Skip to main content


class %CSP.UI.Portal.NLS extends %CSP.UI.Portal.Template

Zen page for System Management Portal - NLS Locale Definition

Method Inventory


parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/mgr/%CSP.UI.Portal.NLS.zen;
Inherited description: This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
parameter EMSSERVICE = Config;
parameter HELPADDRESS = Home,Configuration,Locale Definitions;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Locale Definitions;
Displayed name of this page.
parameter RESOURCE = %Admin_Manage;
Security requirement


method %OnAfterCreatePage() as %Status
Set Locator bar and determine whether to show change password option.
method %OnGetPageName() as %String
Inherited description: Get the (localized) name of the page. This should be implemented in a subclass.
classmethod CopyNow(sLoc As %String, sNew As %String, Description As %String) as %String [ ZenMethod ]
Copy selected locale
classmethod DeleteNow(locale As %String) as %String [ ZenMethod ]
Delete selected locale.
method DrawResult(seed As %String) as %Status
Actually write out result. When the page is first opened, seed is null. When it's called from Prepare, seed = action^the selected locale.
classmethod DrawTableNames(locale, table As %String) as %String [ ZenMethod ]
Load Table Names drop-down list based on user selected table type. Build temp array Properties which contains the table names for this table type.
method ExecuteRS(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean
This method is called when the query is run for the locale list.
classmethod ExportNow(locale, FileName) as %String [ ZenMethod ]
Export selected locale.
classmethod GetLocaleDesc(locale As %String) as %ZEN.proxyObject [ ZenMethod ]
Return an updated title description
classmethod GetLocaleDescription(locale As %String) as %String
classmethod InstallNow(locale) as %String [ ZenMethod ]
Install selected locale. Validation is already done before coming here.
classmethod LoadTableNow(locale, tabletype, tablename) as %String [ ZenMethod ]
Load locale table.
classmethod ReloadDefault(locale As %String, defaultFormat As %Integer) as %String [ ZenMethod ]
Save "Use locale date/time/number formats for current locale" and then reload.
classmethod SaveNow(locale As %String) as %String [ ZenMethod ]
Save selected locale.
classmethod ValidateInstall(locale As %String) as %String [ ZenMethod ]
Validate if the locale is installable Return 1 if ok; 0 if there are errors; 2 if there are warnings Error message or warnings will be set to message fields.
clientmethod browseSelect(name, wildcard) [ Language = javascript ]
User clicked one of the Browse buttons. Save the name of the textfield so that when you return you know which textfield to update.
clientmethod changedDefault(newVal) [ Language = javascript ]
User changed default. Call server method to reload.
clientmethod changedLocale(locale) [ Language = javascript ]
User changed a locale. If it's null, then disable buttons
clientmethod copyLocale() [ Language = javascript ]
User clicked "Copy" button. Show Copy fields.
clientmethod deleteLocale() [ Language = javascript ]
User clicked "Delete" button.
clientmethod displayResult(ok) [ Language = javascript ]
After running action, display error message or refresh page.
clientmethod doCancel() [ Language = javascript ]
User clicked Cancel. Hide sub form.
clientmethod doCopy() [ Language = javascript ]
User clicked OK for Copy. Set seed, show and redraw the content.
clientmethod doExport() [ Language = javascript ]
User clicked OK for Export. Process Export.
clientmethod doInstall() [ Language = javascript ]
User clicked Install Now for Installing a new locale. Process Install.
clientmethod doLoadTable() [ Language = javascript ]
User clicked OK for Load Table. Process Load Table.
clientmethod edit() [ Language = javascript ]
clientmethod exportLocale() [ Language = javascript ]
User clicked "Export" button. Show Export fields.
clientmethod getLocale() as %String [ Language = javascript ]
clientmethod hideFlds() [ Language = javascript ]
hide all fields
clientmethod installLocale() [ Language = javascript ]
User clicked "Install" button. Show Install fields.
clientmethod loadTable() [ Language = javascript ]
User clicked "Load Table" button. Show Load Table fields.
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 onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod tablenameChanged(tablename) [ Language = javascript ]
User changed a character set table name.
clientmethod tabletypeChanged(table) [ Language = javascript ]
User changed a table type. Load table names based on the table type selected.
clientmethod validateLocale() [ Language = javascript ]
User clicked Validate. Set seed, show and redraw the content.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab