Using Metrics Management information in a link
A dynamic link uses variables to pass information from Metrics Management to a URL. These variables are either system variables or link tags. A system variable supports passing properties of a specific Metrics Management object to a link, for example, the name of the selected measure or the logged-in user’s e‑mail address. A link tag is a user-defined text value for a specific Metrics Management object. Each book, database, location, measure, and user supports up to four link tags. The object owner or the system specialist defines the link tag value.
When using a variable in a link, ensure that the variable has a value in the context in which a user accesses it. Using a variable that has no value causes the link to fail. For example, a link using location information fails if placed on a measure.
A variable provides access to properties of any of the context items named in Table 8‑33.
Table 8‑33 Context item types and names
Context item type
Context item name
Assistant to the owner of the currently selected measure
SelectedMeasureAssistant
Currently selected location
SelectedLocation
Currently selected map
SelectedMap
Currently selected measure
SelectedMeasure
Currently selected section
SelectedSection
Currently selected view
SelectedView
Logged-in database
CurrentDatabase
Logged-in user
CurrentUser
Owner of the currently selected measure
SelectedMeasureOwner
Period information
Calendar
Period of the currently selected data
SelectedPeriod
Most context items have a name property. Other properties are specific to the type of context item.
A dynamic link is not available if the specified property does not have a value. For example, <%SelectedMeasureOwner.Email%> does not appear if the selected measure owner does not have e‑mail information.
About calendar properties
Calendar properties provide values for the completed, current, and locked period for each available period type. If the database does not use a period type, those period properties do not have a value. For example, most Metrics Management databases do not support the week or day period types. The context item that provides calendar properties is Calendar. Table 8‑34 lists and describes calendar properties.
Table 8‑34 Calendar properties
Property name
Value
Format and example
Completed.Year
The completed year, specified in Calendar Settings
yyyy
2010
Completed
.Quarter
The completed quarter, specified in Calendar Settings
Qq yyyy
Q4 2010
Completed
.Month
The completed month, specified in Calendar Settings
mmm yyyy
Feb 2011
Completed.Week
The completed week, specified in Calendar Settings
yyyy/Www
2011/W09
Completed.Day
The completed day, specified in Calendar Settings
yyyy/mm/dd
2011/03/10
Current.Year
The current year, specified in Calendar Settings
yyyy
2011
Current.Quarter
The current quarter, specified in Calendar Settings
Qq yyyy
Q1 2011
Current.Month
The current month, specified in Calendar Settings
mmm yyyy
Mar 2011
Current.Week
The current week, specified in Calendar Settings
yyyy/Www
2010/W11
Current.Day
The current day, specified in Calendar Settings
yyyy/mm/dd
2011/03/15
Locked.Year
The locked year, specified in Calendar Settings
yyyy
2009
Locked.Quarter
The locked quarter, specified in Calendar Settings
Qq yyyy
Q3 2010
Locked.Month
The locked month, specified in Calendar Settings
mmm yyyy
Jan 2011
Locked.Week
The locked week, specified in Calendar Settings
yyyy/Www
2011/W05
Locked.Day
The locked day, specified in Calendar Settings
yyyy/mm/dd
2011/02/10
The following line shows an example of a calendar property as used in a link URL:
<%Calendar.Current.Year%>
About database properties
Database properties provide information about the database to which the user logs in. Database properties also include link tags, which are custom values defined by the system specialist. The context item that provides database properties is CurrentDatabase. Table 8‑35 lists and describes database properties.
Table 8‑35 CurrentDatabase properties
Property name
Value
Format and example
Name
Name of the current database
Text
Sample Corporate
Tag1
Link tag text from Link Tag field 1
Text
Tag2
Link tag text from Link Tag field 2
Text
Tag3
Link tag text from Link Tag field 3
Text
Tag4
Link tag text from Link Tag field 4
Text
The following line shows an example of a database property as used in a link URL:
<%CurrentDatabase.Name%>
About location properties
Metrics Management provides a single name property for the currently selected location. Location properties also include link tags, which are custom values defined by the system specialist or location owner. The context item that provides location properties is SelectedLocation. Table 8‑36 lists and describes location properties.
Table 8‑36 SelectedLocation properties
Property name
Value
Name
Name of the currently selected location
Tag1
Link tag text from Link Tag field 1
Tag2
Link tag text from Link Tag field 2
Tag3
Link tag text from Link Tag field 3
Tag4
Link tag text from Link Tag field 4
The following line shows an example of a location property as used in a link URL:
<%SelectedLocation.Name%>
About measure properties
Metrics Management provides a single name property for the currently selected measure. Measure properties also include link tags, which are custom values defined by the system specialist or measure owner. Three context items provide measure properties: SelectedMeasure, SelectedMeasureAssistant, and SelectedMeasureOwner. Table 8‑37 lists and describes measure properties provided by SelectedMeasure.
Table 8‑37 SelectedMeasure properties
Property name
Value
Name
Name of the currently selected measure
Tag1
Link tag text from Link Tag field 1
Tag2
Link tag text from Link Tag field 2
Tag3
Link tag text from Link Tag field 3
Tag4
Link tag text from Link Tag field 4
Table 8‑38 describes measure properties provided by SelectedMeasureAssistant.
Table 8‑38 SelectedMeasureAssistant properties
Property name
Value
Name
Name of the assistant to the measure owner
Email
E‑mail address of the assistant to the measure owner
Table 8‑39 describes measure properties provided by SelectedMeasureOwner.
Table 8‑39 SelectedMeasureOwner properties
Property name
Value
Name
Name of the owner of the currently selected measure
Email
E‑mail address of the measure owner
The following example shows measure properties used in a link URL to send an e-mail message to the measure owner:
mailto:<%SelectedMeasureOwner.Email%>
?subject=<%SelectedMeasure.Name%>
About user properties
User properties provide information about the currently logged-in user. User properties also include link tags, which are custom values defined by the system specialist or user owner. Table 8‑40 lists and describes user properties.
Table 8‑40 User properties
Property name
Value
Format and example
Email
E‑mail address of the current user
UserName@Company.Type
Sales@Actuate.com
LoginId
Login name defined for the Standard authentication method
Text
admin asst
Name
Name of the current user
Text
Admin Asst
Tag1
Link tag text from Link Tag field 1
Text
Tag2
Link tag text from Link Tag field 2
Text
Tag3
Link tag text from Link Tag field 3
Text
Tag4
Link tag text from Link Tag field 4
Text
The following example shows a measure property as used in a link URL:
<%CurrentUSer.Email%>
About selected map, period, section, and view properties
Metrics Management provides a single name property for each currently selected map, period, section, and view. The context items providing the name property are SelectedMap, SelectedPeriod, SelectedSection, and SelectedView respectively. The selected period is the period of the data displayed in the currently selected object. Table 8‑41 shows examples of the name property for these context items.
Table 8‑41 Examples of selected object names
Context item
Examples of name values
SelectedMap
Critical Measures Performance Matrix
SelectedPeriod
2011, Q1 2011, Mar 2011
SelectedSection
Critical Measures
SelectedView
An Overall View of Performance
Using a variable in a link destination
To use a variable in a link’s destination, you type the variable name in the link’s Filename or URL property. Type the variable using the following structure:
<%Context item.Property%>
The <% and %> characters must enclose the variable. To use multiple variables in the URL, enclose each variable separately in these characters.
For example, the following link opens a Google search on the selected measure:
http://www.google.ca/search?hl=en&q=<%SelectedMeasure.Name%>
The following e‑mail link passes the selected measure owner’s e‑mail address to the default mail program, and uses the selected measure name as the subject line:
mailto:<%SelectedMeasureOwner.Email%>
?subject=<%SelectedMeasure.Name%>
If a property value contains characters that Windows or an application launched by a link misinterprets, the link fails to open the destination as expected. Common examples of these characters include &, %, <, >, and space. Add .AsURL after the property name to encode these special characters so that Windows or the application interprets them correctly. For example, use <%SelectedMeasure.Name.AsURL%>. If the property contains international symbols, such as the Euro symbol, €, use .AsUTF8URL instead of .AsURL.
How to create a dynamic link using system variables
1 Open an existing link or create a new link.
2 In File or URL, in Filename or URL do one of the following tasks:
*Use the following syntax to create a URL:
http://www.linkaddress.com?item<%ContextItem.Property%>
where
*ContextItem is the context item, for example, SelectedMeasure.
*Property is the property of the context item, for example, Name.
*Use the following syntax to create an e‑mail link:
mailto:<%ContextItem.Email%>
where ContextItem is the context item. Select SelectedMeasureOwner, SelectedMeasureAssistant, or CurrentUser.
3 Choose Save.
Using link tags in a dynamic link
You can use a link tag to pass context information as a variable to a link. Define custom text values for up to four link tags for a database, user, measure, or location to pass the text values to links. For example, you can create an employee number as a link tag value. The number is then available in a link.
For example, if the selected measure’s name is “Employee Satisfaction,” and the value of the selected measure’s Link tag 1 is “Morale”, the following link:
http://www.google.com/search?hl=en
&q=<%SelectedMeasure.Name%>+<%SelectedMeasure.Tag1%>
&btnG=Google+Search&meta=
opens the following URL:
http://www.google.com/search?hl=en
&q="Employee Satisfaction"+"Morale"&btnG=Google+Search&meta=
How to create a link tag
1 From the Navigation Pane, choose Setup. Then, perform one of the following tasks:
*Choose Configure to define link tags for the overall database.
*Choose Locations to define link tags for a specific location.
*Choose Measures to define link tags for a specific measure.
*Choose Users to define link tags for a specific user.
2 In the main window, select an object and choose View and Edit.
3 In Setup, choose OptionsLink Tags.
4 Type up to four link tag values.
5 Choose Save.
After you have created link tags, you can pass them to URL, filename, application, and e‑mail links.
How to use a link tag
1 Open an existing link or create a new link.
2 In File or URL, in Filename or URL, use the following syntax to create a URL:
http://www.linkaddress.com?item<%ContextItem.TagN%>
where
*<ContextItem> can be the SelectedMeasureOwner, CurrentUser, CurrentDatabase, SelectedMeasure, or the SelectedLocation.
*<TagN> is a reference to the link tag, where N is 1 through 4. For example, to pass the Link tag 1 text value, use Tag1.
3 Choose Save.