Real Time Input
- Ben Clark
Overview
Most DDE rules start with a Real Time Input
This is the plugin that pulls in the real-time data into the Rule
It contains JSON messages that are relevant to the rule
A Decode JSON step would typically follow this step
Example:
A rule has been created that requires Customer information to be stored. The following JSON message will be passed to the rule from a website:
{
"Customer Id": 1,
"Email Address": "ExampleOne@domain.com",
"Customer Name": "Example One"
}The Realtime Input will receive this JSON.
Plugin Configuration
General Settings
Within the General Settings tab:
The following settings can be configured:
Setting | Description |
|---|---|
Overflow protection | If running in DDE drop the row of data if the processing timeout has expired. Only used if the rule contains a Realtime Output Step |
Use test data | When the rule starts then process the data within the “Test Data” tab. It is worth noting that the test data will always be used when started within Spoon |
Repeat test data | Used in conjunction with the “Use test data” setting, this setting keeps processing the same set of test data indefinitely. This is useful for running third-party GET requests on a schedule for example |
Other fields | Other fields that may also available can be found here. Client IP: ClientIP allows a field containing the browsers IP address to be passed into a field. DDE Rule Information: DDE_Client, DDE_Target, DDE_Rule allows a field containing information on the Rule and where it is being run to be created DDE Calling Rule Information: DDE_Referrer_Client, DDE_Referrer_Target, DDE_Referrer_Rule allows a field containing information on the Rule calling this Rule to be added to fields. Invoke_Method: is useful when the an API uses a single DDE URL endpoint for multiple invoke methods. This field allow the invoke method to be added to a field and each method treated independently in a single Rule.
|
Test Data
Within the Test Data tab:
The following settings can be configured:
Setting | Description |
|---|---|
Delay Time (ms) | The time delay in milliseconds between each row of test data being output |
Message | JSON messages to be used for testing the DDE rule. It is recommended that all JSON variances should be tested before deploying to DDE. |
Description | A Description for the Test row. This will show within the Test screen within Rule Designer |
Default Output
Within the Default Output tab:
The following settings can be configured:
| Description |
|---|---|
HTTP Code | This HTTP code is used in Real-time output steps added by Rule Designer as the standard response. |
Static Value | This value is used where control groups are configured. This is used as the default value for those persons in the control group as the “response” from the rule where a Realtime Output step is used. |
Response Content Type | A suitable response content type is automatically selected. Other commonly used options are available for selection |
Timeout Settings
Within the Timeout Settings tab:
The following settings can be configured:
Description
| Description |
|---|---|
Timeout (ms) | The time in milliseconds, after which the default value should be returned if the rule times out |
HTTP Code | The default value to return after a timeout |
Static Value | A static value that can also be returned after a timeout |
Priority | Allows the priority to be configured |
Scenarios
Running Simulation Tests
It is possible to run simulation tests in DDE
The Real Time Input Step allows you to push test data through the rule periodically
This method can also be used to schedule rules to run every x milliseconds
Running a Rule on a Schedule
It is possible to schedule a rule to run every x milliseconds. The below example shows how to configure the Realtime Input to run every 5 minutes:
Enable "Use test data"
Enable "Repeat test data"
Have a dummy test data record
Set the delay to the required time e.g. 5 mins = 300,000 milliseconds
The proceeding step, runs what you need (e.g. Call a third-party web request)