Passing parameters from Data One Contract to Data Shaper graph
DOP_* et al. exposed graph parameters
Any public graph parameter exposed on a graph will be asked as input in a Data One contract referring to such graph.
Graph developers can decide to expose any domain-specific parameters they need as public graph parameters in order to make them configurable at Data One contract level with basic scalar data type validation (e.g, String, Number, Timestamp) and labeling by Data One contract WUI as specified in the graph parameter definition.
That said, some parameters receive special handling and are rendered on Data One contract WUI with Data One aware WUI widgets assisting the user in configuring the contract in a specific way. The special handling is driven by the variables prefix as shown in the table below.
| graph variable prefix | description | internal notes |
|---|---|---|
| DOP_FILESET_ID | Variable prefixed by DOP_FILESET_ID are expected to contain a Data One file identifier inherited from some contract context variable (e.g. from a triggering event variable) and not entered manually by the user. Examples: DOP_FILESET_ID, DOP_FILESET_ID1, DOP_FILESET_INVOICES, ... | Any default values specified in the variable definition in Designer will be ignored. |
| DOP_FILERES | Variable prefixed by DOP_FILERES are expected to contain a Data One File Resource name, their input is collected on the contract configuration WUI with a specific widget that allows the user to navigate through File Resource definitions available on the system and select one of them. Examples: DOP_FILERES, DOP_FILERES_INPUT, DOP_FILESET_PAYROLL, ... | |
| DOP_VPATH | Variable prefixed by DOP_VPATH are expected to contain a Data One VFS path in the form: vfsname:/vpath (e.g. "ordersvfs:/receivables/20221H"). Examples: DOP_VPATH, DOP_VPATH_INPUT, DOP_VPATH_STAGING, ... | |
| DOP_CHARSET | Variable prefixed by DOP_CHARSET are expected to contain a valid charset, their input is collected on the contract configuration WUI with a specific widget that allows the user to navigate through supported charsets. Examples: DOP_CHARSET, DOP_CHARSET_REQUIRED, DOP_CHARSET_ORDERS, ... | On top of eligible charset a NONE value must also be offered for binary files (see also RequiredCharset parameter for DataOneVFSReader graph component at the top of this page |
Updated about 1 year ago