Workplace Forms Extensions provides support for FileNet® P8 eForms Designer, an application integration feature that allows independent software vendors to integrate form templates with Workplace XT and Workplace. This add-on feature supplies classes and properties that enable users to work with form data, templates, and workflow policies.
Workplace Forms Extensions add property templates and custom subclasses:
The following property templates are added by Workplace Forms Extensions and implemented by various add-on features.
Property Template | Type | Implementations | Description |
---|---|---|---|
Form Datas | Object | Form Policy class | A multi-value property consisting of the Form Data instances created by a form policy. |
Form Description | String | Form Template class | Describes a form template. |
Form Policies | Object | ITX Form Template class | Represents the instances of Form Policy that are referenced by a form template. |
Form Policy | Object | Form Data and Form Proxy classes | Represents the Form Policy that was used to create form data, which can either be related to a document or a workflow. |
Form Policy Description | String | Form Policy class | Describes a form policy. |
Form Policy Launched Workflow Number | String | Form Data and Form Proxy classes | When a form data describes a workflow, a value for this property is returned when the workflow has been launched. The number is a unique value that identifies the workflow in which the form data is participating. |
Form Policy Step Descriptor | String | Form Data class | When the form data describes a workflow, this is a multi-value property consisting of the workflow sheet name, step name, and step identifier. |
Form Policy Workflow Id | String | Form Policy class | When the form policy is a workflow, this property provides an identifier for the workflow. |
Form Policy Workflow Object Store | String | Form Policy class | When the form policy is a workflow, this property identifies the object store that contains the workflow. |
Form Template | Object | Form Policy class | When the form policy is a workflow that has a mapped Launch processor, this property specifies the Form Template that was used to launch the workflow. |
Form Type | String | Form Policy class | Identifies the form policy type: document (Document) or workflow (Workflow). These options are specified in the administration console object store navigation pane in the | folder.
IFX Form Datas | Object | Form Template class | Represents the instances of IFX (XML) Form Data that are created by a form template. |
ITX Form Template | Object | Form Data class | Represents the ITX Form Template that was used to create the form data. |
The following subclasses are derived from the Document Class by Workplace Forms Extensions.
Subclass | Modifiable | Description |
---|---|---|
Form Data | Yes | Contains either document or workflow form data. The properties
defined in this class can be used by one or both of the policy types
to maintain the connectivity of data contained in the various form
objects, including identification of the related policy, template,
and launched workflow if applicable. Important: Unlike
the other classes and properties supplied by the Workplace Forms Extensions,
this class can be extended to support additional properties necessary
for mapping other software application form data values.
|
Form Policy | No | Contains data about either a document or workflow form policy. The properties defined in this class can be used by one or both of the policy types to manage the form policy data, type, and workflow if applicable. |
Form Template | No | Contains information about an ITX or IFX (XML) form template that describes either a document or workflow. The ITX Form Template subclass is derived from this class. |
The following properties are added to the Form Data subclass by Workplace Forms Extensions.
Property | Type | Modifiable | Description |
---|---|---|---|
Form Policy | Object | No | Represents the Form Policy that was used to create this form data, which can either be related to a document or a workflow. |
Form Policy Launched Workflow Number | String | No | When the form data describes a workflow, a value for this property is returned when the workflow has been launched. The number is a unique value that identifies the workflow in which the form data is participating. |
Form Policy Step Descriptor | String | No | When the form data describes a workflow, this is a multi-value property consisting of the workflow sheet name, step name, and step identifier. |
ITX Form Template | Object | No | Represents the ITX Form Template that was used to create this form data. |
The following properties are added to the Form Policy subclass by Workplace Forms Extensions.
Property | Type | Modifiable | Description |
---|---|---|---|
Form Datas | Object | No | A multi-value property consisting of the Form Data instances created by this form policy. |
Form Policy Description | String | No | Describes this form policy. |
Form Policy Workflow Id | String | No | When the form policy is a workflow, this property provides an identifier for the workflow. |
Form Policy Workflow Object Store | String | No | When the form policy is a workflow, this property identifies the object store that contains the workflow. |
Form Template | Object | No | When the form policy is a workflow that has a mapped Launch processor, this property specifies the Form Template that was used to launch the workflow. |
Form Type | String | No | Identifies the form policy type: document (Document) or workflow (Workflow). These options are specified in the administration console object store navigation pane in the | folder.
The following properties are added to the Form Template subclass by Workplace Forms Extensions.
Property | Type | Modifiable | Description |
---|---|---|---|
Form Description | String | No | Describes the form template. |
The following subclass is derived from the Form Template Class by Workplace Forms Extensions, which are a subclass of the Document Class.
Subclass | Modifiable | Description |
---|---|---|
ITX Form Template | No | Contains ITX form template data that describes either a document or workflow. The properties defined in this class can be used by one or both of the template types to manage the form template data and policies. |
The following properties are added to the ITX Form Template subclass by Workplace Forms Extensions.
Property | Type | Modifiable | Description |
---|---|---|---|
Form Policies | Object | No | Represents the instances of Form Policy that are referenced by this form template. |
IFX Form Datas | Object | No | Represents the instances of IFX (XML) Form Data that are created by this form template. |
The following subclasses are derived from the Custom Object by Workplace Forms Extensions.
Subclass | Modifiable | Description |
---|---|---|
Form Proxy | No | Maintains information that correlates the data contained in the instances of Form Data, Form Policy, and Form Template, including data about the launched workflow. |
The following properties are added to the Form Proxy subclass by Workplace Forms Extensions.
Property | Type | Modifiable | Description |
---|---|---|---|
Custom Object Type | String | Yes | (Hidden) Specifies the type of a custom object and is used
to determine which icon to display for the object in Workplace. The
specified string value should exist in the customobjecticon.properties file
(located at the root level of the tree) and the appropriate icon to
display for the object type should be located in the images/customobject directory.
For more information about this property, see the description of the Custom Object Type property template in the Workplace Base Extensions section. |
Form Policy | Object | No | Represents the Form Policy that has a mapped Launch processor that was used to launch the workflow. |
Form Policy Launched Workflow Number | String | No | When the form policy specifies a workflow, a value for this property is returned when the workflow has been launched. The workflow number can then be used to determine if the workflow is still running. |