Packet

Method Summary
Attachment	addAttachment(File file, String name, String description) 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.
	addAuditEntry(String event, String description) Adds an audit entry to the transaction.
Document	addDocument(String docname) Adds the specified document to the packet
Document	addDocument(String docname, Data data) 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.
Document	addDocumentFromAttachment(Attachment file, String docname, String description) Adds the specified attachment to the packet as a document. The attachment should be PDF
Document	addDocumentFromFile(File file, String docname, String description) Adds the specified content to the packet as a document. The file should be PDF or HTML.
Document	addDocumentFromFile(File file, String docname, String description, Data data) Adds the specified content to the packet as a document and populates the document with the data. The file should be PDF or HTML.
Document	addDocumentFromPal(String palId, String docname, String newname, String description, Data data) 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.
Document	addDuplicateDocument(String docname, String newname, String description) Adds the specified document to the packet with the specified new name and description.
Document	addDuplicateDocument(String docname, String newname, String description, Data data) 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.
Wizard	addDuplicateWizard(String name, String newName) Adds the specified wizard with the specified new name.
boolean	addGroup(String group) Associates this packet with the specified private group. Returns false if the group does not exist.
Wizard	addWizard(String name) Adds the specified wizard.
Role	assignEnterpriseRole(ProfileInfo profileInfo, String role) Verifies the profile is enterprise then assigns the specified role. Returns null if the profile is not enterprise.
Role	assignEnterpriseRole(String email, String role, EnterpriseInfo enterprise) 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.
Role	assignPersonalRole(ProfileInfo profileInfo, String role) Assigns the role to the personal profile associated with the user who owns the given profile (which may or may not be personal).
Role	assignPersonalRole(String email, String 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.
Role	assignRole(ProfileInfo profileInfo, String role) Assigns the role to the specified user profile.
	cancelDelete() Cancels deletion of the transaction.
	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.
Data	createData(String name) 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.
PacketDataList	createDataList(String name, String[] columns) 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.
Document	createDocument(SmartDoc smartDoc, Data data) 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.
Document	createPdfDocument(PdfFile file, String name, String description) Adds the document from the PDF file. See DisplaySettings.renderSmart and Document.setLayerPayload.
String	createPublicPin(String firstName, String lastName, Date expirationDate, int size, boolean recycle) 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.
String	createUserPin(String firstName, String lastName, String emailAddress, Date expirationDate, int size, boolean recycle) 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.
boolean	deleteAttachment(String name) Deletes the attachment with the given name. Returns false if no attachment exists with the name.
	deleteData(String name) Deletes the Data object with the given name.
	deleteDataList(String name) Deletes the specified DataList.
	deleteDataLists() Deletes all DataList objects in this packet.
	deleteDatas() Deletes all Data objects in this packet.
	deleteDocument(String docname) Deletes the specified document.
	deletePin(String pin) Deletes the specified PIN.
	deleteProperty(String name) Deletes the specified property.
	deleteWizard(String name) Deletes the wizard with the given name.
boolean	disableSystemWorkflow() ⚠Deprecated since 06-19-2024. Use JobManager Job Disables/cancels execution of system workflow. If there is no system workflowassociated with this Pal, calling this method is quietly ignored.
boolean	enableSystemWorkflow() ⚠Deprecated since 06-19-2024. Use JobManager Job 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.
	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.
	endExecutionPeriod() Immediately ends the Execution period (if in the future) and adjusts the Access and Archive periods according to the activation key.
boolean	expandSize(int sizeInMB) Expands the transaction size by the specified amount in MB and charges the corresponding fee as a pal billing event.
DataList	getAllAttachments() Returns a DataList containing information on attachments of this packet and all of its documents.
Attachment	getAttachment(String name) Returns the attachment identified by name. Returns null if no attachment exists with the given name.
DataList	getAttachments() Returns a DataList containing information on attachments of this packet.
DataList	getAuditLogs() Returns the audit log entries associated with this Packet and all of its documents.
BillingEngine	getBillingEngine() Returns the billing engine for this Transaction. Throws exception if the Activation Key does not enable pal billing.
String	getBillingReference() Returns the billing reference associated with the execution fee for this Packet. Deployed Packets only.
String	getCategory() Returns the category of this packet.
String	getColumn1() Returns custom column value
String	getColumn2() Returns custom column value
String	getColumn3() Returns custom column value
String	getColumn4() Returns custom column value
Date	getCreateDate() Returns the date this transaction packet was created.
Document	getCurrentDocument() Returns the active document (the last one shown for signing or viewing).
Wizard	getCurrentWizard() Returns the current wizard.
Data	getData() Returns information about this Packet.
Data	getData(String name) Returns the named Data object. Modifications to the content of the Data object are automatically persisted.
PacketDataList	getDataList(String name) Returns the specified DataList if it exists, or null if it does not.
DataList	getDataLists() Returns a read-only DataList of all the DataList objects in this transaction.
DataList	getDatas() Returns a read-only DataList of all the Data objects in this transaction.
String	getDefaultProperty(String field, String defaultValue, boolean emptyIsNull) 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.
String	getDescription() Returns the description of this packet.
Document	getDocument(String docname) Returns the specified document. Returns null if no document exists with the given name.
DataList	getDocuments() Returns a read-only DataList of all the documents in this transaction. The name of the datalist is 'documents'.
DataList	getDocumentsAndSignatures() Returns a read-only DataList of all the documents and signatures in this transaction. The name of the datalist is 'documents'.
SystemDataView	getEmailJobs() Returns list of email jobs for this transaction.
DataList	getEmails() Returns all email jobs related to this Packet.
SystemDataView	getEnterpriseRoles(String role, EnterpriseInfo enterpriseInfo) 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.
int	getExpandAvailable() Returns the available expansion size in MB. Returns 0 if there is no amount left or if pricing does not permit expansion.
int	getExpandSize() Returns the current expansion size in MB.
Document	getFirstDocument() Returns the first document in the Packet or null if there are no documents.
DataList	getGroups() Returns a DataList of all groups associated with this packet.
String	getId() Returns the ID of the transaction. This can be used in conjunction with web services.
JobManager	getJobManager() Returns a JobManager specific to this Packet.
Date	getLastCycle() ⚠Deprecated since 06-19-2024. Use JobManager Job Returns the date when Transaction System workflow will ran last.
Document	getLastDocument() Returns the last document in the Packet or null if there are no documents.
int	getMaxUploadSize() 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.
String	getName() Returns the name of this packet.
Date	getNextCycle() ⚠Deprecated since 06-19-2024. Use JobManager Job Returns the date when Transaction System workflow will run next.
PacketDataList	getOrCreateDataList(String name, String[] columns) 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.
EnterpriseInfo	getOwner() Returns the enterprise that owns the Transaction.
String	getPalId() Returns the Pal ID of this transaction.
SystemDataView	getPins() Returns a SystemDataView that can be used for accessing PINS associated with this Packet.
Role	getProfileRole(String profileId, String role) Returns the role matching profile and role. Returns null if not found.
Data	getProperties() Returns all properties of this Packet as a read-only Data object. Changes made to these items are not persisted.
String	getProperty(String name) Returns the specified property.
Document	getReviewDocument() Returns the document selected for review by the user.
Role	getRole(String 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	getRoleByEmail(String email) Returns the Role associated with this transaction and the given email.
Role[]	getRoles(String role) Returns an array of Roles with the given role. Pass * as the role to get all Roles.
Date	getScheduledDeleteDate() If this transaction has been scheduled for deletion, returns the date. Otherwise returns null. See scheduleDelete method.
String	getSecureId() Returns the ID of the transaction, encrypted. This can be used in conjunction with Web Pal architecture.
String	getSecuredTxStatus() Returns the secured status.
DataList	getSignedDocumentsByUser(String userId) Returns a DataList of all the documents in this transaction that have been signed by the specified user. See Profile.getUserId().
int	getSize() Returns the size of this Packet in bytes.
String	getStatus() Returns the status of the packet.
String	getSystemStatus() ⚠Deprecated since 06-19-2024. Use JobManager Job Returns the status of the system workflow.
Role	getUserRole(String email, String role) Returns the role matching email and role. Returns null if not found.
SystemDataView	getUserRoles(String role) Returns a SystemDataView that can be used to list users who have the given role. Pass * as the role to get all users.
String	getWebServiceStatus() Returns the status of the web service workflow.
Wizard	getWizard(String name) Returns the specified wizard.
boolean	hasDocument(String docname) Returns true if the given document exists in the packet.
boolean	hasWizard(String name) Returns true if the packet has the specified wizard.
boolean	isSecuredTx() Returns true if this is a secured transaction.
boolean	isStatus(String status) Returns true if the packet status is the specified status.
boolean	isSystemError() ⚠Deprecated since 06-19-2024. Use JobManager Job Returns true if Transaction System workflow generated an error.
boolean	isSystemStatus(String status) ⚠Deprecated since 06-19-2024. Use JobManager Job Returns true if the system status is the specified status.
boolean	isWebServiceStatus(String status) Returns true if the web service status is the specified status.
	removeGroup(String group) Removes the packet from the specified private group.
	removeSecuredTxStatus() Removes the secured status, making this no longer a secured transaction.
	revokeRoles(String role) Revokes the role from all users who have it
boolean	schedule(Date date) ⚠Deprecated since 06-19-2024. Use JobManager Job 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.
boolean	scheduleDelete(Date date, String dataSetNames) 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.
	setBillingReference(String reference) Sets the billing reference associated with the execution fee for this Packet. Deployed Packets only.
	setCategory(String category) Sets the category of this packet. Maximum length is 80 characters.
	setColumn1(String value) Sets custom column value
	setColumn2(String value) Sets custom column value
	setColumn3(String value) Sets custom column value
	setColumn4(String value) Sets custom column value
	setData(String name, Data data) Saves the Data object with the given name, over-writing any existing Data object with the same name.
	setDataList(PacketDataList list) Saves the specified DataList, over-writing any other table that might exist with the same name.
	setDescription(String description) Sets the description of this packet. Maximum length is 128 characters.
	setName(String name) Sets the name of this packet. Maximum length is 80 characters.
	setProperty(String name, String value) Sets the specified property.
	setSecuredTxStatus(String securedStatus) Sets the secured status.
	setStatus(String status) Sets the status of the packet.
	setSystemStatus(String status) ⚠Deprecated since 06-19-2024. Use JobManager Job Sets the system status of the packet.
	setWebServiceStatus(String status) Sets the web service status of the packet.
File	toFile(String fileName, boolean encrypt, String password) 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.
Payload	toPayload() Extracts the properties, Data, and DataLists of this transaction packet as a Payload object. Changes are not saved.
String	toString() Returns a description of this object.
	updatePin(String pin, Date newExpirationDate) Updates the specified PIN. Expiration date must be in the future

Method Detail

Attachment addAttachment(File file, String name, String description)

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.

Parameters:

File file
String name
String description

Returns: Attachment

Since: 11-18-2008

top

addAuditEntry(String event, String description)

Adds an audit entry to the transaction.

Parameters:

String event
String description

Since: 05-31-2007

top

Document addDocument(String docname)

Adds the specified document to the packet

Parameters:

String docname Required parameter. Maximum allowed size of parameter: 80

Returns: Document

Since: 05-31-2007

top

Document addDocument(String docname, Data data)

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.

Parameters:

String docname Required parameter. Maximum allowed size of parameter: 80
Data data

Returns: Document

Since: 05-13-2008

top

Document addDocumentFromAttachment(Attachment file, String docname, String description)

Adds the specified attachment to the packet as a document. The attachment should be PDF

Parameters:

Attachment file Required parameter.
String docname Required parameter. Maximum allowed size of parameter: 80
String description Maximum allowed size of parameter: 80

Returns: Document

Since: 08-27-2009

top

Document addDocumentFromFile(File file, String docname, String description)

Adds the specified content to the packet as a document. The file should be PDF or HTML.

Parameters:

File file Required parameter.
String docname Required parameter. Maximum allowed size of parameter: 80
String description Required parameter. Maximum allowed size of parameter: 80

Returns: Document

Since: 05-31-2007

top

Document addDocumentFromFile(File file, String docname, String description, Data data)

Adds the specified content to the packet as a document and populates the document with the data. The file should be PDF or HTML.

Parameters:

File file Required parameter.
String docname Required parameter. Maximum allowed size of parameter: 80
String description Required parameter. Maximum allowed size of parameter: 80
Data data

Returns: Document

Since: 10-02-2009

top

Document addDocumentFromPal(String palId, String docname, String newname, String description, Data data)

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.

Parameters:

String palId Required parameter.
String docname Required parameter. Maximum allowed size of parameter: 80
String newname Maximum allowed size of parameter: 80
String description Maximum allowed size of parameter: 80
Data data

Returns: Document

Since: 05-31-2007

top

Document addDuplicateDocument(String docname, String newname, String description)

Adds the specified document to the packet with the specified new name and description.

Parameters:

String docname Required parameter. Maximum allowed size of parameter: 80
String newname Required parameter. Maximum allowed size of parameter: 80
String description Required parameter. Maximum allowed size of parameter: 80

Returns: Document

Since: 05-31-2007

top

Document addDuplicateDocument(String docname, String newname, String description, Data data)

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.

Parameters:

String docname Required parameter. Maximum allowed size of parameter: 80
String newname Required parameter. Maximum allowed size of parameter: 80
String description Required parameter. Maximum allowed size of parameter: 80
Data data

Returns: Document

Since: 05-31-2007

top

Wizard addDuplicateWizard(String name, String newName)

Adds the specified wizard with the specified new name.

Parameters:

String name Required parameter. Maximum allowed size of parameter: 80
String newName Required parameter. Maximum allowed size of parameter: 80

Returns: Wizard

Since: 05-31-2007

top

boolean addGroup(String group)

Associates this packet with the specified private group. Returns false if the group does not exist.

Parameters:

String group Required parameter.

Returns: boolean

Since: 12-18-2008

top

Wizard addWizard(String name)

Adds the specified wizard.

Parameters:

String name Required parameter. Maximum allowed size of parameter: 80

Returns: Wizard

Since: 05-31-2007

top

Role assignEnterpriseRole(ProfileInfo profileInfo, String role)

Verifies the profile is enterprise then assigns the specified role. Returns null if the profile is not enterprise.

Parameters:

ProfileInfo profileInfo Required parameter.
String role Required parameter. Maximum allowed size of parameter: 80

Returns: Role

Since: 02-07-2011

top

Role assignEnterpriseRole(String email, String role, EnterpriseInfo enterprise)

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.

Parameters:

String email Required parameter. Maximum allowed size of parameter: 254
String role Required parameter. Maximum allowed size of parameter: 80
EnterpriseInfo enterprise Required parameter.

Returns: Role

Since: 05-18-2011

top

Role assignPersonalRole(ProfileInfo profileInfo, String role)

Assigns the role to the personal profile associated with the user who owns the given profile (which may or may not be personal).

Parameters:

ProfileInfo profileInfo Required parameter.
String role Required parameter. Maximum allowed size of parameter: 80

Returns: Role

Since: 02-07-2011

top

Role assignPersonalRole(String email, String 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.

Parameters:

String email Required parameter. Maximum allowed size of parameter: 254
String role Required parameter. Maximum allowed size of parameter: 80

Returns: Role

Since: 05-18-2011

top

Role assignRole(ProfileInfo profileInfo, String role)

Assigns the role to the specified user profile.

Parameters:

ProfileInfo profileInfo Required parameter.
String role Required parameter. Maximum allowed size of parameter: 80

Returns: Role

Since: 05-18-2011

top

cancelDelete()

Cancels deletion of the transaction.

Since: 09-13-2011

top

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.

Since: 10-31-2011

top

Data createData(String name)

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.

Parameters:

String name

Returns: Data

Since: 10-07-2009

top

PacketDataList createDataList(String name, String[] columns)

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.

Parameters:

String name Required parameter. Maximum allowed size of parameter: 1000
String[] columns Required parameter.

Returns: PacketDataList

Since: 07-08-2010

top

Document createDocument(SmartDoc smartDoc, Data data)

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.

Parameters:

SmartDoc smartDoc Required parameter.
Data data

Returns: Document

Since: 06-28-2012

top

Document createPdfDocument(PdfFile file, String name, String description)

Adds the document from the PDF file. See DisplaySettings.renderSmart and Document.setLayerPayload.

Parameters:

PdfFile file Required parameter.
String name Required parameter. Maximum allowed size of parameter: 80
String description Required parameter. Maximum allowed size of parameter: 80

Returns: Document

Since: 05-15-2018

top

String createPublicPin(String firstName, String lastName, Date expirationDate, int size, boolean recycle)

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.

Parameters:

String firstName Required parameter. Maximum allowed size of parameter: 30
String lastName Required parameter. Maximum allowed size of parameter: 30
Date expirationDate Required parameter.
int size
boolean recycle

Returns: String

Since: 11-19-2009

top

String createUserPin(String firstName, String lastName, String emailAddress, Date expirationDate, int size, boolean recycle)

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.

Parameters:

String firstName Required parameter. Maximum allowed size of parameter: 30
String lastName Required parameter. Maximum allowed size of parameter: 30
String emailAddress Required parameter. Maximum allowed size of parameter: 255
Date expirationDate Required parameter.
int size
boolean recycle

Returns: String

Since: 11-19-2009

top

boolean deleteAttachment(String name)

Deletes the attachment with the given name. Returns false if no attachment exists with the name.

Parameters:

String name

Returns: boolean

Since: 11-26-2008

top

deleteData(String name)

Deletes the Data object with the given name.

Parameters:

String name

Since: 05-31-2007

top

deleteDataList(String name)

Deletes the specified DataList.

Parameters:

String name

Since: 08-01-2007

top

deleteDataLists()

Deletes all DataList objects in this packet.

Since: 05-14-2012

top

deleteDatas()

Deletes all Data objects in this packet.

Since: 05-14-2012

top

deleteDocument(String docname)

Deletes the specified document.

Parameters:

String docname

Since: 05-31-2007

top

deletePin(String pin)

Deletes the specified PIN.

Parameters:

String pin

Since: 11-19-2009

top

deleteProperty(String name)

Deletes the specified property.

Parameters:

String name Required parameter. Maximum allowed size of parameter: 1000

Since: 05-31-2007

top

deleteWizard(String name)

Deletes the wizard with the given name.

Parameters:

String name

Since: 05-31-2007

top

boolean disableSystemWorkflow()

Disables/cancels execution of system workflow. If there is no system workflowassociated with this Pal, calling this method is quietly ignored.

Returns: boolean

Since: 12-01-2010

This method has been deprecated since 06-19-2024. Use JobManager Job

top

boolean enableSystemWorkflow()

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.

Returns: boolean

Since: 05-31-2007

This method has been deprecated since 06-19-2024. Use JobManager Job

top

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.

Since: 11-30-2016

top

endExecutionPeriod()

Immediately ends the Execution period (if in the future) and adjusts the Access and Archive periods according to the activation key.

Since: 05-31-2007

top

boolean expandSize(int sizeInMB)

Expands the transaction size by the specified amount in MB and charges the corresponding fee as a pal billing event.

Parameters:

int sizeInMB Required parameter. Maximum allowed size of parameter: 100

Returns: boolean

Since: 01-18-2017

top

DataList getAllAttachments()

Returns a DataList containing information on attachments of this packet and all of its documents.

Returns: DataList

DataList Name: attachments
DataList Fields: id, name, description, filename, contentType, createDate, size, type, creator, lastModifier, lastModifiedDate, htmlConversionSupported

Since: 12-19-2008

top

Attachment getAttachment(String name)

Returns the attachment identified by name. Returns null if no attachment exists with the given name.

Parameters:

String name

Returns: Attachment

Since: 11-18-2008

top

DataList getAttachments()

Returns a DataList containing information on attachments of this packet.

Returns: DataList

DataList Name: attachments
DataList Fields: id, name, description, filename, contentType, createDate, size, type, creator, lastModifier, lastModifiedDate, htmlConversionSupported

Since: 11-18-2008

top

DataList getAuditLogs()

Returns the audit log entries associated with this Packet and all of its documents.

Returns: DataList

DataList Name: auditlogs
DataList Fields: event, description, document, date, email, role, ipaddress, palversion, useragent

Since: 12-03-2008

top

BillingEngine getBillingEngine()

Returns the billing engine for this Transaction. Throws exception if the Activation Key does not enable pal billing.

Returns: BillingEngine

Since: 05-30-2013

top

String getBillingReference()

Returns the billing reference associated with the execution fee for this Packet. Deployed Packets only.

Returns: String

Since: 05-05-2010

top

String getCategory()

Returns the category of this packet.

Returns: String

Since: 05-31-2007

top

String getColumn1()

Returns custom column value

Returns: String

Since: 01-20-2010

top

String getColumn2()

Returns custom column value

Returns: String

Since: 01-20-2010

top

String getColumn3()

Returns custom column value

Returns: String

Since: 01-20-2010

top

String getColumn4()

Returns custom column value

Returns: String

Since: 01-20-2010

top

Date getCreateDate()

Returns the date this transaction packet was created.

Returns: Date

Since: 01-06-2010

top

Document getCurrentDocument()

Returns the active document (the last one shown for signing or viewing).

Returns: Document

Since: 05-31-2007

top

Wizard getCurrentWizard()

Returns the current wizard.

Returns: Wizard

Since: 05-31-2007

top

Data getData()

Returns information about this Packet.

Returns: Data

Since: 03-12-2012

top

Data getData(String name)

Returns the named Data object. Modifications to the content of the Data object are automatically persisted.

Parameters:

String name

Returns: Data

Since: 05-31-2007

top

PacketDataList getDataList(String name)

Returns the specified DataList if it exists, or null if it does not.

Parameters:

String name

Returns: PacketDataList

Since: 08-01-2007

top

DataList getDataLists()

Returns a read-only DataList of all the DataList objects in this transaction.

Returns: DataList

DataList Name: datalists
DataList Fields: name

Since: 05-14-2012

top

DataList getDatas()

Returns a read-only DataList of all the Data objects in this transaction.

Returns: DataList

DataList Name: datas
DataList Fields: name

Since: 05-14-2012

top

String getDefaultProperty(String field, String defaultValue, boolean emptyIsNull)

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.

Parameters:

String field
String defaultValue
boolean emptyIsNull

Returns: String

Since: 09-05-2008

top

String getDescription()

Returns the description of this packet.

Returns: String

Since: 05-31-2007

top

Document getDocument(String docname)

Returns the specified document. Returns null if no document exists with the given name.

Parameters:

String docname

Returns: Document

Since: 05-31-2007

top

DataList getDocuments()

Returns a read-only DataList of all the documents in this transaction. The name of the datalist is 'documents'.

Returns: DataList

DataList Name: documents
DataList Fields: name, description, status, type, sortOrder

Since: 07-12-2007

top

DataList getDocumentsAndSignatures()

Returns a read-only DataList of all the documents and signatures in this transaction. The name of the datalist is 'documents'.

Returns: DataList

DataList Name: documents
DataList Fields: name, description, status, id, type, role, signed, email, auditName, data, sortOrder

Since: 09-15-2009

top

SystemDataView getEmailJobs()

Returns list of email jobs for this transaction.

Returns: SystemDataView

DataList Name: TransactionPacketEmailJobs

DataList Keys/Column Name	Column Type	Read Only
id	String
email	String
subject	String
status	String
created	Date
sent	Date
expireDate	Date
attempts	Number
nextAttempt	Date
replyTo	String
type	String
sendDate	Date
deliveryStatus	String
senderFirstName	String
senderLastName	String
settingsId	String
senderEmail	String

Since: 08-26-2010

top

DataList getEmails()

Returns all email jobs related to this Packet.

Returns: DataList

DataList Name: emails
DataList Fields: id, email, subject, status, created, sent, attempts, nextAttempt, senderFirstName, senderLastName, senderEmail, replyTo, type, sendDate, settingsId

Since: 12-03-2008

top

SystemDataView getEnterpriseRoles(String role, EnterpriseInfo enterpriseInfo)

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.

Parameters:

String role Required parameter.
EnterpriseInfo enterpriseInfo Required parameter.

Returns: SystemDataView

DataList Name: TransactionPacketEnterpriseUsers

DataList Keys/Column Name	Column Type	Read Only
firstName	String
lastName	String
email	String
status	String
role	String
active	Boolean
accessDate	Date

Since: 05-18-2011

top

int getExpandAvailable()

Returns the available expansion size in MB. Returns 0 if there is no amount left or if pricing does not permit expansion.

Returns: int

Since: 01-18-2017

top

int getExpandSize()

Returns the current expansion size in MB.

Returns: int

Since: 01-18-2017

top

Document getFirstDocument()

Returns the first document in the Packet or null if there are no documents.

Returns: Document

Since: 11-01-2012

top

DataList getGroups()

Returns a DataList of all groups associated with this packet.

Returns: DataList

DataList Name: packetGroups
DataList Fields: name, description, type

Since: 12-18-2008

top

String getId()

Returns the ID of the transaction. This can be used in conjunction with web services.

Returns: String

Since: 01-11-2008

top

JobManager getJobManager()

Returns a JobManager specific to this Packet.

Returns: JobManager

Since: 06-19-2024

top

Date getLastCycle()

Returns the date when Transaction System workflow will ran last.

Returns: Date

Since: 11-17-2011

This method has been deprecated since 06-19-2024. Use JobManager Job

top

Document getLastDocument()

Returns the last document in the Packet or null if there are no documents.

Returns: Document

Since: 11-01-2012

top

int getMaxUploadSize()

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.

Returns: int

Since: 11-25-2008

top

String getName()

Returns the name of this packet.

Returns: String

Since: 12-18-2009

top

Date getNextCycle()

Returns the date when Transaction System workflow will run next.

Returns: Date

Since: 11-17-2011

This method has been deprecated since 06-19-2024. Use JobManager Job

top

PacketDataList getOrCreateDataList(String name, String[] columns)

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.

Parameters:

String name Required parameter. Maximum allowed size of parameter: 1000
String[] columns Required parameter.

Returns: PacketDataList

Since: 07-08-2010

top

EnterpriseInfo getOwner()

Returns the enterprise that owns the Transaction.

Returns: EnterpriseInfo

Since: 02-17-2011

top

String getPalId()

Returns the Pal ID of this transaction.

Returns: String

Since: 05-31-2016

top

SystemDataView getPins()

Returns a SystemDataView that can be used for accessing PINS associated with this Packet.

Returns: SystemDataView

DataList Name: Pins

DataList Keys/Column Name	Column Type	Read Only
palId	String
transactionId	String
txId	String
pin	String
auditName	String
email	String
lastAccess	Date
expirationDate	Date
publicAccess	Boolean

Since: 11-19-2009

top

Role getProfileRole(String profileId, String role)

Returns the role matching profile and role. Returns null if not found.

Parameters:

String profileId Required parameter. Maximum allowed size of parameter: 254
String role Required parameter. Maximum allowed size of parameter: 80

Returns: Role

Since: 12-03-2012

top

Data getProperties()

Returns all properties of this Packet as a read-only Data object. Changes made to these items are not persisted.

Returns: Data

Since: 05-31-2007

top

String getProperty(String name)

Returns the specified property.

Parameters:

String name Required parameter. Maximum allowed size of parameter: 1000

Returns: String

Since: 05-31-2007

top

Document getReviewDocument()

Returns the document selected for review by the user.

Returns: Document

Since: 05-31-2007

top

Role getRole(String 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.

Parameters:

String role Required parameter.

Returns: Role

Since: 05-18-2011

top

Role getRoleByEmail(String email)

Returns the Role associated with this transaction and the given email.

Parameters:

String email Required parameter. Maximum allowed size of parameter: 254

Returns: Role

Since: 05-18-2011

top

Role[] getRoles(String role)

Returns an array of Roles with the given role. Pass * as the role to get all Roles.

Parameters:

String role Required parameter.

Returns: Role[]

Since: 05-18-2011

top

Date getScheduledDeleteDate()

If this transaction has been scheduled for deletion, returns the date. Otherwise returns null. See scheduleDelete method.

Returns: Date

Since: 09-23-2009

top

String getSecureId()

Returns the ID of the transaction, encrypted. This can be used in conjunction with Web Pal architecture.

Returns: String

Since: 04-10-2008

top

String getSecuredTxStatus()

Returns the secured status.

Returns: String

Since: 05-16-2011

top

DataList getSignedDocumentsByUser(String userId)

Returns a DataList of all the documents in this transaction that have been signed by the specified user. See Profile.getUserId().

Parameters:

String userId Required parameter.

Returns: DataList

DataList Name: documents
DataList Fields: name, description, status

Since: 06-29-2011

top

int getSize()

Returns the size of this Packet in bytes.

Returns: int

Since: 11-25-2008

top

String getStatus()

Returns the status of the packet.

Returns: String

Since: 05-31-2007

top

String getSystemStatus()

Returns the status of the system workflow.

Returns: String

Since: 05-31-2007

This method has been deprecated since 06-19-2024. Use JobManager Job

top

Role getUserRole(String email, String role)

Returns the role matching email and role. Returns null if not found.

Parameters:

String email Required parameter. Maximum allowed size of parameter: 254
String role Required parameter. Maximum allowed size of parameter: 80

Returns: Role

Since: 12-03-2012

top

SystemDataView getUserRoles(String role)

Returns a SystemDataView that can be used to list users who have the given role. Pass * as the role to get all users.

Parameters:

String role Required parameter.

Returns: SystemDataView

DataList Name: TransactionPacketUsers

DataList Keys/Column Name	Column Type	Read Only
firstName	String
lastName	String
email	String
status	String
role	String
enterprise	Boolean
personal	Boolean
active	Boolean
accessDate	Date

Since: 02-07-2011

top

String getWebServiceStatus()

Returns the status of the web service workflow.

Returns: String

Since: 05-31-2007

top

Wizard getWizard(String name)

Returns the specified wizard.

Parameters:

String name

Returns: Wizard

Since: 05-31-2007

top

boolean hasDocument(String docname)

Returns true if the given document exists in the packet.

Parameters:

String docname

Returns: boolean

Since: 05-31-2007

top

boolean hasWizard(String name)

Returns true if the packet has the specified wizard.

Parameters:

String name

Returns: boolean

Since: 05-31-2007

top

boolean isSecuredTx()

Returns true if this is a secured transaction.

Returns: boolean

Since: 05-16-2011

top

boolean isStatus(String status)

Returns true if the packet status is the specified status.

Parameters:

String status

Returns: boolean

Since: 05-31-2007

top

boolean isSystemError()

Returns true if Transaction System workflow generated an error.

Returns: boolean

Since: 11-17-2011

This method has been deprecated since 06-19-2024. Use JobManager Job

top

boolean isSystemStatus(String status)

Returns true if the system status is the specified status.

Parameters:

String status

Returns: boolean

Since: 05-31-2007

This method has been deprecated since 06-19-2024. Use JobManager Job

top

boolean isWebServiceStatus(String status)

Returns true if the web service status is the specified status.

Parameters:

String status

Returns: boolean

Since: 05-31-2007

top

removeGroup(String group)

Removes the packet from the specified private group.

Parameters:

String group

Since: 12-18-2008

top

removeSecuredTxStatus()

Removes the secured status, making this no longer a secured transaction.

Since: 05-16-2011

top

revokeRoles(String role)

Revokes the role from all users who have it

Parameters:

String role Required parameter.

Since: 04-20-2018

top

boolean schedule(Date date)

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.

Parameters:

Date date

Returns: boolean

Since: 12-01-2010

This method has been deprecated since 06-19-2024. Use JobManager Job

top

boolean scheduleDelete(Date date, String dataSetNames)

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.

Parameters:

Date date Required parameter.
String dataSetNames Maximum allowed size of parameter: 200

Returns: boolean

Since: 09-03-2008

top

setBillingReference(String reference)

Sets the billing reference associated with the execution fee for this Packet. Deployed Packets only.

Parameters:

String reference Maximum allowed size of parameter: 15

Since: 05-05-2010

top

setCategory(String category)

Sets the category of this packet. Maximum length is 80 characters.

Parameters:

String category Maximum allowed size of parameter: 80

Since: 05-31-2007

top

setColumn1(String value)

Sets custom column value

Parameters:

String value Maximum allowed size of parameter: 80

Since: 01-20-2010

top

setColumn2(String value)

Sets custom column value

Parameters:

String value Maximum allowed size of parameter: 80

Since: 01-20-2010

top

setColumn3(String value)

Sets custom column value

Parameters:

String value Maximum allowed size of parameter: 255

Since: 01-20-2010

top

setColumn4(String value)

Sets custom column value

Parameters:

String value Maximum allowed size of parameter: 255

Since: 01-20-2010

top

setData(String name, Data data)

Saves the Data object with the given name, over-writing any existing Data object with the same name.

Parameters:

String name
Data data

Since: 05-31-2007

top

setDataList(PacketDataList list)

Saves the specified DataList, over-writing any other table that might exist with the same name.

Parameters:

PacketDataList list

Since: 08-01-2007

top

setDescription(String description)

Sets the description of this packet. Maximum length is 128 characters.

Parameters:

String description Maximum allowed size of parameter: 128

Since: 05-31-2007

top

setName(String name)

Sets the name of this packet. Maximum length is 80 characters.

Parameters:

String name Required parameter. Maximum allowed size of parameter: 80

Since: 12-18-2009

top

setProperty(String name, String value)

Sets the specified property.

Parameters:

String name Required parameter. Maximum allowed size of parameter: 1000
String value - Value of length cannot exceed available space in the packet as defined by the activation key.. Required parameter.

Since: 05-31-2007

top

setSecuredTxStatus(String securedStatus)

Sets the secured status.

Parameters:

String securedStatus Required parameter. Maximum allowed size of parameter: 60

Since: 05-16-2011

top

setStatus(String status)

Sets the status of the packet.

Parameters:

String status Maximum allowed size of parameter: 80

Since: 05-31-2007

top

setSystemStatus(String status)

Sets the system status of the packet.

Parameters:

String status Maximum allowed size of parameter: 80

Since: 05-31-2007

This method has been deprecated since 06-19-2024. Use JobManager Job

top

setWebServiceStatus(String status)

Sets the web service status of the packet.

Parameters:

String status Maximum allowed size of parameter: 80

Since: 05-31-2007

top

File toFile(String fileName, boolean encrypt, String password)

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.

Parameters:

String fileName Required parameter.
boolean encrypt Required parameter.
String password

Returns: File

Since: 05-11-2011

top

Payload toPayload()

Extracts the properties, Data, and DataLists of this transaction packet as a Payload object. Changes are not saved.

Returns: Payload

Since: 05-16-2011

top

String toString()

Returns a description of this object.

Returns: String

Since: 06-14-2007

top

updatePin(String pin, Date newExpirationDate)

Updates the specified PIN. Expiration date must be in the future

Parameters:

String pin
Date newExpirationDate

Since: 11-19-2009

top

API Date: Nov 22, 2024 11:54 AM