Use the pages in the Extended UI Module wizard to create extended UI modules or edit existing ones. This wizard prompts you for the information required to create an extended UI module. For existing extended UI modules, the wizard shows the configured information and permits you to make changes in all fields.
The custom object or custom application defined for the Extended UI module will run in context of the user logged into the Axeda® Connected Product Management Applications, and will use the data for the asset shown in the related Asset dashboard. For example, if UserA is logged into the applications and viewing the Asset dashboard for Asset123, then the content shown in any Extended UI Modules defined in that asset dashboard is specific to Asset123, and constrained by the permissions set for that user. The user also needs privileges to see Extended UI Modules in order to use them in the asset dashboard.
Important: The object defined for an Extended UI Module (either a Custom Object or a Custom Application) MUST return actual, viewable content. If the selected content source is not defined to render displayable data, the Extended UI Module will NOT be shown in the related Asset dashboards. In conjunction, if the selected object is deleted from the system or is NOT available to the logged in user, any Extended UI Module defined with that object is not shown in the related Asset dashboards.
The wizard information for an extended UI module is presented as follows:
o Extended UI Module Definition page - specify a title, a description, the height, and content source for the module. Once you select the content source type, the wizard will prompt you for additional information for the selected content source.
o Extended UI Module Preview - select the asset you want to use for testing the module. Previewing provides you with the ability to test how the module will appear at runtime for the related asset.
o Confirmation - review the information displayed for the extended UI module. To make changes, click Back. To commit the extended UI module to the Platform, click Finish.
Warning! When moving backward and forward through the wizard, use the wizard's Back and Next buttons. Do NOT use your browser's tools back and forward tools. You will lose data if you use the browser tools.
1. In the Title field, type a unique name for this extended UI module. This field is required. The name can be up to 25 characters in length. This will be the title of the module as displayed in the Asset dashboard.
2. Optionally, type a Description of the extended UI module. For example, explain what content the module shows. You can use up to 2000 characters.
3. Type a height (in pixels) to control the height of the module when shown in the asset dashboard. The default height is 100 pixels. The height you specify must be in the range of 50 - 1200 pixels.
4. Select the content source for the module. The options are:
Custom Object - this module will display the results of a selected custom object. Custom objects are created in the Custom Object Wizard. This is the default if you do not make a selection.
Custom Application - this module will display a selected custom application. Custom applications are created in the Stand-alone Applications page (Administration application).
Note: The content you select for the Extended UI Module (whether a custom object or a custom application) can be viewed by any user regardless of user group privileges.
The type of content source you select for the module will determine what information you need to provide next.
5. Select the name of the custom object or custom application. For Custom Objects: only custom objects of the type "Extended UI Module" will be shown for selection.
6. If this is a custom application that was uploaded as a .zip file, you can overwrite the Index File Name shown with another file provided in the application .zip file. Make sure you specify a valid file name for the custom application; this wizard does not provide any validation checking.
7. If
supported, type the parameters you want to pass to the custom object or
custom application during runtime. Make sure you specify parameters in
the correct format for this custom object or custom application; this
wizard does not provide any validation checking.
If parameters are specified, they are to be defined as one or more key
value pair sets (using standard HTTP URL parameters format). For each
set, the Key and Value are paired with “=” character and each set of key
value pairs will be separated by “&” character. For example, key1=value1&key2=value2.
At runtime, the parameters are sent to the Axeda Scripto URL when invoking
the Custom Object or to the Custom Application URL.
Note: By default, the Platform passes two parameters to all custom objects or custom applications defined in Extended UI Modules: “assetId” (to identify the related asset) and “extModuleId” (to identify this extended UI module).
Important: The Extended UI Module will not validate any index file name you may specify in this wizard, nor will it validate that any URL parameters you specify are well-formed. To ensure that Extended UI Module configuration is correct, make sure you select to preview the Extended UI Module in this wizard before saving it for runtime use.
8. Click Next to preview the module with data from the related content source and for a specified asset.
At any time, you can discard your changes and return to the View and manage extended UI modules page by clicking Cancel.