Maintain Components
|
|
 |
Dashboard components are discrete elements of functionality, which can be driven by a web data feed or reference a PROIV Task or Function, and are placed on the PROIV Aurora Framework. They can be user-defined or one of the core components shipped with the framework. Their implementations differ depending on their operation, but they are all driven by the same RSS architecture.
To modify a Dashboard component on the PROIV Aurora Dashboard, follow these steps:
-
Click
icon. The Menu screen appears. -
Select the Aurora Configuration option.
-
Select the Maintain Components option.
-
The Maintain Components screen appears.
-
Click New to create a new Dashboard Component. To amend a Dashboard Component, click the drop-down arrow next to the Name field to display list of Dashboard Components and select the appropriate one. Amend as necessary and click the Save to store the changes.
-
Enter/amend the details as you require using the following table as a guide.
Field Descriptions
|
Fields |
Description |
|
Component |
|
|
Name |
User-defined component type. For example, you could set up a component type of a calendar, favourite links, or a news feed. A75 - Mandatory |
|
Object |
JavaScript name for the object. The name refers to a JavaScript file. For example, aurora/widgets/calendar.js, this is entered as aurora.widgets.Calendar. A250 – Mandatory |
|
Icon Class |
CSS icon class used for the widget. Specify an icon to use for the component. A50 - Mandatory |
|
Parameters |
If the component uses parameters, you can specify the default value for these parameters by clicking the Parameters . This value is used when the user logs into PROIV Aurora for the first time, or if they reset their layout. 1. Click Parameters . 2. The Add Layout Component Parameters screen appears. 3. Click Add to add a component parameter. 4. Enter the name in the Name field and enter the value in the Value field. 5. Click OK to close the Add Component Parameter screen. 6. Click OK to close the Add Layout Component Parameters screen. For example, you could add the following parameters for the ActivityHistory component: Name: NUM_DAYS Value: 2 The value is passed to the user’s instance of the component when they log onto PROIV Aurora for the first time or when they reset their layout. The value is placed into the RSS feed's URL to determine the number of days history that is stored. Note: It is important to ensure that the contents of the Name field matches the parameter name used in the JavaScript. |
|
Feed Service |
|
|
Service Id |
Select the RSS data feed service that is used by the component. A10 – Optional |
|
Appearance |
|
|
Title |
Name of the component. For example, Favourites. A50 - Mandatory |
|
Height |
Sets the initial height of the component in pixels. For example, 200 pixels. The height of the component can be changed by the user on the Dashboard if required by dragging and resizing. N12 - Mandatory |
|
Short Description |
Enter a brief description of the component. A10 - Mandatory |
|
Long Description |
Enter a fuller description of the component. A50 - Mandatory |
|
Collapsed |
Enable to ensure that component is collapsed when initially displayed. |
|
Locked |
Enable to ensure that the component is locked and cannot be repositioned on the desktop. |
|
Security |
|
|
Security Profile |
Displays the available Security Profiles. Highlight one of the rows to select the appropriate profile and click the Enable or Disable s as appropriate. Mandatory |
|
Buttons |
|
|
Exit |
Click the Exit to close the screen. |
|
Save |
Click Save to save the details of the Dashboard Component. |
|
Cancel |
Click Cancel to cancel any changes to the Dashboard Component. |
|
New |
Click the New to create a new Dashboard Component. |
|
Delete |
Click the Delete to delete the selected Dashboard Component. |
-
Click Save to save the details, or click the Cancel to cancel any changes.
-
Click Exit to exit the Maintain Components screen.
Note: If the Aurora Security and Menu software is not used, then this screen can be run directly from the PROIV Prompt or from a 3rd party menu by executing the @AU_MaintainComponents function.
To delete a Dashboard Component from the PROIV Aurora Dashboard, follow these steps:
-
Click
icon. The Menu screen appears. -
Select the Aurora Configuration option.
-
Select the Maintain Components option.
-
The Maintain Components screen appears.
-
Click drop-down arrow next to the Name field to display list of Dashboard Components and select the appropriate component that you want to delete. The fields are automatically populated with the component's details.
-
Click Delete to delete the component.
-
Click Exit to exit the Maintain Components screen.
Topic ID: 810016