ProfileTxManager

Method Summary
int	cancelDeleteTransaction(String txId, String group) Cancels deletion of the specified transaction. The active user must have the group permission 'delete transaction' for the specified group.
int	cancelDeleteTransactions(String[] txIds, String group) Cancels deletion of the specified transactions. The active user must have the group permission 'delete transaction' for the specified group.
int	changeTransactionGroup(String fromGroup, String toGroup) Moves group association for all transactions from fromGroup to toGroup. Returns -1 if the user does not have permissions in both groups.
boolean	changeTransactionGroup(String txId, String fromGroup, String toGroup) Moves group association for the specified transaction from fromGroup to toGroup. Returns false if the user does not have permissions in both groups.
int	changeTransactionGroup(String[] txIds, String fromGroup, String toGroup) 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.
SystemDataView	getDeletedTransactionsView() Returns a SystemDataView that can be used for accessing transactions that have been deleted.
DataList	getTransactionAuditLogs(String txId) Returns audit logs for transaction. The active user must have permission to access transaction audit logs. Otherwise null returned
SystemDataView	getTransactionViewByGroup(String group, String palId) 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.
SystemDataView	getTransactionViewByRole(String palId) 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.
SystemDataView	getTransactionViewByRoles(String palId) 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.
SystemDataView	getTransactionViewByScheduledDelete(String group) 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.
SystemDataView	getTransactionViewByUserRemoved() 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.
int	removeUserAccessToTransaction(String txId, String role) Removes the specified role(s) on the given transaction from the active user. Pass * for role to remove all roles.
int	removeUserAccessToTransactions(String[] txIds, String role) Removes the specified role(s) on the given transaction(s) from the active user. Pass * for role to remove all roles.
int	restoreUserAccessToTransaction(String txId, String role) Restores the specified role(s) on the given transaction to the active user. Pass * for role to restore all roles.
int	restoreUserAccessToTransactions(String[] txIds, String role) Restores the specified role(s) on the given transaction(s) to the active user. Pass * for role to restore all roles.
int	scheduleDeleteTransaction(String txId, String group, Date date, String datasetNames) 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.
int	scheduleDeleteTransactions(String[] ids, String group, Date date, String datasetNames) Schedules the transactions to be deleted on the specified date. See scheduleDeleteTransaction.
String	toString() Returns a description of this object.

Method Detail

---

int cancelDeleteTransaction(String txId, String group)

Cancels deletion of the specified transaction. The active user must have the group permission 'delete transaction' for the specified group.

Parameters:

• String   txId
• String   group

Returns:  int

Since: 09-22-2015

---

int cancelDeleteTransactions(String[] txIds, String group)

Cancels deletion of the specified transactions. The active user must have the group permission 'delete transaction' for the specified group.

Parameters:

• String[]   txIds
• String   group

Returns:  int

Since: 09-22-2015

---

int changeTransactionGroup(String fromGroup, String toGroup)

Moves group association for all transactions from fromGroup to toGroup. Returns -1 if the user does not have permissions in both groups.

Parameters:

• String   fromGroup
• String   toGroup

Returns:  int

Since: 09-22-2015

---

boolean changeTransactionGroup(String txId, String fromGroup, String toGroup)

Moves group association for the specified transaction from fromGroup to toGroup. Returns false if the user does not have permissions in both groups.

Parameters:

• String   txId
• String   fromGroup
• String   toGroup

Returns:  boolean

Since: 09-22-2015

---

int changeTransactionGroup(String[] txIds, String fromGroup, String toGroup)

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.

Parameters:

• String[]   txIds
• String   fromGroup
• String   toGroup

Returns:  int

Since: 09-22-2015

---

SystemDataView getDeletedTransactionsView()

Returns a SystemDataView that can be used for accessing transactions that have been deleted.

Returns:  SystemDataView

DataList Name: DeletedTransactions

DataList Keys/Column Name	Column Type	Read Only
id	String
txId	String
deleteDate	Date
testTx	Boolean
palId	String
firstName	String
lastName	String

Since: 09-22-2015

---

DataList getTransactionAuditLogs(String txId)

Returns audit logs for transaction. The active user must have permission to access transaction audit logs. Otherwise null returned

Parameters:

• String   txId

Returns:  DataList

DataList Name: logs
DataList Fields: date, event, description, email, role, ip, browser, version

Since: 09-22-2015

---

SystemDataView getTransactionViewByGroup(String group, String palId)

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.

Parameters:

• String   group Required parameter.
• String   palId

Returns:  SystemDataView

DataList Name: TransactionsByGroup

DataList Keys/Column Name	Column Type	Read Only
id	String
name	String
securedTxStatus	String
description	String
category	String
createDate	Date
modifiedDate	Date
securedTx	Boolean
testTx	Boolean
status	String
softArchive	Boolean
webServiceStatus	String
palId	String
consoleControlled	Boolean
column1	String
column2	String
column3	String
column4	String
executeEndDate	Date
accessEndDate	Date
archiveEndDate	Date
archiveDate	Date
txSize	Number
deleteDate	Date

Since: 09-22-2015

---

SystemDataView getTransactionViewByRole(String palId)

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.

Parameters:

• String   palId  - Pass * for all pals. Required parameter.

Returns:  SystemDataView

DataList Name: TransactionsByRole

DataList Keys/Column Name	Column Type	Read Only
id	String
name	String
securedTxStatus	String
description	String
category	String
createDate	Date
modifiedDate	Date
securedTx	Boolean
testTx	Boolean
status	String
softArchive	Boolean
webServiceStatus	String
palId	String
consoleControlled	Boolean
column1	String
column2	String
column3	String
column4	String
executeEndDate	Date
accessEndDate	Date
archiveEndDate	Date
archiveDate	Date
txSize	Number
role	String
accessDate	Date
removeDate	Date
roleStatus	String
deleteDate	Date

Since: 09-22-2015

---

SystemDataView getTransactionViewByRoles(String palId)

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.

Parameters:

• String   palId  - Pass * for all pals. Required parameter.

Returns:  SystemDataView

DataList Name: TransactionsByRoles

DataList Keys/Column Name	Column Type	Read Only
id	String
name	String
securedTxStatus	String
description	String
category	String
createDate	Date
modifiedDate	Date
securedTx	Boolean
testTx	Boolean
status	String
softArchive	Boolean
webServiceStatus	String
palId	String
consoleControlled	Boolean
column1	String
column2	String
column3	String
column4	String
executeEndDate	Date
accessEndDate	Date
archiveEndDate	Date
archiveDate	Date
txSize	Number
role	String
accessDate	Date
removeDate	String
roleStatus	String
deleteDate	Date

Since: 09-22-2015

---

SystemDataView getTransactionViewByScheduledDelete(String group)

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.

Parameters:

• String   group Required parameter.

Returns:  SystemDataView

DataList Name: ScheduledDeletedTransactions

DataList Keys/Column Name	Column Type	Read Only
name	String
securedTxStatus	String
description	String
category	String
createDate	Date
modifiedDate	Date
securedTx	Boolean
testTx	Boolean
status	String
softArchive	Boolean
webServiceStatus	String
palId	String
consoleControlled	Boolean
column1	String
column2	String
column3	String
column4	String
executeEndDate	Date
accessEndDate	Date
archiveEndDate	Date
archiveDate	Date
txSize	Number
deleteDate	Date
removeDate	Date
id	String
txId	String
deleteStatus	String

Since: 09-22-2015

---

SystemDataView getTransactionViewByUserRemoved()

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.

Returns:  SystemDataView

DataList Name: RemovedUserTransactions

DataList Keys/Column Name	Column Type	Read Only
id	String
name	String
securedTxStatus	String
description	String
category	String
createDate	Date
modifiedDate	Date
securedTx	Boolean
testTx	Boolean
status	String
softArchive	Boolean
webServiceStatus	String
palId	String
consoleControlled	Boolean
column1	String
column2	String
column3	String
column4	String
executeEndDate	Date
accessEndDate	Date
archiveEndDate	Date
archiveDate	Date
txSize	Number
role	String
accessDate	Date
removeDate	Date
roleStatus	String
deleteDate	Date

Since: 09-22-2015

---

int removeUserAccessToTransaction(String txId, String role)

Removes the specified role(s) on the given transaction from the active user. Pass * for role to remove all roles.

Parameters:

• String   txId
• String   role

Returns:  int

Since: 09-22-2015

---

int removeUserAccessToTransactions(String[] txIds, String role)

Removes the specified role(s) on the given transaction(s) from the active user. Pass * for role to remove all roles.

Parameters:

• String[]   txIds
• String   role

Returns:  int

Since: 09-22-2015

---

int restoreUserAccessToTransaction(String txId, String role)

Restores the specified role(s) on the given transaction to the active user. Pass * for role to restore all roles.

Parameters:

• String   txId
• String   role

Returns:  int

Since: 09-22-2015

---

int restoreUserAccessToTransactions(String[] txIds, String role)

Restores the specified role(s) on the given transaction(s) to the active user. Pass * for role to restore all roles.

Parameters:

• String[]   txIds
• String   role

Returns:  int

Since: 09-22-2015

---

int scheduleDeleteTransaction(String txId, String group, Date date, String datasetNames)

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.

Parameters:

• String   txId
• String   group
• Date   date
• String   datasetNames

Returns:  int

Since: 09-22-2015

---

int scheduleDeleteTransactions(String[] ids, String group, Date date, String datasetNames)

Schedules the transactions to be deleted on the specified date. See scheduleDeleteTransaction.

Parameters:

• String[]   ids Required parameter.
• String   group
• Date   date Required parameter.
• String   datasetNames Maximum allowed size of parameter: 200

Returns:  int

Since: 09-22-2015

---

String toString()

Returns a description of this object.

Returns:  String

Since: 09-22-2015