Transaction Webservice API

Misc

04-11-2026
Object Method Return Type Description
JobManager createPriorityJob Job Creates a new job and immediately executes it with the specified priority. Note to keep this from being abused cloud-wide, each enterprise can have at most 10 priority jobs at any given time. A priority of 10 is the highest priority.
04-10-2026
Object Method Return Type Description
Job getPriority int Returns the job priority.
03-16-2026
Object Method Return Type Description
RuntimePal getTunnels DataList Returns a list of tunnels for this pal.
02-09-2026
Object Method Return Type Description
MailMessage getDeliveryStatus String Returns the delivery status of this email message
RuntimePal getMailMessage MailMessage Returns the MailMessage identified by Message ID and associated with this pal. A message ID is returned when sending an email and starts with EM-.
MailMessage getStatus String Returns the send status of this email message
01-19-2026
Object Method Return Type Description
AnalyticDataViewFilter forceIndex Force use of the specified index of this dataset.
DataViewBuilder forceIndex Force use of the specified index of the specified dataset.
DataViewFilter forceIndex Force use of the specified index of this dataset.
SystemDataViewFilter forceIndex Force use of the specified index of this dataset.
AnalyticDataViewFilter useIndex Use the specified index of this dataset.
DataViewBuilder useIndex Use the specified index of the specified dataset.
DataViewFilter useIndex Use the specified index of this dataset.
SystemDataViewFilter useIndex Use the specified index of this dataset.
12-15-2025
Object Method Return Type Description
RuntimePal getSettings Data Returns settings set in Pal Manager.
11-20-2025
Object Method Return Type Description
Chunk getContent String Returns the content of the chunk
10-16-2025
Object Method Return Type Description
Buffer removeNonUTF8Chars Buffer Removes non UTF-8 characters
10-11-2025
Object Method Return Type Description
StoredObject transferFile boolean Copies this object to the target provider
09-11-2025
Object Method Return Type Description
ExcelFile appendWorksheet Adds records to the existing worksheet starting at the position indicated (0 is first row) and preserves existing formatting if any.
05-21-2025
Object Method Return Type Description
AnalyticDataViewFilter addGreaterThanGeoDistance DataViewCriteria Returns rows where the geo distance from the given lat/lon is greater than or equal to the provided distance.
DataViewCriteria addGreaterThanGeoDistance DataViewCriteria Returns rows where the geo distance from the given lat/lon is greater than or equal to the provided distance.
DataViewFilter addGreaterThanGeoDistance DataViewCriteria Returns rows where the geo distance from the given lat/lon is greater than or equal to the provided distance.
SystemDataViewFilter addGreaterThanGeoDistance DataViewCriteria Returns rows where the geo distance from the given lat/lon is greater than or equal to the provided distance.
AnalyticDataViewFilter addLessThanGeoDistance DataViewCriteria Returns rows where the geo distance from the given lat/lon is less than or equal to the provided distance.
DataViewCriteria addLessThanGeoDistance DataViewCriteria Returns rows where the geo distance from the given lat/lon is less than or equal to the provided distance.
DataViewFilter addLessThanGeoDistance DataViewCriteria Returns rows where the geo distance from the given lat/lon is less than or equal to the provided distance.
SystemDataViewFilter addLessThanGeoDistance DataViewCriteria Returns rows where the geo distance from the given lat/lon is less than or equal to the provided distance.
05-20-2025
Object Method Return Type Description
AudioFile isPdfValid boolean Returns true if the content of the file is valid PDF. This will return false for encrypted PDFs or any non PDF files.
DatasetFile isPdfValid boolean Returns true if the content of the file is valid PDF. This will return false for encrypted PDFs or any non PDF files.
DocumentFile isPdfValid boolean Returns true if the content of the file is valid PDF. This will return false for encrypted PDFs or any non PDF files.
ExcelFile isPdfValid boolean Returns true if the content of the file is valid PDF. This will return false for encrypted PDFs or any non PDF files.
File isPdfValid boolean Returns true if the content of the file is valid PDF. This will return false for encrypted PDFs or any non PDF files.
ImageFile isPdfValid boolean Returns true if the content of the file is valid PDF. This will return false for encrypted PDFs or any non PDF files.
PdfFile isPdfValid boolean Returns true if the content of the file is valid PDF. This will return false for encrypted PDFs or any non PDF files.
VCardFile isPdfValid boolean Returns true if the content of the file is valid PDF. This will return false for encrypted PDFs or any non PDF files.
05-05-2025
Object Method Return Type Description
RuntimePal createTinyCube Cube Creates a cube with the size limit controlled by the cloud. Requires cube enabled in activation key. This is restricted by the cloud settings in terms of max size and max cubes per enterprise.
RuntimePal getTinyCubeLimits Data Returns information on tiny cube limits for this pal and cloud. Cube size in MB.
02-03-2025
Object Method Return Type Description
EncryptionUtil ECDSASign String Signs a message with the given key using ECDSA along the P-256 curve and SHA-256 hash. Result is base64url encoded.
EncryptionUtil createECDHKeyPair Data Returns a Data with two values: privateKey and publicKey generated from the P-256 curve. Content is Base64url encoded
EncryptionUtil encryptPushPayload String Performs encryption on a web push message using the aesgcm spec.
EncryptionUtil toBase64URL String Converts string bytes into Base 64 URL encoded content.
01-27-2025
Object Method Return Type Description
ServiceRequest setBinaryBody Sets the request body given a base64 encoded string. It will decode the string to binary and set the request body. Automatically sets the content type to octet-stream.
12-30-2024
Object Method Return Type Description
Cell setId Sets the cell ID. Max Length: 32. Must start with CB- and be unique. Throws exception if this is not a new cell.
12-26-2024
Object Method Return Type Description
Monitor getAverageTime long Returns the average time between each start and stop of the timer in milliseconds.
Monitor getMaxTime long Returns the maximum time among all of the start and stop of the timer in milliseconds.
Monitor isAverageRemaining boolean Returns true if the time remaining in the workflow engine is greater than the average timer recording.
Monitor isMaxRemaining boolean Returns true if the time remaining in the workflow engine is greater than the maximum timer recording.
Monitor startTimer Starts the timer
Monitor stopTimer long Stops the timer and returns the time in milliseconds. You should call start timer first else this will return 0.
11-13-2024
Object Method Return Type Description
Profile getExitUrl String Returns the best exit URL for this user.
10-31-2024
Object Method Return Type Description
AnalyticDataViewFilter geoDistance Returns the calculated distance between the location given and the geo-coordinates in the dataset rows.
AnalyticDataViewFilter havingAnd Adds an 'and' statement to the having clause
AnalyticDataViewFilter havingBeginGroup Adds begin group to having statement
AnalyticDataViewFilter havingBetween Performs a 'having clause' on the specified derived column
AnalyticDataViewFilter havingEndGroup Adds end group to having statement
AnalyticDataViewFilter havingEqual Performs a 'having clause' on the specified derived column
AnalyticDataViewFilter havingGreaterThan Performs a 'having clause' on the specified derived column
AnalyticDataViewFilter havingLessThan Performs a 'having clause' on the specified derived column
AnalyticDataViewFilter havingOr Adds an 'or' statement to the having clause
10-10-2024
Object Method Return Type Description
CellFilter greaterThanDate CellFilter Filters greater than Date.
CellFilter greaterThanExtra CellFilter Filters greater than extra.
CellFilter greaterThanName CellFilter Filters greater than name.
CellFilter greaterThanOrEqualDate CellFilter Filters greater than or equal to Date.
CellFilter greaterThanOrEqualExtra CellFilter Filters greater than or equal to extra.
CellFilter greaterThanOrEqualName CellFilter Filters greater than or equal to name.
CellFilter greaterThanOrEqualSortOrder CellFilter Filters greater than or equal to sort order.
CellFilter greaterThanOrEqualStatus CellFilter Filters greater than or equal to status.
CellFilter greaterThanSortOrder CellFilter Filters greater than sort order.
CellFilter greaterThanStatus CellFilter Filters greater than status.
CellFilter lessThanDate CellFilter Filters less than Date.
CellFilter lessThanExtra CellFilter Filters less than extra.
CellFilter lessThanName CellFilter Filters less than name.
CellFilter lessThanOrEqualDate CellFilter Filters less than or equal Date.
CellFilter lessThanOrEqualExtra CellFilter Filters less than or equal to extra.
CellFilter lessThanOrEqualName CellFilter Filters less than or equal to name.
CellFilter lessThanOrEqualSortOrder CellFilter Filters less than or equal to sort order.
CellFilter lessThanOrEqualStatus CellFilter Filters less than or equal to status.
CellFilter lessThanSortOrder CellFilter Filters less than sort order.
CellFilter lessThanStatus CellFilter Filters less than status.
CellFilter notDate CellFilter Filters not Date.
CellFilter notDateRange CellFilter Filters by outside of date range.
CellFilter notExtra CellFilter Filters not extra.
CellFilter notId CellFilter Filters for cells without the specified cellId.
CellFilter notName CellFilter Filters not name.
CellFilter notParent CellFilter Filters by not parent cell Id.
CellFilter notProfileId CellFilter Filters by not profileId.
CellFilter notSlice CellFilter Filters by main slice if this filter was created from a secondary slice, otherwise it is ignored.
CellFilter notSortOrder CellFilter Filters not equal to sortOrder.
CellFilter notStatus CellFilter Filters not status.
CellFilter withSortOrder CellFilter Filters with sort order.
08-07-2024
Object Method Return Type Description
StorageProvider getEncryptionType String Returns the encryptionType of this provider.
06-20-2024
Object Method Return Type Description
AnalyticDataViewFilter enableFastPaging DataViewCriteria Sets firstResult based on the page size and page number (if greater than 0) and enables paging (if countLimit greater than 0). This will force inquiry to determine if there are additional rows beyond this page but will not inspect the entire database. See DataViewList.getPagingInfo().
DataViewCriteria enableFastPaging DataViewCriteria Sets firstResult based on the page size and page number (if greater than 0) and enables paging (if countLimit greater than 0). This will force inquiry to determine if there are additional rows beyond this page but will not inspect the entire database. See DataViewList.getPagingInfo().
DataViewFilter enableFastPaging DataViewCriteria Sets firstResult based on the page size and page number (if greater than 0) and enables paging (if countLimit greater than 0). This will force inquiry to determine if there are additional rows beyond this page but will not inspect the entire database. See DataViewList.getPagingInfo().
SystemDataViewFilter enableFastPaging DataViewCriteria Sets firstResult based on the page size and page number (if greater than 0) and enables paging (if countLimit greater than 0). This will force inquiry to determine if there are additional rows beyond this page but will not inspect the entire database. See DataViewList.getPagingInfo().
PagingInfo isFast boolean Returns true if fast paging is enabled.
06-19-2024
Object Method Return Type Description
Packet getJobManager JobManager Returns a JobManager specific to this Packet.
TransactionPacket getJobManager JobManager Returns a JobManager specific to this Packet.
06-17-2024
Object Method Return Type Description
TransactionWebServiceController debug Adds a debug message.
06-04-2024
Object Method Return Type Description
AudioFile setFilename Sets the name of the file to the specified name.
DatasetFile setFilename Sets the name of the file to the specified name.
DocumentFile setFilename Sets the name of the file to the specified name.
ExcelFile setFilename Sets the name of the file to the specified name.
File setFilename Sets the name of the file to the specified name.
ImageFile setFilename Sets the name of the file to the specified name.
PdfFile setFilename Sets the name of the file to the specified name.
VCardFile setFilename Sets the name of the file to the specified name.
05-24-2024
Object Method Return Type Description
PagingInfo getTotalRecordCount Integer Returns the total number of records matching the filter.
03-08-2024
Object Method Return Type Description
Validator isValidVIN boolean Returns true if string is a valid VIN (post 1981).
02-16-2024
Object Method Return Type Description
PdfFile readText DataList Returns a datalist of text contained in this PDF. Returns null if the PDF cannot be read.
01-05-2024
Object Method Return Type Description
SiteBuilder deleteWorkflowPath SiteBuilder Deletes the path from being handled by workflow.
SiteBuilder getWorkflowPaths String[] Shows workflow paths, if any.
SiteBuilder setWorkflowPath SiteBuilder Sets a path to be handled by workflow. The path is relative to the root and can end with a * for a wildcard.
11-15-2023
Object Method Return Type Description
JSONBuffer setBooleans JSONBuffer Adds the item(s) to the array node in this buffer.
JSONBuffer setDates JSONBuffer Adds the item(s) to the array node in this buffer.
JSONBuffer setInts JSONBuffer Adds the item(s) to the array node in this buffer.
JSONBuffer setStrings JSONBuffer Adds the item(s) to the array node in this buffer.
11-04-2023
Object Method Return Type Description
RuntimePal getPluginSocket Socket Returns socket for communication with the specified plugin.
SocketResponse getResponseCode int Returns response code
SocketResponse getResponseHeader String Returns response header value
SocketResponse getResponseHeaders Data Returns response headers
SocketResponse getResponseMessage String Returns response message, if error.
RuntimePal getWebSocket Socket Returns socket for direct communication with a web pal workflow
SocketResponse isError boolean Returns true if request was not submitted successfully, false otherwise
SocketResponse isSuccess boolean Returns true if request was submitted successfully, false otherwise
SocketResponse readBody String Reads the response body.
Socket setAction Socket Action or the event.
Socket setData Socket Sets the data.
Socket setHeaders Socket For a web socket, this sets the given http headers.
Socket setJson Socket Sets json.
Socket setMethod Socket For a web socket, for example, this should be 'get' or 'post'.
Socket setPath Socket For a web socket, this sets the given path, e.g. /thepath.
Socket setWorkflow Socket Workflow to run (web pal only).
Socket submit SocketResponse Submits to the socket endpoint.
Socket toString String Returns a description of this object.
SocketResponse toString String Returns a description of this object.
09-22-2023
Object Method Return Type Description
JSONBuffer preserveType JSONBuffer If true, Data operations will attempt to have type guessed and added accordingly (rather than being a string always).
JSONBuffer setDataList JSONBuffer Adds the datalist to the buffer.
JSONBuffer setPayload JSONBuffer Adds the payload to the buffer.
Data toJson String Returns contents as a JSON string with types preserved.
09-14-2023
Object Method Return Type Description
EncryptionUtil md5Base16 String Calculates MD5 digest for a string and returns it as Base16.
EncryptionUtil md5Base16 String Calculates MD5 digest for a file and returns it as Base16.
EncryptionUtil sha1Base16 String Calculates SHA1 digest for a file and returns it as Base16.
EncryptionUtil sha1Base16 String Calculates SHA1 digest for a string and returns it as Base16.
EncryptionUtil sha256Base16 String Calculates SHA256 digest for a string and returns it as Base16.
08-02-2023
Object Method Return Type Description
SiteBuilder cacheFiles SiteBuilder This will enable web caching for the specified extensions. Note: index.html is never cached. Pass an empty array to remove caching.
SiteBuilder setSecure SiteBuilder If true, this will force a redirect to https if the request is not already https.
07-24-2023
Object Method Return Type Description
SiteBuilder deleteFile SiteBuilder Deletes the specified file. After all changes are made call publish().
SiteBuilder publish SiteBuilder Publishes any changes made.
SiteBuilder putFile SiteBuilder Puts the specified file into the site, over-riding any existing file with the same filename. . After all changes are made call publish().
07-07-2023
Object Method Return Type Description
RuntimePal getSiteBuilder SiteBuilder Returns a site builder for managing a web app associated with this pal. Returns null if this pal does not have a web pal component.
SiteBuilder publishWebApp Updates the content of this site with files contained in the zipFile. Throws exception if the resulting webapp exceeds max pal size. The zip must contain index.html. Other site settings (workflow paths, etc) remain intact. Any existing content files are replaced by this zipFile content.
SiteBuilder removeWebApp Removes the web app, if any, associated with this pal. After calling this method, calling any other method will re-create the web app.
SiteBuilder toString String Returns a description of this object.
07-05-2023
Object Method Return Type Description
AnalyticDataViewFilter addIn DataViewCriteria Adds an 'IN' clause to the query
DataViewCriteria addIn DataViewCriteria Adds an 'IN' clause to the query
DataViewFilter addIn DataViewCriteria Adds an 'IN' clause to the query
SystemDataViewFilter addIn DataViewCriteria Adds an 'IN' clause to the query
AnalyticDataViewFilter addNotIn DataViewCriteria Adds an 'NOT IN' clause to the query
DataViewCriteria addNotIn DataViewCriteria Adds an 'NOT IN' clause to the query
DataViewFilter addNotIn DataViewCriteria Adds an 'NOT IN' clause to the query
SystemDataViewFilter addNotIn DataViewCriteria Adds an 'NOT IN' clause to the query
GroupConcat alias GroupConcat By default result column will be the same name as the target column. This lets you change it.
AnalyticDataViewFilter concat GroupConcat Concatenates the values of the specified column when used with a group by clause. By default, the max length will be 1024 characters. Use the resulting GroupConcat object for additional configuration. The alias in GroupConcat should be unique in the field list. To increase the size of the max length, contact support.
GroupConcat delim GroupConcat By default the delimiter is a comma. This lets you change it.
GroupConcat distinct GroupConcat By default all rows are included. This lets you collapse into distinct rows.
GroupConcat sortDescending GroupConcat By default the sort order is ascending. This lets you change it.
GroupConcat toString String Returns a description of this object.
06-29-2023
Object Method Return Type Description
DataList flatten PacketDataList Reduces a list with duplicate data into a list with unique data with later rows filling in empty values in prior rows that match the multi-value key. An optional countColumn can be created which represents the number of times the composite key was encountered.
DataViewList flatten PacketDataList Reduces a list with duplicate data into a list with unique data with later rows filling in empty values in prior rows that match the multi-value key. An optional countColumn can be created which represents the number of times the composite key was encountered.
PacketDataList flatten PacketDataList Reduces a list with duplicate data into a list with unique data with later rows filling in empty values in prior rows that match the multi-value key. An optional countColumn can be created which represents the number of times the composite key was encountered.
StorageProviderDataList flatten PacketDataList Reduces a list with duplicate data into a list with unique data with later rows filling in empty values in prior rows that match the multi-value key. An optional countColumn can be created which represents the number of times the composite key was encountered.
05-15-2023
Object Method Return Type Description
Pal getLogo ImageFile Returns the logo, if any, associated with this pal.
RuntimePal getLogo ImageFile Returns the logo, if any, associated with this pal.
ShellPal getLogo ImageFile Returns the logo, if any, associated with this pal.
04-11-2023
Object Method Return Type Description
AudioFile getXMLReader XMLReader Returns a ServicePayload for processing XML-based files. Returns null if the file is not XML.
DatasetFile getXMLReader XMLReader Returns a ServicePayload for processing XML-based files. Returns null if the file is not XML.
DocumentFile getXMLReader XMLReader Returns a ServicePayload for processing XML-based files. Returns null if the file is not XML.
ExcelFile getXMLReader XMLReader Returns a ServicePayload for processing XML-based files. Returns null if the file is not XML.
File getXMLReader XMLReader Returns a ServicePayload for processing XML-based files. Returns null if the file is not XML.
ImageFile getXMLReader XMLReader Returns a ServicePayload for processing XML-based files. Returns null if the file is not XML.
PdfFile getXMLReader XMLReader Returns a ServicePayload for processing XML-based files. Returns null if the file is not XML.
VCardFile getXMLReader XMLReader Returns a ServicePayload for processing XML-based files. Returns null if the file is not XML.
03-30-2023
Object Method Return Type Description
Validator isValidSecureUrl boolean Returns true if the url is valid. The URL should start with https.
Validator isValidUrl boolean Returns true if the url is valid. The URL should start with http.
StorageProvider listFolders DataList Returns a list of folders within this container
02-08-2023
Object Method Return Type Description
ServiceResponse getCompression String Returns the compression (gzip or deflate), if any, of the response.
01-10-2023
Object Method Return Type Description
BusinessUtil getCalendar PacketDataList Returns a calendar datalist for the given year.
DateUtil getCalendar PacketDataList Returns a calendar datalist for the given year.
01-05-2023
Object Method Return Type Description
Pal getWizardFragment Fragment Returns specified wizard and optionally a specific dialog. This removes all wizard specific tags and returns just the XHTML.
RuntimePal getWizardFragment Fragment Returns specified wizard and optionally a specific dialog. This removes all wizard specific tags and returns just the XHTML.
ShellPal getWizardFragment Fragment Returns specified wizard and optionally a specific dialog. This removes all wizard specific tags and returns just the XHTML.
12-14-2022
Object Method Return Type Description
EncryptionUtil decryptAES String Decrypts the content using the specified AES key. Content is expected to be Base64 encoded.
EncryptionUtil decryptRSA String Decrypts the content using the specified public key. Content is expected to be Base64 encoded.
EncryptionUtil encryptAES String Encrypts the content using the specified Base64 AES key. Result is Base64 encoded.
EncryptionUtil encryptRSA String Encrypts the content using the specified private key. Result is Base64 encoded.
11-28-2022
Object Method Return Type Description
TransactionWebServiceController getPlugins String[] Returns the names of all plugins registered in this cloud
11-17-2022
Object Method Return Type Description
SafeBox canDelete boolean Returns true if the delete permission is allowed by this pal.
SafeBox canPut boolean Returns true if the put permission is allowed by this pal.
RuntimePal createSafeBox SafeBox Creates a SafeBox.
SafeBox deleteFile Deletes the specified file.
SafeBox getExpires Date Returns the expiration datetime for this SafeBox.
SafeBox getFile File Returns the specified file.
SafeBox getFiles DataList Returns a list of all the files in this SafeBox.
SafeBox getFirstFile File Returns the first in this SafeBox.
SafeBox getId String Returns the unique ID of this SafeBox.
SafeBox getLastFile File Returns the last in this SafeBox.
RuntimePal getSafeBox SafeBox Returns the SafeBox.
TunnelResult getSafeBox SafeBox Returns the SafeBox associated with this request, if any.
SafeBox putFile Stores the file
Tunnel setSafeBox Tunnel Sets the SafeBox for the remote end of the tunnel to use.
SafeBox toString String Returns a description of this object.
10-26-2022
Object Method Return Type Description
StorageProvider uploadPublic Data Uploads file into cloud storage and gives it public access. Currently works with AWS-S3 and provides a public-read ACL to the object. You should only use this method for files intended to be accessible over the public Internet.
10-13-2022
Object Method Return Type Description
Inspector getSubjects Payload Detects words and lines in the target file.
Inspector ocrAnalyze Payload Detects words and lines in the target file.
Inspector ocrAnalyzeJob String Detects words and lines in the target file.
Inspector ocrExpense Payload Detects words and lines in the target file.
Inspector ocrExpenseJob String Detects words and lines in the target file.
Inspector ocrID Payload Detects words and lines in the target file.
Inspector toString String Returns a description of this object.
10-12-2022
Object Method Return Type Description
StorageProvider getInspector Inspector Returns an Inspector for analyzing the stored object identified by fileKey. Currently works only on AWS S3.
09-12-2022
Object Method Return Type Description
Buffer clearMarkers Clears the markers (start and end).
08-09-2022
Object Method Return Type Description
AnalyticDataViewFilter addFilter The method will take all the query parameters and paging information from argument and add it to this filter. It throws exception on columns that don't exist in the underlying storage.
DataViewFilter addFilter The method will take all the query parameters and paging information from argument and add it to this filter. It throws exception on columns that don't exist in the underlying storage.
SystemDataViewFilter addFilter The method will take all the query parameters and paging information from argument and add it to this filter. It throws exception on columns that don't exist in the underlying storage.
06-22-2022
Object Method Return Type Description
JSONBuffer setData JSONBuffer Adds the Data to this buffer.
JSONBuffer setData JSONBuffer Adds the Data to this buffer with the given key.
06-15-2022
Object Method Return Type Description
Data removeNonAsciiChars Data Returns a new Data object having removed characters outside of the UTF-8 C1 Controls and Latin1 Supplement (keeps those in the range of 0-255 decimal).
TransactionWebServiceController setClean Sets all dataset operations to clean/not clean. See Dataset.setClean(boolean)
DataSet setClean This will attempt to clean all data that could cause an insert or update failure. This may include truncating length, lowering precision on decimal fields, and removing non ASCII characters.
05-28-2022
Object Method Return Type Description
Data getLong Long Returns the given value of the given key as Java Long which is larger. Throws exception if the value does not exist or cannot be cast to the correct type.
DataRecord getLong Long Returns the given value of the given key as Java Long which is larger. Throws exception if the value does not exist or cannot be cast to the correct type.
DataSetRecord getLong Long Returns the given value of the given key as Java Long which is larger. Throws exception if the value does not exist or cannot be cast to the correct type.
DataViewRecord getLong Long Returns the given value of the given key as Java Long which is larger. Throws exception if the value does not exist or cannot be cast to the correct type.
DownloadResponse getLong Long Returns the given value of the given key as Java Long which is larger. Throws exception if the value does not exist or cannot be cast to the correct type.
Email getLong Long Returns the given value of the given key as Java Long which is larger. Throws exception if the value does not exist or cannot be cast to the correct type.
Fragment getLong Long Returns the given value of the given key as Java Long which is larger. Throws exception if the value does not exist or cannot be cast to the correct type.
PacketDataRecord getLong Long Returns the given value of the given key as Java Long which is larger. Throws exception if the value does not exist or cannot be cast to the correct type.
Payload getLong Long Returns the given value of the given key as Java Long which is larger. Throws exception if the value does not exist or cannot be cast to the correct type.
Render getLong Long Returns the given value of the given key as Java Long which is larger. Throws exception if the value does not exist or cannot be cast to the correct type.
TextEmail getLong Long Returns the given value of the given key as Java Long which is larger. Throws exception if the value does not exist or cannot be cast to the correct type.
05-09-2022
Object Method Return Type Description
JSONBuffer setRecord JSONBuffer Adds the DataViewRecord to this buffer, preserving field types.
JSONBuffer setRecord JSONBuffer Adds the DataViewRecord to this buffer with the given key, preserving field types.
DataSetRecord toJson String Returns the values of this record as a JSON encoded string.
DataViewRecord toJson String Returns the values of this record as a JSON encoded string.
05-02-2022
Object Method Return Type Description
SSOToken getProfileId String Returns the profileId associated with this token.
04-29-2022
Object Method Return Type Description
TransactionWebServiceController createJsonBuffer JSONBuffer Returns a new JSON Buffer
JSONBuffer endArray JSONBuffer Ends an array node.
JSONBuffer endObject JSONBuffer Ends an object node.
JSONBuffer key JSONBuffer Starts an object node with the given name.
JSONBuffer set JSONBuffer Adds the key/value pair to the buffer.
JSONBuffer setBoolean JSONBuffer Adds the key/value pair to the buffer.
JSONBuffer setDate JSONBuffer Adds the key/value pair to the buffer.
JSONBuffer setDouble JSONBuffer Adds the key/value pair to the buffer.
JSONBuffer setInt JSONBuffer Adds the key/value pair to the buffer.
JSONBuffer setLong JSONBuffer Adds the key/value pair to the buffer.
JSONBuffer setString JSONBuffer Adds the key/value pair to the buffer.
JSONBuffer startArray JSONBuffer Starts an array node.
JSONBuffer startObject JSONBuffer Starts an object node.
JSONBuffer toString String Returns the final JSON object as a string.
JSONBuffer value JSONBuffer Adds a JSON encoded string to this buffer.
03-14-2022
Object Method Return Type Description
TransactionWebServiceController getTimeZone String Returns the timezone for this thread.
03-11-2022
Object Method Return Type Description
Enterprise isTimeZoneEnabled boolean Returns true if time zone code of the enterprise is API enabled.
EnterpriseInfo isTimeZoneEnabled boolean Returns true if time zone code of the enterprise is API enabled.
02-28-2022
Object Method Return Type Description
EncryptionUtil decodeMessage MailResponse Decodes a raw email message.
02-24-2022
Object Method Return Type Description
SSOToken getId String Returns the ID of this token
02-21-2022
Object Method Return Type Description
Profile isFloatingLicense boolean Returns true if the licenseType for this profile is floating.
ProfileInfo isFloatingLicense boolean Returns true if the licenseType for this profile is floating.
Profile isSupportLicense boolean Returns true if the licenseType for this profile is support.
ProfileInfo isSupportLicense boolean Returns true if the licenseType for this profile is support.
Profile isUserLicense boolean Returns true if the licenseType for this profile is user.
ProfileInfo isUserLicense boolean Returns true if the licenseType for this profile is user.
02-10-2022
Object Method Return Type Description
RuntimePal createEmail Email Creates an Email container using the specified template found in this pal.
02-05-2022
Object Method Return Type Description
Buffer endMarker int Finds the first location of the matching string, starting from startMarker and returns the end location or -1 if not found. You must call startMarker before calling this method.
Buffer getMarker String Returns the content found between startMarker and endMarker, inclusive.
Buffer replaceMarker Replaces the content found between startMarker and endMarker, inclusive.
Buffer startMarker int Finds the first location of the matching string relative to the last marker and returns the location or -1 if not found. Resets the end mark.
01-31-2022
Object Method Return Type Description
RuntimePal createRemoteReturnUrl String Provides a URL that can be used with the c:remote tag. The parameters action or jsHandler are required. If both are used, the jsHandler client-side function should return true or false. True will submit the action. False will not and the jsHandler function must handle navigation. If the action parameter is the only supplied parameter, the page will be submitted to workflow with the action and all data provided by the remote service. If staticPage is used, the parameters are Base64 encoded and the URL can be used indefinitely, otherwise the URL is encrypted and has a life span of 30 minutes.
01-17-2022
Object Method Return Type Description
ExcelFile addWorksheet Creates a worksheet with name and with content provided by list.
ExcelFile deleteWorksheet Deletes the worksheet matching name.
AudioFile toExcelFile ExcelFile Returns ExcelFile created from this File. Method returns null if current file cannot be represented as an excel file.
DatasetFile toExcelFile ExcelFile Returns ExcelFile created from this File. Method returns null if current file cannot be represented as an excel file.
DocumentFile toExcelFile ExcelFile Returns ExcelFile created from this File. Method returns null if current file cannot be represented as an excel file.
ExcelFile toExcelFile ExcelFile Returns ExcelFile created from this File. Method returns null if current file cannot be represented as an excel file.
File toExcelFile ExcelFile Returns ExcelFile created from this File. Method returns null if current file cannot be represented as an excel file.
ImageFile toExcelFile ExcelFile Returns ExcelFile created from this File. Method returns null if current file cannot be represented as an excel file.
PdfFile toExcelFile ExcelFile Returns ExcelFile created from this File. Method returns null if current file cannot be represented as an excel file.
VCardFile toExcelFile ExcelFile Returns ExcelFile created from this File. Method returns null if current file cannot be represented as an excel file.
ExcelFile toString String Returns a description of this object.
12-09-2021
Object Method Return Type Description
PWA addDevice Adds the active device to the PWA
PWA hasDevice boolean Returns true if this device is registered with the PWA
PWA removeDevice Removes the active device from the PWA
12-02-2021
Object Method Return Type Description
DateUtil getDayOrdinal int Returns the Nth day of this date. If it is the 1st Thursday, this will return 1. If it is the 3rd Friday, this will return 3.
DateUtil getWeekOfMonth int Returns the week of the month for the given date.
DateUtil getWeekOfYear int Returns the week of the year for the given date.
DateUtil nextMonth Date Adds a month to the date and returns the date with the same day of week and week of month. Returns null if the operation is not possible.
11-29-2021
Object Method Return Type Description
RuntimePal getMailBox MailBox Returns the active MailBox associated the target storage provider.
10-14-2021
Object Method Return Type Description
PWA createManifest Creates the manifest the payload provided.
PWA getAction String Returns the default action.
PWA getExpiredUrl String Returns the url for session expiration.
PWA getManifestLink String Returns the manifest URL. This returns a unique manifest URL that should be used in the manifest link tag.
PWA getScope String Returns the scope of this PWA
PWA getWorkflow String Returns the console workflow.
PWA isEnabled boolean Returns true if enabled.
PWA setAction Sets the default action.
PWA setEnabled Sets whether this is enabled. If not enabled, the user cannot access this pal from the installation without logging in.
PWA setExpiredUrl Sets the url to use when a session is expired.
PWA setWorkflow Sets the console workflow to use.
PWA toString String Returns a description of this object.
10-13-2021
Object Method Return Type Description
Profile createPWA PWA Creates a progressive web app and associates it with this user and pal. Returns null if key, enterprise, or profile does not enable PWA. Note- this will immediately send an email to the user notifying of the creation of the PWA.
Profile deletePWA Deletes the PWA associated with this profile and pal, if any.
Profile getPWA PWA Returns the progressive web app, if any, associated with this user and pal.
10-07-2021
Object Method Return Type Description
Formatter formatDate String Formats the given date using the given java date pattern (see java.text.SimpleDateFormat for sample patterns) and the given time zone code (e.g. PST).
Formatter formatDateString String Formats the given date string using the given java date pattern (see java.text.SimpleDateFormat for sample patterns) and the given time zone code (e.g. PST).
BusinessUtil getAllTimezones DataList Returns a list of all timezones.
TransactionWebServiceController getTime double Returns the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC for the given server.
TransactionWebServiceController setDateFormat Sets the date pattern for displaying dates for this thread.
TransactionWebServiceController setTimeZone Sets the timezone for dates created or displayed in this thread.
09-30-2021
Object Method Return Type Description
BusinessUtil getCountryList DataList Returns a list of country names including code, name, iso code, and calling code.
08-18-2021
Object Method Return Type Description
RuntimePal deleteMountPoint Deletes the specified mount point.
RuntimePal setMountPoint Sets a web mount point for this pal. The update may take up to 2 minutes to flush to all locations. Backup, if present is used if the specified workflow is not found in the pal. Such would be the case, for example, in a module pal which may or may not be attached to the runtime pal.
08-05-2021
Object Method Return Type Description
Formatter chopLeft String If the value exceeds the given size, this method chops and returns the right-most characters, optionally with ellipses (...).
07-27-2021
Object Method Return Type Description
TransactionWebServiceController debugs 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.
07-09-2021
Object Method Return Type Description
RuntimePal getSSOTokens SystemDataView Returns sso tokens associated with this pal.
07-05-2021
Object Method Return Type Description
TransactionWebServiceController getWorker String Returns the worker (application server) running this workflow. Useful in a multi-worker environment for analyzing performance and for troubleshooting.
06-29-2021
Object Method Return Type Description
DownloadResponse removeDataList Removes the datalist from the payload
Email removeDataList Removes the datalist from the payload
Fragment removeDataList Removes the datalist from the payload
Payload removeDataList Removes the datalist from the payload
Render removeDataList Removes the datalist from the payload
TextEmail removeDataList Removes the datalist from the payload
06-16-2021
Object Method Return Type Description
ServiceRequest getFormParameters Data Returns a read-only copy of the form parameters for this request.
ServiceResponse getResponseTime long Returns the response time in milliseconds it took for this request.
ServiceResponse getUrl String Returns the URL of this connection if available.
06-03-2021
Object Method Return Type Description
EncryptionUtil verifySha256RsaSignature boolean Verifies the base64 encoded signature against the x509 public certificate and non encoded canonical message
06-01-2021
Object Method Return Type Description
PacketDataList addColumns Adds the new columns to this list and sets the default value.
PacketDataList addColumns Adds the new columns to this list.
PacketDataList deleteColumns Deletes the specified columns from this list.
DataList split PacketDataList Returns a new datalist containing only those columns specified.
DataViewList split PacketDataList Returns a new datalist containing only those columns specified.
PacketDataList split PacketDataList Returns a new datalist containing only those columns specified.
StorageProviderDataList split PacketDataList Returns a new datalist containing only those columns specified.
05-28-2021
Object Method Return Type Description
DataListFilter addIsEmpty Return records where column value is empty.
DataListFilter addIsNotEmpty Return records where column value is not empty.
05-11-2021
Object Method Return Type Description
AudioFile readDataLists Payload Creates a Payload of PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. Throws exception if invalid or unsupported file format.
DatasetFile readDataLists Payload Creates a Payload of PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. Throws exception if invalid or unsupported file format.
DocumentFile readDataLists Payload Creates a Payload of PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. Throws exception if invalid or unsupported file format.
ExcelFile readDataLists Payload Creates a Payload of PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. Throws exception if invalid or unsupported file format.
File readDataLists Payload Creates a Payload of PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. Throws exception if invalid or unsupported file format.
ImageFile readDataLists Payload Creates a Payload of PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. Throws exception if invalid or unsupported file format.
PdfFile readDataLists Payload Creates a Payload of PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. Throws exception if invalid or unsupported file format.
VCardFile readDataLists Payload Creates a Payload of PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. Throws exception if invalid or unsupported file format.
04-22-2021
Object Method Return Type Description
MailResponse compress Reduces any attached images to the maximum width given.
MailResponse deleteAttachments Deletes attachments if any, alternately keeping image-based attachments if keepImages=true.
MailResponse getSize int Returns the approximate size of this message in KB.
MailResponse toPayload Payload Returns the message as a Payload.
04-15-2021
Object Method Return Type Description
TransactionWebServiceController debugPayload Debugs the payload. See comments on debugList and debugData
04-08-2021
Object Method Return Type Description
Browser getHost String Returns the public host name for this session.
03-17-2021
Object Method Return Type Description
Data toJson String Returns contents as a JSON string.
03-10-2021
Object Method Return Type Description
Formatter removeNonAsciiChars String Removes all characters outside of the UTF-8 C1 Controls and Latin1 Supplement (keeps characters in the range 0-255 decimal).
03-05-2021
Object Method Return Type Description
Buffer removeNonAsciiChars Buffer Removes all characters outside of the UTF-8 C1 Controls and Latin1 Supplement (keeps characters in the range 0-255 decimal).
ServiceResponse setEncoding Sets the encoding to be used for reading the payload
XMLReader setEncoding Sets the encoding to be used for reading the payload
02-24-2021
Object Method Return Type Description
Formatter getContinent String Returns the full name of the continent from the iso code.
Formatter getCountry String Returns the full name of the country from the iso code.
Formatter getState String Returns the full name of the state from the state and country iso code.
Formatter getState String Returns the full name of the state from the US iso code.
02-20-2021
Object Method Return Type Description
Email setFrom boolean Sets the 'From' information for the email, over-writing the default provided by the system. This functionality requires the email SMTP server to be configued for support and the email setting being used must allow alias sending. Pass null to remove these settings.
01-11-2021
Object Method Return Type Description
RuntimePal createAuthToken SSOToken Registers the user account with the cloud. Returns null if the email or token is already registered. Requires cloud level configuration and partner settings. For optimal security, the email address should be validated using other means before calling this method. No validation is done on the validity of the email other than checking for uniqueness.
SSOToken deleteAuthToken boolean Deletes the SSOToken identified and associated with this pal. If deleteAccount is true and the user is the active user, you should immediately log the user out.
RuntimePal findAuthToken SSOToken Returns the SSOToken identified by guid and associated with this pal
Profile getAuthToken SSOToken Returns the sso token, if any, associated with this user and pal.
RuntimePal getAuthToken SSOToken Returns the SSOToken identified by ssoToken and associated with this pal
SSOToken getEmail String Returns the email address associated with this token.
SSOToken getFirstName String Returns the first name of the profile associated with this token.
SSOToken getLastName String Returns the last name of the profile associated with this token.
SSOToken getLogoutUrl String Returns the logout URL.
SSOToken getProvider String Returns the provider name.
SSOToken isEnabled boolean Returns true if the token is enabled.
SSOToken isExclusive boolean Returns true if exclusive is enabled.
SSOToken isRedirect boolean Returns true if redirect is enabled.
SSOToken rejectExclusive Disconnects exclusive from this token which gives the user 'normal' access to this cloud.
SSOToken setEmail boolean Sets the email of the profile associated with this token. Returns false if the email is not unique or otherwise invalid. See c.getError() on failure.
SSOToken setFirstName Sets the first name of the profile associated with this token.
SSOToken setLastName Sets the last name of the profile associated with this token.
SSOToken setLogoutUrl Sets logout URL. Must start with https.
SSOToken setProvider Sets provider associated with this token.
SSOToken setRedirect Sets whether redirect should occur on the login screen rather than error notice. This requires setLogoutUrl to be set.
SSOToken toString String Returns a description of this object.
01-07-2021
Object Method Return Type Description
StorageProvider getCDNEndpoint String Returns CDN endpoint, if any.
RuntimePal getStorageProvider StorageProvider Returns the default storage provider, if any, connected to this pal.
01-02-2021
Object Method Return Type Description
Enterprise isSoftArchiveEnabled boolean Returns true if the enterprise is enabled and configured for soft archive.
12-21-2020
Object Method Return Type Description
Chunk setStatic Sets the static content of the chunk. Only allowed in the web workflow engine unless enabled at the cloud level.
12-18-2020
Object Method Return Type Description
Pal hasWorkflow boolean Returns true if the specified workflow exists.
RuntimePal hasWorkflow boolean Returns true if the specified workflow exists.
ShellPal hasWorkflow boolean Returns true if the specified workflow exists.
12-02-2020
Object Method Return Type Description
FtpRequest useLegacy Indicates whether or not to use legacy libraries for connectivity.
11-26-2020
Object Method Return Type Description
StorageProvider getAuthData Data Returns information that can be used in a web pal for posting a file directly to a bucket. Currently works only with AWS S3.
RuntimePal getStorageProvider StorageProvider Returns the storage provider identified by name.
11-24-2020
Object Method Return Type Description
DataSet transfer boolean Transfers all records in this dataset to the target dataset. The two datasets must have the same structure and the target dataset should typically be empty to avoid key violations. Not supported for datasets with files.
DataSet truncate boolean Deletes all records in this dataset. Before calling this method you must manually delete any rows that contain remote files.
10-19-2020
Object Method Return Type Description
Logger debug int Logs the given message at 'debug' level. Returns the remaining log events for this thread.
Logger error int Logs the given message at 'error' level. Returns the remaining log events for this thread.
Logger error int Logs the given message at 'error' level with the specified message added. Returns the remaining log events for this thread.
TransactionWebServiceController getLogger Logger Returns the Logger for this workflow engine.
Logger info int Logs the given message at 'info' level. Returns the remaining log events for this thread.
Logger isDebugEnabled boolean Returns true if this logger is enabled for debug.
Logger isErrorEnabled boolean Returns true if this logger is enabled for error.
Logger isInfoEnabled boolean Returns true if this logger is enabled for info.
Logger isWarnEnabled boolean Returns true if this logger is enabled for warn.
Logger toString String Returns a description of this object
Logger warn int Logs the given message at 'warn' level with the specified message added. Returns the remaining log events for this thread.
Logger warn int Logs the given message at 'warn' level. Returns the remaining log events for this thread.
09-30-2020
Object Method Return Type Description
RuntimePal deletePalTunnel Deletes the inbound pal tunnel exists with the given name.
RuntimePal hasPalTunnel boolean Returns true if an inbound pal tunnel exists with the given name.
09-28-2020
Object Method Return Type Description
StoredObject getUnknownFile UnknownFile Returns the specified file as unknown file.
09-16-2020
Object Method Return Type Description
DataList toJsonArray String Returns contents as a JSON Array string. An optional key map should have field name types defined as string, int, long, double, boolean, or date. This method is limited by the max export size of the activation key.
DataViewList toJsonArray String Returns contents as a JSON Array string. An optional key map should have field name types defined as string, int, long, double, boolean, or date. This method is limited by the max export size of the activation key.
PacketDataList toJsonArray String Returns contents as a JSON Array string. An optional key map should have field name types defined as string, int, long, double, boolean, or date. This method is limited by the max export size of the activation key.
StorageProviderDataList toJsonArray String Returns contents as a JSON Array string. An optional key map should have field name types defined as string, int, long, double, boolean, or date. This method is limited by the max export size of the activation key.
08-28-2020
Object Method Return Type Description
RuntimePal connectTunnel Tunnel Connects a runtime tunnel (memory only) that is not saved to the database.
RuntimePal createPalTunnel String Creates a tunnel for this pal and returns the key. Throws exception if the name already exists.
08-20-2020
Object Method Return Type Description
RuntimePal getEnterpriseId String Returns the ID of enterprise that owns this pal. Storage of this ID should be large enough to handle 70 characters.
08-12-2020
Object Method Return Type Description
Enterprise getId String Returns the ID of this enterprise. Storage of this ID should be large enough to handle 70 characters.
EnterpriseInfo getId String Returns the ID of this enterprise. Storage of this ID should be large enough to handle 70 characters.
07-07-2020
Object Method Return Type Description
SmartDoc setCategory Sets the category of this smart doc.
SmartDoc setDescription Sets the description of this smart doc.
SmartDoc setName Sets the name of this smart doc.
07-02-2020
Object Method Return Type Description
TunnelResult get String Returns the specified value from of the payload result of the request, if any. This may return null if the remote workflow did not set a payload.
TunnelResult getData Data Returns the data of the payload result of the request, if any. This may return null if the remote workflow did not set a payload.
TunnelResult getData Data Returns the specified data of the payload result of the request, if any. This may return null if the remote workflow did not set a payload.
TunnelResult getDataList DataList Returns the specified datalist of the payload result of the request, if any. This may return null if the remote workflow did not set a payload.
Tunnel submitToken TunnelResult Submits a request to the tunnel's target and creates a response token if one doesn't already exist. This will also set the local workflow to run when there is a response and over-ride any already set (this is set permanently, not per request).
06-27-2020
Object Method Return Type Description
Formatter formatPhone1 String Formats a phone to a dashed digit phone number. (ex: converts (123) 456-7890 to 123-456-7890).
Formatter formatPhone2 String Formats a phone to a 10 digit phone number. (ex: converts (123) 456-7890 to 1234567890).
06-23-2020
Object Method Return Type Description
PdfFile copyCompatible PdfFile Creates a new PdfFile with version 1.5 or greater, making it compatible for usage as a Document.
06-20-2020
Object Method Return Type Description
DataReader getColumns String[] Returns the column names obtained from the first line in the file.
06-19-2020
Object Method Return Type Description
MailBoxList findMessage MailResponse Retrieves the specified message from the mail box.
MailResponse getMetaData Data Returns information about this MailResponse to assist in processing it.
06-03-2020
Object Method Return Type Description
AudioFile readDataList PacketDataList Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. If xls, it will also attempt to find a matching tab by name and if that fails, it will return the first tab. Throws exception if invalid or unsupported file format.
DatasetFile readDataList PacketDataList Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. If xls, it will also attempt to find a matching tab by name and if that fails, it will return the first tab. Throws exception if invalid or unsupported file format.
DocumentFile readDataList PacketDataList Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. If xls, it will also attempt to find a matching tab by name and if that fails, it will return the first tab. Throws exception if invalid or unsupported file format.
ExcelFile readDataList PacketDataList Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. If xls, it will also attempt to find a matching tab by name and if that fails, it will return the first tab. Throws exception if invalid or unsupported file format.
File readDataList PacketDataList Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. If xls, it will also attempt to find a matching tab by name and if that fails, it will return the first tab. Throws exception if invalid or unsupported file format.
ImageFile readDataList PacketDataList Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. If xls, it will also attempt to find a matching tab by name and if that fails, it will return the first tab. Throws exception if invalid or unsupported file format.
PdfFile readDataList PacketDataList Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. If xls, it will also attempt to find a matching tab by name and if that fails, it will return the first tab. Throws exception if invalid or unsupported file format.
VCardFile readDataList PacketDataList Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. If xls, it will also attempt to find a matching tab by name and if that fails, it will return the first tab. Throws exception if invalid or unsupported file format.
05-12-2020
Object Method Return Type Description
Cube getSlices PacketDataList Returns the slices for this cube.
04-21-2020
Object Method Return Type Description
TransactionWebServiceController createBrowser Browser Creates a Browser object from the user agent. Some Browser methods may not work when the Browser instance is created this way.
04-20-2020
Object Method Return Type Description
Cube setSystemStorageProvider boolean If the enterprise has a system provider assigned, this will set the storage provider to the system. If the cube already has a storage provider assigned, this is ignored unless override is set to true. Returns false if there are existing remote files attached to an existing provider for this cube. Requires an edit lock.
04-15-2020
Object Method Return Type Description
Validator createCheck ValidityCheck Returns an empty ValidityCheck
DataSetResult setError Sets the main error
ValidityCheck setError Sets the main error
DataSetResult setErrors Sets errors if any
ValidityCheck setErrors Sets errors if any
DataSetResult setValid Sets valid
ValidityCheck setValid Sets valid
04-13-2020
Object Method Return Type Description
RuntimePal getMountPoints DataList Returns the web mount points for this pal. This will not be null but will be empty if there are no mount points set.
RuntimePal setMountPoints Sets web mount points for this pal. The update may take up to 2 minutes to flush to all locations. The datalist should have three columns: mount, workflow, and backup. Backup, if present is used if the specified workflow is not found in the pal. Such would be the case, for example, in a module pal which may or may not be attached to the runtime pal. The list must have at least 2 rows. The first should have a mount point of / and the last should have a mount point of *.
04-02-2020
Object Method Return Type Description
RuntimePal deleteTunnel Deletes the specified tunnel.
RuntimePal isOwnedBy boolean Returns true if the Enterprise owns this pal.
02-20-2020
Object Method Return Type Description
DataSetRecord getCdnUrl String Returns the full CDN url, if any, for the remote file.
DataViewRecord getCdnUrl String Returns the full CDN url, if any, for the remote file.
02-07-2020
Object Method Return Type Description
EncryptionUtil createOtpPassCode int Creates an OTP pass code.
01-27-2020
Object Method Return Type Description
Pal getHeadFragment Fragment Returns specified head fragment. See Chunk API.
RuntimePal getHeadFragment Fragment Returns specified head fragment. See Chunk API.
ShellPal getHeadFragment Fragment Returns specified head fragment. See Chunk API.
01-14-2020
Object Method Return Type Description
StorageProvider getAuthUrl String Returns an authenticated URL and querystring for the specified file. This works only with storage type of AWS S3. It allows access to an object via a URL for the specified amount of time.
StorageProvider getBucket String Returns the bucket or container name of this provider.
StorageProvider getRegion String Returns region of this provider if applicable.
01-08-2020
Object Method Return Type Description
ServiceRequest setAWSProvider Configures this request for AWS authentication using credentials and region from the specified storage provider. Works only for AWS S3 provider settings.
12-05-2019
Object Method Return Type Description
BillingEngine getEventByType BillingEvent Returns the most recent event by type.
11-20-2019
Object Method Return Type Description
DataReader closeReader Closes the reader and releases resources.
AudioFile getReader DataReader Opens a data reader for this file. File type should be list compatible.
DatasetFile getReader DataReader Opens a data reader for this file. File type should be list compatible.
DocumentFile getReader DataReader Opens a data reader for this file. File type should be list compatible.
ExcelFile getReader DataReader Opens a data reader for this file. File type should be list compatible.
File getReader DataReader Opens a data reader for this file. File type should be list compatible.
ImageFile getReader DataReader Opens a data reader for this file. File type should be list compatible.
PdfFile getReader DataReader Opens a data reader for this file. File type should be list compatible.
VCardFile getReader DataReader Opens a data reader for this file. File type should be list compatible.
DataReader moveTo Advances the reader to the specified record. This can be called only forward. Line 0 is the field names. Data records start at line 1.
DataReader readData Data Reads the next line of data. Returns null if there are no more rows to read.
DataReader toString String Returns a description of this object.
11-05-2019
Object Method Return Type Description
EncryptionUtil authorizeOtp boolean Returns true on successful OTP authentication.
EncryptionUtil createOtpAuth Data Returns information that can be used for an OTP Auth service. See QRUtil to create an image from the url.
10-30-2019
Object Method Return Type Description
DataList pivot PacketDataList Returns a new list with the key, the same name with columns specified by the pivot values, and the key+'Total' on the specified operation. The amt column must be numeric and maximum columns is 100.
DataViewList pivot PacketDataList Returns a new list with the key, the same name with columns specified by the pivot values, and the key+'Total' on the specified operation. The amt column must be numeric and maximum columns is 100.
PacketDataList pivot PacketDataList Returns a new list with the key, the same name with columns specified by the pivot values, and the key+'Total' on the specified operation. The amt column must be numeric and maximum columns is 100.
StorageProviderDataList pivot PacketDataList Returns a new list with the key, the same name with columns specified by the pivot values, and the key+'Total' on the specified operation. The amt column must be numeric and maximum columns is 100.
10-23-2019
Object Method Return Type Description
Tunnel setWorkflow Tunnel Sets the target's tunnel workflow, if known.
10-22-2019
Object Method Return Type Description
AnalyticDataViewFilter countDistinct calculates the distinct count of the specified column using the specified resultAlias
10-03-2019
Object Method Return Type Description
CellFilter withId CellFilter Filters for cells with the specified cellId.
09-20-2019
Object Method Return Type Description
Slice findCell Cell Returns the first cell matching the specified filter.
Cell get String Returns the specified value from the cell's properties or metadata.
Cell set Cell Sets or removes the metadata key/value of the cell. Total serialized metadata cannot exceed 255. See Data.toJSON().
09-12-2019
Object Method Return Type Description
Cell deleteSlice Cell Deletes the secondary slice with the given name and value.
Cell getSliceList PacketDataList Returns all of the secondary slices of this cell, if any.
09-06-2019
Object Method Return Type Description
Cube cascadeDelete Deletes the specified cell and all its descendants. The cell is deleted immediately. All descendants are deleted in a background thread that may take hours, days, or weeks.
Cube deleteCells Deletes the specified cells and its slices and data if any.
Slice getCells PacketDataList Returns a list of cells within this slice.
Cell removeParent Cell Removes the parent from this cell. Call save() to persist.
08-29-2019
Object Method Return Type Description
Slice getCellCount long Returns the number of cells in this slice based on the specified filter.
08-27-2019
Object Method Return Type Description
GeoUtil calcDistances double Adds a new column to the datalist called 'distance' and calculates the distance between the first row and the remaining rows.
GeoUtil calcDistances double Adds a new column to the datalist called 'distance' and calculates the distance between the initial provided coordinates and the row and returns the maximum distance.
GeoUtil getCenter Data Returns a Data object containing latitude and longitude geo-coordinate of the approximate center of the list.
GeoUtil getDistance double Returns the distance between the two coordinates.
GeoUtil getEast Data Returns a Data object containing latitude and longitude of the Eastern most point of the list starting at the specified longitude.
TransactionWebServiceController getGeoUtil GeoUtil Returns a utility for working with geo-coordinates. Use km for kilometers and m for miles.
GeoUtil getLatitudeDistance double Returns the distance between the Northern-most and Southern-most points of the list
GeoUtil getLongitudeDistance double Returns the distance between the Eastern-most and Western-most points of the list
GeoUtil getNorth Data Returns a Data object containing latitude and longitude of the Northern most point of the list starting at the specified latitude.
GeoUtil getSouth Data Returns a Data object containing latitude and longitude of the Southern most point of the list starting at the specified latitude.
GeoUtil getWest Data Returns a Data object containing latitude and longitude of the Western most point of the list starting at the specified longitude.
GeoUtil inject PacketDataList Injects the data into the new list based on relative distance to other points on the list. Data must have latitude,longitude coordinates.
GeoUtil isCoordinateInsidePath boolean Returns true if the specified coordinate is within the are of the specified path.
GeoUtil sort PacketDataList Sorts the list by distance relative to each other and starting with the first row. Returns the new sorted list with two new columns- distance and sort.
GeoUtil toMercator Adds a Mercator projection of the list as x,y coordinates. The anticipated target is an image of given height and width.
GeoUtil toString String Returns a description of this object.
08-23-2019
Object Method Return Type Description
CellFilter likeExtra CellFilter Filters like extra. Default search is %extra%.
CellFilter likeName CellFilter Filters like name. Default search is %name%.
CellFilter likeStatus CellFilter Filters like status. Default search is %status%.
CellFilter setQueryTimeout Sets the timeout for the query. By default this is 10 seconds and the maximum is defined by the cloud configuration.
08-20-2019
Object Method Return Type Description
CellFilter ascendId CellFilter Sorts the result ascending by id
CellFilter descendId CellFilter Sorts the result descending by id
08-19-2019
Object Method Return Type Description
CellFilter withParent CellFilter Filters by parent cell Id.
08-13-2019
Object Method Return Type Description
Cube cancelDrop boolean Cancels deletion of the cube. Requires edit lock.
Cube drop boolean Deletes this cube and all of its data on the specified date/time. Cell deletion is performed by a background thread and may not happen at the exact date/time specified or all at once. Once flagged for delete, cubes are locked for inserts and updates. Requires an edit lock. If the date is now or in the past, this cube will be immediately removed from the pal and no longer accessible.
Cube editLock boolean Returns true if this thread successfully obtains an edit lock for doing cube modifications.
Cube expand boolean Returns true if the cube is successfully expanded by the specified size. Requires an edit lock.
Cube getCubeStats Data Returns the approximate statistics of the cube.
Cube getPercentUsed double Returns what percentage of this cube is used. When this reaches 100, the cube will be read-only/locked unless expanded.
Cube isDropped boolean Returns true if the cube has been dropped.
Cube isExpandable boolean Returns true if the cube can be expanded by the specified size
Cube isSizeLocked boolean Returns true if the cube has reached its size limit and is locked. Once size locked, the cube can only be used for read and deletes.
Cube readMode Sets this cube in readMode which allows read and deletes. This releases write locks and flushes stats if this thread had a write lock on the cube.
CellFilter withSlice CellFilter Filters by main slice if this filter was created from a secondary slice, otherwise it is ignored.
Cube writeMode boolean Sets this cube in writeMode which allows inserts and updates. If the cube is dropped, this always returns false. If the cube is locked due to size limitation this will also return false. You can always read and delete, even from a locked or dropped cube.
08-12-2019
Object Method Return Type Description
CellFilter addAnd CellFilter Adds an 'AND' clause to the filter.
CellFilter addOr CellFilter Adds an 'OR' clause to the filter.
CellFilter beginGroup CellFilter Adds a group clause to the filter.
Cell deleteSlices Cell Deletes all of the secondary slices from the cell.
CellFilter endGroup CellFilter Ends a group clause.
Cube getName String Returns the name of this cube.
CellFilter reset CellFilter Removes all criteria from the filter.
08-09-2019
Object Method Return Type Description
Cell getExtra String Returns the extra value.
Cell getModified Date Returns the Date this cell was last modified.
Cell setExtra Cell Sets the extra property of the cell.
CellFilter withExtra CellFilter Filters by extra.
08-07-2019
Object Method Return Type Description
PacketDataList appendList Appends the list and any new columns to this list
DataList flatten PacketDataList Reduces a list with duplicate data into a list with unique data with later rows filling in empty values in prior rows that match the key.
DataViewList flatten PacketDataList Reduces a list with duplicate data into a list with unique data with later rows filling in empty values in prior rows that match the key.
PacketDataList flatten PacketDataList Reduces a list with duplicate data into a list with unique data with later rows filling in empty values in prior rows that match the key.
StorageProviderDataList flatten PacketDataList Reduces a list with duplicate data into a list with unique data with later rows filling in empty values in prior rows that match the key.
Cube isPublicImage boolean Returns true if files in cells can be served as images using the c:image tag
Cube setPublicImage boolean Sets whether or not imaged based files can be served with the c:image tag. Requires an edit lock.
08-05-2019
Object Method Return Type Description
DateUtil isDate boolean Returns true if the two dates have the same day, month, and year
07-25-2019
Object Method Return Type Description
Cell addChild Cell Sets this cell as the parent of the specified cell and returns this cell. This cell must be saved prior to calling this method.
Cell addSlice Cell Adds the secondary slice to the cell. A cell can have a maximum of 1,000 secondary slices.
CellFilter ascendDate CellFilter Sorts the result ascending by date
CellFilter ascendName CellFilter Sorts the result ascending by name
CellFilter ascendSort CellFilter Sorts the result ascending by sortOrder
Cube createCell Cell Creates a cell with no metadata but does not persist it. Call cell.save() to persist.
Cube createCell Cell Creates a cell but does not persist it. Call cell.save() to persist. Serialized metadata size cannot exceed 255 in length. See Data.toJSON().
Slice createFilter CellFilter Returns a new CellFilter.
Cube deleteCell Deletes the specified cell and its slices and data if any.
Cell deleteObject Cell Deletes any associated object (Data, DataList, Payload, File) on save.
Cell deleteSlice Cell Deletes the secondary slice or slices with the given name.
CellFilter descendDate CellFilter Sorts the result descending by date
CellFilter descendName CellFilter Sorts the result descending by name
CellFilter descendSort CellFilter Sorts the result descending by sortOrder
Cell disconnectRemote If the object attached to this cell is stored remotely, this method removes the local pointer but leaves the remote file intact.
Cell encrypt Cell Encrypts any child objects if true.
Data filter Data Returns a new Data object with values from this Data set to keys from the filter. Non matching items are removed if remove is true.
Cell getCdnUrl String Returns the full CDN url, if any, for the remote file. The cell must be saved before calling this method.
Cube getCell Cell Gets the cell with the specified id.
Slice getCellByName Cell Gets the first cell matching the specified name.
Slice getCells PacketDataList Returns a list of cells within this slice.
Cell getChildren PacketDataList Returns the children of this cell, if any.
Cell getData Data Returns the Data if set, null otherwise.
Cell getDataList PacketDataList Returns the DataList if set, null otherwise.
Cell getDataSize long Returns the data size (if any) in bytes.
Cell getDate Date Returns the Date of this cell which by default is the date it was created.
Cell getFile File Returns the File if set, null otherwise
Cell getFileId String Returns the file ID, if any, for the remote file. See c:rfile tag. The cell must be saved before calling this method.
Slice getFirstCell Cell Gets the first cell created by the specified profileId.
Cell getId String Returns the cell ID. Max Length: 32.
Cell getImageId String Returns the file handle, if any, for rendering an in image. See c:image tag. The cell must be saved before calling this method.
Slice getLastCell Cell Gets the last cell created by the specified profileId.
Cell getMeta Data Returns the metadata.
Cell getName String Returns the cell name. Max Length: 60.
Slice getPageCount int Returns the number of pages in this slice based on the specified filter.
Cell getParent Cell Returns the parent of this cell, if any.
Cell getPayload Payload Returns the Payload if set, null otherwise.
Cell getProfileId String Returns the profileId.
Cell getSlice String Returns the slice name. Max Length: 60
Cube getSlice Slice Returns a slice with the specified name from the primary slices.
Cube getSlice Slice Returns a slice with the specified name and value from the secondary slices.
Cell getSlices Data Returns the secondary slices of this cell, if any.
Cell getSortOrder int Returns the sort order.
Cell getStatus String Returns the status. The default status is *.
Cube getStorageProvider String Returns the name of the storage provider associated with this cube, if any.
Cell getType String Returns the type of the data (if any).
PalActivationKeyInfo isCubeEnabled boolean Returns true if DataSet is enabled.
Cell isSaved boolean Returns true if this cell has been saved to persistent storage.
Cell remote Cell If true, specifies child objects should be stored with a remote storage provider, if available.
Cell save Cell Saves the cell and returns it.
Cell setData Cell Associates a data with this cell. The cell must be new, already a data, or type must be reset (see Cell.clearType()).
Cell setDataList Cell Associates a datalist with this cell. The cell must be new, already a datalist, or type must be reset (see Cell.clearType()).
Cell setDate Cell Sets the date of the cell.
Cell setFile Cell Associates a file with this cell. The cell must be new, already a file, or type must be reset (see Cell.clearType()).
Cell setMeta Cell Sets the metadata of the cell. Total serialized metadata cannot exceed 255. See Data.toJSON().
Cell setName Cell Sets the name of the cell.
CellFilter setOffset CellFilter Sets the page offset. Use 0 for the first record.
CellFilter setPageSize CellFilter Sets the page size. Default is 100, minimum is 1 and maximum is 100,000.
Cell setParent Cell Sets the parent of this cell and returns this cell. The parent must be saved prior to calling this method.
Cell setPayload Cell Associates a payload with this cell. The cell must be new, already a payload, or type must be reset (see Cell.clearType()).
Cell setProfileId Cell Sets the profileId of the cell. By default this is 'SYSTEM' or the profileId of the active user, but it can be anything.
Cell setSlice Cell Sets the primary slice of the cell.
Cell setSortOrder Cell Sets the sort order of the cell which by default is 0 and must be 0 or less than 65535.
Cell setStatus Cell Sets the status of the cell.
Cube setStorageProvider boolean Sets the name of the storage provider associated with this cube. Returns false if there is an existing provider. Requires an edit lock.
Cell toData Data Creates a data of this cell with with its properties and meta, if any. Note, if meta has keys that collide with the standard properties, meta will take precedence.
Cell toPayload Payload Creates a payload of this cell with all child objects included except a file.
Cell toString String Returns a description of this object.
CellFilter toString String Returns a description of this object.
Cube toString String Returns a description of this object.
Slice toString String Returns a description of this object.
CellFilter withDate CellFilter Filters by date.
CellFilter withDateRange CellFilter Filters by date range.
CellFilter withName CellFilter Filters by name.
CellFilter withProfileId CellFilter Filters by profileId.
CellFilter withStatus CellFilter Filters by status.
07-24-2019
Object Method Return Type Description
RuntimePal createCube Cube Creates a cube of the specified size. Requires cube enabled in activation key. This is restricted by the overall size of all other cubes compared to the cube storage allotted to the enterprise.
RuntimePal getCube Cube Returns the specified cube or null if it does not exist. Requires cube enabled in activation key.
RuntimePal getCubes DataList Returns a list of cubes
07-23-2019
Object Method Return Type Description
Tunnel deleteToken Deletes the response token associated with this tunnel, if any.
Tunnel submitToken TunnelResult Submits a request to the tunnel's target and creates a response token if one doesn't already exist.
07-03-2019
Object Method Return Type Description
Modules getConfigData Data Returns the configuration data for the specified pal.
Modules getConfigList DataList Returns the configuration data list for the specified pal.
RuntimePal getModules Modules Returns access to the modules associated with this pal, if any.
Modules list DataList Returns the module pals associated with this pal.
Modules remove Removes the module.
Modules setEnabled Enables or disables the module.
Modules toString String Returns a description of this object.
06-21-2019
Object Method Return Type Description
TransactionWebServiceController debugList 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.
06-19-2019
Object Method Return Type Description
DataSet deleteRecords int Deletes matching records.
06-11-2019
Object Method Return Type Description
RuntimePal openTunnel Tunnel Opens a tunnel to the default tunnel workflow of this pal. This works only between pals within the same enterprise and zone.
06-04-2019
Object Method Return Type Description
TransactionWebServiceController debugData Debugs all the values of the given data object.
03-28-2019
Object Method Return Type Description
DataList collapse PacketDataList Reduces a list with duplicate data into a list with unique data adding a new serialized JSON column containing the duplicate information. See also tag c:expand.
DataViewList collapse PacketDataList Reduces a list with duplicate data into a list with unique data adding a new serialized JSON column containing the duplicate information. See also tag c:expand.
PacketDataList collapse PacketDataList Reduces a list with duplicate data into a list with unique data adding a new serialized JSON column containing the duplicate information. See also tag c:expand.
StorageProviderDataList collapse PacketDataList Reduces a list with duplicate data into a list with unique data adding a new serialized JSON column containing the duplicate information. See also tag c:expand.
03-19-2019
Object Method Return Type Description
DataSet findRecord DataSetRecord Finds the first record matching the criteria of column and value.
03-08-2019
Object Method Return Type Description
DateUtil calcDate Date Returns the date of the [week] [day] of the given month and year. For example, (2019,3,2,1) will return the 2nd Sunday of March 2019. This may return null if no date exists with the criteria.
03-06-2019
Object Method Return Type Description
DataSet isEmpty boolean Returns true if this dataset has no records.
02-11-2019
Object Method Return Type Description
DownloadResponse setData boolean Registers the data in the response with the specified id.
Email setData boolean Registers the data in the response with the specified id.
Fragment setData boolean Registers the data in the response with the specified id.
Payload setData boolean Registers the data in the response with the specified id.
Render setData boolean Registers the data in the response with the specified id.
TextEmail setData boolean Registers the data in the response with the specified id.
02-03-2019
Object Method Return Type Description
EncryptionUtil base64toURLSafe String Converts a base64 encoded string to a base64url string.
01-09-2019
Object Method Return Type Description
EncryptionUtil fromBase16 String Decodes the Base16 content and attempts to return it as a string
EncryptionUtil fromBase64 String Decodes the Base64 content and attempts to return it as a string
12-11-2018
Object Method Return Type Description
ZoneAccess getScanResults SystemDataView Returns a SystemDataView that can be used for accessing file scan results for the specified pal.
12-10-2018
Object Method Return Type Description
TransactionWebServiceController dumpDebug Forces an immediate flush of the debug log. This can be called once every 10 seconds.
12-06-2018
Object Method Return Type Description
DataSet analyze Payload This method analyzes columns and indexes for the Pal, Runtime, and Storage components of this DataSet. If updateIndexes is true, this method will force an update on index information which may lock the DataSet for an extended period of time, therefore you should not call this method on peak usage times or repeatedly.
12-04-2018
Object Method Return Type Description
AnalyticDataViewFilter explain This method is only for development purposes to describe the indexes that will be utilized in the given query. The output is rendered in the debug messages of Pal Builder. This method is used for development purposes and ignored in deployed pals.
DataViewFilter explain This method is only for development purposes to describe the indexes that will be utilized in the given query. The output is rendered in the debug messages of Pal Builder. This method is used for development purposes and ignored in deployed pals.
SystemDataViewFilter explain This method is only for development purposes to describe the indexes that will be utilized in the given query. The output is rendered in the debug messages of Pal Builder. This method is used for development purposes and ignored in deployed pals.
11-13-2018
Object Method Return Type Description
EncryptionUtil verifySha1RsaSignature boolean Verifies the base64 encoded signature against the x509 public certificate and non encoded canonical message
11-07-2018
Object Method Return Type Description
Monitor setMaxTimeout int Sets the timeout to maximum allowed and returns it
Monitor setQueryTimeout Sets the global timeout for the dataset queries. Anything longer than this time will trigger a subscription notice. Minimum is 2 seconds and maximum is 10 seconds.
10-29-2018
Object Method Return Type Description
DisplaySettings setAudioSettings Overrides the default context for capturing audio settings.
DisplaySettings setAudioStyleSheet Overrides the default stylesheet for audio capture.
10-26-2018
Object Method Return Type Description
DataSetRecord setFile Same as setFile but expects the file column to be remote file. Associates the file with the specified storage provider.
10-25-2018
Object Method Return Type Description
DatasetFile isRemote boolean Returns true if this is a remotely stored file.
DatasetFile isSaved boolean If a remotely stored file, returns true if it has been saved remotely.
10-17-2018
Object Method Return Type Description
Data parse Integer Parses information from rawText matching fields and storing them in this Data object and returns the number found.
10-08-2018
Object Method Return Type Description
CacheManager putDataList Stores the DataList indefinitely, replacing any with the same key.
09-14-2018
Object Method Return Type Description
FileBuffer getUnknownFile UnknownFile Returns the specified file as unknown file. Available in a 'read' FileBuffer.
08-28-2018
Object Method Return Type Description
Data get String Returns the value associated with key if it exists, null otherwise.
DataRecord get String Returns the value associated with key if it exists, null otherwise.
DataSetRecord get String Returns the value associated with key if it exists, null otherwise.
DataViewRecord get String Returns the value associated with key if it exists, null otherwise.
DownloadResponse get String Returns the value associated with key if it exists, null otherwise.
Email get String Returns the value associated with key if it exists, null otherwise.
Fragment get String Returns the value associated with key if it exists, null otherwise.
PacketDataRecord get String Returns the value associated with key if it exists, null otherwise.
Payload get String Returns the value associated with key if it exists, null otherwise.
Render get String Returns the value associated with key if it exists, null otherwise.
TextEmail get String Returns the value associated with key if it exists, null otherwise.
Data set boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc). The object must be capable of being serialized as a String.
DataSetRecord set boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc). The object must be capable of being serialized as a String.
DownloadResponse set boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc). The object must be capable of being serialized as a String.
Email set boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc). The object must be capable of being serialized as a String.
Fragment set boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc). The object must be capable of being serialized as a String.
PacketDataRecord set boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc). The object must be capable of being serialized as a String.
Payload set boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc). The object must be capable of being serialized as a String.
Render set boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc). The object must be capable of being serialized as a String.
TextEmail set boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc). The object must be capable of being serialized as a String.
Data setBoolean boolean Sets the boolean value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
DataSetRecord setBoolean boolean Sets the boolean value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
DownloadResponse setBoolean boolean Sets the boolean value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Email setBoolean boolean Sets the boolean value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Fragment setBoolean boolean Sets the boolean value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
PacketDataRecord setBoolean boolean Sets the boolean value of the specified column referenced by name. Returns false if the column does not exist.
Payload setBoolean boolean Sets the boolean value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Render setBoolean boolean Sets the boolean value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
TextEmail setBoolean boolean Sets the boolean value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Data setDate boolean Sets the date value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
DataSetRecord setDate boolean Sets the date value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
DownloadResponse setDate boolean Sets the date value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Email setDate boolean Sets the date value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Fragment setDate boolean Sets the date value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
PacketDataRecord setDate boolean Sets the date value of the specified column referenced by name. Returns false if the column does not exist.
Payload setDate boolean Sets the date value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Render setDate boolean Sets the date value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
TextEmail setDate boolean Sets the date value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Data setDouble boolean Sets the decimal value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
DataSetRecord setDouble boolean Sets the decimal value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
DownloadResponse setDouble boolean Sets the decimal value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Email setDouble boolean Sets the decimal value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Fragment setDouble boolean Sets the decimal value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
PacketDataRecord setDouble boolean Adds the key/value pair to the data map, over-writing any set that already exists with name key.
Payload setDouble boolean Sets the decimal value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Render setDouble boolean Sets the decimal value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
TextEmail setDouble boolean Sets the decimal value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Data setInt boolean Sets the integer value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
DataSetRecord setInt boolean Sets the integer value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
DownloadResponse setInt boolean Sets the integer value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Email setInt boolean Sets the integer value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Fragment setInt boolean Sets the integer value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
PacketDataRecord setInt boolean Sets the integer value of the specified column referenced by name. Returns false if the column does not exist.
Payload setInt boolean Sets the integer value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Render setInt boolean Sets the integer value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
TextEmail setInt boolean Sets the integer value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Data setString boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
DataSetRecord setString boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
DownloadResponse setString boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Email setString boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Fragment setString boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
PacketDataRecord setString boolean Sets the string value of the specified column referenced by name. Returns false if the column does not exist.
Payload setString boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
Render setString boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
TextEmail setString boolean Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
08-23-2018
Object Method Return Type Description
AudioFile getFileLength int Returns the size of the file in bytes.
DatasetFile getFileLength int Returns the size of the file in bytes.
DocumentFile getFileLength int Returns the size of the file in bytes.
ExcelFile getFileLength int Returns the size of the file in bytes.
File getFileLength int Returns the size of the file in bytes.
ImageFile getFileLength int Returns the size of the file in bytes.
PdfFile getFileLength int Returns the size of the file in bytes.
UnknownFile getFileLength int Returns the size of the file in bytes.
VCardFile getFileLength int Returns the size of the file in bytes.
EncryptionUtil hmacMd5 String Creates MD5-hashed message authentication code for a string. Result is Base16 encoded.
AudioFile toUnknownFile UnknownFile Converts this file to an UnknownFile (used for testing purposes).
DatasetFile toUnknownFile UnknownFile Converts this file to an UnknownFile (used for testing purposes).
DocumentFile toUnknownFile UnknownFile Converts this file to an UnknownFile (used for testing purposes).
ExcelFile toUnknownFile UnknownFile Converts this file to an UnknownFile (used for testing purposes).
File toUnknownFile UnknownFile Converts this file to an UnknownFile (used for testing purposes).
ImageFile toUnknownFile UnknownFile Converts this file to an UnknownFile (used for testing purposes).
PdfFile toUnknownFile UnknownFile Converts this file to an UnknownFile (used for testing purposes).
VCardFile toUnknownFile UnknownFile Converts this file to an UnknownFile (used for testing purposes).
08-22-2018
Object Method Return Type Description
DisplaySettings replacePrintStyleSheet boolean Replaces all styles of this document with this one.
07-18-2018
Object Method Return Type Description
ServiceResponse removeNamespaces Removes namespaces from the payload XML so the content can be queried with XPATH.
XMLReader removeNamespaces Removes namespaces from the payload XML so the content can be queried with XPATH.
06-25-2018
Object Method Return Type Description
ServiceResponse toFile File Returns the content of this response as a File.
XMLReader toFile File Returns the content of this response as a File.
06-18-2018
Object Method Return Type Description
RuntimePal createTunnel Tunnel Creates and returns the tunnel. Name must be unique. This method is used for creating tunnels against a global target. Configuration information is contained within the encrypted key.
TunnelResult getError String On failure, returns the failure message.
TunnelResult getPayload Payload Returns the payload result of the request, if any. This may return null if the remote workflow did not set a payload.
RuntimePal getTunnel Tunnel Returns the specified tunnel or null if it does not exist.
TunnelResult isSuccess boolean Returns true if the request is successful.
Tunnel submit TunnelResult Submits a request to the tunnel's target.
Tunnel toString String Returns a description of this object.
TunnelResult toString String Returns a description of this object.
05-25-2018
Object Method Return Type Description
ShellPal checkAuthDomain boolean Checks to see if setting the auth domain for the Web module of the Pal will succeed.
ShellPalManager checkAuthDomain boolean Checks to see if setting the auth domain for the Web module of the Pal will succeed.
ShellPal checkWebDomain boolean Checks to see if setting the web domain for the Web module of the Pal will succeed.
ShellPalManager checkWebDomain boolean Checks to see if setting the web domain for the Web module of the Pal will succeed.
05-15-2018
Object Method Return Type Description
Packet createPdfDocument Document Adds the document from the PDF file. See DisplaySettings.renderSmart and Document.setLayerPayload.
TransactionPacket createPdfDocument Document Adds the document from the PDF file. See DisplaySettings.renderSmart and Document.setLayerPayload.
05-11-2018
Object Method Return Type Description
Fragment toImage ImageFile Renders this fragment into an image file using current fragment's state. Supports PNG, JPG, GIF, and TIFF.
Render toImage ImageFile Renders this page into an image file. Currently, only PNG format is supported.
05-10-2018
Object Method Return Type Description
PacketDataList removeColumn Removes the specified column.
04-24-2018
Object Method Return Type Description
PacketDataList addColumn boolean Adds the specified column to the end of this DataList and sets the value for all rows in the list. If the column already exists, this method returns false.
04-20-2018
Object Method Return Type Description
Packet revokeRoles Revokes the role from all users who have it
TransactionPacket revokeRoles Revokes the role from all users who have it
03-30-2018
Object Method Return Type Description
ShellPal exportShellPal File Exports this shell pal to file
03-28-2018
Object Method Return Type Description
UnknownFile getFileExtension String Returns the file extension. 'Myfile.doc' returns 'doc'
UnknownFile getFileSize int Returns the size of the file in kilobytes.
UnknownFile getFilename String Returns the name of the uploaded file.
FtpRequest getUnknownFile UnknownFile Gets the specified file. Returns null if its size exceeds the max size allowed by the key.
UnknownFile toFile File Creates a file with the given name and extension. Extension is required and must be a type supported by the platform
UnknownFile toString String Returns a description of this object.
03-13-2018
Object Method Return Type Description
AnalyticDataViewFilter setQueryTimeout DataViewCriteria Sets the timeout for the query. By default this is 10 seconds and the maximum is defined by the cloud configuration.
DataViewCriteria setQueryTimeout DataViewCriteria Sets the timeout for the query. By default this is 10 seconds and the maximum is defined by the cloud configuration.
DataViewFilter setQueryTimeout DataViewCriteria Sets the timeout for the query. By default this is 10 seconds and the maximum is defined by the cloud configuration.
SystemDataViewFilter setQueryTimeout DataViewCriteria Sets the timeout for the query. By default this is 10 seconds and the maximum is defined by the cloud configuration.
03-09-2018
Object Method Return Type Description
AudioFile getRecordingData Data Returns information on the recording.
AudioFile getRecordingTime int Returns the length of the audio recording in seconds. -1 means there was not enough accurate information to determine the recording time. See guessRecordingTime()
AudioFile guessRecordingTime int Gets the recording time and if it is greater than 0, returns it. Otherwise tries to calculate the best guess base on what is provided in the audio file.
AudioFile toAudioFile AudioFile Returns AudioFile created from this File. Method returns null if current file cannot be represented as an audio.
DatasetFile toAudioFile AudioFile Returns AudioFile created from this File. Method returns null if current file cannot be represented as an audio.
DocumentFile toAudioFile AudioFile Returns AudioFile created from this File. Method returns null if current file cannot be represented as an audio.
ExcelFile toAudioFile AudioFile Returns AudioFile created from this File. Method returns null if current file cannot be represented as an audio.
File toAudioFile AudioFile Returns AudioFile created from this File. Method returns null if current file cannot be represented as an audio.
ImageFile toAudioFile AudioFile Returns AudioFile created from this File. Method returns null if current file cannot be represented as an audio.
PdfFile toAudioFile AudioFile Returns AudioFile created from this File. Method returns null if current file cannot be represented as an audio.
VCardFile toAudioFile AudioFile Returns AudioFile created from this File. Method returns null if current file cannot be represented as an audio.
AudioFile toString String Returns a description of this object.
03-02-2018
Object Method Return Type Description
Pal getAutoScript File Returns automated script of this pal as File. Returns null if script with specified name is not available
RuntimePal getAutoScript File Returns automated script of this pal as File. Returns null if script with specified name is not available
ShellPal getAutoScript File Returns automated script of this pal as File. Returns null if script with specified name is not available
Pal getPalAutoScripts PacketDataList Returns list of automation scripts for this pal
RuntimePal getPalAutoScripts PacketDataList Returns list of automation scripts for this pal
ShellPal getPalAutoScripts PacketDataList Returns list of automation scripts for this pal
03-01-2018
Object Method Return Type Description
TransactionWebServiceController getChartTool ChartTool Creates and returns a chart factory object which can be used to create specific chart types.
AreaChart toImage ImageFile Renders the chart to an image. Filename should have an extension of png, jpg, or gif
BarChart toImage ImageFile Renders the chart to an image. Filename should have an extension of png, jpg, or gif
Chart toImage ImageFile Renders the chart to an image. Filename should have an extension of png, jpg, or gif
LineChart toImage ImageFile Renders the chart to an image. Filename should have an extension of png, jpg, or gif
PieChart toImage ImageFile Renders the chart to an image. Filename should have an extension of png, jpg, or gif
ScatterPlotChart toImage ImageFile Renders the chart to an image. Filename should have an extension of png, jpg, or gif
01-26-2018
Object Method Return Type Description
CacheManager getAvailable int Returns the amount of cache available.
01-19-2018
Object Method Return Type Description
DisplaySettings filterDocumentData Provides a different rendering of data within a document when displayed
01-16-2018
Object Method Return Type Description
CacheManager putData Stores the Data for indefinitely, replacing any with the same key.
01-12-2018
Object Method Return Type Description
Chunk addDataMap Adds the data to the chunk with the specified id.
12-21-2017
Object Method Return Type Description
CacheManager putPayload Stores the Payload indefinitely, replacing any with the same key.
DownloadResponse removeDataMap Removes the data in the response with the specified id.
Email removeDataMap Removes the data in the response with the specified id.
Fragment removeDataMap Removes the data in the response with the specified id.
Payload removeDataMap Removes the data in the response with the specified id.
Render removeDataMap Removes the data in the response with the specified id.
TextEmail removeDataMap Removes the data in the response with the specified id.
12-15-2017
Object Method Return Type Description
Chunk addData Adds the data to the chunk.
Chunk addDataList Adds the datalist to the chunk.
Chunk addPayload Adds the payload to the chunk.
Chunk cache Renders and caches the chunk. Over-rides anything that already exists with the ID.
CacheManager createChunk Chunk Creates a chunk
CacheManager deleteChunk Deletes the chunk
CacheManager getChunk Chunk Returns the chunk with the given ID associated with this Pal
Chunk setFragment Sets the fragment to the chunk.
Chunk setValue Adds the key/value to the chunk.
Chunk toString String Returns a description of this object.
11-13-2017
Object Method Return Type Description
Document getSignatureImage ImageFile Returns the image file, if any, of the specified signed signature.
11-07-2017
Object Method Return Type Description
Buffer getElement String Returns the xhtml of the content identified by xpath.
Buffer replaceElement Buffer Replaces the element identified with xpath with content defined by xhtml. If xhtml is null, it removes the element. Expects the underlying buffer content to be well-formed xhtml.
10-05-2017
Object Method Return Type Description
AudioFile toPdf PdfFile This method expects the document to already be a PDF. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
DatasetFile toPdf PdfFile This method expects the document to already be a PDF. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
DocumentFile toPdf PdfFile This method expects the document to already be a PDF. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
ExcelFile toPdf PdfFile This method expects the document to already be a PDF. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
File toPdf PdfFile This method expects the document to already be a PDF. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
ImageFile toPdf PdfFile This method expects the document to already be a PDF. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
PdfFile toPdf PdfFile This method expects the document to already be a PDF. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
VCardFile toPdf PdfFile This method expects the document to already be a PDF. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
09-7-2017
Object Method Return Type Description
ZoneAccess getPalByName RuntimePal Returns the Pal with the specified name. Requires palToPal permission and both pals must be in this zone.
09-28-2017
Object Method Return Type Description
ShellPal replaceFull This will replace all artifacts in this shell pal with content from the file. If preserveLocal is true, objects in this shell with the same name as the source will not be changed. This method includes all pal objects except workflow, datasets, and dataviews.
ShellPal replacePartial This will replace all artifacts in this shell pal with content from the file. If preserveLocal is true, objects in this shell with the same name as the source will not be changed.
09-12-2017
Object Method Return Type Description
RuntimePal getShellPalManager ShellPalManager Returns the ShellPalManager for this Pal if any. Throws error if not permitted by the pal type, zone, or activation key.
09-08-2017
Object Method Return Type Description
JobManager getLastJob Job Returns the job with the given name and having a schedule furthest in the future.
08-04-2017
Object Method Return Type Description
EncryptionUtil sha512Base16 String Calculates SHA512 digest for an input over n iterations and returns it as Base16.
08-02-2017
Object Method Return Type Description
DownloadResponse allowHTML Permits any rendering target with the specified key to be rendered as HTML.
Email allowHTML Permits any rendering target with the specified key to be rendered as HTML.
Fragment allowHTML Permits any rendering target with the specified key to be rendered as HTML.
Payload allowHTML Permits any rendering target with the specified key to be rendered as HTML.
Render allowHTML Permits any rendering target with the specified key to be rendered as HTML.
TextEmail allowHTML Permits any rendering target with the specified key to be rendered as HTML.
06-26-2017
Object Method Return Type Description
RuntimePal getSavedDataView DataView Returns the DataView identified by name. Returns null if no DataView exists. This method will persist the dataview structure with the underlying storage which may result in faster queries
02-24-2017
Object Method Return Type Description
RuntimePal getCloudCacheManager CacheManager Returns the CacheManager for this Pal with an access level of cloud. Any Pal in the cloud can access and modify cached objects. Use this with caution.
RuntimePal getCloudLockManager LockManager Returns the LockManager for this Pal with an access level of cloud.
RuntimePal getEnterpriseCacheManager CacheManager Returns the CacheManager for this Pal with an access level of enterprise. Any Pal in the enterprise can access and modify cached objects. Use this with caution.
RuntimePal getEnterpriseLockManager LockManager Returns the LockManager for this Pal with an access level of enterprise.
CacheManager getLockManager LockManager Returns the LockManager associated with this Cache.
01-26-2017
Object Method Return Type Description
ImageFile getImageMetadata Data Returns metadata of this image file (not all of which might be present): longitude,latitude,date,camera,manufacturer,focalLength,fStop,exposureTime,isoSpeedRatings shutterSpeedValueAPEX,shutterSpeedExposureTime,apertureValueAPEX,subjectDistance,dateTimeOriginal,orientation,height,width,p0-p12. p0-p12 contains pixel colors for 13 points on the image in hex.
PdfFile getImageMetadata Data Returns metadata of this image file (not all of which might be present): longitude,latitude,date,camera,manufacturer,focalLength,fStop,exposureTime,isoSpeedRatings shutterSpeedValueAPEX,shutterSpeedExposureTime,apertureValueAPEX,subjectDistance,dateTimeOriginal,orientation,height,width,p0-p12. p0-p12 contains pixel colors for 13 points on the image in hex.
TransactionWebServiceController getQRUtil QRUtil Returns a utility for creating and reading QR codes.
QRUtil read String Reads the QR data from the image file
QRUtil toString String Returns a description of this object.
QRUtil writeUrl ImageFile Creates a QR image from the url.
01-18-2017
Object Method Return Type Description
Packet expandSize boolean Expands the transaction size by the specified amount in MB and charges the corresponding fee as a pal billing event.
TransactionPacket expandSize boolean Expands the transaction size by the specified amount in MB and charges the corresponding fee as a pal billing event.
Packet getExpandAvailable int Returns the available expansion size in MB. Returns 0 if there is no amount left or if pricing does not permit expansion.
TransactionPacket getExpandAvailable int Returns the available expansion size in MB. Returns 0 if there is no amount left or if pricing does not permit expansion.
PalActivationKeyInfo getExpandFee double Returns the fee per MB for expanding a transaction size.
Packet getExpandSize int Returns the current expansion size in MB.
TransactionPacket getExpandSize int Returns the current expansion size in MB.
11-30-2016
Object Method Return Type Description
EncryptionUtil decrypt String Decrypts the content using the cloud supplied encryption key. See encrypt(string).
EncryptionUtil encrypt String Encrypts the content using the cloud supplied encryption key and returns it as Base64. See decrypt(string).
Packet endAccessPeriod Ends the Access period and adjusts the Archive period according to the activation key. This may trigger auto-archive or auto-delete if enabled for the enterprise.
TransactionPacket endAccessPeriod Ends the Access period and adjusts the Archive period according to the activation key. This may trigger auto-archive or auto-delete if enabled for the enterprise.
TransactionWebServiceController getEncryptionUtil EncryptionUtil Returns encryption utility
11-16-2016
Object Method Return Type Description
CacheManager getData Data Returns the Data with the specified key.
CacheManager getDataList PacketDataList Returns the DataList with the specified key.
CacheManager getPayload Payload Returns the Payload with the specified key.
CacheManager putData Stores the Data for [expires] minutes, replacing any with the same key.
CacheManager putDataList Stores the DataList for [expires] minutes, replacing any with the same key.
CacheManager putPayload Stores the Payload for [expires] minutes, replacing any with the same key.
11-08-2016
Object Method Return Type Description
EncryptionUtil hmacSha256 String Creates SHA256-hashed message authentication code for a string. Result is Base64 encoded.
ServiceResponse readJSON String Reads the body of the response and converts it to JSON if it is XML. Returns null if there is no body or the body exceeds the maximum upload allowed by the activation key.
XMLReader readJSON String Reads the body of the response and converts it to JSON if it is XML. Returns null if there is no body or the body exceeds the maximum upload allowed by the activation key.
EncryptionUtil sha256 String Calculates SHA256 digest for a string and returns it as Base16.
JSONParser toJson String Returns the content of this JSONParser as JSON.
11-07-2016
Object Method Return Type Description
Document getType String Returns the type of document. Typically this is html or pdf. May also be 'files' or 'adhoc'.
ServiceRequest setAWS Configures this request for AWS authentication.
11-03-2016
Object Method Return Type Description
Job commit Saves payload back to the storage layer for this job.
Job getRunCount int Returns the number of times this job has run.
Job reschedule Reschedules this job to run again at the date and time specified. The time must be in the future. Great care should be taken in using this method since usually you run a job once and forget about it. Priority jobs cannot be rescheduled with the same priority.
Job setPayload Sets the job's payload. For this to persist, call commit(). Max serialized payload is approx 16MB.
10-24-2016
Object Method Return Type Description
PalActivationKeyInfo getMaxPdfPageCount int Returns the max page count for PDFs.
10-07-2016
Object Method Return Type Description
AudioFile encrypt File Returns a new file with the content of this file PGP encrypted having the specified file name. Extensions allowed: pgp, gpg, txt, asc. Extension is required.
DatasetFile encrypt File Returns a new file with the content of this file PGP encrypted having the specified file name. Extensions allowed: pgp, gpg, txt, asc. Extension is required.
DocumentFile encrypt File Returns a new file with the content of this file PGP encrypted having the specified file name. Extensions allowed: pgp, gpg, txt, asc. Extension is required.
ExcelFile encrypt File Returns a new file with the content of this file PGP encrypted having the specified file name. Extensions allowed: pgp, gpg, txt, asc. Extension is required.
File encrypt File Returns a new file with the content of this file PGP encrypted having the specified file name. Extensions allowed: pgp, gpg, txt, asc. Extension is required.
ImageFile encrypt File Returns a new file with the content of this file PGP encrypted having the specified file name. Extensions allowed: pgp, gpg, txt, asc. Extension is required.
PdfFile encrypt File Returns a new file with the content of this file PGP encrypted having the specified file name. Extensions allowed: pgp, gpg, txt, asc. Extension is required.
VCardFile encrypt File Returns a new file with the content of this file PGP encrypted having the specified file name. Extensions allowed: pgp, gpg, txt, asc. Extension is required.
09-19-2016
Object Method Return Type Description
StorageProviderDataList getMarker String Returns the marker, if any, used in paging.
StorageProvider listObjects StorageProviderDataList Lists objects available in cloud storage. Pagination applies if you use a marker. Marker can be obtained from StorageProviderDataList.getMarker() after an initial empty call. Start position is 1-based. Max list size is 500
StorageProviderDataList toString String Returns a description of this object.
StorageProvider uploadObject Data Uploads file into cloud storage
09-01-2016
Object Method Return Type Description
FtpRequest createFolder boolean Creates a folder in the current folder
FtpRequest deleteFolder boolean Deletes the specified folder (and all subfolder if recursive is true).
08-18-2016
Object Method Return Type Description
RuntimePal createDataViewBuilder DataViewBuilder Returns new DataViewBuilder for constructing runtime DataViews.
FtpRequest setPrivateKey Supplies a private key for connecting to a server. Call this before calling connect(). This will over-ride any private key in a connector.
08-17-2016
Object Method Return Type Description
BusinessUtil getPdfFonts DataList Returns a list of fonts usable in creating a PDF. See Render.toDocumentPdf.
08-11-2016
Object Method Return Type Description
Render toDocumentPdf PdfFile Creates PDF file, preserving signatures and input fields. File will reflect current Render state. Further modifications of Render will not have effect on file contents.
08-03-2016
Object Method Return Type Description
AudioFile pgpDecrypt File Returns a new file with the content of this PGP encrypted file decrypted using the provided private key. The content type is guessed from the file name extension
DatasetFile pgpDecrypt File Returns a new file with the content of this PGP encrypted file decrypted using the provided private key. The content type is guessed from the file name extension
DocumentFile pgpDecrypt File Returns a new file with the content of this PGP encrypted file decrypted using the provided private key. The content type is guessed from the file name extension
ExcelFile pgpDecrypt File Returns a new file with the content of this PGP encrypted file decrypted using the provided private key. The content type is guessed from the file name extension
File pgpDecrypt File Returns a new file with the content of this PGP encrypted file decrypted using the provided private key. The content type is guessed from the file name extension
ImageFile pgpDecrypt File Returns a new file with the content of this PGP encrypted file decrypted using the provided private key. The content type is guessed from the file name extension
PdfFile pgpDecrypt File Returns a new file with the content of this PGP encrypted file decrypted using the provided private key. The content type is guessed from the file name extension
VCardFile pgpDecrypt File Returns a new file with the content of this PGP encrypted file decrypted using the provided private key. The content type is guessed from the file name extension
AudioFile pgpEncrypt File Returns a new file with the content of this file PGP encrypted using the provided public key. The new file's filename will be existing filename+.txt
DatasetFile pgpEncrypt File Returns a new file with the content of this file PGP encrypted using the provided public key. The new file's filename will be existing filename+.txt
DocumentFile pgpEncrypt File Returns a new file with the content of this file PGP encrypted using the provided public key. The new file's filename will be existing filename+.txt
ExcelFile pgpEncrypt File Returns a new file with the content of this file PGP encrypted using the provided public key. The new file's filename will be existing filename+.txt
File pgpEncrypt File Returns a new file with the content of this file PGP encrypted using the provided public key. The new file's filename will be existing filename+.txt
ImageFile pgpEncrypt File Returns a new file with the content of this file PGP encrypted using the provided public key. The new file's filename will be existing filename+.txt
PdfFile pgpEncrypt File Returns a new file with the content of this file PGP encrypted using the provided public key. The new file's filename will be existing filename+.txt
VCardFile pgpEncrypt File Returns a new file with the content of this file PGP encrypted using the provided public key. The new file's filename will be existing filename+.txt
07-23-2016
Object Method Return Type Description
DisplaySettings setSigningHandler Passes display responsibility of the signature capture to a client side function. When the signing function has completed capture it should submit to the workflow the same action used to enable signing.
07-20-2016
Object Method Return Type Description
CacheManager enableUpload String Enables short-lived target for a non-browser client to send a file and restricts the upload to type and maximum file size. type can be * (all types) or a comma delimited string of types. kilobytes cannot exceed the pal activation settings for max upload. The URL should be given to the client application for one time use. It is also used to retrieve the file by calling getCachedFile(String url)
06-10-2016
Object Method Return Type Description
TransactionWebServiceController createDataList PacketDataList Creates a new non persistent PacketDataList and adds the array to the column
05-31-2016
Object Method Return Type Description
Packet getPalId String Returns the Pal ID of this transaction.
TransactionPacket getPalId String Returns the Pal ID of this transaction.
ZoneAccess replaceTransaction TransactionPacket Replaces the transaction with the transaction from the file. This is a repair method to restore a transaction to an earlier state. All current artifacts (documents, wizards, etc) are deleted and replaced. The transaction ID of the XML must match the id of the TransactionPacket.
05-02-2016
Object Method Return Type Description
AnalyticDataViewFilter getQuery String Returns the query statement that will be generated for the underlying storage by the filter. This method is primarily used for development purposes.
DataViewFilter getQuery String Returns the query statement that will be generated for the underlying storage by the filter. This method is primarily used for development purposes.
SystemDataViewFilter getQuery String Returns the query statement that will be generated for the underlying storage by the filter. This method is primarily used for development purposes.
04-18-2016
Object Method Return Type Description
CacheManager retrieve String Returns the information with the specified key from storage without caching it
CacheManager store Stores the information indefinitely, replacing any with the same key. This method stores to the storage but not to the cache.
04-11-2016
Object Method Return Type Description
CacheManager deleteCachedFile Deletes the cached file, if any. See cacheFile()
03-25-2016
Object Method Return Type Description
ServiceRequest resolveHost String Returns the resolved IP address of the host
02-26-2016
Object Method Return Type Description
CacheManager cacheFile String Caches the file for the amount of time specified and restricts the access scope. Returns a file url that can be used in an audio or image tag for rendering the file. This is not a high performance and high scale method. It is meant to be used for displaying or streaming a single file to a single user or caching it short term for later processing.
CacheManager getCachedFile File Returns the cached file, if any. See cacheFile()
AudioFile removeSignature File Removes the digital signature, if any.
DatasetFile removeSignature File Removes the digital signature, if any.
DocumentFile removeSignature File Removes the digital signature, if any.
ExcelFile removeSignature File Removes the digital signature, if any.
File removeSignature File Removes the digital signature, if any.
ImageFile removeSignature File Removes the digital signature, if any.
PdfFile removeSignature File Removes the digital signature, if any.
VCardFile removeSignature File Removes the digital signature, if any.
AudioFile sign File Applies a digital signature to the file. Content must be well formed XML.
DatasetFile sign File Applies a digital signature to the file. Content must be well formed XML.
DocumentFile sign File Applies a digital signature to the file. Content must be well formed XML.
ExcelFile sign File Applies a digital signature to the file. Content must be well formed XML.
File sign File Applies a digital signature to the file. Content must be well formed XML.
ImageFile sign File Applies a digital signature to the file. Content must be well formed XML.
PdfFile sign File Applies a digital signature to the file. Content must be well formed XML.
VCardFile sign File Applies a digital signature to the file. Content must be well formed XML.
01-29-2016
Object Method Return Type Description
TransactionWebServiceController createJsonParser JSONParser Returns a parser for the given JSON string
JSONParser getChildren String[] Returns all of the node names for the specified path.
JSONParser getNodeType String Returns the object type of the jsonpath expression target. Result will be string, number, boolean, object, array, list, unknown, 'null', or null
JSONParser hasPath boolean Returns true if the jsonpath expression results in a non null endpoint.
JSONParser readChildren DataList Reads the child nodes of the given path and returns a DataList containing child names and types
JSONParser readData Data Creates a Data object by evaluating the jsonpath expression. If the target is an array or collection, an empty Data is returned. If the target contains a child object or array, the child object or array is serialized as a JSON string.
JSONParser readData Data Creates a Data object by evaluating the jsonpath expression. If the target is an array or a non-text collection, an empty Data is returned. Child objects and arrays are omitted.
JSONParser readDataList DataList Creates a DataList object by evaluating the jsonpath expression. Returns null if path not found. Child objects and arrays are ignored.
JSONParser readDataList DataList Creates a DataList object by evaluating the jsonpath expression. Returns null if path not found. Child objects and arrays are serialized to a JSON string.
JSONParser readPath JSONParser Creates a JSONParser object by evaluating the jsonpath expression. Returns null if path not found or the value of the path is null or the endpoint is not an object.
JSONParser readPayload Payload Creates a Payload object by evaluating the jsonpath expression. Returns null if path not found. Child objects and arrays are serialized to JSON string
JSONParser readPayload Payload Creates a Payload object by evaluating the jsonpath expression. Returns null if path not found.
JSONParser readValue String Returns the value by evaluating the jsonpath expression.
JSONParser reload Reloads this object with the specified json string.
Payload toJSON String Returns this Payload object as a JSON encoded string with a root element identified by name.
JSONParser toString String Returns a description of this object.
01-28-2016
Object Method Return Type Description
Formatter inject String If the text exceeds the given size, this method injects the specified value at every size interval and returns the new text. Used for injecting whitespace.
01-26-2016
Object Method Return Type Description
Pal getPalPages PacketDataList Returns a list of Page object names defined in this Pal.
RuntimePal getPalPages PacketDataList Returns a list of Page object names defined in this Pal.
ShellPal getPalPages PacketDataList Returns a list of Page object names defined in this Pal.
12-09-2015
Object Method Return Type Description
ShellPal getRuntimePal RuntimePal Returns the RuntimePal for this ShellPal.
12-08-2015
Object Method Return Type Description
TransactionWebServiceController getResourcePath String Returns the resource path for the specified resource.
12-02-2015
Object Method Return Type Description
EncryptionUtil hmacSha1 String Creates SHA1-hashed message authentication code for a string. Result is Base64 encoded.
EncryptionUtil hmacSha1 String Creates SHA1-hashed message authentication code for a file and returns it as Base64.
11-19-2015
Object Method Return Type Description
RuntimePal toString String Returns a description of this object.
11-16-2015
Object Method Return Type Description
Pal getSecureWebUrl String Returns the secure web url for this pal the an optional endpoint (for example: start.do). Returns null if there is no web workflow for this pal.
PalInfo getSecureWebUrl String Returns the secure web url for this pal the an optional endpoint (for example: start.do). Returns null if there is no web workflow for this pal.
RuntimePal getSecureWebUrl String Returns the secure web url for this pal the an optional endpoint (for example: start.do). Returns null if there is no web workflow for this pal.
ShellPal getSecureWebUrl String Returns the secure web url for this pal the an optional endpoint (for example: start.do). Returns null if there is no web workflow for this pal.
11-10-2015
Object Method Return Type Description
LockManager createLock boolean Sets a self expiring lock for the given key. The lock will expire as of the date/time indicated. Maximum lock time is 1 hour.
LockManager deleteLock Deletes the specified lock
LockManager getExpire Date Returns the expiration, if any, for the specified objectKey. If sessionKey is provided, this returns the expire datetime only if the sessionKey has the lock.
LockManager getSessionKey String Returns the session key, if any, for the specified objectKey.
LockManager hasLock boolean Returns true if the specified sessionKey has a lock on the objectKey. If sessionKey is provided, this returns the expire datetime only if the sessionKey has the lock.
LockManager toString String Returns a description of this object.
10-11-2015
Object Method Return Type Description
RuntimePal getLockManager LockManager Returns the LockManager for this Pal.
10-08-2015
Object Method Return Type Description
ServiceRequest submit ServiceResponse Submits request to specified url. failOnSSLError used for https connections. If failOnSSLError set to true request will fail if remote host certificate do not pass validation. allowRedirect=false is more secure and should be used if you know the remote service does not forward requests to a new location. Check response code and message.
10-05-2015
Object Method Return Type Description
TransactionWebServiceController setErrorPrefix Appends this prefix to any workflow generated error message.
09-22-2015
Object Method Return Type Description
ProfileTxManager cancelDeleteTransaction int Cancels deletion of the specified transaction. The active user must have the group permission 'delete transaction' for the specified group.
ProfileTxManager cancelDeleteTransactions int Cancels deletion of the specified transactions. The active user must have the group permission 'delete transaction' for the specified group.
ProfileTxManager changeTransactionGroup boolean Moves group association for the specified transaction from fromGroup to toGroup. Returns false if the user does not have permissions in both groups.
ProfileTxManager changeTransactionGroup int Moves group association for all transactions from fromGroup to toGroup. Returns -1 if the user does not have permissions in both groups.
ProfileTxManager changeTransactionGroup int Moves group association for the specified transactions from fromGroup to toGroup. Returns the number of records modified or -1 on failure, such as if the user does not have permissions in both groups.
ProfileTxManager getDeletedTransactionsView SystemDataView Returns a SystemDataView that can be used for accessing transactions that have been deleted.
Profile getPalManager ProfilePalManager Returns the pal manager for this profile.
ProfilePalManager getPalsByGroup SystemDataView Returns a SystemDataView that can be used for accessing pals the active user has group access to.
ProfileTxManager getTransactionAuditLogs DataList Returns audit logs for transaction. The active user must have permission to access transaction audit logs. Otherwise null returned
Profile getTransactionManager ProfileTxManager Returns the transaction manager for this profile.
ProfilePalManager getTransactionPalsByGroup SystemDataView Returns a SystemDataView that can be used for accessing transaction pals for which the active user has createTransaction permission.
ProfilePalManager getTransactionPalsByProfile SystemDataView Returns a SystemDataView that can be used for accessing transaction pals for which the active user has a role.
ProfileTxManager getTransactionViewByGroup SystemDataView Returns a SystemDataView that can be used for accessing transactions associated with the active user (the user belongs to the specified group) and the specified pal. Pass null for palId to include all pals. Pass * for palId to include only those transactions that have pals within the specified group. Pass a specific pal Id to isolate to a single pal.
ProfileTxManager getTransactionViewByRole SystemDataView Returns a SystemDataView that can be used for accessing transactions associated with the active user (a role has been assigned to the profile of the user). This view returns a distinct list of transactions the active user has a role in. See ProfilePalManager for a list of pals with transactions.
ProfileTxManager getTransactionViewByRoles SystemDataView Returns a SystemDataView that can be used for accessing transactions associated with the active user (a role has been assigned to the profile of the user). This view may include duplicate transaction entries if the user has more than one role. See ProfilePalManager for a list of pals with transactions.
ProfileTxManager getTransactionViewByScheduledDelete SystemDataView Returns a SystemDataView that can be used for accessing transactions that have been scheduled for deletion for the logged in users' enterprise. The active user must have the group permission 'delete transaction' for the specified group.
ProfileTxManager getTransactionViewByUserRemoved SystemDataView Returns a SystemDataView that can be used for accessing transactions associated with the logged in user with roles that have been removed. The view is restricted to the active profile.
ProfileTxManager removeUserAccessToTransaction int Removes the specified role(s) on the given transaction from the active user. Pass * for role to remove all roles.
ProfileTxManager removeUserAccessToTransactions int Removes the specified role(s) on the given transaction(s) from the active user. Pass * for role to remove all roles.
ProfileTxManager restoreUserAccessToTransaction int Restores the specified role(s) on the given transaction to the active user. Pass * for role to restore all roles.
ProfileTxManager restoreUserAccessToTransactions int Restores the specified role(s) on the given transaction(s) to the active user. Pass * for role to restore all roles.
ProfileTxManager scheduleDeleteTransaction int Schedules this transaction to be permanently deleted on the specified date or immediately if the date is in the past. If dataSetNames is not null, the related records in the identified dataSets will also be deleted. DataSetNames should be null or a comma separated list of dataSet names. This method returns 0 if the activation key does not permit deletions. The active user must have the group permission 'delete transaction' for the specified group.
ProfileTxManager scheduleDeleteTransactions int Schedules the transactions to be deleted on the specified date. See scheduleDeleteTransaction.
ProfilePalManager toString String Returns a description of this object.
ProfileTxManager toString String Returns a description of this object.
08-19-2015
Object Method Return Type Description
Archive isSoftArchive boolean Returns true if this archive is a soft archive, meaning it is associated with an active transaction.
08-07-2015
Object Method Return Type Description
Pal getPage Render Returns a Render object for the given page.
RuntimePal getPage Render Returns a Render object for the given page.
ShellPal getPage Render Returns a Render object for the given page.
Render toString String Returns a description of this object.
08-06-2015
Object Method Return Type Description
AnalyticDataViewFilter dateDiffCompare Returns the difference in days between the value of the date column and the compare date. If compareDate is null, the current date is used.
AnalyticDataViewFilter timeDiffCompare Returns the difference in unit between the value of the datetime column and the compare datetime. If compareDate is null, the current datetime is used.
07-23-2015
Object Method Return Type Description
PdfFile analyze Data Performs a top level analysis of the PDF and returns summary information.
PdfFile isCompatible boolean Returns true if this PDF can be converted to a Document.
Document signOverride If true, overrides the default signing behavior which requires the document to be presented before signing. If false, resets to the default behavior. This method has a lifespan of the workflow event only. It is not persistent and must be called each time you intend to override. For some signing methods, such as Document.sign(), which signature to sign is handled by the presentation layer. In this case since the document has not been displayed, you must specify which signature(s) and/or initial(s) (comma separated) you intend to sign. If you will be signing with an API that specifies the signature, use null for these parameters.
05-13-2015
Object Method Return Type Description
Pal getData Data Returns Data with top level information about this Pal.
PalInfo getData Data Returns Data with top level information about this Pal.
RuntimePal getData Data Returns Data with top level information about this Pal.
01-20-2015
Object Method Return Type Description
AudioFile readFile String Reads all of the text-based file and returns the content as a string. Returns null if there is no content. Throws exception if this file is not a text-based file.
DatasetFile readFile String Reads all of the text-based file and returns the content as a string. Returns null if there is no content. Throws exception if this file is not a text-based file.
DocumentFile readFile String Reads all of the text-based file and returns the content as a string. Returns null if there is no content. Throws exception if this file is not a text-based file.
ExcelFile readFile String Reads all of the text-based file and returns the content as a string. Returns null if there is no content. Throws exception if this file is not a text-based file.
File readFile String Reads all of the text-based file and returns the content as a string. Returns null if there is no content. Throws exception if this file is not a text-based file.
ImageFile readFile String Reads all of the text-based file and returns the content as a string. Returns null if there is no content. Throws exception if this file is not a text-based file.
PdfFile readFile String Reads all of the text-based file and returns the content as a string. Returns null if there is no content. Throws exception if this file is not a text-based file.
VCardFile readFile String Reads all of the text-based file and returns the content as a string. Returns null if there is no content. Throws exception if this file is not a text-based file.
01-13-2015
Object Method Return Type Description
ServiceRequest setOauth Configures this request for OAuth authentication. Standard oauth parameters in the Data are used to construct the Authorization header. The platform will construct the minimum necessary and pass through any parameters not needing to be changed during signature calculations. Required data elements: oauth_consumer_secret (for hmac-sha1), oauth_consumer_key, and oauth_signature_method (should be rsa-sha1, hmac-sha1, or plaintext). You may also provide oauth_nonce and oauth_timestamp if desired (i.e. for testing) but these will be provided if not present.
01-08-2015
Object Method Return Type Description
Formatter getDayOfWeekAsWord String Returns the name of the day of week based on the number. 1 is Sunday, 7 is Saturday
01-06-2015
Object Method Return Type Description
ProfilePacket clearPacket Deletes all Data, DataLists, and properties stored in this packet.
PacketDataList deleteRecords int Deletes all records that have the specified value in the given column
Payload getDataNames String[] Returns the names of all Data objects in this Payload.
Payload getListNames String[] Returns the names of all Lists in this Payload.
ProfilePacket getPayload Payload Returns copies of all Data, DataLists, and properties as a Payload object.
11-26-2014
Object Method Return Type Description
AnalyticDataViewFilter hasColumn boolean Returns true if the specified column exists for queries.
DataViewFilter hasColumn boolean Returns true if the specified column exists for queries.
SystemDataViewFilter hasColumn boolean Returns true if the specified column exists for queries.
11-24-2014
Object Method Return Type Description
Buffer removeControlChars Buffer Removes all control characters in the range x0000 to x001F inclusive if all is true. If all is false, this will remove all control characters except tab, line feed, and carriage return.
Data removeControlChars Data Returns a new Data object with all control characters in the range x0000 to x001F inclusive removed if all is true. If all is false, this will remove all control characters except tab, line feed, and carriage return.
11-06-2014
Object Method Return Type Description
EncryptionUtil createRSAKeyPair Data Returns a Data with two values: privateKey and publicKey. Content is Base64 encoded.
11-03-2014
Object Method Return Type Description
EncryptionUtil rsaSha1 String Creates base64 encoded RSA-SHA1 for the string. Note that key should be provided as base 64 string (PEM) PKCS8 or X509.
09-04-2014
Object Method Return Type Description
ZoneAccess importTransaction TransactionPacket Creates new transaction for specified Pal and imports transaction data from XML packet. Execution fee applies.
Archive restoreTransaction TransactionPacket Restores the transaction and associates it with the specified Pal and imports transaction data from XML packet. The target Pal must have an activation key that permits an access period.
09-03-2014
Object Method Return Type Description
Document getAudioRecording AudioFile Returns the audio file associated with the specified signature. Returns null if no audio recording exists.
05-15-2014
Object Method Return Type Description
Data calcMD5 String Returns an MD5 checksum of the contents of this Data.
DataList calcMD5 String Returns an MD5 checksum of the contents of this list.
DataViewList calcMD5 String Returns an MD5 checksum of the contents of this list.
PacketDataList calcMD5 String Returns an MD5 checksum of the contents of this list.
Payload calcMD5 String Returns an MD5 checksum of the contents of this Payload.
StorageProviderDataList calcMD5 String Returns an MD5 checksum of the contents of this list.
DataList createSublists Payload Returns a Payload containing one or more lists named prefixN (starting with 1) with a list called prefix containing the names of the lists created.
DataViewList createSublists Payload Returns a Payload containing one or more lists named prefixN (starting with 1) with a list called prefix containing the names of the lists created.
PacketDataList createSublists Payload Returns a Payload containing one or more lists named prefixN (starting with 1) with a list called prefix containing the names of the lists created.
StorageProviderDataList createSublists Payload Returns a Payload containing one or more lists named prefixN (starting with 1) with a list called prefix containing the names of the lists created.
05-09-2014
Object Method Return Type Description
MailMessage getDeliveryWorkflow String Returns the delivery workflow, if any.
MailMessage getReplyWorkflow String Returns the reply workflow, if any.
MailMessage isDeliveryEnabled boolean Returns true if this email has delivery enabled.
MailMessage isReplyEnabled boolean Returns true if this email has reply enabled.
05-01-2014
Object Method Return Type Description
DataListFilter addEqualIgnoreCase Return records where column equals value, ignoring case.
04-26-2014
Object Method Return Type Description
MailBox getMessage MailMessage Returns the MailMessage identified by Message ID and associated with this MailBox. A message ID is provided to the console system workflow of a pal that is registered to the subscription service.
MailMessage setDeliveryStatus Sets the status of this email.
04-24-2014
Object Method Return Type Description
MailResponse getHeaders DataList Returns a DataList of the mail headers.
MailMessage getId String Returns the Message ID associated with this email.
04-16-2014
Object Method Return Type Description
FileBuffer putFile Adds the file to the specified folder with a new filename. Use forward slash '/' for multiple folders. Available in a 'write' FileBuffer.
04-09-2014
Object Method Return Type Description
Email enableReply Allows recipient to reply to this email. This method requires inbound email configuration for current enterprise or a DSN Cloud Subscription Service. When recipient replies to the email, specified system workflow name will be provided to the listener.
Email enableWorkflowDeliveryStatus Enables delivery status for this email. This method requires inbound email configuration for current enterprise or a DSN Cloud Subscription Service. When a delivery status event occurs, this email job have its DSN status updated and specified workflow will be provided to the listener.
03-17-2014
Object Method Return Type Description
AudioFile decrypt File Returns a new file. Assumes the content of this file is PGP encrypted.
DatasetFile decrypt File Returns a new file. Assumes the content of this file is PGP encrypted.
DocumentFile decrypt File Returns a new file. Assumes the content of this file is PGP encrypted.
ExcelFile decrypt File Returns a new file. Assumes the content of this file is PGP encrypted.
File decrypt File Returns a new file. Assumes the content of this file is PGP encrypted.
ImageFile decrypt File Returns a new file. Assumes the content of this file is PGP encrypted.
PdfFile decrypt File Returns a new file. Assumes the content of this file is PGP encrypted.
VCardFile decrypt File Returns a new file. Assumes the content of this file is PGP encrypted.
02-03-2014
Object Method Return Type Description
Profile createPacket ProfilePacket Returns the ProfilePacket associated with this Console Pal or creates one if it does not exist. Each user of the Console Pal has a single ProfilePacket. This will return null if the user has not been granted console access or otherwise has group access to console.
ProfileInfo createPacket ProfilePacket Returns the ProfilePacket associated with this Console Pal or creates one if it does not exist. Each user of the Console Pal has a single ProfilePacket. This will return null if the user has not been granted console access or otherwise has group access to console.
Profile deletePacket Deletes the ProfilePacket, if any and removes console access (if personal profile).
ProfileInfo deletePacket Deletes the ProfilePacket, if any and removes console access (if personal profile).
Profile getPacket ProfilePacket Returns the ProfilePacket associated with this User and 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.
ProfileInfo getPacket ProfilePacket Returns the ProfilePacket associated with this User and 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.
01-03-2014
Object Method Return Type Description
AnalyticDataViewFilter enablePaging DataViewCriteria Sets firstResult based on the page size and page number and enables paging. This will force inquiry into the total number of records that match the filter and can be a performance hit on tables with a large amount of rows. Consider using enableFastPaging on larger datasets. See DataViewList.getPagingInfo().
DataViewCriteria enablePaging DataViewCriteria Sets firstResult based on the page size and page number and enables paging. This will force inquiry into the total number of records that match the filter and can be a performance hit on tables with a large amount of rows. Consider using enableFastPaging on larger datasets. See DataViewList.getPagingInfo().
DataViewFilter enablePaging DataViewCriteria Sets firstResult based on the page size and page number and enables paging. This will force inquiry into the total number of records that match the filter and can be a performance hit on tables with a large amount of rows. Consider using enableFastPaging on larger datasets. See DataViewList.getPagingInfo().
SystemDataViewFilter enablePaging DataViewCriteria Sets firstResult based on the page size and page number and enables paging. This will force inquiry into the total number of records that match the filter and can be a performance hit on tables with a large amount of rows. Consider using enableFastPaging on larger datasets. See DataViewList.getPagingInfo().
12-20-2013
Object Method Return Type Description
ConsoleManager deleteConsolePacket Deletes the Console System Packet associated with this Pal along with any data stored in the Packet.
12-11-2013
Object Method Return Type Description
MailResponse getMessage MailMessage If this MailResponse is in reply to a sent message, this returns the original message.
12-06-2013
Object Method Return Type Description
MailBox closeConnection Closes the remote connection.
MailMessage deleteMessage Deletes the message. Messages are automatically deleted after a certain amount of time determined by the activation key. Calling this method forces an immediate delete.
MailResponse deleteMessage Flags the remote message for deletion
MailMessage getDateSent Date Returns the date the email was sent.
RuntimePal getMailBox MailBox Returns the active MailBox associated with this Pal and identified with the email settings.
RuntimePal getMailBox MailBox Returns the active MailBox associated with this Pal (if any).
MailBoxList getMessageCount int Returns the number of messages in the list.
MailBox getMessages MailBoxList Returns a MailBoxList providing the ability to retrieve a group of messages (up to 100).
MailBoxList getNextMessage MailResponse Retrieves the next message from the mail box.
MailMessage getPalId String Returns the Pal ID of the pal that sent this email.
MailMessage getSubject String Returns the subject of the email.
MailMessage getTo String Returns the email address the message was sent to.
MailMessage getTxId String Returns the Transaction ID, if any, associated with this email.
MailBox toString String Returns a description of this object.
MailBoxList toString String Returns a description of this object.
MailMessage toString String Returns a description of this object
11-21-2013
Object Method Return Type Description
PacketDataList deleteAllRecords Deletes all records.
11-18-2013
Object Method Return Type Description
PdfFile createSprite ImageFile Creates a sprite image for the PDF. Restricted by max upload of the activation key and by the cloud max pdf page count. Height and width will not exceed 30% of normal page size.
10-08-2013
Object Method Return Type Description
DataSet getIndexes DataList Returns a read-only DataList containing index information for this DataSet.
10-04-2013
Object Method Return Type Description
EncryptionUtil createPGPKeyPair Data Returns a Data with two values: privateKey and publicKey. Key size is 1024. Content is Base64 encoded.
ConsoleManager deleteConsoleAccess boolean Deletes console access.
RuntimePal getConsoleManager ConsoleManager Returns the ConsoleManager for this Pal. Not supported in web workflow or module pals.
ConsoleManager getConsoleUsers SystemDataView Returns a SystemDataView that can be used for listing users with console access to this pal. This method may not include users who have group access.
ConsoleManager grantConsoleAccess boolean Grants console access. 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.
ConsoleManager toString String Returns a description of this object
09-30-2013
Object Method Return Type Description
DateUtil getAgeInHours int Returns the number of full hours between the specified dates. If startDate is after endDate, return this as a negative number.
DateUtil getAgeInMinutes long Returns the number of full minutes between the specified dates. If startDate is after endDate, return this as a negative number.
DateUtil getAgeInSeconds long Returns the number of full seconds between the specified dates. If startDate is after endDate, return this as a negative number.
DateUtil getDateDiff Data Returns a Data object containing fields: years, months, days, hours, minutes, seconds with values representing the time between the two dates. All values are positive.
DateUtil isTime boolean Returns true if the date is within the 24 hour start and end times.
09-04-2013
Object Method Return Type Description
CacheManager clearCache int Deletes up to 10,000 cache entries. This might take a long time to execute and may not clear all in one thread- consequently you should check the result and if it is the same as the limit, plan on calling it again.
CacheManager deleteItem Deletes the information with the specified key.
CacheManager get String Returns the information with the specified key.
RuntimePal getCacheManager CacheManager Returns the CacheManager for this Pal.
CacheManager getCacheSize int Returns the total size of the cache for this Pal in KB.
CacheManager put Stores the information indefinitely, replacing any with the same key.
CacheManager put Stores the information for [expires] minutes, replacing any with the same key.
CacheManager toString String Returns a description of this object.
08-29-2013
Object Method Return Type Description
ZoneAccess getArchiveGroups SystemDataView Returns a SystemDataView that can be used for accessing groups of the enterprise that have archive access available. Requires listGroups permission.
ZoneAccess getConsoleGroups SystemDataView Returns a SystemDataView that can be used for accessing groups of the enterprise that have console access available. Requires listGroups permission.
ZoneAccess getTransactionGroups SystemDataView Returns a SystemDataView that can be used for accessing groups of the enterprise that have transaction access available. Requires listGroups permission.
08-27-2013
Object Method Return Type Description
FileBuffer cleanup Releases resources. Best practice is to call this once you are done with this FileBuffer. Available in both 'read' and 'write' FileBuffer.
TransactionWebServiceController createFileBuffer FileBuffer Creates and returns a new FileBuffer object
AudioFile createFileBuffer FileBuffer Reads this compressed file and returns a FileBuffer. Throws exception if this not a supported type (zip and jar).
DatasetFile createFileBuffer FileBuffer Reads this compressed file and returns a FileBuffer. Throws exception if this not a supported type (zip and jar).
DocumentFile createFileBuffer FileBuffer Reads this compressed file and returns a FileBuffer. Throws exception if this not a supported type (zip and jar).
ExcelFile createFileBuffer FileBuffer Reads this compressed file and returns a FileBuffer. Throws exception if this not a supported type (zip and jar).
File createFileBuffer FileBuffer Reads this compressed file and returns a FileBuffer. Throws exception if this not a supported type (zip and jar).
ImageFile createFileBuffer FileBuffer Reads this compressed file and returns a FileBuffer. Throws exception if this not a supported type (zip and jar).
PdfFile createFileBuffer FileBuffer Reads this compressed file and returns a FileBuffer. Throws exception if this not a supported type (zip and jar).
VCardFile createFileBuffer FileBuffer Reads this compressed file and returns a FileBuffer. Throws exception if this not a supported type (zip and jar).
FileBuffer getFile File Returns the specified file. Available in a 'read' FileBuffer.
FileBuffer listFiles PacketDataList Returns a DataList of all the contents of this FileBuffer. Available in a 'read' FileBuffer.
FileBuffer putFile Adds the file. Available in a 'write' FileBuffer.
FileBuffer putFile Adds the file to the specified folder. Use forward slash '/' for multiple folders. Available in a 'write' FileBuffer.
FileBuffer toDocumentFile DocumentFile Creates a new DocumentFile from the contents of this FileBuffer. This can then be used for creating a Document. The docfile parameter must be the name of the XHTML document within the compressed file containing the content to be used for the document.
FileBuffer toFile File Does final compression and creates a new File from the contents of this FileBuffer. Available in a 'write' FileBuffer.
FileBuffer toString String Returns a description of this object.
08-23-2013
Object Method Return Type Description
ProfilePacket commit Typically changes to the packet are committed at the end of the workflow cycle. However, sometimes you need to commit before, in which case use this method.
ZoneAccess getArchiveManager ArchiveManager Returns the transaction archive manager for the enterprise. Do not use * for group.
ZoneAccess isArchiveAllowed boolean Checks archive permission
08-13-2013
Object Method Return Type Description
AudioFile closeReader Resets the capability to read lines to the beginning of the file.
DatasetFile closeReader Resets the capability to read lines to the beginning of the file.
DocumentFile closeReader Resets the capability to read lines to the beginning of the file.
ExcelFile closeReader Resets the capability to read lines to the beginning of the file.
File closeReader Resets the capability to read lines to the beginning of the file.
ImageFile closeReader Resets the capability to read lines to the beginning of the file.
PdfFile closeReader Resets the capability to read lines to the beginning of the file.
VCardFile closeReader Resets the capability to read lines to the beginning of the file.
AudioFile readLine String Reads one line (of the presumably text file) and returns it, advancing the reader to the next line for subsequent reads. Returns null if this file is not text based or there are no more lines to read. Best practice-call closeReader when finished.
DatasetFile readLine String Reads one line (of the presumably text file) and returns it, advancing the reader to the next line for subsequent reads. Returns null if this file is not text based or there are no more lines to read. Best practice-call closeReader when finished.
DocumentFile readLine String Reads one line (of the presumably text file) and returns it, advancing the reader to the next line for subsequent reads. Returns null if this file is not text based or there are no more lines to read. Best practice-call closeReader when finished.
ExcelFile readLine String Reads one line (of the presumably text file) and returns it, advancing the reader to the next line for subsequent reads. Returns null if this file is not text based or there are no more lines to read. Best practice-call closeReader when finished.
File readLine String Reads one line (of the presumably text file) and returns it, advancing the reader to the next line for subsequent reads. Returns null if this file is not text based or there are no more lines to read. Best practice-call closeReader when finished.
ImageFile readLine String Reads one line (of the presumably text file) and returns it, advancing the reader to the next line for subsequent reads. Returns null if this file is not text based or there are no more lines to read. Best practice-call closeReader when finished.
PdfFile readLine String Reads one line (of the presumably text file) and returns it, advancing the reader to the next line for subsequent reads. Returns null if this file is not text based or there are no more lines to read. Best practice-call closeReader when finished.
VCardFile readLine String Reads one line (of the presumably text file) and returns it, advancing the reader to the next line for subsequent reads. Returns null if this file is not text based or there are no more lines to read. Best practice-call closeReader when finished.
07-24-2013
Object Method Return Type Description
ServiceRequest setTimeout Sets the maximum timeout for the connection to (a) connect and (b) wait for data before terminating the connection. Default is 15 seconds for connect and 30 seconds for data.
07-16-2013
Object Method Return Type Description
RuntimePal createRemoteReturnUrl String Provides a URL that can be used with the c:remote tag. The parameters action or jsHandler are required. If both are used, the jsHandler client-side function should return true or false. True will submit the action. False will not and the jsHandler function must handle navigation. If the action parameter is the only supplied parameter, the page will be submitted to workflow with the action and all data provided by the remote service. If staticPage is used, the parameters are Base64 encoded and the URL can be used indefinitely, otherwise the URL is encrypted and has a life span of 30 minutes.
RuntimePal publishRemoteStyle String Provides a URL endpoint for a CSS file that can be embedded in a remote provider solution. This URL has a lifespan of 30 minutes
07-12-2013
Object Method Return Type Description
ServiceRequest checkConnection Enables DNS and certificate details (if any) to be gathered during the request and provided in Response.getConnectionInfo().
ServiceResponse getConnectionInfo Payload Returns DNS, domain, and certificate information about this request. See ServiceRequest.checkConnection().
06-13-2013
Object Method Return Type Description
SystemDataView createFilter SystemDataViewFilter Creates a new DataViewFilter for this DataView that will query against read-only storage (if readOnly is true). This can result in better performance but sometimes at the expense of retrieving current information. Typically you would use true here. You would use false, for example, if you create or update a transaction (or other record) then immediately display a list that includes that transaction and expect the changes to be visible.
SystemDataView createReadFilter SystemDataViewFilter Creates a new DataViewFilter for this DataView that will query against read-only storage. This can result in better performance but sometimes at the expense of retrieving current information.
SystemDataViewFilter isReadOnly boolean Returns true if this is a read-only filter.
ServiceRequest setEncoding Sets (or removes) the character encoding of the request. Default is UTF-8.
06-05-2013
Object Method Return Type Description
JobManager deleteJobs Deletes the jobs with the specified ids.
DataList toArray String[] Returns the values of the specified column as an array. Throws exception if the column does not exist.
DataViewList toArray String[] Returns the values of the specified column as an array. Throws exception if the column does not exist.
PacketDataList toArray String[] Returns the values of the specified column as an array. Throws exception if the column does not exist.
StorageProviderDataList toArray String[] Returns the values of the specified column as an array. Throws exception if the column does not exist.
05-30-2013
Object Method Return Type Description
BillingEngine credit BillingEvent Creates a credit. Amount must be greater than 0.00.
BillingEngine debit BillingEvent Creates a debit. Amount must be greater than 0.00.
Enterprise getBillingDay int Returns the day of the month billing occurs for this Enterprise.
Packet getBillingEngine BillingEngine Returns the billing engine for this Transaction. Throws exception if the Activation Key does not enable pal billing.
RuntimePal getBillingEngine BillingEngine Returns the billing engine for this Pal. Returns null if the Activation Key does not enable pal billing.
TransactionPacket getBillingEngine BillingEngine Returns the billing engine for this Transaction. Throws exception if the Activation Key does not enable pal billing.
BillingEvent getCreateDate Date Returns the date this event was created.
BillingEvent getData Data Returns all properties as a Data object.
BillingEvent getDescription String Returns description.
BillingEngine getEvent BillingEvent Returns the event with id.
BillingEngine getEvents SystemDataView Provides access to the billing event history
BillingEvent getId String Returns the event id.
PalActivationKeyInfo getMaxPageSize int Returns max page size of a dataset query.
BillingEvent getType String Returns the type.
BillingEvent isCredit boolean Returns true if credit.
BillingEvent isDebit boolean Returns true if debit.
PalActivationKeyInfo isPalBillingEnabled boolean Returns true if the key permits pal billing. See Pal.getBillingEngine().
AnalyticDataViewFilter setMaxPageSize DataViewCriteria Set the page size to the maximum allowed by the key.
DataViewCriteria setMaxPageSize DataViewCriteria Set the page size to the maximum allowed by the key.
DataViewFilter setMaxPageSize DataViewCriteria Set the page size to the maximum allowed by the key.
SystemDataViewFilter setMaxPageSize DataViewCriteria Set the page size to the maximum allowed by the key.
BillingEngine toString String Returns a description of this object.
BillingEvent toString String Returns a description of this object.
03-21-2013
Object Method Return Type Description
EncryptionUtil createAESKey String Creates an AES key of the specified length and returns the Base64 encoded raw value.
EncryptionUtil createNonce String Creates a nonce (AKA salt) of the specified length and returns the Base64 encoded raw value.
Formatter formatXMLDate String Returns the date in xsd:date compliant format in UTC. The format will be yyyy-MM-ddTHH:mm:ssZ
Formatter formatXMLDateString String Attempts to create a Date from the string then returns the date in xsd:date compliant format in UTC. The format will be yyyy-MM-ddTHH:mm:ssZ. Returns null if the date cannot be determined from the input string.
EncryptionUtil pSha1 String Creates P_SHA1 key with specifid length. See RFC 2246 section 5: HMAC and the pseudorandom function. Result is Base64 encoded.
ServiceRequest sign Completes the digital signature identified by signatureId.
02-01-2013
Object Method Return Type Description
TiffBuilder rotate TiffBuilder Rotates this image by an angle provided in degrees. Image rotated clockwise if angle is a positive number and counter-clockwise if angle is a negative number
01-28-2013
Object Method Return Type Description
TiffBuilder build File Creates a multi-page TIFF image. Underlying PDF page count is restricted by the cloud max pdf page count
PdfFile getTiffBuilder TiffBuilder Returns a new TiffBuilder for this PdfFile. Throws exception if the content is invalid.
TiffBuilder reset TiffBuilder Resets all settings
TiffBuilder setCompression TiffBuilder Sets the compression.
TiffBuilder setDPI TiffBuilder Sets the DPI of the file.
TiffBuilder setFilename TiffBuilder Set the name of the file.
TiffBuilder setGrayscale TiffBuilder Sets grayscale.
TiffBuilder setLittleEndian TiffBuilder Sets byte order to little endian.
TiffBuilder toString String Returns a description of this object.
01-16-2013
Object Method Return Type Description
MessageManager createMessage Message Creates a message. This message has no receiver or sender associated with it.
MessageManager createMessage Message Creates a message and associates it with the packet. This message has no receiver or sender associated with it.
Message deleteAttachment Deletes the attachment of this message.
Message getAttachment File Returns the attachment of this message, if any.
Message getMessage String Returns the message
Message getMessageType String Returns the message type
Message setAttachment Sets the attachment of this message.
Message setMessageType Sets the message type
01-11-2013
Object Method Return Type Description
Message getData Data Returns a Data of all this message's properties, except body
01-10-2013
Object Method Return Type Description
MessageManager createEnterpriseMessage Message Creates a message intended for the recipient profile associated with the specified enterprise and associates it with the packet. Returns null if no enterprise profile is found for the recipient. Sender profile is optional.
MessageManager createEnterpriseMessage Message Creates a message intended for the recipient profile associated with the specified enterprise. Returns null if no enterprise profile is found for the recipient. Sender profile is optional.
MessageManager createPersonalMessage Message Creates a message for the target recipient's personal profile. Sender profile is optional.
MessageManager createPersonalMessage Message Creates a message for the target recipient's personal profile and associated with the packet. Sender profile is optional.
MessageManager deleteMessage Deletes the specified message.
MessageManager deleteMessages int Deletes the specified messages.
MessageManager getMessage Message Returns the message identified by messageId. Returns null if message with specified id not found.
MessageManager getMessageInbox SystemDataView Returns messages where the profile is the recipient.
RuntimePal getMessageManager MessageManager Returns the job manager associated with this Pal.
MessageManager getMessages SystemDataView Returns all messages associated with this Pal.
MessageManager getMessagesSent SystemDataView Returns messages where the profile is the sender.
MessageManager getTransactionMessages SystemDataView Returns messages associated with the transaction.
MessageManager toString String Returns a description of this object.
01-07-2013
Object Method Return Type Description
JobManager createJob Job Creates a new job and immediately executes it.
Job getRunDate Date Returns the date the job ran or null if it has not yet ran.
Job getScheduleDate Date Returns the date the job is scheduled to run.
Job getStatus String Returns the job status. Status will be New, Finished, Queued, Running, Rescheduled, Error, Deleted, or Unknown
Job remove Removes this job from the job queue (deletes it) effective at the end of the workflow cycle.
12-21-2012
Object Method Return Type Description
DateUtil addSeconds Date Returns a new Date offset in seconds from the given date.
JobManager createJob Job Creates a new job and immediately executes it.
JobManager createJob Job Creates a new job.
JobManager deleteJob boolean Deletes the job with the specified id. Returns false if the job is not deleted. Jobs with a status of Running or Queued cannot be deleted. Jobs with a status of Running can be deleted if they are 'stuck' for an hour or more.
Job getId String Returns the job id. Max length is 30.
JobManager getJob Job Returns the job with the specified id.
RuntimePal getJobManager JobManager Returns the job manager associated with this Pal.
JobManager getJobs SystemDataView Returns a system dataview for accessing jobs.
Job getName String Returns the job name.
Job getPayload Payload Returns the payload for the job. This method always returns a non null payload, even if the payload itself has no data.
Job toString String Returns a description of this object.
JobManager toString String Returns a description of this object.
12-14-2012
Object Method Return Type Description
Validator isValidStateCode boolean Returns true if the state code is an acceptable format for the specified country. For example, 'UT' is a valid state for 'US' . (12/14/2012 - US and Canada support only)
12-03-2012
Object Method Return Type Description
Packet getProfileRole Role Returns the role matching profile and role. Returns null if not found.
TransactionPacket getProfileRole Role Returns the role matching profile and role. Returns null if not found.
Packet getUserRole Role Returns the role matching email and role. Returns null if not found.
TransactionPacket getUserRole Role Returns the role matching email and role. Returns null if not found.
11-28-2012
Object Method Return Type Description
ZoneAccess isWebEnabled boolean Returns true if this zone enables web access.
11-27-2012
Object Method Return Type Description
TransactionPacket changePal boolean Changes the Pal associated with the transaction. Creates an audit trail entry of the event.
11-23-2012
Object Method Return Type Description
AudioFile calcMD5 String Returns an MD5 checksum of the contents of this file.
DatasetFile calcMD5 String Returns an MD5 checksum of the contents of this file.
DocumentFile calcMD5 String Returns an MD5 checksum of the contents of this file.
ExcelFile calcMD5 String Returns an MD5 checksum of the contents of this file.
File calcMD5 String Returns an MD5 checksum of the contents of this file.
ImageFile calcMD5 String Returns an MD5 checksum of the contents of this file.
PdfFile calcMD5 String Returns an MD5 checksum of the contents of this file.
VCardFile calcMD5 String Returns an MD5 checksum of the contents of this file.
11-13-2012
Object Method Return Type Description
PdfFile getSpriteMap DataList Returns a DataList containing sprite coordinate information that can be used to create an HTML image map for the sprite. Call createSprite before calling this method.
11-09-2012
Object Method Return Type Description
RuntimePal getSmartDocManager SmartDocManager Returns the smart doc manager associated with the running Pal.
11-02-2012
Object Method Return Type Description
BusinessUtil getWizardPatterns DataList Returns validation patterns.
11-01-2012
Object Method Return Type Description
DataSetResult getError String Returns the generic error, if any.
ValidityCheck getError String Returns the generic error, if any.
Packet getFirstDocument Document Returns the first document in the Packet or null if there are no documents.
TransactionPacket getFirstDocument Document Returns the first document in the Packet or null if there are no documents.
Packet getLastDocument Document Returns the last document in the Packet or null if there are no documents.
TransactionPacket getLastDocument Document Returns the last document in the Packet or null if there are no documents.
DataSetResult getPage int When used with SmartDocuments, this returns the page number containing invalid data.
ValidityCheck getPage int When used with SmartDocuments, this returns the page number containing invalid data.
SmartDoc getPageCount int Returns the number of pages in the PDF.
SmartDoc getStatus String Returns the status of this smart doc.
SmartDoc setStatus Sets the status of this smart doc.
Document validate ValidityCheck Validates the data for the given Role. This method is used for SmartDocuments.
10-30-2012
Object Method Return Type Description
SmartDoc getSpriteMap DataList Returns a DataList containing sprite coordinate information that can be used to create an HTML image map for the sprite.
09-28-2012
Object Method Return Type Description
Buffer toText String Returns content of this buffer as text (removes any XML/HTML tags).
09-21-2012
Object Method Return Type Description
PdfFile createSprite ImageFile Creates a sprite image for the PDF. Restricted by max upload of the activation key and by the cloud max pdf page count.
09-19-2012
Object Method Return Type Description
Wizard getDialogValues String[] Returns the values associated with key and dialog if it exists, empty array otherwise. Used primarily for multi-select fields.
Wizard getValues String[] Returns the values associated with key if it exists, empty array otherwise. Used primarily for multi-select fields.
Document proxyClickSign Performs a proxy sign in behalf of the person identified by name. Name will appear in the signature rendering and an audit entry will be created indicating the signature was signed in behalf of the name. This should only be called on a single signature of type 'click'.
08-04-2012
Object Method Return Type Description
DataSetResult getErrors Data If validation fails, this returns the data along with the reason for failed validation. For example, if a column name is FirstName and it fails validation there will be an error message with key FirstNameError.
ValidityCheck getErrors Data If validation fails, this returns the data along with the reason for failed validation. For example, if a column name is FirstName and it fails validation there will be an error message with key FirstNameError.
DataSetResult getRecord DataSetRecord Returns the associated record- new or updated.
DataSet insert DataSetResult Creates a new record from the Data. If validation fails for any reason, no record is created.
DataSetResult isValid boolean Returns true if the data passes validation.
ValidityCheck isValid boolean Returns true if the data passes validation.
DataSetResult toString String Returns a description of this object.
ValidityCheck toString String Returns a description of this object.
DataSet update DataSetResult Updates the record, the Data object must contain the target record id. If validation fails for any reason, no record is updated.
DataSet validate ValidityCheck Validates the data against the DataSet validation rules and returns the result.
07-26-2012
Object Method Return Type Description
DataSet bulkInsert boolean Performs bulk insert of datalist into the dataset. If primary key value is present in the list it will insert it into the dataset. Duplicates will cause this method to return false and may result in partial commits. Use c.getError() to interpret failures.
06-28-2012
Object Method Return Type Description
Packet createDocument Document Adds a document using the SmartDoc. See also DisplaySettings.renderSmart. Note that this method will also merge the layer. If you intend to do secondary layer manipulation, don't use this method. Instead use addDocumentFromFile.
TransactionPacket createDocument Document Adds a document using the SmartDoc. See also DisplaySettings.renderSmart. Note that this method will also merge the layer. If you intend to do secondary layer manipulation, don't use this method. Instead use addDocumentFromFile.
SmartDoc createEmptyLayer Payload Creates a new empty Layer. Changes are not persistent. Use setLayer to save changes.
SmartDocManager createPalSmartDoc SmartDoc Creates a smart doc that is accessible to the Pal.
SmartDoc createPdfSprite ImageFile Creates (destroys any existing) a sprite image for the PDF.
SmartDocManager createPrivateSmartDoc SmartDoc Creates a smart doc that is accessible to the Pal and the active user's profile.
SmartDoc deleteOriginal Deletes the original
SmartDoc deletePdf Deletes the PDF.
SmartDocManager deletePrivateSmartDocs int Deletes all smart docs associated with the given profile.
SmartDocManager deleteSmartDoc Deletes the specified smart doc.
SmartDoc getCategory String Returns the category of this smart doc.
SmartDoc getData Data Returns information about the smart doc including details on sprit and the PDF (pageCount).
SmartDoc getDescription String Returns the description of this smart doc.
SmartDoc getId String Returns the ID of this smart doc.
SmartDoc getLayer Payload Returns the Layer. Changes are not persistent. Use setLayer to save changes.
Document getLayerPayload Payload Returns the layer as a non persistent Payload. To persist changes, call setLayerPayload.
SmartDoc getName String Returns the name of this smart doc.
SmartDoc getOriginal File Returns the content of the original file, which might be null.
SmartDocManager getPalSmartDocs SystemDataView Returns a view of smart docs associated with this Pal with access level=Pal.
SmartDoc getPdf PdfFile Returns the content of the PDF file, which might be null.
SmartDoc getPdfSprite ImageFile Returns the sprite image for the PDF if one exists.
SmartDocManager getPrivateSmartDocs SystemDataView Returns a view of smart docs associated with this Pal with access level=Private.
SmartDocManager getSmartDoc SmartDoc Returns the specified smart doc.
Document getSmartDocId String If this document was created from a Smart Document, this method returns the smart doc ID. See Packet.createDocument(SmartDoc,Data).
SmartDocManager getSmartDocs SystemDataView Returns a view of smart docs associated with this Pal regardless of access level.
Document mergeLayerPayload Merges the layer into the document. Throws exception if any signature has been signed.
SmartDoc setLayer Sets the Layer.
Document setLayerPayload Stores the payload layer with the document. Does not merge.
SmartDoc setOriginal Sets the content of the original file. Do not set the original file as a PDF.
SmartDoc setPdf Sets the content of the PDF.
SmartDoc toString String Returns a description of this object.
SmartDocManager toString String Returns a description of this object.
06-08-2012
Object Method Return Type Description
BusinessUtil getLanguages DataList Returns supported languages for this cloud.
BusinessUtil getTimezones DataList Returns a list of timezones for the US.
06-07-2012
Object Method Return Type Description
Document addFile Attachment HTML documents only. Adds the content of the given file to the document as a child of the element identified by targetId. If embed is true,it will attempt to embed the file-- meaning the contents of the file will be rendered by the browser as opposed to being presented as a download link. Future access to the attachment will be by unique name. Pass null for name to have a GUID automatically assigned. The description is what you should display to the user, it is the description of the attachment.
Data getValue String Returns the given value. Throws exception if the max length is exceeded or value is null/empty and allowEmpty=false.
05-29-2012
Object Method Return Type Description
Data isEmpty Boolean Returns true if there are no entries.
05-17-2012
Object Method Return Type Description
PacketDataList findRecord PacketDataRecord Finds the first record matching the given filter. Returns null if no matching record found.
PacketDataList findRecord DataRecord Finds the first record matching the given filter. Returns null if no matching record found.
05-14-2012
Object Method Return Type Description
Packet deleteDataLists Deletes all DataList objects in this packet.
TransactionPacket deleteDataLists Deletes all DataList objects in this packet.
Packet deleteDatas Deletes all Data objects in this packet.
TransactionPacket deleteDatas Deletes all Data objects in this packet.
Packet getDataLists DataList Returns a read-only DataList of all the DataList objects in this transaction.
TransactionPacket getDataLists DataList Returns a read-only DataList of all the DataList objects in this transaction.
Packet getDatas DataList Returns a read-only DataList of all the Data objects in this transaction.
TransactionPacket getDatas DataList Returns a read-only DataList of all the Data objects in this transaction.
05-10-2012
Object Method Return Type Description
Document isSignable boolean Returns true if the document has been presented to the user for signing. For this to be true, 1) the document must have been enabled for signing, and 2) the user must have submitted the action associated with signing.
04-30-2012
Object Method Return Type Description
DisplaySettings renderSmart Tells the rendering engine to display this document in 'smart' mode using the supplied Payload. Applies only to PDF documents. The default Data of the payload should contain edit data. Any lists in the payload will be used to populate select boxes, if any.
04-26-2012
Object Method Return Type Description
PdfFile getNativeLayer Payload Obtains the native layer for this PDF from the underlying content. Changes to this layer are not persisted.
04-19-2012
Object Method Return Type Description
Buffer toDataList PacketDataList Creates a PacketDataList from the buffer contents (expected a serialized JSON DataList). Targets the list identified by varName.
04-18-2012
Object Method Return Type Description
Data getSize Integer Returns the length of all keys and entries in this Data object. This is roughly the length of this object in bytes.
03-20-2012
Object Method Return Type Description
DownloadResponse setError Sets a message to display to the user. Use this when the desired response cannot be constructed. Set to null to remove error message.
03-12-2012
Object Method Return Type Description
Packet getData Data Returns information about this Packet.
TransactionPacket getData Data Returns information about this Packet.
03-02-2012
Object Method Return Type Description
Profile getPalManagerGroupSettings Data Returns Pal manager settings for the specified Group.
Profile getPalManagerPalSettings Data Returns Pal manager settings for the specified Pal.
Profile getTransactionManagerGroupSettings Data Returns transaction manager settings for the specified Group.
03-01-2012
Object Method Return Type Description
Archive getArchive File Returns the content of the archive.
ArchiveManager getArchive Archive Returns the archive specified by archiveId.
Archive getData Data Returns information about the archive.
Archive getId String Returns the ID of this archive (which is also the key on the remote system).
ArchiveManager isSystemArchiveEnabled boolean Returns true if this enterprise has system archive enabled
ArchiveManager scheduleArchive boolean Schedules the selected transaction packet for archive using the system storage provider. The enterprise must be enabled by the cloud owner for this feature to work. See isSystemArchiveEnabled. Test transactions not allowed.
ArchiveManager scheduleArchives int Schedules the selected transactions for archive using the system storage provider. See isSystemArchiveEnabled. Test transactions not allowed.
Archive toString String Returns a description of this object.
02-29-2012
Object Method Return Type Description
ArchiveManager cancelArchives int Cancels the scheduled archives and returns the number of successful results.
ArchiveManager deleteArchive boolean Deletes the archive record and remote file.
ArchiveManager getArchiveView SystemDataView Returns a view for accessing transactions that have been archived.
ArchiveManager getScheduledArchiveView SystemDataView Returns a view for accessing transactions that are scheduled for archiving.
ArchiveManager scheduleArchive boolean Schedules the selected transaction packet for archive using the specified storage provider.
ArchiveManager scheduleArchives int Schedules the selected transactions for archive using the specified storage provider.
ArchiveManager toString String Returns a description of this object.
02-17-2012
Object Method Return Type Description
PdfFile addPage Adds the page from the source PDF to this PDF at the specified location. Controlled by Max Export Size of activation key.
Document addPdfPage Adds the page from the source PDF to this PDF at the specified location. Controlled by Max Max Doc Size of activation key. Exception if not a PDF document or doc is tamper sealed.
Document appendPdf Appends the source PDF to this PDF. Controlled by Max Document Size of activation key. Exception if not a PDF document or doc is tamper sealed.
PdfFile appendPdf Appends the source PDF to this PDF. Controlled by Max Export Size of activation key.
Document deletePdfPage Deletes the specified page. Throws exception if this is not a PDF document or it has been tamper sealed.
StoredObject getIndexedMetadata String[] Returns metadata fields that should be indexed by storage provider, if supported
Document isSealed boolean Returns true if this is a PDF document and has been tamper sealed.
PdfFile isSealed boolean Returns true if this PDF has been tamper sealed.
StoredObject setIndexedMetadata Specifies metadata fields that should be indexed by storage provider, if supported
02-13-2012
Object Method Return Type Description
StorageProvider deleteObject Deletes objects from cloud storage
StorageProvider deleteObjects Deletes list of objects from cloud storage
StorageProvider downloadObject StoredObject Downloads object from cloud storage. Returns null if the object does not exist.
StoredObject getFile File Returns content of this object
StoredObject getKey String Returns key of this object
StoredObject getMetadata Data Returns metadata of this object
StorageProvider getName String Returns name of this provider
StorageProvider getType String Returns type of this provider
StoredObject setFile Sets content of this object
02-10-2012
Object Method Return Type Description
Enterprise getArchiveManager ArchiveManager Returns the transaction archive manager for the enterprise. The active user must have manageArchive permission for the group. Do not use * for group.
Enterprise getStorageProvider StorageProvider Returns storage provider registered for this enterprise.
Enterprise getStorageProviders DataList Returns list of storage provider names and types registered for this enterprise.
02-09-2012
Object Method Return Type Description
DateUtil parseDatetime Date Creates a date from the given string. String can be either integer value in milliseconds or in format MM-dd-yyyy or MM/dd/yyyy
02-07-2012
Object Method Return Type Description
EncryptionUtil base16toBase64 String Converts Base 16 encoded content into Base 64 encoded content
EncryptionUtil base64toBase16 String Converts Base 64 encoded content into Base 16 encoded content
EncryptionUtil md5 String Calculates MD5 digest for a file and returns it as Base64.
EncryptionUtil md5 String Calculates MD5 digest for a string and returns it as Base64.
EncryptionUtil sha1 String Calculates SHA1 digest for a string and returns it as Base64.
EncryptionUtil sha1 String Calculates SHA1 digest for a file and returns it as Base64.
EncryptionUtil toBase16 String Converts file content into Base 16 encoded content.
EncryptionUtil toBase16 String Converts string bytes into Base 16 encoded content
EncryptionUtil toBase64 String Converts file content into Base 64 encoded content.
EncryptionUtil toBase64 String Converts string bytes into Base 64 encoded content
01-13-2012
Object Method Return Type Description
Email setAccessConsoleLink boolean Creates a link that can be clicked from within the email that will provide access to a Console Pal associated with the specified ID.The user must belong to the enterprise and have the appropriate Console Pal permissions OR must have been granted access to the Console Pal. This method will error if the specified Pal is not a Console Pal.
Email setAnonymousAccessConsoleLink boolean Creates a link that can be clicked from within the email that will provide access to a Console Pal associated with the specified ID.The user will be granted access to the Console Pal with the personal profile upon successful authentication. This method will error if the specified Pal is not a Console Pal. By default, single use is set to true for security reasons. Additionally, new user email validation is set to true and we require the user account authenticating from the email to match the email address this was sent to. This means a profile or secondary email address of the user must match the email address this is sent to.
01-11-2012
Object Method Return Type Description
WebServiceRequest getClientAddress String Returns the IP Address of the client.
12-28-2011
Object Method Return Type Description
Validator isValidPhone boolean Returns true if the number is a valid phone number. If allow extension is true, everything after the letter 'x' (if present) must be a number.
12-22-2011
Object Method Return Type Description
Enterprise hasProfile boolean Returns true if enterprise has an active profile associated with the email address. This is a utility method that can be used to quickly determine if email is associated with profile
EnterpriseInfo hasProfile boolean Returns true if enterprise has an active profile associated with the email address. This is a utility method that can be used to quickly determine if email is associated with profile
ZoneAccess isImportTransactionAllowed boolean Checks import transaction permission
12-21-2011
Object Method Return Type Description
ShellPalManager getActivationKeys SystemDataView Returns a view for accessing activation keys for this enterprise that are shell pal compatible.
12-13-2011
Object Method Return Type Description
Profile toVCardFile VCardFile Exports this profile information to business card file. Profile information access permission rules apply
12-12-2011
Object Method Return Type Description
VCardFile getAdditionalNames String[] Returns contact's additional names
VCardFile getAddresses DataList Returns contact's addresses
VCardFile getBirthday Date Returns contact's birthday
VCardFile getData Data Returns data object with basic not-null properties from this business card
VCardFile getEmails DataList Returns contact's emails
VCardFile getExtendedProperty String Returns extended property (like X-JABBER, X-TWITTER, etc) for this VCard or null if not exists
VCardFile getFirstName String Returns contact's first name
VCardFile getGeoLocation String Returns latitude and longitude separated by semicolon. Returns null if geo-location is not available
VCardFile getLastName String Returns contact's last name
VCardFile getLogo ImageFile Returns contact's organization logo
VCardFile getName String Returns contact's name
VCardFile getNickname String Returns contact's nick name
VCardFile getNote String Returns notes and comments
VCardFile getOrganization String Returns contact's organization name or unit
VCardFile getPhoneNumbers DataList Returns contact's phone numbers
VCardFile getPhoto ImageFile Returns contact's photo
VCardFile getRole String Returns contact's role or occupation
VCardFile getTimeZone String Returns contact's time zone
VCardFile getTitle String Returns contact's job title
VCardFile getUID String Returns UID of this contact
VCardFile getUrl String Returns contact's home page URL
AudioFile toVCardFile VCardFile Returns VCard representation of this file. Returns invalid file if current file cannot be parsed as VCard
DatasetFile toVCardFile VCardFile Returns VCard representation of this file. Returns invalid file if current file cannot be parsed as VCard
DocumentFile toVCardFile VCardFile Returns VCard representation of this file. Returns invalid file if current file cannot be parsed as VCard
ExcelFile toVCardFile VCardFile Returns VCard representation of this file. Returns invalid file if current file cannot be parsed as VCard
File toVCardFile VCardFile Returns VCard representation of this file. Returns invalid file if current file cannot be parsed as VCard
ImageFile toVCardFile VCardFile Returns VCard representation of this file. Returns invalid file if current file cannot be parsed as VCard
PdfFile toVCardFile VCardFile Returns VCard representation of this file. Returns invalid file if current file cannot be parsed as VCard
VCardFile toVCardFile VCardFile Returns VCard representation of this file. Returns invalid file if current file cannot be parsed as VCard
12-01-2011
Object Method Return Type Description
Pal getReleaseNotes DataList Returns release notes for this pal
RuntimePal getReleaseNotes DataList Returns release notes for this pal
ShellPal getReleaseNotes DataList Returns release notes for this pal
11-30-2011
Object Method Return Type Description
Browser getClientAddress String Returns the IP Address of the client.
11-17-2011
Object Method Return Type Description
AudioFile copy File Returns a copy of the file
DocumentFile copy File Returns a copy of the file
ExcelFile copy File Returns a copy of the file
File copy File Returns a copy of the file
ImageFile copy File Returns a copy of the file
ImageFile copy ImageFile Returns a copy of the file
PdfFile copy File Returns a copy of the file
PdfFile copy ImageFile Returns a copy of the file
VCardFile copy File Returns a copy of the file
ImageFile getHeight int Returns image height
PdfFile getHeight int Returns image height
Packet getLastCycle Date Returns the date when Transaction System workflow will ran last.
TransactionPacket getLastCycle Date Returns the date when Transaction System workflow will ran last.
Packet getNextCycle Date Returns the date when Transaction System workflow will run next.
TransactionPacket getNextCycle Date Returns the date when Transaction System workflow will run next.
ImageFile getWidth int Returns image width
PdfFile getWidth int Returns image width
Packet isSystemError boolean Returns true if Transaction System workflow generated an error.
TransactionPacket isSystemError boolean Returns true if Transaction System workflow generated an error.
11-10-2011
Object Method Return Type Description
DataSet setDateTimeFormat Sets the date pattern for displaying dates with time.
DataView setDateTimeFormat Sets the date pattern for displaying dates with time.
SystemDataView setDateTimeFormat Sets the date pattern for displaying dates with time.
11-03-2011
Object Method Return Type Description
Formatter avg String Adds the number to internal counter and outputs the average. Returns null on failure.
Formatter dec String Decrements the internal counter by 1 and outputs the number. Returns null on failure.
Formatter inc String Increments the internal counter by 1 and outputs the number. Returns null on failure.
Formatter sum String Adds the number to internal counter and outputs the sum. Returns null on failure.
11-01-2011
Object Method Return Type Description
Profile getDepartment String Returns department name for this profile
Profile getDivision String Returns division name for this profile
Profile getSalesId String Returns Sales ID for this profile
10-31-2011
Object Method Return Type Description
Packet commit Typically changes to the packet are committed at the end of the workflow cycle. However, sometimes you need to commit before, in which case use this method. You should not use it more than once in a given workflow cycle.
TransactionPacket commit Typically changes to the packet are committed at the end of the workflow cycle. However, sometimes you need to commit before, in which case use this method. You should not use it more than once in a given workflow cycle.
ZoneAccess getPalTransactions SystemDataView Returns a SystemDataView that can be used for accessing transactions from any Pal in this zone. Requires transactionSystem permission and the chosen Pal must belong to this zone and pal to pal access.
10-21-2011
Object Method Return Type Description
PdfFile decrypt boolean Sets password for pdf decryption. Call this method before any other modification method if pdf file is password protected. Returns false if decryption fails.
PdfFile isEncrypted boolean Checks if this pdf file is password protected
10-20-2011
Object Method Return Type Description
ZoneAccess createTransaction TransactionPacket Creates new transaction. Transaction System must be enabled and if the palId is not for the running Pal, Pal to Pal must be enabled and the pals must both belong to this zone.
10-19-2011
Object Method Return Type Description
ImageFile rotate Rotates this image by an angle provided in degrees. Image rotated clockwise if angle is a positive number and counter-clockwise if angle is a negative number
PdfFile rotate Rotates this image by an angle provided in degrees. Image rotated clockwise if angle is a positive number and counter-clockwise if angle is a negative number
AudioFile toImage ImageFile Returns ImageFile created from this File. Method returns null if current file cannot be represented as an image. The file must already be a supported image content type to use this method. If you are trying convert a PDF to an image you should just get a specified page or use toTIFF to get a multi-page TIFF file.
DatasetFile toImage ImageFile Returns ImageFile created from this File. Method returns null if current file cannot be represented as an image. The file must already be a supported image content type to use this method. If you are trying convert a PDF to an image you should just get a specified page or use toTIFF to get a multi-page TIFF file.
DocumentFile toImage ImageFile Returns ImageFile created from this File. Method returns null if current file cannot be represented as an image. The file must already be a supported image content type to use this method. If you are trying convert a PDF to an image you should just get a specified page or use toTIFF to get a multi-page TIFF file.
ExcelFile toImage ImageFile Returns ImageFile created from this File. Method returns null if current file cannot be represented as an image. The file must already be a supported image content type to use this method. If you are trying convert a PDF to an image you should just get a specified page or use toTIFF to get a multi-page TIFF file.
File toImage ImageFile Returns ImageFile created from this File. Method returns null if current file cannot be represented as an image. The file must already be a supported image content type to use this method. If you are trying convert a PDF to an image you should just get a specified page or use toTIFF to get a multi-page TIFF file.
ImageFile toImage ImageFile Returns ImageFile created from this File. Method returns null if current file cannot be represented as an image. The file must already be a supported image content type to use this method. If you are trying convert a PDF to an image you should just get a specified page or use toTIFF to get a multi-page TIFF file.
PdfFile toImage ImageFile Returns ImageFile created from this File. Method returns null if current file cannot be represented as an image. The file must already be a supported image content type to use this method. If you are trying convert a PDF to an image you should just get a specified page or use toTIFF to get a multi-page TIFF file.
VCardFile toImage ImageFile Returns ImageFile created from this File. Method returns null if current file cannot be represented as an image. The file must already be a supported image content type to use this method. If you are trying convert a PDF to an image you should just get a specified page or use toTIFF to get a multi-page TIFF file.
10-11-2011
Object Method Return Type Description
Profile deleteProductAccess Deletes desktop product access to the Pal. Note- for non personal profiles, this deletes access but discovery is still controlled by group permissions.
Profile hasProductAccess boolean Returns true if the profile has been granted desktop product access to the Pal.
Profile setProductAccess boolean Grants or updates desktop product access to this pal. The user must have desktop product access enabled in security settings. If the profile is enterprise, the user must have user workflow access group permission. If this method returns false, check c.getError() to determine why.
09-26-2011
Object Method Return Type Description
PalActivationKeyInfo getEmailLimit int Returns max number of emails that workflow can send per run.
09-13-2011
Object Method Return Type Description
Packet cancelDelete Cancels deletion of the transaction.
TransactionPacket cancelDelete Cancels deletion of the transaction.
08-17-2011
Object Method Return Type Description
Fragment toFile File Renders this fragment into file using current fragment's state
08-15-2011
Object Method Return Type Description
Pal getPalScripts PacketDataList Returns list of scripts for this pal
RuntimePal getPalScripts PacketDataList Returns list of scripts for this pal
ShellPal getPalScripts PacketDataList Returns list of scripts for this pal
07-20-2011
Object Method Return Type Description
ShellPal isActive boolean Returns true if the Pal is active.
07-19-2011
Object Method Return Type Description
PdfFile getPage ImageFile Creates a PNG of the specified page.
PdfFile getPageCount int Returns the number of pages in this PDF.
07-15-2011
Object Method Return Type Description
ShellPal getConsoleProfileAccess String Returns the Console Profile access (E,P,PE,EP)
ShellPal setConsoleProfileAccess Sets the Console Profile Access. Choices are 'E' for Enterprise only, 'P' for Personal only, 'EP' for Enterprise first then Personal, 'PE' for Personal first then Enterprise. This property is used by the platform when it is not obvious which user profile to use when running a Console Pal.
07-13-2011
Object Method Return Type Description
PdfFile deletePage boolean Deletes the specified page. Returns false if the page cannot be deleted.
ZoneAccess getUserViewByGroup SystemDataView Returns a SystemDataView that can be used for accessing users of the enterprise that are associated with the specified group. Requires listUsers 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).
Pal isShell boolean Returns true if the Pal is a Shell Pal.
PalInfo isShell boolean Returns true if the Pal is a Shell Pal.
RuntimePal isShell boolean Returns true if the Pal is a Shell Pal.
ShellPal isShell boolean Returns true if the Pal is a Shell Pal.
07-12-2011
Object Method Return Type Description
ServiceResponse readAllTextData Data Creates data object by evaluating xpath expression on response body from first matching element using all descendant elements' names as keys and text nodes as values. Fails if response body is not xml.
XMLReader readAllTextData Data Creates data object by evaluating xpath expression on response body from first matching element using all descendant elements' names as keys and text nodes as values. Fails if response body is not xml.
07-04-2011
Object Method Return Type Description
AudioFile toPdf PdfFile Converts this file to PDF if possible. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
DatasetFile toPdf PdfFile Converts this file to PDF if possible. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
DocumentFile toPdf PdfFile Converts this file to PDF if possible. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
ExcelFile toPdf PdfFile Converts this file to PDF if possible. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
File toPdf PdfFile Converts this file to PDF if possible. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
ImageFile toPdf PdfFile Converts this file to PDF if possible. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
PdfFile toPdf PdfFile Converts this file to PDF if possible. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
VCardFile toPdf PdfFile Converts this file to PDF if possible. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
07-01-2011
Object Method Return Type Description
DataList bubble PacketDataList Performs an aggregation on the data elements of this list and returns a list suitable for use in bubble charts.
DataViewList bubble PacketDataList Performs an aggregation on the data elements of this list and returns a list suitable for use in bubble charts.
PacketDataList bubble PacketDataList Performs an aggregation on the data elements of this list and returns a list suitable for use in bubble charts.
StorageProviderDataList bubble PacketDataList Performs an aggregation on the data elements of this list and returns a list suitable for use in bubble charts.
06-29-2011
Object Method Return Type Description
Packet getSignedDocumentsByUser DataList Returns a DataList of all the documents in this transaction that have been signed by the specified user. See Profile.getUserId().
TransactionPacket getSignedDocumentsByUser DataList Returns a DataList of all the documents in this transaction that have been signed by the specified user. See Profile.getUserId().
Profile getUserId String Returns unique ID of the user associated with this profile. Returns null if profile is not registered.
ProfileInfo getUserId String Returns unique ID of the user associated with this profile. Returns null if profile is not registered.
06-27-2011
Object Method Return Type Description
BusinessUtil getFonts DataList Returns a list of fonts usable in creating an image. See Buffer.toImage.
06-24-2011
Object Method Return Type Description
TransactionWebServiceController createMobileLink String Creates link for mobile application
06-23-2011
Object Method Return Type Description
PdfFile createPdfTamperSeal boolean Creates a Digital Signature 'tamper seal' on this file. This should be called only once, when all data have been applied. Returns false if this method has already been applied to the file.
Pal getPdfDocument PdfFile Returns pdf document of this pal as File. Returns null if document with specified name is not available is not pdf document
RuntimePal getPdfDocument PdfFile Returns pdf document of this pal as File. Returns null if document with specified name is not available is not pdf document
ShellPal getPdfDocument PdfFile Returns pdf document of this pal as File. Returns null if document with specified name is not available is not pdf document
PdfFile hidePdfMenubar Adds viewer setting to not display its menu bar
PdfFile hidePdfToolbar Adds viewer setting to not display its toolbar
PdfFile hidePdfUI Adds viewer setting to not display its UI
PdfFile setData Updates pdf form fields with provided data. Note - further changes to data object are not reflected on document fields
Document softAudioSign boolean Signs the specified audio signature for the active user. Audit trail indicates a 'soft' sign. File must contain valid audio content. Role not required.
Document softImageSign boolean Signs the specified audio signature for the active user. Audit trail indicates a 'soft' sign. File must contain valid image content. Role not required.
Document softSign boolean Signs the specified signature for the active user. Audit trail indicates a 'soft' sign. Role not required.
06-16-2011
Object Method Return Type Description
Data trim Trims all of the values with leading and trailing whitespace, including non breaking spaces.
Formatter trimAll String Returns the value with leading and trailing whitespace removed, including non breaking spaces.
06-10-2011
Object Method Return Type Description
DisplaySettings setPrintStyleSheet boolean Sets the stylesheet (from the Pal) to be used any time this document is printed to PDF in the current session. Set this to null to remove it.
06-09-2011
Object Method Return Type Description
AnalyticDataViewFilter addBetweenDates DataViewCriteria Include records where column is between the two dates. Dates without a time value will be treated as midnight, so between 11-12-2008 and 11-13-2008 will return all entries on 11-12-2008. To include those for 11-13-2008 you would use 11-12-2008 and 11-14-2008 or 11-12-2008 and 11-13-2008 23:59.
DataViewCriteria addBetweenDates DataViewCriteria Include records where column is between the two dates. Dates without a time value will be treated as midnight, so between 11-12-2008 and 11-13-2008 will return all entries on 11-12-2008. To include those for 11-13-2008 you would use 11-12-2008 and 11-14-2008 or 11-12-2008 and 11-13-2008 23:59.
DataViewFilter addBetweenDates DataViewCriteria Include records where column is between the two dates. Dates without a time value will be treated as midnight, so between 11-12-2008 and 11-13-2008 will return all entries on 11-12-2008. To include those for 11-13-2008 you would use 11-12-2008 and 11-14-2008 or 11-12-2008 and 11-13-2008 23:59.
SystemDataViewFilter addBetweenDates DataViewCriteria Include records where column is between the two dates. Dates without a time value will be treated as midnight, so between 11-12-2008 and 11-13-2008 will return all entries on 11-12-2008. To include those for 11-13-2008 you would use 11-12-2008 and 11-14-2008 or 11-12-2008 and 11-13-2008 23:59.
AnalyticDataViewFilter addGreaterThanDate DataViewCriteria Include records where column is greater than the date.
DataViewCriteria addGreaterThanDate DataViewCriteria Include records where column is greater than the date.
DataViewFilter addGreaterThanDate DataViewCriteria Include records where column is greater than the date.
SystemDataViewFilter addGreaterThanDate DataViewCriteria Include records where column is greater than the date.
AnalyticDataViewFilter addGreaterThanEqualToDate DataViewCriteria Include records where column is greater than or equal to the date.
DataViewCriteria addGreaterThanEqualToDate DataViewCriteria Include records where column is greater than or equal to the date.
DataViewFilter addGreaterThanEqualToDate DataViewCriteria Include records where column is greater than or equal to the date.
SystemDataViewFilter addGreaterThanEqualToDate DataViewCriteria Include records where column is greater than or equal to the date.
AnalyticDataViewFilter addLessThanDate DataViewCriteria Include records where column is less than the date.
DataViewCriteria addLessThanDate DataViewCriteria Include records where column is less than the date.
DataViewFilter addLessThanDate DataViewCriteria Include records where column is less than the date.
SystemDataViewFilter addLessThanDate DataViewCriteria Include records where column is less than the date.
AnalyticDataViewFilter addLessThanEqualToDate DataViewCriteria Include records where column is less than or equal to the date.
DataViewCriteria addLessThanEqualToDate DataViewCriteria Include records where column is less than or equal to the date.
DataViewFilter addLessThanEqualToDate DataViewCriteria Include records where column is less than or equal to the date.
SystemDataViewFilter addLessThanEqualToDate DataViewCriteria Include records where column is less than or equal to the date.
Document insertImage Inserts image into document into specified target element
AnalyticDataViewFilter setDateFormat Sets the date pattern for date strings used in criteria.
DataViewCriteria setDateFormat Sets the date pattern for date strings used in criteria.
DataViewFilter setDateFormat Sets the date pattern for date strings used in criteria.
SystemDataViewFilter setDateFormat Sets the date pattern for date strings used in criteria.
06-08-2011
Object Method Return Type Description
DisplaySettings hideElement This method is used for hiding a section of the XHTML-based document from the active user during rendering. This should be used carefully because it could make your documents un-enforceable. The element must be a div or span.
Buffer toImage ImageFile Renders contents of this buffer as image
06-01-2011
Object Method Return Type Description
ShellPal getData Data Returns Data with top level information about this Pal.
Enterprise getDomains SystemDataView Returns a list of domains for this enterprise.
05-31-2011
Object Method Return Type Description
Buffer addDataList Buffer Adds the DataList to this Buffer for subsequent JEXL rendering (see render() or toFile()).
Buffer removeTags Buffer Removes html tags from buffer content. Optionally can separate block elements with specified block separator string
Buffer render String Renders the content (requires well-formed XHTML), injecting dynamic content into the output. See Buffer.addDataList, Buffer.appendFragment, etc.
05-25-2011
Object Method Return Type Description
FtpRequest changeFolder boolean Changes to the specified folder.
FtpRequest connect boolean Connects using the specified parameters. This method is a convenience method for development purposes. For security best practices, don't store remote server credentials in the Pal.
FtpRequest connect boolean Connects using a pre-configured FTP/FTPS/SFTP Connector.
TransactionWebServiceController createFtpRequest FtpRequest Creates real-time FTP/FTPS/SFTP request object useful for communication with an external FTP service. Requires activation key with Remote Services enabled.
FtpRequest deleteFile boolean Deletes the specified file.
FtpRequest disconnect Terminates the connection.
FtpRequest getCurrentFolder String Returns current directory
PalActivationKeyInfo getEmailExpirePeriod int Returns the email expiration period in weeks.
FtpRequest getFile File Gets the specified file.
FtpRequest getFiles File[] Gets the specified files in the current directory (limit = max files to retrieve).
PalActivationKeyInfo getTxJobExpirePeriod int Returns the transaction job expiration period in weeks.
PalActivationKeyInfo isHeadlessEnabled boolean Returns true if headless access to Console/Navigator is permitted.
PalActivationKeyInfo isRemoteServiceEnabled boolean Returns true if remote service calls (web service and ftp) is permitted.
PalActivationKeyInfo isShellPalsEnabled boolean Returns true if shell pals is permitted.
PalActivationKeyInfo isWebEmailEnabled boolean Returns true if web email is permitted.
FtpRequest listFiles DataList Lists the files and folders in this folder. Type will be 'file' or 'folder'.
FtpRequest putFile boolean Puts the specified file in the current remote directory. 4MB is the minimum limit. Files over 4MB are controlled by the activation key max export setting.
FtpRequest toString String Returns a description of this object.
05-24-2011
Object Method Return Type Description
Pal getReadme String Returns the Readme for this Pal or null if there is not one. This method does not chain or inherit the Readme content from elsewhere.
RuntimePal getReadme String Returns the Readme for this Pal or null if there is not one. This method does not chain or inherit the Readme content from elsewhere.
ShellPal getReadme String Returns the Readme for this Pal or null if there is not one. This method does not chain or inherit the Readme content from elsewhere.
05-19-2011
Object Method Return Type Description
Payload getData Data Returns data object from this payload data maps. Note that changes to data object has no effect on payload. You will need to add data again to update payload
Payload getDataList PacketDataList Returns data list object from this payload data lists. Note that changes to data list object has no effect on payload. You will need to add data list again to update payload
Data toFile File Converts this data object to file. Expected entries: filename - contains file name, contentType - contains file content type, base64 - contains base64 encoded file contents OR plain - contains plain text content of the file
05-18-2011
Object Method Return Type Description
Packet assignEnterpriseRole Role Add a user to the transaction. Give the user the specified role. Require the user to have a profile on the specified Enterprise. Returns null if the user does not have a profile on the specified enterprise. Also returns null if there is not an account associated with the specified email.
TransactionPacket assignEnterpriseRole Role Add a user to the transaction. Give the user the specified role. Require the user to have a profile on the specified Enterprise. Returns null if the user does not have a profile on the specified enterprise. Also returns null if there is not an account associated with the specified email.
Packet assignPersonalRole Role Add a user to the transaction. Give the user the specified role and associate the user's personal profile with the role if a user exists with the given email. If not, it will return a virtual Role. When the virtual user logs in for the first time (from a link, etc.) the role/personal profile would be associated with the new user.
TransactionPacket assignPersonalRole Role Add a user to the transaction. Give the user the specified role and associate the user's personal profile with the role if a user exists with the given email. If not, it will return a virtual Role. When the virtual user logs in for the first time (from a link, etc.) the role/personal profile would be associated with the new user.
Packet assignRole Role Assigns the role to the specified user profile.
TransactionPacket assignRole Role Assigns the role to the specified user profile.
Packet getEnterpriseRoles SystemDataView Returns a SystemDataView that can be used to list users who have the given role and belong to the specified enterprise. Pass * as the role to get all users.
TransactionPacket getEnterpriseRoles SystemDataView Returns a SystemDataView that can be used to list users who have the given role and belong to the specified enterprise. Pass * as the role to get all users.
Packet getRole Role Returns the (first) Role with the given role. Safe use of this method is situations where only one user will have the specified role.
Role getRole String Returns the role name.
TransactionPacket getRole Role Returns the (first) Role with the given role. Safe use of this method is situations where only one user will have the specified role.
Packet getRoleByEmail Role Returns the Role associated with this transaction and the given email.
TransactionPacket getRoleByEmail Role Returns the Role associated with this transaction and the given email.
Packet getRoles Role[] Returns an array of Roles with the given role. Pass * as the role to get all Roles.
TransactionPacket getRoles Role[] Returns an array of Roles with the given role. Pass * as the role to get all Roles.
Role getStatus String Returns the role status.
Role isActive boolean Returns true if this role is the active role for the user.
Role revoke Removes the role from the associated user. You should not attempt to use this Role once it has been revoked.
Role setActive Sets this role to be the active role for the user.
Role setStatus Sets the role status.
05-17-2011
Object Method Return Type Description
ZoneAccess getTransaction TransactionPacket Returns the specified TransactionPacket. Requires transactionSystem permission and the TransactionPacket must be accessible from a pal in this zone.
ZoneAccess isSecuredTxEnabled boolean Returns true if this zone enables secured tx access.
05-16-2011
Object Method Return Type Description
TransactionWebServiceController createPayload Payload Creates a new Payload object from the JSON encoded string. See Payload.toJson().
AudioFile encrypt File Returns a new file with the content of this file PGP encrypted. The new file's filename will be existing filename+.txt
DatasetFile encrypt File Returns a new file with the content of this file PGP encrypted. The new file's filename will be existing filename+.txt
DocumentFile encrypt File Returns a new file with the content of this file PGP encrypted. The new file's filename will be existing filename+.txt
ExcelFile encrypt File Returns a new file with the content of this file PGP encrypted. The new file's filename will be existing filename+.txt
File encrypt File Returns a new file with the content of this file PGP encrypted. The new file's filename will be existing filename+.txt
ImageFile encrypt File Returns a new file with the content of this file PGP encrypted. The new file's filename will be existing filename+.txt
PdfFile encrypt File Returns a new file with the content of this file PGP encrypted. The new file's filename will be existing filename+.txt
VCardFile encrypt File Returns a new file with the content of this file PGP encrypted. The new file's filename will be existing filename+.txt
Enterprise getConnectors SystemDataView Lists connectors for this enterprise. Active user must have manageServices permission.
Packet getSecuredTxStatus String Returns the secured status.
TransactionPacket getSecuredTxStatus String Returns the secured status.
Packet isSecuredTx boolean Returns true if this is a secured transaction.
TransactionPacket isSecuredTx boolean Returns true if this is a secured transaction.
Packet removeSecuredTxStatus Removes the secured status, making this no longer a secured transaction.
TransactionPacket removeSecuredTxStatus Removes the secured status, making this no longer a secured transaction.
Packet setSecuredTxStatus Sets the secured status.
TransactionPacket setSecuredTxStatus Sets the secured status.
Buffer toBinaryFile File Returns the Base64 content of this Buffer as a File with the specified name and content type. Exception if the buffer content is not Base64 or does not match the contentType.
AudioFile toData Data Returns the content of this file as a Data object with three properties: fileName, contentType, and base64. base64 will be a Base64 encoded string of the file contents.
DatasetFile toData Data Returns the content of this file as a Data object with three properties: fileName, contentType, and base64. base64 will be a Base64 encoded string of the file contents.
DocumentFile toData Data Returns the content of this file as a Data object with three properties: fileName, contentType, and base64. base64 will be a Base64 encoded string of the file contents.
ExcelFile toData Data Returns the content of this file as a Data object with three properties: fileName, contentType, and base64. base64 will be a Base64 encoded string of the file contents.
File toData Data Returns the content of this file as a Data object with three properties: fileName, contentType, and base64. base64 will be a Base64 encoded string of the file contents.
ImageFile toData Data Returns the content of this file as a Data object with three properties: fileName, contentType, and base64. base64 will be a Base64 encoded string of the file contents.
PdfFile toData Data Returns the content of this file as a Data object with three properties: fileName, contentType, and base64. base64 will be a Base64 encoded string of the file contents.
VCardFile toData Data Returns the content of this file as a Data object with three properties: fileName, contentType, and base64. base64 will be a Base64 encoded string of the file contents.
Payload toJson String Returns this Payload object as a JSON encoded string using web service compatible structure.
Packet toPayload Payload Extracts the properties, Data, and DataLists of this transaction packet as a Payload object. Changes are not saved.
TransactionPacket toPayload Payload Extracts the properties, Data, and DataLists of this transaction packet as a Payload object. Changes are not saved.
05-11-2011
Object Method Return Type Description
Packet toFile File Extracts the transaction packet XML along with all documents, attachments and wizards and wraps with a digital signature 'tamper seal'. An audit entry is recorded whenever this method is called. If encrypt is true, password is required and the contents will be PGP encrypted with the password. Note that this method has a 4MB packet size limit unless called from system workflow. Beware there is a considerable amount of public and private information in the contents of a transaction packet. Use this method with discretion. See Controller.getErrors() for any failures.
TransactionPacket toFile File Extracts the transaction packet XML along with all documents, attachments and wizards and wraps with a digital signature 'tamper seal'. An audit entry is recorded whenever this method is called. If encrypt is true, password is required and the contents will be PGP encrypted with the password. Note that this method has a 4MB packet size limit unless called from system workflow. Beware there is a considerable amount of public and private information in the contents of a transaction packet. Use this method with discretion. See Controller.getErrors() for any failures.
05-10-2011
Object Method Return Type Description
Attachment toFile File Returns contents of this attachment as file object
05-04-2011
Object Method Return Type Description
Profile deleteMobileAccess Deletes mobile access to the Pal. Note- for non personal profiles, this deletes access but discovery is still controlled by group permissions.
Profile hasMobileAccess boolean Returns true if the profile has been granted mobile access to the Pal.
Profile setMobileAccess boolean Grants or updates mobile access to this pal. The user must have mobile access enabled in security settings. The Pal must be mobile enabled. If the profile is not enterprise, the user must have user workflow access group permission.
04-29-2011
Object Method Return Type Description
PalActivationKeyInfo isPalEmailAccountEnabled boolean Returns true if pal email account functionality is permitted.
04-22-2011
Object Method Return Type Description
Email setUtilityReference Sets the utility billing reference for this email. This is a development feature.
04-18-2011
Object Method Return Type Description
ShellPal commit Saves all pending changes to shell pal and releases pal lock
ShellPal getConsoleSystemWorkflow String Returns default console system workflow or null if not set
ShellPal getConsoleWebServiceWorkflow String Returns default console web service workflow or null if not set
ShellPal getConsoleWorkflow String Returns default console workflow or null if not set
Pal getPalWorkflows PacketDataList Returns a list of workflow files defined in this Pal.
RuntimePal getPalWorkflows PacketDataList Returns a list of workflow files defined in this Pal.
ShellPal getPalWorkflows PacketDataList Returns a list of workflow files defined in this Pal.
ShellPal getTransactionSystemWorkflow String Returns default transaction system workflow or null if not set
ShellPal getTransactionWebServiceWorkflow String Returns default transaction web service workflow or null if not set
ShellPal getTransactionWorkflow String Returns default transaction workflow or null if not set
ShellPal getUserWebServiceWorkflow String Returns default user web service workflow or null if not set
ShellPal getWebWorkflow String Returns default web workflow or null if not set
ShellPal isAuditDocumentView boolean Returns true if document view audit is enabled
ShellPal isConsolePalControlled boolean Returns true if console control flag is enabled
ShellPal isFirstInChain boolean Checks whether this pal always has priority in chain lookup
ShellPal isGroupAccessOnly boolean Returns true group access enabled
ShellPal isLocked boolean Returns true if pal is locked and modifications to pal allowed
ShellPal isMobile boolean Checks whether this pal enabled for mobile applications
ShellPal isShowInConsole boolean Checks whether this pal is visible in console
ShellPal lock boolean Obtains a lock on shell pal
ShellPal rollback Discards all pending changes and releases pal lock
ShellPal setAuditDocumentView Enables or disables documents view audit
ShellPal setConsolePalControlled Sets console control flag on this pal
ShellPal setConsoleSystemWorkflow Sets default console system workflow
ShellPal setConsoleWebServiceWorkflow Sets default console web service workflow
ShellPal setConsoleWorkflow Sets default console workflow
ShellPal setFirstInChain Enables or disables chain lookup priority override
ShellPal setGroupAccessOnly Restricts pal to group access
ShellPal setMobile Enables or disables this pal for mobile applications. Note that enabling mobile discovery actually delegates mobile features to first pal in associated pal chain
ShellPal setShowInConsole Sets console visibility for the pal
ShellPal setTransactionSystemWorkflow Sets default transaction system workflow
ShellPal setTransactionWebServiceWorkflow Sets default transaction web service workflow
ShellPal setTransactionWorkflow Sets default transaction workflow
ShellPal setUserWebServiceWorkflow Sets default user web service workflow
ShellPal setWebWorkflow Sets default web service workflow
04-14-2011
Object Method Return Type Description
Pal getChainId String Returns the pal's chain id, if is using a PalChain.
PalInfo getChainId String Returns the pal's chain id, if is using a PalChain.
RuntimePal getChainId String Returns the pal's chain id, if is using a PalChain.
ShellPal getChainId String Returns the pal's chain id, if is using a PalChain.
PalActivationKeyInfo getId String Returns the ID of the key
04-12-2011
Object Method Return Type Description
DataListFilter isNotValid Adds validation filter criteria. Records that are valid according to specified validator type will be removed from data list
DataListFilter isValid Adds validation filter criteria. Records that are valid according to specified validator type will be retained in data list
04-08-2011
Object Method Return Type Description
Pal getPalEmails PacketDataList Returns list of emails for this pal
RuntimePal getPalEmails PacketDataList Returns list of emails for this pal
ShellPal getPalEmails PacketDataList Returns list of emails for this pal
Pal getPalStyles PacketDataList Returns list of styles for this pal
RuntimePal getPalStyles PacketDataList Returns list of styles for this pal
ShellPal getPalStyles PacketDataList Returns list of styles for this pal
Formatter getRandomEasyNumber String Returns a random number sequence including numbers 2-9 of size length. Maximum length is 50, minimum is 1.
Formatter getRandomEasyNumber String Returns a random number sequence including numbers 2-9 of size length. Maximum length is 50, minimum is 1.
Formatter getRandomNumber String Returns a random number sequence including numbers 0-9 of size length. Maximum length is 50, minimum is 1.
Formatter getRandomNumber String Returns a random number sequence including numbers 0-9 of size length. Maximum length is 50, minimum is 1.
ShellPal isConsoleHeadless boolean Returns true if console configured as headless
ShellPal isNavigatorHeadless boolean Returns true if navigator configured as headless
04-07-2011
Object Method Return Type Description
ShellPal setHeadlessMode Sets headless mode for this shell pal
04-04-2011
Object Method Return Type Description
ShellPalManager activateShellPal Activates (enables changes) shell pal by id which shell pal must be associated with the running admin pal
ShellPal addGroup Associates this pal with group. This method silently ignored if pal is already associated with specified group
ShellPal addOrReplaceEmail boolean Adds or replaces email template in this Pal
ShellPal addOrReplaceImage boolean Adds or replaces image in this Pal
ShellPal addOrReplaceStyle boolean Adds or replaces style in this Pal
ShellPalManager cloneShellPal ShellPal Creates a new shell pal from the existing one
ShellPalManager createShellPal ShellPal Creates new shell pal
ShellPal deleteAttachment Deletes attachment from shell pal
ShellPal deleteDocument Deletes document from shell pal
ShellPal deleteEmail Deletes email template from shell pal
ShellPal deleteImage Deletes image from shell pal
ShellPalManager deleteShellPal boolean Attempts to delete shell pal by id which shell pal must be associated with the running admin pal. Returns false if the shell pal has any dependencies (transactions, etc). Use c.getError() to see reason for failure.
ShellPal deleteStyle Deletes style from shell pal
ShellPalManager exportShellPal File Exports shell pal to file
ShellPal getConsoleIcon String Returns console icon name for this pal
ShellPal getConsoleLabel String Returns console label for this pal
Pal getDocument File Returns document of this pal as File. Returns null if document with specified name is not available
RuntimePal getDocument File Returns document of this pal as File. Returns null if document with specified name is not available
ShellPal getDocument File Returns document of this pal as File. Returns null if document with specified name is not available
Pal getEmail File Returns email of this pal as File. Returns null if template with specified name is not available
RuntimePal getEmail File Returns email of this pal as File. Returns null if template with specified name is not available
ShellPal getEmail File Returns email of this pal as File. Returns null if template with specified name is not available
Pal getImage ImageFile Returns image of this pal as File. Returns null if image with specified name is not available
RuntimePal getImage ImageFile Returns image of this pal as File. Returns null if image with specified name is not available
ShellPal getImage ImageFile Returns image of this pal as File. Returns null if image with specified name is not available
ShellPalManager getShellPal ShellPal Returns specified shell pal by id which shell pal must be associated with the running admin pal
ShellPalManager getShellPals SystemDataView Returns list of shell pals created by this controlling pal
Pal getStyle File Returns style of this pal as File. Returns null if style with specified name is not available
RuntimePal getStyle File Returns style of this pal as File. Returns null if style with specified name is not available
ShellPal getStyle File Returns style of this pal as File. Returns null if style with specified name is not available
ShellPalManager importShellPal ShellPal Imports shell pal from file
ShellPalManager inactivateShellPal Inactivates (disables changes) shell pal by id which shell pal must be associated with the running admin pal
ShellPal removeGroup Removes group association for this pal. This method silently ignored if pal is not associated with specified group
ShellPal setCategory Sets new category for this pal
ShellPal setConsoleIcon Sets console icon for this pal
ShellPal setConsoleLabel Sets console label for this pal
ShellPal setDescription Sets new description for this pal
ShellPal setName Sets new name for this pal
ShellPal setPalChain Re-attaches this Pal to different Pal chain. Throws exception if chain does not exist.
04-01-2011
Object Method Return Type Description
Formatter formatFullCurrency String Formats the given string to currency notation. Preserves full decimal places up to 9 places to the right.
ShellPal getAccessToken String Returns Navigator access token for this Pal
Document getBillingReference String Returns the billing reference associated with the execution fee for this Document. Deployed Documents only.
ShellPal setActivationKey Sets activation key for this Pal
Document setBillingReference Sets the billing reference associated with the execution fee for this Document. Deployed Documents only.
03-28-2011
Object Method Return Type Description
DisplaySettings alertSignatureInfo This method is used for displaying signature details on small form-factor (mobile) devices that are otherwise not capable of displaying the normal information for signatures.For mobile devices, by default this is true. This method is ignored for non-mobile browsers.
03-19-2011
Object Method Return Type Description
Pal getGroups DataList Returns a DataList of all groups this pal is a member of.
RuntimePal getGroups DataList Returns a DataList of all groups this pal is a member of.
ShellPal getGroups DataList Returns a DataList of all groups this pal is a member of.
03-02-2011
Object Method Return Type Description
Profile isOwnedBy boolean Returns true if the Enterprise owns this profile.
02-25-2011
Object Method Return Type Description
DataListFilter addIsNotNull Return records where column value is not null.
DataListFilter addIsNull Return records where column value is null.
02-24-2011
Object Method Return Type Description
Wizard isCurrent boolean Returns true if all of the wizard dialogs have corresponding presentation in the Pal.
Wizard rebuildFromPal Clears all information in the wizard, both data and dialog history. If preserve is true an attempt is made to preserve data and dialog history. All dialogs in the wizard after the first dialog that do not have a matching dialog in the pal are dropped along with associated data, if any. Warning: this may adversely impact the data and functionality of the wizard.
PieChart setDataList Sets input for the chart from datalist. Category column contains values for category labels. Value column should contain numeric data. Color column can contain color for chart section.
02-17-2011
Object Method Return Type Description
TransactionWebServiceController getEnterprise Enterprise Returns the enterprise associated with the running Pal.
Packet getOwner EnterpriseInfo Returns the enterprise that owns the Transaction.
TransactionPacket getOwner EnterpriseInfo Returns the enterprise that owns the Transaction.
02-16-2011
Object Method Return Type Description
DataList getColumns DataList Returns the column names of this DataList as a DataList.
DataViewList getColumns DataList Returns the column names of this DataList as a DataList.
PacketDataList getColumns DataList Returns the column names of this DataList as a DataList.
StorageProviderDataList getColumns DataList Returns the column names of this DataList as a DataList.
02-11-2011
Object Method Return Type Description
TransactionWebServiceController createEmail Email Creates an Email container using the specified template and specified enterprise email settings.
02-07-2011
Object Method Return Type Description
Packet assignEnterpriseRole Role Verifies the profile is enterprise then assigns the specified role. Returns null if the profile is not enterprise.
TransactionPacket assignEnterpriseRole Role Verifies the profile is enterprise then assigns the specified role. Returns null if the profile is not enterprise.
Packet assignPersonalRole Role Assigns the role to the personal profile associated with the user who owns the given profile (which may or may not be personal).
TransactionPacket assignPersonalRole Role Assigns the role to the personal profile associated with the user who owns the given profile (which may or may not be personal).
Packet getUserRoles SystemDataView Returns a SystemDataView that can be used to list users who have the given role. Pass * as the role to get all users.
TransactionPacket getUserRoles SystemDataView Returns a SystemDataView that can be used to list users who have the given role. Pass * as the role to get all users.
02-01-2011
Object Method Return Type Description
PacketDataList renameColumn Renames the specified column.
PacketDataList renameColumns Renames all of the columns. The column length must match the existing number of columns.
01-20-2011
Object Method Return Type Description
DataList sublist PacketDataList Creates a new PacketDataList from this DataList with the range of records specified. Returns an empty list if no more records within the range.
DataViewList sublist PacketDataList Creates a new PacketDataList from this DataList with the range of records specified. Returns an empty list if no more records within the range.
PacketDataList sublist PacketDataList Creates a new PacketDataList from this DataList with the range of records specified. Returns an empty list if no more records within the range.
StorageProviderDataList sublist PacketDataList Creates a new PacketDataList from this DataList with the range of records specified. Returns an empty list if no more records within the range.
01-14-2011
Object Method Return Type Description
Document rollbackSignatures Resets all signatures in the document to the new/unsigned state and creates an audit trail for the event.
12-24-2010
Object Method Return Type Description
Document proxySign Performs a proxy sign in behalf of the person identified by name. Name will appear in the signature rendering and an audit entry will be created indicating the signature was signed in behalf of the name. File should be of MPEG or AMR audio type. Recording length validated against activation key constraints. This should only be called on a single signature of type audio.
12-13-2010
Object Method Return Type Description
PalActivationKeyInfo getMaxUploadSize int Returns the max allowed upload size in kilobytes.
12-01-2010
Object Method Return Type Description
Packet disableSystemWorkflow boolean Disables/cancels execution of system workflow. If there is no system workflowassociated with this Pal, calling this method is quietly ignored.
TransactionPacket disableSystemWorkflow boolean Disables/cancels execution of system workflow. If there is no system workflowassociated with this Pal, calling this method is quietly ignored.
ZoneAccess disableTransactionSystemWorkflow int Cancels transaction system workflow for the specified transactions. Returns the number successfully cancelled.
ZoneAccess enableTransactionSystemWorkflow int Enables (schedules two minutes from time of method call) transaction system workflow for the specified transactions. Returns the number successfully scheduled.
ZoneAccess isTransactionSystemEnabled boolean Returns true if this zone enables transaction system access.
Packet schedule boolean Schedules the system workflow to run on the given date. Returns false if the given date is more than 5 minutes in the past or exceeds the access period of the transaction or if system workflow is not enabled by the activation key.
TransactionPacket schedule boolean Schedules the system workflow to run on the given date. Returns false if the given date is more than 5 minutes in the past or exceeds the access period of the transaction or if system workflow is not enabled by the activation key.
ZoneAccess scheduleTransactionSystemWorkflow int Schedules transaction system workflow for the specified transactions. Returns the number successfully scheduled.
11-29-2010
Object Method Return Type Description
WebServiceResponse createDownloadPayload DownloadResponse Creates a download object for the payload response.
WebServiceResponse createPayload Payload Creates a payload object for the payload response.
Profile isDefaultProfile boolean Returns true if this profile is the default profile for the user.
ProfileInfo isDefaultProfile boolean Returns true if this profile is the default profile for the user.
Profile isSystem boolean Returns true if this profile is a system profile.
ProfileInfo isSystem boolean Returns true if this profile is a system profile.
11-19-2010
Object Method Return Type Description
Document toPdf PdfFile Exports this document to PDF file optionally including/excluding any audio signatures.
11-10-2010
Object Method Return Type Description
Formatter getValidSigningRole String Returns a valid role for signing purposes. Roles have a size and content restriction. If role is empty, this returns the String 'role'. A valid signing role is alpha-numeric with zero or more of the following characters (including space): @.-_${}. Keep in mind, a JEXL role requires a JEXL rendering cycle to translate and may result in an error if you don't provide the translation. See Packet.addDocument(String,Data).
11-09-2010
Object Method Return Type Description
DownloadResponse addDataRecord boolean Registers the DataRecord in the response with the specified id. Limited to 500 records per response.
Email addDataRecord boolean Registers the DataRecord in the response with the specified id. Limited to 500 records per response.
Fragment addDataRecord boolean Registers the DataRecord in the response with the specified id. Limited to 500 records per response.
Payload addDataRecord boolean Registers the DataRecord in the response with the specified id. Limited to 500 records per response.
Render addDataRecord boolean Registers the DataRecord in the response with the specified id. Limited to 500 records per response.
TextEmail addDataRecord boolean Registers the DataRecord in the response with the specified id. Limited to 500 records per response.
DataViewRecord appendSystem boolean Joins the SystemDataView to this record on columnAlias. Use systemReference in subsequent DataViewRecord.get(String,String) calls to access the SystemDataView columns.
DataViewRecord getSystemData Data Returns the information in the SystemDataView. See appendSystem.
11-08-2010
Object Method Return Type Description
Document setData Immediately sets the document field values for those fields referenced in Data. If this is a PDF document with checkboxes, any checkbox not referenced in the Data is unchecked.
11-05-2010
Object Method Return Type Description
TransactionWebServiceController createServiceRequest ServiceRequest Creates real-time http(s) request object useful for communication with external web services. Requires activation key with Remote Services enabled.
11-03-2010
Object Method Return Type Description
Email setLoginPage boolean Sets the login page for the returning email. Returns false if the login page does not exist or if the Pal does not support custom login screens. Use null to set the default login page.
11-02-2010
Object Method Return Type Description
Profile getCellPhone String Returns the cell phone of the user associated with this profile.
Profile getCellPhoneProvider String Returns the cell phone provider of the user associated with this profile.
DataList toFile File Creates csv/pipe/tab delimited file from data list. File will reflect current datalist state. Further modifications of datalist will not have effect on file contents. File limit is controlled by the max data export size of the activation key.
DataViewList toFile File Creates csv/pipe/tab delimited file from data list. File will reflect current datalist state. Further modifications of datalist will not have effect on file contents. File limit is controlled by the max data export size of the activation key.
PacketDataList toFile File Creates csv/pipe/tab delimited file from data list. File will reflect current datalist state. Further modifications of datalist will not have effect on file contents. File limit is controlled by the max data export size of the activation key.
StorageProviderDataList toFile File Creates csv/pipe/tab delimited file from data list. File will reflect current datalist state. Further modifications of datalist will not have effect on file contents. File limit is controlled by the max data export size of the activation key.
Render toPdf PdfFile Creates PDF file. File will reflect current Render state. Further modifications of Render will not have effect on file contents.
11-01-2010
Object Method Return Type Description
Buffer addData Buffer Adds the Data to this Buffer for subsequent JEXL rendering (see toString() or toFile()).
Buffer addDataMap Buffer Adds the Data to this Buffer with the given id for subsequent JEXL rendering (see toString() or toFile()).
Buffer addDataMaps Buffer Extracts the records from the list and registers them in the Buffer using the values in the key column. Limited to 500 records.
Pal getScript String Returns the content of the script file as a string. See Response.addJavascript.
RuntimePal getScript String Returns the content of the script file as a string. See Response.addJavascript.
ShellPal getScript String Returns the content of the script file as a string. See Response.addJavascript.
Buffer setValue Buffer Adds the key/value pair to the Buffer, over-writing any set that already exists with name key.
Buffer toFile File Returns the content of this Buffer as a File with the specified name. The fileName must have a text-based extension.
10-29-2010
Object Method Return Type Description
DataViewBuilder getCriteria DataViewCriteria Returns the criteria for the specified DataSet in view. Dataset with such alias must have already been included.
DataSet getStorageSize double Returns the size of the DataSet in MB.
10-27-2010
Object Method Return Type Description
SystemDataView isAppendSupported boolean Returns true if this system view can be joined to pal level datasets.
10-26-2010
Object Method Return Type Description
DataSetRecord appendSystem boolean Joins the SystemDataView to this record on columnAlias. Use systemReference in subsequent DataViewRecord.get(String,String) calls to access the SystemDataView columns.
DataViewBuilder appendSystem DataViewBuilder Joins the SystemView to this view on columnAlias. Use systemAlias in subsequent DataViewRecord.get calls to access the SystemDataView columns. For example, db.appendSystem(view,'sys','profileId') would be accessed by ${rec.get('sys','firstName')}. Note, this does not permit filtering on SystemDataView columns.
DataSetRecord get String Returns the column value from the system table. See DataViewBuilder.appendSystem()
DataViewRecord get String Returns the column value from the system table. See DataViewBuilder.appendSystem()
PagingInfo get String Returns the specified value from the PagingInfo data.
ZoneAccess getConsoleUsers SystemDataView Returns a SystemDataView that can be used for accessing users of the enterprise who have console access to this pal. Requires listUsers permission.
ZoneAccess getData Data Returns zone information.
ZoneAccess getEnterprisePals SystemDataView Returns a SystemDataView that can be used for accessing pals of the enterprise. Requires listPals permission.
ZoneAccess getPalById RuntimePal Returns the Pal for the specified palId. Requires palToPal permission and both pals must be in this zone.
PagingInfo getQueryString String Returns all non default properties (those you've added to Data) as a querystring.
PagingInfo getQueryString String Returns all non default properties (those you've added to Data) as a querystring with action and pageNumber information.
DataSetRecord getSystemData Data Returns the information in the SystemDataView. See appendSystem.
ZoneAccess getUsers SystemDataView Returns a SystemDataView that can be used for accessing users of the enterprise.
RuntimePal getZoneAccess ZoneAccess Returns the ZoneAccess for this Pal. If Web access is not enabled for the zone, this method will return null in web workflow.
ZoneAccess getZonePals SystemDataView Returns a SystemDataView that can be used for accessing pals of the enterprise that belong to this zone. Requires listPals permission.
ZoneAccess isEnabled boolean Returns true if the zone is enabled.
ZoneAccess isListGroupsEnabled boolean Returns true if listing of enterprise groups is enabled.
ZoneAccess isListPalsEnabled boolean Returns true if listing of enterprise pals is enabled.
ZoneAccess isListUsersEnabled boolean Returns true if listing of enterprise users is enabled.
ZoneAccess isPalToPalEnabled boolean Returns true if this zone enables pal to pal access.
ZoneAccess toString String Returns a description of this object.
10-22-2010
Object Method Return Type Description
Email addChart boolean Adds chart to email. Note - only server charts supported (created using ChartTool) otherwise exception occurs
Email addFile boolean Attaches the file to the email as an attachment.
Email enableDeliveryStatus Enables delivery status for this email. This method requires inbound email configured if SMTP settings are configured for current enterprise or a DSN Cloud Subscription Service. When delivery status received, this email job will be marked as "delivered" or "failed"
Email getAttachmentCount int Returns the number of attachments to this email.
Email getAttachmentSize int Returns the size of the attachment payload in KB.
DatasetFile getFileHandle String Returns the file handle for this file.
Email removeAttachments Removes the attachments, if any.
Email schedule Schedules the email to be sent after the specified date.
Email sendToAddress String Sends the email to the specified email address and returns the email job id. This will return the word 'BLOCKED' if the email is on the system block list.
Email sendToAddresses Sends the email to the specified addresses.
Email setReplyTo Sets the replyTo email address. Pass null to remove the replyTo.
Email setSubject Sets the subject of the email (over-rides the subject set during Pal development).
Email toString String Returns a description of this object.
10-21-2010
Object Method Return Type Description
DatasetFile copy File Returns a copy of the file
DataSetRecord deleteFile Deletes file contents from specified dataset column. This operation has immediate effect and cannot be undone
DatasetFile getCreateDate Date Returns creation date of this file
DatasetFile getCreatedBy ProfileInfo Returns information about profile that created this file
DataSetRecord getFile DatasetFile Retrieves file contents from specified dataset column. Returns null of no contents have been set for this record
DatasetFile getModifiedBy ProfileInfo Returns information about the last profile that modified this file
DatasetFile getModifiedDate Date Returns date of last modification of this file
DataSetRecord setFile Sets dataset file contents from provided file. This operation requires subsequent call of DataSet.insertRecord() if this record is new record or DataSet.updateRecord() if this record is existing record to persist
10-19-2010
Object Method Return Type Description
DataViewCriteria sortAscending DataViewCriteria Sorts the results in ascending order on the given column.
DataViewCriteria sortDescending DataViewCriteria Sorts the results in descending order on the given column.
DataViewBuilder unionDistinct DataViewBuilder Constructs a distinct union and returns this. Subsequent calls to this builder are now against the additional DataSets to be added to the union. Field names from all included views must be in the same order and of the same type.
10-18-2010
Object Method Return Type Description
Browser isMobile boolean Returns true if the OS is determined to be a mobile operating system.
10-11-2010
Object Method Return Type Description
AnalyticDataViewFilter addAnd DataViewCriteria Adds an AND operator to the query.
DataViewCriteria addAnd DataViewCriteria Adds an AND operator to the query.
DataViewFilter addAnd DataViewCriteria Adds an AND operator to the query.
SystemDataViewFilter addAnd DataViewCriteria Adds an AND operator to the query.
AnalyticDataViewFilter addBetween DataViewCriteria Include records where column is between and includes the two constraints. The values will be cast to the correct type. The behavior depends on the type of data being operated on. Dates without a time value will be treated as midnight, so between 11-12-2008 and 11-13-2008 will return all entries on 11-12-2008. To include those for 11-13-2008 you would use 11-12-2008 and 11-14-2008 or 11-12-2008 and 11-13-2008 23:59. For string comparisons, between 'A' and 'C' would include 'A', 'B', and 'C' but not 'D'. For numbers, the end points are also inclusive: between 1 and 5 will return 1,2,3,4 and 5 but not 6.
DataViewCriteria addBetween DataViewCriteria Include records where column is between and includes the two constraints. The values will be cast to the correct type. The behavior depends on the type of data being operated on. Dates without a time value will be treated as midnight, so between 11-12-2008 and 11-13-2008 will return all entries on 11-12-2008. To include those for 11-13-2008 you would use 11-12-2008 and 11-14-2008 or 11-12-2008 and 11-13-2008 23:59. For string comparisons, between 'A' and 'C' would include 'A', 'B', and 'C' but not 'D'. For numbers, the end points are also inclusive: between 1 and 5 will return 1,2,3,4 and 5 but not 6.
DataViewFilter addBetween DataViewCriteria Include records where column is between and includes the two constraints. The values will be cast to the correct type. The behavior depends on the type of data being operated on. Dates without a time value will be treated as midnight, so between 11-12-2008 and 11-13-2008 will return all entries on 11-12-2008. To include those for 11-13-2008 you would use 11-12-2008 and 11-14-2008 or 11-12-2008 and 11-13-2008 23:59. For string comparisons, between 'A' and 'C' would include 'A', 'B', and 'C' but not 'D'. For numbers, the end points are also inclusive: between 1 and 5 will return 1,2,3,4 and 5 but not 6.
SystemDataViewFilter addBetween DataViewCriteria Include records where column is between and includes the two constraints. The values will be cast to the correct type. The behavior depends on the type of data being operated on. Dates without a time value will be treated as midnight, so between 11-12-2008 and 11-13-2008 will return all entries on 11-12-2008. To include those for 11-13-2008 you would use 11-12-2008 and 11-14-2008 or 11-12-2008 and 11-13-2008 23:59. For string comparisons, between 'A' and 'C' would include 'A', 'B', and 'C' but not 'D'. For numbers, the end points are also inclusive: between 1 and 5 will return 1,2,3,4 and 5 but not 6.
AnalyticDataViewFilter addEqual DataViewCriteria Include records where column equals value. The value will be cast to the correct type.
DataViewCriteria addEqual DataViewCriteria Include records where column equals value. The value will be cast to the correct type.
DataViewFilter addEqual DataViewCriteria Include records where column equals value. The value will be cast to the correct type.
SystemDataViewFilter addEqual DataViewCriteria Include records where column equals value. The value will be cast to the correct type.
AnalyticDataViewFilter addGreaterThan DataViewCriteria Include records where column is greater than the value. The values will be cast to the correct type.
DataViewCriteria addGreaterThan DataViewCriteria Include records where column is greater than the value. The values will be cast to the correct type.
DataViewFilter addGreaterThan DataViewCriteria Include records where column is greater than the value. The values will be cast to the correct type.
SystemDataViewFilter addGreaterThan DataViewCriteria Include records where column is greater than the value. The values will be cast to the correct type.
AnalyticDataViewFilter addGreaterThanEqualTo DataViewCriteria Include records where column is greater than or equal to the value. The values will be cast to the correct type.
DataViewCriteria addGreaterThanEqualTo DataViewCriteria Include records where column is greater than or equal to the value. The values will be cast to the correct type.
DataViewFilter addGreaterThanEqualTo DataViewCriteria Include records where column is greater than or equal to the value. The values will be cast to the correct type.
SystemDataViewFilter addGreaterThanEqualTo DataViewCriteria Include records where column is greater than or equal to the value. The values will be cast to the correct type.
AnalyticDataViewFilter addIsNull DataViewCriteria Include records where column specified is null
DataViewCriteria addIsNull DataViewCriteria Include records where column specified is null
DataViewFilter addIsNull DataViewCriteria Include records where column specified is null
SystemDataViewFilter addIsNull DataViewCriteria Include records where column specified is null
AnalyticDataViewFilter addLessThan DataViewCriteria Include records where column is less than the value. The values will be cast to the correct type.
DataViewCriteria addLessThan DataViewCriteria Include records where column is less than the value. The values will be cast to the correct type.
DataViewFilter addLessThan DataViewCriteria Include records where column is less than the value. The values will be cast to the correct type.
SystemDataViewFilter addLessThan DataViewCriteria Include records where column is less than the value. The values will be cast to the correct type.
AnalyticDataViewFilter addLessThanEqualTo DataViewCriteria Include records where column is less than or equal to the value. The values will be cast to the correct type.
DataViewCriteria addLessThanEqualTo DataViewCriteria Include records where column is less than or equal to the value. The values will be cast to the correct type.
DataViewFilter addLessThanEqualTo DataViewCriteria Include records where column is less than or equal to the value. The values will be cast to the correct type.
SystemDataViewFilter addLessThanEqualTo DataViewCriteria Include records where column is less than or equal to the value. The values will be cast to the correct type.
AnalyticDataViewFilter addLike DataViewCriteria Include records where column is like the value. The value will be cast to the correct type.
DataViewCriteria addLike DataViewCriteria Include records where column is like the value. The value will be cast to the correct type.
DataViewFilter addLike DataViewCriteria Include records where column is like the value. The value will be cast to the correct type.
SystemDataViewFilter addLike DataViewCriteria Include records where column is like the value. The value will be cast to the correct type.
AnalyticDataViewFilter addNotEqual DataViewCriteria Include records where column is not equal to the value. The value will be cast to the correct type.
DataViewCriteria addNotEqual DataViewCriteria Include records where column is not equal to the value. The value will be cast to the correct type.
DataViewFilter addNotEqual DataViewCriteria Include records where column is not equal to the value. The value will be cast to the correct type.
SystemDataViewFilter addNotEqual DataViewCriteria Include records where column is not equal to the value. The value will be cast to the correct type.
AnalyticDataViewFilter addNotLike DataViewCriteria Include records where column is not like the value. The value will be cast to the correct type.
DataViewCriteria addNotLike DataViewCriteria Include records where column is not like the value. The value will be cast to the correct type.
DataViewFilter addNotLike DataViewCriteria Include records where column is not like the value. The value will be cast to the correct type.
SystemDataViewFilter addNotLike DataViewCriteria Include records where column is not like the value. The value will be cast to the correct type.
AnalyticDataViewFilter addNotNull DataViewCriteria Include records where column specified is not null
DataViewCriteria addNotNull DataViewCriteria Include records where column specified is not null
DataViewFilter addNotNull DataViewCriteria Include records where column specified is not null
SystemDataViewFilter addNotNull DataViewCriteria Include records where column specified is not null
AnalyticDataViewFilter addOr DataViewCriteria Adds an OR operator to the query.
DataViewCriteria addOr DataViewCriteria Adds an OR operator to the query.
DataViewFilter addOr DataViewCriteria Adds an OR operator to the query.
SystemDataViewFilter addOr DataViewCriteria Adds an OR operator to the query.
AnalyticDataViewFilter beginGroup DataViewCriteria Begins a group of statements.
DataViewCriteria beginGroup DataViewCriteria Begins a group of statements.
DataViewFilter beginGroup DataViewCriteria Begins a group of statements.
SystemDataViewFilter beginGroup DataViewCriteria Begins a group of statements.
AnalyticDataViewFilter endGroup DataViewCriteria Ends a group of statements.
DataViewCriteria endGroup DataViewCriteria Ends a group of statements.
DataViewFilter endGroup DataViewCriteria Ends a group of statements.
SystemDataViewFilter endGroup DataViewCriteria Ends a group of statements.
AnalyticDataViewFilter setFirstRecord DataViewCriteria Set the first record to return.
DataViewCriteria setFirstRecord DataViewCriteria Set the first record to return.
DataViewFilter setFirstRecord DataViewCriteria Set the first record to return.
SystemDataViewFilter setFirstRecord DataViewCriteria Set the first record to return.
AnalyticDataViewFilter setPageSize DataViewCriteria Set the page size (max 1000 or limit controlled by the activation key, min 1, default 100). See also setMaxPageSize.
DataViewCriteria setPageSize DataViewCriteria Set the page size (max 1000 or limit controlled by the activation key, min 1, default 100). See also setMaxPageSize.
DataViewFilter setPageSize DataViewCriteria Set the page size (max 1000 or limit controlled by the activation key, min 1, default 100). See also setMaxPageSize.
SystemDataViewFilter setPageSize DataViewCriteria Set the page size (max 1000 or limit controlled by the activation key, min 1, default 100). See also setMaxPageSize.
DataViewCriteria toString String Returns a description of this object.
10-07-2010
Object Method Return Type Description
PacketDataList addJSONDataList Decodes the JSON serialized DataList and adds it to this DataList.
TransactionWebServiceController createDataList PacketDataList Creates a new non persistent PacketDataList and returns it. Maximum column size is 100.
TransactionWebServiceController createPayload Payload Creates a new Payload object.
Pal getConsoleLoginUrl String Returns the console login url for this Pal.
PalInfo getConsoleLoginUrl String Returns the console login url for this Pal.
RuntimePal getConsoleLoginUrl String Returns the console login url for this Pal.
ShellPal getConsoleLoginUrl String Returns the console login url for this Pal.
BusinessUtil getTextMessagingProviders DataList Returns a list of standard SMS providers (cell phone carriers that ContractPal supports SMS communication with).
10-06-2010
Object Method Return Type Description
Browser createBrowser Browser Returns a new Browser object based on the user-agent string supplied. Used for testing site compatibility with different useragents.
10-05-2010
Object Method Return Type Description
DataViewBuilder toString String Returns a description of this object.
10-01-2010
Object Method Return Type Description
Formatter encodeURI String Does a URI encoding on the supplied value.
09-29-2010
Object Method Return Type Description
DataViewBuilder appendColumn DataViewBuilder Appends the specified runtime column with default value. The DataSet must have already been included and the alias cannot conflict with any other alias. Returns this.
DataViewBuilder concatColumn DataViewBuilder Adds the column to the concatination sequence. Returns this.
DataViewBuilder concatText DataViewBuilder Adds the text to the concatination sequence. Returns this.
DataViewBuilder distinct DataViewBuilder Enable/disable distinct records and returns this.
DataSet encryptColumn int Encrypts the values in the specified column and returns the number or rows modified. This may have to be called multiple times to repair all rows (max 1000 rows per call). The specified column must be of type Encrypt. This is a utility method to be used when DataSet modifications have resulted in unencrypted columns. This method returns 0 when no more unencrypted records are found.
DataViewBuilder endConcat DataViewBuilder Ends the concatination sequence and adds the entire sequence referenced by columnAlias. Returns this.
DataSet getRecords DataViewList Creates a default filter and returns the first 100 records.
DataView getRecords DataViewList Creates a default filter and returns the first 100 records.
DataViewBuilder includeColumn DataViewBuilder Includes the specified column. System columns must be aliased with a different name. The DataSet must have already been included. Returns this.
DataViewBuilder includeColumns DataViewBuilder Includes all non system columns from the specified DataSet. The DataSet must have already been included. Returns this.
DataViewBuilder includeDataSet DataViewBuilder Includes the specified DataSet. Returns this.
DataViewBuilder includeDataSet DataViewBuilder Includes the specified DataSet. Returns this.
DataViewBuilder innerJoin DataViewBuilder Creates an inner join (all from both DataSets that match) on the two DataSets and specified columns. Both DataSets must have already been included. Returns this.
DataViewBuilder leftJoin DataViewBuilder Creates a left join (all records from left and matching records from right) on the two DataSets and specified columns. Both DataSets must have already been included. Returns this.
DataViewBuilder reset DataViewBuilder Clears all settings so this builder can be re-used to create a new DataView and returns this.
DataViewBuilder startConcat DataViewBuilder Begins a column concatination sequence. After calling this method you must make one or more calls to concatColumn followed by endConcat. The DataSet must have already been included. Returns this.
DataViewBuilder toDataView DataView Converts this builder to a DataView which can then be queried.
DataViewBuilder union DataViewBuilder Constructs a union and returns this. Subsequent calls to this builder are now against the additional DataSets to be added to the union. Field names from all included views must be in the same order and of the same type.
09-27-2010
Object Method Return Type Description
ServiceRequest echo If enabled, this tells the ServiceRequest to bundle the request and submit to itself. Credentials are masked. This is used for troubleshooting requests so developers can analyze the payload and headers being sent.
09-10-2010
Object Method Return Type Description
Buffer lf Buffer Appends a line feed to the buffer and returns the buffer.
Buffer quote Buffer Appends a quote to the buffer and returns the buffer.
08-30-2010
Object Method Return Type Description
DataSetRecord getData Data Returns the JSON serialized content of the specified column as a Data object.
DataSetRecord getDataList PacketDataList Returns the JSON serialized content of the specified column as a Data object.
Data getJSON String Returns the value of the specified key as unescaped JSON.
DataSetRecord getPayload Payload Returns the JSON serialized content of the specified column as a Payload object.
DataSetRecord setData boolean Sets the value of the specified column as a serialized JSON object. Returns false if the column does not exist.
DataSetRecord setDataList boolean Sets the value of the specified column as a serialized JSON object. Returns false if the column does not exist.
DataSetRecord setPayload boolean Sets the value of the specified column as a serialized JSON object. Returns false if the column does not exist.
Buffer toDataList PacketDataList Creates a PacketDataList from the buffer contents (expected a serialized JSON DataList). See DataList.toJSON. If you pass null or empty for name, the datalist name will be what is already contained in the serialized JSON. Otherwise, the list will get the new name you provide.
Data toJSON String Returns contents as a JSON string.
DataList toJSON String Returns contents as a JSON string.
DataViewList toJSON String Returns contents as a JSON string.
PacketDataList toJSON String Returns contents as a JSON string.
StorageProviderDataList toJSON String Returns contents as a JSON string.
08-27-2010
Object Method Return Type Description
ServiceRequest createServicePayload XMLReader Creates an XMLReader from the contents of the file. This is primarily used for testing or re-analyzing a stored response. The file must be XML.
ServiceRequest createServicePayload XMLReader Creates an XMLReader from the contents of the attachment. This is primarily used for testing or re-analyzing a stored response. The attachment must be XML.
DownloadResponse setAttachmentContent Sets the attachment as the content for this download response.
08-26-2010
Object Method Return Type Description
Packet getEmailJobs SystemDataView Returns list of email jobs for this transaction.
TransactionPacket getEmailJobs SystemDataView Returns list of email jobs for this transaction.
Payload loadJSON Decodes the JSON string (presumably a serialized Payload object) and adds its content to this Payload.
Payload toJSON String Returns this Payload object as a JSON encoded string.
08-25-2010
Object Method Return Type Description
MailResponse getAttachments File[] Returns list of attachments for this email
MailResponse getBody String Returns body of email. Can be null if email has not text body
MailResponse getCC String[] Returns list of CC addresses for email. Can be empty if there is no CC for this email
MailResponse getContentType String Returns content type of email body
MailResponse getDeliveryAction String Returns delivery status action reported by MTA. This method has effect only for delivery status messages.
MailResponse getFrom String Returns sender's address
MailResponse getHeaderNames String[] Returns list of email header names
MailResponse getHeaderValue String Returns email header value for specified header. If specified header has several values, this is the first value. This method is shortcut for getHeaderValues('header')[0]
MailResponse getHeaderValues String[] Returns list of email header values for specified header
MailResponse getSubject String Returns subject of email
MailResponse getTo String[] Returns list of recipient addresses for this email.
MailResponse isDelivered boolean Returns whether message was delivered or not. This method has effect only for delivery status messages. Note that result of delivery can be inaccurate if MTA reports with non-standard action in delivery status. You can use getDeliveryAction() to handle such situations
MailResponse isFailure boolean Returns true if the MTA report is failure. See getDeliveryAction for report.
MailResponse isRelayed boolean Returns true if the MTA report is relay. See getDeliveryAction for report.
MailResponse isTextBody boolean Returns true if email has text body, false otherwise
ServiceRequest setAuthenticationPreemptive Enables preemptive authentication mode. In this mode ServiceRequest will send the basic authentication even before the server gives an unauthorized response in certain situations, thus reducing the overhead of making the connection. This method has effect only if authentication is controlled by ServiceRequest (true by default), see setSendAuthorization()
MailResponse toString String Returns a description of this object
08-24-2010
Object Method Return Type Description
Buffer appendFile Buffer Appends the file content to this buffer and returns the buffer. If the file is not text, the contents are appended as base64.
Buffer appendFragment Buffer Appends the xhtml content of the fragment to this buffer and returns the buffer.
Buffer toDocumentFragment Fragment Creates a Fragment from the buffer content. The content must be well-formed xhtml and be comprised of legal content for a document fragment. Returns null if the content does not conform. If the content is not well-formed and tidy is true, we will attempt to clean it up. The content type should be html, txt, or xml.
Buffer toPageFragment Fragment Creates a Fragment from the buffer content. The content must be well-formed xhtml. If the content is not well-formed and tidy is true, we will attempt to clean it up. The content type should be html, txt, or xml. Returns null if the content cannot be parsed.
08-23-2010
Object Method Return Type Description
Pal getAjaxFragment Fragment Returns the specified fragment with the intention of using the fragment in an ajax response.
RuntimePal getAjaxFragment Fragment Returns the specified fragment with the intention of using the fragment in an ajax response.
ShellPal getAjaxFragment Fragment Returns the specified fragment with the intention of using the fragment in an ajax response.
Pal getChartFragment Fragment Returns the specified fragment with the intention of using the fragment for rendering a chart. Presumably the content is SVG. See also Fragment.toImage()
RuntimePal getChartFragment Fragment Returns the specified fragment with the intention of using the fragment for rendering a chart. Presumably the content is SVG. See also Fragment.toImage()
ShellPal getChartFragment Fragment Returns the specified fragment with the intention of using the fragment for rendering a chart. Presumably the content is SVG. See also Fragment.toImage()
Pal getDocumentAsFragment Fragment Returns the specified document as a fragment.
RuntimePal getDocumentAsFragment Fragment Returns the specified document as a fragment.
ShellPal getDocumentAsFragment Fragment Returns the specified document as a fragment.
Pal getDocumentFragment Fragment Returns the specified fragment with the intention of using the fragment in a document. See Document.addFragment.
RuntimePal getDocumentFragment Fragment Returns the specified fragment with the intention of using the fragment in a document. See Document.addFragment.
ShellPal getDocumentFragment Fragment Returns the specified fragment with the intention of using the fragment in a document. See Document.addFragment.
Pal getExportFragment Fragment Returns the specified fragment with the intention of using it for an export.
RuntimePal getExportFragment Fragment Returns the specified fragment with the intention of using it for an export.
ShellPal getExportFragment Fragment Returns the specified fragment with the intention of using it for an export.
Pal getServiceFragment Fragment Returns the specified fragment with the intention of using it for a ServiceRequest.
RuntimePal getServiceFragment Fragment Returns the specified fragment with the intention of using it for a ServiceRequest.
ShellPal getServiceFragment Fragment Returns the specified fragment with the intention of using it for a ServiceRequest.
Fragment getType String Returns the type of fragment: common,web,console,transaction,export,store,service,document,runtime,head
Pal hasFragment boolean Returns true if the specified fragment exists.
RuntimePal hasFragment boolean Returns true if the specified fragment exists.
ShellPal hasFragment boolean Returns true if the specified fragment exists.
08-13-2010
Object Method Return Type Description
ShellPal isReadonly boolean Returns true if properties are read only.
08-11-2010
Object Method Return Type Description
AnalyticDataViewFilter dateDiff Returns the difference in days between the value of the two date columns.
DownloadResponse setFileContent Sets the file as the content for this download response.
DownloadResponse setFragmentContent Sets the fragment as the content for this download response.
AnalyticDataViewFilter timeDiff Returns the difference in unit between the value of the two datetime columns.
DownloadResponse toString String Returns a description of this object.
07-21-2010
Object Method Return Type Description
ServiceRequest submitUsingConnector ServiceResponse Submits request using connector settings defined for enterprise. Allows to redefine url for submit. Url can be absolute or relative. Relative urls are appended to the connector url.
07-20-2010
Object Method Return Type Description
Payload addJavascript boolean Adds javascript commands to the payload (assumes the payload will be added to a page or ajax response, otherwise has no meaning). Returns false for illegal or empty script.
DownloadResponse addPayload Adds the payload to this response.
Email addPayload Adds the payload to this response.
Fragment addPayload Adds the payload to this response.
Payload addPayload Adds the payload to this response.
Render addPayload Adds the payload to this response.
TextEmail addPayload Adds the payload to this response.
Payload toString String Returns a description of this object.
07-16-2010
Object Method Return Type Description
Pal getPalWizards PacketDataList Returns list of wizards for this pal
RuntimePal getPalWizards PacketDataList Returns list of wizards for this pal
ShellPal getPalWizards PacketDataList Returns list of wizards for this pal
07-14-2010
Object Method Return Type Description
AnalyticDataViewFilter enableDecrypt Decrypts values of encrypted columns. This has a performance impact, especially for large lists.
DataViewFilter enableDecrypt Decrypts values of encrypted columns. This has a performance impact, especially for large lists.
SystemDataViewFilter enableDecrypt Decrypts values of encrypted columns. This has a performance impact, especially for large lists.
AnalyticDataViewFilter isDecryptEnabled boolean Returns true if decryption is enabled.
DataViewFilter isDecryptEnabled boolean Returns true if decryption is enabled.
SystemDataViewFilter isDecryptEnabled boolean Returns true if decryption is enabled.
07-08-2010
Object Method Return Type Description
Packet createDataList PacketDataList Creates a new persistent DataList and returns it. Maximum column name size is 1000 and max column count is 300. Quietly over-rides any existing DataList with the same name. Column names cannot be null or empty.
TransactionPacket createDataList PacketDataList Creates a new persistent DataList and returns it. Maximum column name size is 1000 and max column count is 300. Quietly over-rides any existing DataList with the same name. Column names cannot be null or empty.
Packet getOrCreateDataList PacketDataList Creates a new persistent DataList and returns it. Maximum column name size is 1000 and max column count is 300. If a DataList with the same name already exists, the existing list will be returned but no check is made regarding column names. Column names cannot be null or empty.
TransactionPacket getOrCreateDataList PacketDataList Creates a new persistent DataList and returns it. Maximum column name size is 1000 and max column count is 300. If a DataList with the same name already exists, the existing list will be returned but no check is made regarding column names. Column names cannot be null or empty.
07-01-2010
Object Method Return Type Description
Formatter formatCurrencyAsWords String Formats the currency as words (ex: 32.50 converts to thirty two dollars and fifty cents)
Formatter formatNumber String Returns the given number as comma-formatted string to the specified decimal places.
Formatter getNumberAsOrdinal String Converts number to ordinal value. (ex: 2 converts to '2nd')
Formatter getNumberAsWord String Converts number to word. (ex: 123 converts to 'one hundred twenty three')
Formatter toGigaBytes String Returns the given number (bytes) as gigabytes to the specified decimal places.
Formatter toKiloBytes String Returns the given number (bytes) as kilobytes to the specified decimal places.
Formatter toMegaBytes String Returns the given number (bytes) as megabytes to the specified decimal places.
06-24-2010
Object Method Return Type Description
Formatter formatEIN String Formats a 9 digit EIN. (ex: 123456789 converts to 12-3456789). Returns the parameter without formatting if the length of the string is not 9.
Formatter formatZipCode String Formats a 5 or 9 digit US Zip code. (ex: 123456789 converts to 12345-6789). Returns the parameter without formatting if the length of the string is not 9.
Formatter substring String Returns a sub-string of the given string starting at the specified location. Returns null if the starting point is greater than the length.
06-18-2010
Object Method Return Type Description
Validator isRoutingNumberValid boolean Validates routing transit number checksum. Input string may contain extra characters which will be ignored during validation
06-11-2010
Object Method Return Type Description
Data hasName boolean Returns true if the name exists in the data map.
06-10-2010
Object Method Return Type Description
AudioFile getFileExtension String Returns the file extension. 'Myfile.doc' returns 'doc'
DatasetFile getFileExtension String Returns the file extension. 'Myfile.doc' returns 'doc'
DocumentFile getFileExtension String Returns the file extension. 'Myfile.doc' returns 'doc'
ExcelFile getFileExtension String Returns the file extension. 'Myfile.doc' returns 'doc'
File getFileExtension String Returns the file extension. 'Myfile.doc' returns 'doc'
ImageFile getFileExtension String Returns the file extension. 'Myfile.doc' returns 'doc'
PdfFile getFileExtension String Returns the file extension. 'Myfile.doc' returns 'doc'
VCardFile getFileExtension String Returns the file extension. 'Myfile.doc' returns 'doc'
06-09-2010
Object Method Return Type Description
Document getSignSettings SignSettings Returns sign settings for the document. Sign settings can be used to customize signature appearance. Sign settings are not stored with document in packet
Data loadQueryString Decodes the query string and adds name/value pairs to this data.
SignSettings setAuditNameEnabled Enables or disables audit name string on signature
SignSettings setAuditNamePosition Sets position for audit name string on custom signature.
SignSettings setInitialBackground Enables custom background image for signature. Signature for profile will be painted over background image in position specified with top and left coordinate
ServiceRequest setSendAuthorization Enables or disables sending HTTP authorization header if user and password specified. Allows to control authorization manually. Enabled by default.
SignSettings setSignatureBackground Enables custom background image for signature. Signature for profile will be painted over background image in position specified with top and left coordinate
06-08-2010
Object Method Return Type Description
TextMessage schedule Schedules the message to be sent after the specified date.
06-07-2010
Object Method Return Type Description
Buffer appendArray Buffer Appends the elements of array to this buffer, optionally separating them with delim.
Buffer toDataList PacketDataList Creates a one column PacketDataList from the buffer contents.
05-31-2010
Object Method Return Type Description
ServiceRequest setAttachment Adds the attachment. Content is set as base64
ServiceRequest setCoreDocument Adds the XML of the dta:Document element including all references. Content is set as base64.
ServiceRequest setFile Adds the file. Content is set as base64
ServiceRequest setPacket Adds the XML of the entire transaction packet without a dsig wrapper. Content is set as base64
ServiceRequest setPdfDocument Adds the doc as a PDF. If the document is not already PDF it is converted to PDF. Content is set as base64.
05-28-2010
Object Method Return Type Description
DownloadResponse addData Adds the specified Data to this response.
Email addData Adds the specified Data to this response.
Fragment addData Adds the specified Data to this response.
Payload addData Adds the specified Data to this response.
Render addData Adds the specified Data to this response.
TextEmail addData Adds the specified Data to this response.
DownloadResponse addDataMap boolean Registers the data in the response with the specified id.
Email addDataMap boolean Registers the data in the response with the specified id.
Fragment addDataMap boolean Registers the data in the response with the specified id.
Payload addDataMap boolean Registers the data in the response with the specified id.
Render addDataMap boolean Registers the data in the response with the specified id.
TextEmail addDataMap boolean Registers the data in the response with the specified id.
DownloadResponse addDataMaps boolean Extracts the records from the list and registers them in the response using the values in the key column. Limited to 500 records per response.
Email addDataMaps boolean Extracts the records from the list and registers them in the response using the values in the key column. Limited to 500 records per response.
Fragment addDataMaps boolean Extracts the records from the list and registers them in the response using the values in the key column. Limited to 500 records per response.
Payload addDataMaps boolean Extracts the records from the list and registers them in the response using the values in the key column. Limited to 500 records per response.
Render addDataMaps boolean Extracts the records from the list and registers them in the response using the values in the key column. Limited to 500 records per response.
TextEmail addDataMaps boolean Extracts the records from the list and registers them in the response using the values in the key column. Limited to 500 records per response.
DownloadResponse removeValue Removes the associated key from the response.
Email removeValue Removes the associated key from the response.
Fragment removeValue Removes the associated key from the response.
Payload removeValue Removes the associated key from the response.
Render removeValue Removes the associated key from the response.
TextEmail removeValue Removes the associated key from the response.
05-27-2010
Object Method Return Type Description
Data evaluate String Evaluates the JEXL expression using information from this Data object.
05-25-2010
Object Method Return Type Description
WebServiceRequest getPayload XMLReader Returns optional payload sent in web service request. This method returns null if there is no payload in the request
05-22-2010
Object Method Return Type Description
Pal getId String Returns the pal id.
PalInfo getId String Returns the pal id.
RuntimePal getId String Returns the pal id.
ShellPal getId String Returns the pal id.
05-21-2010
Object Method Return Type Description
Wizard setLinkedValues Allows to enable or disable link between fields with the same names on different wizard dialogs. Disabled by default.
05-20-2010
Object Method Return Type Description
Pal isConsoleModule boolean Returns true if this Pal has a console module.
PalInfo isConsoleModule boolean Returns true if this Pal has a console module.
RuntimePal isConsoleModule boolean Returns true if this Pal has a console module.
ShellPal isConsoleModule boolean Returns true if this Pal has a console module.
Pal isTransactionModule boolean Returns true if this Pal has a transaction module.
PalInfo isTransactionModule boolean Returns true if this Pal has a transaction module.
RuntimePal isTransactionModule boolean Returns true if this Pal has a transaction module.
ShellPal isTransactionModule boolean Returns true if this Pal has a transaction module.
Pal isWebModule boolean Returns true if this Pal has a web module.
PalInfo isWebModule boolean Returns true if this Pal has a web module.
RuntimePal isWebModule boolean Returns true if this Pal has a web module.
ShellPal isWebModule boolean Returns true if this Pal has a web module.
05-15-2010
Object Method Return Type Description
AudioFile toDataList PacketDataList Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls)
DatasetFile toDataList PacketDataList Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls)
DocumentFile toDataList PacketDataList Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls)
ExcelFile toDataList PacketDataList Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls)
File toDataList PacketDataList Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls)
ImageFile toDataList PacketDataList Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls)
PdfFile toDataList PacketDataList Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls)
VCardFile toDataList PacketDataList Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls)
05-12-2010
Object Method Return Type Description
RuntimePal getLocalDataSet DataSet Returns the DataSet identified by name searching only the pal and it's skin pal (if any). New records with auto-populate pal id columns will be associated with the pal. Throws exception if the dataset cannot be found.
05-11-2010
Object Method Return Type Description
Formatter toGigaBytes String Returns the given number (bytes) as gigabytes to the specified decimal places.
05-05-2010
Object Method Return Type Description
Packet getBillingReference String Returns the billing reference associated with the execution fee for this Packet. Deployed Packets only.
ProfilePacket getBillingReference String Returns the billing reference associated with the access fee for this Packet.
TransactionPacket getBillingReference String Returns the billing reference associated with the execution fee for this Packet. Deployed Packets only.
Packet setBillingReference Sets the billing reference associated with the execution fee for this Packet. Deployed Packets only.
ProfilePacket setBillingReference Sets the billing reference associated with the access fee for this Packet.
TransactionPacket setBillingReference Sets the billing reference associated with the execution fee for this Packet. Deployed Packets only.
04-28-2010
Object Method Return Type Description
Pal getActivationKeyInfo PalActivationKeyInfo Returns the PalActivationKeyInfo for the Pal.
RuntimePal getActivationKeyInfo PalActivationKeyInfo Returns the PalActivationKeyInfo for the Pal.
ShellPal getActivationKeyInfo PalActivationKeyInfo Returns the PalActivationKeyInfo for the Pal.
Pal getAttachment File Returns Pal attachment as File object.
RuntimePal getAttachment File Returns Pal attachment as File object.
ShellPal getAttachment File Returns Pal attachment as File object.
Pal getConsolePacketProperties Data Returns all Console Packet properties from the Pal as a read-only Data object. Changes made to these items are not persisted.
RuntimePal getConsolePacketProperties Data Returns all Console Packet properties from the Pal as a read-only Data object. Changes made to these items are not persisted.
Pal getConsoleUserPacketProperties Data Returns all Console User Packet properties from the Pal as a read-only Data object. Changes made to these items are not persisted.
RuntimePal getConsoleUserPacketProperties Data Returns all Console User Packet properties from the Pal as a read-only Data object. Changes made to these items are not persisted.
Pal getData Data Returns an editable, non persistent Data object identified by name. Returns null if no Data object exists.
RuntimePal getData Data Returns an editable, non persistent Data object identified by name. Returns null if no Data object exists.
Pal getDataList DataList Returns the DataList object identified by name. Returns null if no DataList object exists.
RuntimePal getDataList DataList Returns the DataList object identified by name. Returns null if no DataList object exists.
Pal getDataLists PacketDataList Returns a list of DataList object names defined in this Pal.
RuntimePal getDataLists PacketDataList Returns a list of DataList object names defined in this Pal.
ShellPal getDataLists PacketDataList Returns a list of DataList object names defined in this Pal.
Pal getDataNames PacketDataList Returns a list of Data object names defined in this Pal.
RuntimePal getDataNames PacketDataList Returns a list of Data object names defined in this Pal.
ShellPal getDataNames PacketDataList Returns a list of Data object names defined in this Pal.
RuntimePal getDataSet DataSet Returns the DataSet identified by name searching first the pal, then the pal chain and skin pal (if any). New records with auto-populate pal id columns will be associated with the runtime pal. Throws exception if the dataset cannot be found.
Pal getDataSets DataList Returns a list of DataSet names are accessible by this Pal.
RuntimePal getDataSets DataList Returns a list of DataSet names are accessible by this Pal.
ShellPal getDataSets DataList Returns a list of DataSet names are accessible by this Pal.
RuntimePal getDataView DataView Returns the DataView identified by name. Returns null if no DataView exists.
Pal getDataViews DataList Returns a list of DataView names for this Pal.
RuntimePal getDataViews DataList Returns a list of DataView names for this Pal.
ShellPal getDataViews DataList Returns a list of DataView names for this Pal.
TransactionWebServiceController getPal RuntimePal Returns the active Pal
TransactionWebServiceController getPalById RuntimePal Returns the Pal for the specified palId. Pals must belong to the same enterprise and group.
Pal getTransactionProperties Data Returns all transaction properties from the Pal as a read-only Data object.
RuntimePal getTransactionProperties Data Returns all transaction properties from the Pal as a read-only Data object.
ShellPal getTransactionProperties Data Returns all transaction properties from the Pal as a read-only Data object.
Pal toString String Returns a description of this object.
ShellPal toString String Returns a description of this object.
04-23-2010
Object Method Return Type Description
Data toQueryString String Returns all entries as a name/value querystring.
04-22-2010
Object Method Return Type Description
Pal getPalAttachments PacketDataList Returns list of attachments for this pal
RuntimePal getPalAttachments PacketDataList Returns list of attachments for this pal
ShellPal getPalAttachments PacketDataList Returns list of attachments for this pal
Pal getPalDocuments PacketDataList Returns list of documents for this pal
RuntimePal getPalDocuments PacketDataList Returns list of documents for this pal
ShellPal getPalDocuments PacketDataList Returns list of documents for this pal
Pal getPalFragments PacketDataList Returns list of fragments for this pal
RuntimePal getPalFragments PacketDataList Returns list of fragments for this pal
ShellPal getPalFragments PacketDataList Returns list of fragments for this pal
Pal getPalImages PacketDataList Returns list of images for this pal
RuntimePal getPalImages PacketDataList Returns list of images for this pal
ShellPal getPalImages PacketDataList Returns list of images for this pal
04-15-2010
Object Method Return Type Description
DataView findRecord DataViewRecord Finds the first record matching the criteria of the filter.
SystemDataView findRecord DataViewRecord Finds the first record matching the criteria of the filter.
Wizard wasChanged boolean Returns true if wizard was changed by the current request and false otherwise
Wizard wasDialogChanged boolean Returns true if wizard dialog was changed by the current request and false otherwise
04-13-2010
Object Method Return Type Description
Data setValues Boolean Sets all key values to the specified value. If value is null, the keys are deleted. Returns true if changes were made.
04-06-2010
Object Method Return Type Description
Data addPrefix Boolean Adds the prefix to all keys. Returns true if an update was made.
Data removePrefix Boolean Removes the prefix from any key that has it. Returns true if an update was made.
Data updateData boolean Updates matching entries in this Data from the values in the supplied Data. Returns true if any changes were made.
03-31-2010
Object Method Return Type Description
Attachment getFileExtension String Returns file extension for this attachment
Attachment getFilename String Returns file name for this attachment
03-29-2010
Object Method Return Type Description
PalActivationKeyInfo isTransactionEnabled boolean Returns true if transaction modules are enabled.
03-16-2010
Object Method Return Type Description
Document getSortOrder int Returns the sort order of this document in the packet. Default is 0.
Document setSortOrder Sets the sort order of this document in the packet. Order is not unique and not automatic, two documents can have the same sort order.
03-12-2010
Object Method Return Type Description
DisplaySettings setSigningText Sets custom captions and optional tooltips for Sign and Reject buttons
03-11-2010
Object Method Return Type Description
Email setCreateOrAccessTransactionLink Creates a link that can be clicked from within the email that will either access last transaction user has role in or create a new transaction using the Pal associated with the specified ID.If chain is true, the new transaction will be logically associated with this transaction.If data is non null, the data will be available as part of the creation/access of the target transaction-- as if it was passed on the request.
03-10-2010
Object Method Return Type Description
PalActivationKeyInfo getStatus String Returns the status of the key.
03-02-2010
Object Method Return Type Description
Document isAllUserSigned boolean Returns true if all required signatures in this document have been signed by user with the email provided. Method returns false if there are no signatures associated with the specified email. See also Document.setSigner(email) and Document.getUserSignatures(email)
02-23-2010
Object Method Return Type Description
Attachment isClean boolean Returns true if this attachment was checked for viruses or macros and contains none.
AudioFile isMacro boolean Returns true if the content of the file contains macro.
DatasetFile isMacro boolean Returns true if the content of the file contains macro.
DocumentFile isMacro boolean Returns true if the content of the file contains macro.
ExcelFile isMacro boolean Returns true if the content of the file contains macro.
File isMacro boolean Returns true if the content of the file contains macro.
ImageFile isMacro boolean Returns true if the content of the file contains macro.
PdfFile isMacro boolean Returns true if the content of the file contains macro.
VCardFile isMacro boolean Returns true if the content of the file contains macro.
02-05-2010
Object Method Return Type Description
Document createCheckboxGroup boolean Makes the specified fields behave like radio buttons in terms of browser behavior and validation. Returns false if the document has been signed, if the document is not compatible (PDF), or if any of the specified fields to not exist in the document.
Document setAjaxSigning Call this method in conjunction with enableSigning or enableSignature. See also ClientPal.reloadDocument.
02-03-2010
Object Method Return Type Description
AudioFile getContentType String Returns the content type of this file
DatasetFile getContentType String Returns the content type of this file
DocumentFile getContentType String Returns the content type of this file
ExcelFile getContentType String Returns the content type of this file
File getContentType String Returns the content type of this file
ImageFile getContentType String Returns the content type of this file
PdfFile getContentType String Returns the content type of this file
VCardFile getContentType String Returns the content type of this file
AudioFile isDataListSupported boolean Returns true if this file content can be used as a DataList. See Attachment.toDataList
DatasetFile isDataListSupported boolean Returns true if this file content can be used as a DataList. See Attachment.toDataList
DocumentFile isDataListSupported boolean Returns true if this file content can be used as a DataList. See Attachment.toDataList
ExcelFile isDataListSupported boolean Returns true if this file content can be used as a DataList. See Attachment.toDataList
File isDataListSupported boolean Returns true if this file content can be used as a DataList. See Attachment.toDataList
ImageFile isDataListSupported boolean Returns true if this file content can be used as a DataList. See Attachment.toDataList
PdfFile isDataListSupported boolean Returns true if this file content can be used as a DataList. See Attachment.toDataList
VCardFile isDataListSupported boolean Returns true if this file content can be used as a DataList. See Attachment.toDataList
02-01-2010
Object Method Return Type Description
ServiceResponse getFile File Locates text node by xpath expression and creates a File object for it. Content of node should be base64 encoded. File.isValid will indicate success of the operation
XMLReader getFile File Locates text node by xpath expression and creates a File object for it. Content of node should be base64 encoded. File.isValid will indicate success of the operation
ServiceRequest setIgnoreStatusCodes Allows to ignore http status code of response and use response body in error state. Useful for dealing with SOAP
01-29-2010
Object Method Return Type Description
PalActivationKeyInfo getMaxConsolePacketSize int Returns the ConsolePacket size in kilobytes.
PalActivationKeyInfo getMaxUserPacketSize int Returns the ProfilePacket size in kilobytes.
ProfilePacket getSize int Returns the size of this ProfilePacket in bytes.
01-28-2010
Object Method Return Type Description
PacketDataList findRecord PacketDataRecord Returns the first record whose column matches the given value.
PacketDataList findRecord DataRecord Returns the first record whose column matches the given value.
01-27-2010
Object Method Return Type Description
Document getNextSignature String Gets the next signature id to be signed by role.
Document getNextUserSignature String Gets the next signature id to be signed. See setSigner.
DisplaySettings getPage int Returns the adhoc page to display.
DisplaySettings setPage Sets the adhoc page to display.
01-26-2010
Object Method Return Type Description
Pal getWebUrl String Returns the public URL for this Pal.
PalInfo getWebUrl String Returns the public URL for this Pal.
RuntimePal getWebUrl String Returns the public URL for this Pal.
ShellPal getWebUrl String Returns the public URL for this Pal.
01-25-2010
Object Method Return Type Description
Profile getGroupsWithPermission DataList Returns a DataList of all groups this profile is a member of that have the specified permission. Possible choices are: accessTransaction,accessConsolePal,createTransaction,deleteTransaction,accessTransactionLogs,accessTransactionTechnical,managePals,userWebService,manageArchive,developPals
01-21-2010
Object Method Return Type Description
Data toDataList PacketDataList Returns the data as a DataList. This DataList can be modified but will not modify the original Data Object.
01-20-2010
Object Method Return Type Description
Packet getColumn1 String Returns custom column value
TransactionPacket getColumn1 String Returns custom column value
Packet getColumn2 String Returns custom column value
TransactionPacket getColumn2 String Returns custom column value
Packet getColumn3 String Returns custom column value
TransactionPacket getColumn3 String Returns custom column value
Packet getColumn4 String Returns custom column value
TransactionPacket getColumn4 String Returns custom column value
Message getReceiverFirstName String Returns the message receiver's first name
Message getReceiverLastName String Returns the message receiver's last name
ServiceResponse getResponseLength int Returns the length of the response body in bytes.
XMLReader getResponseLength int Returns the length of the response body in bytes.
Message getSenderFirstName String Returns the message sender's first name
Message getSenderLastName String Returns the message sender's last name
Message getTransactionCategory String Returns the transaction category for this message, if it is associated with a transaction.
Message getTransactionDescription String Returns the transaction description for this message, if it is associated with a transaction.
Message getTransactionName String Returns the transaction name for this message, if it is associated with a transaction.
ServiceResponse readBody String Reads the body of the response. Returns null if there is no body or the body exceeds the maximum upload allowed by the activation key.
XMLReader readBody String Reads the body of the response. Returns null if there is no body or the body exceeds the maximum upload allowed by the activation key.
Packet setColumn1 Sets custom column value
TransactionPacket setColumn1 Sets custom column value
Packet setColumn2 Sets custom column value
TransactionPacket setColumn2 Sets custom column value
Packet setColumn3 Sets custom column value
TransactionPacket setColumn3 Sets custom column value
Packet setColumn4 Sets custom column value
TransactionPacket setColumn4 Sets custom column value
01-19-2010
Object Method Return Type Description
Data addJSONData Decodes the JSON string and adds the payload to this Data object.
PacketDataList addJSONRecords Decodes the JSON string and adds the content to this DataList object. Expects a property of a larger JSON object that contains an array of objects.
01-15-2010
Object Method Return Type Description
Profile getAccessLevel String Returns the access level this profile has granted to the running Pal. Responses will be 'None', 'ContractPal', 'Enterprise' or 'B2B'. If 'None', advanced information from the profile is not exposed to this Pal.
Message getReceiverEmail String Returns the message receiver
Message getSenderEmail String Returns the message sender
01-14-2010
Object Method Return Type Description
Message getPalId String Returns the pal id for this message.
Attachment isDataListSupported boolean Returns true if this attachment can be converted to a DataList
Attachment toDataList PacketDataList Creates a non persistent PacketDataList from the contents of this attachment. The contents must support DataList conversion (currently .csv and .xls)
01-11-2010
Object Method Return Type Description
Profile getGroupPermissions Data Returns a Data object (read only) containing the permissions the enterprise profile has for the specified group. See hasGroupPermission for permission names.
Profile getPermissions Data Returns a Data object (read only) containing all permissions of the enterprise profile. Possible choices are: manageUsers,manageStats,manageReseller,enterpriseOwner,manageEnterprise,manageGlobalSettings,manageServices,accounting,manageGroups,manageB2B,manageUnassignedTransactions,manageEnterpriseActivationKeys,manageStore,manageDesktopSoftware,manageSystemActivationKeys,manageZones,managePalChains,manageSSO,manageRemoteProviders,manageResources,systemAccounting,systemStatements,systemSupport,manageEnterprises,systemAdmin,systemDeleteEnterprise,systemStats
Profile hasGroupPermission boolean Returns true the enterprise profile has the group permission. Possible choices are: accessTransaction,accessConsolePal,createTransaction,deleteTransaction,accessTransactionLogs,accessTransactionTechnical,managePals,userWebService,manageArchive,developPals
Profile hasPermission boolean Returns true the enterprise profile has the specified system permission. Possible choices are: manageUsers,manageStats,manageReseller,enterpriseOwner,manageEnterprise,manageGlobalSettings,manageServices,accounting,manageGroups,manageB2B,manageUnassignedTransactions,manageEnterpriseActivationKeys,manageStore,manageDesktopSoftware,manageSystemActivationKeys,manageZones,managePalChains,manageSSO,manageRemoteProviders,manageResources,systemAccounting,systemStatements,systemSupport,manageEnterprises,systemAdmin,systemDeleteEnterprise,systemStats
01-07-2010
Object Method Return Type Description
Attachment updateContent boolean Returns true if this attachment is successfully updated with the file content.
01-06-2010
Object Method Return Type Description
DataSet bulkUpdate int Performs bulk update of all records that match the filter, setting the value of the specified column.
Packet getCreateDate Date Returns the date this transaction packet was created.
TransactionPacket getCreateDate Date Returns the date this transaction packet was created.
01-05-2010
Object Method Return Type Description
Message createReply Message Creates a new message and associates it with the given message. Only non-system messages can be followed
Message getChildMessages SystemDataView Returns messages that are children (one-to-many) for this message.
Message getCreateDate Date Returns the date this message was created.
Message getDateRead Date Returns the date this message was read or null if it has not been read.
Message getId String Returns the message id.
Message getParentMessages SystemDataView Returns parent chain (one-to-one) of messages for this message.
Message getSubject String Returns the subject.
PalActivationKeyInfo getTimeout int Returns the max allowed workflow timeout in seconds. See Monitor.setTimeout
Message getTransactionId String Returns the transaction id for this message, if it is associated with a transaction.
Message markRead Marks the specified message as having been read by the recipient.
PacketDataList setColumnValue boolean Sets the value of the specified column referenced by name for all records. Returns false if the column does not exist.
PacketDataList setColumnValue boolean Sets the value of the specified column referenced by name for all records. Returns false if the column does not exist.
PacketDataList setColumnValue boolean Sets the value of the specified column referenced by name for all records. Returns false if the column does not exist.
PacketDataList setColumnValue boolean Sets the value of the specified column referenced by name for all records. Returns false if the column does not exist.
PacketDataList setColumnValue boolean Sets the value of the specified column referenced by name for all records. Returns false if the column does not exist.
PacketDataList setColumnValue boolean Sets the value of the specified date column referenced by name for all records. Returns false if the column does not exist.
Message toString String Returns a description of this object.
01-04-2010
Object Method Return Type Description
Monitor getMaxTimeout int Returns the maximum allowed timeout set by the activation key.
TransactionWebServiceController getMonitor Monitor Returns the workflow monitor.
Monitor getRemainingTime int Returns the approximate remaining time in seconds.
Monitor getTimeout int Returns the timeout setting.
Monitor isTimeRemaining boolean Returns true if the timeout remaining exceeds the buffer (seconds).
Monitor setTimeout Sets the timeout for the monitor in seconds. Default and minimum is 10. Maximum is determined by the activation key. This method is called only once per workflow cycle. Subsequent calls are ignored.
Monitor toString String Returns a description of this object.
12-24-2009
Object Method Return Type Description
ServiceResponse readNodeText String Returns text of the first node selected by xpath expression. If node is an attribute then attribute value returned. If node is an element then element's text contents returned. Fails if response body is not xml
XMLReader readNodeText String Returns text of the first node selected by xpath expression. If node is an attribute then attribute value returned. If node is an element then element's text contents returned. Fails if response body is not xml
12-23-2009
Object Method Return Type Description
ServiceRequest clearFormParameters Removes all for parameters set for this request
ServiceRequest clearHeaders Removes all request headers set for this request
ServiceRequest setFormParameter Sets request form parameter. Note: this method has no effect for POST and PUT methods if request body set from fragment or string
ServiceRequest setFormParameters Sets request form parameters from data. Note: this method has no effect for POST and PUT methods if request body set from fragment or string
ServiceRequest setFragmentFormParameter Sets request form parameter from fragment. Note: this method has no effect for POST and PUT methods if request body set from fragment or string
12-22-2009
Object Method Return Type Description
ServiceRequest addData Adds data to request body. Used if request body created from fragment
ServiceRequest addDataList Adds datalist to request body. Used if request body created from fragment
ServiceRequest getLastResponse ServiceResponse Returns last response for this request. This method returns null if the request wasn't submitted yet
ServiceResponse getResponseCode int Returns response code
ServiceResponse getResponseHeader String Returns response header value
ServiceResponse getResponseHeaders Data Returns response headers
ServiceResponse getResponseMessage String Returns response message
ServiceResponse isError boolean Returns true if request was not submitted successfully, false otherwise
ServiceResponse isSuccess boolean Returns true if request was submitted successfully, false otherwise
ServiceResponse readAttributeData Data Creates data object by evaluating xpath expression on response body using attributes of first matching element. Fails if response body is not xml
XMLReader readAttributeData Data Creates data object by evaluating xpath expression on response body using attributes of first matching element. Fails if response body is not xml
ServiceResponse readAttributeDataList DataList Creates datalist object by evaluating xpath expression on response body using attributes of matching elements. Fails if response body is not xml
XMLReader readAttributeDataList DataList Creates datalist object by evaluating xpath expression on response body using attributes of matching elements. Fails if response body is not xml
ServiceResponse readTextData Data Creates data object by evaluating xpath expression on response body from first matching element using children elements' names as keys and text nodes as values. Fails if response body is not xml.
XMLReader readTextData Data Creates data object by evaluating xpath expression on response body from first matching element using children elements' names as keys and text nodes as values. Fails if response body is not xml.
ServiceResponse readTextDataList DataList Creates datalist object by evaluating xpath expression on response body from matching elements using children elements' names as keys and text nodes as values. Fails if response body is not xml
XMLReader readTextDataList DataList Creates datalist object by evaluating xpath expression on response body from matching elements using children elements' names as keys and text nodes as values. Fails if response body is not xml
ServiceRequest setBasicAuthorization Sets basic authorization for this request. Note: this method has no effect if request submitted using connector settings
ServiceRequest setContentType Sets content type of this request. Default value is application/xml
ServiceRequest setFragment Set fragment of type "service request" as this request body
ServiceRequest setMethod Sets http method for this request. Default is POST. Note that only POST and PUT methods will allow to send request body
ServiceRequest setNTLMAuthorization Sets NTLM authorization for this request. Note: this method has no effect if request submitted using connector settings
ServiceRequest setRequestBody Sets free-form string request body. Useful for request with JSON body
ServiceRequest setRequestHeader Adds request header or removes it if value is null
ServiceRequest submitUsingConnector ServiceResponse Submits request using connector settings defined for enterprise
ServiceResponse urlDecode String Performs URL-decoding of specified value
ServiceRequest urlEncode String Performs URL-encoding of specified value
12-18-2009
Object Method Return Type Description
Packet getName String Returns the name of this packet.
TransactionPacket getName String Returns the name of this packet.
Packet setName Sets the name of this packet. Maximum length is 80 characters.
TransactionPacket setName Sets the name of this packet. Maximum length is 80 characters.
12-17-2009
Object Method Return Type Description
DataSet bulkDelete int Performs bulk delete of the dataset records with primary key ids matching list values. Array limit is 1000.
DataSet bulkDelete int Performs bulk delete of all the records matching filter criteria and returns the number of records deleted. The maximum number of records deleted depends on the page size of the filter. Returns -1 if error.
DataSet bulkInsert boolean Performs bulk insert of datalist into the dataset
12-15-2009
Object Method Return Type Description
Document getPageHeight int Returns height of the first page in pixels. Method is for pdf documents. For html always returns 0
Document getPageWidth int Returns width of the first page in pixels. Method is for pdf documents. For html always returns 0
12-03-2009
Object Method Return Type Description
AnalyticDataViewFilter standardDeviation calculates the population standard deviation of the specified column using the specified resultAlias
12-02-2009
Object Method Return Type Description
Profile getFullName String Returns the combined first and last name of the user associated with this profile.
ProfileInfo getFullName String Returns the combined first and last name of the user associated with this profile.
11-19-2009
Object Method Return Type Description
PacketDataList addColumn boolean Adds the specified column to the end of this DataList. If the column already exists, this method returns false.
DataList copy PacketDataList Creates a new PacketDataList from this DataList.
DataViewList copy PacketDataList Creates a new PacketDataList from this DataList.
PacketDataList copy PacketDataList Creates a new PacketDataList from this DataList.
StorageProviderDataList copy PacketDataList Creates a new PacketDataList from this DataList.
Packet createPublicPin String Creates a PIN that can be used to access this transaction. The PIN size is minimum 5 and maximum 16. First and last name are required. ExpirationDate is required and must be in the future. Use of this method should be carefully reviewed since it represents open access (non authenticated user) to this transaction when used in conjunction with Web related APIs.
TransactionPacket createPublicPin String Creates a PIN that can be used to access this transaction. The PIN size is minimum 5 and maximum 16. First and last name are required. ExpirationDate is required and must be in the future. Use of this method should be carefully reviewed since it represents open access (non authenticated user) to this transaction when used in conjunction with Web related APIs.
Packet createUserPin String Creates a PIN that can be used to access this transaction. The PIN size is minimum 5 and maximum 16. First name, Last name, and Email are required. ExpirationDate is required and must be in the future. The user associated with this PIN must have a ContractPal account or must create an account.
TransactionPacket createUserPin String Creates a PIN that can be used to access this transaction. The PIN size is minimum 5 and maximum 16. First name, Last name, and Email are required. ExpirationDate is required and must be in the future. The user associated with this PIN must have a ContractPal account or must create an account.
Packet deletePin Deletes the specified PIN.
TransactionPacket deletePin Deletes the specified PIN.
Packet getPins SystemDataView Returns a SystemDataView that can be used for accessing PINS associated with this Packet.
TransactionPacket getPins SystemDataView Returns a SystemDataView that can be used for accessing PINS associated with this Packet.
Packet updatePin Updates the specified PIN. Expiration date must be in the future
TransactionPacket updatePin Updates the specified PIN. Expiration date must be in the future
11-17-2009
Object Method Return Type Description
ChartSharedSettings explodeSection Adds "explode" effect to category section. Percent specifies how far from center section will be exploded. This setting has no effect for 3D view.
ChartTool getSharedSettings ChartSharedSettings Returns shared settings object for all charts created with chart tool during workflow run. All matching settings will automatically apply to created charts unless they are not set precisely for the particular chart.
ChartSharedSettings setBackgroundColor Sets background color for charts (e.q. 'blue' or '#FAE5B0')
ChartSharedSettings setDrawShapes Enables shapes to be rendered for value points for category based charts. Has no effect for 3D view and XY based charts
ChartSharedSettings setShowLabels Renders labels for item values if set to true
ChartSharedSettings setShowLegend Displays legend for charts if set to true
ChartSharedSettings setStacked Sets charts to display data in a stacked manner
ChartSharedSettings setTitle Sets title for charts
11-16-2009
Object Method Return Type Description
ChartTool createAreaChart AreaChart Creates area chart
ChartTool createScatterPlotChart ScatterPlotChart Creates scatter plot chart
AreaChart setDomainAxisColor Sets domain axis color
BarChart setDomainAxisColor Sets domain axis color
ChartSharedSettings setDomainAxisColor Sets domain axis color
LineChart setDomainAxisColor Sets domain axis color
ScatterPlotChart setDomainAxisColor Sets domain axis color
AreaChart setDomainAxisVisible Enables domain axis visibility
BarChart setDomainAxisVisible Enables domain axis visibility
ChartSharedSettings setDomainAxisVisible Enables domain axis visibility
LineChart setDomainAxisVisible Enables domain axis visibility
ScatterPlotChart setDomainAxisVisible Enables domain axis visibility
AreaChart setRangeAxisColor Sets range axis color
BarChart setRangeAxisColor Sets range axis color
ChartSharedSettings setRangeAxisColor Sets range axis color
LineChart setRangeAxisColor Sets range axis color
ScatterPlotChart setRangeAxisColor Sets range axis color
AreaChart setRangeAxisVisible Enables domain axis visibility
BarChart setRangeAxisVisible Enables domain axis visibility
ChartSharedSettings setRangeAxisVisible Enables domain axis visibility
LineChart setRangeAxisVisible Enables domain axis visibility
ScatterPlotChart setRangeAxisVisible Enables domain axis visibility
AreaChart setShowLabels Renders labels for item values if set to true
BarChart setShowLabels Renders labels for item values if set to true
Chart setShowLabels Renders labels for item values if set to true
LineChart setShowLabels Renders labels for item values if set to true
PieChart setShowLabels Renders labels for item values if set to true
ScatterPlotChart setShowLabels Renders labels for item values if set to true
AreaChart setStacked Sets this chart to display data in a stacked manner. Has no effect for XY based charts
BarChart setStacked Sets this chart to display data in a stacked manner
11-13-2009
Object Method Return Type Description
ChartTool createBarChart BarChart Creates bar chart
ChartTool createLineChart LineChart Creates line chart
PieChart explodeSection Adds "explode" effect to category section. Percent specifies how far from center section will be exploded. This setting has no effect for 3D view.
TransactionWebServiceController getWorkflowName String Returns the name of the currently running workflow.
AreaChart setDataList Sets input for the chart from datalist. Value column should contain numeric data.
AreaChart setDataList Sets input for the chart from datalist. Value column should contain numeric data.
BarChart setDataList Sets input for the chart from datalist. Value column should contain numeric data.
BarChart setDataList Sets input for the chart from datalist. Value column should contain numeric data.
LineChart setDataList Sets input for the chart from datalist. Value column should contain numeric data.
LineChart setDataList Sets input for the chart from datalist. Value column should contain numeric data.
AreaChart setDataListXY Sets XY input for the chart from datalist (both numerical axes). xColumn and yColumn should contain numeric data. Note: 3D view not supported for XY based charts.
AreaChart setDataListXY Sets XY input for the chart from datalist (both numerical axes). xColumn and yColumn should contain numeric data. Note: 3D view not supported for XY based charts.
LineChart setDataListXY Sets XY input for the chart from datalist (both numerical axes). xColumn and yColumn should contain numeric data. Note: 3D view not supported for XY based charts.
LineChart setDataListXY Sets XY input for the chart from datalist (both numerical axes). xColumn and yColumn should contain numeric data. Note: 3D view not supported for XY based charts.
ScatterPlotChart setDataListXY Sets XY input for the chart from datalist (both numerical axes). xColumn and yColumn should contain numeric data. Note: 3D view not supported for XY based charts.
ScatterPlotChart setDataListXY Sets XY input for the chart from datalist (both numerical axes). xColumn and yColumn should contain numeric data. Note: 3D view not supported for XY based charts.
AreaChart setDomainAxisLabel Sets domain axis label
BarChart setDomainAxisLabel Sets domain axis label
ChartSharedSettings setDomainAxisLabel Sets domain axis label
LineChart setDomainAxisLabel Sets domain axis label
ScatterPlotChart setDomainAxisLabel Sets domain axis label
LineChart setDrawShapes Enables shapes to be rendered for value points for category based charts. Has no effect for 3D view and XY based charts
AreaChart setRangeAxisLabel Sets range axis label
BarChart setRangeAxisLabel Sets range axis label
ChartSharedSettings setRangeAxisLabel Sets range axis label
LineChart setRangeAxisLabel Sets range axis label
ScatterPlotChart setRangeAxisLabel Sets range axis label
AreaChart setVertical Sets chart vertical orientation. True by default.
BarChart setVertical Sets chart vertical orientation. True by default.
ChartSharedSettings setVertical Sets chart vertical orientation. True by default.
LineChart setVertical Sets chart vertical orientation. True by default.
ScatterPlotChart setVertical Sets chart vertical orientation. True by default.
11-12-2009
Object Method Return Type Description
Document addChart boolean Adds chart to document. Method supported only for html documents. For pdf method silently returns false. Only server charts supported (created using ChartTool) otherwise exception occurs
11-11-2009
Object Method Return Type Description
ChartTool createPieChart PieChart Creates pie chart
Enterprise hasGroup boolean Returns whether or not this enterprise has the private group with the specified name.
BarChart set3D Enables 3D look of pie chart if set to true
ChartSharedSettings set3D Enables 3D look of pie chart if set to true
LineChart set3D Enables 3D look of pie chart if set to true
PieChart set3D Enables 3D look of pie chart if set to true
AreaChart setBackgroundColor Sets background color for chart (e.q. 'blue' or '#FAE5B0')
BarChart setBackgroundColor Sets background color for chart (e.q. 'blue' or '#FAE5B0')
Chart setBackgroundColor Sets background color for chart (e.q. 'blue' or '#FAE5B0')
LineChart setBackgroundColor Sets background color for chart (e.q. 'blue' or '#FAE5B0')
PieChart setBackgroundColor Sets background color for chart (e.q. 'blue' or '#FAE5B0')
ScatterPlotChart setBackgroundColor Sets background color for chart (e.q. 'blue' or '#FAE5B0')
PieChart setData Sets input for the chart from data.
PieChart setDataList Sets input for the chart from datalist. Category column contains values for category labels. Value column should contain numeric data.
AreaChart setShowLegend Displays legend for the chart if set to true
BarChart setShowLegend Displays legend for the chart if set to true
Chart setShowLegend Displays legend for the chart if set to true
LineChart setShowLegend Displays legend for the chart if set to true
PieChart setShowLegend Displays legend for the chart if set to true
ScatterPlotChart setShowLegend Displays legend for the chart if set to true
AreaChart setTitle Sets title of this chart
BarChart setTitle Sets title of this chart
Chart setTitle Sets title of this chart
LineChart setTitle Sets title of this chart
PieChart setTitle Sets title of this chart
ScatterPlotChart setTitle Sets title of this chart
11-09-2009
Object Method Return Type Description
Browser getLanguage String Returns locale language for the request or empty string if no locale information in the request.
Document getPageCount int Returns the number of pages in this document. For PDF and ad-hoc, it returns the actual number of pages. For html, it returns 1 regardless of how many pages there may be.
AudioFile isAdHocConversionSupported boolean Returns true if the content supports immediate conversion to adhoc. See Packet.createAdHocDocument(File,...)
DatasetFile isAdHocConversionSupported boolean Returns true if the content supports immediate conversion to adhoc. See Packet.createAdHocDocument(File,...)
DocumentFile isAdHocConversionSupported boolean Returns true if the content supports immediate conversion to adhoc. See Packet.createAdHocDocument(File,...)
ExcelFile isAdHocConversionSupported boolean Returns true if the content supports immediate conversion to adhoc. See Packet.createAdHocDocument(File,...)
File isAdHocConversionSupported boolean Returns true if the content supports immediate conversion to adhoc. See Packet.createAdHocDocument(File,...)
ImageFile isAdHocConversionSupported boolean Returns true if the content supports immediate conversion to adhoc. See Packet.createAdHocDocument(File,...)
PdfFile isAdHocConversionSupported boolean Returns true if the content supports immediate conversion to adhoc. See Packet.createAdHocDocument(File,...)
VCardFile isAdHocConversionSupported boolean Returns true if the content supports immediate conversion to adhoc. See Packet.createAdHocDocument(File,...)
11-05-2009
Object Method Return Type Description
Data combineValues String Substitutes in JEXL values. Treats null values as "" (empty string). (ex: data.combineValues("${first} ${last}") could be converted to John Doe). Nesting is permitted up to 50 iterations after which an exception occurs.
11-04-2009
Object Method Return Type Description
Formatter formatPhone String Formats a 10 digit phone number. (ex: 1234567890 converts to (123) 456-7890). Returns phone parameter without formatting if the length of the string is not 10.
Formatter formatSSN String Formats a 9 digit social security number. (ex: 123456789 converts to 123-45-6789). Returns ssn parameter without formatting if the length of the string is not 9.
10-28-2009
Object Method Return Type Description
DataSet getRecords DataViewList Returns records that match the filter criteria and sets the name of the list. Filter can be null.
DataView getRecords DataViewList Returns records that match the filter criteria and sets the name of the list. Filter can be null.
10-27-2009
Object Method Return Type Description
TransactionWebServiceController getPalInfo PalInfo The PalInfo for the specified palId.
Pal getVersion String Returns the version of the Pal.
PalInfo getVersion String Returns the version of the Pal.
RuntimePal getVersion String Returns the version of the Pal.
ShellPal getVersion String Returns the version of the Pal.
Pal hasLogo boolean Returns true if the Pal has a logo associated with it.
PalInfo hasLogo boolean Returns true if the Pal has a logo associated with it.
RuntimePal hasLogo boolean Returns true if the Pal has a logo associated with it.
ShellPal hasLogo boolean Returns true if the Pal has a logo associated with it.
Pal isLinked boolean Returns true if the Pal is a linked Pal.
PalInfo isLinked boolean Returns true if the Pal is a linked Pal.
RuntimePal isLinked boolean Returns true if the Pal is a linked Pal.
ShellPal isLinked boolean Returns true if the Pal is a linked Pal.
Pal isShadow boolean Returns true if the Pal is a shadow Pal.
PalInfo isShadow boolean Returns true if the Pal is a shadow Pal.
RuntimePal isShadow boolean Returns true if the Pal is a shadow Pal.
ShellPal isShadow boolean Returns true if the Pal is a shadow Pal.
Pal isTestMode boolean Returns true if the Pal is being executed in test mode.
PalInfo isTestMode boolean Returns true if the Pal is being executed in test mode.
RuntimePal isTestMode boolean Returns true if the Pal is being executed in test mode.
ShellPal isTestMode boolean Returns true if the Pal is being executed in test mode.
10-26-2009
Object Method Return Type Description
AnalyticDataViewFilter dayOfYear returns the day of the year of the specified date column as a number 1-366 using the specified resultAlias
AnalyticDataViewFilter weekOfYear returns the week of the year of the specified date column as a number 0-53 using the specified resultAlias
AnalyticDataViewFilter weekday returns the weekday of the specified date column as a number 0-6 (0 = Monday, 1 = Tuesday, ... 6 = Sunday) using the specified resultAlias
10-20-2009
Object Method Return Type Description
DataSet createRecord DataSetRecord Creates a new, empty record.
10-15-2009
Object Method Return Type Description
Validator isEmpty boolean Returns true if the value is null or contains only whitespace characters or empty string.
Validator isValidPostalCode boolean Returns true if the postal code is an acceptable format for the specified country. (10/15/2009 - US support only)
Formatter trim String Returns the value with leading and trailing whitespace removed.
10-07-2009
Object Method Return Type Description
Packet createData Data If a data object already exists in the packet with the given name, then returns that data object, otherwise creates a new data object with the given name.
TransactionPacket createData Data If a data object already exists in the packet with the given name, then returns that data object, otherwise creates a new data object with the given name.
10-06-2009
Object Method Return Type Description
DataList toData Data Creates a Data object with keys coming from key column and values from value column. Overwrites any keys that are duplicated. Returns null if the keyColumn or valueColumn does not exist. If addNullValues is true then null values will be added as empty string.
DataViewList toData Data Creates a Data object with keys coming from key column and values from value column. Overwrites any keys that are duplicated. Returns null if the keyColumn or valueColumn does not exist. If addNullValues is true then null values will be added as empty string.
PacketDataList toData Data Creates a Data object with keys coming from key column and values from value column. Overwrites any keys that are duplicated. Returns null if the keyColumn or valueColumn does not exist. If addNullValues is true then null values will be added as empty string.
StorageProviderDataList toData Data Creates a Data object with keys coming from key column and values from value column. Overwrites any keys that are duplicated. Returns null if the keyColumn or valueColumn does not exist. If addNullValues is true then null values will be added as empty string.
10-02-2009
Object Method Return Type Description
Packet addDocumentFromFile Document Adds the specified content to the packet as a document and populates the document with the data. The file should be PDF or HTML.
TransactionPacket addDocumentFromFile Document Adds the specified content to the packet as a document and populates the document with the data. The file should be PDF or HTML.
09-25-2009
Object Method Return Type Description
Pal checkTransactionAccess boolean Returns true if the Pal is accessible by the identified profile.
PalInfo checkTransactionAccess boolean Returns true if the Pal is accessible by the identified profile.
RuntimePal checkTransactionAccess boolean Returns true if the Pal is accessible by the identified profile.
ShellPal checkTransactionAccess boolean Returns true if the Pal is accessible by the identified profile.
Pal getCategory String Returns the category of the Pal.
PalInfo getCategory String Returns the category of the Pal.
RuntimePal getCategory String Returns the category of the Pal.
ShellPal getCategory String Returns the category of the Pal.
Pal getDescription String Returns the description of the Pal.
PalInfo getDescription String Returns the description of the Pal.
RuntimePal getDescription String Returns the description of the Pal.
ShellPal getDescription String Returns the description of the Pal.
Pal getName String Returns the name of the Pal.
PalInfo getName String Returns the name of the Pal.
RuntimePal getName String Returns the name of the Pal.
ShellPal getName String Returns the name of the Pal.
Pal getStoreId String If the Pal is published in the store, returns the storeId.
PalInfo getStoreId String If the Pal is published in the store, returns the storeId.
RuntimePal getStoreId String If the Pal is published in the store, returns the storeId.
ShellPal getStoreId String If the Pal is published in the store, returns the storeId.
PalInfo toString String Returns a description of this object.
09-24-2009
Object Method Return Type Description
Document addAttachment Attachment HTML documents only. See Packet.addAttachment(File...) and Packet.getAttachment. This method works only from an attachment obtained from the packet.
ShellPal addOrReplaceAttachment boolean Returns true if the attachment contained in the file upload is successfully added to the Pal as a new attachment or as a replacement.
ShellPal addOrReplaceDocument boolean Returns true if the document contained in the file upload is successfully added to the Pal as a new document or as a replacement.
ShellPal getAuthDomain String Returns the auth domain: auth.mysite.com, returns auth.mysite.com.
ShellPal getAuthSubDomain String Returns the subdomain of the auth domain: auth.mysite.com, returns auth.
ShellPal getAuthTopDomain String Returns the top domain of the auth domain: auth.mysite.com, returns mysite.com.
ShellPal getConsolePacketProperties Data Returns the Console Packet properties for the Pal. The Data is read/write but not persisted. Call setConsolePacketProperties to persist it.
ShellPal getConsoleUserPacketProperties Data Returns the User Console Packet properties for the Pal. The Data is read/write but not persisted. Call setConsoleUserPacketProperties to persist it.
ShellPal getData Data Returns the specified Data object from this Pal. The Data is read/write but not persisted. Call setData to persist it.
ShellPal getDataList DataList Returns the specified DataList from this Pal.
ShellPal getLogoName String Returns the file name of the logo for this Pal.
ShellPal getPacketProperties Data Returns the Packet properties for the Pal. The Data is read/write but not persisted. Call setPacketProperties to persist it.
ShellPal getWebDomain String Returns the web domain: www.mysite.com, returns www.mysite.com.
ShellPal getWebSubDomain String Returns the subdomain of the web domain: www.mysite.com, returns www.
ShellPal getWebTopDomain String Returns the top domain of the web domain: www.mysite.com, returns mysite.com.
ShellPal setAuthDomain boolean Sets the domain for the custom authentication of the Pal. Pass null to remove. See InternalDomain.getDomains()
ShellPal setConsolePacketProperties boolean Sets the Console Packet properties for the Pal.
ShellPal setConsoleUserPacketProperties boolean Sets the User Console Packet properties for the Pal.
ShellPal setData boolean Replaces the specified Data in this this Pal or adds it if it does not exist.
ShellPal setDataList boolean Replaces the specified DataList in this this Pal or adds it if it does not exist.
ShellPal setLogo boolean Sets the logo for the Pal. Pass null to remove the logo.
ShellPal setPacketProperties boolean Sets the Packet properties for the Pal.
ShellPal setWebDomain boolean Sets the domain for the Web module of the Pal. Pass null to remove. See InternalDomain.getDomains()
09-23-2009
Object Method Return Type Description
Packet getScheduledDeleteDate Date If this transaction has been scheduled for deletion, returns the date. Otherwise returns null. See scheduleDelete method.
TransactionPacket getScheduledDeleteDate Date If this transaction has been scheduled for deletion, returns the date. Otherwise returns null. See scheduleDelete method.
09-15-2009
Object Method Return Type Description
Document getCreateDate Date Returns the date this document was created
Packet getDocumentsAndSignatures DataList Returns a read-only DataList of all the documents and signatures in this transaction. The name of the datalist is 'documents'.
TransactionPacket getDocumentsAndSignatures DataList Returns a read-only DataList of all the documents and signatures in this transaction. The name of the datalist is 'documents'.
Document getModifiedDate Date Returns last modified date of the document
Document getModifiedEmail String Returns email of last modifier of the document
Document getModifiedUser String Returns name of last modifier of the document
Document getUserSignatures DataList Returns a DataList containing signature information for this document for specified user.
Document setSigner boolean Sets signer information for signature. Returns false if the signature doesn't exist or is already signed.
09-14-2009
Object Method Return Type Description
DateUtil parseDate Date Creates a date from the given string. Format should adhere to pattern. See java.text.SimpleDateFormat API documentation for more information about possible patterns.
09-11-2009
Object Method Return Type Description
PacketDataList deleteRecords Deletes records matching specified filter.
DataList findRecord DataRecord Finds the first record matching the given filter. Returns null if no matching record found.
DataViewList findRecord DataRecord Finds the first record matching the given filter. Returns null if no matching record found.
StorageProviderDataList findRecord DataRecord Finds the first record matching the given filter. Returns null if no matching record found.
09-09-2009
Object Method Return Type Description
Attachment setDescription Sets the description of this attachment
Attachment setName Sets the name of this attachment
09-08-2009
Object Method Return Type Description
Attachment getCreator String Returns creator name for this Attachment
Attachment getLastModifiedDate Date Returns last modification time stamp for this Attachment
Attachment getLastModifier String Returns last modifier name for this Attachment
Attachment isHTMLConversionSupported boolean Returns true if this attachment can be converted to HTML. Currently supported: doc, docx, rtf, odt.
PalActivationKeyInfo isStoreEnabled boolean Returns true if this activation key permits Store installations.
09-03-2009
Object Method Return Type Description
Document getAllData Data Returns (Read only) all the data elements contained in this document. If the value of the element is null, its value is set to nullValue in this Data object. Any pending updates (Document.getData().setValue or Document.setValue) are committed when this call is made.
09-02-2009
Object Method Return Type Description
SystemDataView getRecords DataViewList Returns records that match the filter criteria and sets the name of the list. Filter can be null
08-27-2009
Object Method Return Type Description
Packet addDocumentFromAttachment Document Adds the specified attachment to the packet as a document. The attachment should be PDF
TransactionPacket addDocumentFromAttachment Document Adds the specified attachment to the packet as a document. The attachment should be PDF
08-19-2009
Object Method Return Type Description
Attachment getId String Returns the id of this attachment
08-17-2009
Object Method Return Type Description
Document showSaveButtons Renders save and cancel buttons in the document. See document.enableEditing. This method is mutually exclusive with signing. You can have sign buttons or save buttons, but not both at the same time. Pass null for ajaxHandler if you are not using AJAX. For PDF documents this works only if you are rendering as 'smart' documents. The saveId and cancelId targets should be 'saveTop', 'cancelTop', 'saveBottom', 'cancelBottom', 'saveBoth', or 'cancelBoth'. For PDF, the buttons will be contained in divs with ID 'navTop' and 'navBottom' For HTML documents, they should be elements with an ID that already exists in the document DOM.
08-10-2009
Object Method Return Type Description
PalActivationKeyInfo isUserWebServiceEnabled boolean Returns true if user web service workflow is enabled.
08-07-2009
Object Method Return Type Description
Document getRoles DataList Returns a unique datalist of role names associated with the signatures in this document.
08-03-2009
Object Method Return Type Description
PalActivationKeyInfo isConsoleWebServiceEnabled boolean Returns true if the ability to run Console Web Service workflow is enabled.
07-15-2009
Object Method Return Type Description
TransactionWebServiceController getBusinessUtil BusinessUtil Returns a BusinessUtil object.
07-14-2009
Object Method Return Type Description
BusinessUtil getNAICSChildCodes DataList Returns a list North American Industry Classification System (NAICS) codes that are children of the specified code.
BusinessUtil getNAICSCodes DataList Returns a list North American Industry Classification System (NAICS) top level codes.
BusinessUtil getStateList DataList Returns a list of states names from the country. Returns null if countryCode is null or empty. Returns empty list of countryCode is not found.
BusinessUtil toString String Returns a description of this object.
07-06-2009
Object Method Return Type Description
Enterprise getAddress String Returns the address of the enterprise.
EnterpriseInfo getAddress String Returns the address of the enterprise.
Profile getAddress String Returns the address of the user associated with this profile.
Enterprise getCity String Returns the city of the enterprise.
EnterpriseInfo getCity String Returns the city of the enterprise.
Profile getCity String Returns the city of the user associated with this profile.
Enterprise getCountry String Returns the country of the enterprise.
EnterpriseInfo getCountry String Returns the country of the enterprise.
Profile getCountry String Returns the country of the user associated with this profile.
Enterprise getCountryCode String Returns the country code of the enterprise.
EnterpriseInfo getCountryCode String Returns the country code of the enterprise.
Profile getCountryCode String Returns the country code of the user associated with this profile.
Enterprise getData Data Returns a Data object with information from this enterprise. The amount of information depends on what the enterprise has enabled for public access. Minimum information available is the name of the enterprise.
EnterpriseInfo getData Data Returns a Data object with information from this enterprise. The amount of information depends on what the enterprise has enabled for public access. Minimum information available is the name of the enterprise.
Profile getEnterprise EnterpriseInfo Returns the enterprise that owns this profile or null if it is a personal profile.
ProfileInfo getEnterprise EnterpriseInfo Returns the enterprise that owns this profile or null if it is a personal profile.
Enterprise getFax String Returns the fax of the enterprise.
EnterpriseInfo getFax String Returns the fax of the enterprise.
Profile getFax String Returns the fax of the user associated with this profile.
Enterprise getLanguage String Returns the language of the enterprise.
EnterpriseInfo getLanguage String Returns the language of the enterprise.
Profile getLanguage String Returns the language of the user associated with this profile.
Profile getMiddleName String Returns the middle name of the user associated with this profile.
Enterprise getName String Returns the name of this enterprise.
EnterpriseInfo getName String Returns the name of this enterprise.
Enterprise getPhone String Returns the phone of the enterprise.
EnterpriseInfo getPhone String Returns the phone of the enterprise.
Profile getPhone String Returns the phone of the user associated with this profile.
Enterprise getPostalCode String Returns the postal code of the enterprise.
EnterpriseInfo getPostalCode String Returns the postal code of the enterprise.
Profile getPostalCode String Returns the postal code of the user associated with this profile.
Role getProfile ProfileInfo Returns profile associated with this role.
Enterprise getState String Returns the state of the enterprise.
EnterpriseInfo getState String Returns the state of the enterprise.
Profile getState String Returns the state of the user associated with this profile.
Enterprise getStateCode String Returns the state code of the enterprise.
EnterpriseInfo getStateCode String Returns the state code of the enterprise.
Profile getStateCode String Returns the state code of the user associated with this profile.
Enterprise getTimeZone String Returns the time zone of the enterprise.
EnterpriseInfo getTimeZone String Returns the time zone of the enterprise.
Profile getTimeZone String Returns the time zone of the user associated with this profile.
Enterprise getTimeZoneCode String Returns the time zone code of the enterprise.
EnterpriseInfo getTimeZoneCode String Returns the time zone code of the enterprise.
Profile getTimeZoneCode String Returns the time zone code of the user associated with this profile.
Profile getTitle String Returns the title or job title of the user associated with this profile.
06-22-2009
Object Method Return Type Description
Email attachAttachment boolean Attaches the specified Attachment to the email. Attachment limit is maximum transaction packet size.
06-05-2009
Object Method Return Type Description
PagingInfo getCurrentPage Integer Returns the number of the current page. Only set if DataViewFilter.filterByPage has been called.
06-02-2009
Object Method Return Type Description
Document addWizard Adds the content and data from the given wizard dialog to the document. Supported for HTML documents only.
Email setGroupUse Identifies this email as destined for a group email address (as opposed to a specific user email address). Access to Navigator from this link requires (a) the person accessing the transaction must already have an account and (b) the person must have an enterprise profile on the enterprise associated with the transaction. Best practices: either set the email to single use or specify an appropriate expiration date.
06-01-2009
Object Method Return Type Description
Profile hasRole boolean Returns true if the profile has a role on the specified transaction.
ProfileInfo hasRole boolean Returns true if the profile has a role on the specified transaction.
05-31-2009
Object Method Return Type Description
ServiceResponse getCookie String Returns cookie by name
05-29-2009
Object Method Return Type Description
DateUtil addMinutes Date Returns a new Date offset in minutes from the given date.
05-27-2009
Object Method Return Type Description
TextEmail attachDocument boolean Attaches the specified document as an attachment to the email. The document will be converted to pdf if it is not already a pdf. This method returns false if the document is not a PDF or cannot be converted to a PDF. Limit 5 documents or attachments per email.
TransactionWebServiceController createTextEmail TextEmail Creates a text-based (body is text as opposed to XHTML) email.
TextEmail removeAttachments Removes the attachments, if any.
TextEmail sendToAddress Sends the email to the specified email address.
TextEmail setReplyTo Sets the replyTo email address.
TextEmail setSubject Sets the subject of the email (over-rides the subject set during Pal development).
TextEmail toString String Returns a description of this object.
05-26-2009
Object Method Return Type Description
Email setNewUserEmailValidation This method applies only to new users who will create an account as a result of accessing the transaction from an email link. This is false by default. If set to true, the user will be forced to validate the email as part of the account creation process.
05-21-2009
Object Method Return Type Description
TransactionWebServiceController createGUID String 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
05-18-2009
Object Method Return Type Description
DataViewList getPagingInfo PagingInfo Returns the paging info object. This object will only be set if the filterByPage or enablePaging methods were called from DataViewFilter.
PagingInfo toString String Returns a description of this object.
05-14-2009
Object Method Return Type Description
PalActivationKeyInfo isAuthEnabled boolean Returns true if this activation key permits authentication (login) processes.
05-06-2009
Object Method Return Type Description
PagingInfo getFirstPage Integer Returns the page number of the first page. Only set if DataViewFilter.filterByPage has been called.
PagingInfo getLastPage Integer Returns the page number of the last page. Only set if DataViewFilter.filterByPage has been called.
PagingInfo getNextPage Integer Returns the page number of the next page. Only set if DataViewFilter.filterByPage has been called.
PagingInfo getPageCount Integer Returns the total page count. Only set if DataViewFilter.filterByPage has been called.
PagingInfo getPreviousPage Integer Returns the page number of the previous page. Only set if DataViewFilter.filterByPage has been called.
PagingInfo hasNextPage Boolean Returns true if there is a next page. Only set if DataViewFilter.filterByPage has been called.
PagingInfo hasPreviousPage Boolean Returns true if there is a previous page. Only set if DataViewFilter.filterByPage has been called.
05-04-2009
Object Method Return Type Description
Document addTarget String Creates a div element with the specified ID and appends it to the root document element. If id is null, a GUID is created and returned. This method is for HTML documents only.
04-28-2009
Object Method Return Type Description
DataList findRecord DataRecord Returns the first record whose column matches the given value.
DataViewList findRecord DataRecord Returns the first record whose column matches the given value.
StorageProviderDataList findRecord DataRecord Returns the first record whose column matches the given value.
04-27-2009
Object Method Return Type Description
TransactionWebServiceController createMessage TextMessage Creates a new Message object.
TextMessage getData Data Returns the Data object for this email.
Validator isValidSMS boolean Returns true if the address is a valid SMS address.
TextMessage sendTextMessage boolean Sends the message to the specified SMS address. Requires the number and carrier in email format (e.g. 8882221111@provider.com)
TextMessage setMessage Sets the message body.
TextMessage setSubject Sets the message subject.
Email setValidationCode Creates a validation code and replaces the specified target in the message body with the code.
TextMessage setValidationCode Creates a validation code and replaces the specified target in the message body with the code.
TextMessage toString String Returns a description of this object.
04-01-2009
Object Method Return Type Description
AudioFile getFailureMessage String When isValid is false, contains failure message.
DatasetFile getFailureMessage String When isValid is false, contains failure message.
DocumentFile getFailureMessage String When isValid is false, contains failure message.
ExcelFile getFailureMessage String When isValid is false, contains failure message.
File getFailureMessage String When isValid is false, contains failure message.
ImageFile getFailureMessage String When isValid is false, contains failure message.
PdfFile getFailureMessage String When isValid is false, contains failure message.
VCardFile getFailureMessage String When isValid is false, contains failure message.
03-30-2009
Object Method Return Type Description
Profile hasConsoleAccess boolean Returns true if this profile can access the specified Console Pal.
ProfileInfo hasConsoleAccess boolean Returns true if this profile can access the specified Console Pal.
03-25-2009
Object Method Return Type Description
PalActivationKeyInfo getMaxExportSize int Returns the maximum export size (in kilobytes).
DataList getTotalRecordCount int Returns the total count of records that match the DataListFilter.
DataViewList getTotalRecordCount int Returns the total count of records that match the DataListFilter.
PacketDataList getTotalRecordCount int Returns the total count of records that match the DataListFilter.
StorageProviderDataList getTotalRecordCount int Returns the total count of records that match the DataListFilter.
Validator isValidFaxNumber boolean Returns true if the number is a valid fax number.
DataListFilter setFirstRecord Set the first record to return.
DataListFilter setPageSize Set the page size (max 1000, min 1, default 100).
03-19-2009
Object Method Return Type Description
DateUtil getEndOfDay Date Returns a new Date which is the beginning of the given day (the time will be 11:59:59 PM).
DateUtil getStartOfDay Date Returns a new Date which is the beginning of the given day (the time will be 12:00:00 AM).
PalActivationKeyInfo isConsoleSystemEnabled boolean Returns true if the ability to run Console System workflow is enabled.
03-06-2009
Object Method Return Type Description
Attachment getDisplaySettings DisplaySettings Returns the DisplaySettings for this Attachment
03-03-2009
Object Method Return Type Description
DataList joinDataList PacketDataList Joins the DataList with this one into a new DataList that is joined by the joinColumn and that has the columns of both data lists.
DataViewList joinDataList PacketDataList Joins the DataList with this one into a new DataList that is joined by the joinColumn and that has the columns of both data lists.
PacketDataList joinDataList PacketDataList Joins the DataList with this one into a new DataList that is joined by the joinColumn and that has the columns of both data lists.
StorageProviderDataList joinDataList PacketDataList Joins the DataList with this one into a new DataList that is joined by the joinColumn and that has the columns of both data lists.
02-23-2009
Object Method Return Type Description
DisplaySettings isHidePdfMenubar boolean Returns hidePdfMenubar setting
DisplaySettings isHidePdfToolbar boolean Returns hidePdfToolbar setting
DisplaySettings setHidePdfMenubar Specifies whether or not PDF menu bar should be visible.
DisplaySettings setHidePdfToolbar Specifies whether or not PDF tool bar should be visible.
02-17-2009
Object Method Return Type Description
Wizard getDisplaySettings DisplaySettings Returns the DisplaySettings for this Wizard
02-13-2009
Object Method Return Type Description
DisplaySettings isHidePdfUI boolean Returns hidePdfUI setting
DisplaySettings positionSigning Positions the signing technology (audio, image) in the page inside the element identified by targetId.
DisplaySettings scrollToAnchor Default is false. If true, ContractPal document will scroll to the just signed signature. With PDF documents, should only be used when document scroll is true.
DisplaySettings setDisplaySettings Globally sets all the properties of this DisplaySettings based on information passed in the Data object. Keys in the Data object should match method signatures. For example: documentStyleSheet or pdfRejectButtonColors-textColor.
DisplaySettings setDocumentScroll boolean Default is true. If false, the frame containing the ContractPal document will be resized so the document does not have scrollbars. Returns false if unable to resize.
DisplaySettings setDocumentStyleSheet Sets the stylesheet (from the Pal) to be used for validation adornment. When this is set, the default Navigator stylesheet is removed.
DisplaySettings setHidePdfUI Specifies whether or not PDF UI should be visible.
DisplaySettings setPdfRejectButtonColors Sets the text and background colors of the reject button in a pdf. Either a color name or six digit hex number (#XXXXXX). Color names are listed in the Misc section: color names.
DisplaySettings setPdfSignButtonColors Sets the text and background colors of the sign button in a pdf. Either a color name or six digit hex number (#XXXXXX). Color names are listed in the Misc section: color names.
DisplaySettings setResetSignatureScroll Default is false. If true, ContractPal document will scroll to the just signed signature. With PDF documents, should only be used when document scroll is true.
DisplaySettings setSignatureScroll Default is false. If true, ContractPal document will scroll to the signature to be signed. With PDF documents, should only be used when document scroll is true.
DisplaySettings setUsePalStyleSheet If true, removes the default Navigator styles for wizard validation. Calling this method assumes you will provide your own alternative CSS classes for [sample, answerRequiredValue, and answerIllegalFormat].
02-10-2009
Object Method Return Type Description
SystemDataView getTotalRecordCount int Returns the total count of records that match the DataViewFilter
02-06-2009
Object Method Return Type Description
Document getDisplaySettings DisplaySettings Returns the DisplaySettings for this Document. DisplaySettings are used for rendering to Browser or print to PDF.
Document isPdf boolean Returns true if this Document is PDF.
DisplaySettings toString String Returns a description of this object.
02-04-2009
Object Method Return Type Description
Profile getId String Returns unique ID of profile. Returns null if profile is not registered.
ProfileInfo getId String Returns unique ID of profile. Returns null if profile is not registered.
02-03-2009
Object Method Return Type Description
TransactionWebServiceController getErrors DataList Returns a list of errors.
01-28-2009
Object Method Return Type Description
Attachment isPdfConversionSupported boolean Returns true if the content supports conversion to PDF.
01-19-2009
Object Method Return Type Description
DataList addDataList PacketDataList Combines the given DataList with this one in a new DataList. Columns that match the names of this DataList are included and others are omited.
DataViewList addDataList PacketDataList Combines the given DataList with this one in a new DataList. Columns that match the names of this DataList are included and others are omited.
PacketDataList addDataList PacketDataList Combines the given DataList with this one in a new DataList. Columns that match the names of this DataList are included and others are omited.
StorageProviderDataList addDataList PacketDataList Combines the given DataList with this one in a new DataList. Columns that match the names of this DataList are included and others are omited.
DataList applyFilter DataList Returns a new DataList with records from this list that match the filter.
DataViewList applyFilter DataList Returns a new DataList with records from this list that match the filter.
PacketDataList applyFilter DataList Returns a new DataList with records from this list that match the filter.
StorageProviderDataList applyFilter DataList Returns a new DataList with records from this list that match the filter.
SystemDataView createFilter SystemDataViewFilter Creates a new DataViewFilter for this DataView.
Document enableEditing Allows specified fields to be edited
DataList getColumnNames String[] Returns the columns of this DataList
DataViewList getColumnNames String[] Returns the columns of this DataList
PacketDataList getColumnNames String[] Returns the columns of this DataList
StorageProviderDataList getColumnNames String[] Returns the columns of this DataList
SystemDataView getColumns DataList Returns a read-only DataList containing column information.
PagingInfo getData Data Returns a Data object with information from this paging info.
Profile getData Data Returns a Data object with information from this profile. The amount of information depends on what the user has enabled for public access. Minimum information available is firstName, lastName, and emailAdress and boolean: personal or enterprise.
ProfileInfo getData Data Returns a Data object with information from this profile. The amount of information depends on what the user has enabled for public access. Minimum information available is firstName, lastName, and emailAdress and boolean: personal or enterprise.
DataSetRecord getDecryptedValue String Returns the decrypted value of the encrypted column.
SystemDataView getName String Returns the name of this DataSet.
SystemDataView getRecords DataViewList Returns records that match the filter criteria.
DataList mergeDataList PacketDataList Merges the DataList with this one into a new DataList using an indexed column. All records in this list are kept but the values that match the index column are replaced by those in the supplied dataList. The index column should contain unique values representing a 1:1 relationship between the two lists.
DataViewList mergeDataList PacketDataList Merges the DataList with this one into a new DataList using an indexed column. All records in this list are kept but the values that match the index column are replaced by those in the supplied dataList. The index column should contain unique values representing a 1:1 relationship between the two lists.
PacketDataList mergeDataList PacketDataList Merges the DataList with this one into a new DataList using an indexed column. All records in this list are kept but the values that match the index column are replaced by those in the supplied dataList. The index column should contain unique values representing a 1:1 relationship between the two lists.
StorageProviderDataList mergeDataList PacketDataList Merges the DataList with this one into a new DataList using an indexed column. All records in this list are kept but the values that match the index column are replaced by those in the supplied dataList. The index column should contain unique values representing a 1:1 relationship between the two lists.
DataSet setDateFormat Sets the date pattern for displaying dates.
DataView setDateFormat Sets the date pattern for displaying dates.
SystemDataView setDateFormat Sets the date pattern for displaying dates.
DataSetRecord toString String Returns a description of this object.
DataViewList toString String Returns a description of this object.
DataViewRecord toString String Returns a description of this object.
PacketDataList toString String Returns a description of this object.
PacketDataRecord toString String Returns a description of this object.
SystemDataView toString String Returns a description of this object.
01-14-2009
Object Method Return Type Description
AnalyticDataViewFilter day returns the day portion of the specified date column as a number 1-31 using the specified resultAlias
AnalyticDataViewFilter dayOfWeek returns the weekday index of the specified date column as a number 1-7 (Sunday=1, Monday=2,...,Saturday=7) using the specified resultAlias
Formatter getMonthAsWord String Converts a number 1-12 to month. (ex: 11 converts to 'November')
Formatter getShortMonthAsWord String Converts a number 1-12 to abbreviated month. (ex: 11 converts to 'Nov')
AnalyticDataViewFilter hour returns the hour of the specified date column as a number 0-23 using the specified resultAlias
AnalyticDataViewFilter minute returns the minute of the specified date column as a number 0-59 using the specified resultAlias
AnalyticDataViewFilter month returns the month portion of the specified date column as a number 1-12 using the specified resultAlias
AnalyticDataViewFilter quarter returns the quarter of the specified date column as a number 1-4 using the specified resultAlias
AnalyticDataViewFilter second returns the second of the specified date column as a number 0-59 using the specified resultAlias
AnalyticDataViewFilter week returns the week number of the specified date column as a number 0-52 using the specified resultAlias
AnalyticDataViewFilter year returns the year portion of the specified date column using the specified resultAlias
01-13-2009
Object Method Return Type Description
DataList createAndFilter DataListFilter Creates an empty DataListFilter based on this DataList. Filter will return records matching all constraints.
DataViewList createAndFilter DataListFilter Creates an empty DataListFilter based on this DataList. Filter will return records matching all constraints.
PacketDataList createAndFilter DataListFilter Creates an empty DataListFilter based on this DataList. Filter will return records matching all constraints.
StorageProviderDataList createAndFilter DataListFilter Creates an empty DataListFilter based on this DataList. Filter will return records matching all constraints.
DataList createOrFilter DataListFilter Creates an empty DataListFilter based on this DataList. Filter will return records matching any constraints.
DataViewList createOrFilter DataListFilter Creates an empty DataListFilter based on this DataList. Filter will return records matching any constraints.
PacketDataList createOrFilter DataListFilter Creates an empty DataListFilter based on this DataList. Filter will return records matching any constraints.
StorageProviderDataList createOrFilter DataListFilter Creates an empty DataListFilter based on this DataList. Filter will return records matching any constraints.
01-09-2009
Object Method Return Type Description
DataListFilter addContains Return records where column contains value.
12-31-2008
Object Method Return Type Description
ProfilePacket createDataList PacketDataList Creates a new persistent DataList and returns it. Maximum column size is 20. Quietly over-rides any existing DataList with the same name. Column names cannot be null or empty.
ProfilePacket deleteData Deletes the Data object with the given name.
ProfilePacket deleteDataList Deletes the specified DataList.
ProfilePacket deleteProperty Deletes the specified property.
ProfilePacket getData Data Returns the named Data object. Modifications to the content of the Data object are automatically persisted.
ProfilePacket getDataList PacketDataList Returns the specified DataList if it exists, or null if it does not.
ProfilePacket getDefaultProperty String Returns the given property. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
ProfilePacket getProperties Data Returns all properties of this Packet. Changes made to these items are automatically persisted.
ProfilePacket getProperty String Returns the specified property.
ProfilePacket getStatus String Returns the status of the packet.
ProfilePacket isStatus boolean Returns true if the packet status is the specified status.
ProfilePacket setData Saves the Data object with the given name, over-writing any existing Data object with the same name.
ProfilePacket setDataList Saves the specified DataList, over-writing any other table that might exist with the same name.
ProfilePacket setProperty Sets the specified property.
ProfilePacket setStatus Sets the status of the packet.
ProfilePacket toString String Returns a description of this object.
12-19-2008
Object Method Return Type Description
Packet getAllAttachments DataList Returns a DataList containing information on attachments of this packet and all of its documents.
TransactionPacket getAllAttachments DataList Returns a DataList containing information on attachments of this packet and all of its documents.
12-18-2008
Object Method Return Type Description
Packet addGroup boolean Associates this packet with the specified private group. Returns false if the group does not exist.
TransactionPacket addGroup boolean Associates this packet with the specified private group. Returns false if the group does not exist.
Packet getGroups DataList Returns a DataList of all groups associated with this packet.
Profile getGroups DataList Returns a DataList of all groups this profile is a member of.
TransactionPacket getGroups DataList Returns a DataList of all groups associated with this packet.
Profile isGroupMember boolean Returns true if this profile is a member of the specified private group.
Packet removeGroup Removes the packet from the specified private group.
TransactionPacket removeGroup Removes the packet from the specified private group.
12-17-2008
Object Method Return Type Description
Email sendToGroup int Sends this email to all users of the specified group who have the Access Transaction permission on this Transaction. Returns the number of emails sent.
12-03-2008
Object Method Return Type Description
Formatter chop String If the value exceeds the given size, this method chops and returns it the value, optionally with ellipses (...).
Document getAuditLogs DataList Returns the audit log entries associated with this Document.
Packet getAuditLogs DataList Returns the audit log entries associated with this Packet and all of its documents.
TransactionPacket getAuditLogs DataList Returns the audit log entries associated with this Packet and all of its documents.
Packet getEmails DataList Returns all email jobs related to this Packet.
TransactionPacket getEmails DataList Returns all email jobs related to this Packet.
DataListFilter toString String Returns a description of this object.
DataRecord toString String Returns a description of this object.
11-26-2008
Object Method Return Type Description
Document deleteAttachment boolean Deletes the attachment with the given name. Returns false if no attachment exists with the name. This method also returns false if the document has any signed signatures.
Packet deleteAttachment boolean Deletes the attachment with the given name. Returns false if no attachment exists with the name.
TransactionPacket deleteAttachment boolean Deletes the attachment with the given name. Returns false if no attachment exists with the name.
Document isEditAttachmentsAllowed boolean Returns true if the document has no signatures or if no signatures have been signed.
11-25-2008
Object Method Return Type Description
Packet getMaxUploadSize int Returns the maximum size in KB that can be uploaded to this Packet. This will never be more than the max upload setting of the activation key. This number changes as the transaction size increases or decreases.
TransactionPacket getMaxUploadSize int Returns the maximum size in KB that can be uploaded to this Packet. This will never be more than the max upload setting of the activation key. This number changes as the transaction size increases or decreases.
Packet getSize int Returns the size of this Packet in bytes.
TransactionPacket getSize int Returns the size of this Packet in bytes.
11-18-2008
Object Method Return Type Description
Packet addAttachment Attachment Logically attaches the contents of the given File to this packet. Returns null if doing so exceeds the transaction size. Name is the id by which the Pal developer will access the file, pass null for name to have a GUID automatically assigned. The description is what you should display to the user, it is the description of the attachment.
TransactionPacket addAttachment Attachment Logically attaches the contents of the given File to this packet. Returns null if doing so exceeds the transaction size. Name is the id by which the Pal developer will access the file, pass null for name to have a GUID automatically assigned. The description is what you should display to the user, it is the description of the attachment.
Document getAttachment Attachment Returns the attachment identified by name. Returns null if no attachment exists with the given name.
Packet getAttachment Attachment Returns the attachment identified by name. Returns null if no attachment exists with the given name.
TransactionPacket getAttachment Attachment Returns the attachment identified by name. Returns null if no attachment exists with the given name.
Document getAttachments DataList Returns a DataList containing information on all attachments of this document.
Packet getAttachments DataList Returns a DataList containing information on attachments of this packet.
TransactionPacket getAttachments DataList Returns a DataList containing information on attachments of this packet.
Attachment getContentType String Returns the content type of this attachment
Attachment getDescription String Returns the description of this attachment
Attachment getFileSize int Returns the size of this attachment in KB
Attachment getName String Returns the name of this attachment
Formatter toLowerCase String Returns the value as all lower case.
Attachment toString String Returns a description of this object.
Formatter toUpperCase String Returns the value as all upper case.
10-09-2008
Object Method Return Type Description
DataSet getTotalRecordCount int Returns the total count of records that match the DataFilter. Returns total count ignoring pageSize.
DataView getTotalRecordCount int Returns the total count of records that match the DataFilter. Returns total count ignoring pageSize.
10-03-2008
Object Method Return Type Description
WebServiceRequest getDocumentByIndex File Returns the document with the given index. This is 0 based so index=0 is the first document.
WebServiceRequest getDocumentCount int The number of documents sent.
09-23-2008
Object Method Return Type Description
DataList getTotal double Returns the total of the given column. If the value of the individual record cannot compute to a double, defaultValue is used.
DataViewList getTotal double Returns the total of the given column. If the value of the individual record cannot compute to a double, defaultValue is used.
PacketDataList getTotal double Returns the total of the given column. If the value of the individual record cannot compute to a double, defaultValue is used.
StorageProviderDataList getTotal double Returns the total of the given column. If the value of the individual record cannot compute to a double, defaultValue is used.
09-12-2008
Object Method Return Type Description
Validator getUSCardType String Returns a United States credit card type (Visa, Master Card, Discover, Amex, and Diners). Returns null if card type cannot be determined.
Validator isValidUSCard boolean Validates a credit card issued in the United States of type Visa, Master Card, Discover, Amex, and Diners
Email setExpiration Sets the expiration date on links in the email. After this date, they will no longer work. Note- this method is a potential security hole. You should use good judgement in setting an expiration date.
Email setSingleUse Marks the email as single use (or not). Single use means once it has been used it will no longer be able to access the transaction.
09-11-2008
Object Method Return Type Description
Data addNewData Adds all of the entries in data to this Data object. If the entry already exists, it is NOT over-written unless its value is empty and emtpyAsNull is true.
09-10-2008
Object Method Return Type Description
Profile getName String Returns the name of the profile.
ProfileInfo getName String Returns the name of the profile.
09-08-2008
Object Method Return Type Description
AreaChart getName String Returns the name of this chart.
BarChart getName String Returns the name of this chart.
Chart getName String Returns the name of this chart.
LineChart getName String Returns the name of this chart.
PieChart getName String Returns the name of this chart.
ScatterPlotChart getName String Returns the name of this chart.
AreaChart getType String Returns the type of this chart.
BarChart getType String Returns the type of this chart.
Chart getType String Returns the type of this chart.
LineChart getType String Returns the type of this chart.
PieChart getType String Returns the type of this chart.
ScatterPlotChart getType String Returns the type of this chart.
AreaChart toString String Returns a description of this object.
BarChart toString String Returns a description of this object.
Chart toString String Returns a description of this object.
LineChart toString String Returns a description of this object.
PieChart toString String Returns a description of this object.
ScatterPlotChart toString String Returns a description of this object.
09-05-2008
Object Method Return Type Description
ImageFile clip If file is an image type, clips the image
PdfFile clip If file is an image type, clips the image
Data getDefaultBoolean Boolean Returns the given field as a boolean. If the field does not exist or refers to a non-boolean field, it returns the default value
DataRecord getDefaultBoolean Boolean Returns the given field as a boolean. If the field does not exist or refers to a non-boolean field, it returns the default value
DataSetRecord getDefaultBoolean Boolean Returns the given field as a boolean. If the field does not exist or refers to a non-boolean field, it returns the default value
DataViewRecord getDefaultBoolean Boolean Returns the given field as a boolean. If the field does not exist or refers to a non-boolean field, it returns the default value
DownloadResponse getDefaultBoolean Boolean Returns the given field as a boolean. If the field does not exist or refers to a non-boolean field, it returns the default value
Email getDefaultBoolean Boolean Returns the given field as a boolean. If the field does not exist or refers to a non-boolean field, it returns the default value
Fragment getDefaultBoolean Boolean Returns the given field as a boolean. If the field does not exist or refers to a non-boolean field, it returns the default value
PacketDataRecord getDefaultBoolean Boolean Returns the given field as a boolean. If the field does not exist or refers to a non-boolean field, it returns the default value
Payload getDefaultBoolean Boolean Returns the given field as a boolean. If the field does not exist or refers to a non-boolean field, it returns the default value
Render getDefaultBoolean Boolean Returns the given field as a boolean. If the field does not exist or refers to a non-boolean field, it returns the default value
TextEmail getDefaultBoolean Boolean Returns the given field as a boolean. If the field does not exist or refers to a non-boolean field, it returns the default value
Data getDefaultDate Date Returns the given field as a date. If the field does not exist or refers to a non-date field, it returns the default value
DataRecord getDefaultDate Date Returns the given field as a date. If the field does not exist or refers to a non-date field, it returns the default value
DataSetRecord getDefaultDate Date Returns the given field as a date. If the field does not exist or refers to a non-date field, it returns the default value
DataViewRecord getDefaultDate Date Returns the given field as a date. If the field does not exist or refers to a non-date field, it returns the default value
DownloadResponse getDefaultDate Date Returns the given field as a date. If the field does not exist or refers to a non-date field, it returns the default value
Email getDefaultDate Date Returns the given field as a date. If the field does not exist or refers to a non-date field, it returns the default value
Fragment getDefaultDate Date Returns the given field as a date. If the field does not exist or refers to a non-date field, it returns the default value
PacketDataRecord getDefaultDate Date Returns the given field as a date. If the field does not exist or refers to a non-date field, it returns the default value
Payload getDefaultDate Date Returns the given field as a date. If the field does not exist or refers to a non-date field, it returns the default value
Render getDefaultDate Date Returns the given field as a date. If the field does not exist or refers to a non-date field, it returns the default value
TextEmail getDefaultDate Date Returns the given field as a date. If the field does not exist or refers to a non-date field, it returns the default value
Data getDefaultDouble Double Returns the given field as a double. If the field does not exist or refers to a non-double field, it returns the default value
DataRecord getDefaultDouble Double Returns the given field as a double. If the field does not exist or refers to a non-double field, it returns the default value
DataSetRecord getDefaultDouble Double Returns the given field as a double. If the field does not exist or refers to a non-double field, it returns the default value
DataViewRecord getDefaultDouble Double Returns the given field as a double. If the field does not exist or refers to a non-double field, it returns the default value
DownloadResponse getDefaultDouble Double Returns the given field as a double. If the field does not exist or refers to a non-double field, it returns the default value
Email getDefaultDouble Double Returns the given field as a double. If the field does not exist or refers to a non-double field, it returns the default value
Fragment getDefaultDouble Double Returns the given field as a double. If the field does not exist or refers to a non-double field, it returns the default value
PacketDataRecord getDefaultDouble Double Returns the given field as a double. If the field does not exist or refers to a non-double field, it returns the default value
Payload getDefaultDouble Double Returns the given field as a double. If the field does not exist or refers to a non-double field, it returns the default value
Render getDefaultDouble Double Returns the given field as a double. If the field does not exist or refers to a non-double field, it returns the default value
TextEmail getDefaultDouble Double Returns the given field as a double. If the field does not exist or refers to a non-double field, it returns the default value
Data getDefaultInt Integer Returns the given field as an int. If the field does not exist or refers to a non-int field, it returns the default value
DataRecord getDefaultInt Integer Returns the given field as an int. If the field does not exist or refers to a non-int field, it returns the default value
DataSetRecord getDefaultInt Integer Returns the given field as an int. If the field does not exist or refers to a non-int field, it returns the default value
DataViewRecord getDefaultInt Integer Returns the given field as an int. If the field does not exist or refers to a non-int field, it returns the default value
DownloadResponse getDefaultInt Integer Returns the given field as an int. If the field does not exist or refers to a non-int field, it returns the default value
Email getDefaultInt Integer Returns the given field as an int. If the field does not exist or refers to a non-int field, it returns the default value
Fragment getDefaultInt Integer Returns the given field as an int. If the field does not exist or refers to a non-int field, it returns the default value
PacketDataRecord getDefaultInt Integer Returns the given field as an int. If the field does not exist or refers to a non-int field, it returns the default value
Payload getDefaultInt Integer Returns the given field as an int. If the field does not exist or refers to a non-int field, it returns the default value
Render getDefaultInt Integer Returns the given field as an int. If the field does not exist or refers to a non-int field, it returns the default value
TextEmail getDefaultInt Integer Returns the given field as an int. If the field does not exist or refers to a non-int field, it returns the default value
Packet getDefaultProperty String Returns the given property. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
TransactionPacket getDefaultProperty String Returns the given property. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
Data getDefaultValue String Returns the given field. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
DataRecord getDefaultValue String Returns the given field. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
DataSetRecord getDefaultValue String Returns the given field. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
DataViewRecord getDefaultValue String Returns the given field. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
DownloadResponse getDefaultValue String Returns the given field. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
Email getDefaultValue String Returns the given field. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
Fragment getDefaultValue String Returns the given field. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
PacketDataRecord getDefaultValue String Returns the given field. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
Payload getDefaultValue String Returns the given field. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
Render getDefaultValue String Returns the given field. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
TextEmail getDefaultValue String Returns the given field. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
09-04-2008
Object Method Return Type Description
DateUtil getAgeInDays int Returns the number of full days between the specified dates. If startDate is after endDate, return this as a negative number.
DateUtil getAgeInMonths int Returns the number of full months between the specified dates. If startDate is after endDate, return this as a negative number.
DateUtil getAgeInYears int Returns the number of full years between the specified dates. If startDate is after endDate, return this as a negative number.
09-03-2008
Object Method Return Type Description
Packet scheduleDelete boolean Schedules this transaction to be deleted on the specified date. If dataSetNames is not null, the related record in the identified dataSets will also be deleted. This method returns false if the activation key does not permit deletions. DataSetNames should be null or a comma seperated list of dataSet names.
TransactionPacket scheduleDelete boolean Schedules this transaction to be deleted on the specified date. If dataSetNames is not null, the related record in the identified dataSets will also be deleted. This method returns false if the activation key does not permit deletions. DataSetNames should be null or a comma seperated list of dataSet names.
08-27-2008
Object Method Return Type Description
Document isSignatureSigned boolean Returns true if signature is signed or completed. Returns false if no signature exists with the given id or it has not been signed.
08-22-2008
Object Method Return Type Description
Data getCommonBoolean Boolean Returns the given field as a boolean. The value must be any of the following combinations: [true/false], [1/0], [yes,no], [on,off]. Throws exception if the value does not exist or cannot be cast to the correct type.
DataRecord getCommonBoolean Boolean Returns the given field as a boolean. The value must be any of the following combinations: [true/false], [1/0], [yes,no], [on,off]. Throws exception if the value does not exist or cannot be cast to the correct type.
DataSetRecord getCommonBoolean Boolean Returns the given field as a boolean. The value must be any of the following combinations: [true/false], [1/0], [yes,no], [on,off]. Throws exception if the value does not exist or cannot be cast to the correct type.
DataViewRecord getCommonBoolean Boolean Returns the given field as a boolean. The value must be any of the following combinations: [true/false], [1/0], [yes,no], [on,off]. Throws exception if the value does not exist or cannot be cast to the correct type.
DownloadResponse getCommonBoolean Boolean Returns the given field as a boolean. The value must be any of the following combinations: [true/false], [1/0], [yes,no], [on,off]. Throws exception if the value does not exist or cannot be cast to the correct type.
Email getCommonBoolean Boolean Returns the given field as a boolean. The value must be any of the following combinations: [true/false], [1/0], [yes,no], [on,off]. Throws exception if the value does not exist or cannot be cast to the correct type.
Fragment getCommonBoolean Boolean Returns the given field as a boolean. The value must be any of the following combinations: [true/false], [1/0], [yes,no], [on,off]. Throws exception if the value does not exist or cannot be cast to the correct type.
PacketDataRecord getCommonBoolean Boolean Returns the given field as a boolean. The value must be any of the following combinations: [true/false], [1/0], [yes,no], [on,off]. Throws exception if the value does not exist or cannot be cast to the correct type.
Payload getCommonBoolean Boolean Returns the given field as a boolean. The value must be any of the following combinations: [true/false], [1/0], [yes,no], [on,off]. Throws exception if the value does not exist or cannot be cast to the correct type.
Render getCommonBoolean Boolean Returns the given field as a boolean. The value must be any of the following combinations: [true/false], [1/0], [yes,no], [on,off]. Throws exception if the value does not exist or cannot be cast to the correct type.
TextEmail getCommonBoolean Boolean Returns the given field as a boolean. The value must be any of the following combinations: [true/false], [1/0], [yes,no], [on,off]. Throws exception if the value does not exist or cannot be cast to the correct type.
08-07-2008
Object Method Return Type Description
Validator isValidDomain boolean Returns true if the domain is valid. Domain should be something.dom, not https://something.com
08-06-2008
Object Method Return Type Description
PalActivationKeyInfo getAccessPeriod int Returns the access period in months. 0 means not used. -1 means infinite (no ending).
PalActivationKeyInfo getArchivePeriod int Returns the archive period in months. 0 means not used. -1 means infinite (no ending).
PalActivationKeyInfo getData Data Returns a Data object containing information on this activation key.
PalActivationKeyInfo getExecutionPeriod int Returns the execution period in months.
PalActivationKeyInfo getMaxAudioLength int Returns the maximum audio recording length in minutes.
PalActivationKeyInfo getMaxDocumentSize int Returns the maximum size an empty Document can be (in kilobytes).
PalActivationKeyInfo getMaxFileSize int Returns the maximum size of any Pal file (in kilobytes).
PalActivationKeyInfo getMaxHtmlDocuments int Returns the maximum number of html documents that can be added to the transaction.
PalActivationKeyInfo getMaxPalSize int Returns the maximum size of the Pal (in kilobytes).
PalActivationKeyInfo getMaxPdfDocuments int Returns the maximum number of pdf documents that can be added to the transaction.
PalActivationKeyInfo getMaxRoles int Returns the maximum number of different roles allowed in the transaction.
PalActivationKeyInfo getMaxSignatures int Returns the maximum number of signatures that can exist in the transaction.
PalActivationKeyInfo getMaxTransactionSize int Returns the maximum transaction size in kilobytes.
PalActivationKeyInfo getMaxWizards int Returns the maximum number of wizards that can be added to the transaction.
PalActivationKeyInfo getName String Returns the name of the this Activation.
PalActivationKeyInfo isAudioEnabled boolean Returns true if audio recording is enabled.
PalActivationKeyInfo isConsoleEnabled boolean Returns true if Console workflow is enabled.
PalActivationKeyInfo isDataSetEnabled boolean Returns true if DataSet is enabled.
PalActivationKeyInfo isRepositoryEnabled boolean Returns true if this activation key can be used for repository Pals.
PalActivationKeyInfo isSystemEnabled boolean Returns true if system workflow is enabled.
PalActivationKeyInfo isWebEnabled boolean Returns true if web workflow is enabled.
PalActivationKeyInfo isWebServiceEnabled boolean Returns true if transaction web service workflow is enabled.
PalActivationKeyInfo toString String Returns a description of this object.
07-31-2008
Object Method Return Type Description
TransactionWebServiceController getFormatter Formatter Returns a formatter.
07-30-2008
Object Method Return Type Description
DataSet findRecord DataSetRecord Finds the first record matching the criteria of the filter. Don't use filter.selectColumn(s) when using this method.
DataSet findRecord DataViewRecord Finds the first record matching the criteria of the filter. Don't use filter.selectColumn(s) when using this method.
07-29-2008
Object Method Return Type Description
TransactionWebServiceController getDateUtil DateUtil Returns a utility for working with dates.
07-17-2008
Object Method Return Type Description
Document addFilter Enables filtering on a field
07-11-2008
Object Method Return Type Description
Data addData Adds all of the entries in data to this Data object, over-writing duplicates.
DownloadResponse addDataList boolean Adds the specified list to a page
Email addDataList boolean Adds the specified list to a page
Fragment addDataList boolean Adds the specified list to a page
Payload addDataList boolean Adds the specified list to a page
Render addDataList boolean Adds the specified list to a page
TextEmail addDataList boolean Adds the specified list to a page
Buffer append Buffer Appends the given int to the buffer and returns the buffer
Buffer append Buffer Appends the given string to the buffer and returns the buffer
TransactionWebServiceController createBuffer Buffer Creates and returns a new Buffer object
Data deleteData Removes all entries.
Data getBoolean Boolean Returns the given field as a boolean. The value must be true or false. Throws exception if the value does not exist or cannot be cast to the correct type.
DataRecord getBoolean Boolean Returns the given field as a boolean. The value must be true or false. Throws exception if the value does not exist or cannot be cast to the correct type.
DataSetRecord getBoolean Boolean Returns the given field as a boolean. The value must be true or false. Throws exception if the value does not exist or cannot be cast to the correct type.
DataViewRecord getBoolean Boolean Returns the given field as a boolean. The value must be true or false. Throws exception if the value does not exist or cannot be cast to the correct type.
DownloadResponse getBoolean Boolean Returns the given field as a boolean. The value must be true or false. Throws exception if the value does not exist or cannot be cast to the correct type.
Email getBoolean Boolean Returns the given field as a boolean. The value must be true or false. Throws exception if the value does not exist or cannot be cast to the correct type.
Fragment getBoolean Boolean Returns the given field as a boolean. The value must be true or false. Throws exception if the value does not exist or cannot be cast to the correct type.
PacketDataRecord getBoolean Boolean Returns the given field as a boolean. The value must be true or false. Throws exception if the value does not exist or cannot be cast to the correct type.
Payload getBoolean Boolean Returns the given field as a boolean. The value must be true or false. Throws exception if the value does not exist or cannot be cast to the correct type.
Render getBoolean Boolean Returns the given field as a boolean. The value must be true or false. Throws exception if the value does not exist or cannot be cast to the correct type.
TextEmail getBoolean Boolean Returns the given field as a boolean. The value must be true or false. Throws exception if the value does not exist or cannot be cast to the correct type.
DataList getColumnCount int Returns the column count for this list
DataViewList getColumnCount int Returns the column count for this list
PacketDataList getColumnCount int Returns the column count for this list
StorageProviderDataList getColumnCount int Returns the column count for this list
DataRecord getData Data Returns the name/value data of this record. Changes made are not persisted.
DataSetRecord getData Data Returns the name/value data of this record (read only). Additionally contains CP-ID, CP-PALID, and CP-TXID
DataViewRecord getData Data Returns the name/value data of this record. Changes made are not persisted.
PacketDataRecord getData Data Returns the name/value data of this record. Changes made are persisted.
DataRecord getDataValue String Gets the value of the specified column referenced by name
DataSetRecord getDataValue String Gets the value of the specified column referenced by name
DataViewRecord getDataValue String Gets the value of the specified column referenced by name
PacketDataRecord getDataValue String Gets the value of the specified column referenced by name
Data getDate Date Returns the given field as a Date. Throws exception if the value does not exist or cannot be cast to the correct type.
DataRecord getDate Date Returns the given field as a Date. Throws exception if the value does not exist or cannot be cast to the correct type.
DataSetRecord getDate Date Returns the given field as a Date. Throws exception if the value does not exist or cannot be cast to the correct type.
DataViewRecord getDate Date Returns the given field as a Date. Throws exception if the value does not exist or cannot be cast to the correct type.
DownloadResponse getDate Date Returns the given field as a Date. Throws exception if the value does not exist or cannot be cast to the correct type.
Email getDate Date Returns the given field as a Date. Throws exception if the value does not exist or cannot be cast to the correct type.
Fragment getDate Date Returns the given field as a Date. Throws exception if the value does not exist or cannot be cast to the correct type.
PacketDataRecord getDate Date Returns the given field as a Date. Throws exception if the value does not exist or cannot be cast to the correct type.
Payload getDate Date Returns the given field as a Date. Throws exception if the value does not exist or cannot be cast to the correct type.
Render getDate Date Returns the given field as a Date. Throws exception if the value does not exist or cannot be cast to the correct type.
TextEmail getDate Date Returns the given field as a Date. Throws exception if the value does not exist or cannot be cast to the correct type.
Data getDouble Double Returns the given value of the given key as a double. Throws exception if the value does not exist or cannot be cast to the correct type.
DataRecord getDouble Double Returns the given value of the given key as a double. Throws exception if the value does not exist or cannot be cast to the correct type.
DataSetRecord getDouble Double Returns the given value of the given key as a double. Throws exception if the value does not exist or cannot be cast to the correct type.
DataViewRecord getDouble Double Returns the given value of the given key as a double. Throws exception if the value does not exist or cannot be cast to the correct type.
DownloadResponse getDouble Double Returns the given value of the given key as a double. Throws exception if the value does not exist or cannot be cast to the correct type.
Email getDouble Double Returns the given value of the given key as a double. Throws exception if the value does not exist or cannot be cast to the correct type.
Fragment getDouble Double Returns the given value of the given key as a double. Throws exception if the value does not exist or cannot be cast to the correct type.
PacketDataRecord getDouble Double Returns the given value of the given key as a double. Throws exception if the value does not exist or cannot be cast to the correct type.
Payload getDouble Double Returns the given value of the given key as a double. Throws exception if the value does not exist or cannot be cast to the correct type.
Render getDouble Double Returns the given value of the given key as a double. Throws exception if the value does not exist or cannot be cast to the correct type.
TextEmail getDouble Double Returns the given value of the given key as a double. Throws exception if the value does not exist or cannot be cast to the correct type.
TransactionWebServiceController getError String Returns the error, if any.
DataSetRecord getId String Returns this record's database primary key id
DataViewRecord getId String Returns this record's database primary key id
DataRecord getIndex int Returns this record's index in the DataList
DataSetRecord getIndex int Returns this record's index in the DataList
DataViewRecord getIndex int Returns this record's index in the DataList
PacketDataRecord getIndex int Returns this record's index in the DataList
Data getInt Integer Returns the given value of the given key as an Java Int which is smaller than a Javascript Int. Throws exception if the value does not exist or cannot be cast to the correct type.
DataRecord getInt Integer Returns the given value of the given key as an Java Int which is smaller than a Javascript Int. Throws exception if the value does not exist or cannot be cast to the correct type.
DataSetRecord getInt Integer Returns the given value of the given key as an Java Int which is smaller than a Javascript Int. Throws exception if the value does not exist or cannot be cast to the correct type.
DataViewRecord getInt Integer Returns the given value of the given key as an Java Int which is smaller than a Javascript Int. Throws exception if the value does not exist or cannot be cast to the correct type.
DownloadResponse getInt Integer Returns the given value of the given key as an Java Int which is smaller than a Javascript Int. Throws exception if the value does not exist or cannot be cast to the correct type.
Email getInt Integer Returns the given value of the given key as an Java Int which is smaller than a Javascript Int. Throws exception if the value does not exist or cannot be cast to the correct type.
Fragment getInt Integer Returns the given value of the given key as an Java Int which is smaller than a Javascript Int. Throws exception if the value does not exist or cannot be cast to the correct type.
PacketDataRecord getInt Integer Returns the given value of the given key as an Java Int which is smaller than a Javascript Int. Throws exception if the value does not exist or cannot be cast to the correct type.
Payload getInt Integer Returns the given value of the given key as an Java Int which is smaller than a Javascript Int. Throws exception if the value does not exist or cannot be cast to the correct type.
Render getInt Integer Returns the given value of the given key as an Java Int which is smaller than a Javascript Int. Throws exception if the value does not exist or cannot be cast to the correct type.
TextEmail getInt Integer Returns the given value of the given key as an Java Int which is smaller than a Javascript Int. Throws exception if the value does not exist or cannot be cast to the correct type.
DataList getName String Returns the name of this list
DataViewList getName String Returns the name of this list
PacketDataList getName String Returns the name of this list
StorageProviderDataList getName String Returns the name of this list
Data getNameSet String[] Returns the names of this Data object as an array of strings that start with the given prefix. If no values exist, this will return an empty array.
Data getNames String[] Returns the names of this Data object as an array of strings. If no values exist, this will return an empty array.
DataList getRecord DataRecord Returns the record at the specified index
DataViewList getRecord DataRecord Returns the record at the specified index
DataViewList getRecord DataViewRecord Returns the record at the specified index
PacketDataList getRecord DataRecord Returns the record at the specified index
PacketDataList getRecord PacketDataRecord Returns the record at the specified index
StorageProviderDataList getRecord DataRecord Returns the record at the specified index
DataList getRecordCount int Returns the number of records in this list
DataViewList getRecordCount int Returns the number of records in this list
PacketDataList getRecordCount int Returns the number of records in this list
StorageProviderDataList getRecordCount int Returns the number of records in this list
TransactionWebServiceController getValidator Validator Returns a utility for validating user data.
Data getValue String Returns the value associated with key if it exists, null otherwise.
DataRecord getValue String Gets the value of the specified column referenced by index
DataRecord getValue String Returns the value associated with key if it exists, null otherwise.
DataSetRecord getValue String Gets the value of the specified column referenced by index
DataSetRecord getValue String Returns the value associated with key if it exists, null otherwise.
DataViewRecord getValue String Gets the value of the specified column referenced by index
DataViewRecord getValue String Returns the value associated with key if it exists, null otherwise.
DownloadResponse getValue String Returns the value associated with key if it exists, null otherwise.
Email getValue String Returns the value associated with key if it exists, null otherwise.
Fragment getValue String Returns the value associated with key if it exists, null otherwise.
PacketDataRecord getValue String Gets the value of the specified column referenced by index
PacketDataRecord getValue String Returns the value associated with key if it exists, null otherwise.
Payload getValue String Returns the value associated with key if it exists, null otherwise.
Render getValue String Returns the value associated with key if it exists, null otherwise.
TextEmail getValue String Returns the value associated with key if it exists, null otherwise.
Data getValues String[] Returns the names of this Data object as an array of strings that start with the given prefix. If no values exist, this will return an empty array.
Data hasValue Boolean Returns true if the value exists in the data map.
Data removeValue String Removes the associated key from the data map.
Buffer replace Buffer Finds occurrences of find and replaces it with replace. If all is true, all occurrences are replaced. Otherwise, the first occurrence is replaced.
DataSetRecord setData Sets the values in this DataRecord, matching keys in the Data to columns in the record.
PacketDataRecord setData boolean Sets the values in this DataRecord, matching keys in the Data to columns in the record. Returns false if the data object is null.
DataSetRecord setDataValue boolean Sets the value of the specified column referenced by name. Returns false if the column does not exist.
PacketDataRecord setDataValue boolean Sets the value of the specified column referenced by name. Returns false if the column does not exist.
DataSetRecord setDateValue boolean Sets the value of the specified date column referenced by name. Returns false if the column does not exist.
PacketDataRecord setDateValue boolean Sets the value of the specified date column referenced by name. Returns false if the column does not exist.
DownloadResponse setHTML Adds the given XHTML to the page (the XHTML should ideally be well-formed). You must use the c:html tag for displaying the content. Throws exception if the content contains illegal tags or attributes. You should avoid inline scripts or script blocks.
Email setHTML Adds the given XHTML to the page (the XHTML should ideally be well-formed). You must use the c:html tag for displaying the content. Throws exception if the content contains illegal tags or attributes. You should avoid inline scripts or script blocks.
Fragment setHTML Adds the given XHTML to the page (the XHTML should ideally be well-formed). You must use the c:html tag for displaying the content. Throws exception if the content contains illegal tags or attributes. You should avoid inline scripts or script blocks.
Payload setHTML Adds the given XHTML to the page (the XHTML should ideally be well-formed). You must use the c:html tag for displaying the content. Throws exception if the content contains illegal tags or attributes. You should avoid inline scripts or script blocks.
Render setHTML Adds the given XHTML to the page (the XHTML should ideally be well-formed). You must use the c:html tag for displaying the content. Throws exception if the content contains illegal tags or attributes. You should avoid inline scripts or script blocks.
TextEmail setHTML Adds the given XHTML to the page (the XHTML should ideally be well-formed). You must use the c:html tag for displaying the content. Throws exception if the content contains illegal tags or attributes. You should avoid inline scripts or script blocks.
DataList setName Sets the name of this list.
DataViewList setName Sets the name of this list.
PacketDataList setName Sets the name of this list.
StorageProviderDataList setName Sets the name of this list.
Data setValue Sets the string value referenced by name. The object must be capable of being serialized as a String.
DataSetRecord setValue Sets the string value referenced by name. The object must be capable of being serialized as a String.
DownloadResponse setValue Sets the string value referenced by name. The object must be capable of being serialized as a String.
Email setValue Sets the string value referenced by name. The object must be capable of being serialized as a String.
Fragment setValue Sets the string value referenced by name. The object must be capable of being serialized as a String.
PacketDataRecord setValue Sets the string value referenced by name. The object must be capable of being serialized as a String.
Payload setValue Sets the string value referenced by name. The object must be capable of being serialized as a String.
Render setValue Sets the string value referenced by name. The object must be capable of being serialized as a String.
TextEmail setValue Sets the string value referenced by name. The object must be capable of being serialized as a String.
Buffer toString String Returns the content of the buffer as a string
Data toString String Returns a description of this object.
DataList toString String Returns a description of this object.
07-10-2008
Object Method Return Type Description
DataSet createAnalyticFilter AnalyticDataViewFilter Returns a new AnalyticSet with no columns selected.
DataView createAnalyticFilter AnalyticDataViewFilter Returns a new AnalyticSet with no columns selected.
Document createPdfTamperSeal boolean Creates a Digital Signature 'tamper seal' on this PDF document. This should be called only once, when all data and signatures have been applied. Returns false if this document is not a PDF or if this method has already been applied to the document.
DateUtil parseComplexDate Date Creates a date from the given string. Format can be almost any valid date (e.g. Mar. 3rd, 1956 or 5/5/2008). Returns null if the date cannot be parsed.
06-26-2008
Object Method Return Type Description
AnalyticDataViewFilter avg calculates the avg of the specified column using the specified resultAlias
AnalyticDataViewFilter count calculates the count of the specified column using the specified resultAlias
AnalyticDataViewFilter groupByColumn Add column to group by
AnalyticDataViewFilter groupByColumns Add columns to group by
AnalyticDataViewFilter max calculates the max of the specified column using the specified resultAlias
AnalyticDataViewFilter min calculates the min of the specified column using the specified resultAlias
AnalyticDataViewFilter sum calculates the sum of the specified column using the specified resultAlias
06-04-2008
Object Method Return Type Description
DataListFilter addBetween Return records where column is between the two constraints. The values will be cast to the correct type. The behavior depends on the type of data being operated on. Dates without a time value will be treated as midnight, so between 11-12-2008 and 11-13-2008 will return all entries on 11-12-2008. To include those for 11-13-2008 you would use 11-12-2008 and 11-14-2008 or 11-12-2008 and 11-13-2008 23:59. For string comparisons, between 'A' and 'C' would include 'A' and 'B' but not 'C'. For numbers, the end points are inclusive: between 1 and 5 will return 1,2,3,4 and 5.
DataListFilter addEqual Return records where column equals value.
DataListFilter addGreaterThan Return records where column is greater than the value. The values will be cast to the specified type.
DataListFilter addLessThan Return records where column is less than the value. The values will be cast to the specified type.
DataListFilter addNotEqual Return records where column is not equal to the value.
DataSet createAnalyticFilter AnalyticDataViewFilter Returns a new AnalyticSet with the columns to be selected.
DataView createAnalyticFilter AnalyticDataViewFilter Returns a new AnalyticSet with the columns to be selected.
DataSet createFilter DataViewFilter Returns a new DataViewFilter.
DataView createFilter DataViewFilter Returns a new DataViewFilter.
DataSet createRecord DataSetRecord Creates a new, empty record.
DataSet deleteRecord Deletes the record identified by id.
DataSet getColumns DataList Returns a read-only DataList containing column information.
DataView getColumns DataList Returns a read-only DataList containing column information.
DataSet getName String Returns the name of this DataSet.
DataView getName String Returns the name of this DataSet.
DataSet getRecord DataSetRecord Returns the record identified by id.
DataSet getRecords DataViewList Returns records that match the filter criteria. If filter is null, a default filter is created.
DataView getRecords DataViewList Returns records that match the filter criteria. If filter is null, a default filter is created.
DataSet insertRecord String Inserts (persists) this new record. Returns the id of the inserted record.
AnalyticDataViewFilter reset Resets the filter (equivalent of creating a new filter).
DataViewFilter reset Resets the filter (equivalent of creating a new filter).
SystemDataViewFilter reset Resets the filter (equivalent of creating a new filter).
AnalyticDataViewFilter selectColumn Explicitly select the specified column.
DataViewFilter selectColumn Explicitly select the specified column.
SystemDataViewFilter selectColumn Explicitly select the specified column.
AnalyticDataViewFilter selectColumns Explicitly select the specified columns.
DataViewFilter selectColumns Explicitly select the specified columns.
SystemDataViewFilter selectColumns Explicitly select the specified columns.
AnalyticDataViewFilter sortAscending DataViewCriteria Sorts the results in ascending order on the given column.
AnalyticDataViewFilter sortAscending DataViewFilter Sorts the results in ascending order on the given column.
DataListFilter sortAscending Sorts the results in ascending order on the given column.
DataViewFilter sortAscending DataViewCriteria Sorts the results in ascending order on the given column.
DataViewFilter sortAscending DataViewFilter Sorts the results in ascending order on the given column.
SystemDataViewFilter sortAscending DataViewCriteria Sorts the results in ascending order on the given column.
SystemDataViewFilter sortAscending DataViewFilter Sorts the results in ascending order on the given column.
AnalyticDataViewFilter sortDescending DataViewFilter Sorts the results in descending order on the given column.
AnalyticDataViewFilter sortDescending DataViewCriteria Sorts the results in descending order on the given column.
DataListFilter sortDescending Sorts the results in descending order on the given column.
DataViewFilter sortDescending DataViewFilter Sorts the results in descending order on the given column.
DataViewFilter sortDescending DataViewCriteria Sorts the results in descending order on the given column.
SystemDataViewFilter sortDescending DataViewFilter Sorts the results in descending order on the given column.
SystemDataViewFilter sortDescending DataViewCriteria Sorts the results in descending order on the given column.
AnalyticDataViewFilter toString String Returns a description of this object.
DataSet toString String Returns a description of this object.
DataView toString String Returns a description of this object.
DataViewFilter toString String Returns a description of this object.
SystemDataViewFilter toString String Returns a description of this object.
DataSet updateRecord boolean Updates (persists) changes made to the record. Returns false if the record is read only.
06-02-2008
Object Method Return Type Description
Document getAudioRecordingLength int Returns the length of the audio recording (in seconds) for the specified audio signature. Returns -1 if the signature does not exist, is not signed, or is not audio.
05-13-2008
Object Method Return Type Description
Packet addDocument Document Adds the specified document to the packet and populates using the data supplied. Executes tag and jexl business logic upon create. See also Document.reloadFromPal.
TransactionPacket addDocument Document Adds the specified document to the packet and populates using the data supplied. Executes tag and jexl business logic upon create. See also Document.reloadFromPal.
Enterprise getGlobalSetting String Returns the global setting identified by name. Returns null if no setting exists with that name.
Document rebuildFromPal Assembles the document again from the template contained in the Pal using the supplied data to populate matching fields in the template. This method will throw an exception if any signature on the document has been signed.
04-10-2008
Object Method Return Type Description
Packet getSecureId String Returns the ID of the transaction, encrypted. This can be used in conjunction with Web Pal architecture.
TransactionPacket getSecureId String Returns the ID of the transaction, encrypted. This can be used in conjunction with Web Pal architecture.
03-13-2008
Object Method Return Type Description
Document proxySign Performs a proxy sign in behalf of the person identified by name. Name will appear in the signature rendering and an audit entry will be created indicating the signature was signed in behalf of the name. This should only be called on a single signature of type audio.
03-10-2008
Object Method Return Type Description
AudioFile isPdfConversionSupported boolean Returns true if the content supports conversion to PDF.
DatasetFile isPdfConversionSupported boolean Returns true if the content supports conversion to PDF.
DocumentFile isPdfConversionSupported boolean Returns true if the content supports conversion to PDF.
ExcelFile isPdfConversionSupported boolean Returns true if the content supports conversion to PDF.
File isPdfConversionSupported boolean Returns true if the content supports conversion to PDF.
ImageFile isPdfConversionSupported boolean Returns true if the content supports conversion to PDF.
PdfFile isPdfConversionSupported boolean Returns true if the content supports conversion to PDF.
VCardFile isPdfConversionSupported boolean Returns true if the content supports conversion to PDF.
02-25-2008
Object Method Return Type Description
Wizard getValue String Returns the value associated with key if it exists, null otherwise.
02-13-2008
Object Method Return Type Description
Document deleteSignature boolean Deletes the signature identified by id. This method returns false if the signature has already been signed and therefore cannot be deleted.
02-08-2008
Object Method Return Type Description
Email setAnonymousLink Creates a link that can be clicked from within the email that will allow an authenticated user to access the transaction without having a role. Use this with care since you have no control over the ultimate destination of the email and anyone using the link will have access to the Transaction. If singleUse is true, the link expires when it is used. If verifyEmail is used, the user must have a profile with an email address that matches the email address you've entered when you send the email. Once the link has been used to access the transaction, it is no longer anonymous but bound to the user who used it.
01-11-2008
Object Method Return Type Description
Packet getId String Returns the ID of the transaction. This can be used in conjunction with web services.
TransactionPacket getId String Returns the ID of the transaction. This can be used in conjunction with web services.
12-31-2007
Object Method Return Type Description
Email setCreateTransactionLink Creates a link that can be clicked from within the email that will create a new transaction using the Pal associated with the specified ID.If chain is true, the new transaction will be logically associated with this transaction.If data is non null, the data will be available as part of the creation of the new transaction-- as if it was passed on the request.
12-21-2007
Object Method Return Type Description
Document getSignatures DataList Returns a DataList containing signature information for this document. Pass * for all roles
Document isAllSigned boolean Returns true if all required signatures in this document have been signed by the indicated role. Pass * for all roles. Returns false if the role does not exist in any signature.
11-30-2007
Object Method Return Type Description
Browser calcHeight String Returns a height as a percentage of the available screen height, confined to within min and max.
Browser calcWidth String Returns a width as a percentage of the available screen width, confined to within min and max.
Document getFragment Fragment Returns a portion of the xhtml of the document identified with an id of targetId. This method will return null if no element exists or if the content has been signed.
Role isRegistered boolean Returns true if the user associated with the role is a registered.
Fragment setName Changes the name of this fragment to the specified name.
11-24-2007
Object Method Return Type Description
Document addAudioSignature boolean Adds an audio signature to the document... (see addClickSignature). The audio recording will be limited to the number of minutes specified in limit.If this limit exceeds that allowed by the activation, the activation limit will be used.
Document addClickSignature boolean Adds a click signature to the document, identified by sigId, signable by role, referencing target. If the document is of type pdf, target can be null. If the document is html, the document must have a span or div tag with an id attribute matching the supplied sigId as well as a div tag with id matching target. If the document is HTML and you pass null for target, the cp-root div will be used as the target. The sigId must be unique (no two signatures in this document can have the same id). The sigId is the same id used to reference the signature that will be created. This method returns false if the signature cannot be added because the document content referenced by target has already been signed.
Document addExclusiveInitial boolean Adds an exclusive initial signature to the document... (see addClickSignature). Note that initial signatures require the existance of a non initial signature (ref) in order to function correctly.
Document addImageSignature boolean Adds an image signature to the document... (see addClickSignature)
Document addInitial boolean Adds an initial signature to the document... (see addClickSignature). Note that initial signatures require the existance of a non initial signature (ref) in order to function correctly.
11-15-2007
Object Method Return Type Description
Formatter formatCurrencyAsWords String Formats the currency as words (ex: 32.50 converts to thirty two dollars and fifty cents)
Formatter formatNumber String Returns the given number as comma-formatted string to the specified decimal places.
11-08-2007
Object Method Return Type Description
Formatter getNumberAsOrdinal String Converts number to ordinal value. (ex: 2 converts to '2nd')
11-07-2007
Object Method Return Type Description
Email attachDocument boolean Attaches the specified document as an attachment to the email. The document will be converted to pdf if it is not already a pdf. This method returns false if the document is not a PDF or cannot be converted to a PDF. Attachment limit is maximum transaction packet size.
AudioFile getFilename String Returns the name of the uploaded file (without the full path).
DatasetFile getFilename String Returns the name of the uploaded file (without the full path).
DocumentFile getFilename String Returns the name of the uploaded file (without the full path).
ExcelFile getFilename String Returns the name of the uploaded file (without the full path).
File getFilename String Returns the name of the uploaded file (without the full path).
ImageFile getFilename String Returns the name of the uploaded file (without the full path).
PdfFile getFilename String Returns the name of the uploaded file (without the full path).
VCardFile getFilename String Returns the name of the uploaded file (without the full path).
10-17-2007
Object Method Return Type Description
Browser getBrowser String Returns a two character code for the browser (ie=Internet Explorer, ff=Firefox, sf=Safari). Returns 'ot' if the browser cannot be identified.
Browser getBrowserVersion String Returns the browser version. Returns 'unknown' if the browser version cannot be identified. For Safari, this returns the AppleWebKit version.
Browser getOperatingSystem String Return a two or three character code for the operating system (win=Windows, mac=Macintosh, lnx=Linux). Returns 'ot' if the operating system cannot be identified.
Browser getUserAgent String Returns the full userAgent reported by the browser.
Browser toString String Returns a description of this Browser object.
09-17-2007
Object Method Return Type Description
Formatter toKiloBytes String Returns the given number (bytes) as kilobytes to the specified decimal places.
Formatter toMegaBytes String Returns the given number (bytes) as megabytes to the specified decimal places.
08-29-2007
Object Method Return Type Description
Enterprise toString String Returns a description of this object.
EnterpriseInfo toString String Returns a description of this object.
08-22-2007
Object Method Return Type Description
Formatter formatDateString String Formats the given date string using the given java date pattern (see java.text.SimpleDateFormat for sample patterns)
08-21-2007
Object Method Return Type Description
TransactionWebServiceController createData Data Creates and returns an empty Data object
08-16-2007
Object Method Return Type Description
DataList isReadOnly boolean Returns true if this is a read-only list
DataViewList isReadOnly boolean Returns true if this is a read-only list
PacketDataList isReadOnly boolean Returns true if this is a read-only list
StorageProviderDataList isReadOnly boolean Returns true if this is a read-only list
08-01-2007
Object Method Return Type Description
Packet deleteDataList Deletes the specified DataList.
TransactionPacket deleteDataList Deletes the specified DataList.
PacketDataList deleteRecord Deletes the record at the specified index.
Packet getDataList PacketDataList Returns the specified DataList if it exists, or null if it does not.
TransactionPacket getDataList PacketDataList Returns the specified DataList if it exists, or null if it does not.
PacketDataList insertRecord PacketDataRecord Creates a new (empty) record and returns it.
Packet setDataList Saves the specified DataList, over-writing any other table that might exist with the same name.
TransactionPacket setDataList Saves the specified DataList, over-writing any other table that might exist with the same name.
07-19-2007
Object Method Return Type Description
Document getName String Returns the name of this document.
Wizard getName String Returns the name of this wizard.
07-12-2007
Object Method Return Type Description
Packet getDocuments DataList Returns a read-only DataList of all the documents in this transaction. The name of the datalist is 'documents'.
TransactionPacket getDocuments DataList Returns a read-only DataList of all the documents in this transaction. The name of the datalist is 'documents'.
06-28-2007
Object Method Return Type Description
Validator isValidDate boolean Returns true if the date is a valid date.
Validator isValidEmail boolean Returns true if the email is a valid email address.
Validator isValidNumber boolean Returns true if the number is a valid number.
06-27-2007
Object Method Return Type Description
DateUtil addDays Date Returns a new Date offset in days from the given date.
DateUtil addHours Date Returns a new Date offset in hours from the given date.
DateUtil addMonths Date Returns a new Date offset in months from the given date.
DateUtil addYears Date Returns a new Date offset in years from the given date.
DateUtil createDate Date Creates a date with the current time on the server
DateUtil getAge int Returns the age in (in years) from the given date. If the date is in the future, this will return a negative number.
DateUtil getDateNextMonth Date Returns a new Date with the given day of the month next month from now.
DateUtil getDateThisMonth Date Returns a new Date with the given day of this month.
DateUtil getDay int Returns the day of the month (1-31) of the given date.
DateUtil getEndOfMonth Date Returns a new Date for the last day of the month of the given date.
DateUtil getEndOfYear Date Returns a new Date for the last day of the year of the given date.
DateUtil getMonth int Returns the month of the year (1-12) of the given date.
DateUtil getStartOfMonth Date Returns a new Date for the first day of the month of the given date.
DateUtil getStartOfYear Date Returns a new Date for the first day of the year of the given date.
DateUtil getYear int Returns the year of the given date.
DateUtil parseDate Date Creates a date from the given string. Format should be MM-dd-yyyy or MM/dd/yyyy
06-14-2007
Object Method Return Type Description
TransactionWebServiceController createEmail Email Creates an Email object using the specified template.
TransactionWebServiceController getPacket Packet Returns the Packet object associated with this transaction.
TransactionWebServiceController toString String Returns a description of this object.
DatasetFile toString String Returns a description of this object.
Document toString String Returns a description of this object.
DocumentFile toString String Returns a description of this object.
File toString String Returns a description of this object.
Fragment toString String Returns a description of this object.
ImageFile toString String Returns a description of this object.
Packet toString String Returns a description of this object.
PdfFile toString String Returns a description of this object.
Role toString String Returns a description of this object.
TransactionPacket toString String Returns a description of this object.
VCardFile toString String Returns a description of this object.
WebServiceRequest toString String Returns a description of this object.
WebServiceResponse toString String Returns a description of this object.
Wizard toString String Returns a description of this object.
05-31-2007
Object Method Return Type Description
Packet addAuditEntry Adds an audit entry to the transaction.
TransactionPacket addAuditEntry Adds an audit entry to the transaction.
Packet addDocument Document Adds the specified document to the packet
TransactionPacket addDocument Document Adds the specified document to the packet
Packet addDocumentFromFile Document Adds the specified content to the packet as a document. The file should be PDF or HTML.
TransactionPacket addDocumentFromFile Document Adds the specified content to the packet as a document. The file should be PDF or HTML.
Packet addDocumentFromPal Document Adds the document from the pal specified to this packet. Returns null if the pal is not accessible or does not have the specified document or a document already exists in this packet with the given name. See TransactionController.getPalDocuments.
TransactionPacket addDocumentFromPal Document Adds the document from the pal specified to this packet. Returns null if the pal is not accessible or does not have the specified document or a document already exists in this packet with the given name. See TransactionController.getPalDocuments.
Packet addDuplicateDocument Document Adds the specified document to the packet with the specified new name and description.
Packet addDuplicateDocument Document Adds the specified document to the packet with the specified new name and description and populates using the data supplied. Executes tag and jexl business logic upon create. See also Document.reloadFromPal.
TransactionPacket addDuplicateDocument Document Adds the specified document to the packet with the specified new name and description.
TransactionPacket addDuplicateDocument Document Adds the specified document to the packet with the specified new name and description and populates using the data supplied. Executes tag and jexl business logic upon create. See also Document.reloadFromPal.
Packet addDuplicateWizard Wizard Adds the specified wizard with the specified new name.
TransactionPacket addDuplicateWizard Wizard Adds the specified wizard with the specified new name.
Document addFragment int Appends to or replaces the content in the element identified by targetId with the content in the fragment. If index is true, the fragment should have an id or name attribute on the root element. This element and any child elements with an id or name attribute are re-indexed and the index is returned. Support for HTML documents only.
Packet addWizard Wizard Adds the specified wizard.
TransactionPacket addWizard Wizard Adds the specified wizard.
Packet deleteData Deletes the Data object with the given name.
TransactionPacket deleteData Deletes the Data object with the given name.
Packet deleteDocument Deletes the specified document.
TransactionPacket deleteDocument Deletes the specified document.
Packet deleteProperty Deletes the specified property.
TransactionPacket deleteProperty Deletes the specified property.
Packet deleteWizard Deletes the wizard with the given name.
TransactionPacket deleteWizard Deletes the wizard with the given name.
Document enableEditing Enables editing of data by the active user.
Document enableSignature boolean Enables signing of the specified signature by the active user. This willreturn acceptAction or rejectAction depending on the choice the user makes. Returns false if the active user does not have a role.
Document enableSigning boolean Enables signing of the next signature allowed for the active user based on the user's role(s). This willreturn acceptAction or rejectAction depending on the choice the user makes. Returns false if the active user does not have a role.
Packet enableSystemWorkflow boolean Marks the system workflow (if any) available for execution. If there is no system workflowassociated with this Pal, calling this method is quietly ignored. This method returns false if system workflow is not enabled by the activation key.
TransactionPacket enableSystemWorkflow boolean Marks the system workflow (if any) available for execution. If there is no system workflowassociated with this Pal, calling this method is quietly ignored. This method returns false if system workflow is not enabled by the activation key.
Packet endExecutionPeriod Immediately ends the Execution period (if in the future) and adjusts the Access and Archive periods according to the activation key.
TransactionPacket endExecutionPeriod Immediately ends the Execution period (if in the future) and adjusts the Access and Archive periods according to the activation key.
Packet getCategory String Returns the category of this packet.
TransactionPacket getCategory String Returns the category of this packet.
Wizard getCurrentDialog String Returns the name of the current dialog.
Packet getCurrentDocument Document Returns the active document (the last one shown for signing or viewing).
TransactionPacket getCurrentDocument Document Returns the active document (the last one shown for signing or viewing).
Document getCurrentSignature String Returns the id of the signature that was presented for signing.
Packet getCurrentWizard Wizard Returns the current wizard.
TransactionPacket getCurrentWizard Wizard Returns the current wizard.
Document getData Data Returns all the data that has values contained in this document.
DownloadResponse getData Data Returns the Data object for this response.
Email getData Data Returns the Data object for this response.
Fragment getData Data Returns the Data object for this response.
Packet getData Data Returns the named Data object. Modifications to the content of the Data object are automatically persisted.
Payload getData Data Returns the Data object for this response.
Render getData Data Returns the Data object for this response.
TextEmail getData Data Returns the Data object for this response.
TransactionPacket getData Data Returns the named Data object. Modifications to the content of the Data object are automatically persisted.
WebServiceRequest getData Data Returns the Data object for this request. This will contain all the form field values posted from the client.
WebServiceResponse getData Data Returns the Data object for this response.
Wizard getData Data Returns the Data object for this wizard.
Document getDescription String Returns the description of this document.
Packet getDescription String Returns the description of this packet.
TransactionPacket getDescription String Returns the description of this packet.
Wizard getDialogData Data Returns the Data object the specified dialog.
Packet getDocument Document Returns the specified document. Returns null if no document exists with the given name.
TransactionPacket getDocument Document Returns the specified document. Returns null if no document exists with the given name.
WebServiceRequest getDocument File Returns the document File object identified by name. Note, web service clients must set the filename of the document to name.
Fragment getName String Returns the name of the fragment.
Packet getProperties Data Returns all properties of this Packet as a read-only Data object. Changes made to these items are not persisted.
TransactionPacket getProperties Data Returns all properties of this Packet as a read-only Data object. Changes made to these items are not persisted.
Packet getProperty String Returns the specified property.
TransactionPacket getProperty String Returns the specified property.
TransactionWebServiceController getRequest WebServiceRequest Returns the current Request.
TransactionWebServiceController getResponse WebServiceResponse Returns the Response object.
Packet getReviewDocument Document Returns the document selected for review by the user.
TransactionPacket getReviewDocument Document Returns the document selected for review by the user.
Document getStatus String Returns the status of this document.
Packet getStatus String Returns the status of the packet.
TransactionPacket getStatus String Returns the status of the packet.
Packet getSystemStatus String Returns the status of the system workflow.
TransactionPacket getSystemStatus String Returns the status of the system workflow.
Data getValues String[] Returns the values of this Data object as an array of strings. If no values exist, this will return an empty array.
Packet getWebServiceStatus String Returns the status of the web service workflow.
TransactionPacket getWebServiceStatus String Returns the status of the web service workflow.
Packet getWizard Wizard Returns the specified wizard.
TransactionPacket getWizard Wizard Returns the specified wizard.
Packet hasDocument boolean Returns true if the given document exists in the packet.
TransactionPacket hasDocument boolean Returns true if the given document exists in the packet.
Packet hasWizard boolean Returns true if the packet has the specified wizard.
TransactionPacket hasWizard boolean Returns true if the packet has the specified wizard.
Role isOwner boolean Returns true if the user associated with the role is the transaction owner (enterprise that owns the related Pal).
Document isSigned boolean Returns true if any signature in this document has been signed by the indicated role. Pass * for all roles.
Packet isStatus boolean Returns true if the packet status is the specified status.
TransactionPacket isStatus boolean Returns true if the packet status is the specified status.
Packet isSystemStatus boolean Returns true if the system status is the specified status.
TransactionPacket isSystemStatus boolean Returns true if the system status is the specified status.
Packet isWebServiceStatus boolean Returns true if the web service status is the specified status.
TransactionPacket isWebServiceStatus boolean Returns true if the web service status is the specified status.
Document removeFragment Removes the element identified by targetId from the document. The element cannot be referenced by any signed signatures. Support for HTML documents only.
Email sendToRole Sends the email to all individuals who have the specified role.
Packet setCategory Sets the category of this packet. Maximum length is 80 characters.
TransactionPacket setCategory Sets the category of this packet. Maximum length is 80 characters.
Packet setData Saves the Data object with the given name, over-writing any existing Data object with the same name.
TransactionPacket setData Saves the Data object with the given name, over-writing any existing Data object with the same name.
Document setDescription Sets the description of this document. Max length is 80 characters.
Packet setDescription Sets the description of this packet. Maximum length is 128 characters.
TransactionPacket setDescription Sets the description of this packet. Maximum length is 128 characters.
Wizard setEndAction Sets the action that will be passed to the workflow when the wizard ends.
Packet setProperty Sets the specified property.
TransactionPacket setProperty Sets the specified property.
Document setStatus Sets the status of this document. Max length is 128 characters.
Packet setStatus Sets the status of the packet.
TransactionPacket setStatus Sets the status of the packet.
Packet setSystemStatus Sets the system status of the packet.
TransactionPacket setSystemStatus Sets the system status of the packet.
Packet setWebServiceStatus Sets the web service status of the packet.
TransactionPacket setWebServiceStatus Sets the web service status of the packet.
Wizard showDialog Sets the current dialog within the wizard for rendering, optionally clearing the history.
Document sign String Completes signing and returns the id of the signature signed. This method will throw an error if the user is not in a signing path.
Document signSignature Call immediately after sign() method. Signs this signature with the same signature signed with the sign() method.
04-26-2007
Object Method Return Type Description
Formatter parseDouble double Parses the given value into a double. Throws an error if the value cannot be converted.
Formatter parseInt int Parses the given value into an integer. Throws an error if the value cannot be converted.
Formatter replace String Replaces the first occurrence of 'find' in 'content' with 'replace' or all occurances if all is true and returns the modified content.
04-10-2007
Object Method Return Type Description
AudioFile getFileSize int Returns the size of the file in kilobytes.
DatasetFile getFileSize int Returns the size of the file in kilobytes.
DocumentFile getFileSize int Returns the size of the file in kilobytes.
ExcelFile getFileSize int Returns the size of the file in kilobytes.
File getFileSize int Returns the size of the file in kilobytes.
ImageFile getFileSize int Returns the size of the file in kilobytes.
PdfFile getFileSize int Returns the size of the file in kilobytes.
VCardFile getFileSize int Returns the size of the file in kilobytes.
AudioFile getFileType String Returns the type of the file as specified by the upload tag or API. This may be null if the file was obtained by means other than an upload.
DatasetFile getFileType String Returns the type of the file as specified by the upload tag or API. This may be null if the file was obtained by means other than an upload.
DocumentFile getFileType String Returns the type of the file as specified by the upload tag or API. This may be null if the file was obtained by means other than an upload.
ExcelFile getFileType String Returns the type of the file as specified by the upload tag or API. This may be null if the file was obtained by means other than an upload.
File getFileType String Returns the type of the file as specified by the upload tag or API. This may be null if the file was obtained by means other than an upload.
ImageFile getFileType String Returns the type of the file as specified by the upload tag or API. This may be null if the file was obtained by means other than an upload.
PdfFile getFileType String Returns the type of the file as specified by the upload tag or API. This may be null if the file was obtained by means other than an upload.
VCardFile getFileType String Returns the type of the file as specified by the upload tag or API. This may be null if the file was obtained by means other than an upload.
AudioFile isCorrectType boolean Returns true if the type of the file is within the specified restriction.
DatasetFile isCorrectType boolean Returns true if the type of the file is within the specified restriction.
DocumentFile isCorrectType boolean Returns true if the type of the file is within the specified restriction.
ExcelFile isCorrectType boolean Returns true if the type of the file is within the specified restriction.
File isCorrectType boolean Returns true if the type of the file is within the specified restriction.
ImageFile isCorrectType boolean Returns true if the type of the file is within the specified restriction.
PdfFile isCorrectType boolean Returns true if the type of the file is within the specified restriction.
VCardFile isCorrectType boolean Returns true if the type of the file is within the specified restriction.
AudioFile isSizeExceeded boolean Returns true if the size of the file exceeds the specified restriction.
DatasetFile isSizeExceeded boolean Returns true if the size of the file exceeds the specified restriction.
DocumentFile isSizeExceeded boolean Returns true if the size of the file exceeds the specified restriction.
ExcelFile isSizeExceeded boolean Returns true if the size of the file exceeds the specified restriction.
File isSizeExceeded boolean Returns true if the size of the file exceeds the specified restriction.
ImageFile isSizeExceeded boolean Returns true if the size of the file exceeds the specified restriction.
PdfFile isSizeExceeded boolean Returns true if the size of the file exceeds the specified restriction.
VCardFile isSizeExceeded boolean Returns true if the size of the file exceeds the specified restriction.
AudioFile isValid boolean Returns true if the content of the file is valid.
DatasetFile isValid boolean Returns true if the content of the file is valid.
DocumentFile isValid boolean Returns true if the content of the file is valid.
ExcelFile isValid boolean Returns true if the content of the file is valid.
File isValid boolean Returns true if the content of the file is valid.
ImageFile isValid boolean Returns true if the content of the file is valid.
PdfFile isValid boolean Returns true if the content of the file is valid.
VCardFile isValid boolean Returns true if the content of the file is valid.
AudioFile isVirus boolean Returns true if the content of the file contains a virus.
DatasetFile isVirus boolean Returns true if the content of the file contains a virus.
DocumentFile isVirus boolean Returns true if the content of the file contains a virus.
ExcelFile isVirus boolean Returns true if the content of the file contains a virus.
File isVirus boolean Returns true if the content of the file contains a virus.
ImageFile isVirus boolean Returns true if the content of the file contains a virus.
PdfFile isVirus boolean Returns true if the content of the file contains a virus.
VCardFile isVirus boolean Returns true if the content of the file contains a virus.
ImageFile resizeWidth Transforms the size of the file (only works on images) by reducing the width to the specified with. If the width is already less than the specified width, this does nothing.
PdfFile resizeWidth Transforms the size of the file (only works on images) by reducing the width to the specified with. If the width is already less than the specified width, this does nothing.
03-15-2007
Object Method Return Type Description
Profile getEmailAddress String Returns the email address associated with this profile.
ProfileInfo getEmailAddress String Returns the email address associated with this profile.
Profile getFirstName String Returns the first name of the user associated with this profile.
ProfileInfo getFirstName String Returns the first name of the user associated with this profile.
Profile getLastName String Returns the last name of the user associated with this profile.
ProfileInfo getLastName String Returns the last name of the user associated with this profile.
Enterprise hasProfile boolean Returns true if the Enterprise has a profile for the user associated with the user of the given profile.
EnterpriseInfo hasProfile boolean Returns true if the Enterprise has a profile for the user associated with the user of the given profile.
Profile isEnterprise boolean Returns true if this profile is an enterprise profile.
ProfileInfo isEnterprise boolean Returns true if this profile is an enterprise profile.
Profile isOwnedBy boolean Returns true if this profile is owned by the enterprise that owns specified domain.
ProfileInfo isOwnedBy boolean Returns true if this profile is owned by the enterprise that owns specified domain.
Profile isPersonal boolean Returns true if this profile is a personal profile.
ProfileInfo isPersonal boolean Returns true if this profile is a personal profile.
Enterprise isRegistered boolean Returns true if the Enterprise domain has been registered with this enterprise.
EnterpriseInfo isRegistered boolean Returns true if the Enterprise domain has been registered with this enterprise.
03-08-2007
Object Method Return Type Description
Formatter formatCurrency String Formats the given string to currency notation.
Formatter formatDate String Formats the given date using the given java date pattern (see java.text.SimpleDateFormat for sample patterns)
Formatter getNumberAsWord String Converts number to word. (ex: 123 converts to 'one hundred twenty three')
01-30-2007
Object Method Return Type Description
Document updateFragment boolean Updates the contents of target with the given fragment. Support for HTML documents only.
01-08-2007
Object Method Return Type Description
Document setValue Adds the fieldName/value pair to the data object for this document, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)
Copyright © 2006 - 2026, ContractPal, Inc. All rights reserved. API Date: Apr 11, 2026 06:50 PM