Home > Class Reference > %SYS namespace > %CSP.UI.Portal.MFT.Connection

%CSP.UI.Portal.MFT.Connection

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

Page to define Managed File Transfer Connections.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

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.Connection.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 HELPADDRESS = System Administration,Security,Managed File Transfer Connections,Managed File Transfer Connection;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Managed File Transfer Connection;
Displayed name of this page.
parameter PARENTPAGE = /csp/sys/sec/%CSP.UI.Portal.MFT.ConnectionList.zen;
Inherited description: This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.
parameter RECENT = 0;
Inherited description: If true, register visits to this page in the recent list.
parameter RESOURCE = %Admin_Secure;
Security requirement

Properties (Including Private)

property IsEditForm as %Boolean [ InitialExpression = 1 ];
Inherited description: If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.
Property methods: IsEditFormDisplayToLogical(), IsEditFormGet(), IsEditFormIsValid(), IsEditFormLogicalToDisplay(), IsEditFormLogicalToXSD(), IsEditFormNormalize(), IsEditFormSet(), IsEditFormXSDToLogical()
property PID as %String (ZENURL = "PID");
ID for edit. Null if adding new configuration.
Property methods: PIDDisplayToLogical(), PIDGet(), PIDIsValid(), PIDLogicalToDisplay(), PIDLogicalToOdbc(), PIDNormalize(), PIDSet()
property isNew as %ZEN.Datatype.boolean (ZENURL = "isNew") [ InitialExpression = "0" ];
Property methods: isNewDisplayToLogical(), isNewGet(), isNewIsValid(), isNewLogicalToDisplay(), isNewLogicalToOdbc(), isNewLogicalToXSD(), isNewNormalize(), isNewSet(), isNewXSDToLogical()

Methods (Including Private)

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: Be sure to do ##super() when overriding.
method %OnGetPageName() as %String [ Language = objectscript ]
Inherited description: Get the (localized) name of the page. This should be implemented in a subclass.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the page. Overrid Edit: id as text on tab display below Menu
classmethod GetRedirectURLforUI(pAddress, pPort, pPrefix, pSSL) as %String [ Language = objectscript, ZenMethod ]
method LoadData(PID As %String, Output sys) as %Status [ Language = objectscript ]
Used when Editing an existing connection. Load previously defined values into fields.
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 [ Language = objectscript ]
Inherited description: Get information to display in the ribbon bar.
classmethod SaveData(pValueProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ Language = objectscript, ZenMethod ]
Save general association data to server Test can only be done for client, not server.
clientmethod disableServer(flag) [ Language = javascript ]
Enable server fields only if user clicked Edit button
clientmethod doFinish() [ Language = javascript ]
End Add/Edit and return to list page.
clientmethod doSave() [ Language = javascript ]
Get user input and send to server to save settings.
clientmethod getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row.
clientmethod getRedirectURL() [ Language = javascript ]
Get redirect URL upon user changing any of server address/port/prefix.
clientmethod onloadHandler() [ Language = javascript ]
Initialize.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)