Ens.Host

The type of adapter used to communicate with external systems

A comma-separated list of variables to retain in the context between messages.
If this parameter is set, all variables execept those specified in this list will be killed before each message.
This parameter is ignored in InProc business hosts.
This parameter is currently only supported in business operations.

2 modes: Queue, InProc

Users can specify these values in the Configuration Editor

return the name of config item

return the name of queue as returned by the config item

If doing keepalives, the time of the last return from MessageHeaderHandler() or OnKeepalive()

If doing keepalives, the time of the last return from MessageHeaderHandler()

Copy of the text of the last error we reported, so we can avoid alerting more than once

Flag for returning an error that will exit the OnTask() loop and terminate the Job

The session id of the current message being processed

The SuperSession id of the current message being processed

Flag whether we have already warned about the class being recompiled

Is this a real live instance or a shadow instance used just to hold config settings.

The adapter instance

The Alert Groups to which this item belongs.

Send an Alert message whenever an error occurs here

Name of a Business Partner Profile associated with this item

Optional when using dedicated pool of job(s):
This is the DTL used to generate the message group identifier that will be associated for the messages queued to this host.
If a message group identifier is set then only one message per message group identifier can be dequeued and be considered in the pipeline at a time. The 'pipeline' is the route from this host to the Completion Hosts.
This DTL needs to be set to use 'new' for the target.
The source is the request body
The target is Ens.Queue.FIFOMessageGroup.Data
aux is not defined

Optional when using dedicated pool of job(s):
When assigning a message group identifier for messages sent received by this host, this is a comma separated list of the host items that can be the last in the processing of messages for the message group identifier.
The hosts specified will be responsible for releasing the hold on the particular message group identifier.
If this is empty then it will default to this host if applying a message grouping to message processing.
Note: The first matching host will be the one to release.

Send an Alert message if this number of seconds elapses with no messages being processed by this item.
Note that this alert will be sent even if AlertOnError is False.
Zero means no alerts of this type will be sent.

This is transient array of data to either set in request header when making SendRequestAs/Sync call and to store data from received request header.
Used for the FIFO Message Group handling to allow passing the FIFO Message Group information from one host to the next as needed.
It also allows for custom code to set various FIFO Message Group data for the next request to be sent

Duration of forced idleness before processing the next message, in milliseconds

Inherited description: This callback method is invoked by the %Close() method to provide notification that the current object is being closed.

The return value of this method is ignored.

initialize Business Host object

This is to allow a process access to local variable storing Super Session. Similar to how a process has access to $$$JobSessionId.

This method will generate a super session ID

Generate a key for the message header id. Maximum length is determined by Ens.Temp.XREF.DelayedClientRequest property ClientRequestKey. (128)

Helper method for OnGetConnections

Get a "shadow" instance of the named ConfigItem, live if the Production is running; otherwise static but fully populated with all its Settings values.

The pConfigItemName argument may contain the following elements:

ProductionName||ConfigName|CommentOrClassname

Only the ConfigName portion is required. If ProductionName is not given, then the currently running or last run Production will be used. CommentOrClassname is the name shown in the Config page's dropdown list for multiple items having the same ConfigName.

In the case that there are multiple ConfigItems with the same name, if one is enabled, that one will be favored.

In order for this method to work properly, none of the names of the items in your production should contain the '|' character.

Can alternatively be used with the syntax 'class||host class name' e.g. 'class||EnsLib.HTTP.GenericOperation'

If use in this way, it will return a "shadow" instance by instantiating the given host class name and assigning 0 to the %ConfigName property.

User call back to override creation of Super Session value.
Return a non empty string from this method to use as the Super Session ID.
Any code needs to ensure the length of the string returned is not more than the MAXLEN of %SuperSession
If Empty string is returned the system will create one in GenerateSuperSession.
pMessageHeader may be populated when this is called.
The default of pDelimiter passed in is a ^

This method is called when Portal is drawing the production diagram pArray contains the config names the scanner found. Users can remove or add new names

This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()

This method will be called within KeepaliveInterval of the last return from OnTask() or OnKeepalive(). It is called via the Adapter's OnKeepalive() method, which is called from the Host.OnTask() method; if there is no Adapter there is no keepalive call.

This user callback method is called by the Monitor Service (Ens.MonitorService) immediately after it has checked on the status of this host class.

This user callback method is called when the system is being started

This user callback method is called when the system is being stopped

This user callback method is called from %OnClose()

Given an instance of an Ens.Host item, create and return a 'shadow' instance of said host item