InternalConsoleController

Action, cp-store-install, supplied by the system when the user has just aquired an item from the store and is now running installer workflow for the first time.

ActionStoreRemove

Action, cp-remove-store, supplied by the system when the user is requesting to be removed from the store and there is a non zero balance on the account.

ActionStoreUpgrade

Action, cp-store-upgrade, supplied by the system when the user has just aquired an upgrade from the store and is now running installer workflow for further configuration

Method Summary
	adjustModule() Adjusts the module i-frame to eliminate multiple scroll-bars.
	clearDebugs() Clears the debug entries.
AjaxResponse	createAjaxResponse(Fragment fragment, boolean dynamicRender) Returns a response to the client using content from the fragment. Pass true for dynamicRender to execute business logic tags and JEXL constructs.
AjaxResponse	createAjaxResponse(String string, boolean dynamicRender) Returns a response to the client using content from the string. Pass true for renderJexl to execute JEXL constructs.
String	createAndRunTransaction(String palId, String description, String dataName, Data data) ⚠Deprecated since 03-02-2011. Use TransactionPacket: createTransaction then add data and/or schedule workflow. Creates a transaction, initializes system workflow, and returns its ID. If the description is not null, the transaction description will be set to the description, otherwise it will be set to the Pal description. If dataName and Data are supplied, the information in the Data object will be stored in the newly created transaction and identified by dataName. If the Pal does not have system workflow, this will return null.
Browser	createBrowser(String userAgent) Creates a Browser object from the user agent. Some Browser methods may not work when the Browser instance is created this way.
Buffer	createBuffer() Creates and returns a new Buffer object
Data	createData() Creates and returns an empty Data object
PacketDataList	createDataList(String name, String column, String[] array) Creates a new non persistent PacketDataList and adds the array to the column
PacketDataList	createDataList(String name, String[] columns) Creates a new non persistent PacketDataList and returns it. Maximum column size is 100.
DownloadResponse	createDownloadResponse() Creates a DownloadResponse. This method can only be used in conjunction with the c:download tag.
Email	createEmail(String emailName, String emailSettingsId) Creates an Email container using the specified template and specified enterprise email settings.
InternalEmail	createEmail(String emailName, String emailSettingsId) Creates an Email container using the specified template and specified enterprise email settings.
InternalEmail	createEmail(String name) Creates an Email container using the specified template.
Email	createEmail(String name) Creates an Email container using the specified template.
InternalEnterprise	createEnterprise(Data data) ⚠Deprecated since 10-15-2019. Use InternalSystemManager.createEnterprise Creates an enterprise using the restricted key/values from the map-- see administrator documentation for more details. The active user is established as the owner of the Enterprise. Returns null if the Enterprise was not created successfully.
FileBuffer	createFileBuffer(String type, int limit) Creates and returns a new FileBuffer object
FtpRequest	createFtpRequest() Creates real-time FTP/FTPS/SFTP request object useful for communication with an external FTP service. Requires activation key with Remote Services enabled.
String	createGUID(String prefix) Creates a Globally Unique ID, alternatively with the specified prefix. Null prefix results in a guid of max length 37. With prefix it is length(prefix)+26
JSONBuffer	createJsonBuffer() Returns a new JSON Buffer
JSONParser	createJsonParser(String jsonString) Returns a parser for the given JSON string
TextMessage	createMessage() Creates a new Message object.
String	createMobileLink(PalInfo pal, String action, Data data) Creates link for mobile application
Payload	createPayload() Creates a new Payload object.
Payload	createPayload(String json) Creates a new Payload object from the JSON encoded string. See Payload.toJson().
ServiceRequest	createServiceRequest() Creates real-time http(s) request object useful for communication with external web services. Requires activation key with Remote Services enabled.
TextEmail	createTextEmail(String emailName) Creates a text-based (body is text as opposed to XHTML) email.
TransactionPacket	createTransaction(String palId, String description) Creates a transaction. If the description is not null, the transaction description will be set to the description, otherwise it will be set to the Pal description. This method enforces group permission for enterprise profiles and requires a pal other than the running pal to belong to the same group as the running pal.
String	createTransaction(String palId, String description, String role, String dataName, Data data) ⚠Deprecated since 03-02-2011. Use TransactionPacket: createTransaction then add data and/or assign roles. Creates a transaction and returns its ID. If the description is not null, the transaction description will be set to the description, otherwise it will be set to the Pal description. If role is not null, the user is assigned the specified role. If dataName and Data are supplied, the information in the Data object will be stored in the newly created transaction and identified by dataName. Note: if role is null and the user does not have appropriate group or shared group rights on the chosen Pal, this method will return null.
	debug(String message) Adds a debug message.
	debugData(Data data) Debugs all the values of the given data object.
	debugList(DataList list) Debugs the name, all of the columns, and up to 100 rows of data. The output is rendered in the debug messages of Pal Builder. This method is used for development purposes and ignored in deployed pals.
	debugPayload(Payload payload) Debugs the payload. See comments on debugList and debugData
	debugs(String message, int length) Adds the debug message but splits it into length character segments. Min length is 20 and max is 150. This debugs only to the server-side debugger.
boolean	deleteConsoleAccess(String profileId, String palId) ⚠Deprecated since 10-04-2013. Use Pal.getConsoleManager().deleteConsoleAccess(profileId) Deletes access to the specified Console Pal.
	deleteConsolePacket() Deletes the Console System Packet associated with this Pal along with any data stored in the Packet.
	deleteConsolePal(String palId) Deletes the specified console pal from the active user's list (requires personal profile).
	dumpDebug() Forces an immediate flush of the debug log. This can be called once every 10 seconds.
	enableDataSetDebug(boolean enabled) ⚠Deprecated since 05-02-2016. Use DataView or DatSet.getQuery(filter) Enables or disables DataSet debugging. See also DataViewList.getQuery()
	enableDebugger() Over-rides default debugger behavior and explicitly turns on full debug information-- use this in a troubleshooting scenario on a deployed Pal.
ConsoleResponse	exitToConsole() Exits to the default console screen that is not associated with the current Pal. Do not call this method on the system transaction manager pal.
InternalResponse	exitToDesktop() Passes control to the default desktop pal and reloads the screen
WorkflowResponse	exitToPWA(PWA pwa) Exits the user to the PWA app.
InternalResponse	exitToStore(String action, String storeId) Passes control to the system store pal with the specified action, optionally landing on a specific, featured item.
WorkflowResponse	exitToWeb(String url, String method) Forces an exit, redirecting the user to the specified url, optionally sending any data set in a Data object associated with this Response object. Note- this method primarily exists for integration purposes with console web services. Any other use is not automatic, meaning the user will see a page with the URL and have the option of clicking the link.
String	getAction() Returns the action.
Browser	getBrowser() Returns a Browser object that contains information about the client browser.
BusinessUtil	getBusinessUtil() Returns a BusinessUtil object.
ChartTool	getChartTool() Creates and returns a chart factory object which can be used to create specific chart types.
InternalCloud	getCloud() Returns a Cloud object. Logged in user must be a system admin or the Pal must belong to the system zone identified in the admin tool.
ConsolePacket	getConsolePacket() Returns the ConsolePacket associated with this Console Pal. There exists only one ConsolePacket for each ConsolePal. All users access the same ConsolePacket. Be careful when writing workflow that modifies the ConsolePacket. Typically, setting properties on the ConsolePacket should be limited to initialization, Console System workflow, or an administrator to reduce the chance of collision.
SystemDataView	getConsolePals() Returns a SystemDataView that can be used for accessing Console Pals that are accessible by the active user (personal profile required).
DateUtil	getDateUtil() Returns a utility for working with dates.
Data	getDesktopInfo(String profileId) Returns information for setting up the standard desktop
DataList	getDesktopPals(boolean includeShellPals) Returns list of pals (applications) for setting up the standard desktop
EncryptionUtil	getEncryptionUtil() Returns encryption utility
InternalEnterprise	getEnterprise() Returns the enterprise associated with the running Pal.
Enterprise	getEnterprise() Returns the enterprise associated with the running Pal.
DataList	getEnterprises(String emailAddress, String type) Returns a DataList (name=enterprises) of enterprises for which the person identified by emailAddress has a profile of the given type. Type options are: owner (Enterprise Owner), business (Business Contact), system (System Admin), technical (Technical Contact), user (has a User Profile)
String	getError() Returns the error, if any.
DataList	getErrors() Returns a list of errors.
Formatter	getFormatter() Returns a formatter.
GeoUtil	getGeoUtil(String units) Returns a utility for working with geo-coordinates. Use km for kilometers and m for miles.
String	getHelpUrl() Returns the URL to the system help site.
Installer	getInstaller() Returns the Installer for this Pal. Think of the Installer as an API version of Pal Manager. A user must have Manage Store permissions on the enterprise. In test mode, you must use a Shadow Pal since Installer manipulation alters the Pal you are working on.
InternalPalInfo	getInternalPalInfo(String palId) Returns the specified pal. Requires system zone access.
InternalRequest	getInternalRequest() Returns the current internalRequest.
String	getLastAction() Returns the last action.
String	getLastWorkflow() Returns the last workflow.
Logger	getLogger() Returns the Logger for this workflow engine.
int	getMaxPdfPageCount() ⚠Deprecated since 10-24-2016. Use Pal.getActivationKeyInfo().getMaxPdfPageCount() Returns the max page count for PDFs.
MobileManager	getMobileManager(Pal pal) If active user has manage SSO enterprise permissions and console group permissions on the pal, returns MobileManager for the given Pal.
Monitor	getMonitor() Returns the workflow monitor.
InternalSupportIncident	getNextIncident(String lastId) Returns the next support incident if any. Pass null to get the first support incident. Be sure to consume support incidents or you will get the same incidents again in subsequent iterations.
Page	getPage(String page) Returns the specified page.
RuntimePal	getPal() Returns the active Pal
RuntimePal	getPalById(String palId) Returns the Pal for the specified palId. Pals must belong to the same enterprise and group.
PalInfo	getPalInfo(String palId) The PalInfo for the specified palId.
InternalPalStore	getPalStore() Returns the Pal Store.
SystemDataView	getPalViewByGroup(String group) ⚠Deprecated since 09-19-2017. Use Profile.getPalManager().getPalsByGroup or getTransactionPalsByGroup Returns a SystemDataView that can be used for accessing pals of the enterprise that are associated with the specified group. The active user must be a member of the group.
String[]	getPlugins() Returns the names of all plugins registered in this cloud
QRUtil	getQRUtil() Returns a utility for creating and reading QR codes.
Request	getRequest() Returns the current Request.
String	getResourcePath(String resource, String version) Returns the resource path for the specified resource.
ShellPalManager	getShellPalManager() Returns shell pal manager for current pal. Current pal should be associated with zone and activation key with Shell Pals option enabled. Pal becomes "admin" for all shell pals created with this shell pal manager. Note that shell pal cannot manage other shell pals (shell pal cannot act as "admin" to create shell pals)
AjaxResponse	getSlice(String sliceId) Returns a response to the client using content from the specified slice. Returns null if no slice is available.
InternalCloudSubscriptionService	getSubscriptionService() Returns the Subscription Service for this Cloud
InternalSystemInformation	getSystemInformation() Returns system information.
InternalSystemLog	getSystemLog() Returns the SystemLog object. This Pal must the system security pal.
InternalResponse	getSystemLogin() Logs the user out and terminates the session. Subsequent login will use the system enterprise profile of the user. Returns null if the user does not have a system profile.
InternalSystemManager	getSystemManager() Returns the system manager. Only available from a system profile.
double	getTime() Returns the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC for the given server.
String	getTimeZone() Returns the timezone for this thread.
TransactionPacket	getTransaction(String txId) Returns the specified Packet. The user must have a role on the transaction
TransactionUtil	getTransactionUtil() Returns a utility for working with one or more transactions.
InternalUser	getUser() Returns the user.
User	getUser() Returns the user.
ProfilePacket	getUserPacket() ⚠Deprecated since 02-03-2014. Use Profile.getPacket() Returns the ProfilePacket associated with this Console Pal. Each user of the Console Pal has a single ProfilePacket. This may return null if the user has not been granted console access or otherwise has group access to console.
SystemDataView	getUserViewByGroup(String group) Returns a SystemDataView that can be used for accessing users of the enterprise that are associated with the specified group. The active user must have the necessary enterprise management permission. This may include users (profiles) who have been granted access to the enterprise but have not yet completed registration with the enterprise (filter lastAccess not null).
Validator	getValidator() Returns a utility for validating user data.
String	getWorker() Returns the worker (application server) running this workflow. Useful in a multi-worker environment for analyzing performance and for troubleshooting.
String	getWorkflowName() Returns the name of the currently running workflow.
boolean	grantConsoleAccess(String profileId, String palId) ⚠Deprecated since 10-04-2013. Use Pal.getConsoleManager().grantConsoleAccess(profileId) Grants access to the specified Console Pal. An icon will appear on the user's desktop. Requires a personal profile or a profile that belongs to the enterprise with sufficient group permissions.
boolean	isAction(String action) Returns true if the action is the specified action
boolean	isBegin() Returns true if the action is cp-begin. This is the action associated with the Transaction being created by an end user from an external link.
boolean	isContinue() Returns true if the action is cp-continue. This is the action associated with a link from Console.
boolean	isWebDavEnabled() ⚠Deprecated since 10-11-2016. No replacement. Returns true if webdav support is enabled.
InternalResponse	logout() Logs the user out and terminates the session.
	redrawConsole() Re-draws the console desktop (currently the left menu). See also InternalUser.switchToProfile.
	removeInlinePal(String palId, String action) Removes the specified inline pal for this session.
	removeSessionRecovery() Removes session recovery.
	revertWorkflow() Reverts the workflow engine to its prior workflow
	setClean(boolean clean) Sets all dataset operations to clean/not clean. See Dataset.setClean(boolean)
	setDateFormat(String pattern) Sets the date pattern for displaying dates for this thread.
	setDefaultConsolePal(String palId) Sets the specified console pal as the default for the active user (requires personal profile).
	setErrorPrefix(String errorPrefix) Appends this prefix to any workflow generated error message.
	setMaxInactiveInterval(int inactiveTime) Sets the max inactive time for this user. If no activity occurs in this time, the user will be logged out. Min is 1 second, max is 28800 seconds (8 hours). Unless configured at the cloud level, the timeout reverts back to the system default for each pal so if you want to enforce it you must call it each time workflow is run.
	setSessionRecovery(String workflow, String action, boolean restrict, int expires) Specifies a console workflow and action to attempt session recovery within the specified timeout in minutes.
	setTimeZone(String timezone) Sets the timezone for dates created or displayed in this thread.
	setTimeoutAction(String palId, String action, String endpoint, boolean secure) If the pal has a web pal component, this will tell the platform to take the user to the web workflow of the specified pal when there is a session timeout event. The action will be encrypted and can be obtained from the path of the web pal. If secure=true, the user will be taken to the secure web url of the pal. Throws exception if the pal does not have a web component. This should be called on each page load.
	setTimeoutWorkflow(String workflow, boolean capturePost) Specifies a console system workflow to record session timeout events optionally capturing post data that was submitted when the session timed-out.
	setUtilityReference(String reference) ⚠Deprecated since 02-06-2019. No replacement. Sets the utility billing reference for this thread. This is a development feature.
WorkflowResponse	switchToConsolePal(String palId, String action) Exits this Pal and passes control to the specified Pal. See grantConsoleAccess. This method returns null if the user cannot access the specified Pal. Pass null for action to use the default action (cp-continue).
WorkflowResponse	switchToNavigator(String txId, String action, boolean anon) Switches control to the specified transaction in Navigator. If anon is true and the profile is personal, the user will have access to the transaction whether or not the user has a role. Otherwise, role and group restrictions apply.
InternalResponse	switchToPal(String palId, String profileId, String workflow) Exits the store and passes control to the installer workflow of the given installation or subscription.
WorkflowResponse	switchToWorkflow(String workflow, String action) Switches the user to a different workflow file. Workflow must be of the same type. You must immediately return this response.
String	toString() Returns a description of this object.

Method Detail

adjustModule()

Adjusts the module i-frame to eliminate multiple scroll-bars.

Since: 04-13-2010

top

clearDebugs()

Clears the debug entries.

Since: 01-28-2009

top

AjaxResponse createAjaxResponse(Fragment fragment, boolean dynamicRender)

Returns a response to the client using content from the fragment. Pass true for dynamicRender to execute business logic tags and JEXL constructs.

Parameters:

Fragment fragment
boolean dynamicRender

Returns: AjaxResponse

Since: 01-28-2009

top

AjaxResponse createAjaxResponse(String string, boolean dynamicRender)

Returns a response to the client using content from the string. Pass true for renderJexl to execute JEXL constructs.

Parameters:

String string
boolean dynamicRender

Returns: AjaxResponse

Since: 01-28-2009

top

String createAndRunTransaction(String palId, String description, String dataName, Data data)

Creates a transaction, initializes system workflow, and returns its ID. If the description is not null, the transaction description will be set to the description, otherwise it will be set to the Pal description. If dataName and Data are supplied, the information in the Data object will be stored in the newly created transaction and identified by dataName. If the Pal does not have system workflow, this will return null.

Parameters:

String palId Required parameter.
String description Maximum allowed size of parameter: 128
String dataName - name of data in new packet.
Data data

Returns: String

Since: 03-19-2009

This method has been deprecated since 03-02-2011. Use TransactionPacket: createTransaction then add data and/or schedule workflow.

top

Browser createBrowser(String userAgent)

Creates a Browser object from the user agent. Some Browser methods may not work when the Browser instance is created this way.

Parameters:

String userAgent Required parameter.

Returns: Browser

Since: 04-21-2020

top

Buffer createBuffer()

Creates and returns a new Buffer object

Returns: Buffer

Since: 07-11-2008

top

Data createData()

Creates and returns an empty Data object

Returns: Data

Since: 08-21-2007

top

PacketDataList createDataList(String name, String column, String[] array)

Creates a new non persistent PacketDataList and adds the array to the column

Parameters:

String name Required parameter.
String column Required parameter.
String[] array Required parameter.

Returns: PacketDataList

Since: 06-10-2016

top

PacketDataList createDataList(String name, String[] columns)

Creates a new non persistent PacketDataList and returns it. Maximum column size is 100.

Parameters:

String name
String[] columns

Returns: PacketDataList

Since: 10-07-2010

top

DownloadResponse createDownloadResponse()

Creates a DownloadResponse. This method can only be used in conjunction with the c:download tag.

Returns: DownloadResponse

Since: 08-11-2010

top

Email createEmail(String emailName, String emailSettingsId)

Creates an Email container using the specified template and specified enterprise email settings.

Parameters:

String emailName - email template name. Required parameter.
String emailSettingsId - if of enterprise email settings. Required parameter.

Returns: Email

Since: 02-11-2011

top

InternalEmail createEmail(String emailName, String emailSettingsId)

Creates an Email container using the specified template and specified enterprise email settings.

Parameters:

String emailName - email template name. Required parameter.
String emailSettingsId - if of enterprise email settings. Required parameter.

Returns: InternalEmail

Since: 02-11-2011

top

InternalEmail createEmail(String name)

Creates an Email container using the specified template.

Parameters:

String name

Returns: InternalEmail

Since: 02-23-2009

top

Email createEmail(String name)

Creates an Email container using the specified template.

Parameters:

String name

Returns: Email

Since: 02-23-2009

top

InternalEnterprise createEnterprise(Data data)

Creates an enterprise using the restricted key/values from the map-- see administrator documentation for more details. The active user is established as the owner of the Enterprise. Returns null if the Enterprise was not created successfully.

Parameters:

Data data

Returns: InternalEnterprise

Since: 04-16-2010

This method has been deprecated since 10-15-2019. Use InternalSystemManager.createEnterprise

top

FileBuffer createFileBuffer(String type, int limit)

Creates and returns a new FileBuffer object

Parameters:

String type Required parameter. Allowed values: zip, jar, ods, odt, xlsx, docx.
int limit - Max size limit in KB, cannot exceed Max Export size of activation key. Required parameter.

Returns: FileBuffer

Since: 08-27-2013

top

FtpRequest createFtpRequest()

Creates real-time FTP/FTPS/SFTP request object useful for communication with an external FTP service. Requires activation key with Remote Services enabled.

Returns: FtpRequest

Since: 05-25-2011

top

String createGUID(String prefix)

Creates a Globally Unique ID, alternatively with the specified prefix. Null prefix results in a guid of max length 37. With prefix it is length(prefix)+26

Parameters:

String prefix

Returns: String

Since: 05-21-2009

top

JSONBuffer createJsonBuffer()

Returns a new JSON Buffer

Returns: JSONBuffer

Since: 04-29-2022

top

JSONParser createJsonParser(String jsonString)

Returns a parser for the given JSON string

Parameters:

String jsonString Required parameter.

Returns: JSONParser

Since: 01-29-2016

top

TextMessage createMessage()

Creates a new Message object.

Returns: TextMessage

Since: 04-27-2009

top

String createMobileLink(PalInfo pal, String action, Data data)

Creates link for mobile application

Parameters:

PalInfo pal - Pal to create link to. Required parameter.
String action - action defined in mobile configuration. Required parameter.
Data data - optional data to pass to action.

Returns: String

Since: 06-24-2011

top

Payload createPayload()

Creates a new Payload object.

Returns: Payload

Since: 10-07-2010

top

Payload createPayload(String json)

Creates a new Payload object from the JSON encoded string. See Payload.toJson().

Parameters:

String json Required parameter.

Returns: Payload

Since: 05-16-2011

top

ServiceRequest createServiceRequest()

Creates real-time http(s) request object useful for communication with external web services. Requires activation key with Remote Services enabled.

Returns: ServiceRequest

Since: 11-05-2010

top

TextEmail createTextEmail(String emailName)

Creates a text-based (body is text as opposed to XHTML) email.

Parameters:

String emailName

Returns: TextEmail

Since: 05-27-2009

top

TransactionPacket createTransaction(String palId, String description)

Creates a transaction. If the description is not null, the transaction description will be set to the description, otherwise it will be set to the Pal description. This method enforces group permission for enterprise profiles and requires a pal other than the running pal to belong to the same group as the running pal.

Parameters:

String palId Required parameter.
String description Maximum allowed size of parameter: 128

Returns: TransactionPacket

Since: 03-02-2011

top

String createTransaction(String palId, String description, String role, String dataName, Data data)

Creates a transaction and returns its ID. If the description is not null, the transaction description will be set to the description, otherwise it will be set to the Pal description. If role is not null, the user is assigned the specified role. If dataName and Data are supplied, the information in the Data object will be stored in the newly created transaction and identified by dataName. Note: if role is null and the user does not have appropriate group or shared group rights on the chosen Pal, this method will return null.

Parameters:

String palId Required parameter.
String description Maximum allowed size of parameter: 128
String role Maximum allowed size of parameter: 80
String dataName - name of data in new packet.
Data data

Returns: String

Since: 01-09-2009

This method has been deprecated since 03-02-2011. Use TransactionPacket: createTransaction then add data and/or assign roles.

top

debug(String message)

Adds a debug message.

Parameters:

String message

Since: 09-16-2008

top

debugData(Data data)

Debugs all the values of the given data object.

Parameters:

Data data

Since: 06-04-2019

top

debugList(DataList list)

Debugs the name, all of the columns, and up to 100 rows of data. The output is rendered in the debug messages of Pal Builder. This method is used for development purposes and ignored in deployed pals.

Parameters:

DataList list

Since: 06-21-2019

top

debugPayload(Payload payload)

Debugs the payload. See comments on debugList and debugData

Parameters:

Payload payload

Since: 04-15-2021

top

debugs(String message, int length)

Adds the debug message but splits it into length character segments. Min length is 20 and max is 150. This debugs only to the server-side debugger.

Parameters:

String message
int length Required parameter. Maximum allowed size of parameter: 150

Since: 07-27-2021

top

boolean deleteConsoleAccess(String profileId, String palId)

Deletes access to the specified Console Pal.

Parameters:

String profileId
String palId

Returns: boolean

Since: 03-30-2009

This method has been deprecated since 10-04-2013. Use Pal.getConsoleManager().deleteConsoleAccess(profileId)

top

deleteConsolePacket()

Deletes the Console System Packet associated with this Pal along with any data stored in the Packet.

Since: 12-20-2013

top

deleteConsolePal(String palId)

Deletes the specified console pal from the active user's list (requires personal profile).

Parameters:

String palId

Since: 09-28-2009

top

dumpDebug()

Forces an immediate flush of the debug log. This can be called once every 10 seconds.

Since: 12-10-2018

top

enableDataSetDebug(boolean enabled)

Enables or disables DataSet debugging. See also DataViewList.getQuery()

Parameters:

boolean enabled

Since: 02-22-2016

This method has been deprecated since 05-02-2016. Use DataView or DatSet.getQuery(filter)

top

enableDebugger()

Over-rides default debugger behavior and explicitly turns on full debug information-- use this in a troubleshooting scenario on a deployed Pal.

Since: 01-28-2009

top

ConsoleResponse exitToConsole()

Exits to the default console screen that is not associated with the current Pal. Do not call this method on the system transaction manager pal.

Returns: ConsoleResponse

Since: 08-03-2009

top

InternalResponse exitToDesktop()

Passes control to the default desktop pal and reloads the screen

Returns: InternalResponse

Since: 10-28-2015

top

WorkflowResponse exitToPWA(PWA pwa)

Exits the user to the PWA app.

Parameters:

PWA pwa Required parameter.

Returns: WorkflowResponse

Since: 10-14-2021

top

InternalResponse exitToStore(String action, String storeId)

Passes control to the system store pal with the specified action, optionally landing on a specific, featured item.

Parameters:

String action - action to pass to the store. Allowed values: cp-add-app, cp-manage-store.
String storeId - ID of the featured item in the store.

Returns: InternalResponse

Since: 04-19-2010

top

WorkflowResponse exitToWeb(String url, String method)

Forces an exit, redirecting the user to the specified url, optionally sending any data set in a Data object associated with this Response object. Note- this method primarily exists for integration purposes with console web services. Any other use is not automatic, meaning the user will see a page with the URL and have the option of clicking the link.

Parameters:

String url
String method Allowed values: get, post.

Returns: WorkflowResponse

Since: 08-03-2009

top

String getAction()

Returns the action.

Returns: String

Since: 12-31-2008

top

Browser getBrowser()

Returns a Browser object that contains information about the client browser.

Returns: Browser

Since: 07-20-2009

top

BusinessUtil getBusinessUtil()

Returns a BusinessUtil object.

Returns: BusinessUtil

Since: 07-15-2009

top

ChartTool getChartTool()

Creates and returns a chart factory object which can be used to create specific chart types.

Returns: ChartTool

Since: 03-01-2018

top

InternalCloud getCloud()

Returns a Cloud object. Logged in user must be a system admin or the Pal must belong to the system zone identified in the admin tool.

Returns: InternalCloud

Since: 05-14-2013

top

ConsolePacket getConsolePacket()

Returns the ConsolePacket associated with this Console Pal. There exists only one ConsolePacket for each ConsolePal. All users access the same ConsolePacket. Be careful when writing workflow that modifies the ConsolePacket. Typically, setting properties on the ConsolePacket should be limited to initialization, Console System workflow, or an administrator to reduce the chance of collision.

Returns: ConsolePacket

Since: 03-19-2009

top

SystemDataView getConsolePals()

Returns a SystemDataView that can be used for accessing Console Pals that are accessible by the active user (personal profile required).

Returns: SystemDataView

DataList Name: ConsolePals
Tag Support: No

DataList Keys/Column Name	Column Type	Read Only
palId	String
test (Deprecated 03-16-2012)	Boolean
testPal	Boolean
name	String
createDate	Number
enterpriseName	String

Since: 07-14-2009

top

DateUtil getDateUtil()

Returns a utility for working with dates.

Returns: DateUtil

Since: 07-29-2008

top

Data getDesktopInfo(String profileId)

Returns information for setting up the standard desktop

Parameters:

String profileId Required parameter.

Returns: Data

Since: 01-15-2019

top

DataList getDesktopPals(boolean includeShellPals)

Returns list of pals (applications) for setting up the standard desktop

Parameters:

boolean includeShellPals

Returns: DataList

DataList Name: pals
DataList Fields: palId, name, enterpriseName, testPal, shellPal

Since: 01-15-2019

top

EncryptionUtil getEncryptionUtil()

Returns encryption utility

Returns: EncryptionUtil

Since: 11-30-2016

top

InternalEnterprise getEnterprise()

Returns the enterprise associated with the running Pal.

Returns: InternalEnterprise

Since: 02-17-2011

top

Enterprise getEnterprise()

Returns the enterprise associated with the running Pal.

Returns: Enterprise

Since: 02-17-2011

top

DataList getEnterprises(String emailAddress, String type)

Returns a DataList (name=enterprises) of enterprises for which the person identified by emailAddress has a profile of the given type. Type options are: owner (Enterprise Owner), business (Business Contact), system (System Admin), technical (Technical Contact), user (has a User Profile)

Parameters:

String emailAddress
String type Allowed values: owner, business, system, technical, user.

Returns: DataList

DataList Name: enterprises
DataList Fields: id, name

Since: 03-02-2010

top

String getError()

Returns the error, if any.

Returns: String

Since: 07-11-2008

top

DataList getErrors()

Returns a list of errors.

Returns: DataList

DataList Name: errors
DataList Fields: error, code, custom

Since: 02-03-2009

top

Formatter getFormatter()

Returns a formatter.

Returns: Formatter

Since: 07-31-2008

top

GeoUtil getGeoUtil(String units)

Returns a utility for working with geo-coordinates. Use km for kilometers and m for miles.

Parameters:

String units Required parameter. Allowed values: km, m.

Returns: GeoUtil

Since: 08-27-2019

top

String getHelpUrl()

Returns the URL to the system help site.

Returns: String

Since: 10-02-2009

top

Installer getInstaller()

Returns the Installer for this Pal. Think of the Installer as an API version of Pal Manager. A user must have Manage Store permissions on the enterprise. In test mode, you must use a Shadow Pal since Installer manipulation alters the Pal you are working on.

Returns: Installer

Since: 09-24-2009

top

InternalPalInfo getInternalPalInfo(String palId)

Returns the specified pal. Requires system zone access.

Parameters:

String palId Required parameter.

Returns: InternalPalInfo

Since: 05-09-2014

top

InternalRequest getInternalRequest()

Returns the current internalRequest.

Returns: InternalRequest

Since: 08-28-2009

top

String getLastAction()

Returns the last action.

Returns: String

Since: 09-29-2020

top

String getLastWorkflow()

Returns the last workflow.

Returns: String

Since: 09-29-2020

top

Logger getLogger()

Returns the Logger for this workflow engine.

Returns: Logger

Since: 10-19-2020

top

int getMaxPdfPageCount()

Returns the max page count for PDFs.

Returns: int

Since: 11-05-2013

This method has been deprecated since 10-24-2016. Use Pal.getActivationKeyInfo().getMaxPdfPageCount()

top

MobileManager getMobileManager(Pal pal)

If active user has manage SSO enterprise permissions and console group permissions on the pal, returns MobileManager for the given Pal.

Parameters:

Pal pal

Returns: MobileManager

Since: 05-04-2011

top

Monitor getMonitor()

Returns the workflow monitor.

Returns: Monitor

Since: 01-04-2010

top

InternalSupportIncident getNextIncident(String lastId)

Returns the next support incident if any. Pass null to get the first support incident. Be sure to consume support incidents or you will get the same incidents again in subsequent iterations.

Parameters:

String lastId

Returns: InternalSupportIncident

Since: 04-18-2011

top

Page getPage(String page)

Returns the specified page.

Parameters:

String page

Returns: Page

Since: 12-31-2008

top

RuntimePal getPal()

Returns the active Pal

Returns: RuntimePal

Since: 04-28-2010

top

RuntimePal getPalById(String palId)

Returns the Pal for the specified palId. Pals must belong to the same enterprise and group.

Parameters:

String palId

Returns: RuntimePal

Since: 04-28-2010

top

PalInfo getPalInfo(String palId)

The PalInfo for the specified palId.

Parameters:

String palId

Returns: PalInfo

Since: 10-27-2009

top

InternalPalStore getPalStore()

Returns the Pal Store.

Returns: InternalPalStore

Since: 02-23-2009

top

SystemDataView getPalViewByGroup(String group)

Returns a SystemDataView that can be used for accessing pals of the enterprise that are associated with the specified group. The active user must be a member of the group.

Parameters:

String group

Returns: SystemDataView

DataList Name: TxPalsByGroup
Tag Support: No

DataList Keys/Column Name	Column Type	Read Only
id	String
name	String
description	String
category	String
createDate	Date
modifiedDate	Date
test (Deprecated 03-16-2012)	Boolean
testPal	Boolean
modeConsole	Boolean
modeTransaction	Boolean
modeWeb	Boolean

Since: 01-19-2009

This method has been deprecated since 09-19-2017. Use Profile.getPalManager().getPalsByGroup or getTransactionPalsByGroup

top

String[] getPlugins()

Returns the names of all plugins registered in this cloud

Returns: String[]

Since: 11-28-2022

top

QRUtil getQRUtil()

Returns a utility for creating and reading QR codes.

Returns: QRUtil

Since: 01-26-2017

top

Request getRequest()

Returns the current Request.

Returns: Request

Since: 12-31-2008

top

String getResourcePath(String resource, String version)

Returns the resource path for the specified resource.

Parameters:

String resource Required parameter.
String version

Returns: String

Since: 12-08-2015

top

ShellPalManager getShellPalManager()

Returns shell pal manager for current pal. Current pal should be associated with zone and activation key with Shell Pals option enabled. Pal becomes "admin" for all shell pals created with this shell pal manager. Note that shell pal cannot manage other shell pals (shell pal cannot act as "admin" to create shell pals)

Returns: ShellPalManager

Since: 04-04-2011

top

AjaxResponse getSlice(String sliceId)

Returns a response to the client using content from the specified slice. Returns null if no slice is available.

Parameters:

String sliceId Required parameter.

Returns: AjaxResponse

Since: 11-23-2022

top

InternalCloudSubscriptionService getSubscriptionService()

Returns the Subscription Service for this Cloud

Returns: InternalCloudSubscriptionService

Since: 12-11-2013

top

InternalSystemInformation getSystemInformation()

Returns system information.

Returns: InternalSystemInformation

Since: 03-03-2010

top

InternalSystemLog getSystemLog()

Returns the SystemLog object. This Pal must the system security pal.

Returns: InternalSystemLog

Since: 11-21-2013

top

InternalResponse getSystemLogin()

Logs the user out and terminates the session. Subsequent login will use the system enterprise profile of the user. Returns null if the user does not have a system profile.

Returns: InternalResponse

Since: 01-15-2019

top

InternalSystemManager getSystemManager()

Returns the system manager. Only available from a system profile.

Returns: InternalSystemManager

Since: 03-08-2010

top

double getTime()

Returns the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC for the given server.

Returns: double

Since: 10-07-2021

top

String getTimeZone()

Returns the timezone for this thread.

Returns: String

Since: 03-14-2022

top

TransactionPacket getTransaction(String txId)

Returns the specified Packet. The user must have a role on the transaction

Parameters:

String txId

Returns: TransactionPacket

Since: 10-07-2009

top

TransactionUtil getTransactionUtil()

Returns a utility for working with one or more transactions.

Returns: TransactionUtil

Since: 12-15-2009

top

InternalUser getUser()

Returns the user.

Returns: InternalUser

Since: 12-31-2008

top

User getUser()

Returns the user.

Returns: User

Since: 12-31-2008

top

ProfilePacket getUserPacket()

Returns the ProfilePacket associated with this Console Pal. Each user of the Console Pal has a single ProfilePacket. This may return null if the user has not been granted console access or otherwise has group access to console.

Returns: ProfilePacket

Since: 12-31-2008

This method has been deprecated since 02-03-2014. Use Profile.getPacket()

top

SystemDataView getUserViewByGroup(String group)

Returns a SystemDataView that can be used for accessing users of the enterprise that are associated with the specified group. The active user must have the necessary enterprise management permission. This may include users (profiles) who have been granted access to the enterprise but have not yet completed registration with the enterprise (filter lastAccess not null).

Parameters:

String group

Returns: SystemDataView

DataList Name: UsersByGroup
Tag Support: No

DataList Keys/Column Name	Column Type	Read Only
id	String
firstName	String
lastName	String
email	String
address	String
city	String
state	String
zip	String
country	String
phone	String
cellPhone	String
cellPhoneProvider	String
fax	String
timeZone	String
title	String
department	String
division	String
lastAccess	Date
accountDisabled	Boolean
salesId	String
userId	String

Since: 02-04-2009

top

Validator getValidator()

Returns a utility for validating user data.

Returns: Validator

Since: 07-11-2008

top

String getWorker()

Returns the worker (application server) running this workflow. Useful in a multi-worker environment for analyzing performance and for troubleshooting.

Returns: String

Since: 07-05-2021

top

String getWorkflowName()

Returns the name of the currently running workflow.

Returns: String

Since: 11-13-2009

top

boolean grantConsoleAccess(String profileId, String palId)

Grants access to the specified Console Pal. An icon will appear on the user's desktop. Requires a personal profile or a profile that belongs to the enterprise with sufficient group permissions.

Parameters:

String profileId
String palId

Returns: boolean

Since: 03-30-2009

This method has been deprecated since 10-04-2013. Use Pal.getConsoleManager().grantConsoleAccess(profileId)

top

boolean isAction(String action)

Returns true if the action is the specified action

Parameters:

String action

Returns: boolean

Since: 12-31-2008

top

boolean isBegin()

Returns true if the action is cp-begin. This is the action associated with the Transaction being created by an end user from an external link.

Returns: boolean

Since: 12-31-2008

top

boolean isContinue()

Returns true if the action is cp-continue. This is the action associated with a link from Console.

Returns: boolean

Since: 12-31-2008

top

boolean isWebDavEnabled()

Returns true if webdav support is enabled.

Returns: boolean

Since: 08-29-2012

This method has been deprecated since 10-11-2016. No replacement.

top

InternalResponse logout()

Logs the user out and terminates the session.

Returns: InternalResponse

Since: 09-25-2012

top

redrawConsole()

Re-draws the console desktop (currently the left menu). See also InternalUser.switchToProfile.

Since: 10-09-2009

top

removeInlinePal(String palId, String action)

Removes the specified inline pal for this session.

Parameters:

String palId Required parameter.
String action Required parameter.

Since: 07-22-2019

top

removeSessionRecovery()

Removes session recovery.

Since: 08-13-2021

top

revertWorkflow()

Reverts the workflow engine to its prior workflow

Since: 05-24-2019

top

setClean(boolean clean)

Sets all dataset operations to clean/not clean. See Dataset.setClean(boolean)

Parameters:

boolean clean Required parameter.

Since: 06-15-2022

top

setDateFormat(String pattern)

Sets the date pattern for displaying dates for this thread.

Parameters:

String pattern

Since: 10-07-2021

top

setDefaultConsolePal(String palId)

Sets the specified console pal as the default for the active user (requires personal profile).

Parameters:

String palId

Since: 09-28-2009

top

setErrorPrefix(String errorPrefix)

Appends this prefix to any workflow generated error message.

Parameters:

String errorPrefix

Since: 10-05-2015

top

setMaxInactiveInterval(int inactiveTime)

Sets the max inactive time for this user. If no activity occurs in this time, the user will be logged out. Min is 1 second, max is 28800 seconds (8 hours). Unless configured at the cloud level, the timeout reverts back to the system default for each pal so if you want to enforce it you must call it each time workflow is run.

Parameters:

int inactiveTime - time in seconds.

Since: 03-20-2018

top

setSessionRecovery(String workflow, String action, boolean restrict, int expires)

Specifies a console workflow and action to attempt session recovery within the specified timeout in minutes.

Parameters:

String workflow Required parameter.
String action Required parameter.
boolean restrict - Restrict to current IP address. Required parameter.
int expires - Expiration in minutes. Max . Required parameter. Maximum allowed size of parameter: 44640

Since: 08-13-2021

top

setTimeZone(String timezone)

Sets the timezone for dates created or displayed in this thread.

Parameters:

String timezone

Since: 10-07-2021

top

setTimeoutAction(String palId, String action, String endpoint, boolean secure)

If the pal has a web pal component, this will tell the platform to take the user to the web workflow of the specified pal when there is a session timeout event. The action will be encrypted and can be obtained from the path of the web pal. If secure=true, the user will be taken to the secure web url of the pal. Throws exception if the pal does not have a web component. This should be called on each page load.

Parameters:

String palId Required parameter.
String action Required parameter.
String endpoint Required parameter.
boolean secure Required parameter.

Since: 03-11-2017

top

setTimeoutWorkflow(String workflow, boolean capturePost)

Specifies a console system workflow to record session timeout events optionally capturing post data that was submitted when the session timed-out.

Parameters:

String workflow Required parameter.
boolean capturePost Required parameter.

Since: 07-05-2021

top

setUtilityReference(String reference)

Sets the utility billing reference for this thread. This is a development feature.

Parameters:

String reference Required parameter. Maximum allowed size of parameter: 20

Since: 04-22-2011

This method has been deprecated since 02-06-2019. No replacement.

top

WorkflowResponse switchToConsolePal(String palId, String action)

Exits this Pal and passes control to the specified Pal. See grantConsoleAccess. This method returns null if the user cannot access the specified Pal. Pass null for action to use the default action (cp-continue).

Parameters:

String palId Required parameter.
String action

Returns: WorkflowResponse

Since: 04-05-2010

top

WorkflowResponse switchToNavigator(String txId, String action, boolean anon)

Switches control to the specified transaction in Navigator. If anon is true and the profile is personal, the user will have access to the transaction whether or not the user has a role. Otherwise, role and group restrictions apply.

Parameters: