Dafne: Documentation import

2026-08-06T13:36:48Z

Documentation import

New page

'''Placeholders''' are markers substituted with their current values before a statement is executed. They are available in task commands, in scenario planning queries and in operator notification commands.

== Syntax ==
A placeholder is written as the name enclosed in percent signs:

<code>%taskid%</code>

All occurrences are replaced, so a placeholder may be used more than once in the same statement.

User-defined parameters use the <code>u:</code> prefix to distinguish them from system placeholders:

<code>%u:parameter_name%</code>

The named parameter must exist in the parameter list. See [[Parameter]].

== Placeholders in task commands ==
{| class="wikitable"
|+ Available in the task Query field
! Placeholder !! Value
|-
| <code>%scenarioid%</code> || Scenario ID
|-
| <code>%scenarioname%</code> || Scenario name
|-
| <code>%groupid%</code> || Group ID
|-
| <code>%groupname%</code> || Group name
|-
| <code>%taskid%</code> || Task ID
|-
| <code>%taskname%</code> || Task name
|-
| <code>%period%</code> || Task period type (D=Daily, W=Weekly, M=Monthly)
|-
| <code>%processingid%</code> || Processing ID
|-
| <code>%processingname%</code> || Processing name
|-
| <code>%iteration%</code> || Processing iteration code
|-
| <code>%date%</code> || Processing date, format ''YYYY-MM-DD''
|-
| <code>%date_n%</code> || Processing date, numeric format ''YYYYMMDD''
|-
| <code>%date_dt%</code> || Processing date, timestamp format ''YYYY-MM-DD 00:00:00.000''
|-
| <code>%processingstart_n%</code> || Processing start time, format ''yyyyMMddHHmmss''
|-
| <code>%execid%</code> || Scheduled task ID. Keeps its value across attempts within one processing.
|-
| <code>%runid%</code> || Run ID. Unique for every attempt.
|-
| <code>%trynumber%</code> || Attempt number of the scheduled task within the processing.
|-
| <code>%env%</code> || Environment code (P=Prod, T=Test, D=Dev, U=UAT, S=SIT, O=Other1, Q=Other2)
|}

Three date forms are provided because target systems differ in what they accept. Use <code>%date_n%</code> where a numeric partition key is expected and <code>%date_dt%</code> where a timestamp is required, rather than converting <code>%date%</code> in the statement.

Note the difference between <code>%execid%</code> and <code>%runid%</code>: the first identifies the scheduled task and is stable across retries, the second identifies the individual attempt. Use <code>%runid%</code> when logging so that each attempt can be distinguished.

=== Example ===
<code>
insert into my_table (taskid, date, scenarioid) values (%taskid%, '%date%', %scenarioid%);
</code>

With a user-defined parameter:

<code>
call proc1(%u:usrpar1%)
</code>

== Placeholders in scenario planning queries ==
A different set is available in the planning query of a [[Scenario]], describing the state of previous processings:

{| class="wikitable"
! Placeholder !! Value
|-
| <code>%scenarioid%</code> || Scenario ID
|-
| <code>%scenarioname%</code> || Scenario name
|-
| <code>%maxdate%</code> || Latest finished processing date. Defaults to 1970-01-01 on the first run.
|-
| <code>%maxprocessingID%</code> || ID of the last finished processing. Defaults to 0 on the first run.
|-
| <code>%maxIteration%</code> || Iteration code of the last '''finished''' processing.
|-
| <code>%maxIterationAll%</code> || Iteration code of the last '''started''' processing.
|-
| <code>%maxProcessingName%</code> || Name of the last finished processing.
|-
| <code>%maxProcessingStatus%</code> || Status of the last started processing. Defaults to ''F'' on the first run.
|}

=== Example ===
<code>
select %maxdate% + 1 as date, 'iter1' as iteration
</code>

== Placeholders in notification commands ==
The notification command of an [[Operator]] may use placeholders identifying the failed task and its processing — the task and group, the processing and its date and iteration, and the scenario. See [[Operator]].

== Quoting ==
Substitution is textual. A placeholder is replaced by its value exactly, without quoting or escaping, so string values must be quoted in the statement itself:

<code>
where business_date = '%date%'
</code>

For the same reason, treat a user-defined parameter whose value comes from a query as untrusted input when building SQL, and prefer passing it as an argument to a procedure over concatenating it into a statement.

== Checking the result ==
The '''Query''' tab of the scheduled task detail in the [[Monitor console]] shows the '''executed query''' — the statement after substitution. This is the reliable way to confirm what a placeholder resolved to, and the first place to look when a task fails with an unexpected value.

== See also ==
* [[Parameter]]
* [[Task]]
* [[Scenario]]

Placeholders - Revision history

Dafne: Documentation import