Create Structured File
Function:
This tool is used to create a structured document based on the structure of the file descriptor referenced as an output parameter.
The tool supports mass processing. The output parameter must be of type file descriptor.
When the tool is used in a single processing action and multiple elements are selected, then a file is created for each selected element. When the tool is used in a mass processing action a single file is created containing a line for each selected element.
Parameters:
| Parameter Name | I/O | Type | Description |
|---|---|---|---|
| Structured File [M] | O | File | References the structured file to be created. The output structure is determined by the file descriptor's definition.
If the referenced file descriptor type is not InputStream, the tool will attempt to physically create or overwrite the target file. |
Example:
If your model contains an Element Type Source with the following properties:
- DOCUMODEL_PROP_ELE_Name
- DOCUMODEL_PROP_ELE_Type
- DOCUMODEL_PROP_ELE_Creator
and the application contains two source elements with the following property values:
- Source element A: PROGX, COBOL, Smith
- Source element B: INCL1, INCLUDE, Miller
The file descriptor which is used as the output parameter of the tool DOCUMODEL_TOOL_AWM_CreateSourceFile is modelled as a structured table with a property delimiter of semicolon.
The tool DOCUMODEL_TOOL_AWM_CreateSourceFile is modelled as the target of the action DOCUMODEL_ACT_CreateSourceFile.
If the action DOCUMODEL_ACT_CreateSourceFile is modelled as type single processing and the two source elements are selected, two files are created with the following content:
- First file:
- PROGX;COBOL;Smith
- Second file:
- INCL1;INCLUDE;Miller
If the action ACT_CreateSourceFile is modelled as a type mass processing and the two source elements are selected, one file is created with the following content:
PROGX;COBOL;Smith INCL1;INCLUDE;Miller