GT 4.0 WS GRAM: Job Description Schema Doc
Table of Contents
- Schema Document Properties
-
Global Declarations
- Element: argument
- Element: count
- Element: directory
- Element: environment
- Element: executable
- Element: extensions
- Element: factoryEndpoint
- Element: fileCleanUp
- Element: fileStageIn
- Element: fileStageOut
- Element: hostCount
- Element: job
- Element: jobCredentialEndpoint
- Element: jobType
- Element: libraryPath
- Element: maxCpuTime
- Element: maxMemory
- Element: maxTime
- Element: maxWallTime
- Element: minMemory
- Element: multiJob
- Element: project
- Element: queue
- Element: serviceLevelAgreement
- Element: stagingCredentialEndpoint
- Element: stderr
- Element: stdin
- Element: stdout
- Global Definitions
Schema Document Properties
| Target Namespace | http://www.globus.org/namespaces/2004/10/gram/job/description |
|---|---|
| Language | en |
| Element and Attribute Namespaces |
|
| Schema Composition |
|
| Documentation |
RSL VariablesThe RSL Language includes support for system-specific variable substitutions. These variables allow one to write an RSL without specific knowledge of the execution host's local account or directory configuration. RSL Variable SyntaxRSL variable references occur within the contents of an xsd:string type RSL element. The syntax for an RSL variable reference is
DOLLAR-SIGN LEFT-BRACE variable-name RIGHT-BRACE
As an example:
<rsl:executable>myJob</rsl:executable>
<rsl:stdout>stdout.${GLOBUS_USER_NAME}</rsl:stdout>
Which would get resolved (supposing the executable is being
run under the "user0001" account) to the job description:
<rsl:executable>myJob</rsl:executable>
<rsl:stdout>stdout.user0001</rsl:stdout>
RSL Attributes Which May Contain Variable ReferencesRSL Variable substitutions may not occur in all RSL Job Attributes. Their use is restricted to those which contain arbitrary string data and which may be used to access the local resource associated with a job. The list of attributes which may contain RSL Variables is:
RSL Variable Descriptions
Differences From Pre-WS GRAM and OGSA GRAMIn both Pre-WS GRAM and OGSA-GRAM, applications could define arbitrary RSL substitutions within an RSL document and rely on the GRAM service to resolve them. This feature is no longer present. Only those RSL variables described in this document may be referenced in an RSL job description. In both Prew-WS GRAM and OGSA-GRAM, RSL substitutions could be used in arbitrary Job Description attributes. In an effort to more strongly type RSL Job Description documents in WS-GRAM, RSL substitutions are now restricted to be used only in certain attribute contexts. OGSA GRAM defines RSL Substitutions as separate XML elements within an RSL Job Description document. With GT4 WS-GRAM, RSL variable references are included with a special syntax within certain RSL job description elements. |
Declared Namespaces
| Prefix | Namespace |
|---|---|
| xml | http://www.w3.org/XML/1998/namespace |
| rft | http://www.globus.org/namespaces/2004/10/rft |
| wsa | http://schemas.xmlsoap.org/ws/2004/03/addressing |
| xsd | http://www.w3.org/2001/XMLSchema |
| types | http://www.globus.org/namespaces/2004/10/gram/job/types |
| tns | http://www.globus.org/namespaces/2004/10/gram/job/description |
| Schema Component Representation |
|---|
|
<xsd:schema xml:lang="en" targetNamespace="http://www.globus.org/namespaces/2004/10/gram/job/description" elementFormDefault="qualified">
<xsd:import namespace="http://www.globus.org/namespaces/2004/10/gram/job/types" schemaLocation="managed_job_types.xsd"/> <xsd:import namespace="http://schemas.xmlsoap.org/ws/2004/03/addressing" schemaLocation="../ws/addressing/WS-Addressing.xsd"/> <xsd:import namespace="http://www.globus.org/namespaces/2004/10/rft" schemaLocation="../transfer/reliable/reliable_transfer_types.xsd"/> ... </xsd:schema> |
Global Declarations
Element: argument
| Name | argument |
|---|---|
| Type | xsd:string |
| Nillable | no |
| Abstract | no |
| Documentation | A command line argument for the executable. Each argument is a separate element within the job description. Spaces and quotes within an argument will preserved literally. One argument section per executable argument token must be provided. To execute e.g. a shell script, one needs to specify <executable>/bin/sh</executable> <argument>-c</argument> <argument>echo "Ran script!"</argument> |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: count
| Name | count |
|---|---|
| Type | xsd:positiveInteger |
| Nillable | no |
| Abstract | no |
| Default Value | 1 |
| Documentation | The number of executions of the executable. Default: 1 (if the element is empty or missing) |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: directory
| Name | directory |
|---|---|
| Type | xsd:string |
| Nillable | no |
| Abstract | no |
| Documentation | Specifies the path of the directory the jobmanager will use as the default directory for the requested job. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: environment
| Name | environment |
|---|---|
| Type | tns:NameValuePairType |
| Nillable | no |
| Abstract | no |
| Documentation | The environment variables that will be defined for the executable in addition to default set that is given to the job by the jobmanager. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: executable
| Name | executable |
|---|---|
| Type | xsd:string |
| Nillable | no |
| Abstract | no |
| Documentation | The name of the executable file to run on the remote machine. If the value is a GASS URL, the file is transferred to the remote gass cache before executing the job and removed after the job has terminated. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: extensions
| Name | extensions |
|---|---|
| Type | tns:ExtensionsType |
| Nillable | no |
| Abstract | no |
| Documentation | This section is currently used only to specify client-specific data which the client wishes to associate with the job it is controlling. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: factoryEndpoint
| Name | factoryEndpoint |
|---|---|
| Type | wsa:EndpointReferenceType |
| Nillable | no |
| Abstract | no |
| Documentation | The Managed Job Factory service endpoint to submit this job description to. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: fileCleanUp
| Name | fileCleanUp |
|---|---|
| Type | rft:DeleteRequestType |
| Nillable | no |
| Abstract | no |
| Documentation | Specifies a list of files local to the job which indicate files to be removed via a GridFTP-compatible file server. |
| XML Instance Representation |
|---|
|
<tns:fileCleanUp>
<!-- 'tns:BaseRequestType' super type was not found in this schema. Some elements and attributes may be missing. --> </tns:fileCleanUp> |
| Schema Component Representation |
|---|
|
|
Element: fileStageIn
| Name | fileStageIn |
|---|---|
| Type | rft:TransferRequestType |
| Nillable | no |
| Abstract | no |
| Documentation | Specifies a list of ("remote URL" "local file") pairs which indicate files to be staged to the nodes which will run the job. |
| XML Instance Representation |
|---|
|
<tns:fileStageIn>
<!-- 'tns:BaseRequestType' super type was not found in this schema. Some elements and attributes may be missing. --> </tns:fileStageIn> |
| Schema Component Representation |
|---|
|
|
Element: fileStageOut
| Name | fileStageOut |
|---|---|
| Type | rft:TransferRequestType |
| Nillable | no |
| Abstract | no |
| Documentation | Specifies a list of ("local file" "remote URL") pairs which indicate files to be staged from the job to a GridFTP-compatible file server. |
| XML Instance Representation |
|---|
|
<tns:fileStageOut>
<!-- 'tns:BaseRequestType' super type was not found in this schema. Some elements and attributes may be missing. --> </tns:fileStageOut> |
| Schema Component Representation |
|---|
|
|
Element: hostCount
| Name | hostCount |
|---|---|
| Type | xsd:positiveInteger |
| Nillable | no |
| Abstract | no |
| Documentation | Only applies to clusters of SMP computers, such as newer IBM SP systems. Defines the number of nodes pizza boxes") to distribute the "count" processes across. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: job
| Name | job |
|---|---|
| Type | tns:JobDescriptionType |
| Nillable | no |
| Abstract | no |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: jobCredentialEndpoint
| Name | jobCredentialEndpoint |
|---|---|
| Type | wsa:EndpointReferenceType |
| Nillable | no |
| Abstract | no |
| Documentation | An EPR which points to the delegated credential resource. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: jobType
| Name | jobType |
|---|---|
| Type | tns:JobTypeEnumeration |
| Nillable | no |
| Abstract | no |
| Documentation | This specifies how the jobmanager should start the job. |
| XML Instance Representation |
|---|
|
|
| Schema Component Representation |
|---|
|
|
Element: libraryPath
| Name | libraryPath |
|---|---|
| Type | xsd:string |
| Nillable | no |
| Abstract | no |
| Documentation | Specifies a list of paths to be appended to the system-specific library path environment variables. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: maxCpuTime
| Name | maxCpuTime |
|---|---|
| Type | xsd:long |
| Nillable | no |
| Abstract | no |
| Documentation | Explicitly set the maximum cputime per executable process. The units is in minutes. The value will go through an atoi() conversion in order to get an integer. If the GRAM scheduler cannot set cputime, then an error will be returned. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: maxMemory
| Name | maxMemory |
|---|---|
| Type | xsd:nonNegativeInteger |
| Nillable | no |
| Abstract | no |
| Documentation | Explicitly set the maximum amount of memory per executable process. The units is in Megabytes. The value will go through an atoi() conversion in order to get an integer. If the GRAM scheduler cannot set maxMemory, then an error will be returned. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: maxTime
| Name | maxTime |
|---|---|
| Type | xsd:long |
| Nillable | no |
| Abstract | no |
| Documentation | The maximum walltime or cputime per executable process. Walltime or cputime is selected by the GRAM scheduler being interfaced. The units is in minutes. The value will go through an atoi() conversion in order to get an integer. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: maxWallTime
| Name | maxWallTime |
|---|---|
| Type | xsd:long |
| Nillable | no |
| Abstract | no |
| Documentation | Explicitly set the maximum walltime per executable process. The units is in minutes. The value will go through an atoi() conversion in order to get an integer. If the GRAM scheduler cannot set walltime, then an error will be returned. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: minMemory
| Name | minMemory |
|---|---|
| Type | xsd:nonNegativeInteger |
| Nillable | no |
| Abstract | no |
| Documentation | Explicitly set the minimum amount of memory per executable process. The units is in Megabytes. The value will go through an atoi() conversion in order to get an integer. If the GRAM scheduler cannot set minMemory, then an error will be returned. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: multiJob
| Name | multiJob |
|---|---|
| Type | tns:MultiJobDescriptionType |
| Nillable | no |
| Abstract | no |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: project
| Name | project |
|---|---|
| Type | xsd:string |
| Nillable | no |
| Abstract | no |
| Documentation | Target the job to be allocated to a project account as defined by the scheduler at the defined (remote) resource. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: queue
| Name | queue |
|---|---|
| Type | xsd:string |
| Nillable | no |
| Abstract | no |
| Documentation | Target the job to a queue (class) name as defined by the scheduler at the defined (remote) resource. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: serviceLevelAgreement
| Name | serviceLevelAgreement |
|---|---|
| Type | tns:ServiceLevelAgreementType |
| Nillable | no |
| Abstract | no |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: stagingCredentialEndpoint
| Name | stagingCredentialEndpoint |
|---|---|
| Type | wsa:EndpointReferenceType |
| Nillable | no |
| Abstract | no |
| Documentation | An EPR which points to the delegated credential resource used to make remote calls to RFT. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: stderr
| Name | stderr |
|---|---|
| Type | xsd:string |
| Nillable | no |
| Abstract | no |
| Documentation | The name of the remote file to store the standard error from the job. The standard error from the job is staged after the execution to the paths or URLs specified as the values. Values which are local paths will be staged relative to the users home directory. Values which are absolute paths will be staged simply as if 'file://' were prepended to the path. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: stdin
| Name | stdin |
|---|---|
| Type | xsd:string |
| Nillable | no |
| Abstract | no |
| Documentation | The name of the file to be used as standard input for the executable on the remote machine. If the value is a GASS URL, the file is transferred to the remote gass cache before executing the job and removed after the job has terminated. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Element: stdout
| Name | stdout |
|---|---|
| Type | xsd:string |
| Nillable | no |
| Abstract | no |
| Documentation | The name of the remote file to store the standard output from the job. The standard output from the job is staged after the execution to the paths or URLs specified as the values. Values which are local paths will be staged relative to the users home directory. Values which are absolute paths will be staged simply as if 'file://' were prepended to the path. |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
|
|
Global Definitions
Complex Type: ExtensionsType
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | ExtensionsType |
|---|---|
| Abstract | no |
| XML Instance Representation |
|---|
|
<...>
Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*] </...> |
| Schema Component Representation |
|---|
|
<xsd:complexType name="ExtensionsType">
<xsd:sequence> </xsd:complexType><xsd:any namespace="##other" minOccurs="0" maxOccurs="unbounded" processContents="lax"/> </xsd:sequence> |
Complex Type: FilePairType
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | FilePairType |
|---|---|
| Abstract | no |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
Complex Type: JobDescriptionType
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | JobDescriptionType |
|---|---|
| Abstract | no |
| XML Instance Representation |
|---|
|
<...>
</...> |
| Schema Component Representation |
|---|
|
<xsd:complexType name="JobDescriptionType">
<xsd:sequence></xsd:sequence> </xsd:complexType> |
Complex Type: MultiJobDescriptionType
| Super-types: | JobDescriptionType < MultiJobDescriptionType (by extension) |
|---|---|
| Sub-types: | None |
| Name | MultiJobDescriptionType |
|---|---|
| Abstract | no |
| Documentation | This type extends JobDescriptionType to allow generalities. If a single job description element does not contain a particular attribute, the outer-scope value will be assumed if it is defined. |
| XML Instance Representation |
|---|
|
<...>
</...> |
| Schema Component Representation |
|---|
|
<xsd:complexType name="MultiJobDescriptionType">
<xsd:complexContent></xsd:complexContent> </xsd:complexType> |
Complex Type: NameValuePairType
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | NameValuePairType |
|---|---|
| Abstract | no |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
Complex Type: ServiceLevelAgreementType
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | ServiceLevelAgreementType |
|---|---|
| Abstract | no |
| XML Instance Representation |
|---|
| Schema Component Representation |
|---|
Simple Type: JobTypeEnumeration
| Super-types: | xsd:string < JobTypeEnumeration (by restriction) |
|---|---|
| Sub-types: | None |
| Name | JobTypeEnumeration |
|---|---|
| Content |
|
| Schema Component Representation |
|---|
|
<xsd:simpleType name="JobTypeEnumeration">
<xsd:restriction base="xsd:string"> </xsd:simpleType><xsd:enumeration value="mpi"/> <xsd:enumeration value="single"/> <xsd:enumeration value="multiple"/> <xsd:enumeration value="condor"/> </xsd:restriction> |
Legend
| Complex Type: | AusAddress |
| Schema Component Type | Schema Component Name |
| Super-types: | Address < AusAddress (by extension) |
|---|---|
| Sub-types: |
|
| Name | AusAddress |
|---|---|
| Abstract | no |
| XML Instance Representation |
|---|
|
<... country="Australia">
<unitNo> string </unitNo> [0..1] <houseNo> string </houseNo> [1] <street> string </street> [1] Start Choice[1] <city> string </city> [1] <town> string </town> [1] End Choice <state> AusStates </state> [1] <postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] </...> |
The XML Instance Representation table above shows the schema component's content as an XML instance.
- The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
- Model group information are shown in gray, e.g. Start Choice ... End Choice.
- For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold.
- If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
- Otherwise, the type of the element/attribute is displayed.
- If the element/attribute's type is in the schema, a link is provided to it.
- For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.
| Schema Component Representation |
|---|
|
<complexTypename="AusAddress">
<complexContent> <extensionbase="Address"> <sequence> <elementname="state" type="AusStates"/> <elementname="postcode"> <simpleType> <restrictionbase="string"> <patternvalue="[1-9][0-9]{3}"/> </restriction> </simpleType> </element> </sequence> <attributename="country" type="string" fixed="Australia"/> </extension> </complexContent> </complexType> |
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.
Generated by xs3p.