Console API

TransactionUtil

List of Classes

ConsoleController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

CommonPacket

ConsoleManager

ConsolePacket

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

Installer

InstallerPal

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

MobileManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

TextEmail

TextMessage

TiffBuilder

TransactionPacket

TransactionUtil

Tunnel

TunnelResult

UnknownFile

Upload

User

VCardFile

Validator

ValidityCheck

Wizard

WorkflowResponse

XMLReader

ZoneAccess

Method Summary
DataList analyzePacket(Packet packet)

This method analyzes the given transaction packet for documents that have been disconnected by bug CTP-8067. Please contact ContractPal support for assistance using this method. This method will eventually be deprecated and removed once we have designed a permanent fix.

SystemDataView getTransactionViewByProfile(String group, String profileId)

Returns a SystemDataView that can be used for accessing transactions associated with the specified profile (a role has been assigned to the profile).

int moveUnassignedTransactions(String[] txIds, String toGroup)

Assigns the specified unassigned transactions to the specified group. Returns the number of records modified or -1 on failure, such as if the user does not have the necessary permissions.

DataList repairPacket(Packet packet, String docname)

This method repairs the given transaction packet and attempts to reconnect orphaned documents that have been disconnected by bug CTP-8067. Documents with the same name are labeled doc-duplicate-index. No documents are deleted. Please contact ContractPal support for assistance using this method. This method will eventually be deprecated and removed once we have designed a permanent fix.

String toString()

Returns a description of this object.

Method Detail


DataList analyzePacket(Packet packet)

This method analyzes the given transaction packet for documents that have been disconnected by bug CTP-8067. Please contact ContractPal support for assistance using this method. This method will eventually be deprecated and removed once we have designed a permanent fix.

Parameters:

  • Packet   packet Required parameter.

Returns:  DataList


DataList Name: documents
DataList Fields: name, docSize, repairNeeded

Since: 09-22-2015

top

SystemDataView getTransactionViewByProfile(String group, String profileId)

Returns a SystemDataView that can be used for accessing transactions associated with the specified profile (a role has been assigned to the profile).

Parameters:

  • String   group
  • String   profileId

Returns:  SystemDataView


DataList Name: TransactionsByProfile
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: 12-14-2009

top

int moveUnassignedTransactions(String[] txIds, String toGroup)

Assigns the specified unassigned transactions to the specified group. Returns the number of records modified or -1 on failure, such as if the user does not have the necessary permissions.

Parameters:

  • String[]   txIds
  • String   toGroup

Returns:  int

Since: 01-22-2010

top

DataList repairPacket(Packet packet, String docname)

This method repairs the given transaction packet and attempts to reconnect orphaned documents that have been disconnected by bug CTP-8067. Documents with the same name are labeled doc-duplicate-index. No documents are deleted. Please contact ContractPal support for assistance using this method. This method will eventually be deprecated and removed once we have designed a permanent fix.

Parameters:

  • Packet   packet Required parameter.
  • String   docname Required parameter.

Returns:  DataList


DataList Name: documents
DataList Fields: name, docSize, repairNeeded

Since: 09-22-2015

top

String toString()

Returns a description of this object.

Returns:  String

Since: 12-14-2009

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Dec 03, 2024 10:24 AM