Forum Discussion

AlBer's avatar
AlBer
Creator I
6 years ago

Documentation about Presentation Configurations

Hello,

I was wondering if there are any available documentation about :

  • Presentation Configurations
  • Command Bar Section

  • Command Bar Item
  • The structure the methods need to have

Thank you !

AlBer

8 Replies

  • christopher_gillis's avatar
    christopher_gillis
    Community Manager
    6 years ago

    Hi AlBer,

    Outside of the blogs that Aras Labs has written, there's no publicly available documentation outlining the CUI data model. 

    As a general overview of the ItemTypes:

    • Presentation Configuration
      • The top-level CUI Item. Defines how the entire UI looks and can be thought of as having two types
      • Global Presentation Configuration
        • Defines the default UI
        • Accessible through the TOC under Administration > Configuration > Client Presentation
        • Change this if you want your new UI element to appear everywhere
      • ItemType Presentation Configuration
        • Defines UI for a particular ItemType
        • Accessible through the Client Style relationship tab of an ItemType
        • Change this if you want your new UI element to only appear when viewing a specific ItemType
    • Command Bar Section
      • Defines a particular section of the UI
        • e.g. search toolbar, relationship grid shortcuts, TOC context menu, etc.
      • In general, you will only ever modify existing sections
        • Look at the Location of the section to see which one you need to modify
    • Command Bar Item
      • Defines an individual element of the UI
        • e.g. buttons, menus, separators, shortcuts, etc.

    This is a large topic to cover. I'd recommend looking at the blogs and projects that are tagged with CUI for some additional information and examples. Let me know if you have any specific questions that aren't answered by the existing resources. :) 

    Chris

    Christopher Gillis

    Aras Las Software Engineer

    • AlBer's avatar
      AlBer
      Creator I
      6 years ago

      Hello,

      Thank you for your answer.

      I was wondering if it is possible to use C# rather than JS in client event methods (for interface interaction purposes) ?

      Best regards,

      AlBer

      • christopher_gillis's avatar
        christopher_gillis
        Community Manager
        6 years ago

        Hi AlBer,

        Because Aras Innovator is a web application, the methods attached as client events need to be JavaScript. However, it would be possible to contain most or all of your logic inside of a C# method and then call that method from your client method with JavaScript code like below.

        aras.applyMethod("Your Method Name", "<your_property>Prop Value</your_property><your_other_property>Prop Value</your_other_property>");

        Chris

  • Juro_Mukai_ll_mit_edu's avatar
    Juro_Mukai_ll_mit_edu
    Ideator III
    5 months ago

    Since CUI objects are items, it would be ideal if we could enable a hover/tooltip mode where mousing over a CUI component would display the name of the CUI object so we could do something other than hunt the grid for likely suspects, and use trial and error to get to the configuration...
    (Identity based or otherwise toggled, or an action, or...)

    • angela's avatar
      angela
      Catalyst II
      5 months ago

      Great idea! As workaround, the name of the CUI element is visible in the browser debugger. Just right click on the element and click inspect. It only works a bit clunky for right-click tear of menus.

      In my case I use the browser debugger and the abbreviations to understand the CUI location. When you know the meaning of mwh, mwmm, ivicb, ivrcb,... you can look up the Methods and navigate to the CUI element pretty fast. 

       

  • vkutsen's avatar
    vkutsen
    Ideator III
    5 months ago

    High Level Overview is available in :

    Aras Innovator XX - Configurable User Interface Administrator Guide.pdf