Dialog for checking in files to Perforce. More...

Inheritance diagram for UI:

[legend]

Collaboration diagram for UI:

[legend]

Static Public Member Functions
_.Library.String	AllowedApps ()
	CSP Applications allowed to access this UI. More...

	CheckinDisplay (_.Library.Boolean DisplayForm)
	Page for checking in files from perforce changelists in the current workspace. More...

	ClearP4Ticket ()
	Handles case of an invalid perforce ticket. More...

	DiffDisplay ()
	Displays a diff between the file passes in the file url parameter and file_".bak" if it exists.

_.Library.Boolean	DiffEnabled ()
	Returns boolean value indicated whether or not the diff UI can be displayed. More...

_.Library.String	GetParameter (Parameter)
	Pages inheriting from CSP.Page don't have a GetParameter() method until 2010.2. More...

_.Library.Numeric	InstanceVersion ()
	Returns value the Major.Minor version for this instance, so it can be used in comparison code which makes sure certain features are used in appropriate versions.

	LoginDisplay (_.Library.Boolean pContinue)
	If login needed (connected multi-developer instance), displays/processes the login form. More...

_.Library.Status	OnPage ()
	Event handler for PAGE event: this is invoked in order to More...

_.Library.Boolean	OnPreHTTP ()
	Ensure that this page is only accessible through approved CSP Applications.

_.Library.Boolean	PerforceLoggedIn ()
	Returns true if the user has a valid Perforce ticket in the CSP session, otherwise returns false. More...

_.Library.Status	PerforceLogin (Password)
	Accepts the password for the current Perforce user (defined by $USERNAME) and validates password by attempting to log into Perforce and obtain a IP-bound ticket More...

	RetrieveCCRDetails (pRID, pToken)
	Retrieve details of the requested CCR and update the UI with the details.

	SelfLink ()
	Link to this page.

	ShelveFile (_.Library.String file)
	Shelve a given file in the current selected changelist.

	SwitchChangelist (newChangelist)
	Store the new changelist number in session.Data if switching. More...

	SystemdefaultsDisplay (_.Library.Boolean DisplayForm)
	Runs the Ens.Config.DefaultSettings. More...

	UnshelveFile (_.Library.String file)
	Unshelve a given shelved file from the current selected changelist, into the same changelist.

	ValidateCCRUpload (pRID)
	Called from UI Bundle page to validate whether an ItemSet can be uploaded for a given CCR. More...

Static Public Member Functions inherited from StudioTemplateSuper
_.Library.Boolean	IsEnabled ()
	Return false from this method to disable this template (for example based on the server platform)

_.Library.Status	LocalizeName (_.Library.String id, _.Library.String name, _.Library.String description)
	Default code to localise the name and description of this template is to look it up in TemplateName. More...

_.Library.Boolean	OnErrorSetup (_.Library.Boolean skipheader)
	This is called before the OnPreHTTP and will handle the HyperEvent errors and. More...

Static Public Member Functions inherited from Page
_.Library.Status	ConvertParameter (_.Library.String url, _.Library.String name, _.Library.String value)
	You pass this the <parameter>url</parameter> of the page you are going to and a. More...

_.Library.Binary	Decrypt (_.Library.String data)
	Decrypts the input string using the session.Key value that is unique to. More...

_.Library.String	Encrypt (_.Library.Binary data)
	Encrypts the input string using the session.Key value that is unique to this. More...

_.Library.String	EscapeHTML (in)
	This method converts input HTML text into Escaped HTML text.

_.Library.String	EscapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in input URL string into Escaped URL string. More...

_.Library.String	HyperEventCall (_.Library.String methodName, _.Library.String args, _.Library.Integer type, _.Library.Boolean mobile)
	This method returns the string that needs to be written to the current. More...

_.Library.String	HyperEventHead (_.Library.Boolean iframeOnly, _.Library.Boolean strict, _.Library.Boolean optionalBroker)
	This method returns the string that needs to be written to the current. More...

	Include (_.Library.String url)
	Include another csp page or file in the output at this point. More...

_.Library.String	InsertHiddenField (_.Library.String url, _.Library.String name, _.Library.String value, _.Library.String extra)
	Inserts a '<input type="hidden" name="Name" value="Value">' tag into the current document. More...

_.Library.String	InsertHiddenFields (_.Library.String url, _.Library.String query)
	Return the string containing the hidden form tags. More...

_.Library.Boolean	IsPrivate ()
	Returns 1 if this page is in fact a private page (see <parameter>PRIVATE</parameter>).

_.Library.String	Link (_.Library.String link, _.Library.String query, _.Library.Boolean addQ)
	Tranforms the link specified by link into a URL and returns it as a string. More...

_.Library.Status	OnHTTPHeader (_.Library.Boolean OutputBody)
	Event handler for PAGE event: this is invoked in order to More...

	OnPageError (_.Library.Status sc)
	Event handler for any error that occurs on the page. More...

	OnPostHTTP ()
	Event handler for POSTPAGE event: this is invoked after the data. More...

_.Library.Status	OnPostHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked after a hyperevent method is called on this page.

_.Library.Status	OnPreHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked before a hyperevent method is called on this page. More...

_.Library.Status	Page (_.Library.Boolean skipheader)
	Process a request to serve a CSPPage. More...

_.Library.String	QuoteJS (in)
	This method converts input string into quoted JavaScript literal.

_.Library.String	RewriteURL (_.Library.String url)
	This method will rewrite a URL to use #url()# if needed.

	ShowError (_.Library.Status sc)
	Display a <class>Status</class> error code to the CSP Page.

	StartTimer (_.Library.String name)
	Used to get performance information on your CSP pages. More...

	StopTimer (_.Library.String name)
	Used to time performance information on your CSP pages. More...

	ThrowError (_.Library.Status sc)
	Passed a <class>Status</class> code this goes to the error page passing this status code.

_.Library.String	UnescapeHTML (in)
	This method converts Escaped HTML text into normal HTML text.

_.Library.String	UnescapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in Escaped URL string back to its original form. More...

Static Public Attributes
	SECURITYRESOURCE = None
	Do not accept the default SECURITYRESOURCE from the superclass as this page handles it's own security to allow TrakCare use-cases. More...

	SrcVer = None
	This Parameter should be updated when synced from Perforce.

	Version = None
	Revision number of this class when compiled as part of the //custom_ccrs/_common/config/... More...

Static Public Attributes inherited from StudioTemplateSuper
	CHARSET = None
	The <CLASS>CSP.StudioTemplateSuper</CLASS> is the superclass for all the template pages. More...

	GlobalTemplate = None
	If this is true then even if this template is tied to a specific namespace it. More...

Static Public Attributes inherited from Page
	CHARSET = None
	The <CLASS>CSP.Page</CLASS> object serves as an event handler for CSP requests. More...

	CONTENTTYPE = None
	Specifies the default content type for the page. More...

	CONVERTINPUTSTREAM = None
	Specifies if input request.Content or request.MimeData values are converted from their. More...

	CSPFILE = None
	If this page was compiled from a .csp file, then this parameter contains the. More...

	CSPSTRICT = None
	The CSPSTRICT parameter is set to 1, if the DOCTYPE indicates that this. More...

	CSPURL = None
	This parameter is used to make sure that if multiple. More...

	CSPXHTML = None
	The CSPXHTML parameter is set to 1, if the DOCTYPE indicates that this. More...

	DOMAIN = None
	The default domain for csp:text, span and div tags. More...

	ENCODED = None
	Controls how the query parameters for this page are passed, it can. More...

	ERRORPAGE = None
	Specify a custom error page to call if there are any problems with generating this page. More...

	EXPIRES = None
	Specified the default value for the response.Expires. More...

	NOCHARSETCONVERT = None
	Specifies if we wish to turn off charset conversion for this page. More...

	PAGETIMING = None
	If this parameter is true then we automatically record timing statistics of how long it takes to. More...

	PRIVATE = None
	Controls the access to the page, it can be set to one of the following: More...

	SECURITYRESOURCE = None
	This is a comma-delimited list of system Resources and associated. More...

	TIMINGSLOTS = None
	Used by the timing to decide how many slots a day should be divided up into. More...

	UseSession = None
	This parameter controls the CSP session support. More...

Detailed Description

Dialog for checking in files to Perforce.

Member Function Documentation

◆ AllowedApps()

_.Library.String AllowedApps ( )

static

CSP Applications allowed to access this UI.

To add web applications to the return list, set ^SYS("SourceControl","AllowedApps")=$lb(app1,app2,...). NOTE: app1, app2, etc must have a trailing '/', e.g. ^SYS("SourceControl","AllowedApps")=$lb("/csp/users/")

◆ CheckinDisplay()

CheckinDisplay ( _.Library.Boolean DisplayForm )

static

Page for checking in files from perforce changelists in the current workspace.

Only valid for connected clients.

◆ ClearP4Ticket()

ClearP4Ticket ( )

static

Handles case of an invalid perforce ticket.

Clears the cache and refreshes the page.

◆ DiffEnabled()

_.Library.Boolean DiffEnabled ( )

static

Returns boolean value indicated whether or not the diff UI can be displayed.

Set ^SYS("SourceControl","UIConfig","DisableDiff")=1 to disable diff for a specific namespace

Set ^SYS("SourceControl","UIConfig","DisableDiff")=1 to disable diff for the entire instance

◆ GetParameter()

_.Library.String GetParameter ( Parameter )

static

Pages inheriting from CSP.Page don't have a GetParameter() method until 2010.2.

This method allows access to the parameter values in the class from outside of the class

◆ LoginDisplay()

LoginDisplay ( _.Library.Boolean pContinue )

static

If login needed (connected multi-developer instance), displays/processes the login form.

Other UIs can call this and examine pLoggedIn to determine if processing should continue.

◆ OnPage()

_.Library.Status OnPage ( )

static

Event handler for PAGE event: this is invoked in order to

generate the content of a csp page.

Reimplemented from Page.

◆ PerforceLoggedIn()

_.Library.Boolean PerforceLoggedIn ( )

static

Returns true if the user has a valid Perforce ticket in the CSP session, otherwise returns false.

Also obtains and validate an existing ticket.
This also inializes the process ticket variable, so this must be called whenever a server-side method requiring Perforce access is invoked

◆ PerforceLogin()

_.Library.Status PerforceLogin ( Password )

static

Accepts the password for the current Perforce user (defined by $USERNAME) and validates password by attempting to log into Perforce and obtain a IP-bound ticket

If login is successful, ticket is stored in the session to be reused on later calls to Perforce
If Password is not defined, then the locally cached ticket will be cleared

◆ SwitchChangelist()

SwitchChangelist ( newChangelist )

static

Store the new changelist number in session.Data if switching.

changelists on check-in page

◆ SystemdefaultsDisplay()

SystemdefaultsDisplay ( _.Library.Boolean DisplayForm )

static

Runs the Ens.Config.DefaultSettings.

Export method

◆ ValidateCCRUpload()

ValidateCCRUpload ( pRID )

static

Called from UI Bundle page to validate whether an ItemSet can be uploaded for a given CCR.

Updates elements on the page according to the status

Member Data Documentation

◆ SECURITYRESOURCE

SECURITYRESOURCE = None

static

Do not accept the default SECURITYRESOURCE from the superclass as this page handles it's own security to allow TrakCare use-cases.

NOTE - this parameter is not enforced until 2012.2

◆ Version

Version = None

static

Revision number of this class when compiled as part of the //custom_ccrs/_common/config/...

branch.

This version will not be updated (by design) when the class is integrated to other branches. This allows the user to tell what version of the Studio client tools are in use.

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ AllowedApps()

◆ CheckinDisplay()

◆ ClearP4Ticket()

◆ DiffEnabled()

◆ GetParameter()

◆ LoginDisplay()

◆ OnPage()

◆ PerforceLoggedIn()

◆ PerforceLogin()

◆ SwitchChangelist()

◆ SystemdefaultsDisplay()

◆ ValidateCCRUpload()

Member Data Documentation

◆ SECURITYRESOURCE

◆ Version