File Descriptor

File Descriptor Structure

A file descriptor can specify the following structures:

Unstructured

The File Descriptor structure 'Unstructured' describes a flat file whose format is not known to AWM and not interpreted by AWM.

Table

The File Descriptor structure 'Table' describes a file consisting of lines with a defined format. The way that AWM interprets the file is determined by the property delimiter (attribute: PropDelimiter) and the properties related to the file descriptor. Each line of the file is expected to consist of values for the related properties separated by the property delimiter in the sequence of the property relation definition. At runtime the values in the file are mapped to the properties as specified in the file descriptor to property relations.

A file descriptor modelled in this way:

Could have the following content:

Argentina,Buenos Aires,South America
Algeria,Alger,Africa
Niger,Niamev,Africa
France,Paris,Europe

JSON

The JSON File Descriptor structure can be used to model a JSON payload, for example, for a REST service call. If the File Descriptor is intended to parse a JSON payload it is only necessary to model the part of the JSON which is relevant for the AWM application. The JSON file structure should describe which parts of the JSON payload should be mapped to AWM properties.

At every level of the structure you can model a child of type 'Element' or 'Attribute'. An element can be a JSON array or a JSON object specified in the element's Type attribute. A JSON attribute can be one of the following types, String, Boolean, and Number. The JSON attribute can be specified as a static value or it can point to a property via the Target ID attribute. If the JSON attribute is pointing to a property via a Target ID the attribute value is taken from the current value of the property at runtime and the property value is set by the value returned in the corresponding JSON attribute.

You can specify a JSON file descriptor structure with objects and attributes that have missing values. If a specified non-mandatory object does not exist, AWM will skip it and continue parsing or generating the rest of the JSON document.

If a JSON object or attribute is specified as mandatory, AWM will enforce that it is present in a parsed JSON document or a property value is available when the JSON output is generated. If it is not, an error message is triggered and the parsing/generation process is stopped.

A file descriptor modelled in this way:

Could, for example, produce the following JSON payload at runtime:

{
	"fields": {
		"summary": "No REST for the Wicked.",
		"issuetype": {
			"id": "Error"
		},
		"project": {
			"id": "10110"
		},
		"description": "Creation of an issue using IDs for projects and issue type."
	}
}

Examples

File Descriptor SCLM_FILE_ElelistMember