Extract Secure Data data action


Use the Extract Secure Data data action in a secure call flow to copy secure data to a non-secure variable of the same type. For example, you might create a variable that extracts the last 4 digits of a customer’s credit card or a customer’s account balance.

The Extract Secure Data action is similar to the Update Data data action, with the following exceptions:

  • The destination variable must be a non-secure variable
  • When specifying the value to assign, expressions can read the values of secure variables
  • Flow authors must check a box on the Extract Secure Data data action to acknowledge the intent to unsecure data from a secure variable and assign it to a non-secure variable

In the Extract Secure Data data action, you can create secure or unsecure update statements. In the update statement:

  • The destination variable must be a non-secure variable
  • The input data must be an expression that contains a secure variable reference. For example,
    If(IsSet(Secure.CustomerId),Substring(Secure.CustomerId, 0, 3), "")

For each Extract Secure Data data action, Architect prompts you with a check box to acknowledge the user is making the data insecure. When checked, the application displays the user name and date the box was checked. This confirms that you plan to use the data in a way that Architect can no longer guarentee is secure. 

Note: If the user that checks this box is removed from PureCloud, the flow will not result in an error. However, the next user to edit the flow will be prompted to check the box.

After you confirm security risk acceptance, the Extract Secure Data data action contains the same functionality as the Update Data data action:

Name Description
Name field

Type a distinctive name for the Extract Secure Data data action. The label you enter here becomes the action’s name displayed in the call flow structure.

Add update statement button Click this button to open a menu from which to choose the value to assign to a particular variable. The form may change, depending on the value or collection you choose. For information on the available variables and how to build them, see the Suggested content.

Note: For information about how to convert a string value into a typed value in Architect, see Convert a string value to a typed value.

Add update statement variables

Choose from these variables:



ACD skills are arbitrary designations of tasks, expertise, or knowledge that someone must have to handle an interaction. A skill variable represents a PureCloud ACD skill (such as a language or certification) possessed by an agent. In Architect, an ACD skill requirement routes a work item to an eligible recipient. ACD skills are established and configured by the PureCloud administrator.

Note: You can add skills created with the Update Data action and then call them from a Transfer to ACD action. For more information, see Set up a Transfer to ACD action.

Add a skill variable to a task sequence

In a task sequence, you can add a skill variable to an Update Data action and then call it from a Transfer to ACD action. For example, to send the call to an agent with fluent Spanish-speaking skills or a higher level of proficiency in Windows OS.

Note: The skills must be defined in PureCloud by the administrator.

  1. From the Toolbox, expand the Data category and drag an Update Data action to the desired location in the task.
  2. On the Update Data design form, in the Name field, add a meaningful name to describe the item.
  3. Click the Add update statement button and select ACD Skill.
  4. In the Variable Name field, type the label to identify the variable on tasks.
  5. In the Value To Assign field, do one of the following:
    • To set the value from literal mode, click the drop-down list and select the desired ACD skill.
    • To set the value using an expression, click the expression button and do one of the following:
      • Add the expression inline.
      • Click the Edit Expression button to open the Edit Expression Editor and build your expression.
  6. (Optional) To add another variable, click the Add update statement button. 
  7. Add a Transfer to ACD action to the task sequence and configure it to use the skill variables you created here.


    A boolean expression can have only one of two values: true (yes) or false (no). For example, the expression "Date equal to 07/17/2014" has a value of yes (true) if the current variable's value is July 17, 2014; otherwise, it has a value of no (false). Use boolean values (or expressions that return boolean values) with If-Then-Else actions to tell  Architect how to make decisions based on two clear alternatives.

    Examples

    • Call.Ani=="tel:+13175551212": In this Boolean expression, the result is true if the originating phone number is 1-317-555-1212; otherwise, false.
    • ToAudioTTS(If(Hour(GetCurrentDateTimeUtc()) >= 12, "Good afternoon", "Good morning")): In this expression that includes boolean values, if the current time is on or after 12:00:00 p.m., the system plays "Good afternoon" audio. Otherwise, it plays "Good morning" audio. 
      Note: In this example, the system runs the check against UTC datetime value.

    You can test for only one condition with one variable, or you can test for multiple conditions with multiple variables. Each time you click Add update statement, Architect adds a variable row. If the table has more than one row, then:

    • The process evaluates the conditions in top-to-bottom order as they appear in the table.
    • The process uses "short-circuit evaluation." When an expression combines multiple conditions by using OR, then the whole expression is true if any of the conditions are true. Therefore, if the first condition is true, the process knows that the whole expression is true and doesn't need to evaluate any of the other conditions. As soon as the process hits a condition that is true, it stops evaluating an OR expression. On the other hand, if an expression combines multiple conditions by using AND, then the whole expression is false if even one of its conditions is false. Therefore, as soon as the process hits a condition that is false, it stops evaluating an AND expression because it knows that the whole expression is false. In either case, the process moves on to the next step.

    Add a boolean expression to a task sequence

    In a task sequence, you can add a boolean expression to an Update Data data action. For example, 

    1. From the Toolbox, expand the Data category and drag an Update Data action to the desired location in the task.
    2. On the Update Data design form, in the Name field, add a meaningful name to describe the item.
    3. Click the Add update statement button and select Boolean.
    4. In the Variable Name field, type the label to identify the variable on tasks.
    5. In the Value To Assign field, do one of the following:
      • To set the value from literal mode, click the True or False radio button.
      • To set the value using an expression, click the expression button and do one of the following:
        • Add the expression inline.
        • Click the Edit Expression button to open the large expression Editor and build your expression.
    6. To optionally add another variable, click the Add update statement button. 



    A currency value represents monetary values. It has two properties:

    • The currency property is a decimal value or the value NOT_SET
    • The string property is a string that holds either a 3-character ISO 4217 code  

    For example, the following expression is valid at runtime:

    MakeCurrency(10.50,"USD") 
    

    This expression evaluates to a currency value with an amount of 10.50 and currency code of 'USD'. 

    Obtaining the symbol for a currency

    There is no "Symbol" property for a currency. However, you can use an expression to return the correct currency symbol:

    GetCurrencySymbol(MakeCurrency(5.0,”USD”))

    This expression returns $.

    Add a currency variable to a task sequence

    In a task sequence, you can add a currency variable to an Update Data data action. For example, 

    1. From the Toolbox, expand the Data category and drag an Update Data action to the desired location in the task.
    2. On the Update Data design form, in the Name field, add a meaningful name to describe the item.
    3. Click the Add update statement button and select Currency.
    4. In the Variable Name field, type the label to identify the variable on tasks.
    5. To set the values in literal mode, in the Value To Assign field, do the following:
      1. Click the + or - buttons to set the desired value.
      2. Click the arrow at the end of the currency symbol drop-down list and select the appropriate 3-character currency value.
    6. To set the value using an expression, in the Value To Assign field, click the expression button and do one of the following:
      • Add the expression inline.
      • Click the Edit Expression button to open the Edit Expression Editor and build your expression.
    7. To optionally add another variable, click the Add update statement button. 



    A DateTime value is a string in the format prescribed by the XML standard for date data, similar to ISO 8601. In this release, Architect allows DateTime values, but not Date and Time values.

    Note:  Architect currently does not support offsets or timezones on DateTime values. You cannot specify offset or time zone, but Architect reports the value in an expression editor function as if it were UTC. If you create a function that calls ToString(datetime), Architect returns the value with a Z appended to the string and treats the value as UTC.

    Add a DateTime variable to a task sequence

    In a task sequence, you can add a date | time variable to an Update Data data action. For example, 

    1. From the Toolbox, expand the Data category and drag an Update Data action to the desired location in the task.
    2. On the Update Data design form, in the Name field, add a meaningful name to describe the item.
    3. Click the Add update statement button and select DateTime.
    4. In the Variable Name field, type the label to identify the variable on tasks.
    5. To set the values in literal mode, in the Value To Assign field, do the following:
      1. Click the date field to display a calendar dialog box and select the appropriate date, month, and year.
      2. Click the time field and select the appropriate time value, including AM and PM.
    6. To set the value using an expression, in the Value To Assign field, click the expression button and do one of the following:
      • Add the expression inline.
      • Click the Edit Expression button to open the Edit Expression Editor and build your expression.
    7. To optionally add another variable, click the Add update statement button. 



    A decimal number is a value consisting only of digits (0 to 9) and a decimal point. The number of display decimal places is configurable.

    Note: In Architect, the decimal data type supports up to 28 total digits. Therefore, the minimum value allowed in a decimal is -9999999999999999999999999999 and the maximum value is +9999999999999999999999999999.

    Add a decimal variable to a task sequence

    In a task sequence, you can add a decimal variable to an Update Data data action. For example, 

    1. From the Toolbox, expand the Data category and drag an Update Data action to the desired location in the task.
    2. On the Update Data design form, in the Name field, add a meaningful name to describe the item.
    3. Click the Add update statement button and select Decimal.
    4. In the Variable Name field, type the label to identify the variable on tasks.
    5. In the Value To Assign field, do one of the following:
      • To set the value from literal mode, click the + or - buttons to select the desired value.
      • To set the value using an expression, click the expression button and do one of the following:
        • Add the expression inline.
        • Click the Edit Expression button to open the Edit Expression Editor and build your expression.
    6. To optionally add another variable, click the Add update statement button. 



    A duration is a representation of time expressed as a string in a subset of the format prescribed by the XML date data standard. Durations have a composite value of days, hours, minutes, and seconds. The length of the duration is the sum total of days, hours, minutes, and seconds values. You can use a duration value to determine how long a "portion" of a process should wait before proceeding.

    Add a duration variable to a task sequence

    In a task sequence, you can add a duration variable to an Update Data data action. For example, 

    1. From the Toolbox, expand the Data category and drag an Update Data action to the desired location in the task.
    2. On the Update Data design form, in the Name field, add a meaningful name to describe the item.
    3. Click the Add update statement button and select Duration.
    4. In the Variable Name field, type the label to identify the variable on tasks.
    5. To set the values in literal mode, in the Value To Assign field, do the following:
      1. Click the calendar button to switch between d-HH:mm:ss.SSS format or HH:mm:ss.SSS format.
      2. Use the + or - buttons to set the desired value, or type it inline.
    6. To set the value using an expression, in the Value To Assign field, click the expression button and do one of the following:
      • Add the expression inline.
      • Click the Edit Expression button to open the Edit Expression Editor and build your expression.
    7. To optionally add another variable, click the Add update statement button. 



    Groups are communities within your organization based on common skills, relationships, location, or other information. Groups are useful for creating categories of knowledge or contact within your enterprise. In Architect, a group expression routes a work item to an eligible group. Groups are established and configured by the PureCloud administrator.

    Add a group variable to a task sequence

    In a task sequence, you can add a group variable to an Update Data data action. For example, to send a call to agents with specialized subject matter knowledge. 

    1. From the Toolbox, expand the Data category and drag an Update Data action to the desired location in the task.
    2. On the Update Data design form, in the Name field add a meaningful name to describe the item.
    3. Click the Add update statement button and select Group.
    4. In the Variable Name field, type the label to identify the variable on tasks.
    5. In the Value To Assign field, do one of the following:
      • To set the value from literal mode, select the appropriate group from the drop-down list.
      • To set the queue using an expression, click the expression button and do one of the following:
        • Add the expression inline.
        • Click the Edit Expression button to open the Edit Expression Editor and build your expression.
    6. To optionally add another variable, click the Add update statement button. 



    An integer is a whole number such as 987 or 5. Use integer values to represent complete objects and processes that cannot be subdivided, such as the number of calls waiting or the number of agents on duty. An integer is an eight-byte value, which means that it can hold positive or negative numbers of practically any size. The range of the Integer data type is -263 to +263 – 1.

    Add an integer variable to a task sequence

    In a task sequence, you can add an integer variable to an Update Data data action. For example, 

    1. From the Toolbox, expand the Data category and drag an Update Data action to the desired location in the task.
    2. On the Update Data design form, in the Name field, add a meaningful name to describe the item.
    3. Click the Add update statement button and select Integer.
    4. In the Variable Name field, type the label to identify the variable on tasks.
    5. In the Value To Assign field, do one of the following:
      • To set the value from literal mode, click the + or - button to select the desired value.
      • To set the value using an expression, click the expression button and do one of the following:
        • Add the expression inline.
        • Click the Edit Expression button to open the Edit Expression Editor and build your expression.
    6. To optionally add another variable, click the Add update statement button. 


    Create a phone number type in an Update Data action sequence when you want to specify a phone number whose properties may be accessed in other flow locations. For more information, see About the phone number data type.

    Example

    A typical use case for phone number update statement is to create a phone number from Call.Ani. Because Call.Ani is a string, converting it to a phone number and accessing the properties gives flow authors easy access to information about the phone number via properties. This alleviates the need to write your own string parsing code to retrieve the information:

    • Variable name: Flow.ClientPhoneNumber
    • Value to assign: ToPhoneNumber(Call.Ani)
    Property Description
    Flow.ClientPhoneNumber.uri Returns the URI for the tel scheme phone number, otherwise a NOT_SET string.
    Flow.ClientPhoneNumber.e164 Returns the E.164 formatted string for the tel scheme phone number with a valid E.164 phone number, including dialing code and subscriber number, otherwise a NOT_SET string.
    Flow.ClientPhoneNumber.subscriberNumber Returns the E.164 formatted subscriber number for a tel scheme phone number with a valid E.164 phone number, otherwise a NOT_SET string.
    Flow.ClientPhoneNumber.dialingCode Returns theE.164 formatted dialing code string for a tel: scheme phone number, otherwise a NOT_SET string.
    Flow.ClientPhoneNumber.isSip Returns false.
    Flow.ClientPhoneNumber.isTel Returns true. 
    Flow.ClientPhoneNumber.isGlobal Returns true.
    Flow.ClientPhoneNumber.scheme Returns tel.
    Flow.ClientPhoneNumber.raw Returns the Call.Ani.

    Example

    The following example illustrate the property data you can extract and the ouput returned when you create a phone number type in a task sequence:

    • Variable name: Flow.ClientPhoneNumber
    • Value to assign: ToPhoneNumber(+13175550116)
    Property Output
    Flow.ClientPhoneNumber.uri "tel:+13175550116"
    Flow.ClientPhoneNumber.e164 "+13175550116"
    Flow.ClientPhoneNumber.subscriberNumber "3175550116"
    Flow.ClientPhoneNumber.dialingCode "1"
    Flow.ClientPhoneNumber.isSip false
    Flow.ClientPhoneNumber.isTel true
    Flow.ClientPhoneNumber.isGlobal true
    Flow.ClientPhoneNumber.scheme tel
    Flow.ClientPhoneNumber.raw "+13175550116"

    Add a phone number update statement to a task sequence

    In a task sequence, you can add a phone number expression to an Update Data data action. For example, 

    1. From the Toolbox, expand the Data category and drag an Update Data action to the desired location in the task.
    2. On the Update Data design form, in the Name field, add a meaningful name to describe the item.
    3. Click the Add update statement button and select Phone Number.
    4. In the Variable Name field, type the label to store the data and identify the variable on tasks.
    5.  To assign a telephone number, do one of the following:
      1. In the Value To Assign field, leave the default tel: data type unchanged.
      2. Click the arrow at the end of the Dialing Code drop-down list and choose the dialing code for the telephone number to ensure the phone number has global dialing information.
      3. In the Enter phone number box, add the subscriber number for the phone number. 

    Note: The subscriber number can also contain an extension. For example, 31755501116;ext=1234. In this case, the full phone number including scheme, dialing code, and subscriber number is tel: +13178723000;ext=1234.

    1. To assign a SIP URI to the phone number, do the following:
      1. In the Value To Assign field, click the arrow at the end of the tel: drop-down list and select sip:.
      2. In the Enter SIP URI box, add the SIP URI phone number string. 
    2. To assign a secure SIP URI to the phone number, do the following:
      1. In the Value To Assign field, click the arrow at the end of the tel: drop-down list and select sips:.
      2. In the Enter SIP URI box, add the secure SIPS URI phone number string. 

    Note: To set the value using an expression, click the expression button and do one of the following:
    • Add the expression inline.
    • Click the Edit Expression button to open the large expression Editor and build your expression.
    1. To optionally add another variable, click the Add update statement button. 



    Queues are the “waiting line” of interactions. In Architect, a queue expression routes a work item to an eligible queue. Queues are established and configured by the PureCloud administrator.

    Add a queue variable to a task sequence

    In a task sequence, you can add a queue variable to an Update Data data action. For example, to send a call to senior technical support or a specialized marketing team.

    1. From the Toolbox, expand the Data category and drag an Update Data action to the desired location in the task.
    2. On the Update Data design form, in the Name field add a meaningful name to describe the item.
    3. Click the Add update statement button and select Queue.
    4. In the Variable Name field, type the label to identify the variable on tasks.
    5. In the Value To Assign field, do one of the following:
      • To set the queue from literal mode, select the appropriate queue from the drop-down list.
      • To set the queue using an expression, click the expression button and do one of the following:
        • Add the expression inline.
        • Click the Edit Expression button to open the Edit Expression Editor and build your expression.
    6. To optionally add another variable, click the Add update statement button. 



    This is a standard text string or a custom series of alphabetical, numerical, and symbolic characters. Its size is limited only by available system resources.

    Add a string variable to a task sequence

    In a task sequence, you can add a string variable to an Update Data data action. For example, 

    1. From the Toolbox, expand the Data category and drag an Update Data action to the desired location in the task.
    2. On the Update Data design form, in the Name field, add a meaningful name to describe the item.
    3. Click the Add update statement button and select String.
    4. In the Variable Name field, type the label to identify the variable on tasks.
    5. In the Value To Assign field, do one of the following:
      • To set the value from literal mode, type the string inline.
      • To set the value using an expression, click the expression button and do one of the following:
        • Add the expression inline.
        • Click the Edit Expression button to open the Edit Expression Editor and build your expression.
    6. To optionally add another variable, click the Add update statement button. 



    This variable is a user type that Architect associates with configured users. In Architect, choose this type from a list box. From the user value, you can retrieve user-related information such as ID or username string values.

    In a task sequence, you can add a user variable to an Update Data data action. For example, to an agent assigned to a specific account.

    1. From the Toolbox, expand the Data category and drag an Update Data action to the desired location in the task.
    2. On the Update Data design form, in the Name field, add a meaningful name to describe the item.
    3. Click the Add update statement button and select User.
    4. In the Variable Name field, type the label to identify the variable on tasks.
    5. In the Value To Assign field, do one of the following:
      • To set the user from literal mode, select the appropriate user from the drop-down list.
      • To set the user using an expression, click the expression button and do one of the following:
        • Add the expression inline.
        • Click the Edit Expression button to open the Edit Expression Editor and build your expression.
    6. To optionally add another variable, click the Add update statement button. 



    To indicate the nature of an interaction, agents specify wrap-up codes; for example, a completed sale, a customer dissatisfied with service, or a billing problem. In Architect, a wrap-up code expression assigns a specific code to a variable, which can then be used throughout the flow. Wrap-up codes are established and configured by the PureCloud administrator.

    This action is available from the Architect toolbox, located in the task editor.

    Add a wrap-up code variable to a task sequence

    In a task sequence, you can add a wrap-up code variable to an Update Data data action.

    1. From the Toolbox, expand the Data category and drag an Update Data action to the desired location in the task.
    2. On the Update Data design form, in the Name field add a meaningful name to describe the item.
    3. Click the Add update statement button and select Wrapupcode.
    4. In the Variable Name field, type the label to identify the variable on tasks.
    5. In the Value To Assign field, do one of the following:
      • To set the wrap-up code from literal mode, select the appropriate code from the drop-down list.
      • To set the wrap-up code using an expression, click the expression button and do one of the following:
        • Add the expression inline.
        • Click the Edit Expression button to open the Edit Expression Editor and build your expression.
    6. To optionally add another variable, click the Add update statement button.