Skip to main content
Mitratech Success Center

Client Support Center

Need help? Click a product group below to select your application and get access to knowledge articles, webinars, training content, and release notes or to contact our support team.

Authorized users - log in to create a ticket, view tickets status and check your success plan details.

 

TeamConnect/TAP Admin Guide

This guide details how to integrate the two software systems and allows you to create and integrate workflows from TeamConnect to TAP. The instructions provide details on how to configure the respective TeamConnect settings for the administrator and to End users.

TAP Admin User

The users of the TAP Admin group perform administrative actions such as creating and editing TAP Instance records and TAP Workflow Action records. End users who perform TAP-related actions are part of the TAP User group.

TAP Instance

A TAP Instance record holds the connection information required to make API requests. Multiple TAP Instance records may be created/edited, each containing the connection information for a different TAP instance.

Creating a TAP Instance

  1. Go to ALL >> TAP Settings. The system displays both TAP Instances and TAP Workflow Actions grids.

Creating a TAP instance (1).jpg

  1. The TAP Instances grid consists of the following:

  • TAP Instance – Displays the given TAP Instance name.
  • TAP URL – Displays TAP Instance API URL.
  • Created By - Displays the name of the Admin User who created the TAP Instance in the system.
  1. Click New under TAP Instances. The system displays TAP Instance >> New window.

  2. Under General Information, enter a name for the TAP Instance.

  3. Under TAP Instance Details, complete the following TAP Instance Details fields 

  • TAP Instance URL: Enter the TAP Instance API URL.
  • TAP Instance Time Zone: Select the hosted TAP Instance Time Zone from the drop-down list.
  • TAP Client ID: Enter the Client ID.
  • TAP User Name: Enter the username.
  • TAP Client Secret: Enter the TAP Client Secret.
  • TAP Password: Enter the password for TAP User.
The TAP Instance credentials (User Name, Password, Client ID and Client Secret) are provided by TAP Admin.

TAP Instance Credentials (2).jpg

  1. Click Save & Close.

  2. A new TAP Instance is created and displayed in the TAP Instances grid.

Editing a TAP Instance

  • Click the existing TAP Instance hyperlink and modify the required fields.
  • Click Save & Close. The system displays the updated TAP Instance details in the grid.

Validating the TAP Instance

  • Click the TAP Instance hyperlink.
  • Click Test Connection.

3.jpg

  • If a proper connection from TeamConnect to TAP is established using the provided credentials, the system displays a confirmation message. 
  • If the connection is not established, the system displays an error message.

TAP Workflow Action

A TAP Workflow Action record defines the template for a workflow operation.

TAP Implementation

The following configurations are required to use the Teamconnect/TAP integration in TAP:

Creating a Workflow with the TeamConnect Integration

Creating a workflow with the TeamConnect Integration on TAP Application.

Create a new TAP Workflow Action

  1. Go to ALL >> TAP Settings. The system displays both TAP Instances and TAP Workflow Actions grids.

new TAP Workflow (3).jpg

  1. Under the TAP Workflow Action grid, enter the following fields:

  • TAP Action Name – Displays entered action name, linked to the action view page
  • TAP Instance – Displays the TAP Instance name.
  • TAP Workflow – Displays the name of the selected TAP workflow template that are defined in TAP.
  • Object - Displays the TeamConnect Objects to which this workflow action applies.
  • Condition – Displays the name of the condition of the object only when it meets the condition. Displays the teamConnect objects records when the condition is true.
  • Workflow Action Type – Displays the Workflow Action Type (Initiate and Continue).
  1. Click New under TAP Workflow Action. The system displays TAP Workflow Action - New.

  2. Complete the following fields.

  • TAP Action Name: Enter a name for the TAP Action.
  • Unique Key: Enter alphanumeric value as the unique key.  Click What’s this? for more information on Unique Key.
  • TAP Instance: Select the TAP Instance record from the drop-down.  
  • TAP Workflow: Select the TAP workflow template from the drop-down that is associated with the selected TAP Instance.
  • Workflow Action Type: Select the Workflow Action Type (Initiate and Continue) from the drop-down.
  1. Initiate: The Initiate operation starts a workflow in TAP to gather and pre-populate data into the workflow form.

  2. Continue: Moves an existing workflow from its current step to the next step and sends the data to TAP for the workflow to continue.

  • Object: Select the TC Object name from the drop-down to which this workflow action is associated. This TAP Workflow Action uses a custom block or custom rule only on the selected object.  (Eg. If you select Matter in Workflow Action Details, in FormFields the Child Record field type displays Child Type records related to Matter.  Selecting TAP Settings, in FormFields the Child Record field type displays Child Type records related to TAP Settings.  See below image)

tap-wf1.png

  • Condition: Select the condition defined for the TC Object Definition from the drop-down.  Click here for How to configure Condition?
  • TAP Field for TAP Workflow Record: When a Workflow Action Type is ‘Initiate’ by TC, the ID of the newly created TAP Workflow record is sent to the TAP element.

Skip and 6.jpg

  1. Click Save & Close.

Editing a TAP Workflow Action

  • Click the TAP Action Name hyperlink and edit the required fields.
  • Click Save & Close.

Configuring/Mapping the list of Object Definitions to TAP Workflow

  1. Click the TAP Workflow action hyperlink. The system displays the TAP Workflow Details page.
  2. Select Form Fields from the left navigation pane. The system displays the Form Fields page.

Form FieldsEach TAP Workflow Form Field record represents the information that is to be collected from the TC user and passed to TAP. The values defined on the TAP Workflow are collected using a wizard.

Form fields (4).jpg

Form Fields grid consists of the following columns:

  • Field Type: Displays the selected Field Type from the drop-down of which the information is sent to TAP.  Fields Types are:

    • Assignee: To send the Assignee details to TAP, select the Assignee from the drop-down of current Assignees of the Custom Object on which the wizard is invoked. This is applied only to Custom Object records.
    • Child Record: To send the details of the Child Record of the Custom Object to TAP, select the Child Record from the drop-down and select the associated Child Type record for the Custom Object on which the wizard is invoked.  Displays the list of Child Records that are selected under Object field in Workflow Action. (Eg.: If the user selects Matter as Object in Workflow Action, Child Type drop-down displays related to Matter. If the user selects Tap Settings as Object in Workflow Action, Child Type drop-down displays related to Tap Settings).
    • Document: Displays the list of documents attached to the record on which the wizard is invoked. This field is used to send the document record to TAP.
    • Involved: Displays the Involved Field Type for a selected Workflow Action record with the object navigator path. The object navigator is disabled if the TAP Workflow Action's Object field is not a custom object with an Involved object definition.
    • Prompt: Displays Prompt Field Type text/instructions where users add more information to the selected workflow action in the label.
    • Static: The user can enter the text/instructions of the workflow in the text field with Order number.  The given instructions are displayed on the wizard form as read only text on the wizard.
  • Field Path: Displays the Object navigator path which evaluates the path against the Involved/Assignee/Child and Embedded records value selected in the wizard.

  • Child Type: Displays the child object type for the selected Child Record.

  • TAP Field: Displays the name of the TAP Workflow template field (elements configured on TAP shown below) that sets for using the collected value.

  • Label: Displays the label of the TAP Workflow Action record referred to workflowJobElementName. This field is required when the Workflow Action Type is Initiate.   Displays the given input text in the field of the TAP Workflow Action to the user in the wizard.  This field is required when the Workflow Action Type is Initiate.

  • Order: Displays the order of the input field in the wizard.  The TAP Workflow Form Field records associated with the TAP Workflow Action record specify the type of data that is to be collected and the display order of the collection form.

  • Action: Enables the user to delete the record.

To add a Form Field record to the selected Workflow Action.

  • Select Field Type from the drop-down list (Assignee/Child Record/Document/Involved/Prompt/Static Text).
  • Enter the details in the fields that are mapped to the Field Type.
  • Click Add.
  • New Form fields mapped to Workflow appear in the grid.

Mapping Data Fields: By mapping the fields, the user sends the information from TeamConnect to TAP.

  • Click the TAP Action Name hyperlink.
  • Select Mapping Data Fields from the left pane.

TAP WorkFlow Action Test.jpg

Mapping Data Fields grid consists of the following columns:

10.jpg

  1. Action: Enables the user to delete the record.

To add a Mapping Data Field record to the selected Workflow Action

  1. Enter the TAP Field name.
  2. Select the Mapping Type (Current Date Field Mapping/Object Field Mapping) from the drop-down. 
  3. On Selecting the Object Field Mapping, TeamConnect Field appears. 
  4. Select the field from the pop-up window.

11.jpg

  1. Enter the current format in the TAP Date Format field.
  2. Click Add.
  3. New mapping fields TAP Field and TeamConnect Field mapped to Workflow, appear in the grid.

TAP Workflow Action Custom Block

This block can be added to any object definition. The block displays a button which when clicked, initiates a workflow in TAP. It also displays a list of open workflow jobs for the associated workflow action for the current record.

If there is a Condition to Initiate the Workflow Action and the Condition is not met, then the system hides the button to Initiate a workflow. If the Initiate button is hidden and there are no open workflow jobs, then the system hides the entire block.

To use/creating a block to Workflow Action

  • Go to Documents >> Top Level >> System >> Screens.

12.jpg

  • Download the xml file by clicking on the existing “TAPWorkflowActionCustomBlock.xml” file (3).
  • Edit the xml file and replace the occurrence of the placeholder text tapWorkflowActionUniqueKey with the unique key of a TAP Workflow Action (TAC$) record.

documents1.jpg

  • Upload the new xml file to the Screens folder.

  • Now select the uploaded file from the drop-down list and enter a name in Friendly Name field.

  • Click Save.
  • Go to Matter >> Object Views.
  • Enter new Tab Name (1) and click Add.
  • Add the block to the new TAB by selecting from the drop-down list (2).
  • Click add.

2021-05-19_16-40-49.jpg

  • Now click on the newly created workflow button to create a wizard.

To view the open workflow jobs for the current record

  • Copy RecordWorkflowJob.xml and RecordWorkflowJob.class (4) (Do not rename the files).
  • Upload the files to the Screens folder of the object definition where the block is to be displayed
  • Create a TC Block for the xml screen and add the Block to an Object View.
  • The new custom block appears in the left panel and TAPWorkflowActionWizard button inside the grid.

TAP Workflow Execution rule

The condition is added to any object definition and associated with a TAP Workflow Action (TAC$) record via a rule parameter. The TAP Workflow Action is of Initiate or Continue type.

When triggered, the condition executes if there is NO Condition on the Workflow Action or the Condition is met.

The condition evaluates the current record of the TAP Workflow Action records with Mapping Data Fields. The Workflow Action record initiates the workflow by evaluating values that are sent to TAP.

  • If the condition references a Workflow Action of type Initiate, the system initiates a new workflow in TAP.

  • If the condition references a Workflow Action of type Continue, the rule finds the most recently created open Workflow Job (TWO$) and Continue when the token id of the workflow job is available.

Condition Configuration

  • Navigate to Setup.
  • Click Go to drop-down >> Object Definitions >> Matter >> Conditions.
  • Click Create New Condition button or click on the existing Condition (Always True).
  • Add the logical conditions to display the continue button or to hide the button.
  • Example:
    • For Initiate, create the Expression and select Condition All of the above expressions are met (AND Logic), as shown below, then the Continue button is not displayed.

condition.png

  • For Continue, create the Expression and select Condition Any of the above expressions are met (OR Logic), as shown below, then the Continue button is displayed.

condition1.png

NOTE: Based on the configuration, User can view the Continue button on the TeamConnect User Interface to complete the TAP Workflow Action

  • Was this article helpful?