Configuration

This document provides a clear and concise guide for configuring and deploying the SigningHub bot for Microsoft Teams. Follow these steps to set up the integration and publish the bot to your organiza

Requirements

• Access to the Unity Portal

• Access to the Developer Portal for your organization

• The SigningHub application installed in your organization's Developer Portal

Configuration

The primary method for configuring the application is by sending a formatted message to the SigningHub bot.

1. Copy the Configuration Template: Copy the following JSON template. This template defines all the necessary settings for the integration.

   SignignHub.ConfigCustomer > {
     "shAuth": {
       "provider": "SIGNINGHUB-USER-PASSWORD",
       "userEmail": "__signingHubEmail__",
       "userPass": "__signingHubPassword__"
     },
     "customerSettings": {
       "teams": {
         "auth": {
           "provider": "MICROSOFT-AZURE-APP",
           "grantType": "client_credentials",
           "clientId": "__teamsBotId/handle__",
           "clientSecret": "__teamsBotClientSecret__",
           "scope": "https://api.botframework.com/.default"
         },
         "webResources": {
           "host": "https://__unity.portal.address__/chat-sh"
         },
         "signingHub": {
           "auth": {
             "clientId": "__signingHubIntegrationId__",
             "clientSecret": "__signingHubIntegrationSecret__",
             "provider": "SIGNINGHUB-APPLICATION"
           },
           "config": {
             "apiUrl": "__signingHubApiUrl__",
             "webUrl": "__signingHubWebUrl__"
           },
           "customerName": "__customerName__"
         }
       }
     }
   }
   

2. Update the fields: Replace the placeholder values (e.g., __signingHubEmail__) with your specific information.

   • __signingHubEmail__: Your SigningHub user's email address.

   • __signingHubPassword__: Your SigningHub user's password.

   • __teamsBotId/handle__: Your bot's ID or handle, which you copied during the previous step.

   • __teamsBotClientSecret__: The secret generated for your bot.

   • __unity.portal.address__: The address of your Unity Portal instance.

   • __signingHubIntegrationId__: Your integration ID or name.

   • __signingHubIntegrationSecret__: Your integration secret.

   • __signingHubApiUrl__: The URL for the SigningHub API.

   • __signingHubWebUrl__: The URL for the SigningHub web page.

   • __customerName__: A descriptive name for the customer this configuration applies to.

3. Send the Message: Using Teams, send the updated JSON message to the SigningHub bot directly in personal chat. The bot will automatically configure your application and reply with a success message.

If you don't receive a reply within 3 minutes, you can assume the configuration failed. Please review the Unity Portal logs to troubleshoot the issue. DO NOT proceed with the next step unless you have received a response from the bot, without this successful configuration step the system will not function correctly.

On the very first message, each user will be prompted to enter their SigningHub email and password. Once authenticated, the system will automatically log the user in for subsequent sessions.