ZoneAccess

Method Summary
TransactionPacket	createTransaction(String palId, String description) 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.
int	disableTransactionSystemWorkflow(String[] txIds, String systemStatus) ⚠Deprecated since 06-19-2024. Use JobManager. No replacement Cancels transaction system workflow for the specified transactions. Returns the number successfully cancelled.
int	enableTransactionSystemWorkflow(String[] txIds, String systemStatus) ⚠Deprecated since 06-19-2024. Use JobManager. No replacement Enables (schedules two minutes from time of method call) transaction system workflow for the specified transactions. Returns the number successfully scheduled.
SystemDataView	getArchiveGroups(boolean restrict) Returns a SystemDataView that can be used for accessing groups of the enterprise that have archive access available. Requires listGroups permission.
ArchiveManager	getArchiveManager(String group) Returns the transaction archive manager for the enterprise. Do not use * for group.
SystemDataView	getConsoleGroups(boolean restrict) Returns a SystemDataView that can be used for accessing groups of the enterprise that have console access available. Requires listGroups permission.
SystemDataView	getConsoleUsers() Append System: ProfileId (40) Returns a SystemDataView that can be used for accessing users of the enterprise who have console access to this pal. Requires listUsers permission.
Data	getData() Returns zone information.
SystemDataView	getEnterprisePals() Append System: PalId (40) Returns a SystemDataView that can be used for accessing pals of the enterprise. Requires listPals permission.
RuntimePal	getPalById(String palId) Returns the Pal for the specified palId. Requires palToPal permission and both pals must be in this zone.
RuntimePal	getPalByName(String name, boolean deployed) Returns the Pal with the specified name. Requires palToPal permission and both pals must be in this zone.
SystemDataView	getPalTransactions(String palId) 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.
SystemDataView	getScanResults(RuntimePal pal) Returns a SystemDataView that can be used for accessing file scan results for the specified pal.
TransactionPacket	getTransaction(String txId) Returns the specified TransactionPacket. Requires transactionSystem permission and the TransactionPacket must be accessible from a pal in this zone.
SystemDataView	getTransactionGroups(boolean restrict) Returns a SystemDataView that can be used for accessing groups of the enterprise that have transaction access available. Requires listGroups permission.
SystemDataView	getUserViewByGroup(String group) 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).
SystemDataView	getUsers() Append System: ProfileId (40) Returns a SystemDataView that can be used for accessing users of the enterprise.
SystemDataView	getZonePals() Append System: PalId (40) Returns a SystemDataView that can be used for accessing pals of the enterprise that belong to this zone. Requires listPals permission.
TransactionPacket	importTransaction(PalInfo pal, File xml, boolean retainCreateDate, boolean includeWizards, String password) Creates new transaction for specified Pal and imports transaction data from XML packet. Execution fee applies.
boolean	isArchiveAllowed() Checks archive permission
boolean	isEnabled() Returns true if the zone is enabled.
boolean	isImportTransactionAllowed() Checks import transaction permission
boolean	isListGroupsEnabled() Returns true if listing of enterprise groups is enabled.
boolean	isListPalsEnabled() Returns true if listing of enterprise pals is enabled.
boolean	isListUsersEnabled() Returns true if listing of enterprise users is enabled.
boolean	isPalToPalEnabled() Returns true if this zone enables pal to pal access.
boolean	isSecuredTxEnabled() Returns true if this zone enables secured tx access.
boolean	isTransactionSystemEnabled() Returns true if this zone enables transaction system access.
boolean	isWebEnabled() Returns true if this zone enables web access.
TransactionPacket	replaceTransaction(TransactionPacket txPacket, File txFile) 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.
int	scheduleTransactionSystemWorkflow(String[] txIds, String systemStatus, Date scheduleDate) ⚠Deprecated since 06-19-2024. Use JobManager. No replacement Schedules transaction system workflow for the specified transactions. Returns the number successfully scheduled.
String	toString() Returns a description of this object.

Method Detail

TransactionPacket createTransaction(String palId, String description)

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.

Parameters:

String palId - Pal id. Required parameter.
String description - description for transaction. Maximum allowed size of parameter: 128

Returns: TransactionPacket

Since: 10-20-2011

top

int disableTransactionSystemWorkflow(String[] txIds, String systemStatus)

Cancels transaction system workflow for the specified transactions. Returns the number successfully cancelled.

Parameters:

String[] txIds Required parameter.
String systemStatus Maximum allowed size of parameter: 80

Returns: int

Since: 12-01-2010

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

top

int enableTransactionSystemWorkflow(String[] txIds, String systemStatus)

Enables (schedules two minutes from time of method call) transaction system workflow for the specified transactions. Returns the number successfully scheduled.

Parameters:

String[] txIds Required parameter.
String systemStatus Maximum allowed size of parameter: 80

Returns: int

Since: 12-01-2010

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

top

SystemDataView getArchiveGroups(boolean restrict)

Returns a SystemDataView that can be used for accessing groups of the enterprise that have archive access available. Requires listGroups permission.

Parameters:

boolean restrict - Restrict to this Pal.

Returns: SystemDataView

DataList Name: ZoneArchiveGroups

DataList Keys/Column Name	Column Type	Read Only
name	String
description	String
createDate	Date

Since: 08-29-2013

top

ArchiveManager getArchiveManager(String group)

Returns the transaction archive manager for the enterprise. Do not use * for group.

Parameters:

String group Required parameter.

Returns: ArchiveManager

Since: 08-23-2013

top

SystemDataView getConsoleGroups(boolean restrict)

Returns a SystemDataView that can be used for accessing groups of the enterprise that have console access available. Requires listGroups permission.

Parameters:

boolean restrict - Restrict to this Pal.

Returns: SystemDataView

DataList Name: ZoneConsoleGroups

DataList Keys/Column Name	Column Type	Read Only
name	String
description	String
createDate	Date

Since: 08-29-2013

top

SystemDataView getConsoleUsers()

Returns a SystemDataView that can be used for accessing users of the enterprise who have console access to this pal. Requires listUsers permission.

Returns: SystemDataView

DataList Name: ZoneConsoleUsers

DataList Keys/Column Name	Column Type	Read Only
profileId	String
firstName	String
lastName	String
email	String
address	String
city	String
state	String
zip	String
country	String
phone	String
cellPhone	String
cellPhoneProvider	String
fax	String
timeZone	String
title	String
salesId	String
department	String
division	String
lastAccess	Date
accountDisabled	Boolean

Since: 10-26-2010

top

Data getData()

Returns zone information.

Returns: Data

Since: 10-26-2010

top

SystemDataView getEnterprisePals()

Returns a SystemDataView that can be used for accessing pals of the enterprise. Requires listPals permission.

Returns: SystemDataView

DataList Name: ZoneEnterprisePals

DataList Keys/Column Name	Column Type	Read Only
palId	String
name	String
description	String
category	String
createDate	Date
modifiedDate	Date
testPal	Boolean
modeConsole	Boolean
modeTransaction	Boolean
modeWeb	Boolean
type	String

Since: 10-26-2010

top

RuntimePal getPalById(String palId)

Returns the Pal for the specified palId. Requires palToPal permission and both pals must be in this zone.

Parameters:

String palId

Returns: RuntimePal

Since: 10-26-2010

top

RuntimePal getPalByName(String name, boolean deployed)

Returns the Pal with the specified name. Requires palToPal permission and both pals must be in this zone.

Parameters:

String name
boolean deployed

Returns: RuntimePal

Since: 09-7-2017

top

SystemDataView getPalTransactions(String palId)

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.

Parameters:

String palId - Pal id. Required parameter.

Returns: SystemDataView

DataList Name: ZonePalTransactions

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: 10-31-2011

top

SystemDataView getScanResults(RuntimePal pal)

Returns a SystemDataView that can be used for accessing file scan results for the specified pal.

Parameters:

RuntimePal pal Required parameter.

Returns: SystemDataView

DataList Name: ZoneScanResults

DataList Keys/Column Name	Column Type	Read Only
scanId	Number
fileSize	Number
scanTime	Number
clean	Boolean
virus	String
available	Boolean
scanDate	Date
filename	String

Since: 12-11-2018

top

TransactionPacket getTransaction(String txId)

Returns the specified TransactionPacket. Requires transactionSystem permission and the TransactionPacket must be accessible from a pal in this zone.

Parameters:

String txId Required parameter.

Returns: TransactionPacket

Since: 05-17-2011

top

SystemDataView getTransactionGroups(boolean restrict)

Returns a SystemDataView that can be used for accessing groups of the enterprise that have transaction access available. Requires listGroups permission.

Parameters:

boolean restrict - Restrict to this Pal.

Returns: SystemDataView

DataList Name: ZoneTransactionGroups

DataList Keys/Column Name	Column Type	Read Only
name	String
description	String
createDate	Date

Since: 08-29-2013

top

SystemDataView getUserViewByGroup(String group)

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).

Parameters:

String group

Returns: SystemDataView

DataList Name: UsersByGroup

DataList Keys/Column Name	Column Type	Read Only
id	String
firstName	String
lastName	String
email	String
address	String
city	String
state	String
zip	String
country	String
phone	String
cellPhone	String
cellPhoneProvider	String
fax	String
timeZone	String
title	String
department	String
division	String
lastAccess	Date
accountDisabled	Boolean
salesId	String
userId	String

Since: 07-13-2011

top

SystemDataView getUsers()

Returns a SystemDataView that can be used for accessing users of the enterprise.

Returns: SystemDataView

DataList Name: ZoneEnterpriseUsers

DataList Keys/Column Name	Column Type	Read Only
profileId	String
firstName	String
lastName	String
email	String
address	String
city	String
state	String
zip	String
country	String
phone	String
cellPhone	String
cellPhoneProvider	String
fax	String
timeZone	String
title	String
salesId	String
department	String
division	String
lastAccess	Date
accountDisabled	Boolean

Since: 10-26-2010

top

SystemDataView getZonePals()

Returns a SystemDataView that can be used for accessing pals of the enterprise that belong to this zone. Requires listPals permission.

Returns: SystemDataView

DataList Name: ZoneZonePals

DataList Keys/Column Name	Column Type	Read Only
palId	String
name	String
description	String
category	String
createDate	Date
modifiedDate	Date
testPal	Boolean
modeConsole	Boolean
modeTransaction	Boolean
modeWeb	Boolean
type	String

Since: 10-26-2010

top

TransactionPacket importTransaction(PalInfo pal, File xml, boolean retainCreateDate, boolean includeWizards, String password)

Creates new transaction for specified Pal and imports transaction data from XML packet. Execution fee applies.

Parameters:

PalInfo pal - Pal to create transaction for. Required parameter.
File xml - File with transaction XML packet. Required parameter.
boolean retainCreateDate - True means the transaction will be created with the original creation date. Required parameter.
boolean includeWizards - whether to import wizards from XML packet. If true, corresponding wizards must exist or must be available via chain in target Pal.
String password - decryption password if XML packet is PGP encrypted.

Returns: TransactionPacket

Since: 09-04-2014

top

boolean isArchiveAllowed()

Checks archive permission

Returns: boolean

Since: 08-23-2013

top

boolean isEnabled()

Returns true if the zone is enabled.

Returns: boolean

Since: 10-26-2010

top

boolean isImportTransactionAllowed()

Checks import transaction permission

Returns: boolean

Since: 12-22-2011

top

boolean isListGroupsEnabled()

Returns true if listing of enterprise groups is enabled.

Returns: boolean

Since: 10-26-2010

top

boolean isListPalsEnabled()

Returns true if listing of enterprise pals is enabled.

Returns: boolean

Since: 10-26-2010

top

boolean isListUsersEnabled()

Returns true if listing of enterprise users is enabled.

Returns: boolean

Since: 10-26-2010

top

boolean isPalToPalEnabled()

Returns true if this zone enables pal to pal access.

Returns: boolean

Since: 10-26-2010

top

boolean isSecuredTxEnabled()

Returns true if this zone enables secured tx access.

Returns: boolean

Since: 05-17-2011

top

boolean isTransactionSystemEnabled()

Returns true if this zone enables transaction system access.

Returns: boolean

Since: 12-01-2010

top

boolean isWebEnabled()

Returns true if this zone enables web access.

Returns: boolean

Since: 11-28-2012

top

TransactionPacket replaceTransaction(TransactionPacket txPacket, File txFile)

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.

Parameters:

TransactionPacket txPacket Required parameter.
File txFile Required parameter.

Returns: TransactionPacket

Since: 05-31-2016

top

int scheduleTransactionSystemWorkflow(String[] txIds, String systemStatus, Date scheduleDate)

Schedules transaction system workflow for the specified transactions. Returns the number successfully scheduled.

Parameters:

String[] txIds Required parameter.
String systemStatus Maximum allowed size of parameter: 80
Date scheduleDate Required parameter.

Returns: int

Since: 12-01-2010

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

top

String toString()

Returns a description of this object.

Returns: String

Since: 10-26-2010

top

API Date: Nov 18, 2024 01:04 PM