Home > Class Reference > ENSLIB namespace > EnsLib.ITK.Setup.UI.Consumer
Private  Storage   


class EnsLib.ITK.Setup.UI.Consumer extends
Ens.Settings, %ZEN.DataModel.Adaptor


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 7 5 2


%id %seriesCount %seriesNames %source
BusHost BusHostId BusHostStatus ConsumerName
DistributionRules Services VirtualSettings

%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%CreateModelInstance %DeleteModel %DispatchClassMethod %DispatchGetModified
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %Extends
%GetJSValidationCode %GetParameter %GetPropertyInfo %InvokeAction
%IsA %IsModified %IsReadOnly %New
%NormalizeObject %ObjectModified %OnCopyDataFromModel %OnCopyDataToModel
%OnDeleteModel %OnDeleteSource %OnGetPropertyInfo %OnInvokeAction
%OnLoadModel %OnNewSource %OnOpenSource %OnSaveSource
%OnStoreModel %OnSubmit %OpenId %OpenModel
%OriginalNamespace %PackageName %RemoveFromSaveSet %SaveModel
%SerializeObject %SetModified %SubmitHandler %ValidateObject
AssignOneSetting BusHostIdGet BusHostStatusGet EnumerateSettingsClose
EnumerateSettingsExecute EnumerateSettingsFetch GetSettings OpenWithHost


• parameter SETTINGS = "ConsumerName:Info:text?readOnly=1,Services:Consumer:consumerEditor,DistributionRules:Consumer:consumerEditor";
List of properties can be set as settings in the configuration file format is a comma separated list of property names


• property BusHost as Ens.Config.Item;
• property BusHostId as %String [ Calculated ];
• property BusHostStatus as %String [ Calculated ];
• property ConsumerName as %String;
• property DistributionRules as %String;
Number of Distrubution Rules with this Consumer as the target. Click magnifying glass to edit list.
• property Services as %String;
Number of Services configured for consumption. Click magnifying glass to edit list.
• property VirtualSettings as list of %String;


• classmethod %OpenId(pId As %String) as Consumer
Return the object populated with name (matching a SystemDefinition) and a list of the ConsumerServiceRegistry objects if defined
• method BusHostIdGet() as %String
This is a Get accessor method for the BusHostId property.
• method BusHostStatusGet() as %String
This is a Get accessor method for the BusHostStatus property.
• classmethod OpenWithHost(pId As %String, pProdId As %String) as Consumer
Special version of openId that takes a production id This is needed so we can check id there is a business operation associated with this consumer
• method PopulateVirtualSettings() as %Status
Populate the VirtualSettings collection.


• query GetAll()
SQL Query :
SELECT ApplicationName as ID FROM EnsLib_ITK_Setup.SystemDefinition
• query GetConsumerServicesByConsumerName(pName As %String)
SQL Query :
SELECT %ID FROM EnsLib_ITK_Setup.ConsumerServiceRegistry
WHERE ConsumerName = :pName