You can access Investor module, Scorecard module, Workbook module, Forms module, and Dashboard module pages from external applications, using the following format:
Syntax
<protocol>://<PPM server>/<PPM virtual directory>/Portfolios/View.htm?<parameters>
where:
<protocol> = https<PPM server> = The name of the server PPM is running on.<PPM virtual directory> = the name of the PPM virtual directory (usually ProSight)<parameters> = a string of parameters that specifies the page to open. The string is in the form:
<parameter name>=<value>&<parameter name>=<value>&<parameter name>=<value>%
Note that the first parameter is not preceded by an ampersand (&).
Example
https://myserver/ProSight/Portfolios/View.htm?window=form&itemID=5&formID=10&formTabID=15
Parameters Rules
Parameters describe the content of the page to open. Parameters vary based on the type of window you want to view. The following rules apply to parameters.
- When a view is missing an expected parameter, it is replaced by either the default or current value in the system. For example, if an item identifier is missing, the default or current item is displayed.
- Parameter names and values are not case sensitive.
General Parameters
The window parameter is required, while all other parameters are optional and can be in any order.
Name | Purpose | Expected Value |
|---|---|---|
window | Identifies the module you want to display. | db = Dashboard module. You must also specify the item to display. wb = Workbook module |
itemID | The ID of the item or portfolio you want to display in the selected module. | Number corresponding with the database ID of the item or portfolio. |
itemName | The name of the item or portfolio you want to display in the selected module. | Escaped string corresponding with the name of the item or portfolio. |
itemCI | The common identifier of the item or portfolio you want to display in the selected module. Use this parameter for OEM purposes. | Number corresponding with the common identifier of the item or portfolio, as set in the values of the category denoted by commonIDCategoryName. |
commonIDCategoryName | The category name holding the items or portfolios common identifiers. Use this parameter for OEM purposes. | Escaped string corresponding with the name of the category holding the items and portfolios common identifiers. |
Investor Parameters
Name | Purpose | Expected Value |
|---|---|---|
mapID | The ID of the map you want to display in the Investor module. | Number corresponding with the database ID of the map. |
mapName | The name of the map you want to display in the Investor module. | Escaped string corresponding with the name of the map. |
viewMode | Identifies how you want to view a portfolio of portfolios. | items = items view mode |
verID | The ID of the scenario you want to display in the Investor module, corresponding with the specified portfolio. | Number corresponding with the database ID of the scenario. |
verName | The name of the scenario you want to display in the Investor module, corresponding with the specified portfolio. | Escaped string corresponding with the name of the scenario. |
colorCatID | The color axis category ID you want to display in the map. | Number corresponding with the database ID of the category. |
colorCatName | The color axis category name you want to display in the map. | Escaped string corresponding with the name of the category. |
sizeCatID | The size axis category ID you want to display in the map. | Number corresponding with the database ID of the category. |
sizeCatName | The size axis category name you want to display in the map. | Escaped string corresponding with the name of the category. |
asOfDate | The as of date. | Escaped string in the format m/d/yyyy. |
asOfID | The version ID. | Number corresponding with the database ID of the version. |
asOfName | The version name. | Escaped string corresponding with the name of the version. |
Scorecard Parameters
Name | Purpose | Expected Value |
|---|---|---|
scID | The ID of the scorecard you want to display. | Number corresponding with the database ID of the scorecard. |
scName | The name of the scorecard you want to display. | Escaped string corresponding with the name of the scorecard. |
asOfDate | The as of date. | Escaped string in the format m/d/yyyy. |
asOfID | The version ID. | Number corresponding with the database ID of the version. |
asOfName | The version name. | Escaped string corresponding with the name of the version. |
Workbook Parameters
Name | Purpose | Expected Value |
|---|---|---|
scID | The ID of the scorecard you want to display. | Number corresponding with the database ID of the scorecard. |
scName | The name of the scorecard you want to display. | Escaped string corresponding with the name of the scorecard. |
tabName | The name of the workbook you want to display. | ai = Action Items tab |
dependenciesType | The type of dependency you want to display in the Dependencies tab | 1 = item depend on |
Forms Parameters
Name | Purpose | Expected Value |
|---|---|---|
formID | The ID of the form you want to display in the Forms module. | Number corresponding with the database ID of the form. |
formName | The name of the form you want to display in the Forms module. | Escaped string corresponding with the name of the form. |
tabID | The ID of the tab you want to display in the Forms module, corresponding with the displayed form. | Number corresponding with the database ID of the tab. |
tabName | The name of the tab you want to display in the Forms module, corresponding with the displayed form. | Escaped string corresponding with the name of the tab. |
asOfDate | The as of date. | Escaped string in the format m/d/yyyy. |
asOfID | The version ID. | Number corresponding with the database ID of the version. |
asOfName | The version name. | Escaped string corresponding with the name of the version. |
Dashboard Parameters
Name | Purpose | Expected Value |
|---|---|---|
dashboardID | The ID of the dashboard you want to display in the Dashboard module. | Number corresponding with the database ID of the dashboard. |
dashboardName | The name of the dashboard you want to display in the Dashboard module. | Escaped string corresponding with the name of the dashboard. |
tabID | The ID of the tab you want to display in the Dashboard module, corresponding with the displayed dashboard. | Number corresponding with the database ID of the tab. |
tabName | The name of the tab you want to display in the Dashboard module, corresponding with the displayed dashboard . | Escaped string corresponding with the name of the tab. |
asOfDate | The as of date. | Escaped string in the format m/d/yyyy. |
asOfID | The version ID. | Number corresponding with the database ID of the version. |
asOfName | The version name. | Escaped string corresponding with the name of the version. |
To Do Parameters
Name | Purpose | Expected Value |
|---|---|---|
tabName | The name of the tab you want to display in the To Do module. | ai = Action Items tab |
My Processes Parameters
Name | Purpose | Expected Value |
|---|---|---|
processFolderID | The ID of the My Processes folder you want to display. | Number corresponding with the database ID of the process folder. |
Escaping Strings
String escaping is the operation of replacing certain characters in a string with other characters that are valid for the usage of the string. When using name values in parameters, you should escape the values.
Character | ASCII code | Escaped value |
|---|---|---|
Space | 32 | %20 |
! | 33 | %21 |
" | 34 | %22 |
# | 35 | %23 |
$ | 36 | %24 |
% | 37 | %25 |
& | 38 | %26 |
' | 39 | %27 |
( | 40 | %28 |
) | 41 | %29 |
+ | 43 | %2B |
, | 44 | %2C |
: | 58 | %3A |
; | 59 | %3B |
< | 60 | %3C |
= | 61 | %3D |
> | 62 | %3E |
? | 63 | %3F |
[ | 91 | %5B |
\ | 92 | %5C |
] | 93 | %5D |
^ | 94 | %5E |
` | 96 | %60 |
{ | 123 | %7B |
| | 124 | %7C |
} | 125 | %7D |
~ | 126 | %7E |
Any other character with an ASCII code lower than 32 or higher than 126 should be escaped to the % character followed by the hexadecimal valuf of the ASCII code.