CfgAppPrototype

Description

An application prototype.

Filter Keys

Filter Name	Type	Description
app_type	int	Type of the application (see type CfgAppType). If specified, Configuration Server will return information only about the application prototypes that relates to the applications of this type.
state	int	Current state of an application prototype (see CfgObjectState). If specified, Configuration Server will return information only about application prototypes that are currently in this state.
name	string	Name of an application prototype. Shall be specified as a character string. If specified, Configuration Server will return information only about the application prototype with that name.
dbid	int	A unique identifier of an application. If specified, Configuration Server will return information only about this application prototype.
version	string	A version of the application. Shall be specified as a character string. If specified, Configuration Server will return information only about application prototypes with that version.

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.
• name — A pointer to the name of the application prototype. Mandatory. Once specified, cannot be changed. Must be unique within the Configuration Database.
• type — Type of the application. Mandatory. Once specified, cannot be changed. See CfgAppType.
• version — A pointer to the application version. Once specified, cannot be changed.
• options — A pointer to the list of application-specific configuration options with default values where appropriate (see the comments below). When used as an entry in CfgDeltaApplication, it is a pointer to a list of options added to the existing list.
• 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

An application prototype cannot be deleted as long as there is at least one application associated with it.

Parameter options has the following structure: Each key-value pair of the primary list (TKVList *options) uses the key for the name of a configuration section, and the value for a secondary list, that also has the TKVList structure and specifies the configuration options defined within that section. Each key-value pair of the secondary list uses the key for the name of a configuration option, and the value for its current setting. Configuration options can be defined as variables of integer, character, or binary type. Names of sections must be unique within the primary list. Names of options must be unique within the secondary list.

Tip

Configuration Server is not concerned with logical meanings of application-specific configuration sections, options, or their values.

An application prototype of CFGConfigServer type with DBID set to 99 shall be pre-defined (scripted) in the Configuration Database before Configuration Server is started for the first time. The object that represents this application prototype cannot be deleted.

An application prototype of CFGSCE type with DBID set to 100 shall be pre-defined (scripted) in the Configuration Database before Configuration Server is started for the first time. The object that represents this application prototype cannot be deleted.

XML Representation

Tip

This XML was created using the Configuration Server 7.5 schema.

<CfgAppPrototype>
	<DBID value="99" />
	<name value="Prototype" />
	<type value="21" />
	<version value="7.5" />
	<state value="1" />
</CfgAppPrototype>

See Also

CfgDeltaAppPrototype