Description of non-dimensional functions
The Dataprocessing function
| Element | Description |
|---|---|
| Availability | From 3.1106 |
| Syntax | dataprocessing |
| Attributes | - desc - dataprocessingcount |
Examples
- dataprocessing.desc
Returns the string "Data Processing in progress", in the user's application language, in the presence of data processing operating on the set of dimensions defined by the form filters, otherwise it returns an empty string.
- dataprocessing.dataprocessingcount
Returns the number of data processes in progress on the set of dimensions defined by the form filters.
The Datasource function
| Element | Description |
|---|---|
| Availability | From 3.1103 |
| Syntax | datasource |
| Attributes | - code - desc |
Examples
- Datasource.code
Returns the code of the datasource in use.
- Datasource.desc
Returns the description of the datasource in use.
The Process function
| Element | Description |
|---|---|
| Availability | From 3.0903 |
| Syntax | process([scenario],[period]) |
| Attributes | - code - desc - BusinessCycle - Scenarios - Periods |
| Parameters | - (Optional) scenario: scenario code - (Optional) period: period code |
Examples
- Process.code
Returns the code of the process on which data entry is carried out. If the form is not run in data entry mode, an error is generated.
- Process.desc
Returns the description of the process on which data entry is carried out. If the form is not run in data entry mode, an error is generated.
- Process($Scenario.code,$Period.code).code
Returns the code of the process to which scenarios/periods present in the form/tab filter are related. If the scenario-period combination has no related process, this function will generated an error.
- Process($Scenario.code,$Period.code).desc
Returns the description of the process to which scenarios/periods present in the form/tab filter are related. If the scenario-period combination has no related process, this function will generated an error.
The BusinessCycle function
| Element | Description |
|---|---|
| Availability | From 5.3.11 |
| Syntax | process.BusinessCycle |
| Attributes | - code - desc |
| Parameters | No parameter. |
Examples
- Process.BusinessCycle.code
Returns the process submission type code. For single submission, it returns "U", for scenarios/periods, it returns "S".
- Process.BusinessCycle.desc
Returns the description of the process submission type. For single submission, it returns "Single", for scenarios/periods, it returns "Scenario/Period".
The Scenarios function
| Element | Description |
|---|---|
| Availability | From 5.3.11 |
| Syntax | process.Scenarios |
| Attributes | - code |
| Parameters | No parameter. |
Example
Process.Scenarios.code
Returns the codes of the scenarios associated with the current process.
| Element | Description |
|---|---|
| Availability | From 5.3.14 |
| Syntax | process([processo]).Scenarios |
| Attributes | - code |
| Parameters | (Optional) process: process code |
Example
Process(@PARAMETRO_PROCESSO).Scenarios
Returns the codes of the original and consolidation scenarios, associated with the process specified via a dynamic parameter. This function can be inserted in a scenario-type parameter based either on the flat dimension or on a hierarchical dimension.
The Periods function
| Element | Description |
|---|---|
| Availability | From 5.3.SP14 |
| Syntax | process.Periods |
| Attributes | code |
| Parameters | (Optional) process: process code |
Examples
- Process.Periods
Returns the codes of the periods associated with the current process.
- Process(@COD_PROCESSO).Periods
Returns the codes of the periods associated with the process specified as the parameter.
The Item(n) function
| Element | Description |
|---|---|
| Availability | From 5.3.11 |
| Syntax | process.Scenarios.Item(n) |
| Parameters | n: scenario to be targeted, ordered by code from 0 in ascending alphabetical order. |
| Value returned | Scenario n from among those associated with the process |
The ProcessScenarioPeriods function
| Element | Description |
|---|---|
| Availability | From 5.3.SP14 |
| Syntax | ProcessScenarioPeriods(codProcesso,codScenario) |
| Parameters | - codProcesso: process code - codScenario: scenario code |
| Value returned | Available (not locked) periods of a scenario belonging to the selected process |
Examples
- ProcessScenarioPeriods("ACT","2019BDG")
If there is a process with code "ATC" containing a scenario with code "2019BDG", it returns the non-locked periods of the scenario associated with the process.
- ProcessScenarioPeriods(@COD_PROCESSO,@COD_SCENARIO)
If a parameter with code @COD_PROCESSO and a scenario-type parameter with code @COD_SCENARIO are selected, and the scenario belongs to the process, it returns the non-locked periods of that specific scenario associated with the process.
The Server function
| Element | Description |
|---|---|
| Availability | From 4.2.1 |
| Syntax | server |
| Attributes | url |
Example
Server.url
Returns the string containing the url of the server to which the client is connected.
The User function
| Element | Description |
|---|---|
| Availability | From 3.0903 |
| Syntax | user |
| Value returned | User who performed the login (current user) |
| Attributes | - code - desc - appLang - code - desc - langIndex - tablesLang - code - desc - langIndex |
Examples
- User.code
Returns the code of the current user.
- User.desc
Returns the description of user.
- User.appLang.code
Returns the code of the user's application language.
- User.appLang.desc
Returns the description of the user's application language.
- User.appLang.langIndex
Returns the whole number by which the user's application language is identified.
- User.tablesLang.code
Returns the code of the user's table language.
- User.tablesLang.desc
Returns the description of the user's table language.
- User.tablesLang.langIndex
Returns the whole number identifying the user's table language.
The Dict function
| Element | Description |
|---|---|
| Availability | From 4.3.2 |
| Syntax | dict(codVoceDizionario, [language]) |
| Value returned | String containing the description of the dictionary item identified by codVoceDizionario. |
| Parameters | - codVoceDizionario: shared dictionary item code - [language] (optional): language in which the dictionary item description is returned (numbers from 0 to 4). If omitted, it returns the description in the language in which the form was run. |
The Datasetpartition function
| Element | Description |
|---|---|
| Availability | From 5.3.SP7 |
| Syntax | DATASETPARTITION(codWorkspace, codDataset, [codProcesso], [codScenario], [codPeriodo], [codAzienda], [codTipologia], [valoreSeMancante]) |
| Value returned | String containing the Dataset physical partition name identified by the codDataset code and belonging to the workspace with the codWorkspace code. Based on the partitioning type, the other additional parameters need to be specified. |
| Parameters | - codWorkspace. Workspace code - codDataset. Dataset code - codProcesso. Process code - codScenario. Scenario code - codPeriodo. Period code - codAzienda. Entity code - codTipologia. Type code - valoreSeMancante. (optional) String returned if the partition does not exist |
Particular features for parameters¶
Parameters can be specified using fixed values (between double inverted commas) or using the dedicated syntax. See Details of advanced selection scripts for calculating the default value.
The values of the parameters, separated by commas, are interpreted based on the position in which they are specified (the first string is interpreted as the Workspace code, the second as the Dataset code, etc.). To omit an optional parameter, specify an empty string in the relative position, between double inverted commas or otherwise.
- With Dataset not partitioned: set the first two parameters only. If specified, the other parameters will be ignored by the system.
- With Dataset partitioned by Business Cycle: also specify the Process. If the Process is submission by Scenario/Period, the Scenario and Period will also need to be specified, otherwise the codScenario and codPeriodo parameters are optional and will be ignored by the system if specified. If the process is single submission, only the Process needs to be specified, in addition to the reference dataset and workspace.
- With Dataset partitioned by Business Cycle and Entity: specify the Process and Entity. If the chosen Process is submission by Scenario/Period, the Scenario and Period will also need to be specified, otherwise the codScenario and codPeriodo parameters will be ignored by the system. These parameters must in any case be set, but this can be done using an empty value. If the dataset is partitioned by entity, then the entity must be specified. If some parameters are not specified because they are not required by the partitioning type, then they will be ignored. When such parameters are not necessary, the user can avoid specifying them, using several consecutive commas (as many as there are parameters to ignore) or empty strings.
To access data of a different type from the Reporting Layer: also specify the type parameter, in addition to the various parameters for the partitioning type used.
In general, access to a calculation type requires the user to specify the Entity (or the node of Entities - hierarchy code pipenode code) that they want to access: to dynamically resolve the lowest level element or the Entity node of the context, the entity parameter can be specified with the following syntax: if($Entity.isleaf,$Entity.code,$Entity.Dimension.hierarchyCode +"|" + $Entity(False).code)
For example, it is possible to obtain the partition with DatasetPARTITION("001", "000007", "ACT", "2019ACT", "05", , "TYPOL") of the dataset partitioned by business cycle with code "000007" in the workspace with code "001", given the process is submission by scenario/process, relative to the "ACT" process, period "05" of scenario "2019ACT", with type "TYPOL" but not partitioned by entity. The same behaviour is obtained using the following wording, with the inverted commas: DatasetPARTITION("001", "000007", "ACT", "2019ACT", "05", "", "TYPOL").
If the specified parameters do not identify any partition existing on the system, the cell field will not return an error but an empty string and if this is used in a query as an extraction table then a syntax error message will be returned on reading. If the partition is not present but a value to return in case the partition is missing (valoreSeMancante parameter) is specified as the last parameter, then the function will return the value inserted as the parameter.
Examples
- DatasetPARTITION("001", "000006")
With a non-partitioned dataset with code "000006" in the workspace with code "001", it returns the name of the single physical partition, if present.
- DatasetPARTITION("001", "000007", "BUD")
With a dataset partitioned by business cycle with code "000007" in the workspace with code "001", and given the "BUD" single submission process, it returns the name of the single physical partition related to the "BUD" process, if present.
- DatasetPARTITION("001", "000007", "ACT", "2019ACT", "01")
With a dataset partitioned by business cycle with code "000007" in the workspace with code "001", and given the "ACT" scenario/period submission process, it returns the name of the single physical partition, if present, related to the "ACT" process, period "01" of scenario "2019ACT".
- DatasetPARTITION("001", "000007", process("2019ACT","01"), "2019ACT", "01")
With a dataset partitioned by business cycle with code "000007" in the workspace with code "001", it returns the name of the single physical partition, if present, related to period "01" of scenario "2019ACT" and to the process to which the scenario-period combination is related. That process is returned by the "process("2019ACT","01")" function.
- DatasetPARTITION("001", "000008", "BUD", "", "", "CORP")
With a dataset partitioned by business cycle - entity with code "000008" in the workspace with code "001", and given the "BUD" single submission process, it returns the name of the single physical partition, if present, related to the "BUD" process, entity "CORP".
- DatasetPARTITION("001", "000008", "ACT", "2019ACT", "01", "CORP")
With a dataset partitioned by business cycle - entity with code "000008" in the workspace with code "001", and given the "ACT" scenario/period submission process, it returns the name of the single physical partition, if present, related to the "ACT" process, period "01" of scenario "2019ACT", entity "CORP".
- DatasetPARTITION("001", "000008", process("2019ACT","01") , "2019ACT", "01", "CORP")
With a dataset partitioned by business cycle with code "000007" in the workspace with code "001", it returns the name of the single physical partition, if present, related to entity "CORP", period "01" of scenario "2019ACT" and to the process to which the scenario-period combination is related. That process is returned by the "process("2019ACT","01")" function.
DatasetPARTITION("001", "000007", "ACT", "2019ACT", "05", , , "TGK_DUAL")
With a dataset partitioned by business cycle with code "000007" in the workspace with code "001", and given the "ACT" scenario/period submission process, related to the "ACT" process, period "05" of scenario "2019ACT", and no partition has been generated for that scenario/period pair, then it returns the text reported as the last "TGK_DUAL" parameter.