Set Properties
apama.analyticsbuilder.blocks.SetProperties
Outputs a pulse with properties set from values on the input ports.
The property names are taken from the parameters and the values from the input ports. New properties are only output if they have been received. An output is sent as soon as at least one of the inputs is provided.
Properties are set on the output in the following order of precedence:
1. Any properties which have been explicitly specified by the use of a parameter. If an input is a pulse, it is treated as an object using the properties of that input. If an input has a primary value (not a pulse), then the primary value is used. To use the properties instead, use the Extract Property block with the Property Path parameter not set and the Property Type parameter set to Properties which replaces the primary value with a pulse (which is ignored) and the properties are used.
2. The properties of any Value object on an input port which does not have the corresponding parameter set. This is a straight merge of the properties dictionary. If two dictionaries have the same property key, then the input port with the lowest identifier has precedence. Thus any shared properties on Input 1 overwrite properties from Input 2 and down.
3. Any properties on a Value object provided to the Merge input port are kept if they are not overwritten by either of the operations above. The optional Merge input port allows chaining or supplementing a set of properties from another block.
Thus, any properties set on an input are overwritten by those with the same name on a higher precedence input, or when an input is configured for the specified property.
Parameters
Name | Description | Type | Notes |
Property 1 | A property to set in the output, using the value from input port 1. | string | Optional |
Property 2 | A property to set in the output, using the value from input port 2. | string | Optional |
Property 3 | A property to set in the output, using the value from input port 3. | string | Optional |
Property 4 | A property to set in the output, using the value from input port 4. | string | Optional |
Property 5 | A property to set in the output, using the value from input port 5. | string | Optional |
Input Port Details
Name | Description | Type |
Input 1 | Value to be added using the property name in parameter Property 1. | any |
Input 2 | Value to be added using the property name in parameter Property 2. | any |
Input 3 | Value to be added using the property name in parameter Property 3. | any |
Input 4 | Value to be added using the property name in parameter Property 4. | any |
Input 5 | Value to be added using the property name in parameter Property 5. | any |
Merge | Source to merge with the specified properties. Properties from here not replaced by an input value are passed through to the output. | any |
Output Port Details
Name | Description | Type |
Output | The output value with extra properties supplied. | pulse |