JavaScript Object Parameters

The JavaScript object parameters that can be used with the methods for calling an Intelligent Advisor interview using a div are given below.

The parameters that can be specified when starting and resuming an embedded interview (that is, when using the OraclePolicyAutomationInterview.StartInterview or OraclePolicyAutomationInterview.ResumeInterview methods) are given in the following table.

Table 1. The parameters used with OraclePolicyAutomationInterview.StartInterview and OraclePolicyAutomationInterview.ResumeInterview
Parameter Type Required Description
el DOMElement Yes The element to render the interview inside of. Use the document property with the getElementById() method to return the element that has the ID attribute with the specified value. For example, document.getElementById("interviewDiv") will return the interviewDiv element (where there is a div with id=”interviewDiv” specified earlier in the document).
webDeterminationsUrl string Yes The URL of the Web Determinations server that the interview you are embedding resides on
deploymentName string Yes The name of the deployed policy model to start the interview for
locale string No The locale to start the interview in. If not specified, the default locale for the policy model will be used.
opaUser string No The authorized user that is interacting with the interview. Used for billing on a per-user basis. Functionally equivalent to the opauniqueuser parameter specified on the startsession action.
params object No A set of string key/value pairs used to start the interview. Functionally equivalent to the query parameters passed to the startsession action, except for the opauniqueuser and seedData parameters.
seedData object No Only used with the StartInterview method. A simple object that defines properties used to seed data via URL parameters. Functionally equivalent to the seedData query parameter specified on the startsession action. For example:
var seedData = {"user_type" : "Call Center Agent","skip_intro" : "true"};
OraclePolicyAutomationInterview.StartInterview(el, webDeterminationsUrl, deploymentName, undefined, undefined, undefined, seedData);
onLoad function(interview: Interview ){} No The method called when the interview starts. If the interview started, the method will pass the resulting interview object, otherwise null will be passed.
onNavigate function(url :string){} No The method called when the interview wants to redirect to an external location. This may happen as a result of a "submit and redirect" or an exit. The parameter passes the URL to navigate to.

 

The parameters that can be specified when using the OraclePolicyAutomationInterview.BatchStartOrResume method are given in the following table.

Table 2. The parameters used with OraclePolicyAutomationInterview.BatchStartOrResume
Parameter Type Required Description
webDeterminationsUrl string Yes The URL of the Web Determinations server that the interview you are embedding resides on
startConfig array of configuration objects Yes The set of objects which configures each interview to start or resume. The details on the object’s structure are given in the following table.
opaUser string No The authorized user that is interacting with the interview. Used for billing on a per-user basis. Functionally equivalent to the opauniqueuser parameter specified on the startsession action.

 

The startConfig parameter is an array of objects which configure each interview. The properties that can be specified for the startConfig object are given in the following table.

Table 3. The properties used with the startConfig object in OraclePolicyAutomationInterview.BatchStartOrResume
Property Type Required Description
operation string Yes The operation to be performed. "start" is used to start a new interview, "resume" is used to resume an interview, and "resumeCheckpointOrStartNew" (Latest Version interviews only) is used to resume an interview if a checkpoint is returned or start a new interview otherwise. Note that for the resumeCheckpointOrStartNew operation to work properly, the caller must provide all the parameters required to both start and resume an interview. For example, if the connector requires a caseID parameter to resume an interview and an initID parameter to start the interview, then the caller must provide both parameters in the interview configuration object.
el DOMElement Yes The element to render the interview inside of. Use the document property with the getElementById() method to return the element that has the ID attribute with the specified value. For example, document.getElementById("interviewDiv") will return the interviewDiv element (where there is a div with id=”interviewDiv” specified earlier in the document).
deploymentName string Yes The name of the deployed policy model to start the interview for
idcsToken string

Yes, if using Identity Cloud Service as an authorization provider for the interview.

No, otherwise.

 A JWE encrypting an Identity Cloud Service access token in JWT compact form. For more information, see Embed an Interview Secured by Identity Cloud Service.
locale string No The locale to start the interview in. If not specified, the default locale for the policy model will be used.
params object No A set of string key/value pairs used to start the interview. Functionally equivalent to the query parameters passed to the startsession action, except for the opauniqueuser and seedData parameters.
seedData object No A JSON object used to seed data via URL parameters. Functionally equivalent to the seedData query parameter specified on the startsession action. Note that you can seed both global and entity-level data via the startsession URL, but you can only seed global data via the resumesession URL.
onLoad function(interview: Interview ){} No The method called when the interview starts. If the interview started, the method will pass the resulting interview object, otherwise null will be passed.
onNavigate function(url :string){} No The method called when the interview wants to redirect to an external location. This may happen as a result of a "submit and redirect" or an exit. The parameter passes the URL to navigate to.
onCustomEvent(event) function(event: any){} : any No Receives any custom events that have been raised by an interview extension
onDirtyChange function(dirty:boolean){} No The method called when data is changed in the interview (making it dirty) or the interview is submitted (making it non-dirty)
canRestart function(){} : boolean No The function called prior to the interview restarting. If it returns true, the interview will restart. If it returns false, the interview will not restart. If not present, the interview will always restart if requested by the user.
loadCustomizations Boolean No The setting used to determine if custom files (including interview extension scripts and CSS) should be loaded. True will automatically load custom files. False will not load custom files. If not present, it is assumed to be true.
disableEnforcedStyling Boolean No The setting used to determine if the embedded interview can use CSS styling. If not present, it is assumed to be false.
errorMessage string No The error text displayed to the user when an interview fails to load. By default, this is "Unable to load interview".
errorStyle object No The style of the error text displayed to the user when an interview fails to load. By default, this is white text on a red background.
warnIfUnsaved Boolean No The setting used to determine if warning messages should be shown when there are unsaved changes. If not present, it is assumed to be true.
useCookies Boolean No The setting used to determine if cookies should be used. True will use cookies and allow cookie behavior to be configured (using the redirector properties below). False will not use cookies. If not present, it is assumed to be false.
redirectorStartMessage

string

 No When useCookies is set to true, this setting is used to specify the text of the message that will induce the user to click on a redirection button (that will briefly redirect the browser so as to set the cookie needed for the page to work correctly).
redirectorButton

string

 No When useCookies is set to true, this setting is used to specify the text of the redirection button (used to set the Intelligent Advisor cookie)
redirectorWhyQuestion

string

 No When useCookies is set to true, this setting is used to specify the text of the question displayed to the user to help them understand why they are seeing the redirection button (used to set the Intelligent Advisor cookie)
redirectorWhyText

string

 No When useCookies is set to true, this setting is used to specify the explanatory text displayed to the user to describe why they are seeing the redirection button (used to set the Intelligent Advisor cookie)
redirectorRTL Boolean No When useCookies is set to true, this setting is used to set the redirection text specified above to be right-to-left instead of left-to-right
redirectorButtonStyle object No When useCookies is set to true, this setting is used to set a specific style for the redirection button (used to set the Intelligent Advisor cookie)

 

The parameters that can be specified when you want to get information about a particular deployment (that is, when using the OraclePolicyAutomationInterview.GetDeploymentInformation method) are given in the following table.

Table 4. The parameters used with OraclePolicyAutomationInterview.GetDeploymentInformation
Parameter Type Required Description
webDeterminationsUrl string Yes The URL of the Web Determinations server that the interview you are embedding resides on
deploymentName string Yes The name of the deployed policy model to start the interview for
callback function(info : DeploymentInformation){} Yes The call with the requested deployment information (see the table below). For example: 
OraclePolicyAutomationInterview.GetDeploymentInformation(webDeterminationsUrl, deploymentName, function(info) {
    console.log(info.getSupportedLocales());
});

 

The methods that can be used with the DeploymentInformation class are given in the following table.

Table 5. The methods used with the DeploymentInformation class
Method Description
isLatestVersionInterview() : boolean Returns true if the interview is a latest version interview, otherwise returns false.
getSupportedLocales() : string[] Returns the set of locales that are supported by this deployment. The first element of the array is the deployment's default locale.
getCustomCSS() : string[] Returns a set of URLs for the custom CSS files contained in this deployment
getCustomJS() : string[] Returns a set of URLs for the custom JavaScript files contained in this file