Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 4.53 KB

signal-extension-and-rules-engine-integration.md

File metadata and controls

83 lines (52 loc) · 4.53 KB
Raw

Signal extension and Rules Engine integration

The rules that you set up can use the available triggers and conditions, which result in one of the following actions:

  • Send a postback
  • Send Personally Identifiable Information (PII)
  • Open a URL

After these actions have been configured to be triggered and published, the Signal extension carries out the requested actions.

To send PII data to external destinations, the PII action can trigger the rules engine when certain triggers and traits match. When setting a rule, you can also set the PII action for a Signal event. The collectPii API can then be used to trigger the rule and send the PII data.

Rules tokens

Rules tokens are special strings that are used in rule actions as values and are expanded by the SDK when the action is carried out. The format of a token is `

, where token is any data element that is defined in Experience Platform Launch for a mobile property that identifies the source of the data from which the token is expanded. For example,

can be used in the Signal postback action, whereMy Data element for ECID` is a data element that was created using the Mobile Core extension, and the data element type is Experience Cloud ID.

The token can also be one of the reserved key names. For more information, see the matching and retrieving values by keys tutorial.

Some tokens are modifier functions that specify the transformation that is applied to the value that was replaced by the token. An example is urlenc, which specifies that the value will be URL-encoded before it is replaced in the rule.

Using tokens in Postbacks and PII rule actions

The Send Postback and Send PII actions allow you to specify a URL field and an optional Post Body field. You can specify which tokens should be expanded by the Experience Platform SDKs when the postback or PII network call is triggered. For more information on tokens, see the rule tokens documentation.

Example

The following example shows how to use the data that is passed to the MobileCore (Android) / ACPCore (iOS) collectPii API to form a token:

  1. In the mobile application, call collectPII to fire Event with context data.

     Signal.registerExtension();
 ...
 Map<String, String> data = new HashMap<String, String>();
 data.put("user_email", "[email protected]");
 MobileCore.collectPII(data);

    Objective-C

     [ACPSignal registerExtension];
 ...
 [ACPCore collectPii:data:@{@"user_email" : @"[email protected]"}];

    Swift

     ACPSignal.registerExtension()
 ...
 let piiContextData: [String: String] = ["user_email" : "[email protected]"]
 ACPCore.collectPii(piiContextData)

  2. In Experience Platform Launch, create a data element for the user_email context data key.

    Data Element Example for Collect PII context data key

  3. In Experience Platform Launch, create a new rule for sending a postback.

  4. Create a new rule by selecting the Mobile Core Collect PII event and the Action Mobile Core Send Postback action.

    Rule example using Collect PII event and Postback action

  5. Select the data element that you created in step 1 for the Postback action.

  6. Edit the Send Postback action and include the following URL in the corresponding edit box:

     https://my.company.com/users?email={%%Mobile Core Context Data email%%}

    Send Postback action example

For more information about collectPii and its usage, see collectPii in the Mobile Core API reference.

Using tokens in Open URL rule actions

Similarly to using tokens in postbacks and PII rule actions, Open URL actions allow you to specify a URL, which can contain the tokens that will be expanded by the Experience Platform SDKs. For more information about tokens, see the rule tokens documentation.