Proteus v2.0 User Guide - Promineoclickonce.promineo.no/Proteus/Documentation/2.0/Proteus 2.0...

Proteus v2.0 User Guide

Revision 1.02 Author: Erik Danielsson

January 2013

Proteus v2.0 User Guide 2

Contents

Chapter 1 Introduction .......................................................................................... 4

Chapter 2 Getting Started ..................................................................................... 5

Chapter 3 Gantt Chart and Grid fundamentals ....................................................... 6 The names of the screen elements ....................................................................................... 7 HOW TO: Filter Data .............................................................................................................. 8

Searching across ALL visible columns ................................................................................ 8

The advanced filter editor ................................................................................................ 9

Filter has hierarchical couplings (cascading effect) ........................................................... 9

HOW TO: Work with the GridGantt..................................................................................... 10 Sorting: ............................................................................................................................ 10

Grouping: ......................................................................................................................... 10

Aggregating: .................................................................................................................... 11

Selecting other fields from DataSet – The “Column Chooser”: ....................................... 11

The Right Click menu options .......................................................................................... 12

Clearing a value in a cell .................................................................................................. 13

Pan and Zoom in the Gantt Chart .................................................................................... 14

HOW TO: Set advanced properties in Grid .......................................................................... 15 Some useful properties to know about ........................................................................... 16

Conditional Formatting - Simple...................................................................................... 17

Conditional Formatting - Advanced................................................................................. 17

Useful Notes on “Filter Grid” ........................................................................................... 18

Setting up a Custom Editor for a column ........................................................................ 19

HOW TO: Print Grid Gantt ................................................................................................... 20 HOW TO: Modify data and save changes ............................................................................ 21

Move bars in Gantt Chart: ............................................................................................... 21

Changing values in GridGantt: ......................................................................................... 21

Saving changes back to source ........................................................................................ 22

Chapter 4 Other Tools in the Proteus toolbox ....................................................... 23 HOW TO: Pivot Data ............................................................................................................ 23 HOW TO: Work with Time-phased data (Histogram) .......................................................... 24

The Normal Histogram .................................................................................................... 24

The Split Histogram ......................................................................................................... 25

HOW TO: Work with the Completion Matrix ...................................................................... 27 HOW TO: Work with “Watchdog Alerts” ............................................................................. 28 HOW TO: Get info on workspace ........................................................................................ 28 HOW TO: See activity log ..................................................................................................... 29

Chapter 5 Customize Proteus to your particular needs.......................................... 30 HOW TO: Save/Load various types of Layouts and Lists ..................................................... 30

Filter List: ......................................................................................................................... 30

Report List: ...................................................................................................................... 31

Action List: ....................................................................................................................... 31

Grid Layout: ..................................................................................................................... 32

Screen Layout: ................................................................................................................. 32

Pivot Layout: .................................................................................................................... 33

Histogram Layout: ........................................................................................................... 34

Completion Layout: ......................................................................................................... 34


Data Layout: .................................................................................................................... 35

Menu items...................................................................................................................... 36

Chapter 6 Transparent Reporting ......................................................................... 38

Appendix A: Internally generated fields ................................................................ 39

Appendix B: Setting License Key and Repository Folder ........................................ 40

Appendix C: Formatting syntax for Gantt's Time Scale .......................................... 41

Appendix D: Exporting data to Safran Planner ...................................................... 42

Copyright Notice .................................................................................................. 44


Chapter 1 Introduction

The idea behind Proteus is to “wire up” connections between your ocean of corporate data and YOU, the one who needs to interact with them (read and/or write). This wiring process is carried out by a Proteus Administrator, and results in a so called “Workspace” with a given name. It defines the following things:

1. Which data the users can interact with (referred to as “DataSets”) 2. Access rights for who can read and/or write data back to source. 3. Access rights for who can save public Layouts/Lists (see chapter 5) 4. The internal hierarchical relationships between the DataSets. 5. How data for each DataSet is visually presented. 6. Calculated fields. 7. How the time-phasing engine should behave: Which quantities to periodize and by

what rules. 8. Which Completion Matrices are set up (see chapter 4). 9. Which “Watchdog Alerts” to monitor, and the response to give should they be

triggered. 10. If and how reference data (snapshots) can be generated, and if and how this is used

to provide change notification between current and stored reference values. 11. If and how data from a resident system should be “expanded” with user editable

columns (and how this data is stored in separate database). 12. The Help information that is provided for the particular workspace. 13. How one or more custom user interfaces, DataLayouts, are produced.

Even though a Workspace is set up by a Proteus Administrator (using a tool called "Proteus Configurator"), beyond the control of the user, there are many ways to customize it to be more tuned to personal preferences and professional needs. The last chapter (chapter 5) will describe how this is accomplished. In general this User Guide is geared towards a “how to”-format, where the Table of Contents page can act as a quick reference to get answers to frequently asked questions. In this User Guide, we will be using screenshots from a Workspace called “Proteus Training”, having quite a limited set of data in order to make it easier to understand the concepts, and not get too lost in details. A quick note on what Proteus does from a technical perspective: When a Workspace is opened, it will load data from database(s) into memory, and then terminate the connection to the data. Proteus will reconnect to the database(s) only when data is updated, if allowed by Workspace and user rights.


Chapter 2 Getting Started

Depending on how Proteus is deployed in your organization, you may need to do a couple of one-time manual operations (supplying license key and/or selecting the Repository folder) to get Proteus up and running. They are described in Appendix B.

Logging in to Proteus is done through this login form:

Depending on the security model that your particular Repository is configured for, you may be asked to supply the Username and Password you were given by your Proteus Administrator (not in case Active Directory is used ), and press "Continue". Then you can choose which Workspace you want to open from the dropdown showing the ones available to you. Press OK (you choice is remembered next time you log on). A splash screen is shown while Proteus loads the data from the selected Workspace.

Figure 1b: Splash screen showing activities during load of Workspace.

Figure 1a: The Proteus Login form for entering credentials and choosing Workspace.


Chapter 3 Gantt Chart and Grid fundamentals

The Gantt Chart and related Grid are commonly used elements of Proteus. The Grid allows sorting, grouping, aggregating, and highlighting data, while the Gantt Chart allows for visual representation of objects as they appear in time.

The Grid (in blue below) and the Gantt Chart (in red) are part of the same component that we call "GridGantt" in this document. Above this, in green, is shown another important element of Proteus called the “Filter Panel”. This is normally docked above the GridGantt, but it may be configured to be a part of the grid – as an extra row at the top. In the following pages we will give names to other elements in a workspace, and look at what they can help you accomplish.

Figure 2: The initial form of the "Proteus Training" Workspace, and its 3 main areas.

2. Grid

1. Filter

3. Gantt Chart


The names of the screen elements

The 3 numbers on previous page refers to the 3 immediate features that you will normally see when you open a workspace. The various circled letters also refer to items that we will look into shortly. First, let’s give them names:

A. DataSet selector (tabs) – may be available both above and below Gantt Grid.

B. Other tools in Proteus toolbox - Dockable panels. C. Toggle button controlling Gantt/Pivot mode. D. Save button for committing data back to source. E. Layouts and Lists – Dockable panels containing

named items for customizations (Chapter 5). F. Each item in E has its Public and Private lists of

named elements. G. Selector of workspace, when more than one is

loaded. H. Menu items. I. Filter criteria display of current filter for current

DataSet. Each DataSet has its own filter.

Figure 3: Bottom left corner has DataSet Tab selector (A), other Proteus Tools (B), Gantt/Pivot Toggle button (C) and Save Button when updating source data (D)

Figure 1: Top left corner of screen

Figure 2: Layouts and lists pop up on demand at right


HOW TO: Filter Data

The filter may be set up by Administrator to be part of each Grid, or (more often) it is accessible as a separate filter panel (docked to wherever you wish, but normally on top of screen). Below is a list of options when filtering:

a. A click here opens the list. b. List of recently selected single values. c. Opens dialog for custom column filter. d. List of unique single values (may be checkboxes

instead by setting column properties). e. Clear filter for this DataSet. f. Enable/Disable the active filter. g. Pick from “Recently used filters”. h. Row of “filter boxes” for typing criteria. i. Launch of Advanced Filter Editor dialog

(see next page). Note 1: When c is pressed, this dialog appears:

Note 2: Proteus can (if set up by Proteus Admin) add an extra row in the grid that acts as a “parent” for any Orphan child objects. Its name will start with “Orphan_”, and

you may in some settings want to hide it using a filter (not like ‘Orphan%’).

Searching across ALL visible columns

Right click in any column header in grid and check the "Show Find Panel" checkbox, this will allow you to search for a text across all visible columns. This setting may be stored in a Grid Layout (see section on grid layouts):

Figure 4: Various filtering options

Figure 5: Custom column filter


The advanced filter editor

If you need more sophisticated filter settings, you can launch the Advanced Filter Editor by pressing the button. Here are some elements that need explaining:

1. Select Field to use (from list). 2. Select Operator from list. 3. Select compare Value OR Field.

Note on 3: When the is shown, a compare value may be typed but when clicked it changes to and you may then select from the list of all available fields in DataSet. Pressing the will delete the item from filter. Combining AND or/or OR groups: You may wish to combine groups of field with “AND” conditions (they are all required to occur in order to pass the filter), or you may want “OR” conditions, or perhaps a combination of both, as shown in example above.

When the is pressed this list appears: It takes a bit of practice to master the art of setting groups as shown in figure above. It’s a good idea to try setting something in the Advanced Filter Editor, press Apply, and view the filter text string that it produces. There the parentheses may make things a bit clearer how things fit together. The specific setting above will result in the following filter criteria text:

Filter has hierarchical couplings (cascading effect)

It is important to know that when two or more DataSets are related hierarchically (one parent record has a number of child records), then filtering the Parent will affect the children as well. The numbers in parentheses on tab of each DataSet show how many records have passed the filter. In the example below, typing “Do” in the “des” field filter-box results in 2 activities passing filter, and this again affects the related child DataSets:

Figure 6: Filtering ONE DataSet can affect how many records are shown in Child DataSets.


HOW TO: Work with the GridGantt

Sorting:

Simply click the column header for which you want to sort, and click again for reverse order. Should you want to sort on more than one column, hold down the SHIFT-Key and press the 2nd column (and 3rd, etc). To remove a column from the multiple-column sort, hold CTRL-Key while pressing column header.

Figure 7: Sorting can be done on more than one column

Grouping:

Drag and drop any column you wish to group on to the area directly above the column headers:

Figure 8: Grouping is accomplished by simply dragging fields to top section of grid

You may group on as many fields as you like, and by clicking on the group field (see mouse arrow below), you will reverse the order of sorting for this group. Note that each group row may have a summary overview (E.g: “Sum Planned = 0”), and this has been set up by Proteus Administrator for the Workspace.

Figure 9: Any number of fields can be used in grouping.


Aggregating:

Right click in the footer bar of grid and select Aggregate function from list. See section on advanced grid properties for info on how to change the number format and the text prefixing the number (It will initially say “SUM=NN”).

Selecting other fields from DataSet – The “Column Chooser”:

The fields you see in grid are normally just a small subset of all available fields for DataSet. Most of them come from the DataSource (through SQL statement), but others are internally generated in different ways. In circled letter “B” below, you see the types of fields available in DataSet, and they may be turned on/off from the list in “A”. Fields from “A” can then be dragged across and dropped in the desired column position in Grid. The selection you make in “B” is remembered next time you bring up the Column Chooser (choice in right click menu from any column header in grid). Note that there is a filter at the top of Column Chooser, allowing you to type the first letters of the field name to narrow the list of visible fields. This filter is also remembered for next time you open Column Chooser.

Figure 11: Right click anywhere in grid header, and then select “Column Chooser”. Drag fields to/from list and Grid.

Figure 10: Right-click in grid’s footer to add aggregate summaries.


The Right Click menu options

When you right click in a grid's column header, the following popup menu will be shown. Below is a table explaining the various choices:

Control Description

Sort Sort Ascending / Descending. A better alternative here.

Group By This Column Group by column. A better alternative here.

Show/Hide Group By Box Toggle the visibility of Grouping Panel above Grid.

Remove This Column Hide the column from Grid.

Column Chooser Show list of fields to be dragged in to desired location in grid. More info here.

Best Fit Automatically adjust width of column.

Best Fit (all columns) As above, but for all columns.

Show/Hide Find Panel Toggle the visibility of the Find Panel.

Remove all but this column Hide all columns except the selected one.

Show/Hide Column Headers Toggle Column Header visibility.

Show/Hide Column Footers Toggle Column Header visibility.

Columns Auto Width Toggle Columns Auto Width mode. If checked, all columns will fit within grid width (and no horizontal scroll bar will ever be shown)


Clearing a value in a cell

In most applications, pressing delete for the content in a cell or control will imply that its value is "cleared". This is not the case with numeric values in Proteus grid-cells or controls (in DataLayout)! You need to press CTRL-DELETE, or CTRL-0 (as in "zero") to explicitly say that the value should be blank. By only pressing the DELETE-button, the cell/control will "complain" that the current value in cell is not containing a numeric value (as if you had typed a text).

Show/Hide Detail Tabs

As seen above, the details tab(s) can be turned on/off.

Properties This opens up a panel for setting advanced properties for the column.

Conditional Formatting – Simple Described in more detail here.

Conditional Formatting – Advanced Described in more detail here.

Build Custom Editors Described in more detail here.

Expand All Level N Depending on the number of hierarchical levels of loaded data, there will be a corresponding number of menu entries for expanding items for a specific level in the "tree structure".

Collapse All Level N Similar to the above, but collapse instead of expand.

Export to Excel Export the grid to Excel (preserving formatting).

Export to Safran Planner Export the visible data (according to expanded/collapsed structure) to Safran Planner format, and launch the application (provided it is installed on machine). More info in Appendix.

Export GridGantt WYSIWYG Export of the Grid and Gantt to pdf. Note: When grouping is activated, each page will start with a group header. This is important to be aware of, since it may be confusing to see the same group header appear multiple times.

Copy top level layout to detail view(s)

This choice can save quite a bit of time, and is therefore good to know about: You man have spent considerable time on setting all the visual attributes for a grid's columns (captions, tooltips, colors, etc). If you have a hierarchical structure, you may find that the same data is shown in a "sub-grid" (or "detail view" as it's called in the menu), and you may then think that you have to do the same work one more time. This is fortunately not the case – all you have to do is to right-click on the parent grid, and select this menu-item. All detail views will then inherit the settings given at "top level".


Pan and Zoom in the Gantt Chart

Below the Gantt Chart, there are various controls for setting the visible timespan:

The controls under the Gantt Chart are used to control the visible timespan.

From left to right, these are as follows:

Control Description

Pan scrollbar Moves the timescale "left" or "right".

Zoom on entire project

Press to show the full project range. This is defined by min/max dates from the loaded data, and a number of "margin-days" at both ends configured in Workspace.

Zoom in on Work Schedule

The WorkSchedule window has been set up in workspace. It is configured to a number of days before and ahead of the TimeNow line (see red solid line in screenshot above). The range is shown above with green dotted lines.

General Zoom slider Controls the zoom-factor of Gantt.


HOW TO: Set advanced properties in Grid

The dropdown menu that appears when you right click on any column header (see Figure above) has a choice called “Properties”. This is the entry point for setting a wide variety of properties relating to a column’s appearance and behavior. Let’s look at the dialog that appears when we choose it:

Figure 12: Properties can be set individually for any column in Grid – example here sets text in column header.

As you can see, at the bottom right section there is a useful description of the selected property.

Some useful properties to know about

Name of Property Description of what it does and how to set it

Caption Sets the text in column header. See “Advanced feature” at bottom of this table for advanced formatting options.

DisplayFormat - FormatString

The value “0” in “n0” means 0 decimal places in number.

SummaryItem - DisplayFormat

Almost identical to the one above, but controls the formatting for aggregated value in footer.

AppearanceCell – BackColor

Setting a static background color. By setting BackColor2 you create a gradient transition.

ToolTip Sets the tooltip shown when mouse hovers over column header. Advanced feature: There are some markup tags that can be used to set color, fontstyle and size to the text in column’s caption and tooltip:

Example Result <color=Red>Some Text</color> Some Text <size=14>Some Text</size> Some Text BoldTextand..and italic Bold Text ..and italic Line1 Line2 Line1

Line2

These tags can be combined in any way you like. Example: The <color=green><size=14>Green</size></color> giant

Result:

The Green giant

The best way to get more familiar with the possibilities for setting column properties is to go through them all, read the description, change some value, and see what effect they have in grid.


Conditional Formatting - Simple

Right click in the column header you wish to add conditional formatting for, and select “Conditional Formatting - Simple”. It brings up this dialog:

Explanation of annotations:

A. Style conditions B. Condition C. Apply to entire row? D. Style formatting

Conditional Formatting - Advanced

Right click on any grid column header and select the choice called “Conditional Formatting - Advanced”. It brings up this dialog:

When the “+” sign is pressed at upper left corner of the form (see left), an expression editor appears that can help you create the expression to match your particular condition. It has a wide range of functions to choose from, each described when selected (see fig. 17 below):

The main difference between “simple” and “advanced” conditional formatting is that the simple version restricts you to show the coloring in the column being tested for a condition; whereas the advanced lets you color any column independent of the columns used in the condition.

Figure 14a: Dialog for setting Conditional Formatting for a grid column Figure 135b: Example result from left

Figure 16: Dialog for setting Advanced Conditional Formatting Figure 15: Conditional Expression editor


Useful Notes on “Filter Grid”

All of the properties that can be set for a grid-column can also be applied to the Filter Grid. As mentioned before, this assumes that the Proteus Administrator has set up filtering in a separate panel instead of using the grid’s own filter. Right-click on a column in filter grid will give the same “Properties” list.

In some cases you may not only want be able to pick a single item from filter’s pick-list, but instead select multiple items. This is achieved by setting the “FilterPopupMode” property to “CheckedList”. The images below reflect how this will appear to user:

When selecting multiple items and pressing "OK", you will notice that the filter text has changed to an "Or" statement:

Figure 16: Filter can allow for selecting multiple items

Figure 17: Multi-select results in an "OR" in filter text


Setting up a Custom Editor for a column

It is possible to specify a custom editor control for any column in a grid. The example below shows a variety of columns having custom editors:

An example of grid with a variety of custom editor controls.

By right clicking a column header, you can select "Build Custom Editor":

And it will bring up the wizard form for choosing type of custom control. In the example below, a Slider control has been selected, and by clicking "Next" you will see what settings it has:

The wizard that guides you through the required steps (depending on control type).

Next -> Setting Slider Properties


HOW TO: Print Grid Gantt

Simply right click in grid and select “Export GridGantt”, and then specify which title text to show in output:

And here is the result:

Note: In the current version of Proteus, if you have grouping activated in the grid, you can’t show the Gantt Chart, only the grid. From the menu you can export the result to various formats:


HOW TO: Modify data and save changes

Depending on your Access Rights, you may or may not be able to edit data. The right to modify data is two-fold:

1. A user may have the right to modify bars in Gantt Chart (drag and drop) and/or 2. A user may have the right to change data in Grid (other than the dates controlling

bar range)

Move bars in Gantt Chart:

A comment on the symbols at “a” and “b” in figure above:

At “a” the tooltip says:

At “b” the tooltip says: It is possible for a Proteus Administrator to make visual indications if a child object is violating “Parent Range Restrictions”, i.e that it is outside parent’s start-finish range.

In the example above, the parent’s range is shown as a red frame with its interior in cross-hatch if child is outside range (out of sync), and semitransparent red if within range. Any movements made to bar will affect these visual indicators dynamically (when bar has been edited).

Changing values in GridGantt:

An alternative way to move bars is to edit the start and finish dates from the Grid. When working with hierarchical child DataSet, you will find some extra choices when right clicking in any (child) row:

Figure 18: If given access, you may drag bars (either endpoint or whole bar) directly in Gantt Chart

Figure 19: Hatch may represent: “out of sync”

Figure 21: Popup menu shown on right click in grid Figure 20: Edit from grid


Saving changes back to source

If you are given access to update data, then pressing the button (at bottom left corner of screen) will bring up a dialog window showing rows that have one or more changed values:

Figure 22: See list of changed rows before committing changes back to source

In order to accept the values that have red “Error Indicators”, you need to check the control called “Ignore Errors” before pressing OK. If changes have been made to more than one DataSet, you may be prompted with the above dialog for each of the affected DataSets. Note: The tab shown above called “SQL List” is only shown for admin users.


Chapter 4 Other Tools in the Proteus toolbox

Proteus is more than just an interactive Gantt Chart for hierarchical data – it has several other useful tools that could be considered “products” in its own right. Many synergies follow from having such a set of tools in conjunction with data loaded from multiple sources.

HOW TO: Pivot Data

When the Gantt-Chart/Pivot-Chart toggle button is pressed (see circled icon above), the Gantt Chart will be swapped with a Pivot Grid+Chart (referred to as "PivotChart"). The PivotChart is a useful tool for getting overviews over data, and they may save you from the habit of “cutting and pasting” data into excel when having to do pivoting of any kind in the future.

Important Note: The data you pivot on are affected by the filter (see previous section). Explanation to annotations in figure:

1. Select from over 30 Chart types. 2. Quick export to Excel or pdf. 3. The Aggregated Field(s). 4. The Row Field(s). 5. The Column Field(s). 6. The Chart. 7. Various Chart options.

The list of available fields is accessible by Right-click in the top part of Pivot Grid and selecting “Show Field List”. You may notice that all date fields appear 4 times (one for the original field and three for Year, Month, and Week formatting). See figure at right.

Figure 23: Pivot Grid and Chart

Figure 24: Pivot Field List


HOW TO: Work with Time-phased data (Histogram)

The Proteus Administrator has defined which fields to time-phase in which DataSet, if and how they are profiled (the normal case is linear spread), what calendar(s) to use, if and by what formula they are derived from other time phased data, and which fields to use for spread range. In addition, the type of spread has been set up in any of these ways:

1. Start to Finish (normal) 2. Start to TimeNow (common for earned and expended values, since “work done”

belongs to the “left” of TimeNow and not "in the future") 3. TimeNow to Finish (common for “Remaining” values – they belong to “the future”) 4. Two arbitrary date fields in a DataSet. 5. It is also possible to load data that is already time-phased and show it in histogram.

The Normal Histogram

Figure 25: Time-phased result for multiple DataSets in “Normal” Histogram

Explanation to annotations in figure: 1. The Bar-Chart showing time-phased result (periodic and cumulative). 2. Tabs for “summary Values overview” AND “control of Series Visibility”. 3. The Histogram Toolbar for controlling these parameters and options:

a. Time Resolution (Normally Day, Week, Month). b. Unit (Normally Hours or Men). c. Visible time range (Start and End dates). d. Legend On/Off. e. AutoRefresh – if checked, the histogram will be updated when filter changes or either of

a or b above are changed. f. Refresh button (for manual refresh in case AutoRefresh is unchecked). g. Preview – show chart and/or grid in pdf format. h. Date Range (Choices: AutoZoom / WorkSchedule / EntireProject / Manual). If you

manually select at start or end date from the visible range (see c. above), this is automatically set to “Manual”.

i. Paging Field (new feature in v2.0) – choose which field to use to create separate charts for each of its unique values, shown in separate tabs and printed on separate pages.

4. The periodic values (can be exported in various ways by right-click menu choices). 5. Tabs for General and Split-Bar Histograms (see next page).


The Split Histogram

There are two tabs in the Histogram control, as seen in figure at left. By clicking on the right tab you can define a split histogram, but only for spreading value from ONE field in ONE DataSet, according to selected split-field. As with

regular histogram, you also have the option of setting the paging field for generating multiple charts (one for each value in the page field).

Figure 26: Example of screen shot from a split-histogram showing day resolution.

The controls are identical to the ones for Normal Histogram, except for these:

DataSet: Which DataSet to use as source. Spread Field: Which field in the selected DataSet to use. The spread-type (see previous page) for this field is the same as in Normal Histogram. Split Field: Which field should be used to “split the bars”?

The preview in pdf format. It may be exported to other formats, such as Excel, if needed.


This popup menu is shown if you Right-Click in grid below the histogram:

Export to Excel: The grid will be shown in Excel. Extort to csv-file: Same as above but grid is transposed. Copy to Clipboard: The selected cells are copied to clipboard. Show as Excel Graph: Creates the graph and grid as a chart with data table in Excel. See figure below. This feature may, or may not, be configured in your particular setup of Proteus.

Grid and Graph can be exported to Excel, provided that a Proteus Administrator has set up this feature.


HOW TO: Work with the Completion Matrix

The “Completion Matrix” is a reporting format with an extremely high “information density”, and is very useful for getting good overviews on how things look from a “completion perspective”. In the example below the objects are located under the column that represent its finish week, and the colors indicate its "Percent Complete Status" (100%=green, 99-51%=yellow, 50-1%=orange, and 0%=red).

Explanation to annotations in figure:

1. Select which DataSet to use as source. 2. Select which predefined Report to use for the selected DataSet (see 1 above). 3. Select TimeUnit (set up by Proteus Administrator, but normally Day, Week, Month). 4. Set time-range to include in report. 5. The "CutOff" time is highlighted (controlled by admin, but normally today’s date). 6. Objects (in this case Activities) are listed vertically under the column (week in the

example) representing the one that they should be “completed” in. 7. Statistics for each column. 8. Tooltip can contain lots of information… even drill down into lower level DataSets 9. Preview report in pdf format. 10. Refresh Report.

Figure 27: Completion Matrix showing Activities colored acc. to their banded Percent Complete value. Finish date of activity controls which column (week in example) it belongs to.


HOW TO: Work with “Watchdog Alerts”

The Proteus Administrator can define (in close dialog with the user group team) which criteria to monitor and what alert message to give, should it be “triggered”. There are very few technical limitations here – the challenge is to formulate all the conditions (inconsistencies between DataSets or plain errors) that your project want to avoid. The Watchdog Alerts shown below is an example from another Workspace, and show the kinds of things your project may want to monitor.

It is a good idea to undock this panel by holding mouse over the Alerts tab and dragging the whole panel upwards. Once you release it, you can again click on the GridGantt tab. If you Double-Click on one of the alert rows, you will apply a filter corresponding to the alert, and you will see the filtered data from the DataSet in question. In this way you can see all the details behind any alert that has been triggered.

HOW TO: Get info on workspace

Since each Workspace acts as an “application” in its own right, it is important to be able to provide the user with information on how to use it properly. The Information tab contains a browser control and is set up by Proteus Admin to contain help information, with possible internal hyperlinks or links to other related information. Alternatively it may be set up as a Word Processor, much like a Word document, that may be edited and updated by some user Groups. It may be a good idea to include information here on (or links to) best practices for performing certain tasks with your data. (The next page shows an example of help info for a demo Workspace in HTML format.)

Figure 28: Example of Watchdogs that "barked". Details behind each are seen by double-click on an item in list


Figure 29: Example of giving the user information on Workspace details

HOW TO: See activity log

If you press menu item “View – Log Info Panel”, you will see an activity log that may in some cases provide useful information, especially when communicating with your Proteus Administrator to identify causes for unexpected behavior. Right-Click in this list shows a popup that allows exporting grid’s content to text file (csv-format) and showing it in Excel. The Proteus Administrator may request this list to be mailed to him/her should such an event occur. A better alternative would be to produce a Report Container and mail it instead of the log file – allowing for an exact recreation of the symptoms to the Proteus Administrator.

Figure 30: An example of the activity log.


Chapter 5 Customize Proteus to your particular needs

Some users in a workspace will be given the right to save “Public customizations”, available to all users, but all users can have their “Private customizations” , available only to themselves. This chapter describes what things can be customized, and how easy it is to accomplish.

The following items can be saved: Filters, Screen Layouts, Grid Layouts, Pivot Layouts, Histogram Layouts, Completion Layouts, Data Layouts, and Reports (combining a Layout and a Filter). These terms will all be explained in this chapter. In addition to this, some users may have access to so called “Actions” that can for example publish data to specific locations. The “Action List” resembles very closely the list of the other items in this chapter, so is included here for that reason, even if it is not customizable in the same way at the others.

HOW TO: Save/Load various types of Layouts and Lists

With the exception of Filter List, Action List and Report List, all of the Layout categories will initially have a “[Default]” item both in the Public and Private branches of their “tree”:

By Right-Clicking under the Private branch, you will always get the popup-menu at “A”: Doing the same under the Public branch may result in only “Load Item” showing – it all depends on your rights to save items under the Public branch.

Filter List:

Set the filter you want by using the filter functionality (shown here), and then right click in either Public (provided you have access) or Private branch and press “Add Item” – fill in Name and Description, and press OK:

Holding mouse over an item in tree will show a tooltip with Name and Description, as well as who created it and when. Filter is applied by simply Double-Clicking item in tree, or by right clicking and selecting “Load Item”.


Report List:

A Report is, for all types except "Custom Reports", simply a combination of a Filter and a Layout that is given a name and a description. By pressing “Add Item” or “Edit Item”, you will launch the “Report Wizard”, where your first choice is what kind of predefined report layout to use as a template for your report. Depending on the type you choose, you will be guided through some additional pages where you have to select

settings that you want.

In the final page (see figure at right) you will have to give the report a name (unique) and a description, as well as setting up custom header footer (unless you with to use the ones set up by Proteus Administrator), and custom margins. In the ReportList, icons will indicate what type of report it is and what destination has been chosen for it (screen, printer, mail, and file). An introductory tutorial (from the creators of the

reporting component) on how to work with the Report Designer can be found here.

Action List:

This is set up by Proteus Administrator, and normally only a select handful of people would see anything in this list (see right). A Double-Click on an item may give a confirmation dialog before the action is carried out, such as this:

Figure 32: The first page in wizard Figure 31: The page where destination is chosen

Figure 33: The final page of the wizard

Figure 34: Confirmation dialog for Action

http://www.youtube.com/watch?v=Z-7pGmtJVP8


Grid Layout:

When a Grid Layout is saved, quite a few things are saved with it besides the layout of the grid:

1. The layout of the filter grid above it (if made visible to users). 2. The splitter position between Gantt-Grid and Gantt-Chart. 3. The state of the Gantt/Pivot toggle-button 4. The "Find Panel" visibility status.

For the grid(s), every property that is set for any column will be saved:

Column widths, captions, tooltips, number formatting, conditional formatting, aggregate summaries, grouping levels, sort orders, Custom Column Editors, etc.

Screen Layout:

All the panels in Proteus are Dockable, which means that they can be “detached” from their resident location and moved or docked elsewhere. Undocking a tool is done by simply holding on the panel’s tab and dragging it away from its original location. Placeholders will appear that indicate where it can be docked, or you can leave it undocked – as a separate “window”. This is especially interesting if you have 2 screens next to each other - you may have some tools constantly visible on the left screen, and others on the right. Or even if you only have one screen, you may want to have some tool-windows alongside each other:

Figure 35: Customize the arrangement of tools and give this arrangement a name for quick retrieval

If a tool-window is floating on screen, it can be returned to its docked position by double-clicking on its top part. Conversely, double-clicking the tab in its docked state will return it to its previous “floating” location. In figure above we see that Gantt’s Grid and Chart (“A”) can be seen together with Histogram (“B”) and Information(“C”). The rest of the tools are still available in the shared space of “A” by selecting any of the 4 tabs for the remaining ones ("D").


How to turn AutoHide on/off for a Panel: Below you see the “normal” look of the Layout and List panels. When the mouse is moved over one of its tabs, it will “pop-out” from its hidden state, and when mouse clicks outside the area, it will return to hiding. If you want to make it “Always Visible”, then simply press the “pin” icon. Notice that the tabs will then move from the right side to the bottom.

Pivot Layout:

When a Pivot Layout is saved, these things are persisted: A. The Chart Type and checkbox-states. B. The Fields used in the Pivot Grid. C. The splitter position (as height %) that separates the grid from the chart.

Figure 36: "AutoHide" turned off

Figure 37: AutoHide turned on


Histogram Layout:

When a Histogram Layout is saved the following things are persisted: A. Which type of Histogram Report to show (Normal or Split-Bar) B. Which series to show. C. The horizontal split percentage. D. The vertical split percentage. E. The control settings. F. The control settings for the Split Histogram.

Figure 38: Items that are persisted in a Histogram Layout

Completion Layout:

When a Completion Layout is saved the control settings of top row is persisted:

Figure 39: The 3 leftmost controls at top are persisted in Completion Layout


Data Layout:

This feature was introduced in Proteus v1.6 and opens the possibility to create virtually any kind of user interface to go with your data. At a user level, it is possible (if access is granted) to right click on the form and choose “Customize Layout”.

Controls can then be rearranged on screen (see figure 44 below), by drag and drop, or new controls can be dragged in from the Layout Tree List (see figure 45 below). The resulting user interface can be saved under a specific (Public or Private) name in the Data Layout list. By double-clicking on such an item the layout is loaded.

Figure 44: Any kind of dashboard can be created in Proteus by a Proteus Administrator, and the users can make customizations to how it looks – to be saved as a private layout, or (if access is given) to a public.

Figure 45: Controls can be dragged from left list, or properties can be set for selected controls (at right)


Menu items

Let’s get a quick overview of the menu item, going from left to right: The File menu: As mentioned before, it is possible to have more than one Workspace open at one time. A new session is launched with File – New – Session (or Ctrl+Shift+N). The View menu: This is useful if one of the Dockable panels have been “closed”, i.e the

at top right corner of the tool has been pressed. By clicking on an item in the list (see figure at right) it will reappear as visible. The Tools menu:

A brief explanation for the items under the Tools menu (the list depends on access rights): 1. Query Analyzer – Allows admins to view/run SQL behind each DataSet. 2. Expression Tester – Allows admins to view existing Expressions and test new ones. 3. Field Viewer – Allows viewing all the fields in a given DataSet. 4. Save and restore Grid Layout from/to file. Can be useful to “copy” layouts. 5. Copy all the column widths, captions, and tooltips from Grid to Filter Grid. 6. Export all DataSets to MSAccess database. It will ask for path (default is user’s temp path)

and suggest the filename to “ProteusPDSExport.mdb”.

7. Create Report Container – See next chapter on "Transparent Reporting".

Figure 40: The View menu


The Window menu:

By unchecking “Use TabbedMDI”, each workspace will become its own window instead of a tabbed page. This may be useful if you need to compare two instances of the same workspace, or have 2 separate workspaces on 2 different screens.

The Skin menu: Controls the “look and feel” of Proteus. This setting is remembered and used for all your Workspaces. This setting can be "forced" in the configuration (by Proteus Administrator) so that a particular Workspace is shown with a particular skin.

The Help menu: This shows an “About Proteus” form as seen in figure below. There you find the version number and license information (Serial Number and Expiration Date).

Figure 41: The Skin menu

Figure 42: The Help menu

Figure 47: The Window menu


Chapter 6 Transparent Reporting

This is the main new feature of Proteus 2.0 that allows undistorted transfer of virtually every aspect of the current Workspace environment to a recipient (which is assumed to also have Proteus 2.0) through ONE file. We have called this concept "Transparent Reporting".

The recipient of the "transparent report" (also called "Report Container") will see virtually the EXACT same user interface and data as is seen on the sender's side – only it will be an interactive OFFLINE REPLICA, no longer attached to the actual data sources. The "interactive" aspect means that the recipient can filter and drill down into any details, and produce reports according to his/her focus or interest. Needless to say the data itself cannot be modified since it is an offline replica. Usage within an organization: A transparent report can be generated at regular intervals (e.g weekly or monthly), and stored on a file share. These files will then act as a historical record of how important corporate data develops over time. It can also provide the basis for historical reporting, and act as internal and external audit trails.

Usages between organizations: Another typical usage would be in contractual agreements, to facilitate and streamline the generation of complete status reports with full drill down into underlying details. The two parties (Contractor and Subcontractor(s)) will agree on, and create a workspace for, how multilayered data from the subcontractor's existing systems should be wired into a "Transparent Report". At regular intervals the subcontractor would "press the button", i.e generate the "Report Container", and simply send it (by mail or ftp) over to contractor. The important shift from traditional reporting is that now the actual generation of "paper reports" is left to the contractor. Having access to all the details, the current interests and focus of the contractor can determine what reports they want to extract from the detail data. This is where the word "Transparent Reporting" gets its meaning – the subcontractor is "transparently" submitting all the relevant detail data from within their own systems and letting the contractor use it to generate the agreed contractual status reports, as well as ad hoc ones. The time spent on status reporting will most likely be dramatically reduced (from hours or days to seconds), and the quality (or at least "truthfulness") of the data will be guaranteed, since no manual interaction is required in producing the report container content (other than "pressing the button").

Appendix A: Internally generated fields

In a grid’s “column chooser”-list, you will see a (long) list of fields. Most of them will probably come from the grid’s DataSource (normally through an SQL statement), and some will be set up by Proteus Administrator as calculated fields, and then some are internally generated.

List of internally generated fields, and what they mean: Column Name Data Type Description _Counter System.Int32 Always 1. Usable in pivoting for getting count. _ParentStart System.DateTime The Parent’s Start Date _ParentFinish System.DateTime The Parent’s Finish Date _ParentID System.String The Parent’s Unique ID _ParentDescription System.String The Parent’s Description _ProgressDate System.DateTime The date corresponding to tip of progress bar _Original_<StartColumn> System.DateTime The original start date, internally used for restore _Original_<FinishColumn> System.DateTime The original finish date, internally used for restore _ExpectedProgress System.Double The calculated expected progress acc. to TimeNow _OnSchedule_Start System.DateTime The start date if it had been on schedule _OnSchedule_Finish System.DateTime The finish date if it had been on schedule _OnSchedule_Offset System.Int32 The number of days to move to be on schedule _IsInWorkSchedule System.Boolean True if within the work-schedule range. The

"WorkSchedule" timerange is defined by Proteus Administrator for each Workspace.

_ChildCount System.Int32 The number of child-rows. If more than one set of child-data exists, the second set will be called _ChildCount2, the etc.

_HasShadow System.Boolean True if the row has a related shadow row. If more than one set of child-data exists, the second set will be called _HasShadow2, the etc.

_IsOrphan System.Boolean True if parent is missing. In such a case the object’s Description Field will start with “Missing Parent: <Name of the parent not found>”

_Duration System.Int32 The number of days between start and finish dates.

_WorkDays System.Int32 The number of working days between start and finish dates, according to the calendar that the object is assigned to.


Appendix B: Setting License Key and Repository Folder

First time Proteus is run, you may have to do one or two one-time operation to get Proteus started. Both of these are described in this Appendix.

Providing a License Key: Depending on how your IT department has decided to deploy the application, the license key may, or may not, be automatically inserted on your local machine’s registry. If this is not the case, the following dialog will be shown the first time the application is started, and you will need to enter the license key given by the vendor, and press “Validate Online Now”. After a second or two, you can press “Accept”, and you never have to enter this again.

Selecting a Repository Folder:

Depending on how your IT department has decided to deploy the application, the Repository Folder may, or may not, be automatically inserted on your local machine’s registry. If this is not the case, you need to manually specify this folder (you should have been given this information from your Proteus Administrator).


Appendix C: Formatting syntax for Gantt's Time Scale

The time scale of the Gantt Chart can be customized in various ways. The same syntax is used when setting up the Time Unit choices available for Histogram. This appendix gives an overview of the various ways to format a time entity to a string.

The formatting options are quite extensive, and more info is found in these links: Standard formatting: http://msdn.microsoft.com/en-us/library/az4se3k1.aspx Custom formatting: http://msdn.microsoft.com/en-us/library/8kb3ddd4.aspx Special Proteus specific formatting codes: We have extended the possibilities shown in the links above, with the following codes:

[Week] Returns the year and week in this format: 13-51 (2 digits for year and week)

q Returns a one digit quarter number.

w Returns a two digit week number (starting with 01 and ending with 52 or 53)

d1 Returns the day name's first letter in lower case.

D1 Returns the day name's first letter in UPPER case.

m1 Returns the month name's first letter in lower case.

M1 Returns the month name's first letter in UPPER CASE.

In Proteus (by right clicking the Gantt's time scale), this list can be seen showing typical examples to choose from (or you can type your own custom formatting code):

If you wish to include a letter that you want to avoid converting to an equivalent formatting result, you can prefix the letter with a "\" character. An example will clarify this: The format "dd-q" would result in this (for example): 01-1 The format "\d\d-q" would result in this (for example): dd-1

http://msdn.microsoft.com/en-us/library/az4se3k1.aspx

http://msdn.microsoft.com/en-us/library/8kb3ddd4.aspx


Appendix D: Exporting data to Safran Planner

Proteus can export its hierarchical Grid and Gantt Chart to Safran Planner format. From Proteus this is done by right clicking in a GridGantt and selecting "Export to Safran Planner".

The next page shows a screenshot from Proteus and the result after export to Safran Planner. There are a few things to comment on there:

1. The background and text colors are “transferred” to the result, but individual cell variations are not. You will notice in example on next page that some cells are orange in Proteus, while black in Safran Planner.

2. If you look at a child DataSet (i.e the DataSet that is not topmost), if the text (caption) given in column headers match text in column headers at toplevel, then this field’s values will show in the same column. This can be quite useful when “reusing columns” for different levels of data.

3. The “expanded/collapsed status” of a row will be reflected in the exported result. If you wish to expand all children (down to some hierarchical level), you can right click in grid and choose the Expand option there.

4. The color of progress bar is not “transferred” to Safran Planner result, nor are, as mentioned previously, the individual bar-colors.

5. Setting a background/foreground color for a column in Proteus, transfers with same colors to result in Safran Planner.


Below is an example of export to Safran Planner:

Screenshot of Proteus

Screenshot from result in Safran Planner.


Copyright Notice

Copyright © 2012 Promineo All rights reserved. No part of this publication may be reproduced in any manner without the prior agreement and written permission of the publisher.

Published by: Proteus Development Team, Eiganesveien 8, Stavanger, Norway Date: December 2012

Feedback: We always try to improve our product, including its documentation.

Please feel encouraged to report any errors or other feedback regarding this document to: [email protected]

Proteus v2.0 User Guide - Promineoclickonce.promineo.no/Proteus/Documentation/2.0/Proteus 2.0...

Documents

Transcript of Proteus v2.0 User Guide - Promineoclickonce.promineo.no/Proteus/Documentation/2.0/Proteus 2.0...