Documentation
DocumentationDeveloperAcademyCommunitySupportLogin

Configure Moveworks Assistant

Suggest Edits

This document is a guide on how to Configure the Moveworks Assistant In order to Deploy the Assistant in the Chat or Web Interface of your enterprise. There are some key items which need to be completed as Pre-requisites in order to have a working Assistant.

Pre-requisites

User Identity

  • Please ensure you have Ingested Users into the Moveworks roster from the External sources of the Enterprise. If this step has not been completed, please follow the Guide here to learn more about Identity Ingestion and the steps to perform it.
  • Please ensure the Access requirements for the Chat Platform have been completed. Here is a set of guides which outline the access requirements across different Chat Platforms.

Configuring Assistants

In order to configure an Assistant on a Chat surface we need to start by Navigating to Manage Chatbots under the Chat Platforms Module.

  • Click on Create

We start with defining the Core Configurations which include the below fields :

  • Channel - It is the channel/chat platform for which ChatBot configuration is required. E.g. Slack, Microsoft Teams, Moveworks for Web Chat.

  • Select Connector - This is the name of the Connector that is used for Chat Integration. Some connectors can only be used with certain Channel options.

📘

These are the Channel and Connector Options which should be selected together

Slack

  • Channel : Slack
  • Select Connector : Slack Connector created using this Guide

Teams

  • Channel : msteams
  • Select Connector : msteams (This is an internal Moveworks connector which always needs to be used when configuring Teams)

Note : In the case of Teams the Auth for the Azure App is defined in the Channel Configurations below.

Moveworks for Webchat

  • Channel : movewebchat
  • Select Connector : movewebchat (This is an internal Moveworks connector which always needs to be used when configuring Moveworks for Web. If the option is not available, leave this field blank and it will be auto-generated when you save the configuration.)
  • Bot ID - This ID identifies which account we are using to send messages from within the Assistant.
    • For The Microsoft Teams AppStore the Bot ID will always be the below value : 
      28:b8ec4e1a-e05a-49d0-ba3a-05119b8b62c0
    • For Microsoft Teams Bot via Non-App Store Method set value to format : 
      28:<app_id>
    • For Slack the Bot ID can be found by making an API Call defined in the Guide here. The format will look something like 
      Bxxxxxx
    • For WebChat an ID will be generated by Moveworks, so when creating the configuration for the first time with the Channel Movewebchat we need to set the value of Bot Id to 1234.
      • Bot ID will be generated automatically upon saving the configurations which the user can then fetch.
    • For Google Chat the Bot ID will be the email address of the bot user created on Google Chat.

For all other chat systems please follow the guides mentioned here.

Bot Name (Moveworks Identifier)

This is a very Important configuration field. The Bot Name is the unique identifier of the Assistant within Moveworks. The value here should always be the Org name followed by the Channel the Assistant is being deployed in.

🚧

Please confirm the Org Name with the Support or CS Team before moving forward

For Examples : If your org name was **moveworks** the Bot Name should be as followed for the respective channels.

  • moveworks-slack
  • moveworks-webchat
  • moveworks-teams

❗️

Note: This Value in the Configuration cannot be changed once it is submitted

  • Bot Friendly Name - This is the Customer-facing name of the Assistant. This is generally the same across all Assistants for an organization. This is what the Assistant will refer to itself as.

We need to now define the Channel Configurations which include the below fields :

  • Channel Configurations dropdown. - Selecting the Channel here will render the Authentication Configuration for that integration on the page.
    • If Slack is Selected we will need to provide fields like the App Id, User Id, Bot ID etc.
    • If Teams is Selected we will provide the Credentials based on the Auth type configured.
    • If Movewebchat is Selected, please specify the Webchat App ID as 1234 when creating the configuration for the first time.
      • Similar to the step above, Webchat App ID will match the Bot ID and will be generated automatically upon saving the configurations which the user can then fetch.
  • Add relevant system specific configs for the channel.
  • Click on Submit

📘

Please ensure that while submitting the configuration, you provide the Config Name as the "Bot Name(Moveworks Identifier)" in the config title.

With these easy steps, you would be able to deploy the Assistant on your channel of choice.

Updated 2 days ago