Skip to main content

Uniphore Help Center Portal

Policy Examples

This topic covers a use case example for each policy type, and includes step-by-step instructions for each example for system administrators to follow in order to become more familiar with Communication Recording Agent Policies. Each example covers the process to create a Calls Filter unique to that example.

Use the following table to jump to the example specific to each policy type. See the Example Details column for a description of the policy aim, along with a summary of the type of Calls Filter created in the example.

Policy Category

Policy Type

Reference

Example Details

Recording Control

Blocklist

Blocklist Policy Example

Create a Blocklist policy that ensures John's calls are discarded, and all other calls are retained.

Recording Control

Allowlist

Allowlist Policy Example

Create an Allowlist policy that ensures the Sales team's calls are recorded, and all other calls are discarded.

Storage

Purge

Purge Policy Example

Create a Purge policy to delete outgoing calls after 5 years, and run this policy every day.

Storage

Move Media

Move Media Policy Example

Create a Move Media policy to move audio from the Support team's calls to cold storage after 90 days, and run this policy every 12 hours.

Storage

Archive Metadata

Archive Metadata Policy Example

Create an Archive Metadata policy to automatically archive the metadata of the calls for two specific people in the Sales team to cold storage, 2 years after the calls took place, and run this policy every first Friday of the month, at a specific time.

Storage

Retention

Retention Policy Example

Create a Retention Policy that automatically locks Darren in the legal team's calls for three years, then automatically unlocks and deletes them from the system.

Transcription

Transcribe

Transcription Policy Example

Create a Transcription policy to automatically transcribe all the calls for the Sales team, and all the incoming calls for the Support Team, and have the transcriptions sent to a new endpoint after each call.

Export

Call Push (post call)

Call Push Export Policy Example

Create a Call Push policy to automatically export all of Barry from the Finance team's outgoing calls to a new endpoint post-call.

Export

Real-Time Audio (real-time)

Real-Time Audio Export Policy Example

Create a Real-time Audio policy to automatically export incoming Support calls and incoming Sales calls to a new endpoint in real-time.

Access Control

Media Playback and Metadata Access

Media and Metadata Access Policy Example - Department

Create a Media Playback and Metadata Access policy to grant John access to the media and metadata for all Support calls in the system, allowing him to freely search and replay Support calls as required.

Access Control

Media Playback and Metadata Access

Media and Metadata Access Policy Example - List

Create a Media Playback and Metadata Access policy to grant Gene access to the media and metadata of all calls made by anyone on a specified list, allowing him to freely search and replay those calls as required.

Locks

Locks

Locks Policy Example

Create a Locks policy to ensure that all new outgoing Sales calls, apart from Jane's calls, can not be automatically deleted by a Purge policy.

Blocklist Policy Example

The below demonstrates how to create a Blocklist policy. Unlike the steps detailed in Manage Policies, these steps detail a specific use case intended to ensure calls for the user with the email "john.doe@writerexample.com" are discarded and therefore not made available. As this is a Blocklist, all other calls are retained.

Tip

The example uses the Agent Email metadata field to filter calls against. However, Filters can use all kinds of metadata fields and can be as complex as needed. Policy Examples provides various examples of Filters, but to understand the mechanics behind the Filters feature, see Create a Calls Filter.

Discard John's Calls

  1. Go to Configurations > Configure (under Communication Recording Agent) > Policies > Recording.

  2. Click +Create and select Blocklist Policy.

  3. Enter a useful Name for the policy. We're using "Do Not Record John" as the Name.

  4. Set the Priority of the policy. We're going with "1" so that the policy is the priority.

  5. Click Next.

  6. Now apply a filter to the policy. To add John to the filter, we need to use something unique to him. We could use his extension, agent ID, first and last name, or his email. In this example, we use his email.

    As mentioned above, complex filters can be set up to match the exact calls you want the policy to apply to.

    1. Under Filters, click + and select Add Filter.

    2. Click the Select a Column dropdown and click Agent Email from the metadata field list.

    3. Click the Select an Option dropdown and click Equals.

    4. Under Enter a Value, enter the email address john.doe@writerexample.com and press Enter.

    5. Click Test Filter to see which calls this filter would apply to. In this example, you would see a list of John's calls.

  7. When you've confirmed the Policy and Filter, click Create and select Create and Enable. You can click Create and Disable to create the policy, but not enable the policy (you can always enable the policy later).

Now that the policy is created, you can find it in Configurations > Configure (under Communication Recording Agent) > Policies > Recording.

BlocklistExample1.png
BlocklistExample2.png

Allowlist Policy Example

The below demonstrates how to create an Allowlist policy. Unlike the steps detailed in Manage Policies, these steps detail a specific use case intended of ensure calls for the Sales team are captured and therefore made available. As this is an Allowlist, all other calls are discarded.

Tip

The example uses the Department metadata field to filter calls against. However, Filters can use all kinds of metadata fields and can be as complex as needed. Policy Examples provides various examples of Filters, but to understand the mechanics behind the Filters feature, see Create a Calls Filter.

Capture Sales Calls

  1. Go to Configurations > Configure (under Communication Recording Agent) > Policies > Recording.

  2. Click +Create and select Allowlist Policy.

  3. Enter a useful Name for the policy. We're using "Capture Sales" as the Name.

  4. Set the Priority of the policy, we're going with "1" so that the policy is the priority.

  5. Click Next.

  6. Now apply a filter to the policy. To add the Sales team to the filter, we need to use a metadata field that all Sales calls have matching values for and is unique to that team. Our captured calls from the Sales team all have the metadata field "Department" with the value "Sales".

    Other instances may have the metadata field "Group" populated. You can test your filter using Test Filter to make sure the policy applies to the desired calls, or review your recorded calls in Conversations > Recorded to see exactly what metadata fields are populated for each call.

    As mentioned above, complex filters can be set up to match the exact calls that you want the policy to apply.

    1. Under Filters, click the + and select Add Filter.

    2. Click the Select a Column dropdown and click Department from the metadata field list.

    3. Click the Select an Option dropdown and click Equals.

    4. Under Enter a Value, enter the Department metadata field value of the Sales team's calls, "Sales", and press Enter.

    5. Click Test Filter to see which calls this filter would apply to. In this example, you would see a list of sales calls.

  7. When you've confirmed the Policy and Filter, click Create and select Create and Enable. You can click Create and Disable to create the policy, but not enable the policy (you can always enable the policy later on).

Now that the policy is created, you can find it in Configurations > Configure (under Communication Recording Agent) > Policies > Recording.

AllowlistExample1.png
AllowlistExample2.png

Purge Policy Example

The below demonstrates how to create a Purge policy. Unlike the steps detailed in Manage Policies these steps detail a specific use case intended to automatically delete outgoing calls five years after they were recorded, and have this policy run every day.

Tip

The below uses the Call Direction metadata field to filter calls against. However, Filters can use all kinds of metadata fields and can be as complex as needed. Policy Examples provides various examples of Filters, but to understand the mechanics behind the Filters feature, see Create a Calls Filter.

Delete 5 Year Old Outgoing Calls

  1. Go to Configurations > Configure (under Communication Recording Agent) > Policies > Storage.

  2. Click +Create and select Purge Storage Policy.

  3. Enter a useful Name for the policy. We're using "Delete 5yr Outgoing" as the Name.

  4. Set the Priority of the policy. We're going with "1" so that the policy is the priority.

  5. Under Data to Purge, select if the media and the metadata of the call should be deleted, or just the media. We're selecting media, metadata from the dropdown to remove all data associated with the calls.

  6. Under Call Age, determine how old the calls should be before the policy is applied to them. Set a value and a unit. We're using "5" and selecting Years from the dropdown.

  7. Click Next.

  8. Now apply a filter to the policy. To make sure only outgoing calls are deleted, we're using the Call Direction metadata field. However, as mentioned above, Filters can be as complex as needed so that the policy is applied to the exact calls you want it to.

    1. Click the Select a Column dropdown and click Call Direction from the metadata field list.

    2. Click the Select an Option dropdown and click Equals.

    3. Under Enter a Value, enter the direction of the calls to delete after 5 years, "Outgoing", and press Enter.

    4. Click Test Filter to see which calls this filter would apply to. In this example, you would see a list of outgoing calls.

    5. Click Next.

  9. Now choose a Schedule to determine how often the policy is run. In this example, we want the policy to run every day to make sure outgoing calls aren't retained for longer than 5 years. As we don't yet have a daily schedule, we want to create a new one when we create the policy:

    1. Select Create new schedule.

    2. Enter a useful Name for the schedule, we're using "Daily Schedule".

    3. Enter a useful Description for the Schedule. Our schedule is pretty simple, so we're leaving it blank.

    4. Select the Schedule Type from the dropdown to determine the units of time for the schedule. We're using Daily.

    5. Use Repeat Every to determine how often the schedule triggers. In our case, how many days the schedule repeats and activates the purge policy, we're going with the default "1".

    6. Select the Time and Time Zone to determine the exact time the schedule triggers the policy. We're selecting "12:00 AM" and "Europe/London (BST)".

    7. Click Save to create the new Schedule.

  10. When you've confirmed the Policy, Filter, and Schedule, click Create and select Create and Enable. You can click Create and Disable to create the policy, but not enable the policy (you can always enable the policy later on).

Now that the policy is created, you can find it in Configurations > Configure (under Communication Recording Agent) > Policies > Storage.

PurgeExample1.png
PurgeExample2.png
PurgeExample3.png

Move Media Policy Example

The below demonstrates how to create a Move Media Policy. Unlike the steps detailed in Manage Policies, these steps detail a specific use case intended to automatically move the media of the Support team's calls 90 days after they were recorded, and run this policy every 12 hours.

Tip

The below uses the Department metadata field to filter calls against. However, Filters can use all kinds of metadata fields and can be as complex as needed. Policy Examples provides various examples of Filters, but to understand the mechanics behind the Filters feature, see Create a Calls Filter.

Move Support Call Media After 90 Days

  1. Go to Configurations > Configure (under Communication Recording Agent) > Policies > Storage.

  2. Click +Create and select Move Media Storage Policy.

  3. Add a Storage Location to move the call media to. As we don't have a cold storage location added yet, we're creating one in the Create Storage Policy page:

    1. Select Create new storage location.

    2. Enter a useful Name for the storage location. As we're creating a storage location for cold storage, we're calling it "Cold Storage".

    3. Enter a useful Description for the storage location. We're leaving this blank.

    4. Enter the Host address for the storage location. We're using "s3.amazonaws.com".

    5. Enter the Bucket for your storage location. We're using "WriterExampleCold".

    6. Enter a Folder name for inside the storage location where you want the call media to be stored. We're using "ConversationMedia".

    7. Enter the Region of your storage location. set to the Regional endpoint of the AWS instance (for a list of valid entries, see Amazon’s documentation on Regional endpoints). We're using "us-west-2".

    8. Enter your Access Key and Secret Key for accessing the S3 bucket.

    9. Confirm the storage location details and click Create.

  4. In the Define Policy step, set details for the policy and how the policy works:

    1. Enter a useful Name for the policy. We're using "Move Support Audio at 90 Days".

    2. Set the Priority of the policy, we're going with priority "4".

    3. Select which format you would like the media to be in when it reaches the storage location using the Output Format dropdown. We're selecting "WAV".

    4. Use Call Age to determine how old the calls should be before the policy is applied by entering an amount of either Days, Weeks, or Years. We're setting the value to "90" and the unit to "Days".

    5. When ready, click Next to move to the Filters page.

  5. Now apply a calls filter to the policy, to add the Support team to the filter we need to use a metadata field that all the support calls have matching values for and is unique to that team, our captured calls from the Support team all have the metadata field "Department" with the value "Support".

    Other instances may have the metadata field "Group" populated. You test your filter using Test Filter to make sure the policy applies to the desired calls, or review your recorded calls in Conversations > Recorded to see exactly what metadata fields are populated for each call.

    The Call Age set in the previous step determines that the policy only applies to calls once they reach an age of 90 days.

    As mentioned above, complex filters can be set up to match the exact calls you want the policy to apply to.

    1. Under Filters, click the + and select Add Filter.

    2. Click the Select a Column dropdown and click Department from the metadata field list.

    3. Click the Select an Option dropdown and click Equals.

    4. Under Enter a Value, enter the Department metadata field value of the Support team's calls, "Support", and press Enter.

    5. Click Test Filter to see which calls this filter would apply to. In this example, you would see a list of Support calls.

    6. Click Next.

  6. Now choose a Schedule to determine how often the policy is run. In this example, we want the policy to run every 12 hours, as we don't yet have a suitable schedule, we want to create a new one when we create the policy:

    1. Select Create new schedule.

    2. Enter a useful Name for the schedule. We're using "12 Hour Schedule".

    3. Enter a useful Description for the Schedule. Our schedule is pretty simple, so we're leaving it blank.

    4. Select the Schedule Type from the dropdown to determine the units of time for the schedule. We're using Hourly.

    5. Use Repeat Every to determine how often the schedule triggers. In our case, how many hours the schedule repeats and activates the Move Media policy, we're going with "12".

    6. Select the Time and Time Zone to determine the exact time the schedule triggers the policy. We're selecting "12:00 AM" and "Europe/London (BST)".

    7. Click Save to create the new Schedule.

  7. When you've confirmed the Policy, Filter, and Schedule, click Create and select Create and Enable. You can click Create and Disable to create the policy, but not enable the policy (you can always enable the policy later on).

Now that the policy is created, you can find it in Configurations > Configure (under Communication Recording Agent) > Policies > Storage.

MoveMediaExample1.png
MoveMediaExample2.png
MoveMediaExample3.png
MoveMediaExample4.png

Archive Metadata Policy Example

The below demonstrates how to create an Archive Metadata Policy. Unlike the steps detailed in Manage Policies, these steps detail a specific use case intended to automatically archive the metadata of the calls for two specific people in the Sales team (Jane and Tom) to cold storage, 2 years after the calls took place, and run this policy every first Friday of the month, in the evening when the system is under the least load.

Tip

The below uses the Department metadata field as well as Agent First Name to filter calls against. However, Filters can use all kinds of metadata fields and can be as complex as needed. Policy Examples provides various examples of Filters, but to understand the mechanics behind the Filters feature, see Create a Calls Filter.

Archive Call Metadata for Jane and Tom (From Sales) After 2 Years, on the First Friday Evening of every Month

  1. Go to Configurations > Configure (under Communication Recording Agent) > Policies > Storage.

  2. Click +Create and select Archive Metadata Storage Policy.

  3. Add a Storage Location to move the call metadata to. As we don't have a cold storage location for metadata added yet, we're creating one in the Create Storage Policy page:

    1. Select Create new storage location.

    2. Enter a useful Name for the storage location. As we're creating a storage location for cold storage, we're calling it "Cold Storage Metadata".

    3. Enter a useful Description for the storage location. We're leaving this blank.

    4. Enter the Host address for the storage location. We're using "s3.amazonaws.com".

    5. Enter the Bucket for your storage location. We're using "WriterExampleCold".

    6. Enter a Folder name for inside the storage location where you want the call media to be stored. We're using "ConversationMetadata".

    7. Enter the Region of your storage location. Set to the Regional endpoint of the AWS instance (for a list of valid entries, see Amazon’s documentation on Regional endpoints). We're using "us-west-2".

    8. Enter your Access Key and Secret Key for accessing the S3 bucket.

    9. Confirm the storage location details and click Create.

  4. In the Define Policy step, set details for the policy and how the policy works:

    1. Enter a useful Name for the policy. We're using "Archive Jane and Tom Sales at 2yrs".

    2. Set the Priority of the policy. We're going with priority "4".

    3. Select which format you would like the metadata to be in when it reaches the storage location using the Output Format dropdown. We're selecting "CSV".

    4. Use Call Age to determine how old the calls should be before the policy is applied by entering an amount of either Days, Weeks, or Years. We're setting the value to "2" and the unit to "Years".

    5. When ready, click Next to move to the Filters page.

  5. Apply a Filter to the policy. We need the filter to find calls for either Jane or Tom in the Sales team. To do this, we can use the default AND group to specify the Sales team, and the OR group to specify either Jane's or Tom's calls:

    The below uses the Department metadata field to identify the Sales team however other instances may have the metadata field "Group" populated, you can test your filter using Test Filter to make sure the policy applies to the desired calls, or review your recorded calls in Conversations > Recorded to see exactly what metadata fields are populated for each call.

    As mentioned above, complex filters can be set up to match the exact calls you want the policy to apply.

    1. Under Filters, click + and select Add Group. This will automatically add a new AND group. Click the new AND group dropdown and select OR. This is where we add Jane and Tom, as the filter wants to find calls for both people.

    2. Hover over the OR dropdown, the + icon will show on the right. Click + and select Add Filter.

      1. Click the Select a Column dropdown and click Agent First Name from the metadata field list.

      2. Click the Select an Option dropdown and click Equals.

      3. Under Enter a Value, enter the Agent's First Name metadata field value for Jane's calls, "Jane", and press Enter. All agents with the first name" Jane" are now added to the filter.

    3. Again, hover over the OR dropdown and the + icon will show on the right. Click + and select Add Filter.

      1. Again, click the Select a Column dropdown and click Agent First Name from the metadata field list.

      2. Again, click the Select an Option dropdown and click Equals.

      3. Under Enter a Value, enter the Agent's First Name metadata field value for Tom's calls, "Tom", and press Enter. All agents with the first name "Tom" are now added to the filter.

    4. Click + at the bottom of the filter and click Add Filter. This will flow under the AND group at the top of the filter. We're ensuring that only Jane and Tom from the Sales team are found with the filter and not all agents called Jane or Tom.

      1. Click the Select a Column dropdown and click Department from the metadata field list.

      2. Click the Select an Option dropdown and click Equals.

      3. Under Enter a Value, enter the Department metadata field value of the Sales team's calls, "Sales", and press Enter.

    5. Click Test Filter to see which calls this filter would apply. In this example, you would see a list of Sales calls for Jane and Tom.

    6. When you've confirmed the Filter, click Next.

  6. Now choose a Schedule to determine how often the policy is run. In this example, we want the policy to run on the first Friday evening of every month. As we don't yet have a suitable schedule, we want to create a new one when we create the policy:

    1. Select Create new schedule.

    2. Enter a useful Name for the schedule. We're using "First Friday PM".

    3. Enter a useful Description for the Schedule. We're using "The first Friday of the month in the evening".

    4. Select the Schedule Type from the dropdown to determine the units of time for the schedule. We're using Monthly, this adds some extra options to select the Day of the Month:

      1. Use Repeat Every to determine how often the schedule will trigger. In our case, how many Months the schedule will repeat and activate the Archive Metadata policy, we're going with "1" for every month.

      2. Under Day of the Month, select either a specific date or choose a day of the month using weekdays. As we want the policy to run on the first Friday of the month, select the second option. Then select First from the Left dropdown, and select Friday from the right dropdown.

    5. Select the Time and Time Zone to determine the exact time the schedule will trigger the policy. We're selecting "06:00" and PM, clicking OK, and then selecting"Europe/London (BST)".

    6. Click Save to create the new Schedule.

  7. When you've confirmed the Policy, Filter, and Schedule, click Create and select Create and Enable. You can click Create and Disable to create the policy, but not enable the policy (you can always enable the policy later on).

Now that the policy is created, you can find it in Configurations > Configure (under Communication Recording Agent) > Policies > Storage.

ArchiveMetadataExample1.png
ArchiveMetadataExample2.png
ArchiveMetadataExample3.png
ArchiveMetadataExample4.png

Retention Policy Example

The below demonstrates how to create a Retention Policy. Unlike the steps detailed in Manage Policies, these steps are specific to a use case that automatically locks Darren from the legal team's calls for three years, then automatically unlocks and deletes them from the system.

A video has been created to demonstrate the steps to create a new Retention Policy, see Retention Policy Demo below.

Tip

The example below:

  • Uses the Department metadata field as well as Agent First Name to filter calls against. However, Filters can use different metadata fields and can be as complex as needed. Policy Examples provides various examples of Filters, but to understand the mechanics behind the Filters feature, see Create a Calls Filter.

  • Performs a Purge at the end of the set retention period, meaning that calls locked by this example policy are unlocked and then deleted from the system. Retention Policies can instead be configured to Move impacted calls or unlock them and then perform No Action. For more information, see Manage Storage Policies.

Retain Darren from the Legal Team's Calls for Three Years, then Purge them from the system.

  1. Go to Configurations > Configure (under Communication Recording Agent) > Policies > Storage.

  2. Click + Create and select Retention Policy.

  3. Enter a useful Name for your policy. We're naming the policy "Darren Legal Hold".

  4. Choose the Priority of the policy (the order in which the policies are run), 1 being first priority, then 2 being second priority, and so on. We're going with "1".

  5. Set the Expiry for the policy (conversations matching the filter are retention-locked until the expiry period has passed). Enter a value in the expiry dialog box and select a unit of time from the expiry dropdown. We're entering "3" and selecting "Years". So that the conversations are locked for three years.

  6. Determine the action to perform on the conversations once the expiry time is reached using the Action After Expiry dropdown. We're selecting "Purge" where the conversations are unlocked and then purged (deleted) from the system. Deleted conversations can not be recovered. Selecting Purge enables the "Data to Purge" setting, which we'll set later.

  7. Enter a Lock Reason so that anyone viewing the locked call can see why the call is locked. We're entering "Legal Hold".

  8. Select which data to remove from the system using the Data to Purge dropdown. We're selecting "Media, Metadata" to fully remove the conversation from the system.

  9. Click Next.

  10. Determine when and how often the policy is applied. Choose either an existing schedule from the Select from existing schedules dropdown, or select Create new schedule and set up a new schedule for the policy to use. For more information on schedules, see Manage Schedules. We're going to create a new Schedule:

    1. Select Create new schedule.

    2. Enter a useful Name for the schedule. We're using "HourlySchedule".

    3. Enter a useful Description for the Schedule. Our schedule is pretty simple, so we're leaving it blank.

    4. Select the Schedule Type from the dropdown to determine the units of time for the schedule. We're using Hourly.

    5. Use Repeat Every to determine how often the schedule triggers. In our case, how many hours the schedule repeats and activates the Move Media policy, we're going with "1".

    6. Select the Time and Time Zone to determine the exact time the schedule triggers the policy. We're selecting "12:00 AM" and "Europe/London (BST)".

    7. Click Save to create the new Schedule.

  11. Click Next.

  12. Create a Calls Filter – Add one or more metadata filters. These are used to define which recordings the policy applies to. See Create a Calls Filter for more information on Calls Filters. We're creating a filter to apply to Darren from the Legal team's calls:

    1. Note that the AND dropdown is the default filter type. This is suitable for our requirements because we want the calls to be from the legal team and by an agent called Darren.

    2. Click the + and select Add Filter.

    3. Click on the Select a Column dropdown and click Department from the metadata field list. Depending on the metadata populated by your integration, the required metadata field may differ.

    4. Click on the Select an Option dropdown and click Equals.

    5. Under Enter a Value, enter the department metadata field value of the agents from the legal team, in your case "Legal", and press Enter.

    6. Click the + and select Add Filter.

    7. Click on the Select a Column dropdown and click Agent First Name from the metadata field list.

    8. Click on the Select an Option dropdown and click Equals.

    9. Under Enter a Value, enter the agent's name, in our case, "Darren".

    10. Click Test Filter to confirm that the filters apply to the correct calls. Using the filter we've set, we should see a list of Darren from the legal team's calls.

  13. When you're ready, click Create and select if you want the policy enabled (Create and Enable) or disabled (Create and Disable), where you can enable or disable it later if needed. We're choosing "Create and Enable".

Now that the policy is created, you can find it in Configurations > Configure (under Communication Recording Agent) > Policies > Storage.

StorageRetentionExample1.png
StorageRetentionExample2.png
StorageRetentionExample3.png

Retention Policy Demo

The following video demonstrates how to add a new Retention Policy:

 
Transcription Policy Example

The below demonstrates how to create a Transcription Policy. Unlike the steps detailed in Manage Policies, these steps detail a specific use intended to automatically transcribe all Sales team calls, all incoming Support team calls, and have the transcriptions sent to a new endpoint post-call.

Tip

The below uses the Department metadata field as well as Call Direction to filter calls against. However, Filters can be made using all kinds of metadata fields and can be as complex as needed. Policy Examples provides various examples of Filters, but to understand the mechanics behind the Filters feature, see Create a Calls Filter.

Transcribe All Sales and All Incoming Support Calls

  1. Go to Configurations > Configure (under Communication Recording Agent) > Policies > Transcription.

  2. Click +Create.

  3. Add an Endpoint to send the call transcriptions to. As we don't have an Endpoint for transcriptions set up yet, we're creating one in the Create Transcription Policy page:

    1. Select Create new endpoint.

    2. Under Information, enter a useful Name for the Endpoint, we're going with "Post-Call Transcriptions Endpoint".

    3. Enter a useful Description if needed. We're leaving it blank.

    4. Under URI, enter the address of the Webhook to export the transcriptions to.

    5. Under Uri Auth Header, enter the authorization header to use during the export.

    6. Under Request Timeout, enter the number of seconds allowed for exporting content, after which the export will fail. This is only taken into account after an initial export fails. The default is 100 seconds if not set. The default works for our purposes, so we're not entering a value here.

    7. Under Allow Insecure Certification, determine the required certificate security during exports to this Endpoint. We want to ensure certification is secure, so we're leaving this toggle off (meaning "do not allow insecure certification").

    8. Under Certificate Hash, enter the hash of the certificate that allows exports to this Endpoint.

    9. Under Authorization, determine if Authorization is enabled or disabled using the toggle. We want to enable Authorization, so we need to set the toggle to enabled and then configure the subsequent settings to obtain an access token for exporting to the Endpoint.

    10. Choose the Grant Type for the authorization. We're using Bearer Token.

    11. Enter the Client ID used to obtain an access token for the export.

    12. As we're using a Bearer Token as the Grant Type, under Token, enter the token for the authorization.

    13. When you've confirmed Endpoint settings, click Create.

  4. In the Define Policy step, enter a useful Name for the policy. We're calling the policy "Transcribe Sales and Incoming Support".

  5. Set the Priority for the policy. We're setting Priority to "3".

  6. Click Next.

  7. Apply a filter to the policy, we need the policy to transcribe all sales calls and all incoming support calls:

    The below uses the Department metadata field to identify the Sales and support teams however other instances may have the metadata field "Group" populated, you can test your filter using Test Filter to make sure the policy will apply to the desired calls, or review your recorded calls in Conversations > Recorded to see exactly what metadata fields are populated for each call.

    As mentioned above, complex filters can be set up to match the exact calls you want the policy to apply.

    1. As we want to transcribe both sales calls and incoming support calls, we need to use the OR group. Click the AND dropdown and select OR.

    2. Click the + and select Add Filter.

      1. Click on the Select a Column dropdown and click Department from the metadata field list.

      2. Click on the Select an Option dropdown and click Equals.

      3. Under Enter a Value, enter the Department metadata field value of the Sales team's calls, "Sales", and press Enter.

    3. Click the + and select Add Group. We want to keep this group as AND because under this group, we want to filter for calls that are both Support calls and Incoming calls (incoming calls for the Support team).

    4. Hover over the AND dropdown to show the + icon. Click + and select Add Filter.

      1. Click on the Select a Column dropdown and click Department from the metadata field list.

      2. Click on the Select an Option dropdown and click Equals.

      3. Under Enter a Value, enter the Department metadata field value of the Support team's calls, "Support", and press Enter.

    5. Again, hover over the AND dropdown and the + icon will show on the right, click the + and select Add Filter.

      1. Click on the Select a Column dropdown and click Call Direction from the metadata field list.

      2. Click on the Select an Option dropdown and click Equals.

      3. Under Enter a Value, enter the Call Direction metadata field value of the incoming calls, "Incoming", and press Enter.

    6. Click Test Filter to see which calls this filter would apply to. In this example, you would see a list of Sales calls, as well as incoming Support calls.

    7. Click Next.

  8. When you've confirmed the Policy and Filter, click Create and select Create and Enable. You can click Create and Disable to create the policy, but not enable the policy (you can enable the policy later on).

Now that the policy is created, you can find it in Configurations > Configure (under Communication Recording Agent) > Policies > Transcription.

TranscriptionPolicyExample1.png
TranscriptionPolicyExample2.png
TranscriptionPolicyExample3.png

Call Push Export Policy Example

The below demonstrates how to create a Call Push Export Policy. Unlike the steps detailed in Manage Policies these steps detail a specific use case intended to automatically export all of Barry from Finance's outgoing calls to a new endpoint post-call.

Tip

The below uses the Agent First Name, Department, and Call Direction metadata fields to filter calls against. However, Filters can use all kinds of metadata fields and can be as complex as needed. Policy Examples provides various examples of Filters, but to understand the mechanics behind the Filters feature, see Create a Calls Filter.

Automatically Export Barry from Finance's Outgoing Calls

  1. Go to > Configurations > Configure (under Communication Recording Agent) > Policies > Export.

  2. Click +Create and choose Call Push Export Policy.

  3. Add an Endpoint to send the calls to, as we don't have an Endpoint for finance calls set up yet. We're creating one in the Create Export Policy page:

    1. Select Create new endpoint.

    2. Under Endpoint type, select Webhook from the dropdown menu.

    3. Under Information, enter a useful Name for the Endpoint. We're going with "Finance Calls Endpoint".

    4. Enter a useful Description if needed. We're leaving it blank.

    5. Under URI, enter the address of the Webhook to export the calls to.

    6. Under Uri Auth Header, enter the authorization header to use during the export.

    7. Under Request Timeout, enter the number of seconds allowed for exporting content, after which the export will fail. This is only taken into account after an initial export fails. The default is 100 seconds if not set. The default works for our purposes, so we're not entering a value here.

    8. Under Allow Insecure Certification, determine the required certificate security during exports to this Endpoint. We want to ensure certification is secure, so we're leaving this toggle off (meaning "do not allow insecure certification").

    9. Under Certificate Hash, enter the hash of the certificate that allows exports to this Endpoint.

    10. Under Authorization, determine if Authorization is enabled or disabled using the toggle. We want to enable Authorization, so we need to set the toggle to enabled and use the subsequent settings to obtain an access token for exporting to the Endpoint.

    11. Choose the Grant Type for the authorization. We're using Credentials Grant.

    12. Enter the Client ID - The client ID to use to obtain access to the export location.

    13. As we're using a Credentials Grant as the Grant Type, we need to set Scope, Authorization Endpoint, and Client Secret:

    14. Enter the Scope value - The scope used to obtain access to the export location.

    15. Enter the Authorization Endpoint - The address or IP of the Authorization Endpoint to use to obtain access to the export location.

    16. Enter the Client Secret - The client secret to use to obtain access to the export location.

    17. When you've confirmed the Endpoint settings, click Create, and then click Next.

  4. In the Define Policy step:

    1. Enter a useful Name for the policy. We're calling the policy "Finance Barry Post Call Export".

    2. Choose the data to send in the export under Export data. Click the dropdown and choose either Media or Metadata, or select both. We're selecting both.

    3. As we plan to include metadata in the export, we're also selecting the format for the metadata under Metadata Type. We're going with CSV, but JSON is also available.

    4. Set the Priority for the policy. We're setting Priority to "3".

    5. When you've confirmed the Policy settings, click Next.

  5. Now apply a filter to the policy. We need the policy to export all of Barry from the Finance team's outgoing calls:

    As we want the calls to match three criteria (Name = Barry, department = Finance, and direction = outgoing) we're going to keep the AND at the top of the calls filter and add filters to that AND group.

    1. Click the + and select Add Filter.

      1. Click on the Select a Column dropdown and click Agent First Name from the metadata field list.

      2. Click on the Select an Option dropdown and click Equals.

      3. Under Enter a Value, enter the name of the agent, "Barry", and press Enter.

    2. Click the + and select Add filter.

      1. Click on the Select a Column dropdown and click Department from the metadata field list.

      2. Click on the Select an Option dropdown and click Equals.

      3. Under Enter a Value, enter the department metadata field value that is captured for the finance team's calls, "Finance", and press Enter.

    3. Click the + and select Add filter.

      1. Click on the Select a Column dropdown and click Call Direction from the metadata field list.

      2. Click on the Select an Option dropdown and click Equals.

      3. Under Enter a Value, enter the Call Direction metadata field value that is captured for the outgoing calls, "Outgoing", and press Enter.

    4. Click the Test Filter button to see which calls this filter would apply to. In this example, you would see a list of Barry from the Finance team's outgoing calls.

    The above uses the Department metadata field to identify the Finance team however other instances may have the metadata field "Group" populated, you can test your filter using Test Filter to make sure the policy applies to the desired calls, or review your recorded calls in Conversations > Recorded to see exactly what metadata fields are populated for each call.

    As mentioned, complex filters can be set up to match the exact calls you want the policy to apply.

  6. When you've confirmed the Policy and Filter, click Create and select Create and Enable. You can click Create and Disable to create the policy but enable the policy active (you can always enable the policy later on).

Now that the policy is created, you can find it in Configurations > Configure (under Communication Recording Agent) > Policies > Export.

ExportPolicyExample1.png
ExportPolicyExample2.png

Real-Time Audio Export Policy Example

The below demonstrates how to create a Real-Time Audio Export Policy. Unlike the steps detailed in Manage Policies, these steps detail a specific use case intended to automatically export incoming Support calls and incoming Sales calls to a new endpoint in real-time.

Tip

The below uses the Department and Call Direction metadata fields to filter calls against. However, Filters can use all kinds of metadata fields and can be as complex as needed. Policy Examples provides various examples of Filters, but to understand the mechanics behind the Filters feature, see Create a Calls Filter.

Automatically Export Incoming Support and Sales Calls in Realtime

  1. Go to Configurations > Configure (under Communication Recording Agent) > Policies > Export.

  2. Click +Create and choose Real-Time Audio Export Policy.

  3. Add an Endpoint to send the calls to, as we don't have a real-time Endpoint for Sales and Support calls set up yet, we're going to create one in the Create Export Policy page:

    1. Select Create new endpoint.

    2. Under Endpoint type, select Realtime Stream from the dropdown menu.

    3. Under Information, enter a useful Name for the Endpoint, we're going with "Incoming Support and Sales Endpoint".

    4. Enter a useful Description if needed. We're leaving it blank.

    5. Under URI, enter the address of the Realtime Stream location to export the calls to.

    6. Under Uri Auth Header, enter the authorization header to use during the export.

    7. Under Request Timeout, enter the number of seconds allowed for exporting content, after which the export will fail. This is only taken into account after an initial export fails. The default is 100 seconds if not set. The default works for our purposes, so we're not entering a value here.

    8. Under Allow Insecure Certification, determine the required certificate security during exports to this Endpoint. We want to ensure certification is secure, so we're leaving this toggle off (meaning "do not allow insecure certification").

    9. Under Certificate Hash, enter the hash of the certificate that allows exports to this Endpoint.

    10. Under Authorization, determine if Authorization is enabled or disabled using the toggle. We want to enable Authorization, so we need to set the toggle to enabled and then use the subsequent settings to obtain an access token for exporting to the Endpoint.

    11. Choose the Grant Type for the authorization. We're using Credentials Grant.

    12. Enter the Client ID - The client ID to use to obtain access to the export location.

    13. As we're using a Credentials Grant as the Grant Type, we need to set Scope, Authorization Endpoint, and Client Secret:

      1. Enter the Scope value - The scope used to obtain access to the export location.

      2. Enter the Authorization Endpoint - The address or IP of the Authorization Endpoint to use to obtain access to the export location.

      3. Enter the Client Secret - The client secret to use to obtain access to the export location.

    14. When you've confirmed the Endpoint settings, click Create, and then click Next.

  4. In the Define Policy step:

    1. Enter a useful Name for the policy. We're calling the policy "Incoming Support and Sales RT Export".

    2. Set the Priority for the policy. We're setting Priority to "1".

    3. When you've confirmed the policy settings, click Next.

  5. Apply a filter to the policy, we need the policy to export all incoming calls for the Support and Sales teams:

    Note

    There are two ways to achieve this filter, which can be described with the following expressions:

    1. (Sales AND Incoming) OR (Support AND Incoming)

    2. Incoming AND (Sales OR Support)

    The steps below detail how to create a filter using option b above.

    1. As we want to filter for incoming calls for both the Sales and Support teams, we're keeping the AND at the top of the filter.

    2. Click the + and select Add Filter.

      1. Click on the Select a Column dropdown and click Call Direction from the metadata field list.

      2. Click on the Select an Option dropdown and click Equals.

      3. Under Enter a Value, enter the value for the Call Direction metadata field for incoming calls, "Incoming", and press Enter.

    3. Click the + and select Add Group, click on the new group dropdown and select OR.

    4. Hover over the OR dropdown to see the + icon, click +, and select Add Filter.

      1. Click on the Select a Column dropdown and click Department from the metadata field list.

      2. Click on the Select an Option dropdown and click Equals.

      3. Under Enter a Value, enter the Department metadata field value of the Support team's calls, "Support", and press Enter.

    5. Again, hover over the OR dropdown to show the + icon, click the +, and select Add Filter.

      1. Click on the Select a Column dropdown and click Department from the metadata field list.

      2. Click on the Select an Option dropdown and click Equals.

      3. Under Enter a Value, enter the Department metadata field value of the Sales team's calls, "Sales", and press Enter.

    6. Click Test Filter to see which calls this filter applies to. In this example, you would see a list of incoming Sales and incoming Support calls.

  6. When you've confirmed the Policy and Filter, click Create and select Create and Enable. You can click Create and Disable to create the policy but enable the policy (you can always enable the policy later on).

Now that the policy is created, you can find it in Configurations > Configure (under Communication Recording Agent) > Policies > Export.

RealtimeExportExample1.png
RealtimeExportExample2.png

Media and Metadata Access Policy Example - Department

The below demonstrates how to create a Media and Metadata Access Policy. Unlike the steps detailed in Manage Policies, these steps detail a specific use case intended to provide John access to the media and metadata of all Support calls in the system, allowing him to search and replay Support calls as required.

Tip

The below uses the Department metadata field to filter calls against. However, Filters can use all kinds of metadata fields and can be as complex as you need them. Policy Examples provides various examples of Filters, but to understand the mechanics behind the Filters feature, see Create a Calls Filter.

Provide John Media and Metadata Access to Support Calls

  1. Go to Configurations > Configure (under Communication Recording Agent) > Policies > Access Control.

  2. Click +Create.

  3. Enter a useful Name for the policy. We're going with "John - Support All Access".

  4. Set the Priority for the policy. We're setting Priority to "2".

  5. When you've confirmed the policy settings, click Next.

  6. Apply a filter to the policy. This is where we determine which calls the users in the policy get access to. We need the policy to provide access to all of the Support calls in the system:

    The below uses the Department metadata field to identify the Support team. However, other instances may have the metadata field "Group" populated. You can test your filter using Test Filter to make sure the policy will apply to the desired calls, or review your recorded calls in Conversations > Recorded to see exactly what metadata fields are populated for each call.

    As mentioned above, complex filters can be set up to match the exact calls you want the policy to apply to.

    1. Click the + and select Add Filter.

    2. Click on the Select a Column dropdown and click Department from the metadata field list.

    3. Click on the Select an Option dropdown and click Equals.

    4. Under Enter a Value, enter the Department metadata field value of the Support team's calls, "Support", and press Enter.

  7. Click Test Filter to see which calls this filter applies to. In this example, you would see a list of Support calls.

  8. When you've confirmed the filter, click Next.

  9. Add Claims to the policy. This is where we set who gets access to the calls specified in the filter. We can add users using User Group(s) (from the Organization Hierarchy) or using User(s) for adding users on a user-by-user basis:

    1. Click into the User(s) box to see a list of users in the system.

    2. Find John's email in the list by either scrolling to John's email or typing John's email to reduce the list to matching users.

    3. Click on John's email to add him to the claim.

  10. When you've confirmed the Policy, Filter, and Claims, click Create and select Create and Enable. You can click Create and Disable to create the policy, but not enable the policy (you can always enable the policy later on).

Now that the policy is created, you can find it in Configurations > Configure (under Communication Recording Agent) > Policies > Access Control.

AccessMandMExample1.png
AccessMandMExample2.png
AccessMandMExample3.png

Media and Metadata Access Policy Example - List

The below demonstrates how to create a Media and Metadata Access Policy. Unlike the steps detailed in Manage Policies, these steps outline a specific use case intended to provide our manager, Gene, with access to the media and metadata of all calls made by his team using a specified list of agents. This allows him to search and replay his team's calls as needed.

Tip

Access Policy Claims can be updated to provide the same access to another user. For example, if a temporary manager needs access while Gene is on holiday, then that manager can be added to the Claims. Find the policy in your Access Policies list, click Icon_ThreeDotsMenu.png and select Manage Claims, click into the User(s) list, select which user to add to the claims, then click the check to save.

The following uses the Agent Email metadata field to filter calls against. However, Filters can use all metadata fields and can be as complex as needes. Policy Examples provides various examples of Filters, but to understand the mechanics behind the Filters feature, see Create a Calls Filter.

Provide Gene with Media and Metadata Access to Certain Agents' Calls

  1. Go to Configurations > Configure (under Communication Recording Agent) > Policies > Access Control.

  2. Click +Create.

  3. Enter a useful Name for the policy. We're going with "Gene - All Access List".

  4. Set the Priority for the policy. We're setting Priority to "2".

  5. When you've confirmed the policy settings, click Next.

  6. Apply a filter to the policy. This is where we determine which calls the users in the policy get access to. We need the policy to provide access to all the calls of a specific list of agents.

    The steps below use the "Agent Email" metadata field to identify each agent. However, your call metadata may have a more suitable metadata field that matches all of the agents that you want to filter for. For example, if all of the agents you want to filter for are in the same department and your integration supports the capture of the Department metadata field, then you could use Department to filter for those calls. This would simplify the filter and would avoid the need to manually add new agents to your filter when they're added to your telephony system.

    You can test your filter using Test Filter to make sure the policy applies to the desired calls, or review your recorded calls in Conversations > Recorded to see exactly what metadata fields are populated for each call.

    As mentioned above, complex filters can be set up to match the exact calls you want the policy to apply to.

    1. Click the AND dropdown and select OR. This means that any of the filters in this OR filter group count as a match.

    2. Click the + and select Add Filter.

    3. Click on the Select a Column dropdown and click Agent Email from the metadata field list.

    4. Click on the Select an Option dropdown and click Equals.

    5. Under Enter a Value, enter the Agent Email metadata field value of one of the agents to include in the filter (the agent whose calls Gene should get access to), and press Enter.

    6. Repeat steps b to e until you have a complete list of agent emails.

  7. Click Test Filter to see which calls this filter applies to. In this example, you would see a list of calls for the listed agents.

  8. When you've confirmed the filter, click Next.

  9. Add Claims to the policy. This is where we set who gets access to the calls specified in the filter. We can add users using User Group(s) (from the Organization Hierarchy) or using User(s) for adding users on a user-by-user basis:

    1. Click into the User(s) box to see a list of users in the system.

    2. Find Gene's email in the list by either scrolling to Gene's email or typing Gene's email to reduce the list to matching users.

    3. Click on Gene's email to add him to the claim.

  10. When you've confirmed the Policy, Filter, and Claims, click Create and select Create and Enable. You can click Create and Disable to create the policy, but not enable the policy (you can always enable the policy later on).

Now that the policy is created, you can find it in Configurations > Configure (under Communication Recording Agent) > Policies > Access Control.

AccessListExample1.png
AccessListExample2.png
AccessListExample3.png

Note

To edit a policy's filters, find the policy in your Access Policies list, click > to open the policy's properties panel, click Clone to duplicate the policy, rename the new policy if needed, click next, then edit the filters, click next, set the claims as required, then click Create, and select Create and Enable. Disable the old policy and test that the new one works as intended, then delete the old policy.

Locks Policy Example

The below demonstrates how to create a Locks Policy. Unlike the steps detailed in Manage Policies these steps detail a specific use case intended to ensure that all new outgoing Sales calls, excluding Jane's calls, can not be automatically deleted by a Purge policy.

Tip

The below uses the Department, Call Direction, and Agent Email metadata fields to filter calls against. However, Filters can use all kinds of metadata fields and can be as complex as needed. Policy Examples provides various examples of Filters, but to understand the mechanics behind the Filters feature, see Create a Calls Filter.

Lock All Outgoing Sales Calls apart from Jane's Calls

  1. Go to Configurations > Configure (under Communication Recording Agent) > Policies > Locks.

  2. Click +Create.

  3. Enter a useful Name for the policy. We're going with "Lock Outgoing Sales -Jane".

  4. Under Lock Reason, briefly explain why the calls are being locked. This is viewable when viewing the calls under Conversations > Recorded. We're going with "Needs Review".

  5. Set the Priority for the policy. We're setting Priority to "1".

  6. When you've confirmed the policy settings, click Next.

  7. Apply a filter to the policy. This is where we set which new calls the policy locks. We need the policy to apply to outgoing sales calls, but we need to make sure Jane's calls are not locked:

    1. Click the + and select Add Filter.

      1. Click the Select a Column dropdown and click Department from the metadata field list.

      2. Click the Select an Option dropdown and click Equals.

      3. Under Enter a Value, enter the Department metadata field value of the Sales team's calls, "Sales", and press Enter.

    2. Click the + and select Add Filter.

      1. Click the Select a Column dropdown and click Call Direction from the metadata field list.

      2. Click the Select an Option dropdown and click Equals.

      3. Under Enter a Value, enter the Call direction metadata field value for outgoing calls, "Outgoing", and press Enter.

    3. Click the + and select Add Filter.

      1. Click the Select a Column dropdown and click Agent Email from the metadata field list.

      2. Click the Select an Option dropdown and click Does Not Equal.

      3. Under Enter a Value, enter Jane's email address, "jane.doe@writerexample.com", and press Enter.

    4. Click Test Filter to see which calls this filter applies to. In this example, you would see a list of all of the outgoing calls for the Sales team, excluding any of Jane's calls.

    The above uses the Department metadata field to identify the Sales team. However, other instances may have the metadata field "Group" populated. You can test your filter using Test Filter to make sure the policy applies to the desired calls, or review your recorded calls in Communication Recording Agent> Conversations > Recorded to see exactly what metadata fields are populated for each call.

    As mentioned, complex filters can be set up to match the exact calls you want the policy to apply.

  8. When you've confirmed the Policy and Filter, click Create and select Create and Enable. You can click Create and Disable to create the policy, but not enable the policy (you can always enable the policy later on).

Now that the policy is created, you can find it in Configurations > Configure (under Communication Recording Agent) > Policies > Locks.

LocksExample1.png
LocksExample2.png