# Data Watcher Macros

These macros are applicable to events relevant to:

* cut-off with error
* cut-off warning (about to expire)
* flow completed
* flow in error
* business error (if licensed)

| Macro              | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                       | Category     |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| FM\_Name           | Flow name (\*)                                                                                                                                                                                                                                                                                                                                                                                                                                                    | FlowModel    |
| FM\_ID             | Flow model ID (\*)                                                                                                                                                                                                                                                                                                                                                                                                                                                | FlowModel    |
| FM\_Version        | Flow model version (\*)                                                                                                                                                                                                                                                                                                                                                                                                                                           | FlowModel    |
| FI\_ID             | Flow instance ID (\*)                                                                                                                                                                                                                                                                                                                                                                                                                                             | FlowInstance |
| FI\_StartTS        | Flow instance start timestamp in ISO8601 format (\*)                                                                                                                                                                                                                                                                                                                                                                                                              | FlowInstance |
| FI\_EndTS          | Flow instance end timestamp in ISO8601 format (\*)                                                                                                                                                                                                                                                                                                                                                                                                                | FlowInstance |
| FI\_Status         | Flow instance status \[SUCCESS \| ERROR \| RUNNING] (\*)                                                                                                                                                                                                                                                                                                                                                                                                          | FlowInstance |
| FI\_ErrMsg         | Flow instance error message, when FI\_Status=ERROR and when an error message is available; in case of multiple error messages the eldest one (the root cause) is selected                                                                                                                                                                                                                                                                                         | FlowInstance |
| FI\_ErrDetails     | FI\_ErrDetails Flow instance error message details, when FI\_Status=ERROR further qualifying FI\_ErrMsg with additional information, when available FlowInstance                                                                                                                                                                                                                                                                                                  | FlowInstance |
| FI\_UsrAttr        | <p>Flow user-defined attribute associated to the flow model. At the time this flow instance matched the model, there can be zero or more attributes, each of them will be rendered as a distinct notification attribute.<br><br>E.g. if the user defined Confidentiality="SECRET" and Signer="CFO" flow attributes, the notification will include these two attributes and values: FI\_UsrAttr\_Confidentiality= "SECRET" and FI\_UsrAttr\_Signers="CFO, CEO"</p> | FlowInstance |
| FI\_SrcSystemsName | Comma separated list of source systems appearing in the flow (\*)                                                                                                                                                                                                                                                                                                                                                                                                 | FlowInstance |
| FI\_SrcDCName      | List of all source data containers (e.g. files) appearing in the flow (\*)                                                                                                                                                                                                                                                                                                                                                                                        | FlowInstance |
| FI\_TgtSystemsName | Comma separated list of target systems appearing in the flow (\*)                                                                                                                                                                                                                                                                                                                                                                                                 | FlowInstance |
| FI\_TgtDCName      | List of all target data containers (e.g. files) appearing in the flow (\*)                                                                                                                                                                                                                                                                                                                                                                                        | FlowInstance |
| FI\_ContractsName  | Comma separated list of contracts appearing in the flow                                                                                                                                                                                                                                                                                                                                                                                                           | FlowInstance |

(\*) Mandatory attribute

List of Macros applicable to events relevant to:

* cut-off with error
* cut-off warning (about to expire)

| Macro                    | Description                                                              | Category       |
| ------------------------ | ------------------------------------------------------------------------ | -------------- |
| CD\_SystemName           | Name of the system on which the cut-off is applied (\*)                  | CutOffDef      |
| CD\_Type                 | Cut-off type \[PLANNED\|DURATION] (\*)                                   | CutOffDef      |
| CI\_PlannedExpectedStart | ISO8601 timestamp indicating the expected start timestamp for the action | CutOffInstance |
| CI\_PlannedExpectedEnd   | ISO8601 timestamp indicating the expected end timestamp for the action   | CutOffInstance |
| CI\_Status               | Cut-off status \[PENDING \| WARNING \| SUCCESS \| ERROR] (\*)            | CutOffInstance |

(\*) Mandatory attribute

List of Macros applicable to events relevant to:

* business error (if licensed)

| Macro        | Description                                                 | Category      |
| ------------ | ----------------------------------------------------------- | ------------- |
| BE\_Status   | Status of the Business Error \[BUSINESS ERROR]              | BusinessError |
| BE\_ErrMsg   | Error message issued for the Business Error                 | BusinessError |
| BE\_ErrCode  | Error code issued for the Business Error                    | BusinessError |
| BE\_FileName | Filename for which the Business Error has been issued       | BusinessError |
| BE\_FileId   | Id of the file for which the Business Error has been issued | BusinessError |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.primeur.com/data-mover-1.21/notification-channels/manage-templates/data-watcher-macros.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
