Applications are the various Genesys software programs that serve a contact center. There are two types of Applications: GUI-based Applications and daemon Applications.
Filter Name | Type | Description |
---|---|---|
app_type | int |
CfgAppType ). If specified, Configuration Server will
return information only about the applications of this type.
|
tenant_dbid | int |
|
is_server | int |
CfgFlag .
|
server_dbid | int |
|
primary_server_dbid | int |
|
backup_server_dbid | int |
|
app_prototype_dbid | int |
|
account_type | int |
CfgObjectType ).
Makes sense only if used with the filter account_dbid (see below).
If both account_type and account_dbid
are specified, Configuration Server will return information only
about the applications associated with this account. Such information
will only be provided to the clients that have privileges to read
access control list of this application.
|
account_dbid | int |
CfgObjectType ). Makes sense only if used
with the filter account_type (see below). Makes sense
only if used with the filter account_dbid (see below).
If both account_type and account_dbid
are specified, Configuration Server will return information only
about the applications associated with this account. Such information
will only be provided to the clients that have privileges to read
access control list of this application.
|
host_dbid | int |
|
port | int |
host_dbid (see above).
|
state | int |
CfgObjectState ). If specified, Configuration Server
will return information only about applications that are currently
in this state.
|
name | string |
|
dbid | int |
|
same_host_and_port | int |
|
switch_dbid | int |
flexibleProperties above). The filter makes
sense for application types T-Server and High Availability Proxy
(CFGTServer; CFGHAProxy. )
|
version | string |
|
no_switch_dbid | int |
flexibleProperties above). The filter makes
sense for application types T-Server and High Availability Proxy
( CFGTServer; CFGHAProxy. )
|
no_client_dbid | int |
|
startup_type | int |
CfgStartupType ). If specified, Configuration Server will
return information only about the applications of this startup type.
|
DBID
—
name
—
type
—
type
of the application prototype specified
in appPrototypeDBID
or explicitly during the creation
time. Once specified, cannot be changed. See CfgAppType
.
password
—
version
—
version
of the application prototype specified
in appPrototypeDBID
or explicitly.
appServerDBIDs
—
CfgConnInfo
. CfgConnInfo
includes:
Applications can be added to the appServerDBIDs
structure only if:
hostDBID
and port
have been specified.
appServerDBIDs
will
include the list of ServerDBIDs
only.
tenantDBIDs
—
Tenants
that are served by this application. Makes sense
only for applications of the daemon type. For applications of
CFGTServer
and CFGHAProxy
type,
can contain only one tenant. A tenant can be added to this list
only if the account that the application is associated with has at
least read-only access
to this tenant. When used as
an entry in CfgDeltaApplication
, it is a pointer to a list of
identifiers of the tenants added to the existing list.
isServer
—
type
above). See CfgFlag
.
serverInfo
—
type
above, the application is a daemon
and must be set to NULL
otherwise. Once specified,
cannot be set to NULL
. See CfgServer
.
options
—
CfgDeltaApplication
,
it is a pointer to a list of options added to the existing list.
state
—
CfgObjectState
userProperties
—
appPrototypeDBID
—
CfgAppPrototype
. The association
with application prototype could be specified at moment of creation
of application object only.
flexibleProperties
—
section Comments
at the beginning of this
document. Only described below options can be added to this property.
This field can not be changed as long as this server remains a backup
for some other server (see CfgServer
structure) and
can only be non-empty for the applications of type CFGTServer
and
CFGHAProxy
workDirectory
—
isServer
property, the application is a server and
optional otherwise. See comments.
commandLine
—
isServer
property, the application
is a server and optional otherwise. See comments.
autoRestart
—
CFGTrue
by
default. See comments. See CfgFlag
startupTimeout
—
isServer
property, the application
is a server and optional otherwise. Default value is 90 seconds.
See comments.
shutdownTimeout
—
isServer
property, the application
is a server and optional otherwise. Default value is 90 seconds.
See comments.
redundancyType
—
CFGHTColdStandby.
See
comments. See CfgHAType
isPrimary
—
CFGTrue
. Read-only (set in accordance with
the current role within the HA/redundancy group). See comments. See CfgFlag
startupType
—
CfgStartupType
Read-only. The property
is accessible via API only and not shown by Configuration Manager.
Specified during application prototype definition automatically
according following: The value is associated with application type
CfgAppType.
The value for the applications of CFGDBServer
and
CFGApplicationCluster
type is set to CFGSUTDisabled,
for
other applications of server type is set to CFGSUTAutomatic.
For
the applications of non-server type is set to CFGSUTDisabled.
commandLineArguments
—
portInfos
—
CfgPortInfo
containing information about listening ports for this Server application.
When used as an entry in CfgDeltaApplication
, it is a pointer to a list of port infos
added to the existing list.
resources
—
CfgObjectResource
). When used as an entry
in CfgDeltaApplication
, it is a pointer to a list of resources
added to the existing list.
Only objects of type CfgScript
can be associated with Application object through resources
Deletion of Application(Server) X will cause the following events set out in the order of arrival:
backupServerDBID
field of the
application that had Application X as a backup server
appServerDBIDs
field of all applications
that had Application X in their connections
statServerDBID
or
dialerDBID
fields set to Application X
IVRServerDBID
field
set to Application X
SCSDBID
field
set to Application X
An application/server cannot be deleted as long as it associated with at least one client application i.e., the connection between client and server is specified within configuration object or it is included to at least one non-optional solution component, or it is assigned as DBServer to at least one table access.
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.
Applications of the daemon type are allowed to establish one and only one communication session to Configuration Server.
Access privileges of an application of the daemon type are
determined by the access privileges of the account it is associated
with. By default, a new application of the daemon type is associated
with access group System
(see comments to
CfgAccessGroup
in section Access Control
Functions and Data Types
). Function ConfSetAccount
can be used to change the default account.
Access privileges of an application of the GUI type are determined
by the access privileges of the currently logged-on person. See
comments to CfgPerson
.
An application is allowed to establish a communication session
with Configuration Server only if the currently logged-on person
(for GUI applications) or the account (for daemon applications)
has Execute
permission with respect to this Application
(see type CfgACE
).
An application of CFGConfigServer
type with
DBID
= 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 cannot be deleted.
An application of CFGSCE
type with
DBID
= 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 cannot be deleted.
An application can be included into different solutions. Configuration
Server does not provide the synchronization property tenantDBID
of
CfgService and property
tenantDBIDs
of CfgApplication. The tenantDBIDs
list should be updated manually or by wizard every time a solution
the application is a part of is assigned to a new tenant (the corresponding
tenant's id should be added to the list). Similar (manual or by
wizard) update should be made if a solution the application is included
into is no longer associated with a tenant (the corresponding tenant's
id should be removed from the list).
An application can not be deleted as long as there is at least one solution the application is a part of.
After upgrading from CME 5.1.x to 6.1 the following default values should be set for the application:
workDirectory = '.'
commandLine = name
(the value of name property)
autoRestart = CFGFalse
startupTimeout = 90
redundancyType=CFGHTColdStandby
isPrimary=CFGTrue
startupType=
<should be set according to description
of startupType
above>
An application cannot be deleted if it has a type CFGITCUtility
(53)
The name of the application can not be changed if there is, at least, one active client exist registered under this name
Note: This XML was created using the Configuration Server 7.5 schema.
<CfgApplication> <DBID value="100" /> <name value="myName" /> <password value="the_password" /> <type value="19" /> <version value="7.5" /> <isServer value="1" /> <state value="1" /> <appPrototypeDBID value="100" /> <autoRestart value="0" /> <startupTimeout value="0" /> <shutdownTimeout value="0" /> <redundancyType value="0" /> <isPrimary value="0" /> <startupType value="3" /> </CfgApplication>