CfgField

Description

Fields are single pieces of data within more complex data structures (for example, database records).

Use Fields to define characteristics of the data in Formats. (Refer to the Outbound Contact documentation set for more information.)

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 fields that belong to this tenant.
name	string	Name of a field. Shall be specified as a character string. If specified, Configuration Server will return information only about the field(s) with that name.
state	int	Current state of the field (See type CfgObjectState). If specified, Configuration Server will return information only about the fields that are currently in this state.
type	int	A data type of field in data base(See type CfgDataType). If specified, Configuration Server will return information only about fields that have this data type.
field_type	int	A field type (See type CfgFieldType). If specified, Configuration Server will return information only about fields that have this field type.
dbid	int	A unique identifier of a field. If specified, configuration server will return information only about this field.
format_dbid	int	A unique identifier of format. If specified, configuration server will return information only about fields that belong to this format.

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 that this field belongs to. Mandatory. Once specified, cannot be changed.
• name — A field name in data base. Due to restrictions of database engine the recommended length for property name is 1-12 characters. Mandatory, once specified cannot be changed.
• type — A data type of field in data base. Mandatory, once specified cannot be changed. See CfgDataType.
• description — A pointer to the description of field. Optional.
• length — A length of field in data base. Optional, once specified cannot be changed.
• fieldType — A field type. Refer to CfgFieldType of User Defined Variable types. Mandatory, once specified cannot be changed.
• defaultValue — A pointer to the default value of field. Specify what value to insert when a user does not enter a value. Optional.
• isPrimaryKey — A flag which determines whether or not a field is used as primary key. Once specified cannot be changed. See CfgFlag.
• isUnique — A flag which determines whether or not a field is used as unique. Once specified cannot be changed. See CfgFlag.
• isNullable — A flag which determines whether or not a field can allow null values (NULLs) for the data in that field. Once specified cannot be changed. See CfgFlag.
• 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

A field cannot be deleted as long as it is associated with at least one format (see CfgFormat).

Uniqueness of object is defined by combination of name and fieldType properties.

The table below lists the outbound mandatory fields and their default settings. Fields should be created as default objects in Configuration Server under the Environment folder.

fieldType	name	description	isPrimary Key	isUnique	isNullable	default Value	type
CFGFTRecordID	record_id	Unique record identifier	No	Yes	No	No	INT
CFGFTPhone	contact_info	Contact Info	No	No	No	No	VARCHAR (128)
CFGFTPhoneType	contact_info_type	Contact Info Type	No	No	No	1= GctiCtTyHomePhone from GctiContactType of Gcti.h	INT
CFGFTRecordType	record_type	Record type	No	No	No	2= GctiRecTyGeneral from GctiRecordType of Gcti.h	INT
CFGFTRecordStatus	record_status	Record status	No	No	No	1= GctiRecStReady from GctiRecordStatus of Gcti.h	INT
CFGFTDialResult	call_result	Dial result	No	No	Yes	28 = GctiCSUnknown from GctiCallState of Gcti.h	INT
CFGFTNumberOfAttempts	attempt	Number of attempts has been made, excluding re-dials in case of errors	No	No	No	0	INT
CFGFTScheduledTime	dial_sched_time	Time, when scheduled call must be done, seconds since midnight of 01/01/1970	No	No	Yes	No	INT
CFGFTCallTime	call_time	Time when last call or dial attempt has been done, seconds since midnight of 01/01/1970	No	No	Yes	No	INT
CFGFTFrom	daily_from	Earliest time to perform the call. Seconds from midnight.	No	No	No	28800 = 8AM	INT
CFGFTUntil	daily_till	Latest time to perform the call. Seconds from midnight	No	No	No	64800 = 6PM	INT
CFGFTTimeZone	tz_dbid	Time zone. DBID from Configuration Data Base.	No	No	No	122= "PST" DBID	INT
CFGFTCampaignID	campaign_id	DBID of the campaign with respect to the last dial attempt has been made.	No	No	Yes	No	INT
CFGFTAgentID	agent_id	Agent login identifier	No	No	Yes	No	VARCHAR (32)
CFGFTChainID	chain_id	Unique identifier of chain	Yes	No	No	No	INT
CFGFTNumberInChain	chain_n	Unique identifier of record within chain	Yes	No	No	No	INT
CFGFTGroupDBID	group_id	AgentGroup or PlaceGroup unique identifier (DBID)	No	No	Yes	No	INT
CFGFTAppDBID	app_id	Application unique identifier(DBID)	No	No	Yes	No	INT
CFGFTTreatments	treatments	Treatments History	No	No	Yes	No	VARCHAR(255)
CFGFTMediaRefference	media_ref	Reference to media body to be sent in case of treatment	No	No	Yes	No	INT
CFGFTEmailSubject	email_subject	Email Subject	No	No	Yes	No	VARCHAR(255)
CFGFTEmailTemplateID	email_template_id	Email Template ID	No	No	Yes	No	INT
CFGFTSwitchID	switch_id	Switch ID	No	No	Yes	No	INT

XML Representation

Tip

This XML was created using the Configuration Server 7.5 schema.

<CfgField>
	<DBID value="101" />
	<tenantDBID value="1" />
	<name value="AField" />
 	<type value="1" />
	<description value="Description" />
	<length value="0" />
	<fieldType value="1" />
	<isPrimaryKey value="1" />
	<isUnique value="2" />
	<isNullable value="1" />
	<state value="1" />
</CfgField>

See Also

CfgDeltaField

CfgFormat