User Tools

Site Tools


Sidebar

widget_editor:creating_widgets_step_by_step:start

Creating Widgets Step by Step

This article contains step by steps instructions for creating a new table widget Portfolio Summary that will display the following information for non-complete projects:

  • Project Name
  • Project Owner
  • Project % Completed
  • Project Start Date
  • Project Finish Date
  • Project Cost
  • Project Work

Creating a Widget and Providing Basic Information

  1. Open Widget Editor.
  2. Click
  3. Open the Basic Info tab.
  4. In the Title field type a title of a new widget, for example “Portfolio Summary”.
  5. From the Widget Type drop down select “Table”.
  6. From the Dashboard Type drop down select “Portfolio”.
  7. In the Category combo box type or select a desired category for a widget, for example “My Widgets”. (Please note that if such category does not exist, it will be created upon saving the widget.)
  8. In the Description field provide a description for the widget.
  9. To set up a custom cover for the widget click the Upload Image button and select an image from the disk.

Defining Widget Data

  1. Open the Fields tab.
  2. In the Data Sources list select Projects.
  3. In the Show column check the checkboxes next to the following fields:
    - ProjectName
    - ProjectOwnerName
    - ProjectPercentCompleted
    - ProjectSummaryTaskStartDate
    - ProjectSummaryTaskFinishDate
    - ProjectCost
    - ProjectWork
    - ProjectUID
    :!: Note: It is not mandatory to select the ProjectUID field, but we will use it on a later stage for creating a drill down. It is recommended to use ProjectSummaryTaskStartDate and ProjectSummaryTaskFinishDate instead of just ProjectStartDate and ProjectFinishDate, as they may contain incorrect values under some circumstances.
  4. In the Display Name column type desired names for the selected fields.
  5. In the Sort column select a sort order next to one of the selected fields, for example, set Desc next to the ProjectSummaryTaskStartDate and Asc next to the ProjectName.
  6. In the Format column select formats for each column, for example, select Cost for ProjectCost and Date for ProjectSummaryTaskStartDate.
  7. In the Cols order list reorder the selected columns as needed using the Up and Down buttons.

:!: More on data structures

Defining Widget Filters

  1. Open the Filters tab.
  2. Set up the following filter to filter out completed projects ProjectPercentCompleted does not equal 100.
    :!: Note: for some datasources filters may already be defined, in this particular example there will be filters that filter projects by Dashboard Timeline, so that widget will display only those projects that intersect with the Timeline period. To add a new filter to the existing ones just select a condition in the And / Or column.

Defining Widget Settings

  1. Open the Settings tab.
  2. Set up default values for widget settings if required, for example, set widget Title to “Active Projects”.

Defining Widget Parameters

  1. Open the Parameters tab.
  2. Select the Drill Down parameter.
  3. Select Projects in the Drill Down Type drop down.
  4. Select ProjectName in the Link Column drop down as the column where Drill Down link will be displayed.
  5. In the Link Source grid select ProjectUID next to the {ProjectUID} tag as the column containing project ID.

Verifying Widget

  1. Open the Results tab.
  2. Select a few projects in the Project Filter.
  3. Check contents of the widget.
  4. Click Save in the toolbar to complete the widget creation process.
widget_editor/creating_widgets_step_by_step/start.txt · Last modified: 2015/05/19 05:34 by Alyona Gonchar