Configuration Platform SDK 8.5 API Reference
CfgTransaction
Description
Transactions define how CTI applications calculate customer-defined
statistics.
Top of Page
Filter Keys
Filter Name |
Type |
Description |
tenant_dbid |
int |
A unique identifier of a tenant.
If specified, Configuration Server will return information only
about the transactions that belong to this tenant.
|
object_type |
int |
Type of the object (see CfgTransactionType ).
If specified, Configuration Server will return information only
about the transactions of this type.
|
state |
int |
Current state of a transaction (see
CfgObjectState ). If specified, Configuration Server
will return information only about transactions that are currently
in this state.
|
dbid |
int |
A unique identifier of a transaction.
If specified, Configuration Server will return information only
about this transaction.
|
name |
string |
Name of a transaction. Shall be specified
as a character string. If specified, Configuration Server will return
information only about the transaction(s) with that name.
|
Top of Page
Attributes
DBID
—
An identifier of this object in the Configuration Database.
Generated by Configuration Server and is unique within an object type.
Identifiers of deleted objects are not used again. Read-only.
tenantDBID
—
A unique identifier of the
Tenant
that this transaction belongs to. Mandatory. Once specified,
cannot be changed.
name
—
A pointer to the name of the transaction.
Mandatory. Must be unique within the transaction type specified
below for the given tenant.
type
—
Type of the transaction. See type
CfgTansactionType. Mandatory. Once specified, cannot be changed.
Shall be set to CFGTransaction for PEG counts.
recordPeriod
—
Period in minutes that shows
how often the current value of the transaction is to be reported
or recorded in a data storage.
alias
—
An alternative name for this transaction.
If specified, must be unique within the object type specified above
for the given tenant .
description
—
A pointer to the text description
of the transaction.
state
—
Current object state. Mandatory. Refer to CfgObjectState
userProperties
—
A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair
of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary
list, that also has the TKVList structure and specifies the properties defined within that section.
Top of Page
XML Representation
Note: This XML was created using the Configuration Server 7.5 schema.
<CfgTransaction>
<DBID value="101" />
<tenantDBID value="101" />
<name value="Transaction" />
<type value="20" />
<recordPeriod value="0" />
<alias value="Transaction" />
<description value="Transaction" />
<state value="1" />
<userProperties>
<list_pair key="Propery">
<str_pair key="key" value="value" />
</list_pair>
</userProperties>
</CfgTransaction>
Top of Page
See Also
CfgDeltaTransaction
Top of Page
Send comments on this topic.
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.