com.ibm.rpm.workflow.containers
ExternalAction

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.workflow.containers.ExternalAction

ExternalAction
Extends: com.ibm.rpm.framework.RPMObject
Child objects: None

Related scope: com.ibm.rpm.workflow.scope.ExternalActionScope

ExternalAction object represents a reference to a custom action implemented outside RPM. It includes all the information required to call the external action from RPM.

These objects can be found in the Application Administration section of the client, in the External Actions tab.

Parent may be null or of the type ExternalActionCategory.

Supported API Calls: Primary key: The following fields are required when using the loadFromID and loadArrayFromID methods:

ID

Field Summary
xsd:boolean blocking
    Set to true if this external action might modify the object that the workflow will be started from (the "target" object). Otherwise, set to false.
xsd:string name
    The name of the external action.
xsd:string path
    The path to reach the external action. If the external action is implemented as a Web service, then this path is the URL to invoke this service. By default, the method invoked will be named "invoke". To invoke another method, you add a question mark ('?') followed by the name of the method. For instance, the following URL refers to "myMethod".
http://my-web-server.my-company.com/web-services/rpm-extensions?myMethod

Inherited Field Summary
xsd:string contextName
   The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.
xsd:boolean deleted
   If the value of this field is set to true, then the RPMObject will be deleted when performing a save.
xsd:string ID
   The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.
RPMObject parent
   The parent of the RPMObject.

Field Detail

blocking


xsd:boolean  blocking
Set to true if this external action might modify the object that the workflow will be started from (the "target" object). Otherwise, set to false.

name


xsd:string  name
The name of the external action.

Maximum: The maximum length for this field is 255 characters.


path


xsd:string  path
The path to reach the external action. If the external action is implemented as a Web service, then this path is the URL to invoke this service. By default, the method invoked will be named "invoke". To invoke another method, you add a question mark ('?') followed by the name of the method. For instance, the following URL refers to "myMethod".
http://my-web-server.my-company.com/web-services/rpm-extensions?myMethod

Maximum: The maximum length for this field is 1000 characters.


Inherited Field Detail

contextName


xsd:string  contextName
The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


deleted


xsd:boolean  deleted
If the value of this field is set to true, then the RPMObject will be deleted when performing a save.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


ID


xsd:string  ID
The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.

Read-only behavior: The value of this field is read only.


parent


RPMObject parent
The parent of the RPMObject.

Scoping: This field will be used by the API if the scope field parent is enabled.

Read-only behavior: The value of this field is read only after the object was created.

Relationship: This field is a reference relationship.

X-Path availability: This field doesn't support X-Path queries.