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

Name	Type	Description	Default Value	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.		x
Connection	Basic Authentication Connection Pass Through Connection	The connection types that can be provided to this configuration.		x
Language	String	The default language for requests. This can be overridden during the operation.	en
SessionClose	Boolean	Whether to leave the session open or not. This can be overridden during the operation.	true
Response Timeout Unit	Enumeration, 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 Timeout	Number	The amount of time to wait for response timeout from the enosix framework. This can be overridden during the operation.	30
Name	String	The identifier of this element used to reference it in other components.		x
Expiration Policy	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

Basic Authentication Connection

Parameters

Name	Type	Description	Default Value	Required
URL	String			x
Username	String			x
Password	String			x
XSD Path	String	This should be enosix_xsd under mule project resource directory		x
Client	Number		800
Proxy config	Proxy	Reusable configuration element for outbound connections through a proxy
TLS configuration	TLS
Reconnection	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

Pass Through Connection

Parameters

Name	Type	Description	Default Value	Required
URL	String			x
Authorization Header	String	Bearer token		x
XSD Path	String	This should be enosix_xsd under mule project resource directory		x
Client	Number		800
Proxy config	Proxy	Reusable configuration element for outbound connections through a proxy
TLS configuration	TLS
Reconnection	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

Pass Through Connection

Parameters

Name	Type	Description	Default Value	Required
URL	String			x
Authorization Header	String	Bearer token		x
XSD Path	String	This should be enosix_xsd under mule project resource directory		x
Client	Number		800
Proxy config	Proxy	Reusable configuration element for outbound connections through a proxy
TLS configuration	TLS
Reconnection	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

Associated Operations

• Command  

• Create  

• Get  

• Check Connection  

• Execute  

• Search  

• Update  

Operations

Command

<enosix:command>

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

Parameters

Name	Type	Description	Default Value	Required
configuration	String	The name of the configuration to use.		x
config Ref	configurationProvider	The name of the configuration to be used to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	configure if repeatable streams should be used and their behaviour
Type	String	The business object name		x
Command	String	Command for the business object		x
Http Headers	Object	Provide http headers
Key	String	The ID of the object	$*$
Payload	Binary	Input payload for the command operation	#[payload]
Language	String	The language that should be used in the enosix framework
Session Close	Boolean	Whether to leave the SAP session open or not
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	The units of time to wait for a reply from the enosix framework
Response Timeout	Number	The amount of time to wait for a reply from the enosix framework
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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Output

Type	Binary
Attributes Type	Enosix Attributes

For configurations

• config  

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

Name	Type	Description	Default Value	Required
configuration	String	The name of the configuration to use.		x
config Ref	configurationProvider	The name of the configuration to be used to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	configure if repeatable streams should be used and their behaviour
Type	String	The business object name		x
Payload	Binary	Input payload	#[payload]
Return Complete Document	Boolean	Return complete Document or not	true
Http Headers	Object	Provide http headers
Language	String	The language that should be used in the enosix framework
Session Close	Boolean	Whether to leave the SAP session open or not
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	The units of time to wait for a reply from the enosix framework
Response Timeout	Number	The amount of time to wait for a reply from the enosix framework
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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Output

Type	Binary
Attributes Type	Enosix Attributes

For configurations

• config  

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

Name	Type	Description	Default Value	Required
configuration	String	The name of the configuration to use.		x
config Ref	configurationProvider	The name of the configuration to be used to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	configure if repeatable streams should be used and their behaviour
Type	String	The business object name		x
Key	String	The ID of the object		x
Http Headers	Object	Provide http headers
Language	String	The language that should be used in the enosix framework
Session Close	Boolean	Whether to leave the SAP session open or not
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	The units of time to wait for a reply from the enosix framework
Response Timeout	Number	The amount of time to wait for a reply from the enosix framework
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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Output

Type	Binary
Attributes Type	Enosix Attributes

For configurations

• config  

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

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Http Headers	Object	Input http headers for login operation
config Ref	configurationProvider	The name of the configuration to be used to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	configure if repeatable streams should be used and their behaviour
Session Close	Boolean	Whether to leave the SAP session open or not
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	The units of time to wait for a reply from the enosix framework
Response Timeout	Number	The amount of time to wait for a reply from the enosix framework
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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Output

Type	Binary
Attributes Type	Enosix Attributes

For configurations

• config  

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

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Config Ref	ConfigurationProvider	The name of the configuration to be used to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure if repeatable streams should be used and their behaviour
Function Name	String	RFC function name		x
Payload	Binary	Input payload	#[payload]
Http Headers	Object	Provide http headers
Language	String	The language that should be used in the enosix framework
Session Close	Boolean	Whether to leave the SAP session open or not
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	The units of time to wait for a reply from the enosix framework
Response Timeout	Number	The amount of time to wait for a reply from the enosix framework
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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Output

Type	Binary
Attributes Type	Enosix Attributes

For Configurations

• Config  

Throws

• ENOSIX:CONNECTIVITY  

• ENOSIX:INTERRUPTED_ERROR  

• ENOSIX:PARSER_ERROR  

• ENOSIX:RESPONSE_TIMEOUT  

• ENOSIX:RETRY_EXHAUSTED  

• ENOSIX:XSD_NOT_FOUND  

Search

<enosix:search>

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

Parameters

Name	Type	Description	Default Value	Required
configuration	String	The name of the configuration to use.		x
config Ref	configurationProvider	The name of the configuration to be used to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	configure if repeatable streams should be used and their behaviour.
Type	String	The business object name.		x
Page Size	Number	Page Size
Page Number	Number	Page Number
Payload	Binary	Payload for search operation.	#[payload]
Http Headers	Object	Provide http headers
Sort Fields	Binary	Sort fields for search operation.
Language	String	The language that should be used in the enosix. framework
Session Close	Boolean	Whether to leave the SAP session open or not.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	The units of time to wait for a reply from the enosix framework
Response Timeout	Number	The amount of time to wait for a reply from the enosix. framework
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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Output

Type	Binary
Attributes Type	Enosix Attributes

For configurations

• config  

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

Name	Type	Description	Default Value	Required
configuration	String	The name of the configuration to use.		x
config Ref	configurationProvider	The name of the configuration to be used to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	configure if repeatable streams should be used and their behaviour.
Type	String	The business object name.		x
Payload	Binary	Input payload	#[payload]
Return Complete Document	Boolean	Return Complete Document or not	true
Http Headers	Object	Provide http headers
Key	String	The ID of the object.		x
Language	String	The language that should be used in the enosix framework.
Session Close	Boolean	Whether to leave the SAP session open or not.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	The units of time to wait for a reply from the enosix framework.
Response Timeout	Number	The amount of time to wait for a reply from the enosix framework.
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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Output

Type	Binary
Attributes Type	Enosix Attributes

For configurations

• config  

Throws

• ENOSIX:CONNECTIVITY  

• ENOSIX:INTERRUPTED_ERROR  

• ENOSIX:PARSER_ERROR  

• ENOSIX:RESPONSE_TIMEOUT  

• ENOSIX:RETRY_EXHAUSTED  

• ENOSIX:XSD_NOT_FOUND  

Types

Proxy

Field	Type	Description	Default Value	Required
Host	String	Host where the proxy requests will be sent.		x
Port	Number	Port where the proxy requests will be sent.		x
Username	String	The username to authenticate against the proxy.
Password	String	The password to authenticate against the proxy.
Non Proxy Hosts	String	A list of comma separated hosts against which the proxy should not. be used.

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	Trust Store
Key Store	Key Store
Revocation Check	Standard Revocation Check Custom Ocsp Responder Crl File

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	Reconnect Reconnect Forever	The reconnection strategy to use

Reconnect

Field	Type	Description	Default Value	Required
Frequency	Number	How often (in ms) to reconnect
Blocking	Boolean	If false, the reconnection strategy will run in a separate, non-blocking thread
Count	Number	How many reconnection attempts to make

Reconnect Forever

Field	Type	Description	Default Value	Required
Frequency	Number	How often (in ms) to reconnect
Blocking	Boolean	If false, the reconnection strategy will run in a separate, non-blocking thread

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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the maxIdleTime attribute

Enosix Attributes

Field	Type	Description	Default Value	Required
Edit Mode	String
Headers	Object
Key	String
Messages	Array of Object
Paging Info	Object
Success	Boolean

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 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 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: BYTE KB MB GB	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: BYTE KB MB GB	The unit in which maxInMemorySize is expressed.

Messages

Field	Type	Description	Default Value	Required
Messages	Messages Type			x

Messages Type

Field	Type	Description	Default Value	Required
Message	Enumeration, one of: messages1 messages2