--- title: Installing and Configuring Collaboration Extension slug: solutions/installing-and-configuring-collaboration-extension docTags: createdAt: 2025-08-11T11:13:45.685Z --- :::hint{type="danger"}  The Collaboration Extension integrates and works well with SOC Solutions Bundle and the Case and Incident Management (CIM) application. This user guide uses the SOC Solutions Bundle and CIM application in examples to instruct how to utilize the Collaboration Solution. ::: :::hint{type="warning"} To best understand the documentation and examples, you can install and configure the SOC Solutions Bundle and the CIM application. For assistance in SOC Solutions Bundle and setup, contact your Swimlane professional services point of contact. ::: The Collaboration Extension is a collection of bundled components to create context-aware messages from predefined templates to send to external messaging systems, such as email, Slack, and/or Microsoft Teams for processing by Swimlane, or non-Swimlane, users. For an additional information, navigate to [Collaboration Extension](docId\:iDZP2eWS0GGvlZEN4EzSV). Start by installing the extension. # Go to Marketplace Navigate to the Turbine Marketplace. Follow these steps: 1. Log in to **Turbine**. 2. In the navigation pane, click **TENANTS**. 3. Select the desired tenant. 4. In the navigation pane, click **LIBRARY**. 5. In the LIBRARY navigation pane, click **Swimlane Content**. ## Install Now, you can install the Collaboration Extension: 1. From the Swimlane Content Library, under **Solutions**, click **Collaboration Extension**. 2. Click **Install** on the right-bottom of the solution. The Collaboration Extension details open. - The **Overview** tab shows each individual solution that composes the Collaboration Extension and their capabilities. - The **Content** tab shows how many and which workspaces, applications, dashboards, and/or reports are included in the Collaboration Extension. - The **Documentation** tab has a link to the Collaboration Extension topic in this user guide. 1. On the right-hand side of the window, click **+Install** again. 2. From the Install Collaboration Extension window, choose which content you’d like to install. :::hint{type="info"}  All content is pre-selected as a default. Click check marks to deselect any content. ::: :::hint{type="warning"} You may see the following warning, if content already exists in your environment. ![](https://api.archbee.com/api/optimize/n8uUzk0MM4uC57-zlHNtY/v4yll_6WBXIBCWY5X8iSY_soc-solution-warning.png) You can avoid overwriting content by deselecting the items you do not wish to overwrite, and it will still work. But if you deselect too many items that are not being overwritten, you will not import the full solution. ::: If prompted to overwrite existing content, click and hold the mouse icon until the circle is complete and the dialog box disappears. ::Image[]{src="https://api.archbee.com/api/optimize/511c8QBH-VHiwWnyzIwUb/gCmpOi2ox6YQOFF1Hsu6m_overwrite-components.png" size="54" width="340" height="223" darkWidth="800" darkHeight="525" position="center" showCaption="false"} You will see **Importing**… If there are no issues, the Import Success window opens. You can import successfully and still have potential issues. If that's the case, the **Review Potential Issues** window opens. Review the potential issues by: Clicking **Import More** to import more SSPs; -OR- Clicking **Go to Application** to address issues, if the issues are in your application. If the issues are with assets or playbooks, navigate to their respective locations in Turbine to edit; -OR- Clicking **Close** to close the window. If there are issues, you see the Import Error window. You must address the errors to import successfully. :::hint{type="danger"}  You *cannot* continue installation without resolving the errors. You **must** start over and re-install from the Collaboration Solution from the Integrated Marketplace, or import as an .ssp file. ::: ## Configure Custom Assets Configuring the Collaboration Solution is a one-time task. You need to configure two assets. The first is a mostly pre-defined Collaboration Extension Configuration asset where you can figure certain inputs. The second is the email provider asset that you choose. ### Configure Collaboration Extension Configuration Asset To configure custom assets, follow these steps: 1. In the navigation pane, click **ORCHESTRATION** and click **Assets**. 2. Search for and click **Collaboration Extension Configuration**. 3. Fill the following fields based on descriptions | Asset Input | Field Information | | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Email\_Medium | Options: **Gmail**, **O365**, or **SMTP**
Enter one of the email options. The field is not case sensitive. | | Post\_Interaction\_Webhook\_URL | Grab the webhook URL from the **Post Interaction** trigger in the Collaboration Extension playbook and paste it here. | | Slack\_Webhook\_URL | This field defaults as empty. Only configure if you want to use Slack. | | Success\_Response | Default text: "Thank you for your response!" | | Reject\_Response | Default text: "A previous response has been recorded for this message. Your response has not been applied. Please contact your administrator if you feel this is in error." | ### Configure Email Provider Based on the chosen **Email\_Medium** in the previous step, the appropriate email provider configuration asset must be set. Use the table below to determine which asset should be configured. | Email\_Medium | Email Provider Configuration Asset Name | | ------------- | -------------------------------------------- | | Gmail |  Collaboration - Google Settings | | O365 |  Collaboration - Microsoft Exchange Settings | | SMTP |  Collaboration - SMTP Settings | Each of the assets above must be provided with their own unique configuration parameters to facilitate communication with the email provider. ## Configure Applet The example in this guide uses the Case and Incident Management (CIM) application that was installed during the **SOC Solutions Bundle** configuration process. However, you can use the following steps within your desired application. To configure for the Collaboration applet, follow these steps: 1. In the navigation pane, click **APPLICATIONS & APPLETS**. 2. Click **Case and Incident Management**. The CIM application opens. 3. Drag the **Collaboration Extension Applet** into the application at a desired location. A confirmation dialog opens: **Add Collaboration Extension Applet Here?** 4. Click **Add**. 5. Under SELECT TEMPLATE SECTION, create a new playbook button and enter the title: **Load Template**. 6. Map the playbook button to the **Collaboration Extension **playbook. 7. From the **Select a flow** drop-down menu, you can select an existing flow or create a new one using **Create new**. 8. Under **COLLABORATION TEMPLATE SELECTED**, create a new playbook button and enter the title: **Send Message** 9. Map the playbook button to the **Collaboration Extension** playbook. 10. From the **Select a flow** drop-down menu, you can select an existing flow or create a new one using **Create new**. 11. Click **Save** to save the application. 12. To finish configuring the applet, let's enable some of the application workflow actions. 13. From the application toolbar, click the **WORKFLOW** icon. ::Image[]{src="https://api.archbee.com/api/optimize/511c8QBH-VHiwWnyzIwUb/s3VmVm4BMpS8zzvHh78L0_collab-app-workflow-icon.png" size="60" width="148" height="116" darkWidth="800" darkHeight="626" position="center" showCaption="false"} The application workflow opens. 1. Click the **Collaboration Hide Default Sections** action and from the ACTION panel, toggle the status to **Enable**. 2. Click the **Collaboration Set Application Name** action and replace the value with the name of the application in which the applet was installed and from the ACTION panel, toggle the status to **Enable**. 3. Click the **If Collaboration Selected Template Not Blank** action and from the ACTION panel, toggle the status to **Enable**. 4. Click **Save**. ## Configure Playbook Triggers Now it is time to configure your newly created playbook trigger from the previous step. 1. Navigate to the **Orchestration** section and select **Playbooks**. 2. Search for and click the playbook titled **Collaboration Extension**. 3. Find the new trigger for your newly created playbook button titled **Load Template**. 4. Under the **Add** section, click **Components** and find the component named **Write - Load Template**. 5. Drag and drop the **Write - Load Template** component under the **Load Template** playbook trigger. 6. With the component clicked, under the **Data** section on the right, click **Configure**. 7. This is where you’ll map application record data to the component interface inputs. Map data according to this chart. | Component Input | Choose This Field to Map Your Inputs To | | --------------------------- | -------------------------------------------------------------- | | **Applet Application Name** | `Application.Name` | | **Applet Tracking ID** | Current record `values.Values.Tracking` Id | | **Selected Template** | Current record `values.Values.Collaboration` Selected Template | | **Application Record** | Current record `values.Values` | 1. Find the new trigger for your newly created playbook button titled **Send Message**. 2. Drag and drop the **Write - Create Record in Message Sender**component under the **Send Message** playbook trigger. 3. With the component clicked, under the **Data** section on the right, click **Configure**. 4. With the component clicked, under the Data section on the right, click Configure. | Component Input | Choose This Field to Map Your Inputs To | | ------------------------------- | ------------------------------------------ | | **Invoking Record Tracking ID** | Current record `values.Values.Tracking` Id | | **Applet Application Name** | `Application.Name` | 1. Click **Save** to save to Playbook. ## Configure Automated Loading and Sending You can configure templates to automatically load and send without any practitioner interaction. To do this, create a new application workflow condition and two actions and configure them to the scenario you desire to initiate the automation. For this example, let's use the scenario **If Signal Source equals Alert**. 1. From the Collaboration Solution Applet's workflow, click on the root of the workflow that has the name of the "host" application. For example, **Case and Incident Management** and click **Create a new condition**. ::Image[]{src="https://api.archbee.com/api/optimize/511c8QBH-VHiwWnyzIwUb/cPmPBtOV4fA7Of4R_B0oU_collab-solution-create-new-condition.png" size="20" width="223" height="127" darkWidth="800" darkHeight="455" position="center" showCaption="false"} The best practice is to name the condition after the scenario. Since we are using the **If Signal Source equals Alert** scenario, follow the steps to configure the condition: 1. In the Name field, enter **Automate Collaboration Extension- Alert**. 2. In the Field Type drop-down menu, select **Signal Source**. 3. In the Operator drop-down menu, select **Equals**. 4. In the Value drop-down menu, select **Alert**. The condition is enabled by default. ::Image[]{src="https://api.archbee.com/api/optimize/511c8QBH-VHiwWnyzIwUb/HBGxCDiBPdqpFfZ9BO4Gm_collab-solution-new-condition-workflow.png" size="48" width="534" height="509" darkWidth="800" darkHeight="762" position="center" showCaption="false"} 1. Click the **Automate Collaboration Extension- Incoming Alert** condition to show the condition icons and click the **create a new action** icon. ::Image[]{src="https://api.archbee.com/api/optimize/511c8QBH-VHiwWnyzIwUb/1cTCGgOjVbWSBvRl9WPZ6_collab-solution-create-new-action.png" size="38" width="299" height="103" darkWidth="800" darkHeight="275" position="center" showCaption="false"} The ACTION panel opens. Configure the new action. 1. In the Name field, enter **Set Collaboration Selected Template**. 2. In the Action Type drop-down menu, select **Set Field Value**. 3. From the Field drop-down menu, select **Collaboration Selected Template**. 4. In the Value field, enter the name of the template title that you want to load and automate sending. This will come from your **Collaboration Template Manager** application. This example has **Incoming High Priority Alert**as a template name. ::Image[]{src="https://api.archbee.com/api/optimize/511c8QBH-VHiwWnyzIwUb/c-KnpY4Lv-bHFIVxcMdt2_collab-solution-new-action-template-title.png" size="36" width="466" height="502" darkWidth="800" darkHeight="861" position="center" showCaption="false"} 1. Repeat step 6 to create another new action from the **Automate Collaboration Extension - Incoming Alert** condition. 2. In the Name field, enter **Set Automated Collab to TRUE**. 3. In the Action Type drop-down menu, select **Set Field Value**. 4. In the Field drop-down menu, select **Collaboration Automate Template Selection**. 5. In the Value drop-down menu, select **TRUE**. ::Image[]{src="https://api.archbee.com/api/optimize/511c8QBH-VHiwWnyzIwUb/6K9U5zN83BnRz34HFvkXI_collab-solution-new-action-true-value.png" size="32" width="467" height="467" darkWidth="800" darkHeight="800" position="center" showCaption="false"} 1. Click **Save**. Multiple conditions can be created to automate the loading and sending of different templates based on your desired use case. ## Set the Application Trigger For the application to initiate, you need to set up the application trigger. To set up the trigger, follow these steps: 1. From the navigation pane, click **ORCHESTRATION** and click **Playbooks**. 2. Search for and open the **Collaboration Extension** playbook. 3. Click **Add a trigger** and select **Record Event**. 4. From the **TRIGGER** panel, drag a drop a new **Record Event** trigger onto the playbook canvas. 5. Click on the new trigger and from the **Application** drop-down menu, select the application name in which the **Collaboration Extension Applet** was installed. 6. Select if the trigger should run on Record Create, Record Update, or both. :::hint{type="info"} If you select Record Update, this may result in duplicate messages being sent if there are many record actions taking place in a short period of time. Only use this option if record updates are infrequent at the point where an automated message should be sent using Collaboration Extension. ::: 1. Navigate to the Components tab and search for the component named **Execute- Automate Collaboration Message Send**. Drag and drop the component under the created **Record Event** trigger. 2. With the component clicked, under the **Data** section on the right, click **Configure**. 3. This is where you’ll map application record data to the component interface inputs. Map data according to this chart. | Component Input | Choose This Field to Map Your Inputs To | | ----------------------- | ------------------------------------------ | | Applet Application Name | `Application.Name` | | Applet Tracking ID | Current record `values.Values.Tracking` Id | 1. Click **Apply**. 2. Click **Save** to save the playbook.