Guide

Q. What is an Approval, when should it be used and what is needed to send approvals?

An Approval is an Approval request by the Bot for the concerned party. It is used to verify if the Bot should execute Automation on the Concerned Resources. Approvals should be used whenever the Bot is about to execute an automation that mutates the existing Settings/Infrastructure of the Integration. To send the Approvals, we need a supported Integration as well as an Integration Automation.

Example :

Integration : MS Teams Integration

Automation Code :

python
import pymsteams
import traceback

def execute(clients, params, resources=[], test=False):
    try:
        my_teams_message = clients['msteams_client']
        
        if 'title' in params.keys():
            my_teams_message.title(params['title'])
        if 'message' in params.keys():
            my_teams_message.text(params['message'])
        for resource in resources:
            resource_section = pymsteams.cardsection()
            text = 'ID' + ' : ' + str(resource.get('id', 'N.A.')) + ', '
            text = text + 'Name' + ' : ' + str(resource.get('name', 'N.A.'))
            resource_section.text(text)
            my_teams_message.addSection(resource_section)

        if 'buttons' in params.keys():
            for button in params['buttons']:
                my_teams_message.addLinkButton(button['name'], button['link'])
        if len(params.keys()) > 1:
            my_teams_message.send()
        else:
            print('This params only contains teams_webhook key, need more data to create a meaningful message.')
        return
    except BaseException as e:
        print('Error Occurred in sending message to teams : ', e)
        traceback.print_exc()

Q. What is a Fleet?

A Fleet can be understood as a set of Bots and the Interations where those bots should be deployed. It is used to deploy group of bots to multiple Integrations with one click. It also automatically figures out which Bot should be deployed for which Integration.

Example : A fleet with 2 AWS Bots and 5 Azure bots will only deploy the 2 AWS Bots when an AWS Integration is added to it and only the 5 Azure Bots when an Azure Integration is added to it.

Q. What are Templates and Overrides in the fleet and how to configure them?

Templates are the Bots that have not been depoyed to Integrations and will be used as a base whenever a deployment is being carried out. You can select any Bot from your Account as a Template or use Default Templates provided.

Overrides are the values that will be substituted in the Templates before they are Deployed for specified Integrations. Currently you can override the Approval Integration Setting for all bots as well as the Evaluator JSON.

You can Configure the Templates and Overrides in Fleets section and clicking on the fleet where you want to manage Templates or Overrides.

Q. What are deployments in the fleet and how to manage them? Where can I manage Integrations to an existing Fleet ?

Deployments is the list of all the Bots that are deployed by the Fleet for all of the Integrations. You cannot manage the Deployments, You can only view them in the Fleets Section by selecting the desired fleet.

You can add Integration to an existing Fleet by selcting the Deploy button on list fleets page, from there you would be redirected to select Integration page, where you can add or remove the Integrations to your fleet.

Q. What are sub-users, what they can see and how can we create new sub-users?

Sub-Users are users that were created by one of the Root User and will be managed by root user. Root user can delete sub users at will. Sub-Users has full access like root user but cannot approve requests in stead of Root User. You can create sub-users from User Management Page. To open User Management Page, click on your Name at the Top-Right corner and select User Management from the DropDown.

Q. What are API Keys, How to create them and How do we use them?

API Keys are permanent keys that can be used to call the Backend APIs. You can create APIs from My Profile Page. To open My Profile Page, click on your Name at the Top-Right corner and select My Profile from the DropDown. Refer : LINK TO API KEY DOC