Creating Operata Orchestrator

A step by step guide on using the Operata CloudFormation template to create Orchestrator.

Preparation is key to a quick and successful deployment of Operata Cloud Orchestrator.

  • There are two Orchestrator templates one if you have an existing VPC that you want to use, or one that creates a new dedicated VPC. Operata will provide links to the CloudFormation template [yml) you need.
  • If you are using a Kinesis Firehose only, you will need to create a Kinesis Stream and use this as the source for your Firehose - here's how.

Before you start, ensure you have the 12 details below captured to simply cut and paste when needed.
Note: be careful to ensure the format as detailed.

1. CFRLogGroupName

From the AWS Console - Amazon Connect - Contact flows
Name of the CloudWatch log group that logs can be generated in
Note: add a leading / to the URL - Example /aws/connect/operata

2. ConnectInstanceARN

From the AWS Console - Amazon Connect - Overview
ARN of the customer connect instance.
Note: use the full ARN name (for example: arn:aws:connect:ap-southeast-2:08xxxxxxx8:instance/cexxxxxxx6-2xxb-4xx7-8xx3-c6xxxxxxxxxb0

3. ConnectRecordingsBucketName

From the AWS Console - Amazon Connect - Data Storage
S3 bucket where the call recordings are stored.
Note: Only use the address to the first / (for example connect-70xxxxxx35c4)

4. ContentControlConfig

Enter the S3 URL of the Content Control Configuration file provided by Operata
See the details here - https://docs.operata.com/docs/configure-data-privacy-controls-for-ctr
If you are not using this, then leave it blank.

5. KinesisStreamCFR

From the AWS Console - Amazon Connect - Contact Flows
The Kinesis stream name for Contact Flow Records - if it already exists, else leave it blank and a new one will be created.

  • To confirm and find the details login to your AWS Console and select CloudWatch and Log Groups
  • Search the CFRLogGroupName and then click on any subscriptions listed (if there are none listed then Operata will create one)

Once you make the selection then copy the Destination ARN
Note: Only use the address after the last / (for example orchestrator-OrchestratorCFRCloudwatchKinesisSubscription62xxxxxB-b53xxxxxxBa5)

6. KinesisStreamCTR

From the AWS Console - Amazon Connect - Data Streaming
Kinesis stream name for Contact Trace Records.
(for example Connect_CTR_Development)
Note: Operata cannot create this as part of the CloudFormation template, we assume one has been created.

7. LogLevel

Log Level needs to stay as pre-populated 0

8. OperataAPIToken

This is created within the Operata platform, here's how.
Here's how to create one

  • Login to the Operata Group as an admin user and navigate to the Settings/Configs section.
  • Select the API section.
  • From here you can create a new API Token by entering a name in the Label field and then selecting + NEW API TOKEN.
  • Hover over the shading to reveal and copy the API Token.

9. OperataAPIUrl

OperataAPIUrl this needs to stay as pre-populated https://api.operata.io

10. OperataGroupID

Operata will provide details of the Operata Group ID.

11. OperataGroupSecret

Operata will provide details of Operata Group Secret.

12. OperataHeartbeatRoutingProfile

Operata Heartbeat Routing Profile name is Operata_Heartbeat_RP

Now you have all the details, lets create Orchestrator

On AWS console, navigate to CloudFormation and create stack - with new resources (standard).
Note: Make sure you are logged in to the right AWS region.

Select Upload a template file and upload the Operata yml and select Next
Note: There is an existing VPN or New VPN version.

Give the stack a name - including Operata Orchestrator in the name is a good idea.

Fill in the parameters you have collected above.

The SubnetIDs and VPCID fields can be left blank
Select Next

There are no changes on the next screen. Click next
Review all the information provided and check the required checkboxes and then select Create stack.

After the stack is created, navigate to Resources tab and search for log.
Click on the log group link to navigate to logs.
Logs generated will confirm that the Orchestrator is deployed and running.

On navigating to ECS, it can be seen that a Fargate cluster has been created


What’s Next

Enabling Heartbeat