Ens.Hostabstract class Ens.Host
Common base class for all Ensemble config item instances
The type of adapter used to communicate with external systems
2 modes: Queue, InProc
Users can specify these values in the Ensemble 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
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.
Duration of forced idleness before processing the next message, in milliseconds
This callback method is invoked by the
%Closemethod 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
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. See method Ens.Director:ParseConfigName() for full syntax of the ConfigItem name specification string.
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
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 Ensemble 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 Ensemble 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()