---
is selected), the associated policy is executed for any status addition.
---
is selected), the associated policy is executed for any data object update. See Policy Events and Scope for additional
information.
Property Name
|
Description
|
---|---|
Workflow ID Data Object
|
Specifies the element path to a data object that contains the ID value of the target
workflow.
|
Status Label
|
Specifies the element path to the status that is added to the target task.
|
Property Name
|
Description
|
---|---|
Task
|
Specifies the element path of the task or subflow to which the status is added.
|
Status
|
Specifies the element
path of the status to be added.
|
Property Name
|
Description
|
---|---|
Source Data Object
|
Specifies the element path of the data object whose value is to be copied.
|
Target Data Object
|
Specifies the element path of the target data object where the value is to be copied.
|
Property Name
|
Description
|
---|---|
Source Workflow ID Data
Object
|
Specifies the element path to a data object that contains the workflow ID value of
the source workflow.
|
Source Data Object Label
|
Specifies the element path of the external data object whose value is to be copied.
|
Target Data Object
|
Specifies the element path of the target data object in the current workflow where
the value is to be copied.
|
Property Name
|
Description
|
---|---|
Source Data Object
|
Specifies the element path of the local data object whose value is to be copied.
|
Target Workflow ID Data
Object
|
Specifies the element path to a data object that contains the workflow ID value of
the target workflow.
|
Target Data Object Label
|
Specifies the element path of the target data object where the value is to be copied.
|
Property Name
|
Description
|
---|---|
Source Task
|
Specifies the element path of the task from which the participant is copied.
|
Source Role
|
Specifies the workflow role that is copied from the source task.
|
Target Task
|
Specifies the element path of the task to which the participant is copied.
|
Target Role
|
Specifies the workflow role for the target task.
|
Property Name
|
Description
|
---|---|
XML Data Object
|
Specifies the element path to the data object that contains the XML value from which
the value is extracted.
|
Output Data Object
|
Specifies the element path to the data object to which the extracted text value is
stored.
|
XPath Statement
|
Specifies the statement that is used to extract the desired text from the data object
specified in the XML Data Object property.
|
<?xml version="1.0" encoding="ISO-8859-1"?> <bookstore> <book> <title lang="en">Harry Potter</title> <author>J K. Rowling</author> <year>2005</year> <price>29.99</price> </book> </bookstore>
/bookstore/book/title
for
the XPath Statement property, then the policy
stores the value Harry Potter
in the target data object.
declare namespace n = "http://support.sas.com/xml/namespace/biwebservices/webservicemaker-9.2"; /n:ListWebServicesResponse/n:ListWebServicesResult/n:string
Property Name
|
Description
|
---|---|
Directive Name
|
Specifies the name of the directive. The value can be specified using data object
substitution. (See Data Object Substitution.) If you are logged on to the SAS platform, you can click to display the list of registered directives.
|
URL
|
Specifies the target URL to invoke, execute, or access. The value can be specified
using data object substitution.
If the value contains
non-ASCII characters, you should select Encode the data
objects in the URL when the policy executes. See the
standard for Uniform Resource Identifier (URI): Generic Syntax at http://tools.ietf.org/html/rfc3986 for
information about character encoding.
|
Parameters
|
Specifies any required additional HTTP parameter values. The value can be specified
using data object substitution.
|
Status Code Data Object
|
Specifies an optional data object to hold the value of the return code of the HTTP
request.
|
Disable Authentication
|
Specifies whether the
proxy ticket for the HTTP request URL should be generated.
Selecting Disable
Authentication prevents the HTTP request policy from generating a proxy ticket to add to the URL.
|
Property Name
|
Description
|
---|---|
Data Object
|
Specifies the element path to a data object to be incremented.
|
Increment Value
|
Specifies the numeric value by which the data object should be incremented. The default
value is 1. Using operand substitution in place
of a value is also supported.
|
Property Name
|
Description
|
---|---|
Web Service Location
|
Specifies the URL of the web service endpoint. The value can be specified using data
object substitution. (See Data Object Substitution.) If you are logged on to the SAS platform, you can click to display the list of all of the registered REST
web services.
|
HTTP Method
|
Specifies the HTTP
method for the web service. Specify GET, PUT, POST, or DELETE.
|
Content Type
|
Specifies the type of the body of the request. The content type is used for POST and
PUT requests only. The value can be specified using data object substitution. If no
content type is specified, the default value is “text/plain”.
|
Web Service Input
|
Specifies the Text data object used for input. The content of the data object can
use data object substitution.
The value of the Text data object should contain the body of the REST request message.
|
Web Service Output
|
Specifies the Text data object used for output. The value of the Text data object
contains the body of the REST
response message.
|
Error Values
|
|
Error Code
|
Specifies the data object (number type) for storage for the code value in the case
of an error.
You can click to display a list of the existing Number data objects.
|
Error Message
|
Specifies the Text data object for storage for the message value in the case of an
error.
You can click to display a list of the existing Text data objects.
|
Authentication
|
|
User Name
|
Specifies the user name. The value can be specified using data object substitution.
If you are logged on to the SAS platform, you can click to search for registered users.
If a value is specified,
then security-level headers are added to the request at the transport
level.
Note: The user name and password
properties are required only if the target service mandates access
control.
|
Password
|
Specifies the password. The value can be specified using data object substitution.
If this property is
specified, then it is used in the security-level headers on the web
service request.
Note: The user name and password
properties are required only if the target service mandates access
control.
|
Property Name
|
Description
|
---|---|
SAS Source Code
|
Specifies either a file
URI or a URL that is the name of the file that contains the SAS code
to execute.
The value can be specified using data object substitution. (See Data Object Substitution.)
|
Server
|
Specifies the name of
the Workspace Server to use to execute the SAS code.
The value can be specified using data object substitution.
|
Repository
|
Specifies the name of
the metadata repository in which the Workspace Server is defined.
The value can be specified using data object substitution.
|
Pass all root data objects?
|
Controls the scope of
root data objects when executing the SAS code.
If this property is checked, then each root-level data object is converted to a macro
variable. The macro variables are available for use within
the SAS code. Each macro variable is prepended to the SAS code before the code is
submitted to the server for processing. See “Macro Name Generation Rules” for more
information.
|
Mappings
|
|
Macro Variable Name
|
Enables you to add a
macro variable to the list of SAS Macro Variables. Enter the name
of the macro variable in the field, and click Add. Macro variable names are limited to 32 characters. Values can be specified using
data object substitution.
|
Data Object and Task
|
Lists the data objects, with their associated tasks, that have been defined for the
workflow. You can use the arrows ( and ) to reorder the data objects in this list. See “Mapping
Data Objects to SAS Macro Variables” for more information.
|
SAS Macro Variable
|
Lists the SAS macro variables that have been defined for this workflow. Click to delete a macro variable from the list. See “Mapping
Data Objects to SAS Macro Variables” for more information.
|
category
and
a value of sales
then the following
macro variable definition is submitted:%let _category=sales;
Workflow.SASCodeOperandPrefix
is
defined as wf_
, then the following
macro variable definition is submitted:%let wf_category=sales;
_quarterly_sales
becomes wf__quarterly_sales
.
Spaces in data object names are replaced by double underscores. Quarterly
Sales
becomes _quarterly__sales
.
The total length of the macro variable name, including the prefix,
cannot exceed 32 characters. Longer names are truncated to 32 characters.
Property Name
|
Description
|
---|---|
Web Service Location
|
Specifies the URL of the web service endpoint. The value can be specified using data
object substitution. (See Data Object Substitution.) If you are logged on to the SAS platform, you can click to display the list of all of the registered SOAP
web services.
|
Web Service Action
|
Specifies the SOAP action header value for the web service. The value can be specified
using data object substitution.
|
Web Service Input
|
Specifies the XML data object used for input. The value can be specified using data
object substitution.
The associated schema property should be set from the WSDL for the web service. The
value of the data object should contain the body of the SOAP request message.
|
Web Service Output
|
Specifies the XML data object used for output.
The associated schema property should be set from the WSDL for the web service. The
value of the data object should contain the body of the SOAP response message.
|
Error Values
|
|
Error Code
|
Specifies the data object (number type) for storage for the code value in the case
of an error.
You can click to display a list of the existing Number data objects.
|
Error Message
|
Specifies the data object (text type) for storage for the message value in the case
of an error.
You can click to display a list of the existing Text data objects.
|
Authentication
|
|
User Name
|
Specifies the user name. The value can be specified using data object substitution.
If you are logged on to the SAS platform, you can click to display the list of registered users.
If a value is specified,
then security-level headers are added to the request at both the transport
level and the message level.
Note: The user name and password
properties are required only if the target service mandates access
control.
|
Password
|
Specifies the password. The value can be specified using data object substitution.
If this property is
specified, then it is used in the security-level headers on the web
service request.
Note: The user name and password
properties are required only if the target service mandates access
control.
|
Property Name
|
Description
|
---|---|
Subject
|
Specifies the subject
of the notification.
|
Message
|
Specifies the body of
the notification.
|
Property Name
|
Description
|
---|---|
Task
|
Specifies the element path for the target workflow or task.
|
Status
|
Specifies the element path for the status that is removed from the target task.
|
Property Name
|
Description
|
---|---|
Task to Schedule
|
Specifies the element path for the scheduled task or subflow.
|
Schedule Timer Data
Object
|
Specifies the data object containing the expression that defines when the scheduled
task or subflow should start. The timer value can be an exact date (Date or String)
or a relative
expression (String). An exact date must be specified in the following form:
MM/dd/yyyy hh:mm:ss AM|PMFor example, 12/31/2010 11:59:00 PM .
You can use a relative expression to configure the task to start at a moment in time
relative to when the policy is triggered. Relative expressions are based on when the
parent element starts. You can use the
reserved keyword Now, or a plus sign, followed by one or more integers,
followed by a unit of measure, as shown in Timer Expressions in the Schedule Task Policy. You can also combine
sequences of plus signs, integers, and units of measure, or you can
specify a cron expression, as shown in Timer Expression Examples in the Schedule Task Policy.
|
End Timer Data Object
|
Specifies the data object containing the expression that defines when the schedule
timer should be stopped.
This property is optional.
|
Unit or Keyword
|
Description
|
Example
|
Explanation
|
---|---|---|---|
Now |
|
Now |
The timer fires immediately.
|
s |
Seconds
|
+45s |
The timer fires in 45
seconds.
|
m |
Minutes
|
+30m |
The timer fires in 30
minutes.
|
h or H |
Hours
|
+6h |
The timer fires in 6
hours.
|
d |
Days
|
+2d |
The timer fires in 2
days.
|
w |
Weeks
|
+1w |
The timer fires in 1
week.
|
Example
|
Explanation
|
---|---|
+2d+12h+30m |
The timer fires in 2
days, 12 hours, and 30 minutes.
|
0 0 12
* * ? |
The timer fires every
day at 12 p.m. (noon).
|
Property Name
|
Description
|
---|---|
To
|
Specifies a recipient’s
e-mail address.
|
From
|
Specifies the sender
e-mail address.
|
Subject
|
Specifies the subject of the e-mail message. The value can be specified using data
object substitution. For more information,
see Data Object Substitution.
|
Message
|
Specifies the body text of the e-mail message. The value can be specified using data
object substitution.
|
Property Name
|
Description
|
---|---|
Recipients(s)
|
Specifies the primary
recipients. Separate multiple recipients with commas.
|
CC Recipient(s)
|
Specifies the copied
recipients. Separate multiple recipients with commas.
|
BCC Recipient(s)
|
Specifies the blind-copied
recipients. Separate multiple recipients with commas.
|
Group Recipient(s)
|
Specifies the primary
group recipients. Separate multiple group recipients with commas.
|
Group CC Recipient(s)
|
Specifies the copied
group recipients. Separate multiple group recipients with commas.
|
Group BCC Recipient(s)
|
Specifies the blind-copied
group recipients. Separate multiple group recipients with commas.
|
Description
|
Specifies the description
or e-mail subject for the notification.
|
Template
|
Specifies the SAS notification
template to use. The default template is the SAS_Email_Message template.
|
Directive
|
Specifies the target
page to which you are directed upon notification. The value must be
a registered SAS directive name. If you are logged on to the SAS platform,
you can click to display the list of all of the registered directives.
|
Notification Variables
|
Specifies one or more element paths for data objects that represent name-value pairs
that are used as merge variables for the template. The data object name corresponds
to the notification variable name while the data object value is
used as the variable value.
Separate the element
path values with commas.
|
HTTP Parameters
|
Specifies one or more element paths for data object that represent name-value pairs
that are used as HTTP parameters. The data object
name corresponds to the HTTP parameter name while the data object value is used as
the parameter value.
Separate the element
path values with commas.
|
Expiry
|
|
Action on Expiry
|
Specifies the action to perform if the workflow is not completed by the date defined
by the Expiration Date Data Object property.
The available expiry options are as follows:
None
no expiration action
for this notification.
Note: The Expiration
Date Data Object property is not required for this option
because the notification does not expire.
Remove
removes the policy after the date is passed.
Reroute
sends the notification
to alternative recipients or group recipients as specified.
Resend
re-sends the notification
to the original recipients defined.
Workflow
starts a new workflow instance using the specified template.
|
Expiration Date Data
Object
|
Specifies the data object that defines the expiration date of the policy.
Note: This property is available
only when the Action on Expiry property is
set to a value other than
None .
|
Expiry Recipients(s)
|
Specifies one or more SAS Platform users to whom notifications are sent when the policy
reaches its expiration date.
Separate multiple recipients
with commas.
Note: This property is available
only when the Action on Expiry property is
set to
Reroute .
|
Expiry Group Recipients(s)
|
Specifies one or more SAS Platform groups to which notifications are sent when the
policy reaches its expiration date.
Separate multiple group
recipients with commas.
Note: This property is available
only when the Action on Expiry property is
set to
Reroute .
|
Workflow
|
Specifies the workflow template to start when the policy reaches its expiration date. If you are logged on to the
SAS platform, you can click
to display the list of activated templates.
Note: This property is available
only when the Action on Expiry property is
set to
Start Workflow .
|
Property Name
|
Description
|
---|---|
Recipients(s)
|
Specifies the primary
recipients. Separate multiple recipients with commas.
|
Group Recipient(s)
|
Specifies the primary
group recipients. Separate multiple group recipients with commas.
|
Description
|
Specifies the description
or e-mail subject for the notification.
|
Template
|
Specifies the target
notification template to use. The default template is the SAS_Email_Message
template.
|
Directive
|
Specifies the target
page to which you are directed upon notification. The value must be
a registered SAS directive name. If you are logged on to the SAS
platform, you can click to display the list of all of the registered directives.
|
Notification Variables
|
Specifies one or more element paths for data objects that represent name-value pairs
that are used as merge variables for the template. The data object name corresponds
to the notification variable name while the data object value is
used as the variable value.
Separate the element
path values with commas.
|
HTTP Parameters
|
Specifies one or more element paths for data objects that represent name-value pairs
that are used as HTTP parameters. The data object name corresponds to the HTTP parameter
name while the data object value is used as
the parameter value.
Separate the element
path values with commas.
|
Expiry
|
|
Action on Expiry
|
Specifies the option to perform if the workflow is not completed by the date specified
by the Expiration Date Data Object property.
The available expiry options are as follows:
None
no expiration action
for this notification.
Note: The Expiration
Date Data Object property is not required for this option
because the notification does not expire.
Remove
removes the policy after the date is passed.
Reroute
sends the notification
to alternative recipients or group recipients as specified.
Resend
re-sends the notification
to the original recipients defined.
Workflow
starts a new workflow instance using the specified template.
|
Expiration Date Data
Object
|
Specifies the data object that defines the expiration date of the policy.
Note: This property is available
only when the Action on Expiry property is
set to a value other than
None .
|
Expiry Recipients(s)
|
Specifies the users to whom notifications are sent when the policy reaches its expiration
date. Separate multiple recipients with commas.
Note: This property is available
only when the Action on Expiry property is
set to
Reroute .
|
Expiry Group Recipients(s)
|
Specifies the groups to which notifications are sent when the policy reaches its expiration
date. Separate multiple group recipients with commas.
Note: This property is available
only when the Action on Expiry property is
set to
Reroute .
|
Workflow
|
Specifies the workflow template to start when the policy reaches its expiration date.
If you are logged on to the SAS platform, you can click
to display the list of activated templates.
Note: This property is available
only when the Action on Expiry property is
set to
Start Workflow .
|
Property Name
|
Description
|
---|---|
Workflow
|
Specifies the element path for the target task or subflow.
|
Role
|
|
Names Data Object
|
Specifies the data object that defines the platform identity names of the participants.
|
Delimiter
|
Specifies the delimiter
to be used if multiple values are specified for the
Names
Data Object property.
|
Property Name
|
Description
|
---|---|
Task
|
Specifies the element path for the target task or subflow.
|
Property Name
|
Description
|
---|---|
Task
|
Specifies the element path for the target task or subflow.
|
Role
|
Specifies the workflow role for the participant.
|
Type
|
|
Name Data Object
|
Specifies the data object that defines the platform identity name of the participant.
|
Property Name
|
Description
|
---|---|
Task
|
Specifies the element path for the target task or subflow.
|
Property Name
|
Description
|
---|---|
New Workflow Label Data
Object
|
Specifies the element path to a data object that contains the name of the workflow
template to start.
|
New Workflow ID Data
Object
|
Specifies the element path to a data object that holds the instance ID of the created
workflow instance. This data object must exist in the current (parent) instance.
|
Current Workflow ID
Data Object
|
Specifies the element path to a data object that contains the instance ID of the parent
task executing this policy. This data object must exist in the newly created child
instance.
|
Property Name
|
Description
|
---|---|
Task
|
Specifies the element path for the target task or subflow.
|
Property Name
|
Description
|
---|---|
Workflow ID Data Object
|
Specifies the element path to a data object with the ID value of the target instance.
|
Property Name
|
Description
|
---|---|
Job Name
|
Specifies the name of
the JES job. You must be logged on to the SAS platform to select a
Job Name. Click to display the list of all of the registered JES
jobs.
|
Error Code
|
Specifies the data object (Short text type) for storage for the code value in the
case of an error.
If you are logged on
to the SAS platform, you can click to display a list of the existing Short text data
objects.
|
Error Message
|
Specifies the data object (text type) for storage for the message value in the case
of an error.
If you are logged on
to the SAS platform, you can click to display a list of the existing Text data objects.
|