This topic describes how to design and launch FileNet P8 workflows that integrate collaborative work environments and tasks.
The FileNet Team Collaboration Manager product installs an inheritable workflow definition file (CollaborationIntegration.pep) that provides the base elements required to integrate core collaboration functionality into workflows, making component integrator steps available for collaboration. A collaboration queue (Collaboration_Wait) is configured on the Process Engine, permitting the workflow engine to await completion of TCM tasks that are designated "workflow-aware." For important information on installation and configuration of these and other elements that comprise workflow support in TCM, see the task, "Configure Workflow for TCM use" in the TCM Installation Guide.
Developers must use the provided base workflow definition file (CollaborationIntegration.pep) from within the FileNet P8 Process Designer to create teamspaces (new or from templates) or create tasks within existing workflows. The base workflow definition's submaps combine component integrator steps and other workflow logic necessary to integrate the specified collaboration functionality. Any workflows designed to include collaboration functionality must inherit the Collaboration Integration workflow as the base workflow, or include its submap and required workflow data.
Note: In the procedure described below in "Using the Process Designer to Create Teamspaces and Tasks," main workflow data (fields, attachments, and workflow groups specified in the Workflow Properties dialog box) interact with the Submap Steps in the current workflow by pushing and pulling data to and from those steps. This allows the workflow designer to specify different workflow data entries specific to collaboration functionality, preventing conflicts with data that may be provided in later submap calls. For instance, an array of attachments used by one workflow-aware task may be different from that used by another workflow-aware task, and applied differently in other steps specified later in the workflow that may relate to a different business process.
A separate sample workflow definition file, CreateTeamspaceWithTaskSample.pep, is provided to help illustrate many of the concepts and relationships described in this topic.
To use the Process Designer to create teamspaces and tasks:
The following tables describe properties available from the base workflow (CollaborationIntegration.pep) for each step type.
Property | Description |
TCMTeamspaceParentFolder | Attachment. Can be specified either by the workflow designer or by the user. If creating a workflow from the procedure described earlier in this topic, use the attachment button in the Launch Processor LaunchStep view to browse for a teamspace location after launching the workflow. |
TCMTeamspaceFolderClass | String. Required. Default value: "CollaborationTeamspace". Custom applications may designate a new class. |
TCMTeamspaceName | String. Required. Identifies the new teamspace. |
TCMTeamspaceOwner | Required identification of the teamspace member creating the teamspace. If specified in a Submap Step, use a workflow group containing one participant. If specified in a Component Step, use a VWParticipant (a single element of a workflow group, such as wfgroup[1], keeping in mind that workflow group arrays begin with element 1, not 0). |
TCMOwnerRole | String. Required. Value: A role (for example, "admin-security-role") with teamspace administrative privileges. Since the member specified in TCMOwnerRole is the only member of the teamspace when it is created, the role specified here should have sufficient capability to control the teamspace. |
TCMOwnerEmailAddress | String. Optional. Email address of the teamspace creator. Must be available to P8 applications. |
TCMTeamspacePropertyNames | An array of property names. Optional. Normally used for properties defined in a custom teamspace class. |
TCMTeamspacePropertyTypes | An array of types matching the property names array. Optional. Values are defined in the Content Engine Property interface. Note: Use only integer values (0-8) here. |
TCMTeamspacePropertyValues | An array of values to match the property names array. Optional. Normally used for properties defined in a custom teamspace class. |
TCMAppId | String. Required. Specified by the workflow designer, based on the collaboration application that will be used to handle the collaboration objects created by this workflow. Default installation value is "TCM". May differ in a custom collaboration application, but must correspond to a value in the Collaboration Store's application configuration file. |
TCMTeamspaceRef | Not specified by task creator. Automatically generated when the workflow is launched and the teamspace is created. |
Property | Description |
TCMTeamspaceRef | Attachment. Required. If creating a workflow from the procedure described earlier in this topic and you are not creating a teamspace in the same workflow, use the attachment button in the Launch Processor LaunchStep view to browse for a teamspace location after launching the workflow. If you are creating a teamspace in the same workflow, the reference value is automatically generated when the workflow is successfully launched. |
TCMTaskName | String. Required. Provides a label for the task. |
TCMTaskAssigner | Required identification of the teamspace member assigning the task. If specified in a Submap Step, use a workflow group containing one participant. If specified in a Component Step, use a VWParticipant (a single element of a workflow group, such as wfgroup[1], keeping in mind that workflow group arrays begin with element 1, not 0). |
TCMTaskAssignee | Optional identification of the the teamspace member to whom the task is assigned. If specified in a Submap Step, use a workflow group containing one participant. If specified in a Component Step, use a VWParticipant (a single element of a workflow group, such as wfgroup[1], keeping in mind that workflow group arrays begin with element 1, not 0). |
TCMWorkflowAwareFlag | Boolean. Optional. If true (the default), the workflow will not complete until the task has been marked as completed by the assigner or assignee. |
TCMTaskDueDate | Optional. The date and time on which the task is to be completed. Recommendation for main workflow fields: Set to the default null(date). |
TCMTaskReminderDate | Optional. The date and time on which members assigned the task are to receive reminder emails. Recommendation for main workflow fields: Set to the default null(date). |
TCMTaskPriority | Integer. 1 = High priority, 2 (default) = Normal priority, 3 = Low priority. |
TCMTaskDescription | String. Optional. Describes the task. |
TCMWaitQueueName | Not specified by task creator. Automatically-generated property specifies the Collaboration Queue (Collaboration_Wait) installed on the Process Engine. |
TCMTaskStepWobNum | Not specified by task creator. Automatically generated when the workflow is successfully launched (obtained by the submap to handle possible workflow branching). |
TCMTaskAttachments | Array of attachment(s). May include documents, folders, UNC\URLs, etc. |
TCMTaskAttachmentsFieldName | Not specified by task creator. Automatically generated from the base workflow. |
TCMAppId | String. Required. Specified by the workflow designer, based on the collaboration application that will be used to handle the collaboration objects created by this workflow. Default installation value is "TCM". May differ in a custom collaboration application, but must correspond to a value in the Collaboration Store's application configuration file. |
TCMTaskRef | Not specified by task creator. Automatically generated when the workflow is successfully launched. |
Property | Description |
TCMTeamspaceTemplate | Attachment. Required. After launching a workflow, use the attachment button in the Launch Processor LaunchStep view to browse for a teamspace template. |
TCMTeamspaceParentFolder | Attachment. Can be specified either by the workflow designer or by the user. If creating a workflow from the procedure described earlier in this topic, use the attachment button in the Launch Processor LaunchStep view to browse for a teamspace location after launching the workflow. |
TCMTeamspaceName | String. Required. Identifies the new teamspace. |
TCMTeamspaceOwner | Required identification of the teamspace member creating the teamspace. If specified in a Submap Step, use a workflow group containing one participant. If specified in a Component Step, use a VWParticipant (a single element of a workflow group, such as wfgroup[1], keeping in mind that workflow group arrays begin with element 1, not 0). |
TCMOwnerRole | String. Required. Value: A role (for example, "admin-security-role") with teamspace administrative privileges. Since the member specified in TCMOwnerRole is the only member of the teamspace when it is created, the role specified here should have sufficient capability to control the teamspace. |
TCMOwnerEmailAddress | String. Email address of the teamspace creator. |
TCMAppId | String. Required. Specified by the workflow designer, based on the collaboration application that will be used to handle the collaboration objects created by this workflow. Default installation value is "TCM". May differ in a custom collaboration application, but must correspond to a value in the Collaboration Store's application configuration file. |
TCMTeamspaceRef | Not specified by task creator. Automatically generated when the workflow is launched and the teamspace is created. |
TCMTeamspaceFolderClass | String. Required. Default value: "CollaborationTeamspace". Custom applications may designate a new class. |
TCMTeamspaceName | String. Required. Identifies the new teamspace. |
TCMTeamspaceOwner | Required identification of the teamspace member creating the teamspace. If specified in a Submap Step, use a workflow group containing one participant. If specified in a Component Step, use a VWParticipant (a single element of a workflow group, such as wfgroup[1], keeping in mind that workflow group arrays begin with element 1, not 0). |
The FileNet Team Collaboration Manager CD includes a sample workflow definition file, CreateTeamspaceWithTaskSample.pep, that offers a prepared and extended version of the workflow design described above in the procedure, "Using the Process Designer to Create Teamspaces and Tasks." To examine the sample, copy CreateTeamspaceWithTaskSample.pep from <CD>\CollaborationToolkit\Workflow to the \Workflow folder on the Application Engine server on which the base workflow definition file (CollaborationIntegration.pep) was installed, then open CreateTeamspaceWithTaskSample.pep from the Process Designer.
Note: The sample workflow definition file does not gather values from workflow data entries for presentation to the end user. The workflow designer may, however, extend the sample to test this capability in accordance with specific customer needs.
To create your own workflow, use the base workflow definition file (CollaborationIntegration.pep) and follow the guidelines above in "Using the Process Designer to Create Teamspaces and Tasks."
API reference: CollaborationOperations.
For information on how workflows are used within the FileNet P8 TCM application, see the TCM Help topic, Workflows.