The Workplace Forms Extensions provide support for FileNet P8 eForms Designer, an application integration feature which allows third-parties to integrate form templates with Workplace XT and Workplace. This feature AddOn supplies classes and properties which enable users to work with form data, templates, and workflow policies.
The Workplace Forms Extensions provides property templates and implements custom classes, objects, and properties in the following areas throughout Enterprise Manager:
CAUTION The Workplace Forms Extensions provide classes and properties which support out-of-the-box behavior for FileNet eForms. The values for properties on object instances created by FileNet out-of-the-box applications should not be modified, as changing these values could cause application behavior issues with FileNet out-of-the-box applications and AddOn applications. In addition, most of the classes should not be extended or subclassed by third-parties, except for the Form Data class. The descriptions included in this section are provided for informational purposes only.
The following property templates are added by Workplace Forms Extensions and implemented by various feature AddOns. These templates are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Property Templates.
Property Template | Type | Implementation(s) | Description |
---|---|---|---|
Form Datas | Object | Form Policy class | A multi-value property consisting of the Form Data instance(s) 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 which contains the workflow. |
Form Template | Object | Form Policy class | When the form policy is a workflow which 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 Enterprise Manager under Domain Root > Object Stores > Object Store Name > Choice Lists > Form Types. |
IFX Form Datas | Object | Form Template class | Represents the instances of IFX (XML) Form Data which 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. These subclasses and their respective properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Document Class > Custom Subclass Name.
Subclass |
Modifiable |
Description |
---|---|---|
Form Data | Yes | Contains either document or workflow form data. The properties defined in this class may 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. NOTE Unlike the other classes and properties supplied by the Workplace Forms Extensions, this class may be subclassed to support additional properties necessary for mapping third-party form data values. |
Form Policy | No | Contains data about either a document or workflow form policy. The properties defined in this class may 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 which 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. These properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Document Class > Form Data, right-click Properties > Property Definitions.
NOTE When an object store item is of type Form Data,
the MimeType
property will be set to: "application/x-filenet-formdata"
.
The Workplace Application Integration getContent servlet and associated redirect properties file use the mime type information
to build the correct URLs in the list views.
The following properties are added to the Form Policy subclass by Workplace Forms Extensions. These properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Document Class > Form Policy, right-click Properties > Property Definitions.
NOTE When an object store item is of type Form Policy,
the MimeType
property will be set to: "application/x-filenet-documentpolicy"
.
The Workplace Application Integration getContent servlet and associated redirect properties file use the mime type information
to build the correct URLs in the list views.
The following properties are added to the Form Template subclass by Workplace Forms Extensions. These properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Document Class > Form Template, right-click Properties > Property Definitions.
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. This class is visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Document Class > Form Template > Custom Subclass Name.
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 may 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. These properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Document Class > Form Template > ITX Form Template, right-click Properties > Property Definitions.
NOTE When an object store item is of type Form Template,
the MimeType
property will be set to: "application/x-filenet-itxformtemplate"
.
The Workplace Application Integration getContent servlet and associated redirect properties file use the mime type information
to build the correct URLs in the list views.
The following subclasses are derived from the Custom Object by Workplace Forms Extensions. These subclasses and their respective properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Other Classes > Custom Object > Custom Subclass Name.
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. These properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Other Classes > Custom Object > Form Proxy, right-click Properties.
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 Web 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 which 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. |