Skip to main content

Welcome to the Cyara Knowledge Center

Search

Managing Existing Campaigns

Updated: tech writers Edited:
Cyara Campaigns are currently undergoing active development as we continue to add features and functionality. Stay tuned for more updates in the Cyara Release Notes and Newsletters.

To view and manage existing Campaigns, perform the following steps:

  1. From the main menu, select Execute and then click the Campaign Library menu option.

  2. Here you can see a list of all Campaigns for your Account. From the Campaign Library you can:
    • Create new Campaigns
    • Edit Campaigns
    • View, Sort, Search and Filter Campaigns
    • Run, Abort and Delete Campaigns
    • Organize Campaigns in to Folders



  3. Sorting Campaigns

    Click on any of the Campaign column headings to sort the Campaigns. Sorting by name will list all campaigns alphabetically.

    For each campaign you sort by the following attributes

    • Name
    • Folder
    • Last Run Date and Time
    • Next Scheduled Date and Time
    • Status
    • Plan Type
    • Channel

    You can also use the filters available on the left menu by ticking these boxes, only Campaigns that match the selection will be displayed. Selecting multiple filters will display results that match any of the filters, for example if you select Completed and Running Campaigns, you will see Campaigns with either status.

    Click the Clear Filters button to remove all currently selected filters. Unselect the checkbox for a filter or click the X icon to remove an individual filter from the applied filters list.

    Note: A very useful feature of these Campaign filtering selections is that the URL of the page will dynamically change. This allows you to copy/paste and share this URL with another user of your Cyara Account and they will be able to see the same filter selection. You can also bookmark these filter selections in your browser for future reference.

Organizing Campaigns in Folders

To keep your Cyara Campaign Library organized, you can arrange and sort Campaigns in folders.

To use Cyara Campaign Folders, click on the Folders tab available in the top left corner.

To create a new Cyara Campaign Folder, right click on any of the available folders and the contextual menu will appear.

Click on New to create a new folder. Here you can also Cut and Paste folders containing Campaigns into differently levels of the Campaigns folder structure.

Note: The top level folder titled "Campaigns" can not be renamed or removed.

Adding Campaigns to Folders

Once you have created some new Campaign Folders, you can then organize Campaigns into these folders. On the main Campaign Library screen, select one or more Campaigns with the checkbox available on the left of each.

Then click on the Action menu button at the bottom of the Campaign list. Here you can Move these Campaigns into a selected folder. Click on the folder where the selected Campaigns should be moved to and select Choose.

Campaign Status Types

Cyara Campaigns will display a Run Status to indicate how the Campaign is performing. See the list below for a summary of each available Campaign Status.

  • Running - Campaign is currently running. To stop this Campaign from running click the Stop button and selecting either Stop or Abort.
  • Queued - Campaign is set to run at a specified time, or is awaiting resources to start running.
  • Aborted - A Campaign that has been forced to stop running.
  • Aborting - A Campaign that has been signaled to stop running and is in the process of completing the last calls that it is responsible for.
  • Completed - Campaign has completed its run. Click on the Campaign Name to see more details of how the Campaign performed.
  • Exceeded Ports - The Campaign has exceeded the maximum number of ports available for your account.
  • Expired Plan - The associated plan with running that Campaign type has expired.
  • Internal Error - An internal Cyara Error has occurred on this Campaign, if issues like these persist contact Cyara.

Editing a Campaign

To edit a Campaign, perform the following steps:

  1. From the Campaign Library screen, click the Campaign Name.
    The Edit Campaign screen appears as shown:

  2. The Last Run field shows the date and time when the Campaign was last run. This field is not editable.
  3. The Current Status field displays the current run status of the Campaign and is not editable. The valid values are:
    • Aborted: the Campaign has been aborted by a user, stopping the currently running Test Cases
    • Stopped: the Campaign run has been stopped, allowing currently running Test Cases to complete
    • Running: the Campaign is currently in progress
    • Queued: the Campaign has been queued and scheduled to run at a future date/time
    • Completed: the Campaign Run has completed successfully
    • Internal Error: a system error has occurred when trying to start or abort the Campaign, or during the execution of the Campaign Run
    • Exceeded Session: displayed when the number of Web session in the Campaign is not available during the run time of the Campaign
    • Data Driven Failure: an error has occurred due to an issue with the supplied data sheet for a test case, either due to formatting or invalid data
  4. The Active Status field indicates if the Campaign is active. An inactive Campaign can be saved, but not scheduled or run.
  5. Make the required changes to the Campaign. See Creating and Running Campaigns for more information on the fields.
  6. If the Campaign is inactive, click the Save Details button and if the Campaign is active, click the Save & Run button.

Cloning a Campaign

Cloning can save time when you are creating new Campaigns because you can use an existing Campaign as the basis for a new one. Changes can then be made to the cloned Campaign as required. There are two methods for cloning a Campaign, see below for details.

  1. To Clone a single Campaign, from the Campaign Library screen, click the Campaign Name.
    The Edit Campaign screen appears as shown below:

  2. Click the Duplicate Campaign button to make a copy of this Campaign. A screen as shown below appears:
  3. Make the required changes to the Campaign. See Creating and Running Campaigns for more information on the fields.
  4. After you make the changes, click the Save Details button.
  5. To Clone multiple Campaigns at the same time, select the Campaigns using the checkboxes on the left.
  6. With multiple Campaigns selected, click on the Action menu at the bottom of the Campaign list and select Copy

  7. You will then be prompted to select a folder where all of the newly cloned Campaigns will reside.

    Select the appropriate folder and click Choose

  8. The copy process will now start and will display a Summary of which Campaigns were able to be copied successfully and which campaigns require additional information or changes in order to be copied.

    Note: In the example above, the Velocity Voice 1 Campaign can not be copied as the Requested Run Date is before the plan expiry date, the Virtual Agent Voice Synchronized Campaign is missing required data and the Velocity Voice 2 Synchronized Campaign was copied successfully.

Deleting a Campaign

To delete a single Campaign, perform the following steps:

  1. From the Campaign Library page, select the Menu icon to the right of the Campaign and then select the Delete option
    A pop-up message is displayed requesting confirmation of your selection.
  2. Click Ok on the message if you are sure you want to delete the Campaign. The Campaign will be deleted from the system.
  3. Alternatively you can delete multiple Campaigns at once. Select all of the Campaigns that you want to delete with the checkboxes on the left of each Campaign

  4. Click on the Action menu at the bottom of the Campaign List and select Delete to delete all of the selected Campaigns.
  5. A confirmation box will appear showing the list of Campaigns to be deleted, click Confirm to delete the Campaigns.

Searching for Campaigns

To search for a Campaign, perform the following steps:

  1. From the Campaign Library page, enter the search string in the Search text box and click the Search button.

    Only Campaigns whose names match the search string will be displayed.
  2. Searching for Campaigns within the View tab will search for Campaigns across all folders. Clicking on Folders and selecting a specific folder, then using the Search function will only search for Campaigns within the currently selected folder.
  3. Click the X button to clear the search query and display the original list of Campaigns.

Saving, Running, and Scheduling Existing Campaigns

To run an existing Campaign, perform the following steps:

  1. Enter a Campaign name, select a valid Plan, and enter a description for the Campaign. For information on the fields, see the Creating and Running Campaigns section.
  2. Ensure that the Active Status of the Campaign is set to Active.
  3. Specify the duration of the Campaign Run in the Run For field.
  4. Specify a date and time for the Campaign to be run using the Requested Run Date or Scheduled Run Date fields.
  5. Select the Agents, associated Behaviors, and vendor servers to be used in the Campaign.
  6. Click Save Details to save and run the Campaign.
    For non-Platform Administrator users, a request will be sent to the Platform Administrator(s) to approve and schedule the Campaign. For Platform Administrators, if the requested/scheduled run date is:
    • set to a date/time in the future, the Campaign will be queued;
    • set to the current date/time or a date/time in the past, the Campaign will be started immediately.
  7. Alternatively, you can run a single campaign by clicking the Run button from the right hand menu of an individual Campaign on the Campaign Library page:

    You can also run multiple Campaigns simultaneously by selecting each one via the checkbox on the left of each Campaign name, then using the Action button available at the bottom of the Campaign list and selecting the Run option.

Stopping or Aborting Campaign Runs

To abort Campaign Run that is in progress, perform the following steps:

  1. Click the right options menu button next to the Campaign you wish to stop. Only Campaigns in a running state may be stopped.

  2. You can also select multiple running campaigns with the left checkbox and use the Action menu at the bottom of the Campaign list to select the Abort action.

  3. A confirmation box will appear showing which campaigns have been stopped.

Removing a Queued Campaign

Campaigns that are in queue and scheduled to be run cannot be aborted.

  1. To remove a scheduled Campaign from the service queue, change the Campaign Active Status to Disabled and save the Campaign.
  2. After de-queuing a scheduled Campaign, click the Save Details button.
Was this article helpful?
0 out of 0 found this helpful
Return to top

Related articles

Comments

0 comments

Please sign in to leave a comment.