Communications Mining Dispatcher Framework

The Communications Mining Dispatcher Framework is an officially supported UiPath® template that fast-tracks the development of projects using Communications Mining.

This framework simplifies the consumption of a Communications Mining stream. Check the streams page. After entering the configuration information and business logic, the framework handles stream consumption and Orchestrator queue creation.

Note: Make sure you have configured your stream in Communications Mining. Check the steps in the Create a stream page.

You can access the framework directly from Studio, under the official templates.

Configuration

Start by configuring the settings within the Config.xlsx file in the Data folder. There are 5 settings in the Settings tab:

Setting	Description	Notes
CommunicationsMiningProjectName	The name of the project containing your dataset	N/A
CommunicationsMiningDatasetName	The name of the dataset containing your stream	N/A
CommunicationsMiningStreamName	The name of your stream	N/A
RunContinuously	Set to True, to keep the process active when the stream is empty	Continuously poll, waiting for new communications to be added to the stream
PollWaitTime	The pause in seconds between stream polls	Only applicable when running Continuously

Note: Ensure you use the API names of your project, dataset and stream. For a correct running of the process, it is recommended to avoid using the titles.

Once you have configured this information in Config.xlsx, the Dispatcher framework now targets the stream that you configured. Next, define the business logic to determine which communications go to which Orchestrator queues.

Business Logic

Configure your business logic in the GetDestinationQueue page in the Framework folder.

This GetDestinationQueue page has:

• one input: Communications Mining Result that is currently being processed
• two outputs: the Destination Queue Name and the Destination Queue Folder.

You can configure your business logic on this page to set the two outputs to the appropriate values for your use case.

The Communications Mining Result type provides several functions to assist you. For example:

• Use in_Communication.LabelExists("Address Change") to check if a label exists for the current communication.
• Use in_Communication.EntityExists("policy-number") to check if an entity exists for the current communication.
• Use in_Communication.GetEntity("policy-number").FormattedValue = "123" to check if an entity has a specific value.

Apply these helper functions with your own business logic to decide which communications to add to specific Orchestrator queues. Set the Destination Queue Name and Destination Queue Folder values accordingly.

Running the process

To run the process, ensure you have configured the inputs in the Data.xlsx spreadsheet and built your own business logic in the GetDestinationQueue page.

Note: By default, streams only return communications added to a dataset after you created the stream. If you don’t see any communications when running your process, you may need to reset your stream. For more information, check the reset a stream page.