Workflow Variables

Description of built-in Workflow Variables that can be referenced in a Workflow Definition.

Workflow Management Workflow Library Workflow Developers Guide

Table of Contents

  1. Introduction
  2. General Variables
  3. Service Specific Variables
  4. Contract Specific Variables

Introduction

The Policy Manager Workflow Library includes a series of built-in variables that can be referred to in a Workflow Definition file. These variables are used to specify service and contract elements that are referenced throughout a Workflow Definition. In addition to the built-in variables, you can also invoke variables bundled with OSWorkflow or custom defined variables. There are three types of built-in variables: Generic, Service-Specific, and Contract-Specific.

Note: Policy Workflow does not include variables.

General Variables

These built-in workflow variables can be used anywhere in Policy Manager workflow definitions.

Variable Content

${subject}

The Subject for the current caller of the workflow instance.

${caller}

Qualified name (domain\user) of the user that is calling workflow.

${owner}

Qualified name (domain\user) of the current “owner” of the workflow step. The “owner” is set whenever an action’s result is fired.

${document}

The WorkflowDocument object for the active workflow instance. (Internal SOA use only).

${root}

The OrganizationKey object for the top-level (Registry) node of the organization tree.

${organization.email.contact}

Comma-delimited list of organization primary email contacts for the organization tree path from the root to the organization containing the service or contract.

back to top

Service Specific Variables

The following built-in workflow variables are used in Service Workflow definitions.

Variable Content

${service}
${service.key}

The ServiceKey object for the service the workflow is managing. This becomes the service’s UDDI key when converted to a string.

${service.name}

The name of the service the workflow is managing.

${service.scope}

The OrganizationKey object of the organization the service belongs to. This becomes the organization’s UDDI key when converted to a string.

${service.consumer}
${service.consumers}

A Collection of OrganizationKey objects for the organizations with contracts to this service.

${service.manager}

The internal ServiceManager published OSGi service. (Internal SOA use only).

${category.manager}

The internal CategoryManager published OSGi service. (Internal SOA use only).

back to top

Contract Specific Variables

The following built-in workflow variables are used in Contract Workflow definitions.

Variable Content

${contract}
${contract.key}

The ContractKey object for the contract the workflow is managing.

${contract.name}

The name of the contract the workflow is managing.

${contract.version}

The version number of the contract.

${contract.description}

The contract’s description.

${contract.summary}

A text block containing the definition of the contract.

${contract.scope}

A text block containing the providing organization along with the services and operations that are within the scope of the contract.

${contract.startdate} The effective date/time of the contract.
${contract.enddate}

The expiration date/time of the contract.

${is.anonymous}

“true” if this is an anonymous contract. “false” otherwise.

${contract.provider}

The OrganizationKey object of the contract’s provider organization. This becomes the organization’s UDDI key when converted to a string.

${provider.name}

The name of the contract’s provider organization.

${provider.contact}

The name of the primary contact for the contract’s provider organization.

${provider.email.contact}

The email address of the primary contact for the contract’s provider organization.

${contract.consumer}

The OrganizationKey object of the contract’s consumer organization. This becomes the organization’s UDDI key when converted to a string.

${consumer.name}

The name of the contract’s consumer organization.

${consumer.contact}

The name of the primary contact for the contract’s consumer organization.

${consumer.email.contact}

The email address of the primary contact for the contract’s consumer organization.

${contract.manager}

The internal ContractsManager published OSGi service. (Internal SOA use only).

back to top