Skip to main content


class %CSP.UI.Portal.MFT.Authorize extends %CSP.UI.Portal.Template

Page to obtain an access token for a connection to a managed file transfer provider.

Property Inventory

Method Inventory


parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/sec/%CSP.UI.Portal.MFT.Authorize.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 PAGENAME = Managed File Transfer Authorization;
Displayed name of this page.
parameter RECENT = 0;
Parameter HELPADDRESS = "System Administration,Security";
parameter RESOURCE = %Admin_Secure;
Security requirement


property AuthorizationCodeURL as %String;
Property methods: AuthorizationCodeURLDisplayToLogical(), AuthorizationCodeURLGet(), AuthorizationCodeURLIsValid(), AuthorizationCodeURLLogicalToDisplay(), AuthorizationCodeURLLogicalToOdbc(), AuthorizationCodeURLNormalize(), AuthorizationCodeURLSet()
property ConnectionName as %ZEN.Datatype.string (ZENURL = "ConnectionName");
Property methods: ConnectionNameDisplayToLogical(), ConnectionNameGet(), ConnectionNameIsValid(), ConnectionNameLogicalToDisplay(), ConnectionNameLogicalToOdbc(), ConnectionNameNormalize(), ConnectionNameSet()
property IsEditForm as %Boolean [ InitialExpression = 0 ];
If it's set to 1 then Save and Cancel buttons will show in top bar
Property methods: IsEditFormDisplayToLogical(), IsEditFormGet(), IsEditFormIsValid(), IsEditFormLogicalToDisplay(), IsEditFormLogicalToXSD(), IsEditFormNormalize(), IsEditFormSet(), IsEditFormXSDToLogical()
property NAMESPACE as %ZEN.Datatype.string (ZENURL = "$NAMESPACE");
Property methods: NAMESPACEDisplayToLogical(), NAMESPACEGet(), NAMESPACEIsValid(), NAMESPACELogicalToDisplay(), NAMESPACELogicalToOdbc(), NAMESPACENormalize(), NAMESPACESet()
property PageScope as %ZEN.Datatype.string (ZENURL = "PageScope");
Property methods: PageScopeDisplayToLogical(), PageScopeGet(), PageScopeIsValid(), PageScopeLogicalToDisplay(), PageScopeLogicalToOdbc(), PageScopeNormalize(), PageScopeSet()


method %OnAfterCreatePage() as %Status
Inherited description: Be sure to do ##super() when overriding.
method %OnGetPageName() as %String
Inherited description: Get the (localized) name of the page. This should be implemented in a subclass.
classmethod CheckToken(name As %String, scope As %String) as %ZEN.proxyObject [ ZenMethod ]
classmethod GetAuthorizationCodeURL(connection As %SYS.MFT.Connection.Base, scope As %String, Output sc As %Status) as %String
Get the authorization code url
classmethod RevokeToken(name As %String) as %ZEN.proxyObject [ ZenMethod ]
clientmethod doCheckToken() [ Language = javascript ]
clientmethod doRevokeToken() [ Language = javascript ]
clientmethod getAccessToken() [ Language = javascript ]
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab