Scripting Administration Tasks

Overview of Scripting Administration Tasks

The Scripting Administration console provides the user interface with which script developers can launch Script Author as a Java applet, and script administrators can administer Oracle Scripting files, as well as generate, view and analyze agent interface reports.

This console is accessed by logging into Oracle HTML-based applications using an Oracle Applications user account with the Scripting Administrator responsibility.

This section includes the following topics:

Scripting Home

Upon logging into the Scripting Administration console, the Home tab appears.

Tasks

You can perform the following tasks:

Concepts

For more information, see the following concepts in the Oracle Scripting User Guide:

Launching the Script Author Java Applet

Using Script Author, you can create, modify, and deploy scripts to the applications database.

Use this procedure to launch Script Author as a Java applet.

Prerequisites

None

Login

Log into Oracle applications using the CRM Home Page login, or the Single Sign-On login if implemented.

Responsibility

Scripting Administrator

Steps

  1. From the Scripting Administration console, click the Home tab.

  2. Click Launch Script Author.

    A separate browser window appears, in which Oracle JInitiator launches, using authentication information from the current Oracle Applications session. Presently, a separate Java applet window appears with the Script Author user interface.

Administering Oracle Scripting Files

From the Administration tab of the Scripting Administration console, you can monitor and administer files supporting Oracle Scripting, including scripts deployed with Script Author, and custom Java archive files.

Tasks

You can perform the following tasks:

Concepts

For more information, see the following topic in the Oracle Scripting User Guide:

Viewing and Removing Deployed Scripts

Use the Deployed Scripts subtab to view or remove scripts deployed to the applications database from Script Author. Removing a script deletes the script and all related metadata from the database tables.

Use this procedure to view or remove deployed scripts.

Prerequisites

At least one script must be deployed to the applications database from Script Author.

Login

Log into Oracle applications using the CRM Home Page login, or the Single Sign-On login if implemented.

Responsibility

Scripting Administrator

Guidelines

Steps

  1. From the Scripting Administration Console, click the Administration tab.

  2. From the Administration tab, click the Deployed Scripts subtab.

    The Deployed Scripts page appears. A summary list of all deployed scripts meeting the filter criteria in the View list appears in the Deployed Scripts table.

  3. Optionally, to change the set of records displayed in this list, perform any of the following:

    • From the View list, select a different filter option to display more or fewer deployed scripts based on active status and which user created the script.

      • To display subsequent records in the found set, click Next or the right arrow. To view previous records in the found set, click Previous or the left arrow.

      • To navigate through the found set of records in groups of ten, from the records range list between the Previous and Next links, select the appropriate range of records (for example, select 11 to 20 of n, where n is the number of records in the found set).

        After any selection above, the page refreshes, displaying the requested records.

  4. Optionally, to remove scripts from the applications database, in the Select column, mark the Select option for each record you want to delete, and click Remove.

    Note: Oracle recommends that you back up any script you may want to reuse to a local or network file system before deleting it from the database.

Viewing and Administering Custom Java Archive Files

At runtime, scripts that contain commands referencing custom Java methods can execute each method as specified by the Script Author command parameters. Customized scripts can also use custom user interface Java beans to provide functionality at runtime. The source code for custom Java supporting Oracle Scripting must be compiled into executable class files and packaged into Java archives as appropriate.

Using the Scripting Administration console, you can upload custom Java archive files to the IES_JARFILES table in the applications database. Management of these files is accomplished from the Jar Listings subtab of the Administration tab.

Custom code loaded from the Scripting Administration console to the applications database need not be added to the class path of any configuration file.

Conversely, for custom code that is deployed manually to the APPL_TOP (the model available before this console was available), the corresponding class path must still be specified (in the JSERV.PROPERTIES file for enterprises using the Apache mid-tier architecture, or in the APPSWEB.CFG file for enterprises using the caching architecture). Manually deployed Java archives will not appear in the list of Java archive files on the Administration > Jar Listings page, nor can they be removed using this user interface.

Tasks

You can perform the following tasks:

See Also

Viewing and Removing Uploaded Java Archive Files

When a Java archive is deployed to the database using the Scripting Administration console, a corresponding record is created in the IES_JARFILES table.

Use this procedure to view and remove custom Java code archives (JAR and ZIP files) uploaded to the applications database from the Scripting Administration console. Removing a Java archive deletes the JAR or ZIP file and all related metadata from the database tables.

Prerequisites

Login

Log into Oracle applications using the CRM Home Page login, or the Single Sign-On login if implemented.

Responsibility

Scripting Administrator

Guidelines

You cannot remove a Java archive deployed to the database until any mappings associated with the archive are also removed.

Steps

  1. From the Scripting Administration Console, click the Administration tab.

  2. From the Administration tab, click the Jar Listings subtab.

    The Jar Files page appears. A summary list of all uploaded Java code archive files meeting the filter criteria in the View list appears in the Jar Files table.

  3. If required, change the set of records displayed in the Jar Files table list as appropriate to display the desired code archives by performing any of the following:

    • From the View list, select a different filter option to display more or fewer Java archive files based on the Oracle Applications login used when the files were uploaded to the database.

      • To display subsequent records in the found set, click Next or the right arrow. To view previous records in the found set, click Previous or the left arrow.

      • To navigate through the found set of records in groups of ten, from the records range list between the Previous and Next links, select the appropriate range of records (for example, select 11 to 20 of n, where n is the number of records in the found set).

        After any selection above, the page refreshes, displaying the requested records.

  4. Optionally, to remove uploaded Java archive files from the server, in the Select column, mark the Select option for each Java archive you want to delete, and click Remove.

Uploading New Java Archive Files

As discussed in the topic Using Custom Java in the Oracle Scripting User Guide, custom Java archives can be used with Oracle Scripting to support the execution of custom commands in any script, or the use of Java beans in the agent interface. Using the Scripting Administration console, you can upload Java archive files from the Jar Listings subtab of the Administration tab.

When a Java archive is deployed to the database using the Scripting Administration console, a corresponding record is created in the IES_JARFILES table.

Custom code loaded from the Scripting Administration console to the applications database need not be added to the class path of any configuration file.

Use this procedure to upload new Java archive files for execution in a script at runtime.

Prerequisites

Login

Log into Oracle applications using the CRM Home Page login, or the Single Sign-On login if implemented.

Responsibility

Scripting Administrator

Guidelines

Steps

  1. From the Scripting Administration Console, click the Administration tab.

  2. From the Administration tab, click the Jar Listings subtab.

    The Jar Files page appears.

  3. To begin uploading a Java archive file, click Upload New Jar.

    The Upload File page appears.

  4. In the Name field, type the name you want to associate with this Java archive file in the database.

    You can use any unique name to associate with this file. If you leave this field blank, the file name of the specified JAR or ZIP file will be used. You cannot use a name already assigned to another Java archive.

    If the Java archive is a Java bean, this name will be referenced by the Jar File Name field of the Script Author panel properties window.

  5. Optionally, if you want this Java archive to be available globally (to all scripts deployed to this environment), select the Global flag option.

  6. In the File field, click Browse... to begin locating and uploading the Java archive file you want to upload.

    The Choose File window appears.

  7. Navigate to the appropriate location on your local file system or network, highlight the file you want to upload, and click Open.

    Note: You can only upload ZIP or JAR files. Other files will not execute appropriately using either Scripting Engine interface, and are therefore not allowed to be uploaded in this user interface.

    The Choose File window closes, and the File window is populated with the path and filename for the specified Java archive file.

  8. To clear this selection and specify another file, click Reset.

  9. To complete uploading the selected file, click Upload.

    The Jar Files page refreshes. An informational message indicates the logical name of the file you successfully uploaded.

Overwriting Existing Java Archive Files with Updated Archives

When custom code supporting the use of Oracle Scripting is updated, you must recompile the code, package it appropriately as a JAR or ZIP file, and upload the modified code to the database. This overwrites the previously loaded Java archive file.

Use this procedure to overwrite an existing Java archive file.

Prerequisites

At least one Java archive file must be uploaded to the applications database using the Scripting Administration Console.

Login

Log into Oracle applications using the CRM Home Page login, or the Single Sign-On login if implemented.

Responsibility

Scripting Administrator

Steps

  1. From the Scripting Administration Console, click the Administration tab.

  2. From the Administration tab, click the Jar Listings subtab.

    The Jar Files page appears. A summary list of all uploaded JAR files meeting the filter criteria in the View list appears in the Jar Files table.

  3. If required, change the set of records displayed in the Jar Files table list as appropriate to display the desired code archives.

  4. Locate the JAR file in the Jar Files table that you wish to overwrite.

  5. In the Select column, mark the Select option for the Java archive file you want to overwrite, and click Overwrite Existing Jar.

    The Upload File page appears.

  6. Click Browse... to identify the Java archive you wish to upload in place of the existing file.

    The File Upload window appears.

  7. In the File Upload window:

    1. Locate the appropriate JAR or ZIP file from your local file system or network.

    2. Highlight the file name.

    3. Click Open.

      The Upload File page refreshes. The FILE field contains the path and file name of the designated file.

  8. To clear this selection and specify another file, click Reset.

  9. To complete uploading the selected file, click Upload.

    The Jar Files page appears. An informational message indicates the logical name of the file you successfully uploaded.

Changing the Global Property of Uploaded Java Archive Files

Java archive files uploaded using the Scripting Administration console have a global attribute. The data type for this attribute is Boolean, and defaults to false or null. To enable or disable this attribute for a selected code archive, you must explicitly select (setting to true) or clear the selected global attribute (setting to false), respectively. Code archives specified as global are loaded into the class loader for all scripts executed in the Scripting Engine.

Java code archives designated as global are loaded into the class loader for all scripts executed in the Scripting Engine in the specified environment, regardless of whether the scripts were deployed from the Script Author applet or from a standalone version of the Script Author application (use release Script Author 11.5.6 or later for compatibility with an 11.5.6 or later Scripting Engine).

Methods referenced in a global code archive need not be mapped to a specific script in order to execute at runtime. Each method in a global code archive is automatically accessible for execution in the Scripting Engine in any interface. You can change the global property at any time from the Scripting Administration console.

Use this procedure to select or clear the global property for one or more code archives.

Prerequisites

Login

Log into Oracle applications using the CRM Home Page login, or the Single Sign-On login if implemented.

Responsibility

Scripting Administrator

Steps

  1. From the Scripting Administration Console, click the Administration tab.

  2. From the Administration tab, click the Jar Listings subtab.

    The Jar Files page appears. A summary list of all uploaded JAR files meeting the filter criteria in the View list appears in the Jar Files table.

  3. If required, change the set of records displayed in the Jar Files table list as appropriate to display the desired code archives.

  4. If you want to set the global property:

    1. For each Java code archive file displayed on the page that you want to set as global, in the Select column, click the Select option.

    2. For each Java code archive file displayed on the page that you want to set as global, in the Global column, select the Global option.

      A check mark indicates that the option is selected.

  5. If you want to clear the global property:

    1. For each global Java code archive file displayed on the page for which you want to clear the global property, in the Select column, click the Select option.

    2. For each appropriate global Java code archive file displayed on the page, in the Global column, clear the Global option.

      An empty check box indicates that the option is cleared.

  6. To complete the change to the global property of each selected code archive, click Update.

    The Jar Files page refreshes. For each code archive you selected (and any code archive previously set as global), the Global option is selected. For each code archive previously marked as global that you cleared, the Global option is cleared.

  7. To change the global property for other archives, repeat steps 3 through 6.

Creating, Removing, and Viewing Java Archive Mapping Definitions

Java archive files supporting custom Java methods can be mapped to specific scripts, or specified as applying globally to all Oracle Scripting scripts. Methods in mapped files are only loaded into the class loader by the Scripting Engine if it identifies an appropriate script mapping. Code archives specified as global are loaded into the class loader for all scripts.

An uploaded Java archive can be mapped to zero, one, or many deployed scripts. When a Java archive is mapped to one or more deployed script, a corresponding record is created in the IES_SCRIPT_JARFILES table tracking this relationship. When a mapping definition is removed, the mapping record is deleted from this database table and no longer appears in the mapping list. An existing mapping definition must be deleted before the mapped Java archive can be removed.

Java archive files supporting custom Java beans do not need to be mapped to any specific script. The Java beans will be available to run as required in each script containing Java beans.

Use the Jar Mapping subtab to map uploaded Java archive files to apply to specific scripts, to remove mapping definitions, to view defined mappings, and to specify load order.

Prerequisites

Login

Log into Oracle applications using the CRM Home Page login, or the Single Sign-On login if implemented.

Responsibility

Scripting Administrator

Steps

  1. From the Scripting Administration Console, click the Administration tab.

  2. From the Administration tab, click the Jar Mapping subtab.

    The Script Jar Files Mapping page appears, containing a Script Jar Files Mapping area and a Create Mapping area. A summary list of all existing mappings meeting the filter criteria in the View list appears in the Script Jar Files Mapping table.

  3. Optionally, request additional Java archive mappings to be listed by changing the View By selection or by clicking the First, Previous, Next, or Last navigation hyperlinks at the bottom of the page.

  4. To create a new mapping, in the Create Mapping area, do the following:

    1. From the Select Script list, select a deployed script.

    2. From the Select Jar File list, select the Java archive you want to map to the designated script.

    3. In the Load Order field, enter an integer representing the load order of this Java archive.

    4. Click Create Mapping.

      The Script Jar Files Mapping page refreshes, displaying the new mapping definition in the table.

  5. To remove one or more existing mappings, in the Script Jar Files Mapping area, do the following:

    1. In the Select column, select each record representing a mapping you want to delete.

      A checkmark in the Select column indicates the record is selected.

    2. Click Remove.

      The Script Jar Files Mapping page refreshes. The records you selected for deletion are no longer listed in the table, and the corresponding information has been deleted from the database.

Specifying Load Order of Java Archives Files

Load order refers to the order in which the Scripting Engine loads mapped Java archive files. If a Java method of the same name is included in two or more Java archives, and you want to control which method is used, specify the desired archive as having a higher load order. This is chiefly relevant only when methods of the same name have differences in the code.

There is currently no verification to ensure that specified load order of Java archives do not overlap; the Scripting Engine will load Java archives of the same load order level in the order they are returned to the Scripting Engine from its query of the database.

Use this procedure to create or modify the load order for uploaded Java archives mapped to specific scripts.

Prerequisites

Login

Log into Oracle applications using the CRM Home Page login, or the Single Sign-On login if implemented.

Responsibility

Scripting Administrator

Guidelines

Steps

  1. From the Scripting Administration Console, click the Administration tab.

  2. From the Administration tab, click the Jar Mapping subtab.

    The Script Jar Files Mapping page appears, containing a Script Jar Files Mapping area and a Create Mapping area.

  3. To modify an existing load order, from the Script Jar Files Mapping list, change the value in the Load Order field to a different integer and click Update.

    The Script Jar Files Mapping page refreshes. The modified load order is listed accordingly.

  4. To create a load order, you must first specify mapping information. In the Create Mapping area, from the Select Script list, select the Java archive file for which you want to specify load order.

  5. In the Load Order field, type a whole number indicating the intended load order, where the lowest number indicates earlier load order.

  6. To save this mapping, including load order, click Create Mapping.

    The Script Jar Files Mapping page refreshes. Any new mappings are included in the Script Jar Files Mapping list. The load order is a modifiable field.

Generating and Viewing Panel Footprint Reports

Use the Reports tab of the Scripting Administration console to generate, view and analyze the panel footprint report.

Other reports supporting Oracle Scripting are available through Oracle Business Intelligence.

Tasks

You can perform the following tasks:

Generating a Panel Footprint Report

The panel footprint report indicates, by panel per script, what panels were visited and the duration of time (in milliseconds) spent in each panel. The business objective of running this report is to see how effective a script is at leading an agent through a dialog with a customer (for the interaction center) or determining which questions may have been the most confusing (for survey respondents). Essentially, this report helps in tuning a script for maximum clarity and streamlined flow. It is typically of most use in the interaction center to reduce talk time and improve a script's efficiency. Note that if this report is not used, then footprinting should be disabled at the script level to conserve system resources.

Use this procedure to generate a panel footprint report.

Prerequisites

Login

Log into Oracle applications using the CRM Home Page login, or the Single Sign-On login if implemented.

Responsibility

Scripting Administrator

Steps

  1. From the Scripting Administration console, click the Reports tab.

    The Panel Footprint Summary page appears.

  2. In the Select a Script field, type search criteria for the specific script for which you want to run the report and click Go.

    • If required, then you can further refine your search and click Go.

      • You can use partial search criteria and the % wildcard character if desired. To see a list of every available script, just type % and click Go.

        A hypertext linked list of records which meet the specified search criteria, if any, will appear.

  3. Click the appropriate hypertext-linked script name.

    The Panel Footprint Summary page refreshes. The selected script is listed in the Select a Script field.

  4. In the Start Date field, using the calendar control, select the start date of the reporting period for which you want to generate a panel footprint report.

  5. In the End Date field, using the calendar control, select the end date of the reporting period for which you want to generate a panel footprint report.

  6. Click Run Report.

    The report generates, appearing on the refreshed Panel Footprint Summary page. The report lists which panels were visited and the duration of time (in milliseconds) spent in each panel.

  7. Exit the window or run another report as desired.

    Reports are dynamically generated. There is no need to save your work.