The OSLC Automation Vocabulary
All vocabulary
URIs defined in the OSLC Automation namespace.
Automation
AutomationPlan
The Automation Plan resource
AutomationRequest
The Automation Request resource
AutomationResult
The Automation Result resource
ParameterInstance
The Automation Parameter Instance resource
parameterDefinition
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:inputParameter` when
unmodified during execution, or as an `oslc_auto:outputParameter`
when modified during execution.
inputParameter
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.
state
Used to indicate the state of the automation request or
result based on values defined in the automation specification and,
optionally, 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 or result state on the service
provider.
desiredState
The intended (domain- or provider-dependant) value of a resource's (domain-dependant) "state" property after some (future, present or past) process, transition or change. It is expected that this will be a resource reference to a definition of a valid state on the service provider. For example, in the OSLC Automation domain this is used to indicate the desired state of the Automation Request based on values defined in the OSLC Automation specification and, optionally, by the service provider.
executesAutomationPlan
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.
verdict
Used to indicate the verdict of the automation result
based on values defined by the automation specification and,
optionally, 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.
contribution
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.
outputParameter
Automation Result output parameters are parameters
associated with the automation execution which produced this Result.
This includes the final value of all parameters used to initiate the
execution and any additional parameters which may have been created
during automation execution by the service provider or external
agents. The value of a given `oslc_auto:outputParameter` MAY change
as the execution proceeds. Point-in-time accuracy of the values of
output parameters is not covered by this specification. Once the
Automation Result is in a final state ( `oslc_auto:complete` or
`oslc_auto:canceled`), the `oslc_auto:outputParameter` values MUST
NOT change.
producedByAutomationRequest
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.
reportsOnAutomationPlan
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.
passed
Used to indicate an automation result represents a
successful execution.
warning
Used to indicate an automation result represents an
execution which encountered conditions
which prevented successful
execution but did not result in a failed
execution.
failed
Used to indicate an automation result represents a
failed execution.
error
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.
unavailable
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.
new
Used to indicate an automation request or result has
just been created in the service
provider and has not yet been acted
upon.
queued
Primarily used to indicate an automation request or
result is queued for additional
actions by the service provider.
inProgress
Used to indicate an automation request or result is
active in the service provider.
canceling
Used to indicate the service provider is in the process
of canceling an automation request or result.
canceled
Used to indicate that an automation request or result
has been canceled.
complete
Used to indicate that an automation request or result is
complete.
TeardownAction
An action that tears down a previously deployed resource.
It is likely that the resource was deployed using an OSLC Automation deployment plan, but this is not always the case.
That is, a tear-down action typically has the opposite semantics from a oslc_auto:Deploy sub-domain Automation Plan or Request,
even if the service provider offers no equivalents in its Automation Plan collection.
usesExecutionEnvironment
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.
ImmediateExecution
A resource that creates an Automation Request that is eligible for execution as soon as it is created,
as defined by the OSLC Automation specification.
For example, when used as an oslc:usage value on an oslc:Dialog, it indicates that it is a creation dialog for Automation Requests that are eligible for execution.
oslc:Dialog resources that use this as an oslc:usage value are compatible with Automation request creation dialog behaviour from OSLC Automation 2.0.
DeferredExecution
A resource that creates an Automation Request that is ineligible for immediate execution,
as defined by the OSLC Automation specification. For example, when used on as an oslc:usage value an oslc:Dialog,
it indicates that it is a creation dialog for Automation Requests that are not eligible for execution.