Skip to main content

Session agent reference

Session agent reference

Configuration

Suppose that a contact phone number field needs to be enabled via MD5 search and blocked from common access. This value is stored in the request as CONTACT_PHONE. Values are stored in XXX-XXX-XXXX format.

  1. Open the Privacy Filter through TMS.
    1. In the WorldView tab, click the Transport Service node.
    2. Click Privacy Filter configuration.
    3. Click View/Edit in the Config Actions panel.
  2. The Privacy Filter configuration opens.
  3. Create an action to copy the field CONTACT_PHONE to CON_PHONE_HASH in the [appdata] section, where it is automatically indexed.
    1. Click Add Action.
    2. The following fields must be specified. The others are optional:
      Option
      Description
      Name
      Enter a name for the action. This name must be unique among all action. For our example, call it CopyContactPhoneToHash.
      Action
      Set this value to ReqSet, which sets or replaces the value for the specified name/value pair in the request. Creates the name/value pair if it doesn't exist.
      Section
      The Section option is used to identify the name of the section containing the data to process. You can leave it blank, which scans the entire request buffer.
      Field
      For our example, enter CONTACT_PHONE.
      Value Name
      Leave this value blank.
      Invert Action
      Set this value to false.
      Start Pattern
      Leave this value blank.
      End Pattern
      Leave this value blank.
      ReqSet Section
      Set this value to appdata to place the name/value pair in the [appdata] section.
      ReqSet Field
      Set this value to CON_PHONE_HASH.
      ReqSet Result
      Leave this value blank.
      MD5
      Set this value to true to apply an MD5 hash to the field. Later, the search field has the MD5 applied to the entered string to retrieve values from the new field.
      Checksum
      Set this value to false.
    3. Save the new CopyContactPhoneToHash action.
  4. Create an action to block the data in CONTACT_PHONE.
    1. Click Add Action.
    2. The following fields must be specified. The others are optional:
      Option
      Description
      Name
      Enter a name for the action. This name must be unique among all action. For our example, call it BlockContactPhone.
      Action
      This example uses Block, which blocks data. You may also choose Encrypt.
      Section
      The Section option is used to identify the name of the section containing the data to process. You can leave it blank, which scans the entire request buffer.
      Field
      For our example, enter CONTACT_PHONE.
      Value Name
      Leave this value blank.
      Invert Action
      Set this value to false.
      Start Pattern
      Leave this value blank.
      End Pattern
      Leave this value blank.
      Strike Character
      Strike Character is used to replace the original data that is blocked or encrypted with an alphanumeric character. For this blocking example, use X.
      Strike Length
      Leave this value blank.
      Blocking Mask
      The Blocking Mask value is a regular expression that specifies which characters in the found data are replaced with the strike character.
      Note: Be careful when using Blocking Mask. If the data does not match the regular expression specified for Blocking Mask then the data is not blocked or encrypted.
      Replace String
      Leave this value blank.
    3. Save the new BlockContactPhone action.
  5. Create a rule to look for the field CONTACT_PHONE. This rule evaluates each hit to determine if it contains the field.
    1. Click Add Rule.
    2. The following fields must be specified. The others are optional:
      Option
      Description
      Name
      Enter a name for the rule. Rule names must be in the form of Rule + Sequential Number.
      ReqField
      Enter the name of the field to look for. In our example, this field is CONTACT_PHONE.
      ReqOp
      For this rule, select exists, which evaluates to true if the field exists in the data.
      Stop Processing
      Set this value to false to continue processing further rules when this rule evaluates to true.
      Enabled
      Set this value to true.
      Actions
      Select the actions you previous created. You must select them so that they appear in the following order: 1) CopyContactPhoneToHash, 2) BlockContactPhone
      Note: The copy action must be executed before the block or encrypting action.
      Tests
      For this example, no test is required.
    3. To save the rule, click OK.
  6. Click Save to save your changes.
  7. Configure a task to push the changes to all servers.
  8. You can configure a search template to include the field CON_PHONE_HASH.
    • The field should be included in a completed search template.
    • The field must be configured to have MD5 hashing enabled.
    • Users of the search template must be informed that they should not insert dashes - in their search strings of this field. An example value might be 4154958000.
  9. You can optionally create a session list template to include this new field value in the displayed output.
    Note: Values do not become available for search using a completed search template until a completed session containing the CON_PHONE_HASH has been captured and indexed.

Related articles

community icon

Join the community

Ask questions, share best practices, and connect with fellow marketers.

Ask a question

Academy

Read how-to articles, guides, and more to help you on the path to success.

Learn more