Skip to main content


persistent class Ens.Util.Schedule extends %Library.Persistent, %XML.Adaptor

SQL Table Name: Ens_Util.Schedule

A persistent named schedule spec string

Property Inventory

Method Inventory


parameter DOMAIN = Ensemble;
Inherited description: The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected attributes in the XML input. By default (XMLIGNOREINVALIDATTRIBUTE = 1), will ignore unexpected attributes. If XMLIGNOREINVALIDATTRIBUTE is set = 0, then an unexpected attribute will be treated as an error.
parameter XMLNAME = schedule;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.


property Deployable as %Boolean [ InitialExpression = 0 ];
Indicates whether this system default setting can be exported for deployment.
Property methods: DeployableDisplayToLogical(), DeployableGet(), DeployableGetStored(), DeployableIsValid(), DeployableLogicalToDisplay(), DeployableLogicalToXSD(), DeployableNormalize(), DeployableSet(), DeployableXSDToLogical()
property Description as %String (MAXLEN = 256);
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Name as %String [ Required ];
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property ScheduleSpec as %String);
Property methods: ScheduleSpecDisplayToLogical(), ScheduleSpecGet(), ScheduleSpecGetStored(), ScheduleSpecIsValid(), ScheduleSpecLogicalToDisplay(), ScheduleSpecLogicalToOdbc(), ScheduleSpecNormalize(), ScheduleSpecSet()


classmethod %ClearStudioDocuments(ByRef pIDsToKeep As %String = "")
Delete the deployable contents of the Schedule specifications table which are projected as one Studio document.
If pIDsToKeep array is passed in where the subscript is the settings id then those schedules will not be deleted.
classmethod %Export(pFileName As %String = "", pDeployable As %Boolean = "") as %Status
Export Schedule Specifications to file pFileName. If pDeployable is not defined, then export both Deployable and non Deployable Schedule settings. This is the default
If pDeployable is set to True, then only export Schedule settings that are marked as Deployable.
If pDeployable is set to False, then only export Schedule settings that are marked as not Deployable.
classmethod %ExportStudioDocuments(pStream As %String = "") as %Status
Export Default Settings that are deployable to stream pStream.
classmethod %Import(pFileName As %String = "", Output pCount As %Integer, ByRef pIDsImported As %String = "") as %Status
Import Schedule Specification data from the xml file pFileName.
Lookup data is in the form:
  <schedule name="MyName" schedulespec="START:WEEK-*-01T00:00:00,STOP:WEEK-*-01T00:00:05" deployable="0"/>
classmethod %ImportStudioDocuments(pStream As %String = "") as %Status
Import method for rows projected in studio document and then remove those that weren't imported after.
classmethod Evaluate(pScheduleSpec As %String, pODBCDateTime As %String = "") as %String


index (Name on Name) [IdKey, Type = key];
Index methods: NameCheck(), NameDelete(), NameDisplayToLogical(), NameExists(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameOpen(), NameSQLCheckUnique(), NameSQLExists(), NameSQLFindPKeyByConstraint(), NameSQLFindRowIDByConstraint(), NameSet()


trigger OnDelete (AFTER event DELETE);
Update the timestamp whenever a deployable row is removed from a table.
trigger OnModify (AFTER event INSERT/UPDATE);
Update the timestamp for the settings whenever an entry is added or updated that is deployable.

Inherited Members

Inherited Methods


Storage Model: Storage (Ens.Util.Schedule)



FeedbackOpens in a new tab