BMC Helix Business Workflows connector documentation reference
This is the main class of an extension, is the entry point from which configurations, connection providers, operations and sources are going to be declared.
Configurations
Config
Default configuration
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name | String | The name for this configuration. Connectors reference the configuration with this name. | x | |
Connection | The connection types that can be provided to this configuration. | x | ||
Expiration Policy | Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit. |
Connection Types
Connection
This class (as it's name implies) provides connection instances and the funcionality to disconnect and validate those connections.
All connection related parameters (values required in order to create a connection) must be declared in the connection providers.
This particular example is a PoolingConnectionProvider which declares that connections resolved by this provider will be pooled and reused. There are other implementations like CachedConnectionProvider which lazily creates and caches connections or simply ConnectionProvider if you want a new connection each time something requires one.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Host Name | String | x | ||
User Name | String | x | ||
Password | String | x | ||
Connection Timeout | Number | 10 | ||
Connection Timeout Unit | Enumeration, one of:
| Time unit to be used in the Connection Timeout | SECONDS | |
TLS Configuration | ||||
Reconnection | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy | |||
host_proxy | String | |||
port_proxy | Number | |||
username_proxy | String | |||
password_proxy | String | |||
NTLM Domain | String |
Associated Operations
Operations
Create Case
<BWF:create-case>
Operation to create case in BMC Helix Business Workflows
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Create Case Payload | Any | #[payload] | ||
Streaming Strategy | Configure if repeatable streams should be used and their behaviour | |||
Target Variable | String | The name of a variable on which the operation's output will be placed | ||
Target Value | String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Output
Type | Any |
Attributes Type |
For Configurations
Throws
- BWF:RETRY_EXHAUSTED
- BWF:CONNECTIVITY
- BWF:VALIDATION_FAILED
- BWF:EXECUTION
- MULE:CONNECTIVITY
Get Case
<BWF:get-case>
Operation to Get case Details from BMC Helix Business Workflows
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Get Case Payload | Any | #[payload] | ||
Streaming Strategy | Configure if repeatable streams should be used and their behaviour | |||
Target Variable | String | The name of a variable on which the operation's output will be placed | ||
Target Value | String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Output
Type | Any |
Attributes Type |
For Configurations
Throws
- BWF:RETRY_EXHAUSTED
- BWF:CONNECTIVITY
- BWF:VALIDATION_FAILED
- BWF:EXECUTION
- MULE:CONNECTIVITY
Search Cases
<BWF:search-cases>
Operation to Search case from BMC Helix Business Workflows
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Search Case Payload | Any | #[payload] | ||
Maximum Number Of Records To Be Processed | String | |||
Maximum Records Per Page | String | |||
Streaming Strategy | Configure if repeatable streams should be used and their behaviour | |||
Target Variable | String | The name of a variable on which the operation's output will be placed | ||
Target Value | String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Output
Type | Any |
Attributes Type |
For Configurations
Throws
- BWF:RETRY_EXHAUSTED
- BWF:CONNECTIVITY
- BWF:VALIDATION_FAILED
- BWF:EXECUTION
- MULE:CONNECTIVITY
Update Case
<BWF:update-case>
Operation to update case to BMC Helix Business Workflows
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Update Case Payload | Any | #[payload] | #[payload] | |
Streaming Strategy | Configure if repeatable streams should be used and their behaviour | |||
Target Variable | String | The name of a variable on which the operation's output will be placed | ||
Target Value | String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Output
Type | Any |
Attributes Type |
For Configurations
Throws
- BWF:RETRY_EXHAUSTED
- BWF:CONNECTIVITY
- BWF:VALIDATION_FAILED
- BWF:EXECUTION
- MULE:CONNECTIVITY
Types
Tls
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Enabled Protocols | String | A comma separated list of protocols enabled for this context. | ||
Enabled Cipher Suites | String | A comma separated list of cipher suites enabled for this context. | ||
Trust Store | ||||
Key Store | ||||
Revocation Check |
Trust Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path | String | The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. | ||
Password | String | The password used to protect the trust store. | ||
Type | String | The type of store used. | ||
Algorithm | String | The algorithm used by the trust store. | ||
Insecure | Boolean | If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. |
Key Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path | String | The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. | ||
Type | String | The type of store used. | ||
Alias | String | When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. | ||
Key Password | String | The password used to protect the private key. | ||
Password | String | The password used to protect the key store. | ||
Algorithm | String | The algorithm used by the key store. |
Standard Revocation Check
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Only End Entities | Boolean | Only verify the last element of the certificate chain. | ||
Prefer Crls | Boolean | Try CRL instead of OCSP first. | ||
No Fallback | Boolean | Do not use the secondary checking method (the one not selected before). | ||
Soft Fail | Boolean | Avoid verification failure when the revocation server can not be reached or is busy. |
Custom Ocsp Responder
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Url | String | The URL of the OCSP responder. | ||
Cert Alias | String | Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
Crl File
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path | String | The path to the CRL file. |
Reconnection
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fails Deployment | Boolean | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy | ||
Reconnection Strategy | The reconnection strategy to use |
Reconnect
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency | Number | How often (in ms) to reconnect | ||
Count | Number | How many reconnection attempts to make |
Reconnect Forever
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency | Number | How often (in ms) to reconnect |
Expiration Policy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Idle Time | Number | A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it's considered eligible for expiration | ||
Time Unit | Enumeration, one of:
| A time unit that qualifies the maxIdleTime attribute |
Response Status
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Headers | Object | |||
Status Code | Number |
Repeatable In Memory Stream
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size | Number | This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. | ||
Buffer Size Increment | Number | This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. | ||
Max Buffer Size | Number | This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit. | ||
Buffer Unit | Enumeration, one of:
| The unit in which all these attributes are expressed |
Repeatable File Store Stream
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Size | Number | Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk. | ||
Buffer Unit | Enumeration, one of:
| The unit in which maxInMemorySize is expressed |
Comments
Log in or register to comment.