Realtime Input
- Ben Clark
The majority of Rules you build in Rule Designer will start with a Realtime Input Step. This allows you to call the Rule and allows you to understand the Fields and Field formats that need to be passed to the Rule.
You may need to build Input Templates for your use case specific Rules. To provide a quick start we have a Public Template called Realtime Input. This contains all the Fields that are required for a Rule containing a Get CXID Public template to work. This can be downloaded, altered and re-uploaded to create your own input templates.
Input Data
Field | Description | Example |
|---|---|---|
Message | The message contains the Mandatory Field required for a Rule with a Get CXID. These are passed through in a JSON string. The Required Fields are: AlterianCX_channelagentid1 AlterianCX_channelagentid2 AlterianCX_channelagentid3 AlterianCX_isknown AlterianCX_referrer AlterianQueue_channel AlterianQueue_location AlterianQueue_position | { "AlterianCX_channelagentid1": "Test@alterian.com", "AlterianCX_channelagentid2": "71e33980-d95c-403a-925b-6babf82546ff", "AlterianCX_channelagentid3": "", "AlterianCX_isknown": "Y", "AlterianCX_referrer": "http://www.acadianhotels.co.uk/", "AlterianQueue_location": "http://www.acadianhotels.co.uk/", "AlterianQueue_position": "HeroBanner", "AlterianQueue_channel": "Web"} |
Configuration
No configuration items exist.
Processing
This tile template will take the message break it into the required fields for a GET CXID Rule to run. It will also add to the Rule flow various Fields that are used later in the Rule.
Output Data
Field | Description | Example |
|---|---|---|
Message | Message Passed to the Rule by the Calling system. This should contain all the fields required |
|
AlterianCX_channelagentid1 | channelagentid1 - First identification value. Provide whatever information you have to identify the individual exposed to this Rule. | Mandatory* |
ClientIP | IP of the calling solution. This can be used for geographic location identification with other Public Templates and to block or allow certain IPs to call the Rule. | Created by Rule Where available |
AlterianCX_channelagentid2 | channelagentid1 - Second identification value. Provide whatever information you have to identify the individual exposed to this Rule. | Not Mandatory* |
AlterianCX_channelagentid3 | channelagentid1 - Third identification value. Provide whatever information you have to identify the individual exposed to this Rule. | Not Mandatory* |
AlterianCX_isknown | Is one of the identification values (channelagentid) for the individual good enough for us to consider that they are “known” to the brand? | Not Mandatory |
AlterianCX_referrer | referrer for this Invoke | Not Mandatory |
AlterianQueue_channel | What Channel is using this Rule for this specific call | Mandatory |
AlterianQueue_location | the Location where the Rule is being called from or where the invidual is when they are exposed to the results of the Rule. | Mandatory for tracking and listening Rules |
AlterianQueue_position | Where within the Location the rule is being used. Top Banner, Hero banner, Footer banner could all be on the home page using the same rule. Rule Position identifies which one was using the Rule in this specific call. | Not Mandatory |
Sequence Number | Internal Field to identify a specific Invoke and the steps and tiles it went through. | System Generated |
Time Stamp | Internal Field to identify a Time that an action occurred | System Generated |
loopcount | Internal Field to restrict infinite loops | System Generated |
Is Control | Internal Field to identify whether this individual is in the Control Group for this Rule. Populated by the Get CXID | System Generated |
Rule Group | Internal Field to identify whether this Rule was called from a Rule Group. The Rule Group will be populated automatically | System Generated |
Rule Type | Internal Field to identify the type of Rule. Populated automatically by various Templates or manually when a Rule is saved. | System Generated |
*Not Mandatory if one of the other values is populated