UserController

Field Summary

ActionBegin Action, cp-begin, supplied by the system when an application is initially created.

ActionContinue Action, cp-continue, supplied by the system when an existing application is accessed.

ActionStoreInstall 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
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.
Email	createEmail(String emailName) Creates an Email container using the specified template.
Email	createEmail(String emailName, String emailSettingsId) Creates an Email container using the specified template and specified enterprise email settings.
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.
String	createSingleUseConsoleToken(ProfilePacket packet, String action, Data data) Returns a single use token to Console for the active user. The token should be used immediately. The contents of data are available from the initial request in console workflow.
String	createSingleUseConsoleToken(ProfilePacket packet, String action, Data data, boolean headless) Returns a single use token to Console for the active user. The token should be used immediately. The contents of data are available from the initial request in console workflow.
String	createSingleUseToken(TransactionPacket packet, String action, Data data) Returns a single use token for the transaction and the active user. The token should be used immediately. The contents of data are available from the initial request in transaction workflow.
String	createSingleUseToken(TransactionPacket packet, String action, Data data, boolean headless) Returns a single use token for the transaction and the active user. The token should be used immediately. The contents of data are available from the initial request in transaction workflow.
TextEmail	createTextEmail(String emailName) Creates a text-based (body is text as opposed to XHTML) email.
TransactionPacket	createTransaction(String description, String role) Create a transaction with the given description. If role is not null, the current user will be assigned the given role on the profile associated with the desktop software. Returns the Packet if successful.
	debug(Object 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.
	dumpDebug() Forces an immediate flush of the debug log. This can be called once every 10 seconds.
String	getAction() Returns the action.
BusinessUtil	getBusinessUtil() Returns a BusinessUtil object.
ChartTool	getChartTool() Creates and returns a chart factory object which can be used to create specific chart types.
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. If the Pal does not have a console module, this returns null.
DateUtil	getDateUtil() Returns a utility for working with dates.
EncryptionUtil	getEncryptionUtil() Returns encryption utility
Enterprise	getEnterprise() Returns the enterprise associated with the running Pal.
String	getError() Returns the error, if any.
String	getFirstTransactionId() Returns the first transaction id created by this pal for this user.
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	getLastTransactionId() Returns the last transaction id created by this pal for this user.
Logger	getLogger() Returns the Logger for this workflow engine.
Monitor	getMonitor() Returns the workflow monitor.
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.
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 request.
String	getResourcePath(String resource, String version) Returns the resource path for the specified resource.
UserWebServiceResponse	getResponse() Returns the response.
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.
User	getUser() Returns the active user.
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	isAction(String action) Returns true if the action is the specified action
	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.
	setErrorPrefix(String errorPrefix) Appends this prefix to any workflow generated error message.
	setTimeZone(String timezone) Sets the timezone for dates created or displayed in this thread.
String	toString() Returns a description of this object.

Method Detail

---

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

---

Buffer createBuffer()

Creates and returns a new Buffer object

Returns:  Buffer

Since: 07-11-2008

---

Data createData()

Creates and returns an empty Data object

Returns:  Data

Since: 08-21-2007

---

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

---

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

---

Email createEmail(String emailName)

Creates an Email container using the specified template.

Parameters:

• String   emailName

Returns:  Email

Since: 08-10-2009

---

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

---

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

---

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

---

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

---

JSONBuffer createJsonBuffer()

Returns a new JSON Buffer

Returns:  JSONBuffer

Since: 04-29-2022

---

JSONParser createJsonParser(String jsonString)

Returns a parser for the given JSON string

Parameters:

• String   jsonString Required parameter.

Returns:  JSONParser

Since: 01-29-2016

---

TextMessage createMessage()

Creates a new Message object.

Returns:  TextMessage

Since: 04-27-2009

---

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

---

Payload createPayload()

Creates a new Payload object.

Returns:  Payload

Since: 10-07-2010

---

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

---

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

---

String createSingleUseConsoleToken(ProfilePacket packet, String action, Data data)

Returns a single use token to Console for the active user. The token should be used immediately. The contents of data are available from the initial request in console workflow.

Parameters:

• ProfilePacket   packet Required parameter.
• String   action Required parameter.
• Data   data

Returns:  String

Since: 05-05-2011

---

String createSingleUseConsoleToken(ProfilePacket packet, String action, Data data, boolean headless)

Returns a single use token to Console for the active user. The token should be used immediately. The contents of data are available from the initial request in console workflow.

Parameters:

• ProfilePacket   packet Required parameter.
• String   action Required parameter.
• Data   data
• boolean   headless  - set to true for headless access.

Returns:  String

Since: 01-16-2011

---

String createSingleUseToken(TransactionPacket packet, String action, Data data)

Returns a single use token for the transaction and the active user. The token should be used immediately. The contents of data are available from the initial request in transaction workflow.

Parameters:

• TransactionPacket   packet Required parameter.
• String   action Required parameter.
• Data   data

Returns:  String

Since: 02-04-2011

---

String createSingleUseToken(TransactionPacket packet, String action, Data data, boolean headless)

Returns a single use token for the transaction and the active user. The token should be used immediately. The contents of data are available from the initial request in transaction workflow.

Parameters:

• TransactionPacket   packet Required parameter.
• String   action Required parameter.
• Data   data
• boolean   headless  - set to true for headless access.

Returns:  String

Since: 01-16-2011

---

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

---

TransactionPacket createTransaction(String description, String role)

Create a transaction with the given description. If role is not null, the current user will be assigned the given role on the profile associated with the desktop software. Returns the Packet if successful.

Parameters:

• String   description Required parameter. Maximum allowed size of parameter: 128
• String   role Maximum allowed size of parameter: 80

Returns:  TransactionPacket

Since: 08-07-2009

---

debug(Object message)

Adds a debug message.

Parameters:

• Object   message  - Any object.

Since: 06-17-2024

---

debugData(Data data)

Debugs all the values of the given data object.

Parameters:

• Data   data

Since: 06-04-2019

---

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

---

debugPayload(Payload payload)

Debugs the payload. See comments on debugList and debugData

Parameters:

• Payload   payload

Since: 04-15-2021

---

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

---

dumpDebug()

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

Since: 12-10-2018

---

String getAction()

Returns the action.

Returns:  String

Since: 08-07-2009

---

BusinessUtil getBusinessUtil()

Returns a BusinessUtil object.

Returns:  BusinessUtil

Since: 07-15-2009

---

ChartTool getChartTool()

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

Returns:  ChartTool

Since: 03-01-2018

---

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. If the Pal does not have a console module, this returns null.

Returns:  ConsolePacket

Since: 07-22-2011

---

DateUtil getDateUtil()

Returns a utility for working with dates.

Returns:  DateUtil

Since: 07-29-2008

---

EncryptionUtil getEncryptionUtil()

Returns encryption utility

Returns:  EncryptionUtil

Since: 11-30-2016

---

Enterprise getEnterprise()

Returns the enterprise associated with the running Pal.

Returns:  Enterprise

Since: 02-17-2011

---

String getError()

Returns the error, if any.

Returns:  String

Since: 07-11-2008

---

String getFirstTransactionId()

Returns the first transaction id created by this pal for this user.

Returns:  String

Since: 01-07-2010

---

Formatter getFormatter()

Returns a formatter.

Returns:  Formatter

Since: 07-31-2008

---

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

---

String getLastTransactionId()

Returns the last transaction id created by this pal for this user.

Returns:  String

Since: 01-07-2010

---

Logger getLogger()

Returns the Logger for this workflow engine.

Returns:  Logger

Since: 10-19-2020

---

Monitor getMonitor()

Returns the workflow monitor.

Returns:  Monitor

Since: 01-04-2010

---

RuntimePal getPal()

Returns the active Pal

Returns:  RuntimePal

Since: 04-28-2010

---

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

---

PalInfo getPalInfo(String palId)

The PalInfo for the specified palId.

Parameters:

• String   palId

Returns:  PalInfo

Since: 10-27-2009

---

String[] getPlugins()

Returns the names of all plugins registered in this cloud

Returns:  String[]

Since: 11-28-2022

---

QRUtil getQRUtil()

Returns a utility for creating and reading QR codes.

Returns:  QRUtil

Since: 01-26-2017

---

Request getRequest()

Returns the request.

Returns:  Request

Since: 08-07-2009

---

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

---

UserWebServiceResponse getResponse()

Returns the response.

Returns:  UserWebServiceResponse

Since: 08-21-2009

---

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

---

String getTimeZone()

Returns the timezone for this thread.

Returns:  String

Since: 03-14-2022

---

TransactionPacket getTransaction(String txId)

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

Parameters:

• String   txId

Returns:  TransactionPacket

Since: 08-07-2009

---

TransactionUtil getTransactionUtil()

Returns a utility for working with one or more transactions.

Returns:  TransactionUtil

Since: 05-31-2011

---

User getUser()

Returns the active user.

Returns:  User

Since: 08-07-2009

---

Validator getValidator()

Returns a utility for validating user data.

Returns:  Validator

Since: 07-11-2008

---

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

---

String getWorkflowName()

Returns the name of the currently running workflow.

Returns:  String

Since: 11-13-2009

---

boolean isAction(String action)

Returns true if the action is the specified action

Parameters:

• String   action

Returns:  boolean

Since: 01-07-2010

---

setClean(boolean clean)

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

Parameters:

• boolean   clean Required parameter.

Since: 06-15-2022

---

setDateFormat(String pattern)

Sets the date pattern for displaying dates for this thread.

Parameters:

• String   pattern

Since: 10-07-2021

---

setErrorPrefix(String errorPrefix)

Appends this prefix to any workflow generated error message.

Parameters:

• String   errorPrefix

Since: 10-05-2015

---

setTimeZone(String timezone)

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

Parameters:

• String   timezone

Since: 10-07-2021

---

String toString()

Returns a description of this object.

Returns:  String

Since: 01-26-2011