Agent scripts page field descriptions

Last Updated : Sep 12, 2022 |

Use this page to manage the agent scripts based on your role.

Note:

When you replace the HTML content using the Agent Script Editor, ensure that you replace the content only between the body tags. Do not replace or change the existing Javascript code, but add new Javascript functions.

Field or Button

Description

Text Box

Use to specify the name of the agent script to search.

Use to start the search.

Use to clear or cancel the search.

You see the following fields when you click Advanced:

Select
Use the list to choose the search criteria. You can specify the search criteria using one of the following options:

  • Name

  • Primary URL

  • Fail over URL

Select
Use the list to specify the operator for the search criteria. You can use the following operators:

  • Equal to (=)

  • Not Equal to (!=)

  • in

  • like

Quick

Use to return from Advanced.

Show

Use to display the search results. You can choose to view the number of results as 10, 20, 50, or all.

Page

Use to display the current page number. You cannot change the value manually.

Use to go to the first page.

Use to go to the previous page.

Text Box

Use to specify a particular page to navigate.

Go

Use to navigate to the specified page number.

Use to go to the next page.

Use to go to the last page.

Name

Displays the agent script name.

Type

Displays the type of the agent script.

State

Displays the state of the agent script.

Primary URL

For URL type, displays the primary URL for the agent script. Primary URL and Fail over URL should not start with <, >, &, ", ', `, #, !.

Fail Over URL

For URL type, displays the fail-over URL if the primary URL is not functioning.

Actions
To reuse an agent script, you can use Save As or Export. You can also delete the agent script.

  • Click to save the script with another name.

  • Click to export the agent script.

  • Click to delete the agent script.

Add

Click to add a new agent script.

Import

Click to import the agent script.

You see the following fields when you click Import:

Field or Button

Description

Import Agent Script

Agent Script Name

Use to specify the name for the agent script.

File to Upload

Use to specify the path of the file to upload.

Choose file

Click to browse to the file to upload.

Import

Click to import the agent script.

If you have a Native agent script, you can reuse the agent script using Agent Script Save As. You see the following fields when you click Agent Script Save As:

Field or Button

Description

Agent Script Save As

Agent Script Name

Displays the original agent script name.

Save As Name

Use to specify a different name for the agent script.

Save

Click to save the agent script with the new name.

Save As Template

Use to save the agent script as Template.

If you have a Native agent script, you can reuse the agent script using Export Agent Script. The system displays a dialog box asking to open or save the agent script. If you click Save, the system displays a folder structure to browse and select the location to save the agent script.

You see the following fields if you click Add:

Field or Button

Description

Add an Agent Script

Select agent script type

Use the list to select the type of the agent as URL or Native.

New agent script name

Use to specify the name of the new agent script.

Continue

If you select the agent script type as URL, you see the following fields:

Field or Button

Description

Select agent script type

Use to specify the name for the agent script.

New agent script name

Use to specify the name of the new agent script.

New primary URL

Use to specify the primary URL.

Verify

Click to verify if the primary URL is functioning.

Fail over URL

Use to specify a fail-over URL if the primary URL does not function.

Verify

Click to verify if the fail-over URL is functioning.

Encode URL

Select to send the encoded url to show the agent script on the agent desktop.

Save

Click to save the agent script.
When you run a campaign where you specify the agent script as URL, you will see the following additional parameters:

Field or Button

Description

Session ID

Current POM session ID information.

Agent Script ID

The script ID of the specific agent script.

Destination IP Address

The FQDN or IP address of Experience Portal system.

Contact List Name

The contact list associated with the campaign.

Agent ID

The ID of the logged-in agent.

Agent Name

The name of the logged-in agent.

Organization Name

The organization associated with the campaign.

User Name

The user that creates the job.

User Contact ID

The unique ID of the imported contact that the user provides.

Campaign Name

The campaign associated with the agent.

If you select the agent script type as Native script, you see the following fields:

Field or Button

Description

Select agent script type

Use to specify the name for the agent script.

New agent script name

Use to specify the name of the new agent script.

Use template

Use to select the agent script saved as template.

Template

Use the list to select the agent script.

Continue

Click to continue to open the editor, where you can specify the parameters and the script details. After you update the script, click Save. For more information about working with the editor, see Working with the editor for adding or editing Native type agent scripts.

If you click the name of the agent script, you can edit the selected agent script. If the selected agent script is of type URL, you see the following fields:

Field or Button

Description

Edit Agent Script

Agent Script Name

Displays the name of the agent script. You cannot change the name once specified.

New Primary URL

Displays the name of the primary URL. You can specify a different name.

Verify

Click to verify if the primary URL is functioning.

Fail-over URL

Displays the name of the fail-over URL. You can specify a different name.

Verify

Click to verify if the fail-over URL is functioning.

Encode URL

Select to send the encoded url to show the agent script on the agent desktop.

Save

Click to save the agent script.

If you edit a Native type agent script, the system displays the editor to make changes to the script and then click Save. For more information about working with the editor, see Working with the editor for adding or editing Native type agent scripts.