Ensemble Class Reference

Static Public Member Functions
_.Library.Status	BounceExternalLanguageServer (_.Library.String pServer)
	Method used by PEX Components Registration to bounce the server if necessary for ensuring the correct file is used. More...
_.Library.Status	CreateDocumentation (_.Library.String pProduction, _.Library.Boolean pIntro, _.Library.String pFormat, _.Library.String LogFileName, _.Library.String URL, _.Library.String BookName, _.Library.String PDFFileName, _.Library.String PDFRenderer, _.Library.String Params, _.Library.Boolean pAllSettings)
	Wrapper around the Ens.Util.Documentation::CreateDoc() API to ensure that users have sufficient privileges to. More...
_.Library.String	EnsembleUsername ()
	Correctly determine the expanded Interoperability manager username (used internallly and not for login) More...
_.Library.Status	GetEnsMetrics (_.Library.String pID, _.Library.Integer pCount, pValues, pStatus, pMsg, _.Library.Numeric pInterval)
	Wrapper around the SYS.EnsMetrics::GetMainMetrics() API to ensure that all users with. More...
_.Library.Status	GetExternalLanguageServers (pServers)
	Method used by Context Search to get list of External Language Servers. More...
_.Library.Status	GetMapParent (_.Library.String pInputClass, _.Library.Boolean pIsBatch, _.Library.Status pSC)
	Method used by DTL Test page that requires de-serialization of the test input data. More...
_.Library.Status	ListAlertingUsers (_.Library.String pUsers, _.Library.String pLimitToNamespace)
	This method is used by the portal page EnsPortal.ManagedAlertViewer<br> More...
_.Library.Status	StartProduction (_.Library.String pProductionName)
	Secure wrapper for the StartProduction API in <class>Ens.Director</class>.
_.Library.Status	StopProduction (_.Library.Numeric pTimeout, _.Library.Boolean pForce)
	Secure wrapper for the StopProduction API in <class>Ens.Director</class>.
_.Library.Status	UpdateProduction (_.Library.Numeric pTimeout, _.Library.Boolean pForce, _.Library.Boolean pCalledByScheduleHandler)
	Secure wrapper for the UpdateProduction API in <class>Ens.Director</class>.

Member Function Documentation

BounceExternalLanguageServer()

_.Library.Status BounceExternalLanguageServer ( _.Library.String  pServer )

static

Method used by PEX Components Registration to bounce the server if necessary for ensuring the correct file is used.

User might not have Admin_Manage and DB_IRISSYS privileges Instead require WRITE priv on the Ens_Code resource in order to gain elevated privileges.

CreateDocumentation()

_.Library.Status CreateDocumentation ( _.Library.String  pProduction, _.Library.Boolean  pIntro, _.Library.String  pFormat, _.Library.String  LogFileName, _.Library.String  URL, _.Library.String  BookName, _.Library.String  PDFFileName, _.Library.String  PDFRenderer, _.Library.String  Params, _.Library.Boolean  pAllSettings  )

static

Wrapper around the Ens.Util.Documentation::CreateDoc() API to ensure that users have sufficient privileges to.

add the resulting material to the documentation.
The parameter <parameter>PDFRenderer</parameter> is deprecated and is ignored.
The parameter <parameter>pAllSettings</parameter> defaults to 0 but if set to 1 all settings including default values for a host item will be included.

EnsembleUsername()

_.Library.String EnsembleUsername ( )

static

Correctly determine the expanded Interoperability manager username (used internallly and not for login)

if the system is using multiple domains. If multiple domains are in use, then the Interoperability manager username should be present in the default domain.

GetEnsMetrics()

_.Library.Status GetEnsMetrics ( _.Library.String  pID, _.Library.Integer  pCount,   pValues,   pStatus,   pMsg, _.Library.Numeric  pInterval  )

static

Wrapper around the SYS.EnsMetrics::GetMainMetrics() API to ensure that all users with.

USE permissions on Ens_Dashboard can get this information even if they aren't permitted to directly run code in the system database.

GetExternalLanguageServers()

_.Library.Status GetExternalLanguageServers (   pServers )

static

Method used by Context Search to get list of External Language Servers.

User might not have SQL privs on the Config.Gateways::ListShort query Instead require WRITE priv on the Ens_ProductionConfig resource in order to gain elevated privileges.

GetMapParent()

_.Library.Status GetMapParent ( _.Library.String  pInputClass, _.Library.Boolean  pIsBatch, _.Library.Status  pSC  )

static

Method used by DTL Test page that requires de-serialization of the test input data.

User might not have SQL privs on the Dictionary.ParameterDefinition table If the User does not have SQL Select privs on Dictionary.ParameterDefinition table then user requires USE priv on the Ens_DTLTest resource in order to gain elevated privileges.

ListAlertingUsers()

_.Library.Status ListAlertingUsers ( _.Library.String  pUsers, _.Library.String  pLimitToNamespace  )

static

This method is used by the portal page EnsPortal.ManagedAlertViewer<br>

It returns a list of users who are members of the EnsRole_AlertManager, EnsRole_AlertOperator or EnsRole_Alert roles.
If the role EnsRole_Administrator has USE privilege on the Ens_AlertAdministration resource then users of the role EnsRole_Administrator will also be listed.
Users with All role will not be listed unless they are explicitly members of one of the roles previously mentioned.
The default is to list all the users in the instance. Pass the namespace in the second parameter to limit the list to the user with write access to the Ens.Alerting.ManagedAlert data in a specific namespace.
A user must be permitted to edit alerts to call this API.