Skip to main content

enosix Module Connector Reference

This is the main class of an extension, it is the entry point from which configurations, connection providers, operations and sources are going to be declared.

configurations


config

Default configuration

Parameters

NameTypeDescriptionDefault ValueRequired
NameStringThe name for this configuration. Connectors reference the configuration with this name.x
ConnectionThe connection types that can be provided to this configuration.x
LanguageStringThe default language for requests. This can be overridden during the operation.en
SessionCloseBooleanWhether to leave the session open or not. This can be overridden during the operation.true
Response Timeout UnitEnumeration, one of:
  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
The unit of time to wait for response time out from the enosix framework. This can be overridden during the operation.SECONDS
Response TimeoutNumberThe amount of time to wait for response timeout from the enosix framework. This can be overridden during the operation.30
NameStringThe identifier of this element used to reference it in other components.x
Expiration PolicyExpiration Policyconfigures 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

Basic Authentication Connection
Parameters
NameTypeDescriptionDefault ValueRequired
URLStringx
UsernameStringx
PasswordStringx
XSD PathStringThis should be enosix_xsd under mule project resource directoryx
ClientNumber800
Proxy configProxyReusable configuration element for outbound connections through a proxy
TLS configurationTLS
ReconnectionReconnectionWhen 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
Pass Through Connection
Parameters
NameTypeDescriptionDefault ValueRequired
URLStringx
Authorization HeaderStringBearer tokenx
XSD PathStringThis should be enosix_xsd under mule project resource directoryx
ClientNumber800
Proxy configProxyReusable configuration element for outbound connections through a proxy
TLS configurationTLS
ReconnectionReconnectionWhen 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
Pass Through Connection
Parameters
NameTypeDescriptionDefault ValueRequired
URLStringx
Authorization HeaderStringBearer tokenx
XSD PathStringThis should be enosix_xsd under mule project resource directoryx
ClientNumber800
Proxy configProxyReusable configuration element for outbound connections through a proxy
TLS configurationTLS
ReconnectionReconnectionWhen 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

Associated Operations

Operations

Command

<enosix:command>

Command operation is used to run the set of commands supported by enosix SAP framework on Rapid Integration Objects.

Parameters

NameTypeDescriptionDefault ValueRequired
configurationStringThe name of the configuration to use.x
config RefconfigurationProviderThe name of the configuration to be used to execute this component.x
Streaming Strategyconfigure if repeatable streams should be used and their behaviour
TypeStringThe business object namex
CommandStringCommand for the business objectx
Http HeadersObjectProvide http headers
KeyStringThe ID of the object$*$
PayloadBinaryInput payload for the command operation#[payload]
LanguageStringThe language that should be used in the enosix framework
Session CloseBooleanWhether to leave the SAP session open or not
Response Timeout UnitEnumeration, one of:
  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
The units of time to wait for a reply from the enosix framework
Response TimeoutNumberThe amount of time to wait for a reply from the enosix framework
Target VariableStringThe name of a variable on which the operation’s output will be placed
Target ValueStringAn 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 StrategyA retry strategy in case of connectivity errors

Output

TypeBinary
Attributes TypeEnosix Attributes

For configurations

Throws

  • ENOSIX:CONNECTIVITY  

  • ENOSIX:INTERRUPTED_ERROR  

  • ENOSIX:PARSER_ERROR  

  • ENOSIX:RESPONSE_TIMEOUT  

  • ENOSIX:RETRY_EXHAUSTED  

  • ENOSIX:XSD_NOT_FOUND  

Create

<enosix:create>

Create operation is used to create detailed Rapid Integration Object using enosix SAP framework.

Parameters

NameTypeDescriptionDefault ValueRequired
configurationStringThe name of the configuration to use.x
config RefconfigurationProviderThe name of the configuration to be used to execute this component.x
Streaming Strategyconfigure if repeatable streams should be used and their behaviour
TypeStringThe business object namex
PayloadBinaryInput payload#[payload]
Return Complete DocumentBooleanReturn complete Document or nottrue
Http HeadersObjectProvide http headers
LanguageStringThe language that should be used in the enosix framework
Session CloseBooleanWhether to leave the SAP session open or not
Response Timeout UnitEnumeration, one of:
  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
The units of time to wait for a reply from the enosix framework
Response TimeoutNumberThe amount of time to wait for a reply from the enosix framework
Target VariableStringThe name of a variable on which the operation’s output will be placed
Target ValueStringAn 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 StrategyA retry strategy in case of connectivity errors

Output

TypeBinary
Attributes TypeEnosix Attributes

For configurations

Throws

  • ENOSIX:CONNECTIVITY  

  • ENOSIX:INTERRUPTED_ERROR  

  • ENOSIX:PARSER_ERROR  

  • ENOSIX:RESPONSE_TIMEOUT  

  • ENOSIX:RETRY_EXHAUSTED  

  • ENOSIX:XSD_NOT_FOUND  

Get

<enosix:get>

Get operation is used to get detailed Rapid Integration Object using enosix SAP framework.

Parameters

NameTypeDescriptionDefault ValueRequired
configurationStringThe name of the configuration to use.x
config RefconfigurationProviderThe name of the configuration to be used to execute this componentx
Streaming Strategyconfigure if repeatable streams should be used and their behaviour
TypeStringThe business object namex
KeyStringThe ID of the objectx
Http HeadersObjectProvide http headers
LanguageStringThe language that should be used in the enosix framework
Session CloseBooleanWhether to leave the SAP session open or not
Response Timeout UnitEnumeration, one of:
  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
The units of time to wait for a reply from the enosix framework
Response TimeoutNumberThe amount of time to wait for a reply from the enosix framework
Target VariableStringThe name of a variable on which the operation’s output will be placed
Target ValueStringAn 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 StrategyA retry strategy in case of connectivity errors

Output

TypeBinary
Attributes TypeEnosix Attributes

For configurations

Throws

  • ENOSIX:CONNECTIVITY  

  • ENOSIX:INTERRUPTED_ERROR  

  • ENOSIX:PARSER_ERROR  

  • ENOSIX:RESPONSE_TIMEOUT  

  • ENOSIX:RETRY_EXHAUSTED  

  • ENOSIX:XSD_NOT_FOUND  

Check Connection

<enosix:login>

Login operation is used to check the connection health check for SAP via the enosix framework

Parameters

NameTypeDescriptionDefault ValueRequired
ConfigurationStringThe name of the configuration to use.x
Http HeadersObjectInput http headers for login operation
config RefconfigurationProviderThe name of the configuration to be used to execute this componentx
Streaming Strategyconfigure if repeatable streams should be used and their behaviour
Session CloseBooleanWhether to leave the SAP session open or not
Response Timeout UnitEnumeration, one of:
  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
The units of time to wait for a reply from the enosix framework
Response TimeoutNumberThe amount of time to wait for a reply from the enosix framework
Target VariableStringThe name of a variable on which the operation’s output will be placed
Target ValueStringAn 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 StrategyA retry strategy in case of connectivity errors

Output

TypeBinary
Attributes TypeEnosix Attributes

For configurations

Throws

  • ENOSIX:CONNECTIVITY  

  • ENOSIX:INTERRUPTED_ERROR  

  • ENOSIX:PARSER_ERROR  

  • ENOSIX:RESPONSE_TIMEOUT  

  • ENOSIX:RETRY_EXHAUSTED  

  • ENOSIX:XSD_NOT_FOUND  

Execute

<enosix:rfc>

Execute operation is used to run the RFC / BAPI functions using enisox SAP framework.

Parameters

NameTypeDescriptionDefault ValueRequired
ConfigurationStringThe name of the configuration to use.x
Config RefConfigurationProviderThe name of the configuration to be used to execute this componentx
Streaming StrategyConfigure if repeatable streams should be used and their behaviour
Function NameStringRFC function namex
PayloadBinaryInput payload#[payload]
Http HeadersObjectProvide http headers
LanguageStringThe language that should be used in the enosix framework
Session CloseBooleanWhether to leave the SAP session open or not
Response Timeout UnitEnumeration, one of:
  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
The units of time to wait for a reply from the enosix framework
Response TimeoutNumberThe amount of time to wait for a reply from the enosix framework
Target VariableStringThe name of a variable on which the operation’s output will be placed
Target ValueStringAn 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 StrategyA retry strategy in case of connectivity errors

Output

TypeBinary
Attributes TypeEnosix Attributes

For Configurations

Throws

  • ENOSIX:CONNECTIVITY  

  • ENOSIX:INTERRUPTED_ERROR  

  • ENOSIX:PARSER_ERROR  

  • ENOSIX:RESPONSE_TIMEOUT  

  • ENOSIX:RETRY_EXHAUSTED  

  • ENOSIX:XSD_NOT_FOUND  

<enosix:search>

Search operation is used to find the list of Rapid Integration Object documents from enosix SAP framework

Parameters

NameTypeDescriptionDefault ValueRequired
configurationStringThe name of the configuration to use.x
config RefconfigurationProviderThe name of the configuration to be used to execute this component.x
Streaming Strategyconfigure if repeatable streams should be used and their behaviour.
TypeStringThe business object name.x
Page SizeNumberPage Size
Page NumberNumberPage Number
PayloadBinaryPayload for search operation.#[payload]
Http HeadersObjectProvide http headers
Sort FieldsBinarySort fields for search operation.
LanguageStringThe language that should be used in the enosix. framework
Session CloseBooleanWhether to leave the SAP session open or not.
Response Timeout UnitEnumeration, one of:
  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
The units of time to wait for a reply from the enosix framework
Response TimeoutNumberThe amount of time to wait for a reply from the enosix. framework
Target VariableStringThe name of a variable on which the operation’s output will be placed.
Target ValueStringAn 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 StrategyA retry strategy in case of connectivity errors

Output

TypeBinary
Attributes TypeEnosix Attributes

For configurations

Throws

  • ENOSIX:CONNECTIVITY  

  • ENOSIX:INTERRUPTED_ERROR  

  • ENOSIX:PARSER_ERROR  

  • ENOSIX:RESPONSE_TIMEOUT  

  • ENOSIX:RETRY_EXHAUSTED  

  • ENOSIX:XSD_NOT_FOUND  

Update

<enosix:update>

Update operation is used to update detailed Rapid Integration Object using enisox SAP framework.

Parameters

NameTypeDescriptionDefault ValueRequired
configurationStringThe name of the configuration to use.x
config RefconfigurationProviderThe name of the configuration to be used to execute this component.x
Streaming Strategyconfigure if repeatable streams should be used and their behaviour.
TypeStringThe business object name.x
PayloadBinaryInput payload#[payload]
Return Complete DocumentBooleanReturn Complete Document or nottrue
Http HeadersObjectProvide http headers
KeyStringThe ID of the object.x
LanguageStringThe language that should be used in the enosix framework.
Session CloseBooleanWhether to leave the SAP session open or not.
Response Timeout UnitEnumeration, one of:
  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
The units of time to wait for a reply from the enosix framework.
Response TimeoutNumberThe amount of time to wait for a reply from the enosix framework.
Target VariableStringThe name of a variable on which the operation’s output will be placed.
Target ValueStringAn 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 StrategyA retry strategy in case of connectivity errors

Output

TypeBinary
Attributes TypeEnosix Attributes

For configurations

Throws

  • ENOSIX:CONNECTIVITY  

  • ENOSIX:INTERRUPTED_ERROR  

  • ENOSIX:PARSER_ERROR  

  • ENOSIX:RESPONSE_TIMEOUT  

  • ENOSIX:RETRY_EXHAUSTED  

  • ENOSIX:XSD_NOT_FOUND  

Types

Proxy

FieldTypeDescriptionDefault ValueRequired
HostStringHost where the proxy requests will be sent.x
PortNumberPort where the proxy requests will be sent.x
UsernameStringThe username to authenticate against the proxy.
PasswordStringThe password to authenticate against the proxy.
Non Proxy HostsStringA list of comma separated hosts against which the proxy should not. be used.

TLS

FieldTypeDescriptionDefault ValueRequired
Enabled ProtocolsStringA comma separated list of protocols enabled for this context.
Enabled Cipher SuitesStringA comma separated list of cipher suites enabled for this context.
Trust StoreTrust Store
Key StoreKey Store
Revocation Check

Trust Store

FieldTypeDescriptionDefault ValueRequired
PathStringThe location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.
PasswordStringThe password used to protect the trust store.
TypeStringThe type of store used.
AlgorithmStringThe algorithm used by the trust store.
InsecureBooleanIf true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

FieldTypeDescriptionDefault ValueRequired
PathStringThe location (which will be resolved relative to the current classpath and file system, if possible) of the key store.
TypeStringThe type of store used.
AliasStringWhen 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 PasswordStringThe password used to protect the private key.
PasswordStringThe password used to protect the key store.
AlgorithmStringThe algorithm used by the key store.

Standard Revocation Check

FieldTypeDescriptionDefault ValueRequired
Only End EntitiesBooleanOnly verify the last element of the certificate chain.
Prefer CrlsBooleanTry CRL instead of OCSP first.
No FallbackBooleanDo not use the secondary checking method (the one not selected before).
Soft FailBooleanAvoid verification failure when the revocation server can not be reached or is busy.

Custom OCSP Responder

FieldTypeDescriptionDefault ValueRequired
UrlStringThe URL of the OCSP responder.
Cert AliasStringAlias of the signing certificate for the OCSP response (must be in the trust store), if present.

CRL File

FieldTypeDescriptionDefault ValueRequired
PathStringThe path to the CRL file.

Reconnection

FieldTypeDescriptionDefault ValueRequired
Fails DeploymentBooleanWhen 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 StrategyThe reconnection strategy to use

Reconnect

FieldTypeDescriptionDefault ValueRequired
FrequencyNumberHow often (in ms) to reconnect
BlockingBooleanIf false, the reconnection strategy will run in a separate, non-blocking thread
CountNumberHow many reconnection attempts to make

Reconnect Forever

FieldTypeDescriptionDefault ValueRequired
FrequencyNumberHow often (in ms) to reconnect
BlockingBooleanIf false, the reconnection strategy will run in a separate, non-blocking thread

Expiration Policy

FieldTypeDescriptionDefault ValueRequired
Max Idle TimeNumberA 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 UnitEnumeration, one of:
  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
A time unit that qualifies the maxIdleTime attribute

Enosix Attributes

FieldTypeDescriptionDefault ValueRequired
Edit ModeString
HeadersObject
KeyString
MessagesArray of Object
Paging InfoObject
SuccessBoolean

Repeatable In Memory Stream

FieldTypeDescriptionDefault ValueRequired
Initial Buffer SizeNumberThis 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 IncrementNumberThis is by This is how much the buffer size will be expanded by 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 SizeNumberThis 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 UnitEnumeration, one of:
  • BYTE
  • KB
  • MB
  • GB
The unit in which all these attributes are expressed.

Repeatable File Store Stream

FieldTypeDescriptionDefault ValueRequired
In Memory SizeNumberDefines 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 UnitEnumeration, one of:
  • BYTE
  • KB
  • MB
  • GB
The unit in which maxInMemorySize is expressed.

Messages

FieldTypeDescriptionDefault ValueRequired
MessagesMessages Typex

Messages Type

FieldTypeDescriptionDefault ValueRequired
MessageEnumeration, one of:
  • messages1
  • messages2