Notices
Copyright ©
OASIS Open
2021.
All Rights Reserved.
All capitalized terms in the following text have the meanings assigned to them in the
OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy").
The full Policy
may be found at the OASIS website.
This specification is published under the Attribution 4.0 International (CC BY 4.0).
Portions of this specification are also provided under the Apache License 2.0.
All contributions made to this project have been made under the
OASIS Contributor License Agreement (CLA).
For information on whether any patents have been disclosed that may be essential to implementing this specification,
and any offers of patent licensing terms,
please refer to the
Open Projects IPR Statements page.
This document and translations of it may be copied and furnished to others,
and derivative works that comment on or otherwise explain it or assist in its implementation
may be prepared, copied, published, and distributed, in whole or in part,
without restriction of any kind, provided that the above copyright notice
and this section are included on all such copies and derivative works.
However, this document itself may not be modified in any way,
including by removing the copyright notice or references to OASIS,
except as needed for the purpose of developing any document or deliverable
produced by an OASIS Open Project or OASIS Technical Committee
(in which case the rules applicable to copyrights,
as set forth in the OASIS IPR Policy, must be followed)
or as required to translate it into languages other than English.
The limited permissions granted above are perpetual and will not be revoked by OASIS
or its successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis
and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY
THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
OASIS requests that any OASIS Party or any other party that believes it has patent claims
that would necessarily be infringed by implementations of this OASIS Project Specification
or OASIS Standard, to notify the OASIS TC Administrator and provide an indication of its
willingness to grant patent licenses to such patent claims in a manner consistent with the
IPR Mode of the OASIS Technical Committee that produced this specification.
OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership
of any patent claims that would necessarily be infringed by implementations of this specification
by a patent holder that is not willing to provide a license to such patent claims in a manner
consistent with the IPR Mode of the OASIS Open Project that produced this specification.
OASIS may include such claims on its website, but disclaims any obligation to do so.
OASIS takes no position regarding the validity or scope of any intellectual property
or other rights that might be claimed to pertain to the implementation or use of
the technology described in this document or the extent to which any license under
such rights might or might not be available;
neither does it represent that it has made any effort to identify any such rights.
Information on OASIS' procedures with respect to rights in any document or deliverable
produced by an OASIS Technical Committee can be found on the OASIS website.
Copies of claims of rights made available for publication and any assurances of licenses
to be made available, or the result of an attempt made to obtain a general license
or permission for the use of such proprietary rights by implementers or users of this
OASIS Open Project Specification or OASIS Standard, can be obtained from the OASIS TC Administrator.
OASIS makes no representation that any information or list of intellectual property rights
will at any time be complete, or that any claims in such list are, in fact, Essential Claims.
The name "OASIS" is a trademark of OASIS,
the owner and developer of this specification,
and should be used only to refer to the organization and its official outputs.
OASIS welcomes reference to, and implementation and use of, specifications,
while reserving the right to enforce its marks against misleading uses. Please see
https://www.oasis-open.org/policies-guidelines/trademark
for above guidance.
2. Automation Vocabulary Terms
This specification defines the root superclasses, properties and values. Servers may define additional
subclasses and provide additional properties as needed.
2.1 Vocabulary Details
The namespace URI for this vocabulary is:
http://open-services.net/ns/auto#
All vocabulary URIs defined in the OSLC Automation namespace.
AutomationPlan
http://open-services.net/ns/auto#AutomationPlan
AutomationPlan is an RDFS class.
The Automation Plan resource.
AutomationRequest
http://open-services.net/ns/auto#AutomationRequest
AutomationRequest is an RDFS class.
The Automation Request resource.
AutomationResult
http://open-services.net/ns/auto#AutomationResult
AutomationResult is an RDFS class.
The Automation Result resource.
ParameterInstance
http://open-services.net/ns/auto#ParameterInstance
ParameterInstance is an RDFS class.
The Automation Parameter Instance resource.
State
http://open-services.net/ns/auto#State
State is an RDFS class.
Defines the possible oslc_auto:state property values.
Verdict
http://open-services.net/ns/auto#Verdict
Verdict is an RDFS class.
Defines the possible oslc_auto:verdict property values.
2.1.2 Properties in this namespace (14)
binding, desiredState, executesAutomationPlan, futureAction, hasContribution, inputParameter, outputParameter, parameterDefinition, producedByAutomationRequest, progress, reportsOnAutomationPlan, state, usesExecutionEnvironment, verdict
binding
http://open-services.net/ns/auto#binding
binding is an RDF property.
A resource providing instructions that a client can follow to immediately execute the action, when the client is ready to do so. In this context (a deferred execution creation dialog), each binding is likely to be an immediate-execution binding, used during the execution phase of the deferred execution dialog interaction pattern.
desiredState
http://open-services.net/ns/auto#desiredState
desiredState is an RDF property.
Used to indicate the desired state of the automation request based on values defined by the service provider.
executesAutomationPlan
http://open-services.net/ns/auto#executesAutomationPlan
executesAutomationPlan is an RDF property.
Automation Plan run by the Automation Request. It is likely that the target resource will be an oslc_auto:AutomationPlan but that is not necessarily the case.
futureAction
http://open-services.net/ns/auto#futureAction
futureAction is an RDF property.
A resource representing actions that will become available on Automation Results that result from execution of this Plan. The resource is likely to be of type oslc:Action,
but it can be of any type. Automation defines oslc_auto:TeardownAction as one kind of future action.
hasContribution
http://open-services.net/ns/auto#contribution
hasContribution is an RDF property.
A result contribution associated with this automation result. It is recommended that the contribution be an inline resource which can be retrieved with the automation result. The recommended attributes beyond the contribution itself are dcterms:title, dcterms:description and dcterms:type to provide a description of the contribution which would be appropriate for display in a simple UI for an automation result.
http://open-services.net/ns/auto#inputParameter
inputParameter is an RDF property.
Parameters provided when Automation Requests are created. These include parameters provided by the creator of the Automation Request (whether by delegated UI or HTTP POST) and MAY include additional parameters added by the service provider during Automation Request creation. See the definition of the oslc_auto:parameterDefinition attribute of the Automation Plan for additional guidance on determining which parameters are required. Creators of Automation Requests MAY provide parameters beyond those defined in the Automation Plan without guarantee the service provider will recognize or honor them. It is expected that this attribute is write-able on Automation Request creation and read-only thereafter.
outputParameter
http://open-services.net/ns/auto#outputParameter
outputParameter is an RDF property.
Automation Result output parameters are parameters associated with the result other than the oslc_auto:inputParameter resources. These could be parameters added during automation execution by the service provider or external agents. They could also be copies of input parameters with values changed during execution.
parameterDefinition
http://open-services.net/ns/auto#parameterDefinition
parameterDefinition is an RDF property.
The definition of a parameter for this Automation Plan. parameterDefinitions are either a local (inline) or referenced resource and use the attributes (the range) of the oslc:Property resource with one exception. When used in the context of an oslc_auto:parameterDefinition, the cardinality of oslc:propertyDefinition becomes zero-or-one instead of exactly-one. Automation consumers creating Automation Requests MUST use the oslc:occurs attribute of the parameterDefinition, if present, to determine if a given parameter is required when creating the Automation Request. If the oslc:occurs attribute indicates the parameter is required (exactly-one or one-or-more), the service provider must guarantee the named parameter will be present in the Automation Result either as an oslc_auto:inputParmeter when unmodified during execution, or as an oslc_auto:outputParameter when modified during execution.
producedByAutomationRequest
http://open-services.net/ns/auto#producedByAutomationRequest
producedByAutomationRequest is an RDF property.
Automation Request which produced the Automation Result. It is likely that the target resource will be an oslc_auto:AutomationResult but that is not necessarily the case.
progress
http://open-services.net/ns/auto#progress
progress is an RDF property.
A percentage (0-100) of completion.
reportsOnAutomationPlan
http://open-services.net/ns/auto#reportsOnAutomationPlan
reportsOnAutomationPlan is an RDF property.
Automation Plan which the Automation Result reports on. It is likely that the target resource
will be an oslc_auto:AutomationPlan but that is not necessarily the case.
state
http://open-services.net/ns/auto#state
state is an RDF property.
Used to indicate the state of the automation request based on values defined by the service provider. Most often a read-only property. It is expected that this will be a resource reference to a definition of a valid automation request state on the service provider.
usesExecutionEnvironment
http://open-services.net/ns/auto#usesExecutionEnvironment
usesExecutionEnvironment is an RDF property.
A resource representing the environment(s) which this Automation Plan can be executed in. The execution environment resource could represent a grouping of
environmental details such as operating system, database, browser, compiler, etc. See also the execution environments section.
verdict
http://open-services.net/ns/auto#verdict
verdict is an RDF property.
Used to indicate the verdict of the automation result based on values defined by the service provider. Most often a read-only property. It is expected that this will be a resource reference to a definition of a valid automation result verdict on the service provider.
2.1.3 Resources (Individuals) in this namespace (11)
canceled, canceling, complete, error, fail, inProgress, new, passed, queued, unavailable, warning
canceled
http://open-services.net/ns/auto#canceled
canceled is an RDF individual.
Used to indicate that an automation request or result has been canceled.
canceling
http://open-services.net/ns/auto#canceling
canceling is an RDF individual.
Used to indicate the service provider is in the process of canceling an automation request or result.
complete
http://open-services.net/ns/auto#complete
complete is an RDF individual.
Used to indicate that an automation request or result is complete.
error
http://open-services.net/ns/auto#error
error is an RDF individual.
Used to indicate an automation result has completed but did not run successfully due to some error. This could be a timeout, automation coding error, network problem or other error which prevented the automation from running successfully to a pass, warning or fail verdict.
fail
http://open-services.net/ns/auto#failed
fail is an RDF individual.
Used to indicate an automation result represents a failed execution.
inProgress
http://open-services.net/ns/auto#inProgress
inProgress is an RDF individual.
Used to indicate an automation request or result is active in the service provider.
new
http://open-services.net/ns/auto#new
new is an RDF individual.
Used to indicate an automation request or result has just been created in the service provider and has not yet been acted upon.
passed
http://open-services.net/ns/auto#passed
passed is an RDF individual.
Used to indicate an automation result represents a passed execution.
queued
http://open-services.net/ns/auto#queued
queued is an RDF individual.
Primarily used to indicate an automation request or result is queued for additional actions by the service provider.
unavailable
http://open-services.net/ns/auto#unavailable
unavailable is an RDF individual.
Used to indicate an automation result is in a state where a final verdict such as oslc:auto_pass or oslc_auto:fail is not yet available. Usually used when the result is in a state other than oslc_auto:complete.
warning
http://open-services.net/ns/auto#warning
warning is an RDF individual.
Used to indicate an automation result represents an execution which encountered conditions which prevented successful execution but did not result in a failed execution.
3. Automation Resource Definitions
The Automation resource properties are not limited to the ones defined in this specification; service providers
may provide additional properties. It is recommended that any additional properties exist in their own unique
namespace and not use the namespaces defined in this specification.
A list of properties is defined for each type of resource. Most of these properties are identified in
[OSLCCore3] Any exceptions are noted. Relationship properties refer to other resources. These resources may
be in any OSLC domain (including Automation).
The diagram below shows the relationships between Automation Resources.
For all resource types defined in this specification, all required properties (those defined with an occurrence
of exactly-one or one-or-many) MUST exist for each resource and must be provided when requested. All other
properties are optional, and might not exist on some or any resources; those that do not exist will not be
present in the returned representation even if requested, while those that do exist MUST be provided if
requested. Providers MAY define additional provider-specific properties; providers SHOULD use their own
namespaces for such properties, or use standard Dublin Core or RDF namespaces and properties where appropriate.
If no specific set of properties is requested, all properties are returned - both those defined in this
specification as well as any provider-specific ones. See [OSLCCore2] Selective Property Values in OSLC Core
Specification.
Consumers of OSLC Automation services should note that some resources may have a very large number of related
resources, and that some resources may be very large and/or expensive to compute. For this reason, consumers are
strongly encouraged to use the oslc.properties parameter to limit the properties returned from a
request to the subset required. See [OSLCCore2] Selective Property Values in OSLC Core Specification.
3.1 Vocabulary Details
The namespace URI for this vocabulary is:
http://open-services.net/ns/auto#
All vocabulary URIs defined in the OSLC Automation namespace.
AutomationPlan
http://open-services.net/ns/auto#AutomationPlan
AutomationPlan is an RDFS class.
The Automation Plan resource.
AutomationRequest
http://open-services.net/ns/auto#AutomationRequest
AutomationRequest is an RDFS class.
The Automation Request resource.
AutomationResult
http://open-services.net/ns/auto#AutomationResult
AutomationResult is an RDFS class.
The Automation Result resource.
ParameterInstance
http://open-services.net/ns/auto#ParameterInstance
ParameterInstance is an RDFS class.
The Automation Parameter Instance resource.
State
http://open-services.net/ns/auto#State
State is an RDFS class.
Defines the possible oslc_auto:state property values.
Verdict
http://open-services.net/ns/auto#Verdict
Verdict is an RDFS class.
Defines the possible oslc_auto:verdict property values.
3.1.2 Properties in this namespace (14)
binding, desiredState, executesAutomationPlan, futureAction, hasContribution, inputParameter, outputParameter, parameterDefinition, producedByAutomationRequest, progress, reportsOnAutomationPlan, state, usesExecutionEnvironment, verdict
binding
http://open-services.net/ns/auto#binding
binding is an RDF property.
A resource providing instructions that a client can follow to immediately execute the action, when the client is ready to do so. In this context (a deferred execution creation dialog), each binding is likely to be an immediate-execution binding, used during the execution phase of the deferred execution dialog interaction pattern.
desiredState
http://open-services.net/ns/auto#desiredState
desiredState is an RDF property.
Used to indicate the desired state of the automation request based on values defined by the service provider.
executesAutomationPlan
http://open-services.net/ns/auto#executesAutomationPlan
executesAutomationPlan is an RDF property.
Automation Plan run by the Automation Request. It is likely that the target resource will be an oslc_auto:AutomationPlan but that is not necessarily the case.
futureAction
http://open-services.net/ns/auto#futureAction
futureAction is an RDF property.
A resource representing actions that will become available on Automation Results that result from execution of this Plan. The resource is likely to be of type oslc:Action,
but it can be of any type. Automation defines oslc_auto:TeardownAction as one kind of future action.
hasContribution
http://open-services.net/ns/auto#contribution
hasContribution is an RDF property.
A result contribution associated with this automation result. It is recommended that the contribution be an inline resource which can be retrieved with the automation result. The recommended attributes beyond the contribution itself are dcterms:title, dcterms:description and dcterms:type to provide a description of the contribution which would be appropriate for display in a simple UI for an automation result.
http://open-services.net/ns/auto#inputParameter
inputParameter is an RDF property.
Parameters provided when Automation Requests are created. These include parameters provided by the creator of the Automation Request (whether by delegated UI or HTTP POST) and MAY include additional parameters added by the service provider during Automation Request creation. See the definition of the oslc_auto:parameterDefinition attribute of the Automation Plan for additional guidance on determining which parameters are required. Creators of Automation Requests MAY provide parameters beyond those defined in the Automation Plan without guarantee the service provider will recognize or honor them. It is expected that this attribute is write-able on Automation Request creation and read-only thereafter.
outputParameter
http://open-services.net/ns/auto#outputParameter
outputParameter is an RDF property.
Automation Result output parameters are parameters associated with the result other than the oslc_auto:inputParameter resources. These could be parameters added during automation execution by the service provider or external agents. They could also be copies of input parameters with values changed during execution.
parameterDefinition
http://open-services.net/ns/auto#parameterDefinition
parameterDefinition is an RDF property.
The definition of a parameter for this Automation Plan. parameterDefinitions are either a local (inline) or referenced resource and use the attributes (the range) of the oslc:Property resource with one exception. When used in the context of an oslc_auto:parameterDefinition, the cardinality of oslc:propertyDefinition becomes zero-or-one instead of exactly-one. Automation consumers creating Automation Requests MUST use the oslc:occurs attribute of the parameterDefinition, if present, to determine if a given parameter is required when creating the Automation Request. If the oslc:occurs attribute indicates the parameter is required (exactly-one or one-or-more), the service provider must guarantee the named parameter will be present in the Automation Result either as an oslc_auto:inputParmeter when unmodified during execution, or as an oslc_auto:outputParameter when modified during execution.
producedByAutomationRequest
http://open-services.net/ns/auto#producedByAutomationRequest
producedByAutomationRequest is an RDF property.
Automation Request which produced the Automation Result. It is likely that the target resource will be an oslc_auto:AutomationResult but that is not necessarily the case.
progress
http://open-services.net/ns/auto#progress
progress is an RDF property.
A percentage (0-100) of completion.
reportsOnAutomationPlan
http://open-services.net/ns/auto#reportsOnAutomationPlan
reportsOnAutomationPlan is an RDF property.
Automation Plan which the Automation Result reports on. It is likely that the target resource
will be an oslc_auto:AutomationPlan but that is not necessarily the case.
state
http://open-services.net/ns/auto#state
state is an RDF property.
Used to indicate the state of the automation request based on values defined by the service provider. Most often a read-only property. It is expected that this will be a resource reference to a definition of a valid automation request state on the service provider.
usesExecutionEnvironment
http://open-services.net/ns/auto#usesExecutionEnvironment
usesExecutionEnvironment is an RDF property.
A resource representing the environment(s) which this Automation Plan can be executed in. The execution environment resource could represent a grouping of
environmental details such as operating system, database, browser, compiler, etc. See also the execution environments section.
verdict
http://open-services.net/ns/auto#verdict
verdict is an RDF property.
Used to indicate the verdict of the automation result based on values defined by the service provider. Most often a read-only property. It is expected that this will be a resource reference to a definition of a valid automation result verdict on the service provider.
3.1.3 Resources (Individuals) in this namespace (11)
canceled, canceling, complete, error, fail, inProgress, new, passed, queued, unavailable, warning
canceled
http://open-services.net/ns/auto#canceled
canceled is an RDF individual.
Used to indicate that an automation request or result has been canceled.
canceling
http://open-services.net/ns/auto#canceling
canceling is an RDF individual.
Used to indicate the service provider is in the process of canceling an automation request or result.
complete
http://open-services.net/ns/auto#complete
complete is an RDF individual.
Used to indicate that an automation request or result is complete.
error
http://open-services.net/ns/auto#error
error is an RDF individual.
Used to indicate an automation result has completed but did not run successfully due to some error. This could be a timeout, automation coding error, network problem or other error which prevented the automation from running successfully to a pass, warning or fail verdict.
fail
http://open-services.net/ns/auto#failed
fail is an RDF individual.
Used to indicate an automation result represents a failed execution.
inProgress
http://open-services.net/ns/auto#inProgress
inProgress is an RDF individual.
Used to indicate an automation request or result is active in the service provider.
new
http://open-services.net/ns/auto#new
new is an RDF individual.
Used to indicate an automation request or result has just been created in the service provider and has not yet been acted upon.
passed
http://open-services.net/ns/auto#passed
passed is an RDF individual.
Used to indicate an automation result represents a passed execution.
queued
http://open-services.net/ns/auto#queued
queued is an RDF individual.
Primarily used to indicate an automation request or result is queued for additional actions by the service provider.
unavailable
http://open-services.net/ns/auto#unavailable
unavailable is an RDF individual.
Used to indicate an automation result is in a state where a final verdict such as oslc:auto_pass or oslc_auto:fail is not yet available. Usually used when the result is in a state other than oslc_auto:complete.
warning
http://open-services.net/ns/auto#warning
warning is an RDF individual.
Used to indicate an automation result represents an execution which encountered conditions which prevented successful execution but did not result in a failed execution.
