Integrating Genesys Intelligent Automation and Customer Environments
This page describes how to set up Integration Processes to integrate the customer's backend resources, such as web services and databases, with Genesys Intelligent Automation.
The iHub interface is where you set up the Processes that integrate Intelligent Automation with the customer's resources, such as databases and web services.
iHub has four tabs, as follows:
- Processes—In this tab, you define the Integration Processes that will handle HTTP(S) requests that are received from the Intelligent Automation VUI. Use the scripting commands described in Scripting Commands to write any Process and Library scripts.
- Deploy to Production—After you have created and tested your Processes, you put them into production using this tab. Deployments in the current calendar year are displayed in tabular and calendar (weekly) format. From the table of deployments, you can also rollback to previous productions if needed.
- Import—You can import Process scripts and Shared scripts from other Processes.
- Export—You can export Process scripts, including the latest production versions, and library entries into a compressed (.zip) file; compatible for use with the Import tab.
Defining Common Properties
To simplify your work, Intelligent Automation allows you to specify common properties, such as variables, functions, and environment settings, that can be used for all of your processes as required. In addition, if any Company-specific configuration information applies to a specific callflow engine and resides on a web site or in a database, you can specify the location and access credentials of the site or database to which the VUI must connect, even securing the connection if necessary. You can do all this on the right-hand panel of the Processes tab.
On the Library tab, create a list of additional variables and functions that can be shared between Processes. The Library is inserted at the top of a Process script, so you can reference the variables and functions throughout the script, as needed.
HTTP Settings tab
On the HTTP Settings tab, provide the Company-specific configuration information that applies to a given Intelligent Automation callflow engine installation on a website. Most of this information requested on this tab relates to using Client-Side Authentication and TLS for setting up a secure connection between Intelligent Automation and the web site.
Enter only a Hostname, Port (defaults to the port used by the installation in which you are working), and the Connection Timeout. If you want to set up a secure connection, you will have to provide additional information. For more information about the security concepts, refer to the Genesys Security Deployment Guide.
JDBC Data Sources tab
If any of this Company-specific information resides in a database or in SQL connection pools, define the JDBC parameters on this tab. The contents of this tab can differ depending on what you specify in the Database Type field, and by what you enter in other fields. Enter the required information in this tab, noting the following:
- The entry in the Name field is unique, but is for internal use only.
- You can enter the JDBC URL manually by selecting Set Connection String Manually or have Intelligent Automation construct it from the information you enter in the fields that open when you click JDBC URL Generation Method.
- The are four supported Database Types—SQL Server, PostgreSQL, MySQL, and Oracle (using either a System ID or a Service Name).
- WarningGenesys does not ship with a driver for MySQL, so if you are using the MySQL DBMS, you will have to obtain that separately.
- Enter a driver name in Override Driver Class Name only if you need to override the driver class name, for example if you are using an older or custom version of a driver.
- If you do not want to use the standard validation query specific to the database type (for example, SELECT 1 for SQL Server) that is used by the connection pool to determine if the connection is working, you can specify a custom one, perhaps based on the Company name, in Override Validation Query.
Environment-specific Settings tab
In this tab, define any settings that are specific to the environment in which you are working, such as Lab, Test, or Production.
Creating a Process
Create a new Process in the Processes tab, as indicated in the following diagram:
After you click New Process in the tab's header bar or click the Create a New Process button:
- Enter a unique Process Name. Intelligent Automation automatically assigns a Process UUID for a new process. This UUID stays with this Process until the Process is deleted.
- Enter any parameters that will be required in the request from VUI. These parameters will be used by the process as it is executing. If the request does not contain these parameters, it will be rejected.
- Enter any confidential parameters. These parameters might contain customer-sensitive data, such as passwords or credit card numbers, and will not be written to logs or reporting databases.
- Using the scripting commands provided with Intelligent Automation, enter the code for the script that will process the request.
- Create the Response Template that will be returned by this Process.You must create at least one Response Templates - one for successful Process execution (Success). A Response Template for unsuccessful execution (Error) is optional.
Modifying a Saved Process
To modify a saved (existing) process, even its name, click Processes on the Processes tab to view the list of Processes. Select it by name on the Processes tab, and make the appropriate changes.
Deleting an Existing Process
To delete a process, click Processes on the Processes tab to view the list of Processes. Select the process you want to delete in the list, and click the garbage can icon to delete it.
Testing a Process
iHub allows you to test your Processes by defining test cases and running them against any Processes you have created, before the Processes are put into production. You can also test a production version by copying the currently deployed version of a Process to the test side of the environment.
Refer to the following diagram to create, run, and examine the results of a test case. The numbers in the diagram correspond to the tasks that follow.
Creating a Test Case
After clicking New Test Case:
- Define the test case by giving it a specific Test Name, an optional Test Description, and values of any Request Parameters required by the process.
- Specify the expected HTTP Response Code (the default, 200, indicates success); and optionally, the XPath Response Assertions, in which known elements or variables should match or not match specified values. The variety of assertions is based on whatever data is returned by the test stubs. The Author can write as many XPath assertions as they wish to inspect the generated XML, as long as he or she knows what data is returned by a test web service for a particular input. For example:
- XPath is /response/status/text()
- Match Type is matches
- Expected Values is success
Running and Evaluating a Test Case
- Click Run this Test.
- View the Execution Results, including the information from any Response Templates associated with this process.
Deploy to Production
After you have created the Process and tested it, it is ready to be put into the production side of the environment in which you are working. Note that when you deploy a process to production, it is not changed nor removed from the testing environment.
To deploy a process to production:
- Select the Processes to Deploy. If there is more more than one listed, you can deploy one, some, or all of those that are listed.
- Deployment Options give you the option to include the Library and/or Environment information that you entered on the Processes tab.
TipIf you included any of the library variables or environment information in any of the processes to be deployed, you must include the corresponding deployment option here.
- You must provide a Reason for Deployment, if for no other reason than to identify this particular deployment.
The Production Version section (see the diagram below) displays a history of your deployment activities, including which deployment is your Current Production Version.
You can also copy a deployment to a test version, effectively overwriting the test version with a copy of the deployed version.
The twelve-month calendar for the current year illustrates the distribution of all deployments throughout the current calendar year. Hovering over a red box displays the date and number of deployments on that date; clicking on the red box highlights the deployment in the table above the calendar.
Adding Integration Processes to a Callflow
After you have created and tested an Integration Process, you can incorporate it into your callflow by adding it to an Interceptor block, as shown in the following diagram:
Open the Integration tab of the Interceptor block, and do the following:
- Replace the values of the Web Service URL for Test Calls and Web Service URL for Production Calls fields with the following:
Where Process_ID is the Process UUID shown at the top of the Processes tab. You can also add additional parameters, if required.
- Change the value of the Web Service Timeout field, if needed.
On the Import tab, you can import iHub Scripts from other processes in the same or a different environment. The input file must be created by using the Export tab.
After you have selected the .zip files for importing, click Choose Components for Import. You can then choose to use the file contents to create a new process, or to overwrite the corresponding parts of an existing process.
On the Export tab, you can export processes and shared scripts to a .zip file. This file can be used for such things as backup or storage, or to import back into iHub, perhaps into another environment.
You must select one or more processes and/or one or more shared component to export. If any process you selected is also in production, you can also choose to export the latest production version of it instead of the test version.
When you click Export, the export operation creates a file called Integration Export <datestamp> <timestamp>.zip. This file can then be imported using the Import tab.
iHub provides the following commands for use in Process and Library Scripts:
|context.cacheGet(java.lang.String sKey_p)||Retrieve an item placed in the user cache.|
|context.cachePut(java.lang.String sKey_p, java.io.Serializable value_p, int ExpiryTimeSecs_p)||Place an item in the user cache.|
|context.escapeUrl(java.lang.String sText_p)||Free up memory used by the given URL.|
|context.escapeXml(java.lang.String sText_p)||Free up memory used by the given XML string.|
|context.formatCurrency(java.lang.String sCurrencyCode_p, java.math.BigDecimal currencyAmount_p)||Create a correctly formatted currency string by passing in an ISO 4217 currency code and a BigDecimal amount.|
|context.formatCurrency(java.lang.String sCurrencyCode_p, java.lang.String sCurrencyAmount_p)||Create a correctly formatted currency string by passing in an ISO 4217 currency code and a String amount.|
|context.formatDate(java.util.Date date_p)||Format a date in the standard Intelligent Automation format (yyyy-mm-dd) using the system timezone.|
|context.formatDate(java.util.Date date_p, java.lang.String sFormat_p)||Format a date into the standard Intelligent Automationformat (i.e yyyy-MM-dd)|
|context.formatDate(java.util.Date date_p, java.time.ZoneId timezone_p)||Format a date into a specified format using the system timezone.|
|context.formatDate(java.util.Date date_p, java.lang.String sFormat_p, java.time.ZoneId timezone_p)||Format a date into a specified format with a specified timezone.|
|context.getCurrencyAmount(java.lang.String sSpeechStormCurrency_p)||Retrieve the amount from an Intelligent Automation formatted currency string.|
|context.getCurrencyCode(java.lang.String sSpeechStormCurrency_p)||Retrieve the ISO 4217 from an Intelligent Automation formatted currency string.|
|context.getLastBackendCallResult()||Return the result of the last backend request.|
|context.getRandomPercentage()||Return a random percentage value that can be used for routing a given number of calls in different directions.|
|context.getResponseTemplateNames()||Return the set of Response Template names that are configured in the iHub|
|context.getTimeZone(java.lang.String sTimeZoneName_p)||Return the ZoneId value of a specified timezone name.|
|context.getVariable(java.lang.String sName_p)||Return the value of a variable held in session by it's name|
|context.getVariableNames()||Return a Collection of the variable names currently held in session.|
|context.http(java.lang.String sURL_p, java.lang.String sMethod_p, java.util.List<java.lang.String> headers_p, java.util.Map<java.lang.String,java.lang.String> params_p, int iTimeoutMillis_p)||Send an HTTP request to a specified web service URL containing key/value pair parameters.|
|context.http(java.lang.String sURL_p, java.lang.String sMethod_p, java.util.List<java.lang.String> headers_p, java.lang.String sRequestBody_p, java.lang.String sContentType_p, int iTimeoutMillis_p)||Send an HTTP request to a specified web service URL containing a request body and content type.|
|context.logDebug(java.lang.String sMessage_p, java.lang.Object... additionalItems_p)||Write a debug statement to the logs.|
|context.logError(java.lang.String sMessage_p, java.lang.Object... additionalItems_p)||Write an error statement to the logs.|
|context.logError(java.lang.Throwable error_p, java.lang.String sMessage_p, java.lang.Object... additionalItems_p)||Write an error statement to the logs including a Throwable object.|
|context.logInfo(java.lang.String sMessage_p, java.lang.Object... additionalItems_p)||Write an info statement to the logs.|
|context.logWarning(java.lang.String sMessage_p, java.lang.Object... additionalItems_p)||Write a warning statement to the logs.|
|context.parseDate(java.lang.String sSpeechStormDate_p)||Parse a date in the Intelligent Automation format (yyyy-MM-dd) using the system time zone.|
|context.parseDate(java.lang.String sDate_p, java.lang.String sFormat_p, java.time.ZoneId timezone_p)||Parse a date in the Intelligent Automation format (yyyy-MM-dd) using the given time zone.|
|context.parseDate(java.lang.String sDate_p, java.lang.String sFormat_p)||Parse a date in a specified format using the system time zone.|
|context.parseDate(java.lang.String sDate_p, java.lang.String sFormat_p, java.time.ZoneId timezone_p)||Parse a date with a specified format and timezone.|
|context.parseJSON(java.lang.String sJSON_p)||Parse a provided JSON string into a JSON object.|
|context.parseXML(java.lang.String sXML_p)||Parse a provided XML string into a Node object.|
|context.selectResponseTemplate(java.lang.String sResponseTemplateName_p)||Specify the response template to use when responding to the VUI.|
|context.sendEmail(java.util.List<java.lang.String> recipients_p, java.lang.String sFromAddress_p, java.lang.String sSubject_p, java.lang.String sMessage_p)||Send an email.|
|context.sendSMS(java.lang.String sRecipientNumber_p, java.lang.String sSenderNumber_p, java.lang.String sMessage_p)||Send an SMS.|
|context.setVariable(java.lang.String sName_p, java.lang.Object value_p)||Add a variable to the session.|
|context.sqlDelete(java.lang.String sConnectionName_p, int iTimeoutMillis_p, java.lang.String sQuery_p, java.lang.Object... parameters_p)||Perform a DELETE query in the database.|
|context.sqlInsert(java.lang.String sConnectionName_p, int iTimeoutMillis_p, java.lang.String sQuery_p, java.lang.Object... parameters_p)||Perform an INSERT query in the database.|
|context.sqlSelect(java.lang.String sConnectionName_p, int iTimeoutMillis_p, java.lang.String sQuery_p, java.lang.Object... parameters_p)||Perform a SELECT query in the database.|
|context.sqlStoredProcedure(java.lang.String sConnectionName_p, int iTimeoutMillis_p, java.lang.String sStoredProcedureName_p, java.lang.Object... parameters_p)||Run the specified stored procedure.|
|context.sqlUpdate(java.lang.String sConnectionName_p, int iTimeoutMillis_p, java.lang.String sQuery_p, java.lang.Object... parameters_p)||Perform a UPDATE query in the database.|
|context.sqlDelete(String sConnectionName_p, int iTimeoutMillis_p, String sQuery_p, List<Object> parameters_p)||Perform a DELETE query in the database.|
|context.sqlInsert(String sConnectionName_p, int iTimeoutMillis_p, String sQuery_p, List<Object> parameters_p)||Perform an INSERT query in the database.|
|context.sqlSelect(String sConnectionName_p, int iTimeoutMillis_p, String sQuery_p, List<Object> parameters_p)||Perform a SELECT query in the database.|
|context.sqlUpdate(String sConnectionName_p, int iTimeoutMillis_p, String sQuery_p, List<Object> parameters_p)||Perform an UPDATE query in the database|
|context.sqlStoredProcedure(String sConnectionName_p, int iTimeoutMillis_p, String sStoredProcedureName_p, List<Object> parameters_p)||Run the specified stored procedure.|