This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsPortal.ScheduleEditor

EnsPortal.ScheduleEditor

class EnsPortal.ScheduleEditor extends EnsPortal.Template.standardPage

Ensemble schedule spec editor. Schedules are used to schedule resources and alerts.

Property Inventory

Method Inventory

Parameters

parameter EDITRESOURCE = %Ens_ProductionConfig:WRITE;
User needs WRITE permissions on the %Ens_ProductionConfig resource to edit this page.
parameter PAGENAME = Schedule Editor;
Displayed name of this page.
parameter RESOURCE = %Ens_ProductionConfig:READ;
User needs READ permissions on the %Ens_ProductionConfig resource to view this page.

Properties

property addMode as %ZEN.Datatype.boolean;
whether or not the page is in add mode
Property methods: addModeDisplayToLogical(), addModeGet(), addModeIsValid(), addModeLogicalToDisplay(), addModeLogicalToOdbc(), addModeLogicalToXSD(), addModeNormalize(), addModeSet(), addModeXSDToLogical()
property editMode as %String (ZENURL = "editMode");
Value of schedule string currently being edited.
Property methods: editModeDisplayToLogical(), editModeGet(), editModeIsValid(), editModeLogicalToDisplay(), editModeLogicalToOdbc(), editModeNormalize(), editModeSet()
property lblAdd as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Add New Item Below") ];
Property methods: lblAddDisplayToLogical(), lblAddGet(), lblAddIsValid(), lblAddLogicalToDisplay(), lblAddLogicalToOdbc(), lblAddNormalize(), lblAddSet()
property lblEdit as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Edit Setting Below") ];
Property methods: lblEditDisplayToLogical(), lblEditGet(), lblEditIsValid(), lblEditLogicalToDisplay(), lblEditLogicalToOdbc(), lblEditNormalize(), lblEditSet()
property msgDate as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please select a date!") ];
Property methods: msgDateDisplayToLogical(), msgDateGet(), msgDateIsValid(), msgDateLogicalToDisplay(), msgDateLogicalToOdbc(), msgDateNormalize(), msgDateSet()
property msgDelete as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to remove this item?") ];
Property methods: msgDeleteDisplayToLogical(), msgDeleteGet(), msgDeleteIsValid(), msgDeleteLogicalToDisplay(), msgDeleteLogicalToOdbc(), msgDeleteNormalize(), msgDeleteSet()
property scheduleId as %String (ZENURL = "scheduleId");
ID of schedule spec to display.
Property methods: scheduleIdDisplayToLogical(), scheduleIdGet(), scheduleIdIsValid(), scheduleIdLogicalToDisplay(), scheduleIdLogicalToOdbc(), scheduleIdNormalize(), scheduleIdSet()
property scheduleString as %String (ZENURL = "schedule");
Value of schedule string currently being edited.
Property methods: scheduleStringDisplayToLogical(), scheduleStringGet(), scheduleStringIsValid(), scheduleStringLogicalToDisplay(), scheduleStringLogicalToOdbc(), scheduleStringNormalize(), scheduleStringSet()
property selectedRow as %ZEN.Datatype.integer;
Selected row in listing mode.
Property methods: selectedRowDisplayToLogical(), selectedRowGet(), selectedRowIsValid(), selectedRowLogicalToDisplay(), selectedRowLogicalToOdbc(), selectedRowNormalize(), selectedRowSet()

Methods

method %OnAfterCreatePage() as %Status
Decorate the page.
method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetTitle() as %String
Get the (localized) title string for the page.
classmethod DeleteID(id) as %String [ ZenMethod ]
Delete the given id.
method DrawListing1(pSeed As %String) as %Status
Draw table under Description with Schedule view mode = calendar.
classmethod GetHyperEventResources(pMethod As %String = "") as %String
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
classmethod GetScheduleInfo(ByRef pParms As %String, pBeginDate As %Date, pEndDate As %Date, ByRef pInfo As %List) as %Boolean
GetScheduleInfo callback for the Schedule Page.
This method returns the set of scheduled items that should be displayed on the schedulePane.
classmethod LoadSchedule(scheduleId) as %ZEN.proxyObject [ ZenMethod ]
Load up the properties of the named schedule into the properties of the proxy object
method OnDrawRibbon() as %Status
Add to the contents of the tool ribbon.
method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
classmethod SaveData(pScheduleId As %String, Description As %String, scheduleString As %String, pDeployable As %Boolean) as %String [ ZenMethod ]
Save modified schedule to server.
classmethod ValidateScheduleString(txt) as %String [ ZenMethod ]
Delete the given id.
clientmethod addItem() [ Language = javascript ]
user clicked "Add Item". Reset the selectedRow to null, refresh table and show action block.
clientmethod adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod applyRawToView() [ Language = javascript ]
user wishes to apply the current raw string to the entire schedule view
clientmethod cancelRaw(action) [ Language = javascript ]
simply return to the production configuration page
clientmethod changeFrequency(choice) [ Language = javascript ]
clientmethod changeMonthly(choice) [ Language = javascript ]
enable/disable radio buttons for monthly
clientmethod changeSchedule() [ Language = javascript ]
user selected a Schedule spec from drop-down
clientmethod clearFields() [ Language = javascript ]
clientmethod deleteSchedule() [ Language = javascript ]
User clicked Delete button.
clientmethod getDialogValue() [ Language = javascript ]
clientmethod gotoAdded() [ Language = javascript ]
clientmethod gotoNotSelected() [ Language = javascript ]
clientmethod gotoSelected() [ Language = javascript ]
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when the a popup page launched from this page fires an action.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod refreshCalendar() [ Language = javascript ]
Refresh list and calendar
clientmethod refreshList() [ Language = javascript ]
Refresh list
clientmethod removeEmptyRow() [ Language = javascript ]
clientmethod removeItem() [ Language = javascript ]
user clicked "Remove Item". If confirmed, remove the matching piece from scheduleString and refresh table.
clientmethod saveCurrentStringAndName() [ Language = javascript ]
clientmethod saveDeployable() [ Language = javascript ]
user changed Deployable flag
clientmethod saveDescription() [ Language = javascript ]
user clicked "Save" by the description.
clientmethod saveRaw(action) [ Language = javascript ]
clientmethod saveRawSchedule() [ Language = javascript ]
user clicked "Save As"
clientmethod saveSchedule() [ Language = javascript ]
user clicked "Save Action". If selectedRow exists then this is Edit. Otherwise it's Add.
clientmethod selectDate(date) [ Language = javascript ]
User has selected a new date in the calendar. Update the schedule pane.
clientmethod selectItem(id, time) [ Language = javascript ]
clientmethod selectRow(row) [ Language = javascript ]
User has selected a row in the listing table.
clientmethod selectSchedule() [ Language = javascript ]
user clicked New. Open New Schedule dialog.
clientmethod setActionsHidden(flag) [ Language = javascript ]
clientmethod setScheduleEndTime(time) [ Language = javascript ]
Change the endTime displayed by the schedulePane.
clientmethod setScheduleInterval(interval) [ Language = javascript ]
Change the time interval displayed by the schedulePane.
clientmethod setScheduleStartTime(time) [ Language = javascript ]
Change the startTime displayed by the schedulePane.
clientmethod showWorkArea(value) [ Language = javascript ]
clientmethod updateSchedule() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new window