Difference between revisions of "ART Scenario Editor"
(added template Underconstruction so page can be found as todo) |
|||
| Line 1: | Line 1: | ||
{{Underconstruction}} | {{Underconstruction}} | ||
| + | |||
| + | =Form parameters= | ||
| + | The scenarios form, as most other forms, supports parametrization. | ||
| + | |||
| + | <syntaxhighlight lang="text"> | ||
| + | /decor-scenarios--[prefix]?id=[scenario/transaction id]&effectiveDate=[scenario/transaction effective date]&datasetId=[dataset id]&datasetEffectiveDate=[dataset effective date]&conceptId=[concept id]&conceptEffectiveDate=[concept effective date] | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | {| style="text-align: left;" class="artdecor" | ||
| + | ! Parameter !! Description !! Since | ||
| + | |- | ||
| + | | prefix || Project prefix || ''always'' | ||
| + | |- | ||
| + | | id | ||
| + | | Switches to the project scenario or transaction with this id. Format: OID | ||
| + | | ''always'' | ||
| + | |- | ||
| + | | effectiveDate | ||
| + | | Switches to the project scenario or transaction with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param id | ||
| + | | ''always'' | ||
| + | |- | ||
| + | | datasetId | ||
| + | | Filters the list of scenarios/transaction to those that binds the project dataset with this id. Format: OID | ||
| + | | ''always'' | ||
| + | |- | ||
| + | | datasetEffectiveDate | ||
| + | | Filters the list of scenarios/transaction to those that binds 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 | ||
| + | | ''always'' | ||
| + | |- | ||
| + | | actorId | ||
| + | | Selects the actor with this id in the list of actors. Format: OID. Setting this param assumes param section=actors | ||
| + | | ''always'' | ||
| + | |- | ||
| + | | section | ||
| + | | Switches to the requested section. Options | ||
| + | * scenarios (default if actorId is not used) - switches to the tab Scenarios | ||
| + | * actors (default if param actorId is used) - switches to the tab Actors | ||
| + | | art v1.5.3 | ||
| + | |} | ||
Revision as of 14:14, 26 August 2015
 | This article or section is in the middle of an expansion or major restructuring and is not yet ready for use. You are welcome to assist in its construction by editing it as well. |
Form parameters
The scenarios form, as most other forms, supports parametrization.
/decor-scenarios--[prefix]?id=[scenario/transaction id]&effectiveDate=[scenario/transaction effective date]&datasetId=[dataset id]&datasetEffectiveDate=[dataset effective date]&conceptId=[concept id]&conceptEffectiveDate=[concept effective date]
| Parameter | Description | Since |
|---|---|---|
| prefix | Project prefix | always |
| id | Switches to the project scenario or transaction with this id. Format: OID | always |
| effectiveDate | Switches to the project scenario or transaction with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param id | always |
| datasetId | Filters the list of scenarios/transaction to those that binds the project dataset with this id. Format: OID | always |
| datasetEffectiveDate | Filters the list of scenarios/transaction to those that binds 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 | always |
| actorId | Selects the actor with this id in the list of actors. Format: OID. Setting this param assumes param section=actors | always |
| section | Switches to the requested section. Options
|
art v1.5.3 |
