<!-- TITLE: User Guide --> <!-- SUBTITLE: PPMVUE User Guide --> # Overview PPMVUE is an ad-hoc real-time reporting app for Project Online / Project Server. The app enables users to view and created reports and dashboards to gain visibility to their Project and Portfolio data. PPMVUE comes equipped with out-of-the-box reports and dashboards that can be modified by the end users to fit their needs by changing the filters and widget configurations to slice and dice data by any custom fields defined in the system. Users can also create dashboards from scratch for any view type. Refer to the documentation on how to create new views and configure widgets. The app loads data from the Project OData feed available for Project server 2013/2016 and Project Online. The OData feed is a real-time reporting data API that enables access to various data entities like Projects, Tasks, Resources, Timesheet, etc. depending on the view filters and amount of data available, load time will vary as the app doesn’t cache the data, rather, it loads it directly from Project Server/ Project Online. In PPMVUE, you can create 4 types of dashboards (Views). Portfolio, Project, Resource, and Timesheet. Each view has its own set of data and filter options you can use to create reports and dashboards from. <p class="align-center"> <img src="/uploads/ppmvue-showcase-1.png" alt="Ppmvue Showcase 1" width="600" class="align-center" /> </p> <br/> <br/> # Data Sources # Views ## View Types In PPMVUE, you can create 4 types of dashboards (Views). [Portfolio](#portfolio-view), [Project](#project-view), [Resource](#resource-view), and [Timesheet](#timesheet-view). Each view has its own set of data and filter options you can use to create reports and dashboards from. ### Portfolio View: Loads all Project level fields (built-in and custom fields), Project Workflow Information, Risks, and Issues data. The data set enables the users to gain visibility across multiple projects in the same view. You can limit the number of projects by setting the filter in the view and filter the data set by any of the project fields (built-in and custom fields). This will reduce the load time and enable the users to focus on a set of projects rather than the entire portfolio. Example: A Project Manager can set the Project Owner field to Equal to his/her name to view only project where he/she is the owner. ### Project View: Loads all the Project Level info, Tasks, Milestones, Timephased Task Info, Risks, Issues, Workflow Status, and Resource Assignments for the selected Project. The view has a filter to select the project, the time frame for the timephased task information, and an option to load timephased data and resource assignments. The two options help minimize the data loaded into the view and help reduce the load time if the view is not utilizing the assignments or timephased data. >Timephased data requires the reporting setup to be set to Daily or more but not set to never. ### Resource View: Loads all resource pool information with resource custom fields, resource capacity and assignments for the selected period. In this view, the user must select the resource from the filter menu along with the time frame to load capacity and assignments data. ### Timesheet View: Loads all resource pool information with resource custom fields, resource timesheets and timesheet details (project and task drilldown) In this view, the user must select the resource from the filter menu along with the time frame. ## Changing Views To change and explore other views in the app, locate the menu icon on the top left side of the app menu bar then locate the view you want to load. The views are organized in three groups: * **Sample Views**: Lists all Built-in views included by default. * **Shared Views:** Lists Views created and shared by other users in your organization. * **My Private Views**: List Views that you created and only visible to you. ![2018 06 01 12 25 45 Window](/uploads/2018-06-01-12-25-45-window.png "2018 06 01 12 25 45 Window") ![2018 06 01 12 26 09 Window](/uploads/2018-06-01-12-26-09-window.png "2018 06 01 12 26 09 Window") ## Applying Filters Each View type (**Portfolio**, **Project**, **Resource**, or **Timesheet**) has a view level filter that you can apply to change the content of the data loaded in the view. The view applies to all the widgets loaded in the view and is different from the individual filters that you can set on the individual widgets. Portfolio Views have a dynamic filter you can apply to filter the list of projects loaded by one or more Project Level fields (Built-in or custom). You can chain the filters to limit the amount of data loaded. The **Portfolio** filter will be saved after the view is saved. This is the only view level filter that is saved with the view. The **Project** View lets you change the project data loaded in the view, the time frame for Timephased data if loaded, and options to load resource assignments and timephased data. The filter will not be saved with the view; however, the browser will remember the filter selection (granted you use the same computer and browser for the next session). The **Resource** and **Timesheet** views use the same view level filter, in the filter, you can select one or more resource from the resource list, the time frame for timephased data (assignments, capacity, timesheets, etc..). The filter will not be saved with the view; however, the browser will remember the filter selection (granted you use the same computer and browser for the next session). ## Creating Views To create a new blank view, locate the menu icon on the top left side of the app menu bar. This will bring the Views picker menu, from there, use the plus icon next to the last tab (**My Private Views**) then pick the view type to create. Please note that if you apply a view level filter before saving the changes on the new view, the changes may be lost as the filter will have to reload the data and the view. Make sure you save the changes first before applying a filter. ## Modifying Views If the user has permission to create views, he/she will be able to modify any view then save a copy of it. If the view was created by the user, the changes can be updated to the view itself. Only the view owner and administrators can modify existing views in the Shared Views. ## Exporting Data To export widget data, use the widget menu, then click on Export Data (Excel). You will be prompted to download the Excel file generated to your local disk. Some browsers may block the exported file and display a blocked pop-up message. Ensure to allow pop-ups on the app to download the exported Excel file. # Widgets To add a widget to a view, click on the add widget icon in the view toolbar then select the desired widget to add. Each widget starts with default values based on the view type. The default values offer a starting point to configure the widget. ![2018 06 04 12 48 07 Window](/uploads/2018-06-04-12-48-07-window.png "2018 06 04 12 48 07 Window") To change the widget type after it was configured. Open the widget configuration dialog then click on Type tab then select the desired type. The existing widget configurations will remain and will apply to the new widget type. Keep in mind that not all widgets share the same configuration so additional configuration will be required. ![2018 06 04 12 46 57 Window](/uploads/2018-06-04-12-46-57-window.png "2018 06 04 12 46 57 Window") To copy an existing widget, select Copy from the widget menu. The new widget will be appended to the bottom of the view with the same configuration as the original widget. ![2018 06 01 15 02 06 Window](/uploads/2018-06-01-15-02-06-window.png "2018 06 01 15 02 06 Window") To remove a widget from the view, select remove from the widget menu. PPMVue offers 11 widget types. each type has its own configuration as documented below. please follow these instructions to configure each widget. ## Number ![Number Widget](/uploads/number-widget.png "Number Widget") The number widget displays an aggregated value of a field in the data set. It can also display a unit under the value if provided. If non-numerical field is used, the aggregate function must be a COUNT or COUNT UNIQUE or FIRST, otherwise, the value will default to zero. The COUNT UNIQUE function will count the unique values of the rows in the data set. This can be both numerical or non-numerical fields. If the FIRST function is used on a non-numerical field, the value will display as is. This can be useful if you wanted to display a text value rather than a numerical one. For example, in a Project View, you can display the Project owner name in the widget by selecting the Owner Name field and setting the aggregate function to FIRST. To configure the Number widget, select Configure in the widget menu options to bring the widget options dialog. ![Number Widget Menu](/uploads/number-widget-menu.png "Number Widget Menu") In the options tab, set the desired configurations as explained below: ![Number Widget Config](/uploads/number-widget-config.png "Number Widget Config") * **Data Source**: select a data source for the widget data. Once selected, the fields schema will reload and fields pickers will update. * **Title:** enter widget title. * **Value Field**: pick a field from the data set that will be aggregated to display the value in the widget. * **Aggregate Function**: pick one of the available aggregates to apply to the field values. * **Unit Label**: optional unit of measure that will be displayed under the value (example: USD or $ to denote the value is currency). > **Tip**: you can search for a field in the field picker drop-down by typing the field name in the text box. > ![Finding Field In Picker](/uploads/findig-field-in-picker.png "Findig Field In Picker") ## Gauge/Progress applies to Gauge and Progress widget ![Guage Widget](/uploads/guage-widget.png "Guage Widget") ![Progresbarwidget Ppmvue](/uploads/progresbarwidget-ppmvue.png "Progresbarwidget Ppmvue") The Gauge widget displays the % difference between two values. The actual value and target value. Bothe values come from the data source fields and will be aggregated by the applied aggregate function. For example, to get the work progress across all projects, select the Actual Work field as the value field, and the Work field as the target field. Then apply a SUM aggregate on both fields to get the total Actual work and total Work of all projects in the data set. The widget will calculate the percentage difference between the two values and renders the gauge bar in the widget. ![Guage Widget Config](/uploads/guage-widget-config.png "Guage Widget Config") Gauge widget configuration: * **Data Source**: select a data source for the widget data. Once selected, the fields schema will reload and fields pickers will update. * **Title**: enter widget title. * **Value Field**: pick a field (Actual Value) from the data set that will be aggregated then compared to the Target field. * **Target Field**: pick a field to aggregate the value that will be compared to the Value field and calculate the percentage difference between the two values. Typically, the value from the target field is greater than the value field. * **Aggregate Function**: pick one of the available aggregates to apply to the field values. * **Gauge Color**: pick a color for the gauge progress bar. ## Indicator ![Indicator Widget](/uploads/indicator-widget.png "Indicator Widget") The Indicator widget displays Red, Green, or Yellow icon based on conditions set in the widget configuration. The conditions are applied on a numerical value only and the values must be aggregated from one or two fields. You can set the conditions on a value that is s a sum of one field in the data set or on a value that is a difference (%) between two fields value. For example, you can compare the difference (%) between the Cost field and the base line cost field and set the conditions to display Red if difference more than 10% (over budget by 10%) or yellow if value is more than or equal 5%, or green if the value is less than 5% difference. > **Tip**: when you hover over the indicator icon, the description will show the actual value and the condition behind the current value. ![Indicator Widget Config](/uploads/indicator-widget-config.png "Indicator Widget Config") Indicator widget configuration: * **Data Source**: select a data source for the widget data. Once selected, the fields schema will reload and fields pickers will update. * **Title**: enter widget title. * **Value Field**: pick a field (Actual Value) from the data set that will be aggregated then compared to the Target field. * **Target Field**: pick a field to aggregate the value that will be compared to the Value field and calculate the percentage difference between the two values. Typically, the value from the target field is greater than the value field. * **Aggregate Function**: pick one of the available aggregates to apply to the field values. * **Conditions**: pick an icon color, and set the condition. each condition will be evaluated in the order they are configured (top to bottom). ## Charts Applies to Basic Charts (Line, Column, Area, Bar, Radar, Pie, Domunt, and Funnel) charts. ![Chart Widget](/uploads/chart-widget.png "Chart Widget") The Chart widgets offers 5 basic chart types (Line, Column, Bar, Radar, and Area). All charts share the same configuration as explained below: ![Chart Widget Config](/uploads/chart-widget-config.png "Chart Widget Config") * **Data Source**: select a data source for the widget data. Once selected, the fields schema will reload and fields pickers will update. * **Title**: enter widget title. * **Category Field**: a field that will become the x Axis of the chart and all data series will be grouped by the values of that field. * **Value Fields**: one or more fields that will be aggregated and grouped by the category (x Axis) values. Each field will become a series in the chart and will have a different color. The field names will be added as legend items in the chart. * **Aggregate Function**: pick one of the available aggregates to apply to the series. * **Chart Type**: the type of chart to display (Line, Column, Bar, Radar, and Area). * **Stacked Series**: option to stack the series in the chart. * **Show legend**: show or hide the legend. * **Show Category Labels**: show or hide the x Axis labels. * **Show Value Labels**: show or hide the y Axis labels. * **Color Theme**: a collection of chart colors to apply to the chart series. ## Timeline ![Timelinewidget Ppmvue](/uploads/timelinewidget-ppmvue.png "Timelinewidget Ppmvue") The Timeline widget displays activities timeline in a Gantt-like chart. Each activity will be displayed as a bar or a diamond (milestone) if it has a zero duration. An optional progress of the activity is also available as a progress bar to indicate the activity progress (Percent Complete). To setup a timeline widget, apply the following configurations: ![Timelinewidget Config Ppmvue](/uploads/timelinewidget-config-ppmvue.png "Timelinewidget Config Ppmvue") * **Data Source**: select a data source for the widget data. Once selected, the fields schema will reload, and fields pickers will update. * **Title**: enter widget title. * **Header Field**: A field to display the activity title in the timeline view. * **Group By**: an optional field to group similar activities by. Select --NO GROUP-- to ignore this option. * **Start Date Field**: A field to indicate the start date of the activity. Only Date type fields are available in the list. * **Percent Complete Field**: An optional field to indicate progress of the activity. * **End Date Field**: A field to indicate the end date of the activity. Only Date type fields are available in the list. * **Additional Info**: A list of fields to add to the hover-over context menu. The information will be displayed once the user hovers over an activity in the timeline. ## Table ![Tablewidget Ppmvue](/uploads/tablewidget-ppmvue.png "Tablewidget Ppmvue") The Table widget will display any number of fields in the data set as a table. The table data can be grouped by a field and summaries any value data (numbers) in the total row when grouped. To setup a Table widget, apply the following configurations: ![Tablewidget Config Ppmvue](/uploads/tablewidget-config-ppmvue.png "Tablewidget Config Ppmvue") * **Data Source**: select a data source for the widget data. Once selected, the fields schema will reload, and fields pickers will update. * **Title**: enter widget title. * **Header Field**: A field to display the activity title in the timeline view. * **Column List**: A list of fields to display as a table column. The data for each field will represent a row in the table. * **Group By**: A filed to group similar rows in the table. The field must be added to the Column List first to use it as a group. ## Tree Table ![Ttreetablewidget Ppmvue](/uploads/ttreetablewidget-ppmvue.png "Ttreetablewidget Ppmvue") The Tree widget will display any number of fields in the data set as a nestable tree table like the WBS table in MS project. Rows in a tree table will be grouped by their parent row (each row requires a parent identifier). You can expand and collapse rows by their parent row. To setup a Tree Table widget, apply the following configurations: ![Ttreetablewidget Config Ppmvue](/uploads/ttreetablewidget-config-ppmvue.png "Ttreetablewidget Config Ppmvue") * **Data Source**: select a data source for the widget data. Once selected, the fields schema will reload, and fields pickers will update. * **Title**: enter widget title. * **Header Field**: A field to display the activity title in the timeline view. * **Column List**: A list of fields to display as a table column. The data for each field will represent a row in the table. * **ID Field**: A field to uniquely identify each row in the table. Example: Task ID. * **Parent ID Field**: A field to uniquely identify each row’s parent row in the table. Example: Task Parent ID