Icon

This is the documentation of the latest development version of automaIT. The documentation of the latest stable release can be found at AUTOMAIT.

Skip to end of metadata
Go to start of metadata

Table of Contents

top

Global Declarations

Element: componentVarSets

Documentation: Each file contains the exported variable sets of a single component.
<componentVarSets
component="NonEmptyString [0..1] The optional fully qualified name of component. This attribute is ignored during import. It is only informative for exports."
exported="dateTime [0..1] The optional time stamp of the export. This attribute is ignored during import. It is only informative for exports.">
<!--
Uniqueness Constraint - variableSetName
Selector - tns:varSet
Field(s) - @name
-->

<varSet
name="NonEmptyString512 [1] The name of the variable set."
description="string [0..1] The optional description of the variable set."> [0..*] The variable set bundles multiple overwritten component variables.
<!--
Uniqueness Constraint - variableName
Selector - tns:var
Field(s) - @name
-->

<var
name="NameType [1] The name of the overwritten component variable."
value="SubstitutionType4096 [1] The value of the overwritten component variable."/> [0..*] The overwritten component variable.
</varSet>
</componentVarSets>
top

Element: jobHistory

Documentation: A Job History contains information about an executed job as well as steps.
<jobHistory
id="long [1] The element id of this job."
name="NonEmptyString255 [1] The name of the job."
kind="KindType [1] This field holds information about the kind of this job. Example kinds are: "pe" for plan execution or "hi" for host initialization. Is used to determine the correct subtype of JobHistory on import."
state="string [1] The current state of the job. Can be queued, started, completed, aborted, failed, or cancelled. Is represented by an Integer value."
startedAt="dateTime [0..1] Timestamp representing the moment of time at which the job execution has been started."
stoppedAt="dateTime [0..1] Timestamp representing the moment of time at which the job execution has been stopped, either successful or unsuccessful."
queuedAt="dateTime [1] Timestamp representing the moment of time at which the job execution has been queued."
cancelledAt="dateTime [0..1] Timestamp representing the moment of time at which the job execution has been cancelled by a user."
outputSizeExceeded="boolean [0..1] Boolean indicating if the combined size of the binary output of all steps exceeded the allowed volume.">
<errorMessage> NonEmptyString </errorMessage> [0..1] The termination error message in case of abnormal termination.
<executionJobDetails
kind="KindType [1] This field holds information about the kind of this job execution. Example kinds are: "pe" for plan execution or "hi" for host initialization. Is used to determine the correct subtype of JobHistory on import."
processTimeout="long [0..1] The default process timeout (in seconds) that is specified on job creation."
jobTimeout="long [0..1] the job timeout (in seconds) that is specified on job creation."
maxParallelExecutions="long [0..1] The maximum number of parallel executions during this job."> [0..1] This element contains additional details that apply only to execution jobs.
<parameter
key="NonEmptyString512 [1] The specified key for a parameter."
value="VariableValueType [1] The value belonging to the respective key."/> [0..*] a parameter is key-value pair that is valid for the complete duration of the job execution.
<componentName> NonEmptyString4096 </componentName> [0..1] The unique identifier of the component used during this job execution.
<componentMethodName> NonEmptyString512 </componentMethodName> [0..1] The name of the component method executed during this job.
<componentVarSetName> NonEmptyString512 </componentVarSetName> [0..1] The component variable set used during this job execution.
<subJobHistory> SubJobHistory </subJobHistory> [1..*] Subjob-histories are concrete executions of jobs on a single hosts. A job can contain one or more subjobs, depending on the number of hosts the job is to be executed on.
</executionJobDetails>
</jobHistory>
top

Global Definitions

Complex Type: Representation

Super-types: None
Sub-types: None
Name Representation
Abstract no
<...>
<rawExpression> string </rawExpression> [1] The current representation's raw expression before substitution.
<substitutedExpression> string </substitutedExpression> [1] The current representation's expression after substitution.
</...>
top

Complex Type: Step

Super-types: None
Sub-types: None
Name Step
Abstract no
<...
id="long [1] The element id of this step."
kind="KindType [1] The discriminator indicating which kind of step is present."
state="string [1] The steps state."
nestingDepth="integer [1] The step's nesting depth"
startedAt="dateTime [1] Timestamp representing the moment of time at which the step execution has been started."
finishedAt="dateTime [0..1] Timestamp representing the moment of time at which the step execution has been finished.">
<rawExpression> string </rawExpression> [1] The unsubstituted expression of the current step.
<substitutedExpression> string </substitutedExpression> [1] The substituted expression of the current step.
<host> host </host> [1] The name of the host the current step is performed on.
<errorMessage> NonEmptyString </errorMessage> [0..1] The error message. Is only present in case of failure.
Start Choice [1]
<processStepDetail
returnCode="integer [0..1] The return code for this process step."
stdInCharset="NonEmptyString255 [0..1] The character set used for standardIn text."
stdOutCharset="NonEmptyString255 [0..1] The character set used for standardOut text."
stdErrCharset="NonEmptyString255 [0..1] The character set used for standardErr text."
nativeByteOrder="NonEmptyString255 [0..1] The byte order used for this step."
redirectErrorStream="boolean [0..1] Boolean indicating if the error stream is redirected."
loginShell="boolean [0..1] Boolean indicating if a loginShell is used for this step."
truncatedStdOut="boolean [0..1] Boolean indicating if the StandardOut text is truncated."
truncatedStdErr="boolean [0..1] Boolean indicating if the StandardErr text is truncated."> [0..1]
<inputFile> Representation </inputFile> [0..1] The specified input file's substituted and unsubstituted descriptor.
<outputFile> Representation </outputFile> [0..1] The specified output file's substituted and unsubstituted descriptor.
<errorFile> Representation </errorFile> [0..1] The specified error file's substituted and unsubstituted descriptor.
<inputEncoding> Representation </inputEncoding> [0..1] The encoding of the input file.
<inputText> Representation </inputText> [0..1] The specified input text.
<cmd> Representation </cmd> [0..1] The execution command performed during this step.
<directory> Representation </directory> [0..1] The directory in which the command is to be executed.
<user> Representation </user> [0..1] The user the command shall be executed as.
<expectedStdOutBegin> Representation </expectedStdOutBegin> [0..1] The expected value for StdOut output, used when matching from the beginning.
<expectedStdOutEnd> Representation </expectedStdOutEnd> [0..1] The expected value for StdOut output, used when matching from the end.
<expectedStdErrBegin> Representation </expectedStdErrBegin> [0..1] The expected value for StdErr output, used when matching from the beginning.
<expectedStdErrEnd> Representation </expectedStdErrEnd> [0..1] The expected value for StdErr output, used when matching from the end.
<processStepArgument> Representation </processStepArgument> [0..*] A single argument that belongs to the execution command.
<environmentVariable> [0..*] An environment variable that is persisted with a step.
<key> string </key> [1] The current environment variable's key.
<rawExpression> string </rawExpression> [1] The current environment variable's raw expression before substitution.
<substitutedExpression> string </substitutedExpression> [1] The current environment variable's expression after substitution.
</environmentVariable>
<stdOut> output </stdOut> [0..1] The stdOut output for this step.
<stdErr> output </stdErr> [0..1] The stdErr output for this step.
</processStepDetail>
Start Choice [0..1]
<installStepDetail
componentInstanceId="NonEmptyString4096 [0..1] The id of the affected component instance."
targetableHost="NonEmptyString512 [0..1] The name of the targetable host."
componentInstance="NonEmptyString4096 [0..1] The name of the affected component instance."> [1]
<returnValue> Representation </returnValue> [0..1] The step's return value
<componentInstanceVariableSet> componentInstanceVariableSet </componentInstanceVariableSet> [0..1] The variable set used in this install step.
</installStepDetail>
<callStepDetail
componentInstanceId="NonEmptyString4096 [0..1] The id of the affected component instance."
targetableHost="NonEmptyString512 [0..1] The name of the targetable host."
componentInstance="NonEmptyString4096 [0..1] The name of the affected component instance."> [1]
<returnValue> Representation </returnValue> [0..1] The step's return value
</callStepDetail>
<uninstallStepDetail
componentInstanceId="NonEmptyString4096 [0..1] The id of the affected component instance."
targetableHost="NonEmptyString512 [0..1] The name of the targetable host."
componentInstance="NonEmptyString4096 [0..1] The name of the affected component instance."> [1]
<returnValue> Representation </returnValue> [0..1] The step's return value
</uninstallStepDetail>
End ChoiceEnd Choice</...>
top

Complex Type: SubJobHistory

Super-types: None
Sub-types: None
Name SubJobHistory
Abstract no
<...
id="long [1] The element id of this subjob."
kind="KindType [1] This field holds information about the kind of this job execution. Can be "sjph" for plan execution or "sjch" for component execution. Is used to determine the correct subtype of SubJobHistory on import."
state="string [1] The current state of the subJob. Can be queued, started, completed, aborted, failed, or cancelled. Is represented by an Integer value."
queuedAt="dateTime [1] Timestamp representing the moment of time at which the subjob execution has been queued."
startedAt="dateTime [0..1] Timestamp representing the moment of time at which the subjob execution has been started."
completedAt="dateTime [0..1] Timestamp representing the moment of time at which the subjob execution has been stopped, either successful or unsuccessful.">
<errorMessage> NonEmptyString </errorMessage> [0..1] The termination error message in case of abnormal termination.
<host> host </host> [0..1] The name of the target host for plan execution or the name of the host of the target component instance in case of component method execution.
<componentId> SubstitutionType4096 </componentId> [0..1] The Identifier of the affected component.
<componentInstanceName> SubstitutionType4096 </componentInstanceName> [0..1] The name of the target component instance.
<subJobHistoryPhase> SubJobHistoryPhase </subJobHistoryPhase> [1..2] representation of the phases performed during this subjob execution.
</...>
top

Complex Type: SubJobHistoryPhase

Super-types: None
Sub-types: None
Name SubJobHistoryPhase
Abstract no
<...
id="long [1] The element id of this subjobHistoryPhase."
state="string [1] The current state of the subJobHistoryPhase. Can be queued, started, completed, aborted, failed, or cancelled. Is represented by an Integer value."
phase="string [1] The current phase of the subJobHistoryPhase. Can be execution and simulation. Is represented by an Integer value."
startedAt="dateTime [0..1] Timestamp representing the moment of time at which the subjobHistoryPhase execution has been started."
completedAt="dateTime [0..1] Timestamp representing the moment of time at which the subjobHistoryPhase execution has been stopped, either successful or unsuccessful.">
<errorMessage> NonEmptyString </errorMessage> [0..1] The termination error message in case of abnormal termination.
<step> Step </step> [1..*] representation of a single step performed during this subjob execution.
</...>
top

Complex Type: componentInstanceVariableSet

Super-types: None
Sub-types: None
Name componentInstanceVariableSet
Abstract no
Documentation: A variable set used in an install step.
<...
variableSetName="NonEmptyString512 [1] The id of the variable set used in this install step.">
<componentInstanceVariable
id="long [1] The id of the variable."
name="NonEmptyString512 [0..1] The specified variable name."
value="VariableValueType [1] The value belonging to the respective variable."
valueUnsubstituted="VariableValueType [1] The unsubstituted value belonging to the respective variable."
isIdentifier="boolean [0..1] Marks if the variable is an identifier variable."/> [0..*] A single variable in an install step.
</...>
top

Complex Type: host

Super-types: string < NonEmptyString (by restriction) < host (by extension)
Sub-types: None
Name host
Abstract no
Documentation: The name of a host.
<...
id="long [0..1] The id of the host.">
NonEmptyString
</...>
top

Complex Type: output

Super-types: None
Sub-types: None
Name output
Abstract no
Documentation: A single step's complete output to stdOut or stdErr.
<...>
<output
size="long [0..1] The size of this output."> [1..*] One piece of binary output
NonEmptyString
</output>
</...>
top

Simple Type: KindType

Super-types: string < KindType (by restriction)
Sub-types: None
Name KindType
Content
  • Base XSD Type: string
  • length <= 16
Documentation: This type is used for any "kind" specifier. It can be used to distinguish different kinds of jobs, subjobs, or steps. Usually corresponds to the discriminator field in the database used by hibernate.
top

Simple Type: NameType

Super-types: string < NameType (by restriction)
Sub-types: None
Name NameType
Content
  • Base XSD Type: string
  • pattern = [\p{L}_][\p{N}\p{L}_]*
  • length <= 512
Documentation: This type is used for any kind of names. It is a string with the maximum length of 512 characters. It may contain either a unicode letter or an underscore, then either a number, a unicode letter or underscore.
top

Simple Type: NonEmptyString

Super-types: string < NonEmptyString (by restriction)
Sub-types:
  • host (by extension)
Name NonEmptyString
Content
  • Base XSD Type: string
  • pattern = (.|\n)*\S(.|\n)*
  • length >= 1
Documentation: This is a string with a minimum length of 1. There must be at least one letter that is neither a blank, nor a tabspace, nor a newline.
top

Simple Type: NonEmptyString255

Super-types: string < NonEmptyString (by restriction) < NonEmptyString255 (by restriction)
Sub-types: None
Name NonEmptyString255
Content
  • Base XSD Type: string
  • pattern = (.|\n)*\S(.|\n)*
  • length >= 1
  • length <= 255
Documentation: This is a string with a minimum length of 1 and maximum 255. There must be at least one letter that is neither a blank, nor a tabspace, nor a newline.
top

Simple Type: NonEmptyString4096

Super-types: string < NonEmptyString (by restriction) < NonEmptyString4096 (by restriction)
Sub-types: None
Name NonEmptyString4096
Content
  • Base XSD Type: string
  • pattern = (.|\n)*\S(.|\n)*
  • length >= 1
  • length <= 4096
Documentation: This is a string with a minimum length of 1 and maximum 4096. There must be at least one letter that is neither a blank, nor a tabspace, nor a newline.
top

Simple Type: NonEmptyString512

Super-types: string < NonEmptyString (by restriction) < NonEmptyString512 (by restriction)
Sub-types: None
Name NonEmptyString512
Content
  • Base XSD Type: string
  • pattern = (.|\n)*\S(.|\n)*
  • length >= 1
  • length <= 512
Documentation: This is a string with a minimum length of 1 and maximum 512. There must be at least one letter that is neither a blank, nor a tabspace, nor a newline.
top

Simple Type: SubstitutionType4096

Super-types: string < SubstitutionType4096 (by restriction)
Sub-types: None
Name SubstitutionType4096
Content
  • Base XSD Type: string
  • length <= 4096
Documentation: This type marks strings which allow variable substitutions. The maximum length is 4096.
top

Simple Type: VariableValueType

Super-types: string < VariableValueType (by restriction)
Sub-types: None
Name VariableValueType
Content
  • Base XSD Type: string
  • length <= 4096
Documentation: This type is used for any kind of variable/parameter values. It is a string with the maximum length of 4096 characters.
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top