This wiki is locked. Future workgroup activity and specification development must take place at our new wiki. For more information, see this blog post about the new governance model and this post about changes to the website.
TWiki> Main Web>AutomationHome>AutomationVocabulary (revision 1)

The OSLC Automation Vocabulary

The namespace URI for this vocabulary is: 

http://open-services.net/ns/auto#

This page lists the RDFS classes and RDF properties that make up the OSLC Automation vocabulary. Following W3C best practices, this information is available in HTML format (this page) and in RDFS format.

More details on how this page is generated and other related material can be found in the OSLC URI Naming Guidelines.

Description:

All vocabulary URIs defined in the OSLC Automation namespace.

See Also:

RDFS Classes in this namespace

AutomationPlan, AutomationRequest, AutomationResult, ParameterInstance

RDF Properties in this namespace

canceled, canceling, complete, desiredState, error, executesAutomationPlan, fail, hasContribution, inProgress, inputParameter, new, outputParameter, parameterDefinition, pass, producedByAutomationRequest, queued, reportsOnAutomationPlan, state, unavailable, verdict, warning

AutomationPlan

http://open-services.net/ns/auto#AutomationPlan
AutomationPlan is an RDFS class.

The Automation Plan resource

See Also:

AutomationRequest

http://open-services.net/ns/auto#AutomationRequest
AutomationRequest is an RDFS class.

The Automation Request resource

See Also:

AutomationResult

http://open-services.net/ns/auto#AutomationResult
AutomationResult is an RDFS class.

The Automation Result resource

See Also:

canceled

http://open-services.net/ns/auto#canceled
canceled is an RDF description.

Used to indicate that an automation request or result has been canceled.

See Also:

canceling

http://open-services.net/ns/auto#canceling
canceling is an RDF description.

Used to indicate the service provider is in the process of canceling an automation request or result.

See Also:

complete

http://open-services.net/ns/auto#complete
complete is an RDF description.

Used to indicate that an automation request or result is complete.

See Also:

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.

See Also:

error

http://open-services.net/ns/auto#error
error is an RDF description.

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.

See Also:

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.

See Also:

fail

http://open-services.net/ns/auto#fail
fail is an RDF description.

Used to indicate an automation result represents a failed execution.

See Also:

hasContribution

http://open-services.net/ns/auto#hasContribution
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.

See Also:

inProgress

http://open-services.net/ns/auto#inProgress
inProgress is an RDF description.

Used to indicate an automation request or result is active in the service provider.

See Also:

inputParameter

http://open-services.net/ns/auto#initialParameter
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.

See Also:

new

http://open-services.net/ns/auto#new
new is an RDF description.

Used to indicate an automation request or result has just been created in the service provider and has not yet been acted upon.

See Also:

outputParameter

http://open-services.net/ns/auto#additionalParameter
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.

See Also:

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.

See Also:

ParameterInstance

http://open-services.net/ns/auto#ParameterInstance
ParameterInstance is an RDFS class.

The Automation Parameter Instance resource

See Also:

pass

http://open-services.net/ns/auto#pass
pass is an RDF description.

Used to indicate an automation result represents a successful execution.

See Also:

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.

See Also:

queued

http://open-services.net/ns/auto#queued
queued is an RDF description.

Primarily used to indicate an automation request or result is queued for additional actions by the service provider.

See Also:

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.

See Also:

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.

See Also:

unavailable

http://open-services.net/ns/auto#unavailable
unavailable is an RDF description.

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.

See Also:

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.

See Also:

warning

http://open-services.net/ns/auto#warning
warning is an RDF description.

Used to indicate an automation result represents an execution which encountered conditions which prevented successful execution but did not result in a failed execution.

See Also:
Attachments Attachments
Topic attachments
I Attachment Action Size Date Who Comment
htmlhtml auto.html manage 3.2 K 17 Jan 2012 - 14:47 PramodChandoria  
elserdf auto.rdf manage 2.3 K 17 Jan 2012 - 14:38 PramodChandoria  
Edit | Attach | Print version | History: r3 < r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions...
Topic revision: r1 - 17 Jan 2012 - 14:47:40 - PramodChandoria
 
This site is powered by the TWiki collaboration platform Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use
Ideas, requests, problems regarding this site? Send feedback