Home

Other Products

Configuring the Related Document Workflow precondition

Mainsoft Document Collaboration for Rational Jazz supplies integration of document workflows and approvals within the work item resolution process. The Related Document Workflow precondition can be configured and added to the process definition. A typical scenario for using this feature is to have the development team’s work items linked to documents that participate in a workflow. In Microsoft SharePoint this implies configuring the document library to allow workflows; in Lotus Quickr it implies configuring document types to use an approval process.

To add and configure a Related Document Workflow precondition to your process, follow these steps:
  1. Add a Related Document Workflow precondition:
    1. In Rational Team Concert, open the project where you want to configure a precondition.
    2. Open the Process Configuration tab in the Project Area editor.
    3. Expand Team Configuration and select Operation Behavior.
    4. In the Operation Behavior table, select the Work Item > Save Work Item (server) operation.
    5. Select a corresponding role (typically, Everyone) and add an instance of the Related Document Workflow precondition, by clicking the Add… button.
  2. Configure the Related Document Workflow precondition:
    1. Select the work item types and the work item actions that will be impacted by the document workflow precondition:
      1. Select a Work Item type category, from the drop-down menu.
        Note: You can select only one work item type category for each precondition instance. If you want to impact more than one category, add another precondition instance for that category.
      2. Select the Work Item types that will be impacted by the precondition. The list of available work item types is set according to the selected work item type category.
      3. Select the Work Item actions and the Work Item resolutions that will be impacted by the precondition.
    2. Select the Document locations and the workflows that will be checked when the preconditions are met:
      1. Click the Add… button next to the Document locations and workflows table.
        Note: The Select Location on Document Site dialog box displays only configured Document Sites.

        The Select Location on Document Site dialog that allows you to select a document workflow to add as a precondition to your work item resolution process.

      2. Expand the relevant Document Site and select a document library.
      3. From the Selected workflow drop-down list, select a workflow that will be executed once the precondition is met.
        Note: Lotus Quickr only supports document approvals.
      4. Click OK.

        This dialog shows two workflow processes that will be checked when work items are marked as fixed.
        Tip: Workflows associated with the selected document library that have never been activated, will not show up in the drop-down list. They can be entered manually.
        When you add the first Document Location of each site, the credentials dialog opens, asking you to enter the credentials that will be used by the Jazz Team server to access the Document Site when verifying the precondition.
    3. Save the Project Area.
Click Edit Credentials… to manage the server credentials for the configured Document Sites. The Server Credentials dialog opens, allowing you to add, remove, or edit the credentials of each configured site. These credentials are used by the Jazz Team Server to verify the precondition on the Document Site server.

The Server Credentials dialog.

The server credentials must identify a user that has access to view documents waiting for approval. In Lotus Quickr, this implies a user with access to view locked files. In Microsoft SharePoint, the document library versioning setting lets you configure Draft Item Security to make drafts visible to readers, editors or approvers. The user identified by the server credentials has to belong to the appropriate group. More information about this SharePoint visibility setting is available here.
Note: When using Related Document Workflow preconditions, the Jazz Team Server connects to the document server to verify the workflow status of related documents when the user saves a work item. It is necessary to verify the licensing requirements for this server/server connection with your Document Site licensing agreements. More information about the communication between the Jazz Team Server and the document server is available in Understanding how Jazz uses Document Site credentials.

Related tasks
Using the Related Document Workflow precondition

Related information
Understanding how Jazz uses Document Site credentials
  • Overview
  • Accessibility features
  • Installing and upgrading Document Collaboration
  • Getting started with Document Collaboration
  • Working with the Documents folder in Team Artifacts
  • Working with the Documents view
  • Configuring the preferences
  • Configuring the Related Document Workflow precondition
  • Using the Related Document Workflow precondition
  • Understanding how Jazz uses document site credentials
  • Licensing and Trial Extension