Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt

Use this file to discover all available pages before exploring further.

Download sample file: sign-off-task-definitions.csv This file is used to create task definitions in bulk. For information on how to upload adjustments using this file, see Upload tasks.
Column NameDescriptionRequiredValue Example
nameThe name of the definition. Must be unique across all task definitions.YPnl
descriptionThe description of the definition.YDescription for the Pnl definition
categoryThe category of the definition.YPnl category
workflowTypeThe workflow type used by the subsequent tasks.Ysimple, 4-eyes or 4-eyes-kpi
workflowVariablesAny variables required by the workflow.Napprovers=MANAGERS;reviewers=USERS
startDateThe start date of the task definition with YYYY-MM-DD date format.Y2018-09-20
endDateThe end date of the task definition with YYYY-MM-DD date format.N2018-09-30
cubeThe cube on which the definition applies.YVaR ES Cube
serverThe server on which the definition applies.YMR
scopeValuesThe scope of the definition. If empty, the definition will be considered top of house.N[Booking].[Desks].[Desk]=[AllMember].[Commodity]|[AllMember].[Equities];[Organization].[BookHierarchy].[Level 4]=[AllMember].[Global Markets].[Equities].[Cash Equities].[Developed Markets]
kpisThe thresholds at which the task is automatically approved and exported without any review. Only applicable for 4-eyes-kpi workflow type.NDesk All PV;Cash Equities
linkedDashboardIdThe ID of an existing dashboard to link to the definition. This is the unique reference to a dashboard that you may find in the URL when accessing the dashboard.NecxRnV

Scope values

In the notation for scope values, a semi-colon (;) is used to separate level members and a pipe (|) is used to separate levels. So the following example:
[Booking].[Desks].[Desk]=[AllMember].[Commodity]|[AllMember].[Equities];[Organization].[BookHierarchy].[Level 4]=[AllMember].[Global Markets].[Equities].[Cash Equities].[Developed Markets]
Breaks down into:
  • [Booking].[Desks].[Desk] =
    • [AllMember].[Commodity]
    • [AllMember].[Equities]
  • [Organization].[BookHierarchy].[Level 4] =
    • [AllMember].[Global Markets].[Equities].[Cash Equities].[Developed Markets]
This means that your definition scope will include at the desk level Commodity and Equities and at level 4 of BookHierarchy the Developed Markets.

Workflow variables

In the notation for workflow variables, a semi-colon (;) is used to separate workflow variable names and a pipe (|) is used to separate values. So the following example:
approvers=MANAGERS;reviewers=USERS;emails=abc@company.com|def@company.com|ghi@company.com
Breaks down into:
  • approvers =
    • MANAGERS
  • reviewers =
    • USERS
  • emails =
    • abc@company.com
    • def@company.com
    • ghi@company.com
emails is not a valid variable in the provided workflows (simple, 4-eyes, 4-eyes-kpi). You may have such a variable if you define a custom workflow sending an update via emails.