CT Center Documentation > Reference Manual Menu

 

CT Center Dialer Interface Reference Manual

Internal System Design

 

The CT Center Dialer interface software is proprietary intellectual property of Cubs Consulting, Inc.  Source code is encrypted.  Users have a limited license to use the software which is renewable for an annual fee.  Notwithstanding the proprietary nature of the application, system administrators have a legitimate need to understand the nature of programs which are executing on their system.  With that consideration in mind, the following information is made available.

 

·       Programs

·       Database Schema

·       Control File Items

 

Programs:

PL-CCI Programs and Included Source Code Items:

Most of the interface programs reside in the PL-CCI file which was created in your “main” Cubs logon at installation time.  Other Cubs logons point to the common program file.  The program names and brief descriptions follow:

 

IAT.BATCH.DTC: Processes batch result files.

IAT.BUILD.CAMPAIGNS.AUTO: Runs from dayend processing (CFDAYEND.USER) and calls IAT.BUILD.CAMPAIGNS.SUB to build all campaigns scheduled for the next work day.

IAT.BUILD.CAMPAIGNS.MANUAL: Runs from the menu and calls IAT.BUILD.CAMPAIGNS.SUB to build user-specified campaigns on-the-fly.

IAT.BUILD.CAMPAIGNS.SUB: Sub-program called by the ...AUTO and ...MANUAL programs to build the campaigns.

IAT.CAMPAIGN.QUERY: The first screen of the Campaign Query program

IAT.CAMPAIGN.QUERY.SUB: The detail screen of the Campaign Query program

IAT.CHECK.EXCLUSION.SUB: Screens accounts to see if they need to be excluded from dialing.

IAT.COMMONS: An included source code item which defines a common data area used by all programs and subroutines.

IAT.DEBTOR.QUERY: The Debtor Query screen program.

IAT.DEFINE.AGENTS: The Agents Definition screen program.

IAT.DEFINE.CAMPAIGNS: The first screen of the Campaign Definition program

IAT.DEFINE.CAMPAIGNS.1.SUB: The detail screen of the Campaign Definition program for the “Single Recall Statement” build strategy.

IAT.DEFINE.CAMPAIGNS.2.SUB: The detail screen of the Campaign Definition program for the “Stacked Recall Statements” build strategy.

IAT.DEFINE.CAMPAIGNS.3.SUB: The detail screen of the Campaign Definition program for the “Select From Multiple Desk Ticklers” build strategy.

IAT.DEFINE.CAMPAIGNS.4.SUB: The detail screen of the Campaign Definition program for the “Combine WIP From Multiple Desks” build strategy.

IAT.DEFINE.CAMPAIGNS.5.SUB: The detail screen of the Campaign Definition program for the “Use Campaign Generated by Cubs” build strategy.

IAT.DEFINE.PP.CCI: Main screen of Process Parameters configuration program only used by CCI personnel.

IAT.DEFINE.PP.CCI.SUB: Detail screen of Process Parameters configuration program only used by CCI personnel.

IAT.DEFINE.PP.USER: Processing Parameters definition screen called from the menu.

IAT.DEFINE.RESULT.CODES: First screen of the Result Code Definition program.

IAT.DEFINE.RESULT.CODES.SUB: Detail screen of the Result Code Definition program.

IAT.EQUATES: An included source code item which gives names to numerical database addresses.

IAT.IIO.MAIN: The main Interactive IO program.

IAT.IIO.STOP: The Stop Interactive IO program.

IAT.IIO.WIP.SUB: Sub-program called by Interactive IO to get the next account in the WIP.

IAT.INITIALIZE.SUB: Sub-program, called by all main programs, which initializes the common area.

IAT.IO.LOG.QUERY: IO Log Query screen.

IAT.PROCESS.DTC.SUB: Sub-program to update the Cubs database with dialing results, called by Interactive IO and Batch Result processing programs.

IAT.PURGE: Runs from dayend processing (CFDAYEND.USER) and clears out old database items.

IAT.RENEW.LICENSE: Not on the menu.  Run from TCL to set a new expiration date for the software usage license.

IAT.RESULT.QUERY: The Result History Query program.

IAT.SCRUB.NAME.SUB: Sub-program to limit names entered on various screens to certain characters.

IAT.STATEMENT.DISPLAY.SUB: Sub-program used by campaign definition programs to display Recall statements.

IAT.STATEMENT.INPUT.SUB: Sub-program used by campaign definition programs to enter Recall statements.

IAT.TRANSLATE.CYCLE.SUB: Sub-program used by campaign definition programs to translate the cycle entered.

IAT Logon:

The IAT logon is not a Cubs logon.  It is a generic logon which is host to the CTCENTER.INTERFACE program.  This program is the link between Cubs’ Interactive IO program and the CTCenter host computer.  There are Q-pointers in the Master Dictionary of this logon which point to the IO files which live in the Cubs logon(s).

 

CTCENTER.INTERFACE: The program run by the CTCenter host’s telnet connection to the Cubs host.  This program lives in the PRIVLIB file of the IAT logon.

 

 

Database Schema:

·       Files Shared by All Cubs Logons

·       Local Files for Each Cubs Logon

 

Files Shared by All Cubs Logons:

IAT-CONTROL file:

There are multiple types of control items, which are defined in the section below.

IAT-DTC-AUDIT file:

Keep track of the date that each DTC file was processed and moved to DTCArchive folder

 

Attribute

Description

Values

Item-ID

DTC Filename

 

1

Logons

MV’ed

2

Date processed

MV’ed

3

Time processed

MV’ed

4

Archive date

 

 

IAT-IO-RESPONSE file:

Used for interactive DTC communication from the dialer.

 

Attribute

Description

Values

Item-ID

Sequence number

 

1

Message type

S = Submit

E = End of list

A = Accept

R = Reject

2

Message reference number

 

3 - 10

Campaign detail record

Only used for message type S.  See specs in IAT-CAMPAIGN file detail record section.

 

 

Local Files for Each Cubs Logon:

IAT-CAMPAIGN file:

There are 3 types of data records: Control, Sequential account, and Timed account. Contains control records for every campaign, whether batch or interactive.  Contains detail data for interactive campaigns only. 

Control Record

Attribute

Description

Values

Item-ID

CampaignName *CONTROL

 

1

Type

1 = Batch

2 = Interactive

2

Date created

 

3

Time created

 

4

Next sequence number

 

5

Maximum regular sequence number

 

6

Earliest times to call (MVed)

Earliest times first.

7

Timed sequence numbers to call (MVed and correlated)

 

8

Maximum timed sequence number

 

9

Status exclude count

 

10

Desk exclude count

 

11

Client exclude count

 

12

Don’t call exclude count

 

13

No phone exclude count

 

14

Future date exclude count

 

 

Sequential and Timed Account Record

Attribute

Description

Values

Item-ID

CampaignName * SequenceNumber

Or

CampaignName *TIMED* SeqNbr

 

1

Not used

 

2

Not used

 

3

DNUM

 

4

Primary phone type (HOME_PHN, EMP1_PHN, or whichever is the first one populated in the account’s records)

 

5

Primary phone number

 

6

Campaign name

 

7

First name of debtor

 

8

Last name of debtor

 

9

Secondary phone types (MV)

 

10

Secondary phone numbers (correlated)

 

 

IAT-CAMPAIGN-DEF file:

Contains campaign definition data.

 

Attribute

Description

Values

Item-ID

Campaign name.

May not start with CF.  Must be unique, max 10X, only allow uppercase alpha, numbers, and underscores.

1

Type

1 = Batch

2 = Interactive

2

Cycle

“X” or list of days separated by semi-colons

3

Strategy

1 = Single statement

2 = Stacked statement

3 = Multiple desks

4 = WIP group

5 = Cubs front-end

4

Recall statement 1

Up to 450 characters

5

Recall statement 2

Up to 450 characters

6

Desks (MVed)

Up to 999 possible values

 

IAT-DEBTOR file:

It is possible that this file could grow very large.  Some agencies may not have the disk space to support this file.  For this reason, this file is optional.  Programs will attempt to open it, but if it’s not present, the programs will still work, just not attempt to use it.

 

This filename should be added to CODES, PURGE-CUSTOM, attribute 2.

 

Attribute

Description

Values

Item-ID

DNUM

 

1

History date

MV’ed.  Value 1 is most recent one.

2

History time

MV’ed

3

History result code

MV’ed

4

History campaign name

MV’ed

5

History phone number

MV’ed

10

Number of attempts

 

11

Number of failed attempts

 

12

Exclusion date

 

13

Exclusion reason

1 = Current activity

2 = Status code

3 = Desk

4 = Client

5 = Don’t call

6 = No phone number

7 = Future next work date

14

Exclusion date attribute

Which Cubs attribute was used to detect current activity?

15

Built campaign name

 

16

Built date

 

17

Built time

 

18

Interactive submit campaign name

 

19

Interactive submit date

 

20

Interactive submit time

 

 

IAT-IO-REQUEST file:

Used for interactive DTC communication from the dialer.

 

Attribute

Description

Values

Item-ID

Sequence number

 

1

Message type

R = Request by ID

L = Request by list

Q = Qualify

2

Message reference number

 

3

Key

Depending on message type, DNUM or list name

 

IAT-IO-UPDATE file:

Used for interactive DTC communication from the dialer.

 

Attribute

Description

Values

Item-ID

Sequence number

 

1

Message type

U = Update

2

Message reference number

 

3

Key

DNUM

4

Phone type

 

5

Phone number

 

6

Campaign

 

7

Variant

O = Outbound

I = Inbound

T = Test

OT = Outbound Test

IT = Inbound Test

8

Call Date

CCYYMMDD

9

Call Time

HHMMSS

10

Result code

 

11

Blob name

multivalued

12

Blob value

correlated to Blob name

13

AgentID

 

 

IAT-RESULT-HISTORY file:

Attribute

Description

Values

Item-ID

Multipart  A*B*C*D*E*F

A = Campaign

B = Client

C = Date

D = Hour

E = Result code

F = Agent ID

1

Count

 

 

IAT-WORK-BUILD file:

Used by the IAT.BUILD.CAMPAIGNS.SUB program to handle multiple desks and WIP groups, to get a single list of DNUMs from multiple file sources.

 

Attribute

Description

Values

Item-ID

DNUM

 

1

Not used - empty

 

 

 

IAT-WORK-DTC file:

Used by the IAT.BATCH.DTC program to accumulate all of the result records for a single account

 

Attribute

Description

Values

Item-ID

DNUM

 

1

Phone number

MV’ed

2

Latest call time

MV’ed

3

Return record

MV’ed

 

Control File Items:

The control file is shared amongst all of the Cubs logons.

IAT-CONTROL File, AGENTS Item:

Value

Description

Values

Item ID

AGENTS

 

1

Agent ID

MV’ed

2

Cubs initials

Correlated

3

Desk

Correlated

 

IAT-CONTROL File, EXPIRATION.DATE Item:

Value

Description

Values

Item ID

EXPIRATION.DATE

 

1

Encrypted expiration date

15 digits, proprietary encryption format.

 

IAT-CONTROL File, IO-LOG Item:

This item logs the most recent messages which have passed through interactive IO.  The number of messages to retain is specified in the PROCESS-PARAMETERS item, attribute 3.

Value

Description

Values

Item ID

IO-LOG

Each attribute contains a complete log entry, multivalued.  Number of attributes is set in attr 3 of the PROCESS-PARAMETERS item.

 

1

Date

 

2

Time

 

3

Logon

 

4

Direction

C = CTD (Cubs-To-Dialer)

D = DTC (Dialer-To-Cubs)

5

Message Type

 

6

Reference Number

 

7

Message

Varies depending upon code, but can’t contain AMs or VMs

 

PROCESS-PARAMETERS Item:

Attribute

Description

Values

Item ID

PROCESS-PARAMETERS

 

1

CTCenter

2

Reporting history retention period in days

Default 90

3

I/O log, maximum lines

Default 500

4

DTCArchive retention period in days

Default 90

5

Campaign data retention period in days

Default 2

6

CTD folder

 

7

DTC folder

 

8

DTCArchive folder

 

9

CTImpact folder

 

10

Report folder

 

11

Exclude timed WIP for current activity

Y or N

12

Exclude for future next work date

Y or N

The Following CCI-Maintained Attributes are MVed, One Value for Each Logon

20

Logon

 

26

Phone number descriptions (MSV).  Must be unique, max 10X, only allow uppercase alpha, numbers, and underscores.

 

27

Phone number fiscal attribute numbers (MSV and correlated to phone number names)

 

31

Extra Field File/Attrs  (MSV)

i.e. D23 or F123

32

Extra Field Names (MSV correlated to 31)

 

33

Extra Field Oconvs (MSV correlated to 31)

 

The Following User-Maintained Attributes are also MVed, Correlated to Logon

21

Do not call fiscal attribute number

 

25

Call-back number

 

28

Status codes to exclude from calling (MSV)

 

29

Desks to exclude from calling (MSV)

 

30

Clients to exclude from calling (MSV)

 

 

RESULT-CODES Item:

Value

Description

Values

Item ID

RESULT-CODES

Each attribute contains a multivalued set of result code parameters.

 

1

Result code

25 X maximum

2

Advance next work date

Number of days

3

New priority

Numeric

4

Action on phone

! = disable

D = delete

5

New desk

 

6

Failed attempt

Y or N

7

Update CF Activity

Y or N

8

Memo note line text

 

9

Not used

 

10

New status code

 

 

 

 

 

Back        Next

 

Copyright 2009, Cubs Consulting, Inc.