There are various parts of the Enate system which support integration with other systems and extensibility through custom code. This section is here to help developers and analysts work with these features, along with other documentation on the more technical aspects of configuring Enate.

As a primer for this, it's a good idea to read the Whitepaper on Enate Integration available in the Enate White Papers section.

You can also find examples of how to use these integrations to achieve functions and patterns that help speed up your workflows and processes in Enate:

Overview

Our email classification pattern, available in Marketplace in Builder enables the automatic classification and categorization of Tickets, without agents having to do this manually so that by the time an agent picks a Ticket it up, it's already where it needs to be.

This pattern is available via the following providers:

• EnateAI

• OpenAI GPT3

• Azure OpenAI GPT3

• UiPath Communications Mining

EnateAI Setup

EnateAI is a zero configuration option supplied by Enate which uses our own Azure hosted OpenAI Instance for the GPT3 Engine.

This instance is shared with anyone that enables EnateAI so if you have high volume/high demand then you may be better off configuring your own Azure Open AI instance and using an Azure Open AI Adapter Version.

The setup of EnateAI for all patterns is super simple - simply click to activate.

OpenAI GPT3 Setup

OpenAI Adapters allow you to talk to the OpenAI API directly via your own OpenAi account and API keys, this will be using the OpenAI API which is open to everyone. You can also monitor usage of API requests sent via this API in the OpenAI interface.

To setup OpenAI for email classification, follow these steps:

1. Click on 'Activate' on the 'OpenAI GPT3 - Email Classification' option in Enate Marketplace.

1. In the resulting pop-up, enter the following information:

• the URL of the instance - this is the base URL for OpenAI, i.e. https://api.openai.com/

• the API key - this you can create from the OpenAI API keys page https://platform.openai.com/account/api-keys

1. Click to test the connection

2. Once the connection has been successfully tested, click to activate. Your Email Classification pattern provided by OpenAI is ready to be used.

Further notes of interest

The OpenAI API keys page is where you can create further API keys and manage your existing ones.

You can monitor the usage and breakdown of requests of the OpenAI account on the OpenAI Usage page:

Azure OpenAI GPT3 Setup

AzureAI allows you to use your own Azure instance of OpenAI which you can manage and control, giving you a great deal of control and detail of the information going through the API.

To setup Azure OpenAI for email classification, follow these steps:

1. Click on 'Activate' on the 'Azure OpenAI GPT3 - Email Classification' option in Enate Marketplace.

1. Enter the following information, all of which can be gathered from your Azure OpenAI instance, in the resulting pop-up:

• Resource Name - this is the Azure Resource Name which can be found by navigating to your OpenAI Cognitive Services in Azure, accessing your Azure OpenAI Resource and opening the resource. The resource name can be found in the overview page, next to 'Resource group'

• Deployment Name - to find this, go to the 'Model deployments' section in Azure OpenAI studio and then click on 'Manage Deployments'.

Then click on the 'Deployments' section on the left and the deployment name will appear on the right - this is the value you need.

• API Key - this is configured back in the OpenAI Portal, from the 'Keys and Endpoints' section on the left. This is where you can generate new keys and manage existing ones. Enter one of these keys.

• Click to test the connection

• Once the connection has been successfully tested, click to activate. Your Email Classification pattern provided by OpenAI is ready to be used.

UiPath Communications Mining Setup

UiPath Communications Mining provides communication analysis and to help automate your processes.

The following video takes you through how to setup UiPath Communications Mining for email classification.

This shows you how to add an Iframe to your Advanced Custom Cards through which you can surface your own bespoke content. Check out our dedicated Github section for more details:

Check out our Advanced Custom Cards section for more information about what they are and how to use them:

Overview

The Document Classification component, available in Enate Marketplace, analyzes the attachments of incoming emails and automatically classifies them with a tag.

This provides accurate tagging of the files in your work items without an agent needing to spend time doing this manually, saving time and effort and allowing them to focus on their core activities.

Infrrd Set Up

There are a few steps to follow when it comes to switching Document Classification component on using Infrrd as yor provider.

1. Marketplace Setup

2. Contract Setup

3. File Tag Setup

1. Marketplace Setup

You'll first need go to the to Marketplace section of Enate Builder and click to activate the Infrrd Document Classification component.

In the following pop-up, you'll need to add the URL and account ID of your Infrrd platform.

You'll then need to add the model(s) you want to use. To add a model, you'll first need to make sure that it is already configured in your Infrrd platform. You'll then need to enter the following information, all of which can be found in your Infrrd platform:

• Model ID

• Model name

• API key

You can add as many models as you like. These models are what determines how documents get classified. For example, you might have configured a model that is trained to only identify invoices, so that would be the model you would want to use for your invoice processes.

Once you have entered all of the above information, you'll need to test the connection.

Once the connection has been tested successfully, click to activate.

2. Contract Setup

Once the adapter is activated, you'll need to make sure that the correct model is used for the right process. This involves adding the model to the contract settings of the desired process.

To do this, go to the Service Matrix and open the contract settings of the desired process.

You'll need to fill in the following two settings:

• Document Classification Model - enter the model you want to use here. You can refresh to view the updated list of models available.

• Allowed File Types for Document Classification - enter the file types you want to be considered for file classification here.

3. File Tag Setup

You'll also need to make sure that all the file tags you might need are set up in the system. This is done from the File Tag section in the System Settings page of Enate Builder.

You can find more information about adding and maintaining your file tags here.

And you're done.

Infrrd Document Classification auto creation of file tags

Alongside manually created file tags, whenever the 'Infrrd Document Classification' Integration returns a document with a proposed file tag value, if the value it is proposing is not in the current list of file tags set in Enate, Infrrd will auto-populate the proposed file tag into this list in general settings. Be sure that your process configuration for any downstream actions which are intended to process such documents are set with am 'Input File Tag' whih corresponds with this.

Obviously you're stil in control of the file tags values will be in play in your process set up, since part of training your Infrrd system to recognize the desired type of document e.g. 'Invoice' or 'Payslip'. For more information on how to train Infrrd to recognize documents correctly, please see the following link: Infrrd Document Classification

Introduction

This guide will outline the steps involved in configuring a Bot Status monitor in Power Automate. With this flow correctly set up, an email will be automatically generated notifying you of when any of your Bots working in Enate go offline.

Prerequisites :

• Microsoft Power Automate licensed version.

• Enate instance URL

• Username and password for that instance (user must have Team Leader access)

• RobotFarmGUID (thst you want to receive notifications from). Select GUID from tblRobotFarms where Name = 'Enter-BotFarm-Name'

• Email address of people whom you want to be notified

Step 1 : Configure Office 365 Outlook Connector in Power Automate.

1. Go to Power Automate dashboard ( https://emea.flow.microsoft.com/ )

2. On left menu bar go to ‘Data’ > ‘Connections’.

3. Click on ‘New Connection’.

4. Choose ‘Office 365 Outlook’

5. Click on ‘Create’.

6. Choose a user account and complete the authentication process.

Step 2 : Importing the flow

1. Choose the ‘My Flows’ option from the left side menu bar on the dashboard and click on ‘Import’.

2. Download the .zip file of the from here:

3. Upload the provided .zip file into Power Automate.

4. After it has uploaded successfully, click on the ‘Update’ option

5. Select the ‘Create as new’ option from the dropdown and click on ‘Save’.

6. Click ‘Select during import’ under Import Setup in the Related Resources field.

7. Select email account that you connected in step 1 and click on ‘Save, then ‘Import’.

8. After a successful import, your screen should look like this:

Step 3: Configure Flow

1. Go to the ‘My Flows’ option from the left side menu bar on the dashboard. This will show you your Imported project. Then click on the edit button.

2. Click on ‘Variable to be initialized’

3. You can then choose which fields to initialize:

Details of how to initialize the various fields:

1. URL: Enter enate instance URL: Ex: => https://enate.community/XYZ

2. User Name and Password: Enter the credentials for your chosen URL.

3. RobotFarmGUID: your can get this from the database. Select GUID from tblRobotFarms where Name = 'Enter-BotFarm-Name'.

4. Email Subject and Header: Enter your Email Subject and header for the notification Email.

5. To Email Addresses: enter the Email addresses which you want to send the notification to, separateing each email address with a semicolon ‘;’ Ex. deval.example@enate.net;abc@enate.net;xyz@enate.net

Click on ‘Save’ and a green confirmation message will appear.

6. Once the green confirmation message has appeared, go back and click ‘Turn on’ to switch on the flow.

This will make the yellow header disappear, telling you that the flow is up and running.

Now the flow is running, you should get an email notifying you of every time one of your Bots working in Enate goes offline.

How to integrate with Power Automate

Check out our Power Automate section for more information about how to integrate it with Enate here:

Check out this video explainer which shows you a neat trick for populating row data directly into an Enate Case while it's being created, using one of UiPath's native activities.

Check out our UiPath section for more information about how to integrate it with Enate here:

Check out this explainer for how to create a simple web front end which you could drop onto an intranet / public site to create Tickets in Enate using Enate's standard APIs.

You can even download the source code for this from Enate's GitHub page to get you up & running quickly with this:

Check out our APIs section for more information about Enate's APIs and how to use them:

Overview

Our sentiment analysis pattern, available in in Builder enables the analysis of the content of incoming emails and determine if, for example, they are positive or negative. This assessment can be passed back into Enate Work Manager so that Agents can tell at a glance what the tone of the mail is as headline information as they start to deal with it.

This pattern is available via the following providers:

EnateAI Setup

EnateAI is a zero configuration option supplied by Enate which uses our own Azure hosted OpenAI Instance for the GPT3 Engine.

This instance is shared with anyone that enables EnateAI so if you have high volume/high demand then you may be better off configuring your own Azure Open AI instance and using an Azure Open AI Adapter Version.

The setup of EnateAI for all patterns is super simple - simply click to activate.

OpenAI GPT3 Setup

OpenAI Adapters allow you to talk to the OpenAI API directly via your own OpenAi account and API keys, this will be using the OpenAI API which is open to everyone. You can also monitor usage of API requests sent via this API in the OpenAI interface.

To setup OpenAI for sentiment analysis, follow these steps:

1. Click on 'Activate' on the 'OpenAI GPT3 - Sentiment Analysis' option in Enate Marketplace.

1. In the resulting pop-up, enter the following information:

• the URL of the instance - this is the base URL for OpenAI, i.e. https://api.openai.com/

1. Click to test the connection

2. Once the connection has been successfully tested, click to activate. Your Sentiment Analysis pattern provided by OpenAI is ready to be used.

Further notes of interest

The OpenAI API keys page is where you can create further API keys and manage your existing ones.

You can monitor the usage and breakdown of requests of the OpenAI account on the OpenAI Usage page:

Azure OpenAI GPT3 Setup

AzureAI allows you to use your own Azure instance of OpenAI which you can manage and control, giving you a great deal of control and detail of the information going through the API.

To setup Azure OpenAI for sentiment analysis, follow these steps:

1. Click on 'Activate' on the 'Azure OpenAI GPT3 - Sentiment Analysis' option in Enate Marketplace.

2. Enter the following information, all of which can be gathered from your Azure OpenAI instance, in the resulting pop-up:

• Resource Name - this is the Azure Resource Name which can be found by navigating to your OpenAI Cognitive Services in Azure, accessing your Azure OpenAI Resource and opening the resource. The resource name can be found in the overview page, next to 'Resource group'

• Deployment Name - to find this, go to the 'Model deployments' section in Azure OpenAI studio and then click on 'Manage Deployments'.

Then click on the 'Deployments' section on the left and the deployment name will appear on the right - this is the value you need.

• API Key - this is configured back in the OpenAI Portal, from the 'Keys and Endpoints' section on the left. This is where you can generate new keys and manage existing ones. Enter one of these keys.

1. Click to test the connection

2. Once the connection has been successfully tested, click to activate. Your Sentiment Analysis pattern provided by Azure OpenAI is ready to be used.

UiPath Communications Mining Setup

UiPath Communications Mining provides communication analysis and to help automate your processes.

Note that the Sentiment Analysis pattern works slightly differently when using UiPath Communications Mining as your provider. Communications in incoming emails are still analysed, but the assessment is not passed back into Enate Work Manager. Instead, the assessment remains in you UiPath Communications Mining system, allowing you to auto-tag and categorise emails in a certain way according to how you've set UiPath Communications Mining up.

The following video takes you through how to setup UiPath Communications Mining for sentiment analysis.

Overview

Enate provides lots of offerings when it comes to the AI space and we have a number of GPT-driven integrations, available in , to support your users with their day to day activities.

EnateAI is a zero-configuration GPT option supplied by Enate which uses our own Azure hosted OpenAI Instance for the GPT3 Engine. This instance is shared with anyone that enables EnateAI, so if you have high volume/high demand then you may be better off configuring your own Azure OpenAI instance and using an Azure Open AI Adapter Version. The configuration of the EnateAI adapters is super simple and is a mere click of a button to enable.

The OpenAI option allows you to talk to the OpenAI API (which is open to everyone) directly via your own OpenAI account and API keys. You can also monitor usage of API requests sent via this API in the open AI interface.

And if you'd rather run these patterns via your own Azure platform, our AzureAI adapters allow you to use your own Azure instance of OpenAI which you can manage and control, providing you with a great deal of control and detail of the information going through the API.

Patterns Available

These providers are available for the following patterns:

• - automatically classifies and categorizes Tickets, saving agents having to do this manually. Check out the dedication section to find out more.

• - that auto-populates important information from emails into custom cards in your Tickets and Cases, saving agents from having to do this manually. Check out to the dedication section to find out more.

• - automatically detects whether incoming emails to a resolved work are just simple 'thank you emails', and if so then have them automatically moved back to a state of 'resolved' without agent users having to manually perform such repetitive checks. Check out to the dedication section to find out more.

• - analyzes the content of incoming emails, determines their sentiment - e.g. if they're positive or negative and displays this information to your users to they can determine the sentiment of an email at a glance. Check out to the dedication section to find out more.

Setup Guide

EnateAI

EnateAI is a zero configuration option supplied by Enate which uses our own Azure hosted OpenAI Instance for the GPT3 Engine.

OpenAI

To setup OpenAI for a pattern, follow these steps:

1. In the resulting pop-up, enter the following information:

• the URL of the instance - this is the base URL for OpenAI, i.e. https://api.openai.com/

1. Click to test the connection

2. Once the connection has been successfully tested, click to activate. Your pattern provided by OpenAI is ready to be used.

Further notes of interest

The OpenAI API keys page is where you can create further API keys and manage your existing ones.

You can monitor the usage and breakdown of requests of the OpenAI account on the OpenAI Usage page:

Azure OpenAI

To setup Azure OpenAI for email classification, follow these steps:

1. Enter the following information, all of which can be gathered from your Azure OpenAI instance, in the resulting pop-up:

• Resource Name - this is the Azure Resource Name which can be found by navigating to your OpenAI Cognitive Services in Azure, accessing your Azure OpenAI Resource and opening the resource. The resource name can be found in the overview page, next to 'Resource group'

• Deployment Name - to find this, go to the 'Model deployments' section in Azure OpenAI studio and then click on 'Manage Deployments'.

Then click on the 'Deployments' section on the left and the deployment name will appear on the right - this is the value you need.

• API Key - this is configured back in the OpenAI Portal, from the 'Keys and Endpoints' section on the left. This is where you can generate new keys and manage existing ones. Enter one of these keys.

• Click to test the connection

• Once the connection has been successfully tested, click to activate. Your pattern provided by OpenAI is ready to be used.

This section gives a list of changes to Enate's APIs from version 2020.1 and above.

What is a breaking change?

With each release of Enate (both major and minor), the changes to Enate's APIs may also include breaking changes. Examples of breaking changes are:

• Changes to the URL or fundamental request/response associated with a resource

• Removal, rename, or change to the type of a declared property

• Removal or rename of APIs or API parameters

• Addition of a required request header

• Addition of a required API parameter

Examples of changes which are NOT considered breaking changes and are outside the scope of this document are:

• Addition of properties that are nullable or have a default value

• Addition of an optional API parameter

• Addition of a member to an enumeration

• Removal, rename, or change to the type of an open extension

• Removal, rename, or change to the type of an annotation

• Introduction of paging to existing collections

• Changes to error codes

• Changes to the order of properties

• Changes to the length or format of opaque strings, such as resource IDs

API Changes Documents

See the following documents for details of all the API changes, including breaking API changes.

v2023.1

v2022.6

v2022.5

v2022.4

v2022.3

v2022.2

v2022.1

v2021.2

v2021.1

v2020.1

How to use the API Changes document

Recommendations for how best to use the breaking changes document information to highlight where you may need to make changes to your code which involves Enate APIs.

Recommendation for best use of API breaking changes documentation is as follows:

• Read through the breaking changes information for APIs.

• Upon finding reference to an API which you currently use and which has changed, go to your Swagger environment for the quickest way to view the overall impact and new API content definition. Your Swagger environment should always be your go-to place for the definitive explanation of the current API structure. See the Swagger explanation section for more info.

Overview

The Document Extraction component, available in Enate Marketplace, automatically extracts the relevant data from files attached to incoming emails so that this data can be used in further processing of the work item, saving your agents time and effort. This also means that documents such as PDFs can be scanned and used both to start Cases in Enate and to form part of the ongoing process's activities.

Infrrd Set Up

There are a few steps to follow when it comes to switching Document Extraction component on with Infrrd.

1. Marketplace Setup

2. Case Flow Setup

1. Marketplace Setup

You'll first need go to the to Marketplace section of Enate Builder and click to activate the Infrrd Document Extraction component.

In the following pop-up, you'll need to add the URL and account ID of your Infrrd platform, as well as the model(s) you want to use.

To add a model, you'll first need to make sure that it is already configured in your Infrrd platform. You'll then need to enter the following information, all of which can be found in your Infrrd platform.

• Model ID

• Model name

• API key

You can add as many models as you like. These models are what determines how documents get classified. For example, you might have configured a model that is trained to only identify invoices, so that would be the model you would want to use for your invoice processes.

Once you have entered all of the above information, you'll need to test the connection.

Once the connection has been tested successfully, click to activate.

2. Case Flow Setup

You'll then need to set up your Case flow to support the Document Extraction component. This involves adding an 'IDP Data Extraction' Action in Enate Builder to use in your desired Case flows.

You can either add an existing one from the Actions list if one has already been created, or you can create a brand new one.

IDP Data Extraction Actions can be created in the same way any other Action is created in Enate: either from the Service Line page, or directly from within your Case flow.

To create an IDP Data Extraction Action from the Service Line page, select to create a new Action under the desired service line, give the action a name and a description and choose approval action from the type drop down. You can also give the Action a global checklist if you wish.

To create an IDP Document Extraction Action directly from the Case flow itself, open a Case flow in edit mode, click on an Action's menu and then instead of clicking to add an existing Action, select to create a new Action by clicking the '+' icon.

Give the Action a name, add a description if you wish and for its type, select 'Approval'. When you click 'OK, the Action will be created and added to the Case flow.

Once you have added your approval action to your flow, you will then need to fill out its settings.

On the Action Info tab you will need to set when it's due and set an Allocation rule.

There's also general settings for the Action too, and ability to set a custom card, again only really for use in the unlikely event that someone needs to intervene and view the action in Work Manager.

Next, go to the IDP Document Extraction tab to define the settings which specifically relate to the approval activities.

You'll need to fill in the Extraction Model - this is the ID of the model you want to use for that process.

You'll also need to fill in the input and output tags. The input tag is the tag that the file/document must be tagged with in Work Manager in order to be eligible for document extraction processing and output tags. The output tag is the tag that will be assigned to the file/document in Work Manager once the document extraction process has completed.

Once you have filled in the above settings details, set the Case live.

ABBYY Set Up

In order to integrate with ABBYY FlexiCapture, you need to:

1. Set up an ABBYY FlexiCapture connection

2. Create an ABBYY FlexiCapture Action type

3. Add an ABBYY FlexiCapture Action into you Case flow

Watch this video to find out more about integrating Enate and ABBYY FlexiCapture.

1. Setting up an ABBYY FlexiCapture connection

In order to enable ABBYY FlexiCapture integration, a connection to an active ABBYY instance must be configured in Enate's Builder app. These settings are accessed from the ABBYY section in Enate's Marketplace:

Clicking on 'Activate' will take you to a page where you can view your OCR Connections. Click to add a new connection and then in the subsequent pop-up, provide the following details:

Once you have supplied this information, click to test the connection.

Once the connection has been tested successfully, your ABBYY integration is successfully connected with Enate. Enate will now automatically sync project lists with ABBYY; ABBYY projects do not need to be manually added to Enate.

2. Creating an ABBYY Action Type

Once you have successfully set up an ABBYY FlexiCapture connection, you then need to create an ABBYY FlexiCapture Action type.

You can either do this in the Service Line section of Builder, or directly from your Case flow.

From the Service Lines Page

Creating an ABBYY FlexiCapture Action type from the Service Lines section of Builder adds the Action to your menu of available Actions when you're building flows subsequently in Cases.

To do this, in the Service Lines page select, which service line you would like to add the ABBYY Action to and then click on the plus symbol next to the 'Process Search' box. This will bring up a drop down menu where you can select an Action.

This will open up a new Action for you to create.

Add a name and description to your Action and then in the 'type' drop down select 'ABBYY OCR'.

You can then choose to add a global checklist to your ABBYY FlexiCapture Action. This contains a standard checklist of activities that will be added any time this Action type is added to a Case flow. See here for more information on checklists.

Once you are happy with your Action, hit save to create it. This Action can now be added to new and existing business processes by selecting it from the dropdown list when adding a new Action to a Case.

From a Case Flow

Alternatively, you can add an ABBYY FlexiCapture Action type directly from the Case flow itself.

To do this, open your desired Case flow in edit mode, click on an Action's menu and then instead of clicking to add an existing Action, select to create a new Action by clicking the '+' icon.

Give the Action a name, add a description if you wish and for its 'type', select 'ABBYY OCR'. This will add the ABBYY FlexiCapture Action to the Case flow.

3. Adding an ABBYY FlexiCapture Action into you Case flow

Once you has successfully set up an ABBYY connection, you then need to add an ABBYY FlexiCapture Action in your Case flow.

Select the '+' icon on the Add Action Menu in the desired Case flow. Give the ABBYY Action a name and then assign it as an ABBYY OCR Action Type. This will add an ABBYY Action to the Case flow.

Once an ABBYY FlexiCapture Action has been added to your Case flow, a new section will display in the Action info grid.

Configuring an ABBYY Action

You now need to configure the settings for the new Action you have added to your Case.

Click on the Action in the flow to highlight it in the info section. In the Action Info tab, you need to add the following information:

Additionally, once an ABBYY Action has been added to your Case flow, a new 'ABBYY FlexiCapture' tab will display in the info grid.

Here you need to add the following settings that are only relevant for ABBYY Actions:

Your ABBYY FlexiCapture Action is now ready to be used in your Case flows at runtime.

Overview

Enate is able to provide integration with ABBYY FlexiCapture to allow intelligent document processing to be part of your Enate processes - this is achieved through use of an ABBYY FlexiCapture integrated Action. This means that documents such as PDFs can be scanned by ABBYY FlexiCapture both to start and to form part of your Enate processes.

When an ABBYY Action runs for a Case, documents attached to the Case can be submitted to ABBYY FlexiCapture for OCR Scanning and the processed output files will be returned and automatically attached to the Case.

Furthermore, if ABBYY FlexiCapture highlights that additional manual verification may be needed (i.e. if confidence levels in the scanned output is below threshold), the work is transferred over to a human resource to be able to verify and if necessary adjust the data via the ABBYY FlexiCapture screen surfaced directly in an Enate Action.

Watch this video to find out more about integrating Enate and ABBYY FlexiCapture.

The ABBYY section in Enate's Marketplace is where you can create and maintain your ABBYY Integration.

You can find out how to integrate Enate and ABBYY to start including intelligent document processing in your Enate processes here:

For detailed information on how ABBYY Actions work at runtime, see here:

Overview

Our 'Thank You Email Evaluation' pattern, available in Marketplace in Builder automatically detects whether incoming emails to a resolved work are just simple 'thank you emails', and if so then have them automatically moved back to a state of 'resolved' without agent users having to manually perform such repetitive checks. Importantly, the 'Resolved' date of the work item remains as-is, i.e. it is unchanged when EnateAI automatically re-resolves the work item.

This pattern is available via the following providers:

• EnateAI

• OpenAI GPT3

• Azure OpenAI GPT3

• UiPath Communications Mining

EnateAI Setup

EnateAI is a zero configuration option supplied by Enate which uses our own Azure hosted OpenAI Instance for the GPT3 Engine.

This instance is shared with anyone that enables EnateAI so if you have high volume/high demand then you may be better off configuring your own Azure Open AI instance and using an Azure Open AI Adapter Version.

The setup of EnateAI for all patterns is super simple - simply click to activate.

OpenAI GPT3 Setup

OpenAI Adapters allow you to talk to the OpenAI API directly via your own OpenAi account and API keys, this will be using the OpenAI API which is open to everyone. You can also monitor usage of API requests sent via this API in the OpenAI interface.

To setup OpenAI for Thank You Email Evaluation, follow these steps:

1. Click on 'Activate' on the 'OpenAI GPT3 - Thank You Email Evaluation' option in Enate Marketplace.

1. In the resulting pop-up, enter the following information:

• the URL of the instance - this is the base URL for OpenAI, i.e. https://api.openai.com/

• the API key - this you can create from the OpenAI API keys page https://platform.openai.com/account/api-keys

1. Click to test the connection

2. Once the connection has been successfully tested, click to activate. Your Thank You Email Evaluation pattern provided by OpenAI is ready to be used.

Further notes of interest

The OpenAI API keys page is where you can create further API keys and manage your existing ones.

You can monitor the usage and breakdown of requests of the OpenAI account on the OpenAI Usage page:

Azure OpenAI GPT3 Setup

AzureAI allows you to use your own Azure instance of OpenAI which you can manage and control, giving you a great deal of control and detail of the information going through the API.

To setup Azure OpenAI for thank you email evaluation, follow these steps:

1. Click on 'Activate' on the 'Azure OpenAI GPT3 - Thank You Email Evaluation' option in Enate Marketplace.

1. Enter the following information, all of which can be gathered from your Azure OpenAI instance, in the resulting pop-up:

• Resource Name - this is the Azure Resource Name which can be found by navigating to your OpenAI Cognitive Services in Azure, accessing your Azure OpenAI Resource and opening the resource. The resource name can be found in the overview page, next to 'Resource group'

• Deployment Name - to find this, go to the 'Model deployments' section in Azure OpenAI studio and then click on 'Manage Deployments'.

Then click on the 'Deployments' section on the left and the deployment name will appear on the right - this is the value you need.

• API Key - this is configured back in the OpenAI Portal, from the 'Keys and Endpoints' section on the left. This is where you can generate new keys and manage existing ones. Enter one of these keys.

1. Click to test the connection

2. Once the connection has been successfully tested, click to activate. Your Thank You Email Evaluation pattern provided by Azure OpenAI is ready to be used.

UiPath Communications Mining Setup

UiPath Communications Mining provides communication analysis and to help automate your processes.

The following video takes you through how to setup UiPath Communications Mining for 'thank you' email evaluation.

In order to integrate with ABBYY FlexiCapture, you need to:

1. Set up an ABBYY FlexiCapture connection

2. Create an ABBYY FlexiCapture Action type

3. Add an ABBYY FlexiCapture Action into you Case flow

1. Setting up an ABBYY FlexiCapture connection

In order to enable ABBYY FlexiCapture integration, a connection to an active ABBYY instance must be configured in Enate's Builder app. These settings are accessed from the ABBYY section in Enate's Marketplace:

Clicking on 'Activate' will take you to a page where you can view your OCR Connections. Click to add a new connection and then in the subsequent pop-up, provide the following details:

Once you have supplied this information, click to test the connection.

Once the connection has been tested successfully, your ABBYY integration is successfully connected with Enate. Enate will now automatically sync project lists with ABBYY; ABBYY projects do not need to be manually added to Enate.

2. Creating an ABBYY Action Type

Once you have successfully set up an ABBYY FlexiCapture connection, you then need to create an ABBYY FlexiCapture Action type.

You can either do this in the Service Line section of Builder, or directly from your Case flow.

From the Service Lines Page

Creating an ABBYY FlexiCapture Action type from the Service Lines section of Builder adds the Action to your menu of available Actions when you're building flows subsequently in Cases.

To do this, in the Service Lines page select, which service line you would like to add the ABBYY Action to and then click on the plus symbol next to the 'Process Search' box. This will bring up a drop down menu where you can select an Action.

This will open up a new Action for you to create.

Add a name and description to your Action and then in the 'type' drop down select 'ABBYY OCR'.

You can then choose to add a global checklist to your ABBYY FlexiCapture Action. This contains a standard checklist of activities that will be added any time this Action type is added to a Case flow. See here for more information on checklists.

Once you are happy with your Action, hit save to create it. This Action can now be added to new and existing business processes by selecting it from the dropdown list when adding a new Action to a Case.

From a Case Flow

Alternatively, you can add an ABBYY FlexiCapture Action type directly from the Case flow itself.

To do this, open your desired Case flow in edit mode, click on an Action's menu and then instead of clicking to add an existing Action, select to create a new Action by clicking the '+' icon.

Give the Action a name, add a description if you wish and for its 'type', select 'ABBYY OCR'. This will add the ABBYY FlexiCapture Action to the Case flow.

3. Adding an ABBYY FlexiCapture Action into you Case flow

Once you has successfully set up an ABBYY connection, you then need to add an ABBYY FlexiCapture Action in your Case flow.

Select the '+' icon on the Add Action Menu in the desired Case flow. Give the ABBYY Action a name and then assign it as an ABBYY OCR Action Type. This will add an ABBYY Action to the Case flow.

Once an ABBYY FlexiCapture Action has been added to your Case flow, a new section will display in the Action info grid.

Configuring an ABBYY Action

You now need to configure the settings for the new Action you have added to your Case.

Click on the Action in the flow to highlight it in the info section. In the Action Info tab, you need to add the following information:

Additionally, once an ABBYY Action has been added to your Case flow, a new 'ABBYY FlexiCapture' tab will display in the info grid.

Here you need to add the following settings that are only relevant for ABBYY Actions:

Your ABBYY FlexiCapture Action is now ready to be used in your Case flows at runtime.

For detailed information on how ABBYY Actions work at runtime, see here:

Intro to Enate APIs

Enate has an open REST API that allows other systems to start, track and interact with work in Enate. Enate APIs communicate via HTTPS Get/Post calls using the JSON data format.

Enate also supports Webhooks, which you can subscribe to so your system is updated on Enate activity in real-time. Check out the Webhooks section for more information:

Using Application Credentials to access Enate

Enate allows you to create Application Credentials to support multiple concurrent integrations into Enate via APIs. This approach has replaced the need to use standard Enate user accounts for authorised access to the system, which only supported one concurrent access. The Application Credentials records created in User Management section of Builder can be used to generate 'Bearer Tokens' which can be appended in the header of each API to grant access to Enate. Different permission levels can be granted to each Application Credential by selecting from a number of available 'Roles' when creating the Application Credential.

For more information on this, check out the Application Credentials page in the Builder section:

Swagger - Enate's Interactive API Documentation

If you've got access to an existing Enate environment, you'll be able to access interactive API documentation for Enate’s APIs using your Swagger link, which will be a unique url specific to your instance available at https://YourPlatformName/YourInstance/WebAPI.

If you don't yet have access to an existing Enate environment to run & test your APIs, you can at least take a 'read-only' look at all of the APIs available and their details in this sample Enate environment link:

https://sample.enate.net/documentation/webapi

More general information on Swagger can be found here.

Sample Integration Patterns Using Enate's API's

The following code can be added to a custom card to set the default value of a date/time field to the current date/time. In order to do this we need to use a third party object called 'moment' which lives in your browser, and will return the current datetime if we include it as a variable at the beginning of our code. This sample will assume the following:

• You have a custom card open

• It is set to 'Customised' in order to show the additional code tabs

• You have added a DateTime Field to your card - here we will give it a name of 'CurrentDate' - you will have to adjust this name of the field referenced in your code in step 2 in order to match with your own specific field's name.

When you set your card to 'Customised', all the previously auto-generated for the standard form layout remains for your use, so there are only two small lines of code to add, in two places. Follow the steps below:

1. Declare 'moment' as a vairable In the Typescript tab, add the following line of code immediately after line 8, to declare this 'moment' as a variable for subsequent use:

declare var moment; // Include moment in TypeScript

It should look like this in your code..

2. Add your custom code in the dedicated section to set your field value to the 'moment' value. Further down in the Typescript code, add the following line immediately after the '//YOUR CUSTOM CODE BEGINS' line:

this.Packet.DataFields['CurrentDate'] = moment().format("YYYY-MM-DD")+'T00:00:00';

It should look like this in your code..

Note that you can adjust the date format to fit your needs.

Save your card, and you're finished.

Check out our Advanced Custom Cards section for more information about what they are and how to use them:

Submitting a document for scanning

At runtime in Work Manager, when an ABBYY Action runs for a Case, documents attached to the Case can be submitted to ABBYY FlexiCapture for OCR Scanning and the processed output files will be returned and automatically attached to the Case.

In an ABBYY FlexiCapture Action, a user needs to submit a document (or multiple documents) to the ABBYY FlexiCapture engine for processing.

The system will confirm when documents have been submitted successfully.

Last attempt is the time when the document(s) have been submitted to the ABBYY FlexiCapture engine for processing.

Scan Quality Verification

After having scanned a document, decides how confident it is on the quality of the scan of the submitted documents and creates a confidence score.

If the confidence score is above a defined threshold, then no further verification is required and it will process the data and complete the task.

A status message will confirm that further validation is not required:

Once processing is complete, the ABBYY Action will close. Exported files will be attached to the Case and are visible in the Files Card.

If the confidence score is below a certain threshold, further verification is required. A human user must then check the scan before the task can progress further.

Additionally, a reminder text will display in next to the Action status to reaffirm that manual verification must be completed in ABBYY before continuing.

To do this, a user must click on the ‘Verify’ button and will be taken to the ABBYY Verification Station where they can verify the scans of the documents and adjust information as necessary.

Once they are logged in, they will be presented with ABBY FlexiCapture’s Verification Station screen where they can review and adjust information as necessary.

The Verification Station is made up of three sections:

1. The individual pages of the document to be scanned.

2. A close up of the original document to be scanned.

3. The Extracted Output - so the scanned version of the original document.

Text highlighted in yellow in the original document tab is the data ABBYY is unable to read. This is highlighted in red in the Extracted Output.

Certain characters like ‘i’ may also been highlighted in the Extracted Output section if ABBYY is uncertain about the scanned copy.

Once you’ve finished the manual verification, the screen will confirm this has been done but will note that there was an expectation which required manual intervention:‌

‌Once processing is complete, exported files will be attached to the Case and are visible in the Files tab.

You can then mark the Action as complete in the Info Card.

Potential Validation Issues

If the documents submitted were of an invalid file format or if there were problems with the formatting of the document itself, the system will return the following message.

If there has been an issue with document submission, the system will automatically retry submitting a certain number of times, depending on how your system has been configured in Builder (see here for more information).

If there is still a problem with submission following the automatic retries (e.g. if the retry setting is set to 5 and the system fails to establish a connection following 5 automatic retries), the ABBYY Action will move to a state of 'Closed'.

The following Webhooks are currently available in Enate:

• - fires when a Ticket, Case or Action is created.

• - fires when a Ticket, Case or Action is updated.

• - fires when a communication (email or note) is added to a specific work item

• - fires when a COMPANY or a SCHEDULE is created.

• - fires when a COMPANY or a SCHEDULE is updated.

• - fires when a COMPANY or a SCHEDULE, specified within the subscription, is updated.

The sections below give details for the webhooks you can currently subscribe to, a short description of the events which will trigger them, the data you'll get returned from the webhook (with example values for each) and the parameters which are to be passed in.

Packet Created

Packet Updated

NewCommunication

BusinessObjectCreated

BusinessObjectUpdated

SpecificBusinessObjectUpdated

Builder users can set the confidence levels for their Integrations (such as EnateAI's) in the General Settings section. This gives users a greater level of control and flexiility when implementing Integrations into their operations, letting them quickly and easily adjust Integrations confidence levels as needed to allow more of fewer Work Items to be passed via Agents for verification after AI has taken some action.

How to find the EnateAI confidence level settings

Within Builder, go to the General Settings page, then to the 'Integrations' section.

This section allows users to set the confidence Thresholds for all available Integrations which use them. level for:

• Document Classification Integrations

• Email Classifications Integrations

• Document Extraction Integrations

• Thank You Email Integrations

How to set an integration confidence level

To set the confidence level users simply need to move the slider for the desired integration. The higher the confidence implies a greater degree of trust in the results of the integration, while a lower confidence level will see a greater degree of human involvement.

What if an integration is not active?

If users do not have a specific integration activated in the Enate Marketplace, there will be a 'Get This Integration' button displayed instead of the slider. Clicking on this button will take the user to the section of the Enate Marketplace where the Integration offerings for that confidence level option are.

Integrations that do not have confidence levels

For Integrations that do not work with Confidence Thresholds, no sliders are provided. Examples of this are Sentiment Analysis and Email Data Extraction Integrations.

Other integration technology providers

These confidence threshold sliders control the threshold levels for ALL Integration patterns, no matter which technology provider has been enabled for it in Marketplace.

What is a Webhook?

A webhook (also called a web call back or HTTP push API) is a way for an application to provide other applications with real-time information. You can use Webhooks for more seamless integration with your other systems.

You can subscribe to webhooks so your systems are notified of events in Enate as they happen, allowing you to get data immediately. This makes webhooks much more efficient for both provider and consumer. An example might be if a new Case gets created – if this happens then Enate will send a request to your system to let you know.

It's important to be familiar with Webhooks before embarking on using them. You can check out a list of the Webhooks currently available in Enate:

APIs exist in Enate to allow you to get information about the available Webhooks and their structure, and to subscribe / update / unsubscribe from them. A quick example of this would be the . Check out the details for this in the API Webhook Subscription section:

Make sure to check out our sample Webhook integrations section here:

This sections contains common webhook troubleshooting questions to help with any general queries you might have:

You can also check out some of the questions to help with any general queries you might have.

Webhook Authentication

Authentication for creating or updating a Webhook subscription is the same as for any other Enate API, the user account creating the subscription must have the Process Builder role as well as permission to access data related to the requested entity (Customer, Contract etc.). Authentication is required at various points when using Webhook . There are two main places where Webhook authentication takes place:

1. On the Webhook Provider side (i.e. Enate):

When the Webhook subscription is created the subscriber needs to provide valid user credentials (as with any other API call) and where the subscription refers to a specific entity (i.e. events related to a Company) the account needs to have permissions on that entity.

2. On the Webhooks Subscriber side (i.e. your systems):

Every Webhook subscription has a GUID which is generated by the provider when the subscription is created. This is then included in the header of all Webhook messages sent out for that subscription to give the subscriber confidence that the incoming messages are legitimate.

Optional - HTTP Header

In addition to the above authentication points, Webhook subscriptions have an optional custom http header which can contain any key/value data the subscriber requires i.e. it could be used to include a further key generated by the subscriber which they can use to authenticate received messages.

Sample Integration Patterns Using Enate's Webhooks

In order to work with Webhooks in Enate, you need to pass certain parameters to the Webhook (see for more information) and you will get a message returned with corresponding information (see below for more information).

Message Returned Explanation

Parameters Required Explanation

Note on creating Webhook subscriptions:

For creating subscriptions, the FilterObjectType and the FilterObjectGUID should match up according to the item you want to receive messages about, i.e. if you want to know about Packets Created for a particular Company then you would use:

• FilterObjectType = 31 (Company in the EnateObjects enum) (Or alternatively Contract = 215, Service = 217)

• FilterObjectGUID = <any valid Company GUID you can access>

• WebHook = PacketCreated

From version 2021.1 the status reasons and resolution methods architecturally support all work items (i.e. Tickets, Cases and Actions), however currently some of them are specific to a Ticket/Case/Action - see below for more information.

Status Reasons

Resolution Methods

UiPath Synchronization V4 supports the latest features of UiPath orchestrator. This synchronization majorly covers the modern folders features which can be widely used for orchestration along with its sub folders.

See here for more information regarding which version of UiPath in Enate works with which versions of UiPath Orchestrator:

Steps to synchronize Enate and UiPath Orchestrator V4

Create a new RPA Sync Connection in Enate

You do this by going to the and selecting the '+' icon to add a new connection. Enter a Name for the connection and from the Technology dropdown select 'UiPath Synchronisation V4'.

In the following pop-up, fill in the following details:

• URL - URL of the UiPath Orchestrator

• Tenant Name - Tenant name for UiPath Orchestrator

• Username - Username for UiPath Orchestrator

• Password - Password used to access UiPath Orchestrator

• Credential Store Name – name of the credential store, used to store robot credentials

Once all the details have been entered, you need to Test the Connection.

Once the connection has been tested successfully, click to enable the connection:

Extracting Details from Orchestrator

Create a user account for your on prem Orchestrator and use these details (URL, username, password, tenant name and credential store name) to establish the RPA connection in Enate.

Restart the application engine

Now go to Enate Manager and open the instance to re-start the application engine:

Log in to On Prem Orchestrator

Create a machine template by clicking Tenant and then Machines. Click on Add Machine Template

Click Provision after entering the Template name and increasing the number of Licenses to at least 1

Now you need to make sure to check that above created machine shows up in under Tenant -> Machines.

Open UiPath Assistant

Open UiPath Assistant and navigax`te to User Profile > Preferences > Orchestrator Settings.

In the Connection Type dropdown, select ‘Machine Key’ and then in the Orchestrator URL field enter your organisation's on prem orchestrator URL.

Then click to 'Connect'.

Once you are signed in, the Status will now be showing as Connected.

Open UiPath Orchestrator

Now you need to make sure to check that your machine shows up in

Orchestrator. To do this, go back to UiPath Orchestrator and then click on Tenant and Machines.

Select a Folder

Now you need to select a modern folder to assign a robot account to, to assign a machine to and to create an automation process in.

To select a folder, click on Tenant and then click on the Folders tab.

Create a new folder by selecting the New Folder icon.

Create a Robot account

The next step is to create a Robot account. You can do this by navigating to Tenant -> Users -> Add Local User

Click on ‘Unattended Robot’ section on the left side, make sure to enable the toggle ‘Automatically create an unattended robot for this user’ and enter domain\username and password of the account under which this robot runs and click Add.

Assign roles

Now we need to assign roles to the robot account. To do this, click on the folder which we created, and then go to Users --> Settings --> Manage access --> Assign Account/Group.

Search for the robot account we just added and select it from the drop down. Then add a 'Robot' role to the robot account and click on 'Assign'.

Once you have done this, the robot account will appear in the modern folder with its roles.

Assign Machine to the modern folder

You now need to assign a local machine to the folder. Browse to the modern folder created in previous step, navigate to Home -> Machines

Click “Manage Machine in Folder”

Search for machine created in previous step, select and click Update

Now the local machine will show in the modern folder under the Machines tab.

Check Bot and Bot Environment Synced

And now when we go to the Robots section (under User Management) in Enate, you can see that the robot you've just created in UiPath Orchestrator is showing in Enate.

Publish the Project in your Machine

The next step is to publish the the UiPath project in your local machine. To do this, go to UiPath Studio, select the desired UiPath project that Enate will trigger based on Action configuration and click 'Publish'.

And then in Package Name enter the name of project you are wanting to publish and click Next.

Then for the Custom URL click the folder icon and select the folder where you want to save the package and then select 'Publish'.

Upload Package to UiPath Orchestrator

Once the package is published you need to upload it to UiPath Orchestrator. To do this, go to Tenant, select the Packages tab and then click on Upload.

In the resulting pop-up, select the published package from the local folder you have just saved it to and click Upload.

The recently uploaded package should now be visible in the Packages tab.

Create a Process Using the Package

The next step is to create a process using the package you have just published in the previous step.

To do this, navigate to the desired modern folder and then click Automations > Processes > Add Process

Select the package that was just published in the previous step and click Continue.

Add a Display name and a description if you want and then click Create.

Then click on the play button to start the job manually from on prem Orchestrator:

In the following screen, enter the same robot account, local machine and hostname as selected in the above steps and click Start.

In the Jobs tab you can see that the job is now running.

And you can see when the job is completed.

Back in Enate, click to edit the robot that got synced:

And then click to edit the Bot Farm.

Here you need to click on the Integration Process dropdown and select the job you want the Bot Farm to perform:

We now need to configure an Action that can be performed by the bot. To do this we need configure the Bot Farm (from Orchestrator) in an Action's General Settings.

To do this, select to clone the General Settings of the Action and then add the bot farm that we adding in the integration process. You can add the estimated duration for the bot to complete the action if you want.

We then need to adjust the allocation rules for the Action. To do this, select to clone the Allocation rules and then in the Queue field select the desired Queue (we will add the bot to the Queue in the next step).

Set the process live.

Add bot to Queue

Once the process has been set live, as a Team Leader go to the Queues page, click on edit and then add the robot to the Queue you want it to work from.

When the Case process you have just configured gets launched in Enate Work Manager, and when the Action we have just configured gets created, the integration process will be triggered.

When the Action is created and pushed to a Queue that has the desired deep-integrated robot, it sends a message to UiPath Orchestrator to get a job ready for the selected integration process for the selected robot.

You will be able to see when the job triggered from Enate has completed successfully.

To set up Enate and UiPath, you'll need to go through the following steps in order:

1. Setting up UiPath Studio

You'll first need to set up UiPath studio. The following video will take you through how to do this.

2. Setting up the Enate Activity Library in UiPath Studio

Now you need to set up the Enate Activity Library in your installation of UiPath Studio. Watch the following video to find out how to do this:

3. Adding a UiPath Connection in Enate

In the following page click on the '+' to add a new connection.

In the following pop-up, fill in the following fields:

Depending upon which technology you choose, the following fields may also need to be filled in.

To enable a connection, the connection has been tested successfully first. Click to 'Test Connection' which will run a live connection test and when a successful response has been detected, the connection will be enabled.

You can see details about the connection test in the Connection Logs tab.

Editing a UiPath Connection

You can edit an existing UiPath connection by going to the Marketplace section in Builder and clicking to 'Update' UiPath Orchestrator.

When editing a connection, you are also able to see the activity history of the connection by clicking on the Show Activity button. You can see when the connection was created and by who and you can see if any subsequent edits have been made, when they were made and by who.

You can choose to disable any of your Email-related Integrations for specific Mailbox Connectors, so the Integration doesn't run for any emails coming in to that specific mailbox. This more flexible steup lets you implement new AI technology while safeguarding specific work activities which you want to keep running as-is.

How to Disable and Re-Enable EnateAI Integrations per Connectors

When an Email-related Integration is activated in the Enate Marketplace, it is automatically applied to all email connectors. However, in certain scenarios, users may only want certain Email integrations to apply to certain email connectors. To disable integrations for a specific connector users should go to the Connectors page in the Email section of Builder. There they will see a new column titled 'Integrations', which will show the total number of Integrations available, and the number of those which are switched on for that Connector, e.g. '3/4' will mean that 3 of the 4 email integrations are running.

To disable / re-enable integrations for a specific connector simply click on the relevant link in the 'Integrations' column box for the desired connector. This will bring up the 'Edit a Connector' pop-up, showing all activated Email integrations for that connector.

Toggle the settings on / off as desired to enable / disable an Integration. Please note the following:

• Whenever a new email connector is created, ALL integrations that are active in Marketplace will automatically be activated for the new connector.

• Whenever an Integration is enabled in Marketplace for a certain Email Integration pattern, e.g. 'Sentiment Analysis', it will be switched on for ALL Connectors. If an EmailAI pattern gets switched off in Marketplace and subsequently turned back on, it will be active in all connectors once again.

Outgoing Connectors

Email Integrations cannot be turned on for email connectors that are just for outgoing emails, since currently these integrations are only relevant for incoming emails. For these connector an 'NA' will be displayed in the 'Integrations' column.

Q: In the event of the external system being down, or a failure response, does the Enate system retry? A: YES. The Enate system will retry failed messages 3 times.

Q: Is there a possibility of duplicate events? A: YES. Duplicate events can occur, for instance multiple updates to a work item occurring in quick succession, or when an email is received (which triggers a 'new email received' webhook and may very likely then trigger the packet update API too, if incoming email will change the work item's current state.

Q: Is there a standard response structure for Enate Webhooks? A: NO. Response structures can be different between Webhooks. Please see the list of Enate's Webhooks for the specifics of each response structure.

Q: If I've unsubscribed from a Webhook, what is the procedure for re-subscribing. Is there some kind of 'reactivation' approach? A: NO, this is a simple case of adding a subscription again, as you did when first subscribing to it.

Q: Is it mandatory to supply an Entity for a Webhook? A: No. This is dependent upon the Webhook. In some situations it is mandatory, in some optional, and in others there isn't such a filter option.

Q: Can the same subscriber URL be used in multiple subscriptions? A: Yes, it is possible for the same subscriber URL to be used in multiple subscriptions. However, it may be preferable to create different URLs for each subscription to prevent bottlenecks and to create more logical routes for messages into downstream systems.

Q: How can I identify whether the Webhook update is for a Case or Ticket or Action? A: The ProcessType field will indicate the type of packet i.e. 1= Case, 2=Ticket, 3=Action but a more informative approach would be to add some identifying information to the custom header when creating the webhook subscription, this header information will then be included with every message sent out i.e.:

• "CustomHeader": " Update-ticket-200243-T-subscription"

• "CustomHeaderValue": "Ticket 200243-T has been updated "

Q: Can Webhook Subscriptions be seen by other users? A: Webhook Subscriptions are per user and the permissions of that user are applied to the messages that are sent so, depending on permission configurations, not all users will be able to see all Webhook Subscriptions.

Q: In which scenarios will a New Communication event be triggered for a packet ? A: A New Communication event is triggered whenever a new Packet Communication is written to the database. A Packet Communication may be:

• A note written by Agent

• A note written in Self Service

• An email coming in

• An email going out

• An existing email being “duplicated” onto another Work Item (for instance a Ticket merge into a Ticket/Case/Action causes a “new” email in the target work item)

Enate UiPath Activity Library - Overview

The Enate Workflow Activity Library allows easy integration with Enate’s enterprise workflow engine. It allows bots to get work from the Enate platform, edit the data, add or download files and update the Enate platform. We can also create new work items on the Enate platform using the activities.

The .Net Workflow Activity library allows easy integration with Enate v2021.1 and above. The Activities will perform authentication when necessary and allow a single authentication token to be passed between concurrent calls to improve performance.

Authentication will be done through the Authenticate Activity. This will return an Authentication Token which can then be passed to the other Enate Activities.

All date/time values are passed in UTC and each Enate Activity has a standard set of 4 arguments:

• PlatformURL (String) - This should be set to the URL of your Enate instance, as you would type in a portal to get to the login page. e.g. https://hosting.enate.net/MyInstance

• Username (String) - Any valid Username for your Enate instance. Only required if AuthenticationToken is not set or has expired.

• Password (String) - The current Password for the user account specified in Username. Only required if AuthenticationToken is not set or has expired.

• AuthenticationToken (String) - After an initial call to an Activity has succeeded its authentication token can be reused if the next call is made within the configured timeout window. The timeout is configured per customer instance so please check your token validity duration with Enate Support.

Each successful Activity will output a new AuthenticationToken that resets the timeout window.

All activities can be found in the Activities panel, under Enate > Workflow > Activities.

These activities enable you to build complex rules for interacting with the Enate platform combining them with UiPath’s built-in functionality for if/else or switching to make conditional decisions for powerful workflows.

You can find all of Enate's Activity Libraries in the sections below, as well as explanations of each of the activities available.

Check out the setting up the Enate Activity Library in UiPath Studio section which details how to install this file in UiPath Studio to get access to Enate's dedicated Activity library.

Latest Enate Activity Library

Activity Library v1.3.3

Changes made as part of this release is:

• Fixed a bug related to CreateCase and CreateSubCase Activities.

Activity Library v1.3.1

In this version we have fixed the CreateCase and CreateTicket activities to add Service Agents contact while creating Case or Ticket - Previously while creating a Ticket or Case We were allowing only external contact to be added whereas Now users should be able to add service agent contact and external contacts as well.

Activity Library v1.2.19

This release focuses on supporting workflows in Windows Legacy which is in sync with the release of version 2024.1 of Enate. In this version, we have fixed the CreateCase and CreateTicket activities to add Service Agents' contact while creating a Case or Ticket.

This version of the UiPath package only works with version 2024.1 and above of Enate and is the final release for Windows Legacy Previous Activity Libraries

Previous Activity Library

Activity Library v1.3.0

This release focuses on upgrading workflows from Windows Legacy to Windows.

Activity Library v1.2.18

In this release we have updated the GetCommunications and SendEmailCommunication activities to align with the updated APIs in Enate following the most recent product release.

Activity Library v1.2.13

In sync with the release of version 2022.5 of Enate and the customer GUID field in the /Packet/GetContexts API being made mandatory, the GetTicketProcess, GetCaseProcess, GetCaseProcesses and GetCaseAttribute activities have been updated.

Note that the GUI for the GetCaseProcess activity is yet to be finalised, but users can still enter property fields in the Properties window on the right.

Also note that for the GetCaseProcesses activity, the Customer Name property has now been made mandatory.

Activity Library v1.2.8

You can download the Enate UiPath Activity Library v1.2.8 from the links below. In this version we have improved saving work item communication attachments. Previously when saving an email attachment, if a special character(s) was present in the file name, the special character(s) would be replaced by an empty space upon saving. Now when saving email attachments with special character(s) in their name, the name of the file is not changed - the special character(s) are included.

Activity Library v1.2.5

In this version we have added a new field in the CreateCase and CreateTicket activities called ‘Do Not Send Automated Emails’. When the Boolean value is set to True, the request acknowledgement email will not be triggered/sent. When the Boolean value is set to False or the field is left empty, the request acknowledgement email will be triggered/sent.

You can download the Enate UiPath Activity Library v1.2.5 from the links below.

Activity Library v1.1.9

Below is a copy of the Enate UiPath Workflow Activity Library for v1.1.9. In this version we have fixed the ‘AttachFile’ activity - previously it was mandatory when attach a file to a work item for the file to have a file tag whereas now users are able to attach a file to a work item with or without a file tag.

Activity Library v1.1.8

Below is a copy of the Enate UiPath Workflow Activity Library for v1.1.8. In this version we have added the Nito.AsyncEx library within the latest UiPath package so that you no longer need to add it manually.

Activity Library v1.1.4

Below is a copy of the Enate UiPath Workflow Activity Library for v1.1.4:

Activity Library v7.3.12

Below is a copy of the Enate UiPath Workflow Activity Library for v7.3.12:

Activity Library v7.3.10

Below is a copy of the Enate UiPath Workflow Activity Library for v7.3.10:

Activity Library v7.3.7

Below is a copy of the Enate UiPath Workflow Activity Library for v7.3.7:

Enate UiPath Connector v7.3.7 works best with v2021.1.

The key updates for this connector are:

• Ability to add file tags and contact tags to Cases and Tickets

• Ability to launch a Case linked to a Schedule

• Ability to launch ad-hoc Actions

• Ability to extracting communications and saving the communication attachments locally

• Ability to attaching files to Cases, Tickets and Actions

In v2021.1 bots can access Builder APIs to get contact tags, file tags etc. To enable this:

Edit the bot in User management

Update the bots access permissions and save

Activity Library v7.2.10

Below is a copy of the Enate UiPath Workflow Activity Library for v7.2.10:

Activity Library v7.2.9

Below is a copy of the Enate UiPath Workflow Activity Library for v7.2.9:

Activity Library v7.1.1

Below is a copy of the Enate UiPath Workflow Activity Library for v7.1.1:

Two GET operations and three POST operations are present under Webhook Subscription. These are the API for the client to consume and subscribe to the webhooks.

GET Operations

• Get All Webhook Subscriptions - use this to get a list of all available webhooks you can subscribe to.

• Get Webhook Subscriptions - use this to get more details for a single kind of subscription.

Get All Webhook Subscriptions

Path /WebHookSubscription/GetAllWebhookSubscriptions

• Type: GET

• Function: Returns a list of all Webhook Subscriptions

• No parameters required

• Expected Response – list of subscriptions in the following format:

[
  {
    "GUID": "00000000-0000-0000-0000-000000000000",
    "Webhook": "PacketCreated",
    "FilterObjectGUID": "00000000-0000-0000-0000-000000000000",
    "FilterObjectType": "None",
    "SubscriberURL": "string",
    "Signature": "string",
    "CustomHeader": "string",
    "CustomHeaderValue": "string"
  }
]

Get Webhook Subscription

Path: /WebHookSubscription/GetWebhookSubscription

• Type: GET

• Function: Returns detail of a specific Webhook Subscription

• Parameter to set: webhookSubscriptionGUID

• Parameter values: GUID value present in GUID column of tblWebhookSubscriptions table.

Expected Response – a single subscription in the following format:

[
  {
    "GUID": "00000000-0000-0000-0000-000000000000",
    "Webhook": "PacketCreated",
    "FilterObjectGUID": "00000000-0000-0000-0000-000000000000",
    "FilterObjectType": "None",
    "SubscriberURL": "string",
    "Signature": "string",
    "CustomHeader": "string",
    "CustomHeaderValue": "string"
  }
]

Response Code: 200 :

Expected Response in case of invalid GUID: Response Code:400 - Bad Request The response should contain the below message: ‘The request is invalid’ Request:

POST Operations

• Subscribe to Webhook - use this to subscribe to an individual webhook.

• Update Webhook Subscription - use this to update an existing subscription to an individual webhook

• Unsubscribe - use this to permanently delete an existing subscription for an individual webhook.

Subscribe to Webhook API

Path: /WebHookSubscription/SubscribeToWebhook

• Type: POST

• Function: Used to create a new subscription and the API returns the details of newly created

• Webhook Subscription

• Parameters:

  Copy

  {
    "Webhook": "PacketCreated",
    "FilterObjectGUID": "00000000-0000-0000-0000-000000000000",
    "FilterObjectType": "None",
    "SubscriberURL": "string",
    "CustomHeader": "string",
    "CustomHeaderValue": "string"
  }

Expected Response: Response Code:200 Expected Response – subscription data in the following format:

[
  {
    "GUID": "00000000-0000-0000-0000-000000000000",
    "Webhook": "PacketCreated",
    "FilterObjectGUID": "00000000-0000-0000-0000-000000000000",
    "FilterObjectType": "None",
    "SubscriberURL": "string",
    "Signature": "string",
    "CustomHeader": "string",
    "CustomHeaderValue": "string"
  }
]

The signature should be added by the server when the subscription is created and then included in the webhook messages which are sent out.

Update Webhook Subcription

Parameters and response as for SubscribeToWebhook plus the GUID of the WebHookSubscription to update

Unsubscribe (Delete Webhook Subscription)

• Takes a Webhook subscription GUID as the only parameter.

• Permanently deletes a subscription from the database.

API: Webhook Test-Simulate Event

A GET API called Simulate Event is present under Webhook Test.

• Parameter: any valid webHookSubscriptionGUID

• Creates a test WebHook message for a provided webHookSubscriptionGUID

General API Validations

Authorization

When an unauthorized request is sent, the APIs need to show a message stating ‘Authorization has been denied for this request’. Below is the response in case of an unauthorised request:

Quick steps to vaidate authorization:

1. Open the Swagger UI

2. Do not login to the test instance

3. Send a request with all the valid details

4. API throws an error saying Authorization has been denied

5. Login to the test instance

6. Retry the same request

7. API returns successful response as the request is authorized.

Invalid Requests

When an invalid request is submitted, the APIs need to return 400-Bad Request Error and display a message stating, ‘The request is invalid’. Below is the response in case of invalid requests:

General scenarios where bad request error is seen are mentioned below:

• Wrong/Incorrect GUID values

• Syntax errors in the Request json

• Non existing values

Overview

This section gives an overview of how to integrate Enate with the UiPath Orchestrator. It provides steps on how to establish a connection between UiPath Cloud Orchestrator and Enate.

UiPath Orchestrator is a web application that enables you to orchestrate our UiPath robots in executing repetitive business processes. Orchestrator lets you manage the creation, monitoring and deployment of resources in our environment. It acts as an integration point with third-party solutions and applications.

Enate’s process orchestration platform simplifies the process from start to finish, ensuring the right worker does the right thing at the right time. It streamlines the management and governance of large-scale processes involving digital, human and hybrid workforces.

There is a dedicated section available in Enate Builder to configure a bot Action where as soon as the bot Action is launched in Enate, it sends a message to the UiPath Orchestrator which creates a job in Orchestrator. Orchestrator then invokes the machine/bot to perform the action defined in the bot routine.

Enate has a dedicated RPA section available in the Builder, where we can create and maintain the connections to Orchestrators. Within this section, we can configure multiple UiPath Orchestrators with which the Enate environment can be synchronised.

UiPath Orchestrator Sync Settings

This document provides information regarding which version of UiPath in Enate works with which versions of UiPath Orchestrator:

Check out this explainer for how you can get your client apps to automatically receive real-time updates from Enate, such as from new Cases, Tickets and communications, via Webhook subscriptions. It will also show you how you can make additional updates into Enate from the client app itself.

Check out our Webhooks section for more information about Enate's Webhooks and how to use them:

Overview

Our 'Email Data Extraction' pattern, available in Marketplace in Builder auto-populates important information from emails into custom cards in your Tickets and Cases, saving agents from having to do this manually

This pattern is available via the following providers:

• EnateAI

• OpenAI GPT3

• Azure OpenAI GPT3

EnateAI Setup

EnateAI is a zero configuration option supplied by Enate which uses our own Azure hosted OpenAI Instance for the GPT3 Engine.

This instance is shared with anyone that enables EnateAI so if you have high volume/high demand then you may be better off configuring your own Azure Open AI instance and using an Azure Open AI Adapter Version.

The setup of EnateAI for all patterns is super simple - simply click to activate.

OpenAI GPT3 Setup

OpenAI Adapters allow you to talk to the OpenAI API directly via your own OpenAi account and API keys, this will be using the OpenAI API which is open to everyone. You can also monitor usage of API requests sent via this API in the OpenAI interface.

To setup OpenAI for Email Data Extraction, follow these steps:

1. Click on 'Activate' on the 'OpenAI GPT3 - Email Data Extraction' option in Enate Marketplace.

1. In the resulting pop-up, enter the following information:

• the URL of the instance - this is the base URL for OpenAI, i.e. https://api.openai.com/

• the API key - this you can create from the OpenAI API keys page https://platform.openai.com/account/api-keys

1. Click to test the connection

2. Once the connection has been successfully tested, click to activate. Your Email Data Extraction pattern provided by OpenAI is ready to be used.

Further notes of interest

The OpenAI API keys page is where you can create further API keys and manage your existing ones.

You can monitor the usage and breakdown of requests of the OpenAI account on the OpenAI Usage page:

Azure OpenAI GPT3 Setup

AzureAI allows you to use your own Azure instance of OpenAI which you can manage and control, giving you a great deal of control and detail of the information going through the API.

To setup Azure OpenAI for Email Data Extraction, follow these steps:

1. Click on 'Activate' on the 'Azure OpenAI GPT3 - Email Data Extraction' option in Enate Marketplace.

2. Enter the following information, all of which can be gathered from your Azure OpenAI instance, in the resulting pop-up:

• Resource Name - this is the Azure Resource Name which can be found by navigating to your OpenAI Cognitive Services in Azure, accessing your Azure OpenAI Resource and opening the resource. The resource name can be found in the overview page, next to 'Resource group'

• Deployment Name - to find this, go to the 'Model deployments' section in Azure OpenAI studio and then click on 'Manage Deployments'.

Then click on the 'Deployments' section on the left and the deployment name will appear on the right - this is the value you need.

• API Key - this is configured back in the OpenAI Portal, from the 'Keys and Endpoints' section on the left. This is where you can generate new keys and manage existing ones. Enter one of these keys.

1. Click to test the connection

2. Once the connection has been successfully tested, click to activate. Your Email Data Extraction pattern provided by Azure OpenAI is ready to be used.

Overview

Enate supports a number of RPA technologies including UiPath, Blue Prism, Automation Anywhere and Power Automate.

With Enate you can easily integrate Blue Prism with Enate’s enterprise workflow engine to enable bots to get work from the Enate platform, edit the data, add or download files and update the Enate platform. You can even create new work items on the Enate platform using the VBO Action.

You can find out how to integrate Enate and Blue Prism here:

Click here for information about Enate's Blue Prism Connectors.

You can download version 7.0 of Blue Prism by using the following link:

In the Typescript section of a Custom Card you can add your logical calculation or validation code related to work items and data fields.

In many circumstances you will also need to add validation. The best way to add validation is by using the ngOnInit method. Once you submit a work item it will be checked for any validation errors. If there is a validation error, the work item submission will be paused until the error is resolved.

If you look at your Typescript you will see that there are few lines of code which have been created by default, as well as a few properties such as Option, Packet and IsExpanded.

1. Option - The Option property contains two properties: Packet and Card.

   Card - This property contains the information about the card including which fields are attached to this card.

   Packet - The Packet property contains all the information related to the work item. Use your Swagger UI, available for your instance at (https://<your-work-manager-url>/webapi/) and look for the following APIs to see further details: Case/GetCase Ticket/GetTicket Action/GetAction

In your Typescript section there will be generated/auto- code and it will also contain following ngOnInit method:

ngOnInit() {
        //YOUR CUSTOM CODE BEGINS
        
        //YOUR CUSTOM CODE ENDS
}

Now let us take a few examples to understand how we can add runtime validation.

1. Required Validation

ngOnInit() {
        //YOUR CUSTOM CODE BEGINS

        this.Option.Card.Validators.push(function (packet, card) {
            // YOUR VALIDATION
            const errors = [];
            if (
                packet.DataFields.Policy === null ||
                packet.DataFields.Policy === ""
            ) {
                errors.push('Please enter a policy number');
            }
            return WorkItemValidator.ERRORS(card, errors);
        });

        //YOUR CUSTOM CODE ENDS
    }

2. Range Validation

ngOnInit() {
        //YOUR CUSTOM CODE BEGINS

        this.Option.Card.Validators.push(function (packet, card) {
            // YOUR VALIDATION
            const errors = [];
            if (
                packet.DataFields.Policy > 0 ||
                packet.DataFields.Policy < 9999
            ) {
                errors.push('Policy number must be between 1 - 9999.');
            }
            return WorkItemValidator.ERRORS(card, errors);
        });

        //YOUR CUSTOM CODE ENDS
    }

3. Complex Validation

ngOnInit() {
        //YOUR CUSTOM CODE BEGINS

        this.Option.Card.Validators.push(function (packet, card) {
            // YOUR VALIDATION
            const errors = [];
            if (packet.ProcessType === 1) { //for case type work item
                if (
                    packet.DataFields.Policy > 0 ||
                    packet.DataFields.Policy < 99
                ) {
                    errors.push('Policy number must be between 1 - 99.');
                }
            } else if (packet.ProcessType === 2) { //for ticket type work item
                if (
                    packet.DataFields.Policy > 100 ||
                    packet.DataFields.Policy < 199
                ) {
                    errors.push('Policy number must be between 100 - 199.');
                }
            } else { //for action type work item
                if (
                    packet.DataFields.Policy > 200 ||
                    packet.DataFields.Policy < 299
                ) {
                    errors.push('Policy number must be between 200 - 299.');
                }
            }

            return WorkItemValidator.ERRORS(card, errors);
        });

        //YOUR CUSTOM CODE ENDS
    }

Metabot Installation

Follow these steps to sync Automation Anywhere with Enate:

Logged into Automation Anywhere, click on the MetaBots icon.

Click on 'Edit', then select 'Locate on Disk'. Then paste Enate Metabot to the opened location path

Now you're all set up, you can find our latest Metabot Logic Library here:

In Enate you can add custom content into your Tickets, Cases & Actions. This custom content is displayed via Custom Cards which can be set to display in the main section of the work item, and also as a section of the side panel on the right side of the screen.

You can instantly create cards of your custom data fields or you can create Advanced Custom Cards that can be designed with HTML, JavaScript or CSS to show richer content such as external systems & webforms.

To create an Advanced Custom Card, select the 'Advanced' option in the Custom Card screen. This will allow you to add HTML, Typescript and CSS.

You will first be presented with a warning message highlighting that you're responsible for the errors / unexpected behaviour that may occur from your bespoke code.

You can revert back at any time by switching the customized setting back to off - this will remove any custom code and return the card to its original form.

Check out the following sections for explanations for how they are structured plus some examples of standard content you may wish to use..

You can check out our Github section that provides you with sample code integrations for Advanced Custom Cards here:

Overview

Creating a Process

The following diagram shows what a basic integration with Enate should look like using the Enate VBO. It should follow the logic of:

• Authenticate Pass credentials to Enate and get a token, this will be used in all future calls to Enate.

• Get More Work This action will return a small JSON object with details on what the next piece of work is.

• Get Action This will get the full JSON object representing the piece of work assigned to the bot (assuming it’s an action)

• {process object using BP commands/actions or the Enate JSON Get/Set} - this is where you are going to manipulate the JSON object before updating this back to Enate. Change status, add notes, send email etc.

• Update Action This action will send the updated JSON object back to Enate for updating.

• Is Work Available This last stage is to check if there is any more work for the bot to process, if there is then go back to the start to Get More Work

There are lots of different things you can do with the Enate VBO, this is one example. You could also have a process which could iterate through an excel document and create a case/ticket in Enate for each row in the document. This would not use the get more work action and would use a combination of the BP looping along with the Enate Create Ticket action. The Get more work action is used where you are asking Enate for work and you should then keep checking until there is no more work to do. The bot can then rest until it’s next scheduled time to run.

Publishing a Process

In order for you to be able to schedule the process you need have published it to the control room.

If you double click on the process information box (or right click choose properties)

Then you will get the process information windows displayed. At the bottom of this screen there is a checkbox you need to ensure is ticked:

This process will then be available to schedule in the control room.

Scheduling a process

Now head to the Control section of Blue prism which looks like this:

Right click on schedules and choose new schedule:

Now give it a name and configure how often you want this schedule to run:

After you have configured this, you’ll notice on the left in the tree there is a new task under the schedule:

Click on this task and then we need to configure the process we are going to run and what resource to run this on:

You need to drag the process onto the relevant resource:

This will then create an entry at the bottom to show this is a scheduled session:

Click the apply changes button at the bottom left to ensure the schedule is saved:

If you click on the timetable in the tree you can see that the task is now scheduled to run:

Overview

Enate supports a number of RPA technologies including UiPath, Blue Prism, Automation Anywhere and Power Automate.

Enate provides easy integration with Automation Anywhere via the Automation Anywhere Mbot connector. This enables bots to get work from the Enate platform, edit the data, add or download files and update the Enate platform. Additionally, new work items can be created on the Enate platform using the Automation Anywhere Activity.

We have an online swagger API documentation to help when you need some assistance with the JSON structure returned from any of the metabot Actions. This will help you to understand parts of the DTO and how to populate and what data types are required for each part of the DTO:

Getting Started

You can find out how to set up Enate and Automation Anywhere to start including Enate activities in your bot routines here:

Latest Version

The latest version of Automation Anywhere supported by Enate is version 11. This version is compatible with version 2022.5 and above of Enate.

You can download the Automation Anywhere Metabot Logic Library for version 11 here:

UiPath Cloud Synchronization V2 supports synchronisation with classic folders in UiPath Cloud Orchestrator.

See here for more information regarding which version of UiPath in Enate works with which versions of UiPath Orchestrator:

Synchronization between Enate and Uipath orchestrator

In Enate, we have a dedicated RPA section available in the Builder, where we can create and maintain the connections to Orchestrators :

Within this section, we can configure multiple UiPath Orchestrators with which the Enate environment can be synchronised.

Details Required to Configure a Connection

To add a new connection, click on Add Connection, give a name to the RPA connection based on the release version select the relevant technology (here we have selected the technology as UiPath cloud synchronization V2). The popups are dynamically launched according to the RPA Technology selected.

To establish a connection, we need below details:

• URL - URL of the UiPath Orchestrator

• Account Logical Name - Account logical name for UiPath Orchestrator

• Client Id - Client Id for UiPath Orchestrator

• Folder Name - The name of the folder

• Tenant Logical Name - Tenant logical name for UiPath Orchestrator

• User Key - User key for UiPath Orchestrator

• Credential Store Name – The name of the credential store, used to store robot credentials

Extracting Details from Orchestrator

Login into UiPath Orchestrator with the username and Password.

To get the details required to establish the RPA connection, click on admin (on the left-hand side) and then go to Tenants.

Expand the Tenants, click on the ellipses on the right-hand side of the orchestrator, select API access, copy the User Key, Account Logical Name, Tenant logical Name, Client Id and paste it in the desired sections of RPA connection in Enate

Copy and paste the relevant data in the relevant fields of the below-highlighted section.

To create or access the folders, select the orchestrator (on the left side) and then go to tenants, click on the folders tab, we can use an available folder or else can create a new one. (As of now Enate supports only the classic folders).

Copy and paste the folder name in the below-highlighted section of the RPA connection.

To get the credential store name, go to the credential stores tab in the Uipath orchestrator, copy and paste the credential store name in the dedicated section of the RPA connection (as shown below).

Test the connection and enable it, once the connection is successful.

After establishing the connection, we need to connect the machine to the orchestrator. To do that, go to the machines tab in the tenant, and then click on add a new standard machine, basically the name of the machine will be the laptop’s name (Open the Control Panel. Click System and Security > System). Give License as 1.

The next step is to create a Robot, Click on the folder which we created and then go to the Robots tab, click on Add robot(standard). Provide the Machine name, name of the robot, select the type (Non-Production), domain name/Username (the one which we use to login into the system), the password is the password used for logging into the system and the credential type will be windows.

Once the Robot is created, we need to create the Environment, (environment is the bot farm that we create on Enate), click on Add environment, give the name to the Environment, and click on create.

Since the connection between Enate and UiPath orchestrator is already established, environments and robots will be synced into Enate automatically.

In the Assets section, Enate will sync the environment URL and robot credentials.

And now when we go to the Robots section (under user management) in Enate, we can see the bot farm and the robot’s name.

Once the machine is connected to the orchestrator the relevant folder will appear at the bottom of the routine as shown below screenshot. (e.g., Amidha Folder).

In the Main file of UiPath Bot Routine, below Routine is published.

Get credential activity is used along with Enate activities. The output from getting credential activity will be username and password which is synchronized with Enate and UiPath orchestrator which will then be used for authentication of bot into Enate instance.

Username is the Username of the Bot created in Enate and password is the password created in Enate and it is a secure password. So Please tick the checkbox of “Secure String “ in Authentication.

The next step is to publish the Main file of the UiPath bot routine, to do that, select the package name that needs to be published. (Publish will publish the process in the relevant folder)

Once the package is published, go to the folders in the Uipath orchestrator, and then go to the Automations tab, click on Add Process. In the Package source name, select the package which was published recently.

Go to the Robots in the User management tab on Enate, select the Bot Farm and define the integration process. (In the Integration process user needs to select which process needs to be triggered when the Action for the Bot Farm is available to work on)

Enate Process and Queue Configuration

Builder Configuration

In Builder, we now need to configure an action that can be performed by the bot. To achieve that we need to go configure the Bot Farm in the Action General Settings in the Action Info.

In the general settings, the user needs to define the bot farm (can be performed by Robotics Group) and the estimated duration for the bot to complete the action.

Adding Robots to the Queue

Team Leaders are the only people who can access the Queues Page. To add the robot to the queue, navigate to the queues section from work manager, click on edit and then add the queue in which the bot needs to be added.

Once the respective queue is added, click on the ‘+’ icon on the queue and then add the robot.

The below screenshot explains how to add a robot to the queue.

As shown in the below Screenshot, the bot is now added to the queue.

Manage Page View and Running a Work Item

Once a Bot Action is launched in Enate, it sends a message to the UiPath Orchestrator which in turn creates a job in Orchestrator (which is available in Automation’s tab in UiPath Orchestrator). Orchestrator, then invokes the bot to perform the action defined in the bot routine.

Team Leaders can see the bot farm and the current status of Bots in the Work manager.

In the above screenshots, there is an action that is available for a bot to perform. When the Bot Routines executes the bot will get the action. If there are multiple work items then the bot will get the single most important piece of work based on the SLA.

We can now see that the Action is completed by the Bot which was created in the Uipath orchestrator and synchronized in Enate.

Enate Integration Architecture

Enate supports a number of RPA technologies including UiPath, Blue Prism, Automation Anywhere and Power Automate.

Enterprise organisations need to connect large numbers of business applications together to build their technology stack.

Currently, the best practice recommendation for enterprise architectures is to use a Composable Architecture approach. The headlines from Gartner’s latest paper, “Future of Applications: Delivering the Composable Enterprise,” help give some insights into this:

• A Composable Enterprise is an organization that can innovate and adapt to changing business needs through the assembly and combination of packaged business capabilities.

• Packaged business capabilities will be sourced from third parties or composed internally. They will deliver more unique and customized application experiences to application users.

• To enable the composable enterprise, organizations will need to adapt the way they source and deliver applications as vendors deliver more modular capabilities.

What does this mean for your Enate implementation?

Running a Composable Architecture means using a decoupled architecture rather than creating a very tightly coupled integration directly between Enate and each individual Line of Business system. This decoupling is achieved using specialist integration components that are tailored to the job.

Microsoft Power Automate is a citizen developer integration platform designed for precisely this purpose. Enate links seamlessly with Power Automate provide giving you the power of Microsoft’s standard connectors with Enate managing the end-to-end process orchestration for business users.

MS Power Automate provides out-of-the-box integrations for a huge number of the most widely used business applications such as SAP, Salesforce, and Workday. A full list can be found here- and is growing every day. Bringing MS Power Automate to bear reduces setup time and simplifies the approach to integration; the drag and drop interface provides a low-code approach to integration.

Example - Enate Orchestrates SAP Integration wth Power Automate

This example shows you how Enate updates to SAP by triggering Power Automate:

1. Invoice extraction & validation (which may be manual or through Intelligent Document Processing) creates a new work item in Enate with invoice details and line-item detail.

2. Enate then posts an API call to MS Power Automate, passing through all data which Power Automate needs to update the target system. Enate also provides a call-back URL, allowing Power Automate to update Enate on progress.

3. MS Power Automate then updates SAP with all relevant data using the standard connector calling either SAP’s BAPI or RFC interface.

4. If the update fails, Enate’s in-built ‘airbag’ features kick in and bring a human user into the loop to manage the situation and ensure the transaction is corrected.

The Power Automate SAP connector allows both BAPI and RFCs to be called on either SAP S4HANA or SAP ECC. In both cases, the On-premise Data Gateway should be installed, giving Power Automate appropriate access to SAP. Authentication can either be through SAP authentication or Windows authentication.

MS Power Automate Licensing

Typical cost for running 5 MS Power flows triggered from Enate for 100 invoices per day would be c$500/month.

Configuring Enate Case to call Post url

At runtime, Enate will call the above URL, passing in relevant data for the activity. A sample of the kind of information which would be passed is shown below:

Sample Integration Patterns Using Power Automate

In the CSS section can define your stylesheet information.

The HTML section is where you can build your UI. We recommend visiting following articles in the Angular.io help files first to learn about how templates work.

Custom Card Directives - View & Update Data Fields

We have created a few directives for different data type fields which allow you to see and update the data field value. Please note that this directive is compatible with the 'disable state', meaning that if a work item is not editable then such fields will be in read-only mode and the user will not be able to update data field values.

1. For Boolean Fields

2. Date & Time Fields

3. Email Address Fields

4. List Field

5. Long Text Fields

6. Number Fields

7. Text Fields

Sample HTML Code

Here are a couple of examples of HTML code you can write within a Custom Card

1. Add Input control for text field with basic HTML input control:

2. Add Input control for text field with directive control:

Check out this explainer for how to use Power Automate to search for the latest email from an Enate Case work item, and then extract that Email and its attachments to a SharePoint directory.

You can even download this Power Automate flow from Enate's GitHub page to get you up and running quickly with this:

Check out our Power Automate section for more information about how to integrate it with Enate here: