Attachments

doc/4.0.0/Working With Portal/Setup/Managing Components

Contents

  1. Modules
    1. Create
    2. Delete
    3. Tools
      1. Compute
      2. Clear
      3. Publish
    4. Advanced
  2. Dashboards
    1. Create
    2. Delete
    3. Tools
      1. Compute
      2. Clear
      3. Publish
    4. Advanced
  3. Widgets
    1. Create
    2. Delete
    3. Tools
    4. Advanced
  4. Gallery
    1. Description
    2. Content
    3. Add an element from the Gallery
  5. How to start
    1. Requirements
    2. Step-by-step process
      1. Step 1: Add a new module
      2. Step 2: Add a new dashboard
      3. Step 3: Add a new Widget
      4. Step 4: Publish a module in the Gallery
      5. Step 5: Define a role
      6. Step 6: Apply role(s) to a user

1. Modules

1.1. Create

Each administrator and user having access to the Gallery can create local content.

To create a local module:

  1. Click the icon portal_mod_plus_icon.png on the bottom left of the window

  2. Select Add a new module


    portal_mod_step1_addmodule.png

  3. Double-click the default name and enter the module name. Apply with Enter or cancel with Esc.


    portal_mod_step1_rename.png

1.2. Delete

A local module could be deleted using the delete icon near the name. After a click on the icon, a confirmation dialog appears to avoid unwanted actions. Deleting a module has only an impact on the local content.

Module from the Gallery could be deleted but it should be unlocked first. A module could be mandatory in the Portal content, in this case it is not possible to delete it.


  • module_delete.png

1.3. Tools

The tools are available only for administrators. The menu contains 3 actions.

  • Compute: compute all widgets in the module through all pages
  • Clear: clear all widgets in the module through all pages
  • Publish: publish the module in the Gallery


    portal_mod_step4_inplace_publish.png

/!\ Computing or clearing a module could have an impact for others users since widgets are global. It means that the widget displayed in your dashboard could also be used in another module of your Portal or by other users.

1.3.1. Compute

Click on Compute widgets will load the computation dialog. This dialog display the date to compute and offer the option to force the computation. Disabled widgets will be not computed. It there is no widgets to compute or computable an alert will be displayed.

1.3.2. Clear

Click on Clear widgets will clear all data of widgets. This operation is irreversible, it should be used carefully.

1.3.3. Publish

If widgets created are directly available in the Gallery, this is not the case for modules and dashboards. Once created, they exist only locally in the environment of the creator. To set them available for others and use them in roles, they need to be published.

Click on Add module in Gallery

Once open

  1. Select if the module is a new one or if it replaces an existing module

  2. (Optional) Change the name for the gallery

  3. Define a category, or choose an existing one

  4. Add a description

  5. Click on Ok


    portal_mod_step4_inplace_publish_dialog.png

Note 1 The published module is replaced by the module coming from Gallery. It means that it becomes locked.

Note 2 Dashboards are not added independently in Gallery. To have dashboards as components, each one should be published.

To update a module of the Gallery

  1. Add it to Portal (see Gallery chapter)
  2. Unlock the module


    portal_mod_unlock_module.png

  3. Add, modify or delete components

  4. Click on tools menu then Add module to Gallery

  5. Select replace existing module
  6. Select the module in Gallery to replace in the list and valid your choice. The list contains all modules in the Gallery the user has access to.


    portal_mod_updatemodule.png

1.4. Advanced

Only for administrators, there is a widget to manage modules. In module Administration, section Gallery Management, click on Modules Management


  • modules_management_widget.png

This widget permits to see a list of existing modules. All these modules are available in the Gallery but they are visible only for user having access to them. In this list, by default administrators will see modules created with the same domain as theirs. But in tool bar, it is possible to display in addition modules created by administrators with a lower domain.

Available actions are:

  • Add a module in the Gallery
  • Edit an existing module of the Gallery
  • Remove a module from the Gallery

Add a module in the Gallery has the same effect as doing it directly from the module. The dialog has a small difference, the administrator should first select the local module to publish.

  1. Select the local module to add

  2. (Optional) Change the name for the gallery

  3. Define a category, or choose an existing one

  4. Add a description

  5. Click Ok to add the module in the Gallery


    portal_mod_step4_describe.png

In the list will be displayed all local modules.

To edit a module, click on the edit icon on the same row in the table. In this case the first option is keep original content which permits to not modify content.


  • portal_mod_updatemodule.png

To remove a module, select its row by checking the box in the first column and the click on the delete icon. Multiple modules can be selected and deleted in one action.

Modules created with a lower administration domain could not be edited but they can be removed. A such action could have an impact on other users. In this case a dialog gives a summary of impact. It permits to know if the module is used and if it will have a non-wanted effect.


  • module_delete_impact.png

2. Dashboards

2.1. Create

Each administrator and user having access to the Gallery can create local content.

To create a local dashboard:

  1. Click the icon portal_mod_plus_icon.png on the bottom left of the window

  2. Select Add a new dashboard


    portal_mod_step2_adddashboard.png

  3. Double-click the default name and enter the dashboard name. Apply with Enter or cancel with Esc.


    portal_mod_step2_rename.png

In the menu, there is also the option Add a new section. Sections are particular dashboards, they can't contain widgets or be selected but are used to organize the content in a module.

Sections and dashboard could be organized by drag and drop. A dashboard could be placed under a section to have a tree structure in the module content.

2.2. Delete

A local dashboard could be deleted using the delete icon near the name which appears when the mouse is on the dashboard name. After a click on the icon, a confirmation dialog appears to avoid unwanted actions. Deleting a dashboard has only an impact on the local content.

Dashboard from the Gallery could be deleted but it should be unlocked first.


  • dashboard_delete.png

2.3. Tools

When the mouse is on the dashboard name, the tool icon is available. It gives access to 3 actions.

  • Compute: compute all widgets in the dashboard
  • Clear: clear all widgets in the dashboard
  • Publish: publish the dashboard in the Gallery


    dashboard_tools.png

/!\ Computing or clearing a module could have an impact for others users since widgets are global. It means that the widget displayed in a dashboard could also be used in another module or by other users.

2.3.1. Compute

Click on Compute widgets will load the computation dialog. This dialog display the date to compute and offer the option to force the computation. Disabled widgets will be not computed. If there is no widgets to compute or computable an alert will be displayed.

2.3.2. Clear

Click on Clear widgets will clear all data of widgets. This operation is irreversible, it should be used carefully.

2.3.3. Publish

If widgets created are directly available in the Gallery, this is not the case for modules and dashboards. Once created, they exist only locally in the environment of the creator. To set them available for others and use them in other modules they need to be published.

Click on Add dashboard in Gallery

Once open

  1. (Optional) Change the name for the gallery

  2. Define a category, or choose an existing one

  3. Add a description

  4. Click on Ok


    dashboard_inplace_publish.png

Note The published dashboard is replaced by the dashboard coming from Gallery. It means that it becomes locked.

2.4. Advanced

Only for administrators, it exists a widget to manage dashboards. In module Administration, section Gallery Management, click on Dashboards Management


  • dashboards_management_widget.png

This widget permits to see a list of existing dashboards. All these dashboards are available in the Gallery but they are visible only for user having access to them. In this list, by default administrators will see dashboards created with the same domain as theirs. But in tool bar, it is possible to display in addition dashboards created by administrators with a lower domain.

Available actions are:

  • Add a dashboard in the Gallery
  • Edit an existing dashboard of the Gallery
  • Remove a dashboard from the Gallery

Add a dashboard in the Gallery has the same effect as doing it directly from the dashboard. Here the administrator should first select the local dashboard to publish.

  1. Select the local dashboard to add

  2. (Optional) Change the name for the gallery

  3. Define a category, or choose an existing one

  4. Add a description

  5. Click Ok to add the dashboard in the Gallery


    dashboard_widget_publish.png

In the list will be displayed all local dashboards in the format <Module> -> <Dashboard>.

To edit a dashboard, click on the edit icon on the same row in the table. In this case there are two options, the first option is keep original content which permits to not modify content and the second one is to replace the dashboard in the Gallery by a local dashboard.


  • dashboard_widget_edit.png

To remove a module, select its row by checking the box in the first column and then click on the delete icon. Multiple dashboard can be selected and deleted in one action.

Dashboards created with a lower administration domain could not be edited but they can be removed. A such action could have an impact on other users. In this case a dialog gives a summary of impact. It permits to know if the module is used and if it will have a non-wanted effect.

3. Widgets

3.1. Create

Only administrator could create widget.

To create a local widget:

  1. Click the icon portal_mod_plus_icon.png on the bottom left of the window

  2. Select Add a new widget


    portal_mod_step3_addwidget.png

  3. Select the type of widget you want to add, name it and select its category (or create a new one).


    portal_mod_step3_createwidget.png

  4. Then follow the step of the wizard. Each wizard is described in the corresponding page. Please consult Using widgets for details about each widget.

  5. Once the wizard completed, the new widget is added on a new row in the selected dashboard. Note that the widget created is directly added in the Gallery and could be used by other users

The same operation could be repeated for each widget to add in the dashboard or it is possible to use the Gallery to add existing widget as described at the end of this page.

Once all widgets have been added in the dashboard, they can be organized as wanted by dragging the widget and drop it a new place.

  • Move the mouse over the widget bar


  • portal_mod_step3_selectmove.png

    • Move the widget to the new area


    portal_mod_step3_move.png

Multiple widgets could be put on the same row. In this case the width of widgets is automatically adapted to receive a new neighbor. When the widget is moved, blank rows appears between each row, at the beginning and at the end. It permits to place widgets on new rows.

3.2. Delete

A widget could be deleted only by administrators and if the module and dashboard containing the widget are not locked.

If delete is available then the delete icon is displayed.


  • widget_delete.png

There are two options to delete the widget.

  • Remove from current dashboard
  • Remove from Gallery


    widget_delete_dialog.png

The first one as only a local impact, the widget will be removed only from the dashboard which is part of local content.

The second one could have a major impact on content of other users. If the widget is removed from the Gallery then no one could see this widget and data are lost. This second option is available only for administrators. Normal users could only remove a widget from the local content.

3.3. Tools

For administrators, a widget displayed in unlocked module and dashboard offers multiple tools by clicking on the corresponding icon.


  • widget_tools_menu.png

  • Edit: gives access to the wizard to edit widget configuration
  • Duplicate: loads the wizard with the same configuration but create a new widget
  • Compute: computes the last available day

  • Clear: clears widget data. /!\ This operation can't be reverted

  • Enable/Disable: depending on the state of the widget, it could be enabled or disabled

Again, don't forget that a widget could be part of content of different users and any action on a widget will have an effect for everybody.

If the widget is disabled then compute and clear are not available.

3.4. Advanced

Only for administrators, it exists a widget to manage dashboards. In module Administration, section Gallery Management, click on Widgets Management


  • widgets_management_widget.png

This widget permits to see a list of existing widgets. All these widgets are available in the Gallery but they are visible only for user having access to them. In this list, by default administrators will see widgets created with the same domain as theirs. But in tool bar, it is possible to display in addition dashboards created by administrators with a lower domain.

Available actions are:

  • Create
  • Edit
  • Duplicate
  • Remove
  • Change ownership (Only for central administrators)
  • Enable/Disable
  • Compute
  • Clear

Create a widget is exactly the same as creating a widget directly from the Portal. The first step permits to select the type of widget, its name and its category. Then the dedicated wizard is loaded to configure the widget.

To edit a widget, first it should be selected using the check box and then click on the edit button in the tool bar. When a single widget is selected, it correspond to the edition from the widget itself. The wizard is loaded with the configuration of the widget. When multiple widgets are selected then it is possible to edit for all if results are displayed globally or by hierarchy.


  • widget_multi_edit.png

/!\ A such modification requires to clear the data

Duplicate a widget permits to create a new widget with an existing configuration.

Widgets, like other components, have an owner domain. It corresponds to the domain of administration of the creator. It permits to determine who can see, edit and use the widget. Central administrators have the possibility to change ownership.


  • widgets_change_ownership.png

For a central administrator, this action is useful to get the control of a widget or to give the management to a local administrator. It is also useful if there are some changes in the hierarchy and the domain doesn't exist anymore, it permits to avoid orphan.

Enable/Disable have the same effect than from the widget itself. Here it possible to apply the action on multiple widgets. A widget could be disable by the Portal if its configuration is not valid. In this case it is not possible to enable it. An error is displayed to indicated that the action has been not completed.

Compute and clear are similar to the action from the widget itself. Multiple widgets could be selected to compute (or clear) them in one action. Only the last day is computed.

4. Gallery

4.1. Description

The Gallery contains all components published by administrators and all widgets created. The Gallery is used to construct Portal content.

To use the Gallery, the user should have the rights to access it. Any administrators have access to it but for other users it is possible to restrict the access.

4.2. Content

The Gallery contains modules, dashboards, widgets and reports. Everybody will have these four types available but then the content of the Gallery depends on the type of user and on its roles.

For each type, an administrator will have two subsections.

  • portal_mod_admin_gallery.png

In the first part, there are elements coming with the roles associated to the account and in the second part there are elements the administrator could manage. It means that these elements are the same as displayed in the management widgets.

For modules and reports, in the first part they are grouped by role. It means that the name displayed is the name of the role. In the second part, the category is displayed.

For dashboards and widgets, in the first part they are grouped by module associated to roles. It means that the name displayed is the name of the module. In the second part, the category is displayed.

A normal user will have only the first section.

  • portal_mod_user_gallery.png

Click on Add content on the top right of the windows

  • portal_mod_gallery_addcontent.png

To add a dashboard, an unlocked module should be selected. The dashboard will be added in this module.

To add a Widget, an unlocked dashboard should be selected. The widget will be added on a new row in this dashboard.

Modules and reports could be added without any particular selection.

The Portal Gallery opens for browsing the existing components.

To add a widget proceed with with the following sequence

  1. Click Browse Widgets

  2. Select the category of the widget (in this example, Discovery)

  3. Select the widget that you want to add (in this example, Binaries by path)

  4. Click Add it to my portal to add the widget


    portal_mod_browse_gallery.png

It is the same for each type of component.

5. How to start

This example explains how to create content in the Portal and then associate it to an user.

5.1. Requirements

Before starting the configuration of dashboards, modules and roles, these tasks should be completed

  • a Portal account with Administrator privilege is created
  • a basic concept to design the information has been prepared

5.2. Step-by-step process

5.2.1. Step 1: Add a new module

Logging in to Portal with Administrator privilege user account

  1. Click the icon portal_mod_plus_icon.png on the bottom left of the window

  2. Select Add a new module


    portal_mod_step1_addmodule.png

  3. Double-click the default name and enter the module name. Apply with Enter or cancel with Esc.


    portal_mod_step1_rename.png

5.2.2. Step 2: Add a new dashboard

In the selected module

  1. Click the icon portal_mod_plus_icon.png on the bottom left of the window

  2. Select Add a new dashboard


    portal_mod_step2_adddashboard.png

  3. Double-click the default name and enter the dashboard name. Apply with Enter or cancel with Esc.


    portal_mod_step2_rename.png

5.2.3. Step 3: Add a new Widget

In the selected dashboard

  1. Click the icon portal_mod_plus_icon.png on the bottom left of the window

  2. Select Add a new widget


    portal_mod_step3_addwidget.png

  3. Select the type of widget you want to add, name it and select its category (or create a new one).


    portal_mod_step3_createwidget.png

  4. Then follow the step of the wizard. Each wizard is described in the corresponding page. Please consult Using widgets for details about each widget.

  5. Once the wizard completed, the new widget is added on a new row in your dashboard. Note that the widget created is directly added in the Gallery and could be used by other users

Repeat the operations to have multiple pages in the module or multiple widgets in the dashboard.

To publish the module

  1. Click on the tools menu
  2. Click on "Add module in Gallery"


    portal_mod_step4_inplace_publish.png

Once open

  1. Select if the module is a new one or if it replace an existing module

  2. (Optional) Change the display name for the gallery

  3. Define a category, or choose an existing one

  4. Add a description

  5. Click on Ok


    portal_mod_step4_inplace_publish_dialog.png

5.2.5. Step 5: Define a role

  1. Once the module in the gallery, you can create a role using it as described in page Managing Roles and use the module to define content of the role.

5.2.6. Step 6: Apply role(s) to a user

  1. Finally the role could be applied to a user, it will define the content of the Portal for this user. What he will view (mandatory modules) and what he could add (its gallery content). This action is described in page Managing Accouts

last modified 2011-11-16 08:09:00