Copyright © TIBCO Software Inc. All rights reserved.
Copyright © TIBCO Software Inc. All rights reserved.


Chapter 8 Case Data Queue Parameters : CDQP Control File

CDQP Control File
The CDQP control file is a text file consisting of one or more commands, one command per line:
A line starting with a semicolon (;) is treated as a comment line and ignored.
Each command starts with a single character code (for example: F), followed by a modifier (for example: +).
(optional) The P command enables prediction on the CDQP. See "Using Case Prediction to Forecast Outstanding Work Items" in TIBCO iProcess Modeler Advanced Design for more information about case prediction.
The control file contains the following sections, which must be specified in this order:
Resetting CDQP Configuration Data
To delete all existing CDQP definitions and queue assignments, including the default user and group queue mappings, use the command:
R
The R command must be the first character of the first non-comment line of the control file, otherwise it is ignored.
Defining CDQPs
You can define any field in a procedure as a CDQP. Once defined, a CDQP is available system-wide, and can then be mapped to iProcess queues as required.
About CDQP Definitions
You should note the following when defining CDQPs:
Fields that are defined as CDQPs are assumed to exist in all iProcess procedures, and to have consistent type and size definitions across all procedures. No validation is performed to check this. (Any fields that do not exist will be treated as null or blank fields in Work Queue Manager.)
Add or Change a CDQP
To add a field as a CDQP, or to change the definition of an existing CDQP, use the command:
F+FieldName,FieldSize,WQMDescription[,P]
where:
FieldName is the name of the iProcess field to be defined as a CDQP. FieldName must be less than or equal to 15 characters.
If the field is a composite field of the form TagName:FieldName, TagName must be less than 15 characters and FieldName must be less than 15 characters.
FieldSize is the size, in characters, of the CDQP. FieldSize must be less than or equal to 255.
WQMDescription is the name that will be used to represent this field in Work Queue Manager dialogs. WQMDescription must be unique, and must be less than or equal to 39 characters.
P is the command used to enable prediction on the CDQP.
Delete a CDQP
To delete an existing CDQP, use the command:
F-FieldName
where FieldName is the name of the iProcess field to be deleted as a CDQP.
Example CDQP Definitions
The following control file fragment illustrates how to define CDQPs.

 
; Add the fields TOWN and AGE as CDQPs.
;
F+TOWN,20,Town/City
F+AGE,3,Age

; Change the definition of an existing CDQP,
; DRIVER_NAME.
;
F+DRIVER_NAME,30, Driver Name

; Delete an existing CDQP, DISTRICT, that is
; no longer required.
;
F-DISTRICT

 
Mapping CDQPs to Queues
When you have defined fields as CDQPs, you can map them to particular iProcess queues for use in Work Queue Manager.
Add or Change a Queue Mapping
To add or change a CDQP mapping for a queue, use the following command:
Q+QueueName[,QueueName,...]
where QueueName is the name of an iProcess queue, which must be already defined in iProcess. Multiple QueueNames can be specified, separated by commas.
Q commands must appear after the CDQP definition section (F commands) in the control file. Any F commands that follow a Q command are ignored.
Add or Delete Field Mappings
After the Q command, you can add or delete field mappings for this queue, as follows:
To add any FieldName already defined as a CDQP (see Add or Change a CDQP) to the specified queue’s mapping, use the command:
C+FieldName
The maximum number of CDQPs that can be mapped to a queue depends upon the FieldSize of each CDQP, and upon the number and size of any other standard selectable fields that are mapped to the queue. The larger the FieldSize, the fewer CDQPs you can map to the queue. For example, if each CDQP has a FieldSize of 255, and the default selectable fields are used, approximately 14 CDQPs can be mapped to a single queue, although this is not an exact calculation.
If you attempt to map too many fields to a queue a validation error will occur See C+.
To delete any FieldName from the queue’s existing mapping, use the command:
C-FieldName
Delete a Queue Mapping
To delete a queue’s existing CDQP mapping, use the command:
Q-QueueName[,QueueName,...]
where QueueName is the name of an iProcess queue, which must be already defined in iProcess. Multiple QueueNames can be specified, separated by commas.
All fields currently mapped to the specified queue are removed. The queue reverts to the default user or group queue mapping, if one has been configured.
Default User and Group Queue Mappings
You can use the Q and C commands described above to define default user and group queue mappings. The default mappings will be used for all queues on the system that do not have their own mappings defined.
To define default mappings:
1.
Use the following identifiers as the QueueName in a Q command:
SW_DEFAULT_CASEDATAQPARAM_USER defines the default user queue mapping.
SW_DEFAULT_CASEDATAQPARAM_GROUP defines the default group queue mapping.
2.
Exclude a Queue from Using Default Mappings
You can exclude a particular queue from using default mappings if required. To do this:
If the queue has no mappings already, use the Q+ command to set up a queue mapping, but do not use any C commands to map fields.
Q+QueueName

 
Q+QueueName
C-FieldName
...

 
Example Queue Mappings
The following control file fragment continues the example shown in Example CDQP Definitions, and illustrates the use of the different queue mapping commands:

 
; Define DRIVER_NAME as the default mapping for user and group queues.
;
Q+SW_DEFAULT_CASEDATAQPARAM_USER
C+DRIVER_NAME

Q+SW_DEFAULT_CASEDATAQPARAM_GROUP
C+DRIVER_NAME

; Add AGE to user queues usr30 and usr31.
;
Q+usr30,usr31
C+AGE

; The following command is intended to add VEHICLE as a CDQP, but will be ignored
; because it is specified AFTER a Q command.
;
F+VEHICLE,20,Vehicle Type

; Remove TOWN from user queue usr30.
;
Q+usr30
C-TOWN

; The following command is intended to add VEHICLE to user queue usr31, but will be
; ignored because VEHICLE is not a CDQP.
;
Q+usr31
C+VEHICLE

; Delete existing mappings for user queue usr24, which will revert to the default
; user queue
; mapping.
;
Q-usr24

; Remove current mapping (TOWN) from group queue group10, and exclude it from using
; the default group queue mapping.
;
Q+group10
C-TOWN

 

Copyright © TIBCO Software Inc. All rights reserved.
Copyright © TIBCO Software Inc. All rights reserved.