Internal Links Configuration
An internal URL link displays a related project concept or metric using a matching condition.
The match is between the following:
- A property or field in the target concept or metric.
- A field in the source metric (the metric you are configuring).
The target type instance is retrieved from the cache or backing store (depending on configuration) by a query and displays in a search page.
Syntax
/page.html?stoken=${USR:TOKEN}&pagetype=SearchPage &typename=TargetType&TargetPropertyOrField=${VAR:SourceMetricField}
See Table 5, Metric Link to Internal URL—Syntax, for syntax details. (The VAR variable is documented in Substitution Variable Syntax.)
Example
/page.html?stoken=${USR:TOKEN}&pagetype=SearchPage
&typename=TargetConcept&CProperty2=${VAR:MField1}
Specify the syntax in the a field of the metric you are configuring. The link displays the instance of the specified concept (TargetConcept) in which the value of the specified concept property (CProperty2) matches the value of the specified metric field (MField1).
You can choose any field in the metric you are configuring. Often the field is the one in which the URL link is configured, but this is not required.
| Syntax Element | Notes |
|---|---|
| /page.html | This is the required beginning of the URL |
| stoken | This parameter is required to authenticate the user when launching the referenced page. It enables the software to reuse the login session. Required. |
| pagetype | Indicates what type of page to load. In this release the required value is SearchPage. |
| TargetType | The name of the concept or metric. If the name is unique project wide, you can specify the simple name, for example, Foo. If the name is reused in different folders, you must provide the complete project path. When specifying a project path, use an initial slash, for example: /somefolder/anotherfolder/Foo. |
| TargetPropertyOr Field | The name of the target concept property or metric field to use for the matching condition. The value of TargetPropertyOrField must match the value of ${VAR:SourceMetricField}. For usage of VAR, see Substitution Variable Syntax |