Success
| Short Description |
| Ports |
| Success Attributes |
| Details |
| See also |
Short Description
Success is a successful endpoint in a jobflow.
| Component | Data output | Input ports | Output ports | Transformation | Transf. required | Java | CTL | Auto-propagated metadata |
|---|---|---|---|---|---|---|---|---|
| Success | none | 0-1 | 0 | ⨯ | ⨯ | ⨯ | ✓ | ✓ |
Ports
| Port type | Number | Required | Description | Metadata |
|---|---|---|---|---|
| Input | 0-1 | ✓ | For received tokens | Any |
Success Attributes
| Attribute | Req | Description | Possible values |
|---|---|---|---|
| Basic | |||
| Message | no | Text message to log for each incoming token. | text |
| Mapping | no | Mapping is used for dynamic assembling of a log message. Moreover, dictionary content can be changed as well. See Details. | |
Details
Success is a successful endpoint in a jobflow. Tokens that flow into the component are not processed anymore - they are considered to be successfully processed within the jobflow. The component can serve as a visual marker of success in a jobflow.
The component can log a message and set contents of a dictionary - it is similar to the Fail component.
Mapping details
Mapping in the Success component is generally used for two purposes:
Assembling of a log message from an incoming record.
Populating a dictionary content from an incoming record.
![[Note]](../figures/note.png)
Note Only output dictionary entries can be changed.
A log message compiled by the mapping has the highest priority. If the mapping does not set 'message', the message from the component attribute is used instead. If no message is set via the attribute or mapping, nothing is logged.