Creating an active web publishing link
Active web publishing link parameters differ for each object type. A link is case‑sensitive. Create an active web publishing link using the following syntax:
http://ServerName/MetricsManagementWebClient/directURL_ObjectType.aspx
?objectID=<objectIDvalue>&objectID=<objectIDvalue>
where
*ServerName/MetricsManagementWebClient specifies the address of the Metrics Management Web Client application, for example:
MetricsManagementServer/MetricsManagement
*directURL_ObjectType.aspx?objectID specifies the object type, for example:
directURL_view.aspx?viewID
Table 8‑26 describes the available object types and mandatory object IDs.
Table 8‑26 Metrics Management object type parameters
Object type
Parameter
Book
directURL_book.aspx?ID
Dashboard
directURL_dashboard.aspx?viewID
Map
directURL_map.aspx?mapID
Section
directURL_book.aspx?sectionID
View
directURL_view.aspx?viewID
*objectID=<objectIDvalue> specifies the object ID parameters. For example:
viewID=-1970514038
Use the ampersand (&) character to separate multiple parameters, for example:
viewID=-1970514038&periodID=60930526
The following sample active web publishing link references the Balanced Metrics Management view and January 2011 period:
http://<yourservername>/Metrics Management
/directURL_view.aspx?viewID=-1970514038&periodID=60930526
About book objectID parameters
Table 8‑27 describes book objectID parameters for active web publishing links.
Table 8‑27 Book objectID parameters for Active web publishing links
Parameter
Description
ID
Mandatory. Specifies the book to open. Users can also open all sections in the book.
periodID
Optional. Specifies the period for the book. To use the most recent completed period, do not specify the periodID parameter.
The following sample active web publishing link opens the Corporate Management book:
http://MetricsManagementServer/MetricsManagement/directURL_book.aspx?ID=1986762926
Table 8‑28 describes the book objectID parameter for Metrics Management portal links.
Table 8‑28 Book objectID parameter for Metrics Management portal links
Parameter
Description
bookID
Mandatory. Specifies the book to open. Users can also open all sections in the book.
The following sample Metrics Management portal link opens the Corporate Governance Compliance Book:
http://MetricsManagementServer/MetricsManagement
/portal_book.aspx?bookID=-1960247508&s=
MetricsManagementServer&d=
Sample+Corporate&m=MetricsManagement
About book section objectID parameters
Table 8‑29 describes book section objectID parameters.
Table 8‑29 Book section objectID parameters
Parameter
Description
sectionID
Mandatory. Specifies the book section to open.
periodID
Optional. Specifies the period for the section. To use the most recent completed period, do not specify the parameter.
The following sample Metrics Management portal link opens the Leading Indicators section only at the January 2010 period:
http://MetricsManagementServer/MetricsManagement
/portal_section.aspx?sectionID=
-2044797168&periodID=-347543466&s=
MetricsManagementServer&d=Sample+Corporate&m=MetricsManagement
The following sample active web publishing link opens the Operational Measures section only:
http://MetricsManagementServer/MetricsManagement
/directURL_book.aspx?sectionID=1146842186
About dashboard objectID parameters
Table 8‑30 describes dashboard objectID parameters. A link with no optional parameters displays the dashboard at the top measure, top location, and completed period for the specified view.
Table 8‑30 Dashboard objectID parameters
Parameter
Description
viewID
Mandatory. Specifies the view available to the dashboard.
locationID
Optional. Specifies the location at which the dashboard opens. The location must belong to the specified view.
measureID
Optional. Specifies the measure at which the dashboard opens. The measure must belong to the specified view.
periodID
Optional. Specifies the period for the dashboard. To use the most recent completed period, do not specify the parameter.
The following sample Metrics Management portal link opens the dashboard to the Customer Perspective measure and UK location:
http://MetricsManagementServer/MetricsManagement
/portal_dashboard.aspx?viewID=-1970514038&measureID=
1397935581&locationID=1787291502&s=
MetricsManagementServer&d=Sample+Corporate&m=
MetricsManagement
The following sample active web publishing link opens the dashboard to the Environment measure and EMEA location:
http://MetricsManagementServer/MetricsManagement
/directURL_dashboard.aspx?viewID=1532921478
&measureID=883965183&locationID=-2021725154
About map objectID parameters
Table 8‑31 describes map objectID parameters.
Table 8‑31 Map objectID parameters
Parameter
Description
mapID
Mandatory. Specifies the map to open.
comparisonID
Optional. Specifies the comparison series at which the map opens.
locationID
Optional. Specifies the location for measures in a measure only map.
measureID
Optional. Specifies the measure for locations in a location only map.
periodID
Optional. Specifies the period for the map. To use the most recent completed period, do not specify the parameter.
The following sample Metrics Management portal link opens the Strategy map:
http://MetricsManagementServer/MetricsManagement
/portal_map.aspx?mapID=-1456528854&s=
MetricsManagementServer&d=Sample+Corporate&m=MetricsManagement
The following sample link opens the Critical Measures Performance Matrix map to the Solvent Reduction measure:
http://MetricsManagementServer/MetricsManagement
/directURL_map.aspx?mapID=-1700065194&measureID=-2044672214
About view objectID parameters
Table 8‑32 describes view objectID parameters.
Table 8‑32 View objectID parameters
Parameter
Description
viewID
Mandatory. Specifies the view that a link opens.
comparisonID
Optional. Specifies the comparison series at which the view opens.
locationID
Optional. Specifies the top location for the view.
measureID
Optional. Defines the specified measure as the top measure in a custom view.
periodID
Optional. Specifies the period for the view. To use the most recent completed period, do not specify the parameter. The period must be within the display period range of the specified view.
The following sample Metrics Management portal link opens the Balanced Metrics Management view at the customer perspective measure:
http://MetricsManagementServer/MetricsManagement
/portal_view.aspx?viewID=-1970514038&measureID=1397935581
&locationID=437336099&comparisonID=-2107299553
&periodID=1005640468&s=MetricsManagementServer&d=
Sample+Corporate&m=MetricsManagement
The following sample link opens the Overall View of Performance view at July 2011:
http://MetricsManagementServer/MetricsManagement
/directURL_view.aspx?viewID=1532921478&periodID=-558287148