|
|
Method DetailclearDebugs() Clears the debug entries. Since: 01-28-2009 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:
Returns: AjaxResponse Since: 01-28-2009 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:
Returns: AjaxResponse Since: 01-28-2009 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:
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:
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:
Returns: PacketDataList Since: 10-07-2010 DownloadResponse createDownloadResponse() Creates a DownloadResponse. This method can only be used in conjunction with the c:download tag. Returns: DownloadResponse Since: 08-11-2010 Email createEmail(String emailName, String emailSettingsId) Creates an Email container using the specified template and specified enterprise email settings.
Parameters:
Returns: Email Since: 02-11-2011 Email createEmail(String name) Creates an Email container using the specified template.
Parameters:
Returns: Email Since: 02-05-2009 FileBuffer createFileBuffer(String type, int limit) Creates and returns a new FileBuffer object
Parameters:
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:
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:
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:
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:
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 TextEmail createTextEmail(String emailName) Creates a text-based (body is text as opposed to XHTML) email.
Parameters:
Returns: TextEmail Since: 05-27-2009 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:
Returns: TransactionPacket Since: 03-02-2011 debug(Object message) Adds a debug message.
Parameters:
Since: 06-17-2024 debugData(Data data) Debugs all the values of the given data object.
Parameters:
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:
Since: 06-21-2019 debugPayload(Payload payload) Debugs the payload. See comments on debugList and debugData
Parameters:
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:
Since: 07-27-2021 deleteConsolePacket() Deletes the Console System Packet associated with this Pal along with any data stored in the Packet. Since: 12-20-2013 dumpDebug() Forces an immediate flush of the debug log. This can be called once every 10 seconds. Since: 12-10-2018 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 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 WorkflowResponse exitToPWA(PWA pwa) Exits the user to the PWA app.
Parameters:
Returns: WorkflowResponse Since: 10-14-2021 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:
Returns: WorkflowResponse Since: 08-03-2009 String getAction() Returns the action. Returns: String Since: 12-31-2008 Browser getBrowser() Returns a Browser object that contains information about the client browser. Returns: Browser Since: 07-20-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. Returns: ConsolePacket Since: 03-19-2009 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 DataList getErrors() Returns a list of errors. Returns: DataList DataList Name: errors DataList Fields: error, code, custom Since: 02-03-2009 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:
Returns: GeoUtil Since: 08-27-2019 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 String getLastAction() Returns the last action. Returns: String Since: 09-29-2020 String getLastWorkflow() Returns the last workflow. Returns: String Since: 09-29-2020 Logger getLogger() Returns the Logger for this workflow engine. Returns: Logger Since: 10-19-2020 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:
Returns: MobileManager Since: 05-04-2011 Monitor getMonitor() Returns the workflow monitor. Returns: Monitor Since: 01-04-2010 Page getPage(String page) Returns the specified page.
Parameters:
Returns: Page Since: 12-31-2008 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:
Returns: RuntimePal Since: 04-28-2010 PalInfo getPalInfo(String palId) The PalInfo for the specified palId.
Parameters:
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 current Request. Returns: Request Since: 12-31-2008 String getResourcePath(String resource, String version) Returns the resource path for the specified resource.
Parameters:
Returns: String Since: 12-08-2015 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 AjaxResponse getSlice(String sliceId) Returns a response to the client using content from the specified slice. Returns null if no slice is available.
Parameters:
Returns: AjaxResponse Since: 11-23-2022 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:
Returns: TransactionPacket Since: 10-07-2009 TransactionUtil getTransactionUtil() Returns a utility for working with one or more transactions. Returns: TransactionUtil Since: 12-15-2009 User getUser() Returns the user. Returns: User Since: 12-31-2008 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:
Returns: SystemDataView DataList Name: UsersByGroup
Since: 02-04-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:
Returns: boolean Since: 12-31-2008 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 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 removeInlinePal(String palId, String action) Removes the specified inline pal for this session.
Parameters:
Since: 07-22-2019 removeSessionRecovery() Removes session recovery. Since: 08-13-2021 revertWorkflow() Reverts the workflow engine to its prior workflow Since: 05-24-2019 setClean(boolean clean) Sets all dataset operations to clean/not clean. See Dataset.setClean(boolean)
Parameters:
Since: 06-15-2022 setDateFormat(String pattern) Sets the date pattern for displaying dates for this thread.
Parameters:
Since: 10-07-2021 setErrorPrefix(String errorPrefix) Appends this prefix to any workflow generated error message.
Parameters:
Since: 10-05-2015 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:
Since: 03-20-2018 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:
Since: 08-13-2021 setTimeZone(String timezone) Sets the timezone for dates created or displayed in this thread.
Parameters:
Since: 10-07-2021 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:
Since: 03-11-2017 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:
Since: 07-05-2021 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:
Returns: WorkflowResponse Since: 04-05-2010 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:
Returns: WorkflowResponse Since: 07-14-2009 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.
Parameters:
Returns: WorkflowResponse Since: 02-06-2009 String toString() Returns a description of this object. Returns: String Since: 12-31-2008 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. | API Date: Dec 03, 2024 10:24 AM |