Unknown macro: {next_previous_links}
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

In DS, viewers can personalize their own view of a dashboard that has been previously created by an editor, by adding new pages, which contain separate dashboards. This enabled a viewer to maintain multiple views of a single dashboard.

Follow the instructions below to add a page to a viewer dashboard:

  1. Enter the dashboard URL to access the respective dashboard in view mode.
    URL format: 
    https://<HOSTNAME>:<HTTPS-PORT>/portal/<DASHBOARD_URL>
    Example: 
    https://localhost:9443/portal/dashboards/sales-stats
  2. Log into the dashboard using the viewer credentials.
  3. Click Edit, in the Dashboard Designer view mode.
  4. Click Pages.
  5. Click Create Page.
  6. Click on a preferred layout. 
  7. Click on the newly created page name to view the properties related to the page.
  8. Edit the page related properties as required.
    • Title - Name of the page. When a new page is created, by default it is given a generic name (e.g., Page 0, Page 1, etc.). Replace the generic page name with a meaningful name.
    • URL - This defines the URL context used to access this specific page in the dashboard.
      Format:
      http://<DS_HTTP_HOST>:<HTTP_PORT>/portal/dashboards/<DASHBOARD_NAME_URL_CONTEXT>/<PAGE_NAME_URL_CONTEXT>
      https://<DS_HTTPS_HOST>:<HTTPS_PORT>/portal/dashboards/<DASHBOARD_NAME_URL_CONTEXT>/<PAGE_NAME_URL_CONTEXT>

      Example:
      https://localhost:9443/portal/dashboards/sales-stats/sales-targets
    • Use as Landing - If this checkbox is clicked, when the corresponding dashboard is accessed, this page is loaded first as the landing page.
    • Full Layout - If this option is selected, the page appears in full screen mode without any margins.

  9. Edit the newly added page in the dashboard as required.

     Click here for instructions...

    The following are the ways in which a viewer can customize a dashboard:

    Adding a banner to a dashboard

    When designing the dashboard the editors may select a banner to be uploaded to the dashboard. Once banner is uploaded it will appear when viewing the dashboard. When a user (a viewer) views the dashboard, if there is an existing banner the banner is displayed. The viewer can personalize the banner in the dashboard if required. Each personalized dashboard that includes a banner can only be accessed by the user who added that specific personalization.

    Follow the instructions below to add a banner to a dashboard:

    1. Enter the dashboard URL to access the respective dashboard in view mode.
      URL format: 
      https://<HOSTNAME>:<HTTPS-PORT>/portal/<DASHBOARD_URL>
      Example: 
      https://localhost:9443/portal/dashboards/sales-stats
    2. Log into the dashboard using the viewer credentials.
    3. Click Edit on the dashboard.
      In the Dashboard Designer, if the layout supports a banner, the banner placeholder appears. In addition, if a banner is already uploaded, the banner appears; otherwise, an empty placeholder appears.
    4. Click Add/Edit, select an image from the file browser window and click Open. The selected image appears in the block allocated for the banner with the option to crop the image.
    5. Crop the banner image.
      1. Move your pointer over the cropping tool and drag the points to resize it.

      2. Click Save to crop the image.

        If you wish to remove the custom copy of the banner, reset the dashboard.

    Adding a block to a dashboard

    1. Enter the dashboard URL to access the respective dashboard in view mode.
      URL format: 
      https://<HOSTNAME>:<HTTPS-PORT>/portal/<DASHBOARD_URL>
      Example: 
      https://localhost:9443/portal/dashboards/sales-stats 
    2. Log into the dashboard using the viewer credentials.
    3. Click Edit.
    4. Click Block.
    5. If you want to view the size of the existing blocks in the dashboard, click Show Grid. This displays a grid to gauge the size of the block based on its columns.
    6. Enter the width and height of the block in the respective text-boxes, or drag the pointer either vertically, horizontally or diagonally to define the size of the block in the grid.
    7. Click Add Block to add the block to the page in the dashboard. 

    Adding a gadget to a dashboard 

    1. Enter the dashboard URL to access the respective dashboard in view mode.
      URL format: 
      https://<HOSTNAME>:<HTTPS-PORT>/portal/<DASHBOARD_URL>
      Example: 
      https://localhost:9443/portal/dashboards/sales-stats  
    2. Log into the dashboard using the viewer credentials.
    3. Click Edit.
    4. Click on the gadget icon. All the available gadgets that are shipped with WSO2 DS appears.

    5. Drag and drop the gadget into the desired block in the dashboard.

      The visual content of some gadgets (e.g., The "Population by History" gadget, which is part of the Drill Down Dashboard sample) only appears after gadget to gadget communication is enabled.

    Repositioning a block in the dashboard 

    1. Enter the dashboard URL to access the respective dashboard in view mode.
      URL format: 
      https://<HOSTNAME>:<HTTPS-PORT>/portal/<DASHBOARD_URL>
      Example: 
      https://localhost:9443/portal/dashboards/sales-stats   
    2. Log into the dashboard using the viewer credentials.
    3. Click Edit.
    4. Hover your pointer over the block title bar, drag the pointer, and release the pointer in a preferred location in the dashboard. 

    Resizing a block in the dashboard

    1. Enter the dashboard URL to access the respective dashboard in view mode.
      URL format: 
      https://<HOSTNAME>:<HTTPS-PORT>/portal/<DASHBOARD_URL>
      Example: 
      https://localhost:9443/portal/dashboards/sales-stats 
    2. Log into the dashboard using the viewer credentials.
    3. Click Edit.
    4. Hover your pointer over the bottom-right corner of the block. When the resize button appears together with the diagonal pointer, drag the pointer to resize the dashboard.

    Maximizing and minimizing the view of a gadget

    A viewer can view a gadget in full screen mode when either viewing or personalizing a dashboard.

    • Maximizing a gadget in view mode
      1. Enter the dashboard URL to access the respective dashboard in view mode.
        URL format: 
        https://<HOSTNAME>:<HTTPS-PORT>/portal/<DASHBOARD_URL>
        Example: 
        https://localhost:9443/portal/dashboards/sales-stats  
      2. Log into the dashboard using the viewer credentials.
      3. Click Maximize to view the gadget in full screen mode.
      4. Click Minimize to view the gadget in the standard mode.
    • Maximizing a gadget in personalization mode
      1. Enter the dashboard URL to access the respective dashboard in view mode.
        URL format: 
        https://<HOSTNAME>:<HTTPS-PORT>/portal/<DASHBOARD_URL>
        Example: 
        https://localhost:9443/portal/dashboards/sales-stats  
      2. Log into the dashboard using the viewer credentials.
      3. Click Edit.
      4. Click Maximize.
      5. Click Minimize to view the gadget in the standard mode.

    Changing user preferences of a gadget

    All dashboard viewers are given the option to change the user preferences in the dashboard view page. The changes made by dashboard viewers are saved in that respective user's space in the registry. Thereby, enabling viewers who have entered user preferences to view a customized version of the original dashboard.

    A viewer can change the user preferences of a gadget when either viewing or personalizing a dashboard.

    • Changing user preferences of a gadget in view mode
      1. Enter the dashboard URL to access the respective dashboard in view mode.
        URL format: 
        https://<HOSTNAME>:<HTTPS-PORT>/portal/<DASHBOARD_URL>
        Example: 
        https://localhost:9443/portal/dashboards/sales-stats  

      2. Log into the dashboard using the viewer credentials.

      3. Click Properties.

        The Properties button only appears if user preferences are defined, using the <UserPref> tags, in the gadget definition XML file.

      4. Enter the required user preference details.
      5. Click Properties.
        These changes are saved to the userPrefs of a particular gadget. In addition, the gadget view is also updated based the new preferences.  
    • Changing user preferences of a gadget in personalization mode
      1. Enter the dashboard URL to access the respective dashboard in view mode.
        URL format: 
        https://<HOSTNAME>:<HTTPS-PORT>/portal/<DASHBOARD_URL>
        Example: 
        https://localhost:9443/portal/dashboards/sales-stats   
      2. Log into the dashboard using the viewer credentials.
      3. Click Edit.

      4. Click Properties.

        The Properties button only appears if user preferences are defined, using the <UserPref> tags, in the gadget definition XML file.

      5. Enter the required user preference details.

        If you wish to revert to the original version of the dashboard, reset the dashboard.

    Removing a block in a dashboard

    1. Enter the dashboard URL to access the respective dashboard in view mode.
      URL format: 
      https://<HOSTNAME>:<HTTPS-PORT>/portal/<DASHBOARD_URL>
      Example: 
      https://localhost:9443/portal/dashboards/sales-stats
    2. Log into the dashboard using the viewer credentials. 
    3. Click Remove, which appears in the block title bar.  
    4. Select your delete preference and click Delete.
      • The following message-box appears when you are trying to delete a block that already has a gadget.
      • The following message-box appears when you are trying to delete an empty block.
         

    Removing a page in a dashboard

    1. Enter the dashboard URL to access the respective dashboard in view mode.
      URL format: 
      https://<HOSTNAME>:<HTTPS-PORT>/portal/<DASHBOARD_URL>
      Example: 
      https://localhost:9443/portal/dashboards/sales-stats
    2. Log into the dashboard using the viewer credentials. 
    3. Click Next or Previous to navigate to the required page.
    4. Click Remove. 
    5. Click Yes to confirm the deletion process.

    Resetting a dashboard

    1. Enter the dashboard URL to access the respective dashboard in view mode.
      URL format: 
      https://<HOSTNAME>:<HTTPS-PORT>/portal/<DASHBOARD_URL>
      Example: 
      https://localhost:9443/portal/dashboards/sales-stats 
    2. Log into the dashboard using the viewer credentials. 
    3. Click Reset to discard your dashboard preferences and revert to the dashboard that was created by the dashboard editor.

    When a dashboard with multiple pages are accessed via the dashboard viewer (view mode), these pages are rendered as tabs inside the dashboard, and you can switch between the pages by clicking on the respective tabs.

  • No labels
Unknown macro: {next_previous_links2}