MAAPFormData Schema

EMRALD_Model#/definitions/MAAPFormData

Form data used by the MAAP form

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Forbidden	none	EMRALD_JsonSchemaV3_4.json*

MAAPFormData Type

object (MAAPFormData)

MAAPFormData Properties

Property	Type	Required	Nullable	Defined by
exePath	string	Optional	cannot be null	EMRALD_Model
sourceElements	array	Optional	cannot be null	EMRALD_Model
parameters	array	Optional	cannot be null	EMRALD_Model
initiators	array	Optional	cannot be null	EMRALD_Model
inputBlocks	array	Optional	cannot be null	EMRALD_Model
fileRefs	array	Optional	cannot be null	EMRALD_Model
inputPath	string	Optional	cannot be null	EMRALD_Model
parameterPath	string	Optional	cannot be null	EMRALD_Model
possibleInitiators	array	Optional	cannot be null	EMRALD_Model
docLinkVariable	string	Optional	cannot be null	EMRALD_Model
output	string	Optional	cannot be null	EMRALD_Model
caType	Not specified	Required	cannot be null	EMRALD_Model
needsUpgrade	boolean	Optional	cannot be null	EMRALD_Model

exePath

The path to the MAAP executable on the user's machine

exePath

• is optional

• Type: string

• cannot be null

• defined in: EMRALD_Model

exePath Type

string

sourceElements

The contents of original .inp file parsed into JSON

sourceElements

• is optional

• Type: an array of merged types (Details)

• cannot be null

• defined in: EMRALD_Model

sourceElements Type

an array of merged types (Details)

parameters

Source elements from the .inp file identified as parameters

parameters

• is optional

• Type: object[] (Details)

• cannot be null

• defined in: EMRALD_Model

parameters Type

object[] (Details)

initiators

Source elements from the .inp file identified as initiators

initiators

• is optional

• Type: an array of merged types (Details)

• cannot be null

• defined in: EMRALD_Model

initiators Type

an array of merged types (Details)

inputBlocks

Source elements from the .inp file identified as input blocks (if blocks, when block, etc.)

inputBlocks

• is optional

• Type: object[] (MAAPConditionalBlockStatement)

• cannot be null

• defined in: EMRALD_Model

inputBlocks Type

object[] (MAAPConditionalBlockStatement)

fileRefs

The paths to other files referenced by the .inp and .par files

fileRefs

• is optional

• Type: string[]

• cannot be null

• defined in: EMRALD_Model

fileRefs Type

string[]

inputPath

The full path to the .inp file on the user's machine

inputPath

• is optional

• Type: string

• cannot be null

• defined in: EMRALD_Model

inputPath Type

string

parameterPath

The full path to the .par file on the user's machine

parameterPath

• is optional

• Type: string

• cannot be null

• defined in: EMRALD_Model

parameterPath Type

string

possibleInitiators

A list of possible initiators extracted from the .par file

possibleInitiators

• is optional

• Type: object[] (MAAPParameter)

• cannot be null

• defined in: EMRALD_Model

possibleInitiators Type

object[] (MAAPParameter)

docLinkVariable

The doc link variable used to store the results

docLinkVariable

• is optional

• Type: string

• cannot be null

• defined in: EMRALD_Model

docLinkVariable Type

string

output

The MAAP output variable to store in the doc link variable

output

• is optional

• Type: string

• cannot be null

• defined in: EMRALD_Model

output Type

string

caType

caType

• is required

• Type: unknown (CustomFormType)

• cannot be null

• defined in: EMRALD_Model

caType Type

unknown (CustomFormType)

caType Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"MAAP"

needsUpgrade

needsUpgrade

• is optional

• Type: boolean

• cannot be null

• defined in: EMRALD_Model

needsUpgrade Type

boolean