CfgFormat

Description

Use Formats to specify Fields that form a data structure (for example, a database table).

Filter Keys

Filter Name	Type	Description
tenant_dbid	int	A unique identifier of the tenant. If specified, Configuration server will return information only about the formats that belong to this tenant.
state	int	Current state of the format (See CfgObjectState). If specified, Configuration Server will return information only about the formats that are currently in this state.
dbid	int	A unique identifier of a format. If specified, configuration server will return information only about this format.
name	string	Name of a format. Shall be specified as a character string. If specified, Configuration Server will return information only about the format(s) with that name.
field_dbid	int	A unique identifier of the field. If specified, Configuration Server will return information only about the format(s) which consists this field.

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 CfgTenant to which this format is allocated. Mandatory. Once specified, cannot be changed.
• name — A pointer to the name of the format. Due to restrictions of database engine the recommended length for property name is 1-12 characters. Mandatory, once specified cannot be changed.
• description — A pointer to the description of format.
• fieldDBIDs — A pointer to the list of identifiers of CfgField objects that this format consists of.
• 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.

Comments

One format can be dedicated to several objects of type CfgTableAccess.

A format cannot be deleted as long as it is associated with at least one TableAccess or Filter. The list of fields cannot be changed as long as it is associated with at least one TableAccess or Filter. See:

• CfgTableAccess
• CfgFilter

CfgField must be unique within CfgFormat.

Predefined Formats

Name	Tenant (if applicable)	Description	Fields
Default_Outbound_6	Environment	Default format for Outbound Suite (before 7.0 release)	CFGFTRecordID
			CFGFTPhone
			CFGFTRecordType
			CFGFTRecordStatus
			CFGFTDialResult
			CFGFTNumberOfAttempts
			CFGFTScheduledTime
			CFGFTCallTime
			CFGFTFrom
			CFGFTUntil
			CFGFTTimeZone
			CFGFTCompaignID
			CFGFTAgentID
			CFGFTChainID
			CFGFTNumberInChain
			CFGFTPhoneType
Default_Outbound_70	Environment	Default format for Outbound Suite (starting from 7.0 release)	CFGFTRecordID
			CFGFTPhone
			CFGFTRecordType
			CFGFTRecordStatus
			CFGFTDialResult
			CFGFTNumberOfAttempts
			CFGFTScheduledTime
			CFGFTCallTime
			CFGFTFrom
			CFGFTUntil
			CFGFTTimeZone
			CFGFTCompaignID
			CFGFTAgentID
			CFGFTChainID
			CFGFTNumberInChain
			CFGFTPhoneType
			CFGFTGroupDBID
			CFGFTAppDBID
			CFGFTTreatments
			CFGFTMediaRefference
			CFGFTEmailSubject
			CFGFTEmailTemplateID
			CFGFTSwitchID
Default_DoNotCall_List	Environment	Default format for Do Not Call List	CFGFTPhone

XML Representation

Important

This XML was created using the Configuration Server 7.5 schema.

<CfgFormat>
	<DBID value="101" />
	<tenantDBID value="1" />
	<name value="MyFormat" />
	<description value="Description" />
	<fieldDBIDs>
		<DBID value="111" />
		<DBID value="112" />
	</fieldDBIDs>
	<state value="1" />
</CfgFormat>

See Also

CfgDeltaFormat

CfgField

CfgTableAccess