EnsPortal.Utils
class EnsPortal.Utils extends %Library.RegisteredObject
Class to provide information to build portal pagesMethod Inventory
- CheckForItemStatusChanges()
- CheckForProductionStatusChange()
- CheckResourceList()
- DrawBodyInfo()
- DrawEventInfo()
- DrawEventInfoStyle()
- DrawFullContentLinks()
- DrawItemDetails()
- DrawRuleInfo()
- EnumerateEditableSubclassesClose()
- EnumerateEditableSubclassesExecute()
- EnumerateEditableSubclassesFetch()
- EnumerateMessageClassesClose()
- EnumerateMessageClassesExecute()
- EnumerateMessageClassesFetch()
- GetCurrentProductionName()
- GetCurrentProductionState()
- GetItemsForProduction()
- GetProductionList()
- GetRuleReasonLink()
- HistoryList()
- IsComponent()
- IsOKForMode()
- ItemEventLog()
- ItemJobs()
- ItemLineConnections()
- ItemLineConnectionsById()
- ItemQueueList()
- ItemSettings()
- ItemSettingsById()
- ProductionItems()
- ValidImportFileExists()
- getHostTypeString()
- getProductionStateColor()
- resolveHostType()
- resolveProductionStateName()
Parameters
parameter DOMAIN = Ensemble;
Methods
Return a string containing a delimited list of items whose status has changed since last check.
A maximum of ~32000 characters is returned; in general a few characters will be sufficient,
but if not, in the next check the remaining chunk of changes will be returned.
Return a flag indicating if the Production state has changed
concatenated with a list of items whose status have changed.
Method to check a comma-delimited list of resources in the format used for the
Zen RESOURCE parameter. The method returns true/1 if the user has the specified
privileges on any of the listed resources.
classmethod DrawBodyInfo(pHeaderID As %String, pHeaderClass As %String = "Ens.MessageHeader") as %Status
Write out contents of body details panel.
pHeaderID is the message id.
classmethod DrawEventInfo(pEventID As %String = "", pShowTraceLink As %Boolean = 0, pNarrowDisplay As %Boolean = 0, pIsEnterprise As %Boolean = 0) as %Status
classmethod DrawEventInfoStyle() as %Status
classmethod DrawFullContentLinks() as %Status
Common API to draw links for multiple pages in the portal.
classmethod DrawItemDetails(pID As %String = "", pClassname As %String = "Ens.MessageHeader") as %Status
Utility method used to write out the HTML for a specific
Message Header in the Trace and Message Viewer pages.
pID is the message header ID.
classmethod DrawRuleInfo(pRuleID As %String = "", pShowHeaderLinks As %Boolean = 0, pNarrowDisplay As %Boolean = 0) as %Status
classmethod EnumerateEditableSubclassesExecute(ByRef qHandle As %Binary, pSuperclass As %String) as %Status
pSuperclass is either "Ens.BusinessProcess" or "Ens.DataTransform".
The purpose of this query is to exclude the base classes
Ens.BusinessProcessBPL and Ens.DataTransformDTL from the list.
classmethod EnumerateEditableSubclassesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod EnumerateMessageClassesExecute(ByRef qHandle As %Binary, Mode As %String, Category As %String) as %Status
classmethod EnumerateMessageClassesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod GetCurrentProductionName() as %String
classmethod GetCurrentProductionState() as %String
Note that this method does NOT log any data to the Event Log if the call to
GetProductionStatus() returns an error.
classmethod GetItemsForProduction(pProdName As %String, pType As %String, Output pHostList As %String)
Get a list of BPL "components" within a given production.
Get a list of current productions.
classmethod GetRuleReasonLink(pReason As %String = "", pRuleSet As %String = "", pRuleName As %String = "", pAssumeOtherwise As %Boolean = 1) as %String
Given a business process class name, return if it is a component
Some finder searches want only request messages, or only response messages.
Based on that, this method determines whether we want the message class that we are looking at.
classmethod ItemEventLog(pConfigItemName As %String = "", Output pList, Output pColNames, ByRef pEventsCount As %Integer, pNumItems As %Integer = 100, pPrevId As %String = "") as %Status
Returns pNumItems event log entries for the given config item, starting after entry ID pPrevId.
If pPrevId is empty, starts from the beginning.
The pNumItems+1 output list element will be $LB("more...") if there are more entries for this config item in the event log.
If pConfigItemName is an empty string, gets all available event log entries regardless of config item.
If pEventsCount is passed in as 0, pEventsCount will NOT be calculated, as the query may be expensive on very large systems;
in this case the value of pEventsCount, if passed by reference, will be the actual number of rows returned.
Return all config jobs for the given config item
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. If it is not given, then if more than one item of the given ConfigName exists, all will match.
In order for this method to work properly, none of the names of the items in your production should
contain the '|' character.
classmethod ItemLineConnectionsById(pItemId As %String, pProd As %String, pCat As %String = "", Output pList, Output pColNames) as %Status
Givem an item id, return a list of the items that are connected to it.
classmethod ItemQueueList(pConfigItemName As %String = "", Output pList, Output pColNames, Output pQueueName As %String, Output pQueueCount As %Integer, pNumItems As %Integer = 100, pPrevId As %String = "", Output pMsg As %String = "", pEnsActorQueueLimit As %Integer = 0, pContinueIfItemMissing As %Boolean = 0) as %Status
pConfigItemName is in the form ProductionName||ItemName. When ItemName is null, a summary of the queues for the Production is returned,
otherwise the queue contents for the given item are returned.
Returns pNumItems entries for the given config item's primary queue or the Production, starting after entry ID pPrevId. If pPrevId is empty, starts from the beginning. The pNumItems+1 output list element will be $LB("More...") if there are more entries.
pMsg may contain an output informative message complementing the data array returned if any.
pContinueIfItemMissing, if set to true, will allow the list to be populated if a message header object referenced in the queue is not found. If the message header is not found either *Deleted* (if the object is not there) or *Error* (if a SQL error was encountered) will be returned in the list structure via the source config item position. The default for backwards compatibility is false. The Production configuration portal page calls this method with pContinueIfItemMissing true.
Returns pNumItems entries for the given config item's primary queue or the Production, starting after entry ID pPrevId. If pPrevId is empty, starts from the beginning. The pNumItems+1 output list element will be $LB("More...") if there are more entries.
pMsg may contain an output informative message complementing the data array returned if any.
pContinueIfItemMissing, if set to true, will allow the list to be populated if a message header object referenced in the queue is not found. If the message header is not found either *Deleted* (if the object is not there) or *Error* (if a SQL error was encountered) will be returned in the list structure via the source config item position. The default for backwards compatibility is false. The Production configuration portal page calls this method with pContinueIfItemMissing true.
Return a list of different settings that apply to the given item -- by item name.
classmethod ItemSettingsById(pItemId As %String, pProd As %String, Output pList, Output pColNames) as %Status
Return a list of different settings that apply to the given item -- by item Id.
Return a list of all the config items defined in the given Production
Used to support import operations. Returns a string:
"None" if there is no file by the name given by pFilename,
"Invalid" if the file exists and export syntax is valid but it is not a subclass of pSuperClass,
"Ok" if the file exists and seems to contain an exported subclass of pSuperClass,
"Open" if we could not open the file,
"Syntax" if the file exists but does not contain valid syntax for an exported subclass of pSuperClass,
"Duplicate" if a class with the name supplied in the file already exists.
Convert host BusinessType integer into a canonical (non-localized) string
correlate the status with a color, for quick scanning of the enterprise monitor table
this is redundant data, repeated by the status column, so if a user is color-blind,
they will still be able to use the page.
Turn the host BusinessType integer into a human-readable type string
Turn the Production State integer into a human-readable state string.
Queries
query EnumerateEditableSubclasses(pSuperclass As %String)
Selects Name As %String, Modified As %TimeStamp
pSuperclass is either "Ens.BusinessProcess" or "Ens.DataTransform".
The purpose of this query is to exclude the base classes
Ens.BusinessProcessBPL and Ens.DataTransformDTL from the list.
Category:
= "request" for request messages
= "response" for response messages
= "messages" for request messages and response messages
= "persistentvdoc" for subclasses of Ens.VDoc.Interface that are also persistent
= "persistentselect" for persistent classes with the unlikely prospects weeded out
= "classselect" for both persistent and non-persistent classes, with the unlikely prospects weeded out
= "classvdoc" for both persistent and non-persistent subclasses of Ens.VDoc.Interface, with some weeding out
= "request" for request messages
= "response" for response messages
= "messages" for request messages and response messages
= "persistentvdoc" for subclasses of Ens.VDoc.Interface that are also persistent
= "persistentselect" for persistent classes with the unlikely prospects weeded out
= "classselect" for both persistent and non-persistent classes, with the unlikely prospects weeded out
= "classvdoc" for both persistent and non-persistent subclasses of Ens.VDoc.Interface, with some weeding out
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()