Cisco Customer Response Applications Editor Step Reference Guide (3.1)
User Step Descriptions
Download this chapter
User Step DescriptionsUser Step Descriptions
 Feedback

Table of Contents

User Step Descriptions
 Authenticate User
 Get User Info
 Set User Info

User Step Descriptions

The steps in the User palette of the Cisco Customer Response Applications (CRA) Editor provide designers with a way to authenticate, retrieve, and assign user attributes.

The User palette contains the following steps:

Figure 8-1 shows the steps in the User palette as they appear in the Palette pane of the CRA Editor.


Figure 8-1   User Palette Steps


Authenticate User

Use the Authenticate User step to authenticate user identification.

You can, for example, use this step as part of a login (and logout) service that performs the necessary administrative updates when users authenticate themselves at a phone.

The Authenticate User step uses the information provided in the customizer (either a user object representing the user or a string representing the user ID along with a password or Personal Identification Number (PIN) to authenticate a user by comparing the information supplied with the information entered for this user in the CRA Administration web interface.

The Authenticate User step has two output branches:

  • Success
  • Fail

Figure 8-2 shows the Authenticate User customizer window.


Figure 8-2   Authenticate User Customizer Window


Figure 8-2 describes the properties of the Authenticate User customizer window.

Table 8-1   Authenticate User Properties

Property Description

User

User ID stored as a string variable, or a user object previously acquired (for example, by using the Name To User step).

Password/Pin

User password or PIN (depending on the radio button chosen in the Credential Format field) stored as a string variable.

Credential Format

Radio buttons that indicates whether you are using a password or PIN variable in the Password/Pin Variable field.

If PIN is chosen, the step attempts to authenticate using the PIN entered in the user's CRA Administration web interface instead of the alphanumeric password. If Password is chosen, the application attempts to authenticate the user against the user's actual alphanumeric password.

To use the Authenticate User customizer window to authenticate user identification, perform the following procedure:

Procedure
Step 1   From the User Variable drop-down menu, choose the variable that stores the user ID.

Step 2   From the Password/PIN variable drop-down menu, choose the variable that stores the user password or PIN.

Step 3   In the Credential Format field, click the Password radio button to enable authentication by password; click the PIN radio button to enable authentication by PIN.

Step 4   Click OK.

The Authenticate User customizer window closes, and the name of the user variable appears next to the Authenticate User step icon in the Design pane of the CRA Editor.




Get User Info

Use the Get User Info step to make user attributes available to the script.

Figure 8-3 shows the properties of the Get User Info customizer window.


Figure 8-3   Get User Info Customizer Window


Table 8-2 describes the properties of the Get User Info customizer window.

Table 8-2   Get User Info Properties

Property Description

User

User object stored in a script variable previously acquired (by, for example, using a step such as the Name To User step)

Attribute/Variable list box

Attributes and associated variables of user

Table 8-3 describes the attributes that can be retrieved by using the Get User Info step.

Table 8-3   Get User Info Attributes

Attribute Description

Full Name

String for the full name of the user as configured in the CRA Administration web interface.

Last Name

String for the last name of the user.

First Name

String for the first name of the user.

Extension

String representing the primary extension selected in the User pages of the CRA Administration web interface.

E-mail

String representing the e-mail ID for this user.

The user ID field is currently returned.

User ID

String for the user ID configured for this user

Spoken Name

Document object representing the recorded name of the user.

To use the Get User Info customizer window to make user attributes available to the script, perform the following procedure:

Procedure
Step 1   From the User drop-down menu, choose the User variable that identifies the user for whom you want to get information.

Step 2   In the Attribute/Variable list box, choose the attributes that represent the information you want to get for the user, and then click Set.

The Get User dialog box appears. (See Figure 8-4 .)


Figure 8-4   Get User Dialog Box


Step 3   From the Select Variable drop-down menu, choose the variable that will store the information, and then click OK.

Step 4   The Get User dialog box closes.

Step 5   Click OK.

The Get User Info customizer window closes, and the name of the user variable appears next to the Get User Info step icon in the Design pane of the CRA Editor.




Set User Info

Use the Set User Info step to assign values to user attributes.

Figure 8-5 shows the Set User Info customizer window.


Figure 8-5   Set User Info Customizer Window


Table 8-4 describes the properties of the Set User Info customizer window.

Table 8-4   Set User Info Properties

Property Description

User

User object stored in a script variable previously acquired (by, for example, using a step such as the Name To User step)

Attribute/Value list box

Attributes and assigned values for the user

Note The Set User Info step supports only the Spoken Name attribute, for which the expected value must be a Document object that represents a recorded prompt.

To use the Set User Info customizer window to assign values to user attributes, perform the following procedure:

Procedure
Step 1   From the User drop-down menu, choose the User variable that identifies the user for which you want to set information.

Step 2   In the Attribute/Variable drop-down list box, choose the attributes that represent the information you want to set for the user, and then click Set.

The Set User Info dialog box appears. (See Figure 8-6 .)


Figure 8-6   Set User Info Dialog Box


Step 3   From the Select Variable drop-down menu, choose the variable that stores the user information you want to set, and then click OK.

Step 4   The Set User dialog box closes.

Step 5   Click OK.

The Set User Info customizer window closes, and the name of the user variable appears next to the Set User Info step icon in the Design pane of the CRA Editor.