Difference between revisions of "ART Template Associations"
(→Go to the templates/template mapping dialog) |
(→Form parameters) |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 3: | Line 3: | ||
==Menu== | ==Menu== | ||
| − | Go to the templates/template mapping dialog. | + | Go to the templates/template mapping dialog of the project. |
| + | |||
[[File:TemplateMapping-Menu.png|400px|Template Mapping Menu]] | [[File:TemplateMapping-Menu.png|400px|Template Mapping Menu]] | ||
| Line 25: | Line 26: | ||
[[File:TemplateMapping-Templatetargets.png|650px|Target icon on template element]] | [[File:TemplateMapping-Templatetargets.png|650px|Target icon on template element]] | ||
| + | |||
| + | =Form parameters= | ||
| + | The template association form, as most other forms, supports parametrization. | ||
| + | |||
| + | <syntaxhighlight lang="text" enclose="div"> | ||
| + | /decor-template-mapping--[prefix]?id=[template id/name]&effectiveDate=[template effective date]&datasetId=[dataset id]&datasetEffectiveDate=[dataset effective date]&conceptId=[concept id]&conceptEffectiveDate=[concept effective date]&language=[ll-CC] | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | {| style="text-align: left;" class="artdecorwiki" | ||
| + | ! Parameter !! Description !! Since | ||
| + | |- | ||
| + | | prefix || Project prefix || ''always'' | ||
| + | |- | ||
| + | | id | ||
| + | | Switches to the project template with this id/name. Format: OID/name. Note: while references by name remain supported on best effort basis for historic reasons they are notoriously ambiguous and hence strongly discouraged. | ||
| + | | art v1.5 | ||
| + | |- | ||
| + | | effectiveDate | ||
| + | | Switches to the project template with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param id | ||
| + | | art v1.5 | ||
| + | |- style="font-style:italic;" | ||
| + | | templateRef | ||
| + | | Switches to the project template with this id/name. Format: OID | ||
| + | | ''always'' (deprecated in art >= 1.5) | ||
| + | |- style="font-style:italic;" | ||
| + | | templateEffectiveDate | ||
| + | | Switches to the project template with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param templateRef | ||
| + | | ''always'' (deprecated in art >= 1.5) | ||
| + | |- | ||
| + | | datasetId | ||
| + | | Selects the project dataset with this id. Format: OID | ||
| + | | ''always'' | ||
| + | |- | ||
| + | | datasetEffectiveDate | ||
| + | | Selects the project dataset with this effectiveDate. Format: yyyy-mm-ddThh:mm:ss. | ||
| + | | art v1.5 | ||
| + | |- | ||
| + | | conceptId | ||
| + | | Selects the dataset concept with this id in the selected transaction. Format: OID. Param only works if the param id points to a transaction that binds the dataset that contains this concept. | ||
| + | | ''always'' | ||
| + | |- | ||
| + | | conceptEffectiveDate | ||
| + | | Selects the dataset concept with this effective date in the selected transaction. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param conceptId | ||
| + | | art v1.5 | ||
| + | |- | ||
| + | | language | ||
| + | | Displays contents in the requested language. When contents are not available in the requested language, there will be nothing to display. Example en-US, or nl-NL. | ||
| + | | art v1.8.51 | ||
| + | |} | ||
Latest revision as of 11:00, 4 October 2017
Contents
Creating ART Template Associations
Template associations link template elements to dataset concepts. The rationale is to make a link possible between a functional concept in a dataset / scenario and their technical representation in the form of a template element and it's properties.
Menu
Go to the templates/template mapping dialog of the project.
Dialog
A dialog opens were you can select concepts with the view on a dataset or a scenario (1). On the left hand side the Concepts are listed (2) and shown in detail in area (3), on the right hand side all available templates are listed (4) and shown in details in area (5).
Selection
Select the concept (lefthand side) and the template (righthand side) you want to link together. The area (6) in the middle of the screen allows you to create the association.
Select the template element from the dropdown box to link the template element to the dataset concept (1) and click on Create template association (2) to establish the link and save the template association. If there are no existing template element ids yet (usually the case) then add them with the button Add element ids (3). You have the option to even create a template based on the selected information (4).
Display
The template associations are typically shown as a "target" icon at the corresponding template element (1).
Form parameters
The template association form, as most other forms, supports parametrization.
/decor-template-mapping--[prefix]?id=[template id/name]&effectiveDate=[template effective date]&datasetId=[dataset id]&datasetEffectiveDate=[dataset effective date]&conceptId=[concept id]&conceptEffectiveDate=[concept effective date]&language=[ll-CC]
| Parameter | Description | Since |
|---|---|---|
| prefix | Project prefix | always |
| id | Switches to the project template with this id/name. Format: OID/name. Note: while references by name remain supported on best effort basis for historic reasons they are notoriously ambiguous and hence strongly discouraged. | art v1.5 |
| effectiveDate | Switches to the project template with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param id | art v1.5 |
| templateRef | Switches to the project template with this id/name. Format: OID | always (deprecated in art >= 1.5) |
| templateEffectiveDate | Switches to the project template with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param templateRef | always (deprecated in art >= 1.5) |
| datasetId | Selects the project dataset with this id. Format: OID | always |
| datasetEffectiveDate | Selects the project dataset with this effectiveDate. Format: yyyy-mm-ddThh:mm:ss. | art v1.5 |
| conceptId | Selects the dataset concept with this id in the selected transaction. Format: OID. Param only works if the param id points to a transaction that binds the dataset that contains this concept. | always |
| conceptEffectiveDate | Selects the dataset concept with this effective date in the selected transaction. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param conceptId | art v1.5 |
| language | Displays contents in the requested language. When contents are not available in the requested language, there will be nothing to display. Example en-US, or nl-NL. | art v1.8.51 |
