introduction - colt technology · web viewcarrier-voip ip-voice-line in-for-resellers...

129
Cocom- Reseller Connect FTP User Guide GB Colt Cocom FTP User Guide GB 7.2 1/ 129

Upload: trinhdan

Post on 19-Mar-2018

216 views

Category:

Documents


4 download

TRANSCRIPT

Page 1: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Cocom- Reseller Connect

FTP User Guide

GB

Colt Cocom FTP User Guide GB 7.2 1/ 97

Page 2: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Document History

Soft copies of this document are maintained under change control, but hard copies

are not. This may not be a printout of the latest version.

Revision history

Reseller Guide

Version Issue DateDescription of change from previous version

Distributed

Generic

Body6.0 20/10/2005

Re-structure sections; New layout.

Update Colt validation and error Codes

(E 1.2)

Correction of typos

Change of CPS request (4.1 Table 1)

Added E.3 Troubleshooting Cocom

6.2 26/02/2006

Added cps Reseller ID field in flat file

schema to accommodate the UK

regulatory RID requirements (Changes

are made in the following chapters:

A.1.3, A.4.2, A.4.3., E.2.1)

6.3 21/04/2006Added Colt responses for RID Code in

chapter E 1.2

6.4 03/05/2006

Update the error codes from BT in

chapter

E 1.2 (error codes 79-85), change of

error code 21

6.5 11/07/2007 Correct CDR-Format

6.6 17/09/2007Added CDR-Format for Colt Switchless

Reseller Line

6.7 15/04/2009 Maintenance & Support updated.

6.8 20/01/2012Updated to reflect enhanced Cocom and

the consolidated CDR feature

6.9 05/10/2012

Update the error codes from BT in

chapter

E 1.2 (error codes 106-110)

7.0 23/07/2015 Updated to reflect the UK

Regulatory impacts on the unrated CDRs

Colt Cocom FTP User Guide GB 7.2 2/ 97

Page 3: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

for calls to non-geographic numbers.

7.1 04/02/2016 Updated to reflect Colt rebranding

7.2 04/03/2016

Replaced VoIP Access with SIP

Trunking and change in the notification

period for planned maintenance work in

section 5

Colt Cocom FTP User Guide GB 7.2 3/ 97

Page 4: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

ContentsDOCUMENT HISTORY............................................................................................2INTRODUCTION......................................................................................................51. SERVICE OUTLINE......................................................................................61.1 OUTLINE PROCESS.........................................................................................61.2 TECHNICAL INFRASTRUCTURE.........................................................................7

1.2.1 Overview...................................................................................................71.2.2 Directory Structure....................................................................................71.2.3 File Naming Standard.............................................................................10

2. SERVICE REQUESTS................................................................................112.1 OVERVIEW....................................................................................................112.2 REQUEST FILE PROCESSING.........................................................................142.3 VALIDATION RULES AND CHECKS..................................................................15

3. SERVICE RESPONSES..............................................................................173.1 COLT RESPONSES........................................................................................173.2 PTT RESPONSES..........................................................................................17

4. CDR FILES..................................................................................................184.1CONSOLIDATED CDR REQUEST...........................................................................194.2CONSOLIDATED CDR DOWNLOAD........................................................................214.3CONSOLIDATED CDR FILE FORMAT.....................................................................21

5. MAINTENANCE AND SUPPORT...............................................................226. TIPS, TRICKS & RULES.............................................................................237. GLOSSARY.................................................................................................24APPENDIX A REQUEST FILE FORMATS.......................................................25APPENDIX B RESPONSE FILES.....................................................................46APPENDIX C FILE LEVEL ERRORS...............................................................76APPENDIX D CDR FILE....................................................................................80APPENDIX E REFERENCE DATA........................................................................85

Colt Cocom FTP User Guide GB 7.1 Page of

Page 5: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Introduction

Colt Technology Services (Colt) has provided you with an electronic interface for the

activation and deactivation of Colt Wholesale Products on your end-customer CLIs

(Calling Line Identifier) and for the daily transfer of call detail records (CDR). This

system is referred to as Cocom.

This interface allows you to submit individual and bulk requests to Colt, and in return

allows you to retrieve the results of your requests and to retrieve the CDRs resulting

from your end-customers’ traffic within the Colt network.

Cocom can also be used for Carrier Pre-Selection (CPS) requests on end-customer

CLIs. The system will confirm that the CLI is known to Colt and activate the CLI

before forwarding the request to the relevant PTT, and passes back the responses

received from the PTT.

This document describes the necessary technical details and the processes that

allow you to

Set up your internal systems and processes

Successfully submit and retrieve requests

Successfully retrieve CDR files from Colt

The information specific to each country is defined in Appendices to this document.

Examples of this information are:

CLI and CPS requests

Action codes

PTT messages

Colt Cocom FTP User Guide GB 7.1 Page 5 of 97

Page 6: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

1. Service Outline

1.1 Outline Process

The communications server itself is generally available except when Colt needs to

carry out essential housekeeping and maintenance work. So, you have considerable

flexibility in deciding how often you choose to upload and retrieve files.

There are three main activities that you will need to carry out on a regular basis.

During a typical session you will:

Upload a request file, followed by a matching job file

Retrieve response and any error files from previous upload sessions

And twice a day retrieve CDR files for processing within your own systems

Each of these activities is described in greater detail in later sections.

Resellers

VPN

Cocom

Colt network

Colt Billing Systems

Figure 1 Colt Reseller support infrastructure

Colt Cocom FTP User Guide GB 7.1 Page 6 of 97

Page 7: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

1.2 Technical Infrastructure

1.2.1 Overview

The Cocom server currently supports FTP access to dedicated and protected

directories that have been created specifically for your business. Additionally access

via XML and a graphical user interface is available.

Access to the server is via a dedicated VPN client provided by Colt. These methods

are detailed in separate documents accompanying this guide. Colt will assign a

temporary IP address on successful access that will remain valid and available only

for the duration of your connection to the service.

When you connect with Colt, you will be prompted to enter two User IDs and

passwords; the first to gain access to Colt’s customer network, and the second to

gain access to your home directory on the Cocom server.

After you have successfully gained access to the server you will be connected to

your home directory. Your home directory has been created specifically for you and

can only be accessed using the User ID provided to you by Colt.

To use the service you will need to integrate these processes and file interface into

your own IT environment. For a stand-alone operation you can use a standard FTP

client. Any of the commonly available FTP clients should be satisfactory, for example

ReflectionFTP.

1.2.2 Directory Structure

Files within this directory are protected from access by others in a secure

environment. The key directories in your home directory on the Cocom Server are

shown in the diagram below.

From here you can download your unrated CDRs for existing Colt products which

you resell and across one or more Colt countries. You can also do Reseller Connect

transactions – i.e. place CLI activation / deactivation and CPS requests.

Colt Cocom FTP User Guide GB 7.1 Page 7 of 97

Page 8: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Reseller Domain ID

Country Code

Product

Profile

/bin/cdr

/jobout/lib

/bin/cdr

/cli_list/err_in

/err_out/jobin

/jobout/lib

/request/response

Product

Profile

colt123

gb

reseller-connect

800 /bin/cdr/cli_list/err_in/err_out/jobin/jobout/lib/request/response

Diagram notes Note lower case values above

Reseller Domain ID is an auto-generated ID, a combination of your company

name & random digits, minimum length of 5 and max length of 8

Country code in ISO 2 character format, note gb is used

The product will be one of the following - all lower case:-

reseller-connect

sip-trunking

voice-line

carrier-voip

ip-voice-line

in-for-resellers

reseller-voip-connect

The profile is up to 5 alphanumeric and is either the account profile or the service

profile

Account profiles are set up based on your billing account (BCN), whereas service

profiles are set up per service instance. Account profiles will apply to products such

as SIP Trunking and Voice Line, and service profiles will apply to Reseller Connect.

Colt Cocom FTP User Guide GB 7.1 Page 8 of 97

Page 9: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

If you have more than one product on the same billing account (BCN), e.g. SIP

Trunking & Voice Line, then they will have the same account profile. The unrated

CDR files will be generated in separate files by product and made available under

each product as per the FTP folder structure above.

The files provided by Colt such as CDR files, and response files are available in

separate sub-directories in a standard format (detailed in the Appendices to this

Guide):

/request the directory where you must upload your request files

/response the directory where Colt will deposit response files

/jobin the directory where you must upload job request files, one for each request

file

/jobout the directory where Colt will deposit job files, one for each response file

/err_in this is the directory that will contain any error files

/cdr this directory will contain your CDR files, delivered twice daily as well as

any consolidated CDR files you have requested using the consolidated

CDR request feature in Cocom Web Manager

/cli_list at the end of each day, Colt will provide a report of your CLI activity for the

day and leave these in this directory for your collection

Colt Cocom FTP User Guide GB 7.1 Page 9 of 97

Page 10: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

1.2.3 File Naming Standard

Files transferred to and from Colt are all uniquely identified and adhere to the

following naming convention.

The file names will consist of three parts:

1. The first digits are assigned by Colt Technology Services (Colt) and will be your

unique identifier, which is a 3 digit number e.g. 999.

2. The next eight (8) digits are the file sequence number with leading zeros, for

example 00000001. These must follow strictly in sequence for each request file

submitted to Colt and each response file will always match its corresponding

request file.

3. A suffix separated by a dot that describes the type of the file

req request file

rsp response file

error error file

cdr CDR file

The corresponding job files have the additional suffix “job”.

For example a request from a new reseller with service profile 999 would be a pair of

files:

99900000001.req

99900000001.req.job

The Colt response would be another pair of files:

99900000001.rsp

99900000001.rsp.job

Colt Cocom FTP User Guide GB 7.1 Page 10 of 97

Page 11: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

2. Service Requests

2.1 Overview

Colt allows service activation, and deactivation requests for Resellers’ end-

customers CLIs on the Colt network and optionally, for Carrier Pre-Selection (CPS)

service through the local PTT. Colt also allows you to request the transfer of an

existing CLI to you from another Reseller, through a Modify request, but this feature

is restricted and available only on special request.

At any time you may be required to provide written proof that the end-customer has

signed up for service with you. This may be to verify that the end-customer has

consented to transfer their service to you, or may be as a result of a demand from

the local PTT to verify that a CPS request is valid. If this is required you will be

contacted by Colt directly.

You can request service to be activated or deactivated for a given CLI,

on the Colt network only (CLI only),

on the Colt network with CPS enabled (CPS or CLI/CPS)

Activate Deactivate

CLI CLI must not be active Only if the CLI is already active

CPS CLI may be inactive or active

If the CLI is active – no warning

message will be given but CPS

request is processed

If the CLI is inactive – CLI is

activated on the Switch then the CPS

is processed

If activation process for CLI is in

progress – warning message will be

sent

Only if CPS is already active on the CLI.

And only if permitted by PTT (e.g. some

PTTs will only accept CPS deactivation

requests directly from the end-customer)

CLI and CPS combined (obsolete)

CLI may be inactive or active

If the CLI is active – warning

message given but CPS request is

processed

If the CLI is inactive – CLI is

Not Permitted.

You need to deactivate CPS first, and

then submit another request to deactivate

the CLI after the CPS has been

deactivated.

Colt Cocom FTP User Guide GB 7.1 Page 11 of 97

Page 12: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

activated on the Switch then the CPS

is processed

Table 1 - CLI and CPS Request RulesYou can include up to 500 individual requests in a single file, and the file must be

uniquely identified (see Appendix B for the File Naming Specification). Each request

file must also be accompanied by a Job File, and it is the Job File that triggers

processing of the Request file by Colt.

The normal sequence of events is as follows:

You will upload a request file

Followed by uploading the corresponding job file

Colt detects the job file and automatically looks for the corresponding request

file. If no request file is found then the system generates an error.

It is very important that the request file is uploaded BEFORE its corresponding Job

file. If you upload a Job file first then the system will start to search for the request

file, and will continue to look for up to 90 seconds. If it cannot find the file, or more

likely it cannot read the file because it cannot get exclusive access to it, the server

will create an error response. The request file will then be ignored by the system.

Colt will check the request file, and carry some basic validation (detailed in

Section 2.3 below)

Carry out the request within the Colt network, and return the result

If the file contains a CPS request, then Colt will activate the CLI and forward the

request to the local PTT. In the case the CLI is already active and no error

occurs no message will be send.

If the file contains combined CLI/CPS requests then Colt will generate an

acknowledgement for the CLI element and forward the request to the local PTT

for the CPS element, if the CLI request is successful.

Colt Cocom FTP User Guide GB 7.1 Page 12 of 97

Page 13: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

The local PTT (incumbent Network Operator) normally has a fixed period of time to

process a CPS request, typically between 5 and 10 working days. Their response to

the request will be sent at any time in the period from your submission, up to the

time limit. When Colt receives these responses they are returned directly to you via

the response directory within your home directory on the Colt server.

Colt Cocom FTP User Guide GB 7.1 Page 13 of 97

Page 14: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

2.2 Request File Processing

Colt carries out some basic validation of requests and request files before accepting

them for processing. The rules are simple and are as follows:

Each file pair, Job and Request file, must conform to the naming standard,

detailed in Appendix A.

Each request file must be numbered sequentially, starting at 1. The file will be

rejected if it has a sequence number that is lower or the same or more than 1

higher than the last file submitted.

Each file must contain no more than 500 records excluding the file Header

and Trailer records.

If several requests should be send it is strongly recommended to put not

more than one file every 1-2 minutes in the jobin resp. /request Directory, to

avoid rejections from the system.

The CLI within each request record must comply with your National standard,

detailed in Appendix A. The CLI and CPS requests must comply as per Appendix A

(Request File Formats)

If the validation is passed successfully then each CLI request will be sent to the Colt

network, and where appropriate to the local PTT.

The technical detail for Request File layouts and examples are given in Appendix A.

For each CLI and CPS request, Colt expects an ‘action code’ to be provided. This

indicates whether you want the CLI to be activated, deactivated, etc. The valid codes

are defined in Appendix A together with the Request File Format definition.

Colt Cocom FTP User Guide GB 7.1 Page 14 of 97

Page 15: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

2.3 Validation Rules and Checks

As indicated above, Colt will carry out basic validation at two levels on each request

file received.

First LevelFirst, there are a series of checks to confirm that the request file is in the correct

format and is complete. To pass this level of validation the file must:

Conform to the Colt file naming standard (1.2.3 File Naming Standard)

The file sequence number must follow in sequence and be only 1 higher than the

last file successfully submitted

There must be a matching pair of request and job files

Have one and only one Header record, one or more Detail records and one and

only one Trailer record

The Header, Detail and Trailer records must be in the specified format (See also

Appendix A)

There must be no more than 500 Detail records in the file.

There should be only one CLI or CPS request for each Detail record.

If the file is incorrect or fails at this stage, a single error file (with a suffix of ‘.error’) is

generated and left in your \err_in directory (see also Appendix C File Level Errors).

This file will contain a Header record, a single detail record containing an error

message as per Error: Reference source not found above, and a Trailer record. The

technical detail for file level error notifications is in Appendix C File Level Errors.

The original request and job file are renamed with an extra “.failed” at the end and

left in their original directory. The Resellers should correct as appropriate and either

rename the original files removing the “.failed” extension (the request 1st then the

job); or create new files

Colt Cocom FTP User Guide GB 7.1 Page 15 of 97

Page 16: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Note that if a file fails file-level validation, the SAME file sequence number should be used, because the system does not move the file sequence

counter in the case of file error.

Second LevelAfter file-level validation the file will be processed and it will be validated to ensure

that the requests are valid. This may result in further error or warning messages,

which are notified in the Response file. There will be one Response file containing

one line for each request record within the corresponding Request File. Appendix

B.1 CLI Responses gives the technical detail of the CLI Response file. Appendix B.5

CPS Response File contains the technical detail on the CPS Response file.

Some examples what will be checked are

1) The request action codes must be valid (A.3 Reference Data)

2) The date needs to be in the right format (See also Appendix A)

3) Country specific information in a CPS-Request is existing and in the right

format (See also Appendix A)

The possible error messages in the Response file can be found in Error: Reference

source not found Error: Reference source not found.

Note that each Job File Detail record must end with the value

CLI – to indicate that this is a CLI only request

CPS – to indicate that this is a CPS request

CLI/CPS – indicating that this is a combined request

If any detail record ends with any other value, Colt will attempt to process the record

as if it was a CLI only request. If it is not a CLI only request then it will fail and the

appropriate error will be generated.

Finally, for CPS and combined CLI/CPS requests, if the previous stages were

successful the request will be forwarded to the local PTT. They will respond with the

result of the request, typically within 5 to 10 working days.

Colt Cocom FTP User Guide GB 7.1 Page 16 of 97

Page 17: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

3. Service Responses

3.1 Colt Responses

For each request made, a response will be created by Colt. For CPS requests this

will be the response that Colt receives from the local PTT. There will be one

Response file for each CLI Request file submitted and a separate response file for

each CPS request.

For example,

If a CLI request file contained

150 CLI activation requests,

25 CLI deactivation requests

Then there will be one response file containing 175 lines (CLI requests)

If a CPS request file contains 225 CPS activation requests there will be 225 separate

response files; one for each CPS activation.

The technical detail for the CLI Response File layouts and examples are given in B.1

CLI Responses.

The technical detail for the CPS Response File layouts and examples are given in

B.5 CPS Response File

3.2 PTT Responses

For each response from the local PTT, there will be a status code and a response

code. This information will be included in the Colt Response File for CPS requests.

The potential status and response codes that may be returned as a result of a CPS

request are given in Error: Reference source not found Error: Reference source not

found.

Colt Cocom FTP User Guide GB 7.1 Page 17 of 97

Page 18: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

4. CDR Files

Twice a day, every day of the week, Colt will deposit a file of Call Detail Records

(CDR) into your /cdr directory on the server. This will contain all of the CDRs

collected by the Colt network since the last file, typically each 12 hours. The CDR

files are provided in a pre-defined, fixed length format. CDR file format description

has been detailed in Appendix D.

CDR file naming standard

Files transferred to and from Colt are all uniquely identified and adhere to the

following file format

<countrycode>_<profile>_<productidentifier>_<sequence no>_<date>.cdr.gz

Where:

<countrycode> in ISO 2 character format, note GB to be used

<profile> is up to 5 alphanumerics and is the applicable profile for the product

<productidentifier> is the product identifier (1-2 alphanumerics) – see table

below

<sequence no> is a rolling four digit sequence per <profile>_<product>

combination

<date> is YYYYMMDDHHmmss

cdr.gz is where the file is zipped

Product Identifier Product name01 Reseller Connect

00 Voice Line

10 SIP Trunking

11 IP Voice Line

12 IN for Resellers

13 Carrier VoIP

Colt Cocom FTP User Guide GB 7.1 Page 18 of 97

Please Note: The first CDR file will appear in Cocom FTP after the first call has

been made.

Page 19: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

4.1Consolidated CDR RequestThis feature enables you to place a request for a consolidated CDR file through

Cocom Web Manager, accessed via ColtOnline. Up to 90 days of CDRs can be

requested, e.g. a consolidated file of a week's worth of CDRs and these files will be

delivered to both Cocom Web Manager & Cocom FTP.

In Cocom Web Manager, click on “CDR” and on the left side of the screen select

“Consolidated CDR Request”. Search for the specific Profile.

Figure 1: Consolidated CDR request - Select profile

Colt Cocom FTP User Guide GB 7.1 Page 19 of 97

1 2

Please Note: When you wish to consolidate unrated CDRs, these CDRs will be

delivered to Cocom Web Manager & FTP in a compressed/zipped format. If your

twice daily CDR files are already over 5MB in size, then please allow time to

download a consolidated file from Cocom Web Manager or you may find it easier to

download files greater than 5MB directly from Cocom FTP.

1

2

Page 20: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Figure 2: Consolidated CDR Request

Select Start (From) and End (To) date by clicking on the calendar Symbol

and choose the preferred date. Click on the Button “Consolidated CDR”

Your Consolidated CDR request will be processed. A transaction ID will be

displayed to the user, along with a message “Consolidated CDR file “

<profile><transactionID>.cdr.zip” will be ready for download within the next 2 hours.”

Figure 3: Consolidated CDR Request: Transaction Result

Colt Cocom FTP User Guide GB 7.1 Page 20 of 97

3 4 5

6

3 4

5

6

Page 21: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

4.2Consolidated CDR DownloadWithin 2 hours the consolidated CDR file will be available in the Cocom FTP /cdr file

under the product & profile which you used in your request.

4.3Consolidated CDR File FormatAll Consolidated CDR files delivered to Cocom Web Manager and FTP have a

filename in the following format:-

<profile><transactionID>.cdr.zip.

Where:

<profile> is up to 5 alphanumeric and is the applicable profile for the product

<transactionID> is the combination of date and unique number, this can be used in Cocom Web Manager to search for Consolidated CDR

.cdr is the extension .zip is where the file is zipped

Example: AM220120110182.cdr.zip

The content of the consolidated CDR file is the same as the standard twice daily

delivered CDRs, as described in Appendix D.

Colt Cocom FTP User Guide GB 7.1 Page 21 of 97

Page 22: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

5. Maintenance and Support

Customer Service is available during normal office hours, from Monday to Friday

except during Public Holidays.

Should we need to temporarily suspend access to the server, for planned

maintenance, you will be notified at least 10 days in advance and be told how long it

will be suspended for. Generally, this is an unusual occurrence (approximately once

a month) and service interruptions are brief.

While Colt may, from time to time, remove files that are more than 90 days old from

the server, it is your responsibility to ensure that files are collected and deleted from

our servers on a regular basis.

Colt Cocom FTP User Guide GB 7.1 Page 22 of 97

Page 23: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

6. Tips, Tricks & Rules

How to avoid congestionIf several requests are to be sent, it is strongly recommended to put not more than

one file every 1-2 minutes in the jobin resp. /request Directory, to avoid rejections

from the system.

There could be up to 500 records in one file. Fewer files with more records will be

processed faster than a lot of files with a low number of records.

If there is a need to send more than 5000 CLI/CPS (single records) in a short time

frame (1-2 hours) please contact Customer Services before sending the requests to

do this on an agreed timeframe. Otherwise Colt reserves the right to delete mass

requests which haven’t been confirmed by Colt. Colt may suggest a dedicated

timeframe to accept these mass requests as part of a migration or database cleanse.

Unexpected messagesIf error messages are to be interpreted automatically, check the Response Code and

Colt Response Text. The Description Text may change and new error messages

may be added. Please ask Customer Services if you recognize new or different

messages if a new Guide is available.

Modify commandThe modify command is used to change the ownership of a CLI to the requesting

reseller. Rights to use the modify command is restricted and has to be requested

separately. The modify command will automatically include a CLI activation.

MiscellaneousIf you are using Cocom for different countries, please be aware that the syntax for

the different countries varies from country to country. Please ask your Customer

Service representative for the country-specific user guide or you can find the latest

guides on Cocom Web Manager under the Help menu.

Please check also chapter Error: Reference source not found File Validation Codes

of Cocom Reference Data.

Colt Cocom FTP User Guide GB 7.1 Page 23 of 97

Page 24: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

7. Glossary

Term DescriptionCLI Calling Line Identifier. A term used within Colt to mean an end-customer

telephone number such as a Directory number.

Cocom Colt Communications server. The FTP server and internal applications that

provide a file level interface allowing resellers to request bulk activation and

deactivation of CLIs and CPS services.

CPS Carrier Pre-Selection.

CDR Call Detail Record. A record that contains the details of a call made on the Colt

network. Normally used for end-customer billing purposes. Typically this will be

unrated, i.e. contains no charges but indicates the service used during the call

and the tariff band(s) that apply. If the CDR is rated, then it will include the

charge due for the call.

PTT Public Telegraph Telephony [operator]. Any fixed-line network operator but

typically the major incumbent operator within the country. Colt deals with the

following operators: France Telecom (France), Deutsch Telekom (Germany),

British Telecom (UK), Telia (Sweden), KPN (Netherlands), Belgacom

(Belgium), Austria Telekom, Telecom Italia (Italy), Eircom (Ireland), Portugal

PTT, Telefonica (Spain), Teledenmark (Denmark). Swisscom (Switzerland).

Table 2 – Glossary

Colt Cocom FTP User Guide GB 7.1 Page 24 of 97

Page 25: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Reseller Request

Header Record{1 per file}

Detail Records{1 to 500}

Trailer Record{1 per file}

Appendix A Request File Formats

This section describes the format of the Reseller Request file and its associated Job

file. There is exactly one Job file for one Request file.

The Reseller Request file passes the list of requests to Cocom for processing. The

list may contain either CLI or CPS or CLI+CPS requests. The requested processing

may be, where authorised, for activation, change, deactivation and modification of

CLI or CPS. See the tables in section A.3.1 Action Types for valid request types.

A.1 Request File

A.1.1 File/Message Structure

Figure 2 Reseller Request Structure

Each Reseller Request consists of a:

Header Record, describing the type of request (CLI, CPS, combined

CLI/CPS)

Detail Record, describing the end-customer details

Trailer Record, including a checksum

Colt Cocom FTP User Guide GB 7.1 Page 25 of 97

Please Note: A List of all CLIs will appear in the “all_cli” Folder in FTP after the first

request was successfully processed.

.

Page 26: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Header RecordThere is just one Header record per file, which must be the first record in the file.

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

1 Header Id Alphanume

ric

1 Mandato

ry

H Must equal

character “H”

(without quotes)

2 Format

Description

Alphanume

ric

35 Optional none Free format text for

information only.

For example “CLI

Requests”

3 Version Alphanume

ric

6 Mandato

ry

0.02.1 File Format

Version. This is a

required value and

should be the

default value unless

otherwise

instructed by Colt

4 Country ID Alpha 2 Mandato

ry

GB Country ID in ISO-

3166 Code

5 Service

Profile ID

Alphanume

ric

3 Mandato

ry

none This is your unique

ID allocated by

Colt.

6 Customer

Group

Alphanume

ric

30 Mandato

ry

None Leave blank

7 Tariff Plan Alphanume

ric

2 Mandato

ry

None Leave blank

Colt Cocom FTP User Guide GB 7.1 Page 26 of 97

Please Note: When you want to place a request in the “request”-folder in FTP make

sure you either start with the sequence number 000001 or continue with the

sequence number if you already placed requests before. It is also very important that

the Service Profile in the filename is written in lower case due to the UNIX Server

can’t process files with capital letters in the file name.

.

Page 27: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

8 CLISERV

Screening

Index

Alphanume

ric

3 Mandato

ry

None Leave blank

9 The number

of current

block

Integer 2 Optional 01 01-99; Currently

only 01 is

supported

10 Total

number of

blocks

Integer 2 Optional 01 01-99; Currently

only 01 is

supported

11 Creation

Date

Timestamp 17 Mandato

ryCurrent Date YYYYMMDD-

hh:mm:ss

Example:

20040430-13:42:27

Table 3 - Request Header Record

Colt Cocom FTP User Guide GB 7.1 Page 27 of 97

Please Note: Each field must be delimited by a semi-colon (;) and the line should end

with a semi-colon.

Page 28: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

A.1.2 Detail Records

There can be up to 500 detail records per Request file.

Ref Identifier/ Field Name

Data Type

MaxLength

M/O Default Field Description / Notes

1 Data Record

Identifier

Alphanum

eric

1 Mandatory D D for Detail

2 Request

Number

Integer 22 Mandatory None Record number

Starting at 1, increase by 1

with a maximum of 500. No

gaps or duplicates allowed.

The sequence is Reseller-

maintained.

3 CLI Integer 11 Mandatory None Telephone number

Numeric 10 or 11 digits

including the leading zero.

The following prefixes are not

allowed:

00, 07, 08, 09

Colt Cocom FTP User Guide GB 7.1 Page 28 of 97

Page 29: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Ref Identifier/ Field Name

Data Type

MaxLength

M/O Default Field Description / Notes

4 Action Alpha 1 Mandatory None Request Type CLI:A = Add to Switch

D = Delete from Switch

M = Modify CLI ownership to

this Reseller.

Request Type CLI/CPS:

A = Add to Switch AND

Activate Pre-selection

I = Renumber order

Request Type CPS:

(There must be an Active CLI

for B, E and G)

B = Remove Order

C = CPS set-up on an existing

switched CLI

E = Cancel own order

G = Change order (Customer

Request Date)

5 Toneburst Boolean 1 Optional none Deactivated for UK requests

6 Job date Timestam

p

17 Mandatory none Current Date in format

YYYYMMDD-hh:mm:ss

Example:

20040430-13:42:27

Colt Cocom FTP User Guide GB 7.1 Page 29 of 97

Page 30: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Ref Identifier/ Field Name

Data Type

MaxLength

M/O Default Field Description / Notes

7 Customer

Request

Date

Integer 8 Mandatory For CLI Only request this

should be current date. CLI will

be activated on the same day

when the request is submitted

to Cocom.

For activity Activate and

Deactivate CLI, customer

request date should be current

date but for activity Modify CLI

customer request date must be

greater than 10 working days

from date of order however the

CLI will be activated on the

day when the request was

submitted

For CPS only request this is

the date the Customer wants

order implemented. Must be

greater than 10 days from date

of order.

For a CLI/CPS combined

request this is the date the

Customer wants order

implemented at PTT. Must be

greater than 10 days from date

of order however the CLI will

be activated on the day when

the request was submitted

Colt Cocom FTP User Guide GB 7.1 Page 30 of 97

Page 31: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Ref Identifier/ Field Name

Data Type

MaxLength

M/O Default Field Description / Notes

8 CPS Level Alphanum

eric

9 Mandatory none *Not relevant for CLI only

requests

The type of CPS service

required.

CLI Request: Must be blank

CPS Request: Mandatory

CLI/CPS Request: Mandatory

Permitted values are:

opt1, opt2, opt1n2, opt3.

Refer to table 5 CPS Option

Descriptions below for

mappings to BT CPS options

9 Range start Alphanum

eric

Optional None *Not relevant for UK requests.

Must be blank

10 Range End Alphanum

eric

Optional None *Not relevant for UK requests.

Must be blank

Colt Cocom FTP User Guide GB 7.1 Page 31 of 97

Page 32: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Ref Identifier/ Field Name

Data Type

MaxLength

M/O Default Field Description / Notes

11 Post Code 1 Alphanum

eric

Variable Blank *Not relevant for CLI only

requests

First part of UK postcode.

Example: for postcode SS6

8UP, Postcode 1 = SS6

Mandatory for new combined

CLI/CPS orders and

Renumbers only.

For Transfer CLI Option

(Modify Action Code: M),

where in a reseller acquires

the ownership of an active CLI

associated with BT, This field

is Mandatory.

12 Post Code 2 Alphanum

eric

Optional Blank *Not relevant for CLI only

requests

Second part of UK postcode.

Example: for postcode SS6

8UP, Postcode 2 = 8UP

Not mandatory but put in if

known.

For Transfer CLI Option

(Modify Action Code: M),

where in a reseller acquires

the ownership of an active CLI

associated with BT, This field

is Mandatory.

Colt Cocom FTP User Guide GB 7.1 Page 32 of 97

Page 33: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Ref Identifier/ Field Name

Data Type

MaxLength

M/O Default Field Description / Notes

13 Cease NT

Number

Alphanum

eric

Optional Blank *Not relevant for CLI only

requests

Only present for Renumbering.

The value is passed back from

the PTT and should be input to

allow the PTT to renumber

without a service break for the

end-customer.

Colt Cocom FTP User Guide GB 7.1 Page 33 of 97

Page 34: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Ref Identifier/ Field Name

Data Type

MaxLength

M/O Default Field Description / Notes

14 WLR Flag Alphanum

eric

1 Variable Blank *Not relevant for CLI only

requests

Indicates whether the CLI

belongs to BT or another

operator, e.g. the Reseller.

For requests where the

Action = C or A, this field is

Mandatory. The allowed

values are:

If the line is owned by Colt

or a Reseller:

WLR_FLAG = 'Y'

(case insensitive)

If the line is owned by BT:

WLR_FLAG =  'N'

(case insensitive)

For all other Action types,

this field should be left

blank.

For Transfer CLI Option

(Modify Action Code: M),

where in a reseller acquires

the ownership of an active CLI

associated with BT, This field

is Mandatory.

Colt Cocom FTP User Guide GB 7.1 Page 34 of 97

Page 35: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Ref Identifier/ Field Name

Data Type

MaxLength

M/O Default Field Description / Notes

15 CPS

Reseller ID

Alphanum

eric

Variable Blank CLI only requests: Optional

For Transfer CLI Option

(Modify Action Code: M),

where in a reseller acquires

the ownership of an active CLI,

This field is Mandatory.

CPS Request: Mandatory

CLI/CPS Request: Mandatory

Table 4 Request Detail Record FormatNote: Each field must be delimited by a semi-colon (;) and the line should end with a

semi-colon.

Service Component BT Option UK CPS Level Field Values

International A (Option 1) opt1

National B (Option 2) opt2

International & National C (Option 1 and 2) opt1n2

All calls (default) D (Option 3) opt3

Table 5 CPS – Option Description

Colt Cocom FTP User Guide GB 7.1 Page 35 of 97

Please Note: Each field must be delimited by a semi-colon (;) and the line should end with a

semi-colon.

Page 36: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

A.1.3 Trailer Record

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

1 Trailer Id Alphanume

ric

1 Mand

atory

T T for Trailer

Must be first field on last line

in file

2 Number of

Records in

this block

Integer 3 Mand

atory

Maintained by Reseller

3 Checksum Integer 10 Option

al

Blank Value generated running

Unix checksum on this

block’s data records. By

default no checksum is

performed and the field is

empty

4 Number of

current

block

Integer 2 Option

al

01 01-99; Currently only 01 is

supported

5 Total

number of

blocks

Integer 2 Option

al

01 01-99; Currently only 01 is

supported

Table 6 - Request Trailer Record

Colt Cocom FTP User Guide GB 7.1 Page 36 of 97

Please Note: Each field must be delimited by a semi-colon (;) and the line should end with a

semi-colon.

Page 37: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

A.1.4 Request File Examples

CLI-only request message exampleFile name:

99900000001.req

Header Record:H;CLI Requests;0.02.1;GB;999;;;;01;01;20040908-11:31:11;

Detail Record(s):D;1;02082026743;A;0;20040908-11:31:11;;;;;;;;;;

D;2;02082362355;A;0;20040908-11:31:11;;;;;;;;;;

D;3;02082362355;D;0;20040908-11:31:11;;;;;;;;;;

Trailer Record:T;3;;01;01

Colt Cocom FTP User Guide GB 7.1 Page 37 of 97

Page 38: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Reseller Request Job file

Header Record{1 per file}

Detail Record{1 per file}

Trailer Record{1 per file}

A.2 Request Job File

The Request Job file is a flat file containing the name of a Request file and the Type

of Request. The file acts as a trigger for Cocom to start looking for a Request file.

There is exactly one job file for one Reseller Request file.

A.2.1 File/Message Structure

Figure 3 Request Job File Structure

A.2.2 Character Coding

ASCII

A.2.3 File Mark-up Coding

No structured Mark-Up used

Semi- colon separators used

Variable length records

A.2.4 Compression/Decompression Algorithms

None used.

A.2.5 File Name

The file name is formatted by concatenating:

The Service Profile – 3 alphanumerics

Colt Cocom FTP User Guide GB 7.1 Page 38 of 97

Page 39: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

The file sequence number – 8 characters left padded with zeros

File extension “.req.job”

Example:

99900000001.req.job

(Service Profile) 999 + 00000001 (File sequence number)

Colt Cocom FTP User Guide GB 7.1 Page 39 of 97

Page 40: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

A.2.6 Header Record

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

1 Header Id Alphanume

ric

1 Mandat

ory

H H for Header

Must be the first Field on

the First line of the file

2 Format

Description

Alphanume

ric

35 Optional Request Type + “

“ + “Requests”

Example:

CLI Requests

Free format text for

support

3 Version Alphanume

ric

6 Mandat

ory

0.02.1 Format version

Must be 0.02.1 unless

advised otherwise by

your Colt Account

Manager

4 Creation

Date

Timestamp 17 Mandat

ory

Current Date Format: YYYYMMDD-

hh:mm:ss

Example:

20040430-13:42:27

Table 7 - Job Header Record

A.2.7 Detail Record

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

1 Data Record

Identifier

Alphanume

ric

1 Mandat

ory

D D for Detail

Colt Cocom FTP User Guide GB 7.1 Page 40 of 97

Please Note: Each field must be delimited by a semi-colon (;) and the line should end

with a semi-colon.

Page 41: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

2 Request File

name

Alphanume

ric

23 Mandat

ory

Name of the associated

Reseller Request file

Format:

Dir/filename

Example:

Request/

99900000001.req

3 Format Alpha 32 Mandat

ory

plain Format of compression

of the Request file. This

should be the text value

‘plain’.

4 Request

Type

Alphanume

ric

32 Mandat

ory

Defines the type of

Request:

CLI

CPS

CLI/CPS

Table 8 - Job Detail Record

Colt Cocom FTP User Guide GB 7.1 Page 41 of 97

Please Note: Each field must be delimited by a semi-colon (;) and the line should end with

a semi-colon.

Page 42: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

A.2.8 Trailer Record

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

1 Trailer Id Alphanume

ric

1 Mandato

ry

T T for Trailer

Must be the First field

2 Number of

lines

Integer 3 Mandato

ry

1 Number of detail lines

3 Checksum Integer 10 Optional Blank Value generated running

Unix checksum on this

block’s data records. By

default no checksum is

performed and the field

is empty.

Table 9 - Job Trailer RecordNote: Each field must be delimited by a semi-colon (;) and the line should end with a

semi-colon.

A.2.9 Request Job File Example

File name:

99900000001.req.job

Header Record:H;Cocom Combined CLI/CPS Requests;0.02.1;20040908-11:31:11;

Detail Record(s):D;request/99900000001.req;plain;CLI/CPS;

Trailer Record:T;1;;

Colt Cocom FTP User Guide GB 7.1 Page 42 of 97

Page 43: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

A.3 Reference Data

A.3.1 Action Types

The following tables list the types of requests that you can submit for CLI and CPS.

CLI Action Types

Action Code

Action Rules

A Add to switch CLI must not be active

D Delete from switch CLI must be already active

M Modify CLI ownership to this

Reseller

CLI must be active with another Reseller. The

action will transfer the ownership of the CLI.

Table 10 - CLI Action Types

CLI / CPS Action Types

Action Code

Action Code Action Code

A CLI/CPS Request

Activate the CLI on the switch

and request Pre-selection

CLI may be inactive or active

If the CLI is active – warning message given

but CPS request is processed

If the CLI is inactive – CLI is activated on the

Switch then the CPS is processed

B Remove Order CLI must be active

C CPS Request

Request Pre-selection only but

CLI will be activated

automatically.

CLI may be inactive or active

If the CLI is active – no warning message

given but CPS request is processed

If the CLI is inactive – CLI is activated on the

Switch then the CPS is processed

E Cancel own order CLI must be active

G Change order CLI must be active

Change of Customer Request date

Table 11 – CLI / CPS Action Types

Colt Cocom FTP User Guide GB 7.1 Page 43 of 97

Page 44: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

A.4 Request Examples

The following example requests are for Reseller 853.

A.4.1 CLI-only Requests

This is from GB Reseller 999 to Deactivate CLI 02085552222, and to Activate CLIs

02075551112, and 02075688123Request File:H;CLI;0.02.1;GB;999;;;;01;01;20040816-09:50:28;

D;1;02085552222;D;;20040816-14:50:33;;;;;;;;;;

D;2;02075551112;A;;20040816-14:50:33;;;;;;;;;;

D;3;02075688123;A;;20040816-14:50:33;;;;;;;;;;

T;3;0;01;01;

Job File:H;CLI;0.02.1;20040816-09:50:28;

D;request/99900000006.req;plain;CLI;

T;1;;

A.4.2 CPS Requests

This is from GB Reseller 999 to Activate CPS on CLI 02078765198. The line is owned by BT

Request File:H;CPS Only Request;0.02.1;GB;999;;;;01;01;20040816-15:08:27;

D;1;02078765198;C;0;20040910-15:08:27;20040920;opt1;;;SS6;8UP;;N;BZW;T;1;;01;01;

Job File:H;CPS Only Request;0.02.1;20040816-15:08:27;

D;request/99900000003.req;plain;CPS;

T;1;;

A.4.3 CLI/CPS Request

This is from GB reseller 999 whose CLI screening profile index is 10719. This is a request

for the activation of a 3 completely new CLIs on the Colt switch, and the setting up of a

specified CPS service on BT for those CLIs. The lines are not owned by BT.

Request File:H;CLI/CPS Request;0.02.1;GB;999;;;;01;01;20040818-10:50:13;

D;1;01179345321;A;0;20040818-10:50:13;20040901;opt1;;;SS6;8UP;;Y;BZW;

Colt Cocom FTP User Guide GB 7.1 Page 44 of 97

Page 45: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

D;2;01179345326;A;0;20040818-10:50:13;20040901;opt1;;;SS6;8UP;;Y;BZW;D;3;01179345328;A;0;20040818-10:50:13;20040901;opt1;;;SS7;8UO;;Y;BZW;T;3;;01;01;

Job File:H;CLI/CPS Request;0.02.1;20040818-10:50:13;

D;request/99900000006.req;plain;CLI/CPS;

T;1;;

Colt Cocom FTP User Guide GB 7.1 Page 45 of 97

Page 46: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Appendix B Response Files

B.1 CLI Responses

This section describes the layout of a CLI Response file and the CLI Response Job file.

The Response file will contain an entry for each CLI request showing the status of the

request and will give the errors that are generated if a request fails validation. These

errors occur if there is something logically wrong with the actual request, rather than the

format of the request file. The errors will appear in the Response file, not in a separate

error file.

B.1.1 CLI Response Files

The CLI Response File is in the format of a flat file containing details of all the CLI

requests in the associated Request file. For each CLI or CLI/CPS Request File that

passes file-level validation one Response file and one Job File will be returned.

The Response file returns the result of the processing of all the CLI Requests submitted

to Cocom. The detail line defines whether the

activation/deactivation/modification/change request has been successful or has been

rejected.

Notes:

When the CLI is successfully actioned the “Error Code” field will contain 0 (zero) and

the “Error Text” field will contain ‘OK’.

When a CPS request is for a range of individual CLIs, the CLI response file will

contain one detail line for each number in the range.

The Response message is placed in a dedicated Reseller directory on the Colt

server /response.

Colt Cocom FTP User Guide GB 7.1 Page 46 of 97

Page 47: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

CLI Response

Header Record{1 per file}

Detail Record{n per file}

Trailer Record{1 per file}

B.1.2 File/Message Structure

Figure 4 - CLI Response Structure

File Naming

The file name is the same as the associated Request file name with a file extension of

“.rsp”.

Example:For a request file 99900000002.req

Response file will be:99900000002.rsp

B.1.3 Header Record

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

1 Header Id Alphanumeric 1 Manda

tory

H H for Header

2 Format

Description

Alphanumeric 35 Option

al

Cocom

Response

Activation/De

activation

The type of response

file

3 Version Alphanumeric 6 Manda

tory

0.02.1 Format version

Colt Cocom FTP User Guide GB 7.1 Page 47 of 97

Page 48: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

4 Creation

Date

Timestamp 17 Manda

tory

Current Date Format:

YYYYMMDD-

hh:mm:ss

Example:

20040430-13:42:27

Table 12 - CLI Response Header Record

Colt Cocom FTP User Guide GB 7.1 Page 48 of 97

Please Note: Each field must be delimited by a semi-colon (;) and the line should end

with a semi-colon.

Page 49: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

B.1.4 Detail Record

Field #

Field Name Type Field Length

Format Description

1 Data Record

Identifier

Alpha 1 “D” (without quotes)

2 Request No. Alphanumeric Variable Request No. provided in the request.

3 CLI Alphanumeric Variable CLI which has been processed. Inherited

from Request.

4 Action Alphanumeric Variable Populated from the corresponding original

ACTION value in Reseller Request Data

record.

For invalid action types the value is “?”

5 Colt Response

Date

Alphanumeric Variable Date and time when the response is

processed by Colt

6 Colt Response

Code

Alphanumeric Variable Cocom Error Code – refer to Table 27

“Cocom Validation Error Codes”

7 Colt Response

Text

Alphanumeric Variable Cocom Error Text – refer to Table 27

“Cocom Validation Error Codes”

Table 13 - CLI Response Detail Record

Fields holding data from the PTT may or may not be populated.

Colt Cocom FTP User Guide GB 7.1 Page 49 of 97

Please Note: Each field must be delimited by a semi-colon (;) and the line should end with

a semi-colon.

Page 50: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

B.1.5 Trailer Record

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default

Field Description / Notes

1 Trailer Id Alphanume

ric

1 Mandatory T T for Trailer

2 Number of

Detail Lines

Integer 3 Mandatory Number of Detail Lines

3 Checksum Integer 10 Optional Blank Value generated running Unix

checksum on this block’s data

records. By default no

checksum is performed and

the field is empty.

Table 14 - CLI Response Trailer Record

Colt Cocom FTP User Guide GB 7.1 Page 50 of 97

Please Note: Each field must be delimited by a semi-colon (;) and the line should end with

a semi-colon.

Page 51: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

B.2 CLI Response File Example

This is an example of a response to a CLI request with one successful CLI

activation, one successful CLI deactivation and one that was rejected because the

Action field contained “Activate” instead of “A”.

Response FileH;Cocom Response Activation/Deactivation;0.02.1;20040816-

18:05:49;

D;1;02078765198;A;20040816-18:05:49;0;OK;

D;2;02078895561;D;20040816-18:05:49;0;OK;

D;3;02085624897;?;20040816-18:05:49;1;DATA OUT OF RANGE(action

is Invalid);

T;3;;

Colt Cocom FTP User Guide GB 7.1 Page 51 of 97

Page 52: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

CLI Response job file

Header Record{1 per file}

Detail Record{1 per file}

Trailer Record{1 per file}

B.3 CLI Response Job File

The Response Job file is a flat file containing the name of a Response file and the

Type of Response. There is exactly one Job file for one Response file.

The file is created and transmitted after the CLI Response file processing is

complete. The aim is to prevent access of the Response file by the Reseller while it

is still open for writing by Colt. Therefore, the Reseller must not attempt to access

the Response file, before a job file is transmitted by Colt.

Job files are always stored in the /job_out directory.

B.3.1 File/Message Structure

Figure 5 - CLI Response Job File Structure

B.3.2 File Name

The file name is formatted by concatenating the file name of the associated CPS

Response file with an additional extension “.job”

Example:

99900000002.rsp.job

Colt Cocom FTP User Guide GB 7.1 Page 52 of 97

Page 53: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

B.3.3 Header Record

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

1 Header Id Alphanume

ric

1 Mandatory H H for Header

2 Format

Description

Alphanume

ric

35 Optional Cocom

Response

Jobfile

Description of the type

of job file

3 Version Alphanume

ric

6 Mandatory 0.02.1 Format version

4 Creation

Date

Timestamp 17 Mandatory Current Date Format: YYYYMMDD-

hh:mm:ss

Example:

20040430-13:42:27

Table 15 - Response Job Detail RecordNote: Each field will be delimited by a semi-colon (;) and the line will end with a

semi-colon.

B.3.4 Detail Record

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

1 Data Record

Identifier

Alphanume

ric

1 Mandatory D D for Detail

2 Response

File name

Alphanume

ric

23 Mandatory Name of the associated

CLI Response file

Format:

Dir/filename

Example:

Response/

99900000002.rsp

Colt Cocom FTP User Guide GB 7.1 Page 53 of 97

Page 54: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

3 Format Alpha 32 Mandatory plain Format of compression

of the Response file.

Should be text value

‘plain’.

Table 16 - Response Job Detail Record

Colt Cocom FTP User Guide GB 7.1 Page 54 of 97

Please Note: Each field must be delimited by a semi-colon (;) and the line should end

with a semi-colon.

Page 55: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

B.3.5 Trailer Record

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

1 Trailer Id Alphanume

ric

1 Mandatory T T for Trailer

2 Number of

lines

Integer 3 Mandatory 1 Number of detail lines

3 Checksum Integer 10 Optional Blank Value generated running

Unix checksum on this

block’s data records. By

default no checksum is

performed and the field

is empty.

Table 17 - Response Job Trailer Record

Colt Cocom FTP User Guide GB 7.1 Page 55 of 97

Please Note: Each field must be delimited by a semi-colon (;) and the line should end

with a semi-colon.

Page 56: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

B.4 CLI Request and Response File Example

In this example, CLI 01179301111 was successfully Deactivated, CLI 01179301135

successfully activated and a request to activate 01179301116 failed because the CLI has

already been activated for this Reseller.

Response File:H;Cocom Response Activation/Deactivation;0.02.1;20040816-18:05:49;

D;1;01179301111;D;20040816-18:05:49;0;OK;

D;2;01179301135;A;20040816-18:05:49;0;OK;

D;3;01179301116;A;20040816-18:05:49;2;OBJECT ALREADY EXISTS (direct

conflict with cli <0117301116>);

T;3;;

File name:99900000007.rsp.job

Job File:H;Cocom Response Jobfile;0.02.1;20040816-18:05:49;

D;response/99900000007.rsp;plain;

T;1;;

Colt Cocom FTP User Guide GB 7.1 Page 56 of 97

Page 57: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

B.5 CPS Response File

This section describes the format of the Cocom Response file and its associated Job file.

There is always one Job file for one Response file.

The CPS Response File is in the format of a flat file containing details of exactly 1

processed CPS request.

The Response file returns the result of the processing of the individual CPS

Requests submitted to BT.

Notes:

When the CLI is switched (preselection activated) the field “Date Switched” is always

populated

Activation Request date =< Date Switched =< Deactivation Request Date

The possible codes send by BT can be found in Error: Reference source not found

Error: Reference source not found

The Response message is placed in a dedicated Reseller directory on the Colt

server /response.

B.5.1 Response Times

CPS requests are usually processed by BT within 10 working days of BT acknowledging

receipt of the order. The detail line defines whether the activation request has been

successful or has been rejected.

B.5.2 Character Coding

ASCII

B.5.3 File Mark-up Coding

No structured Mark-Up used

Semi-column separators used

Variable line length

B.5.4 Compression/Decompression Algorithms

None used.

Colt Cocom FTP User Guide GB 7.1 Page 57 of 97

Page 58: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

CPS Response

Header Record{1 per file}

Detail Record{1 per file}

Trailer Record{1 per file}

B.5.5 File/Message Structure

Figure 6 - CPS Response Structure

B.5.6 File Naming – CPS Response file for a single CLI

This section describes the name of the CPS response file for a single CLI request.

The file name is formatted by concatenating:

The associated Request file name

“_”

Record number (the Line info value of an individual CPS request within the Request

file)

Response number – 1 response expected providing PTT and Colt systems work

correctly

File extension “.rsp”

Example:

99900000001_17_1.rsp

Colt Cocom FTP User Guide GB 7.1 Page 58 of 97

Page 59: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Where:

999 Unique Colt assigned Service Profile

00000001 File sequence number

17 The Line Info of an individual CPS request within the Request file

1Response number – 1 response expected providing PTT and Colt

systems work correctly

Colt Cocom FTP User Guide GB 7.1 Page 59 of 97

Page 60: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

B.5.7 File Naming – CPS Response file for a CLI within a range

British Telecom does not allow CLIs within a range.

B.5.8 File Naming – CPS Unsolicited Cease

CPS can be deactivated on request by the Reseller. CPS can also be deactivated by BT

directly. In this case, BT sends Colt a notification. CPS deactivated in this manner is

treated by the Colt system as Unsolicited Ceases.

For Unsolicited Ceases there is no associated file number, as there was no Deactivation

CPS request from the Reseller through Cocom. Therefore the file naming convention

uses the Service Profile and the CLI.

The file name is formatted by concatenating:

Service Profile

“_”

CLI

“_”

Response number – 1 response expected providing PTT and Colt systems work

correctly

File extension “.rsp”

Example:

999_02085624123_1.rsp

.Where:

999 Unique Colt assigned Service Profile

02085624123 CLI

1Response number – 1 response expected providing PTT and Colt

systems work correctly

Colt Cocom FTP User Guide GB 7.1 Page 60 of 97

Page 61: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

B.5.9 Header Record

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

1 Header Id Alphanume

ric

1 Mandat

ory

H H for Header

2 Format

Description

Alphanume

ric

35 Option

al

The type of Response

file

Example: CPS

Deactivation Response

3 Version Alphanume

ric

6 Mandat

ory

0.02.1 Format version

4 Creation

Date

Timestamp 17 Mandat

ory

Current Date Format: YYYYMMDD-

hh:mm:ss

Example:

20040430-13:42:27

Table 18 - CPS Response Header Record

Colt Cocom FTP User Guide GB 7.1 Page 61 of 97

Please Note: Each field must be delimited by a semi-colon (;) and the line should end with

a semi-colon.

Page 62: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

B.5.10CPS Response Detail Record

Field #

Field Name Type Field Length

Format Description

1 Data Record

Identifier

Alpha 1 “D” (without quotes)

2 Request No. Alphanumeric Variable Request No. provided in the request.

3 CLI Alphanumeric Variable CLI which has been processed. Inherited from

Request, or originated from PTT in the case of

Unsolicited Cease.

4 Action Alphanumeric Variable Populated from the corresponding original

ACTION value in CPS Reseller Request Data

record.

For Unsolicited Ceases, the value is “U”.

For invalid action types the value is “?”

Colt Cocom FTP User Guide GB 7.1 Page 62 of 97

Page 63: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Field #

Field Name Type Field Length

Format Description

5 CPS Status Alphanumeric Variable Normal Responses from BTConfirmed-First BT response to a Valid request.

Switched-Second BT response if order OK. Ready

for service as of “Switchover Date & Time”

Reject-Can be first or second BT response. Can

follow a Confirmed. According to Error Code/Text –

refer to Section F.2, Table 24 “BT CPS Status

Notification (CPSS) Reason Codes”. Order must be

corrected and resubmitted.

Unsolicited Messages from BT

Ceases are issued usually in response to end-

Customer requests to BT, or changes in the end-

Cust/BT relationship. CPS SERVICE ENDS

Cease Pending- Notification of intention to cease

line by BT

Cease Ignore Pending- PTT is not now going to

cease line. CPS continues in service.

Cease Actual - Line has been ceased by PTT

Cancel Other-Order has been cancelled by BT.

According to Error Code/Text – refer to Section F.3,

Table 25 “BT CPS Cancel Other Notification (CPSS)

Reason Codes”.

Change of Address (COA) : end-Customer has

told BT of a change of address. NO IMPACT ON

CPS SERVICE.

COA_PENDING- end-Customer moving premises

COA_IGNORE_PENDING- move cancelled

WLR-Related CPS Messages: only Resellers

subbing WLR requests to the BT SPG will get these.

CPS_RETAIN_PENDING-you have ordered WLR

and requested existing Colt CPS is retained.

CPS_RETAIN_IGNORE_PENDING- your WLR

order is not happening OR you do not now want to

retain CPS for some reason.

CPS_RETAIN_ACTUAL-PTT has completed

association of your WLR and CPS on this line.

COA_SUSPEND-move on hold

COA_ACTUAL- End-Customer has moved

premises.

Colt Cocom FTP User Guide GB 7.1 Page 63 of 97

Page 64: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Field #

Field Name Type Field Length

Format Description

6 Not used Not used

7 Not used Not used

8 Switch-over Date Alphanumeric Variable The Date on which the service is/will be

Installed

9 Colt Response

Date

Alphanumeric Variable Date and time when the response is processed

by Colt

10 Colt Response

Code

Alphanumeric Variable Cocom Error Code – refer to Error: Reference

source not found Error: Reference source not

found

11 Colt Response

Text

Alphanumeric Variable Cocom Error Text – refer to Error: Reference

source not found Error: Reference source not

found

12 BT Error Code 1 Alphanumeric Variable Main Error Code returned from – refer to Error:

Reference source not found Error: Reference

source not found

Note: Successful activation returns blank

13 BT Error Text 1 Alphanumeric Variable Main Error Text translated from BT Error Code

1 – refer to the sections below:

Error: Reference source not foundError:

Reference source not found

Error: Reference source not foundError:

Reference source not found

Note: Successful activation returns blank

14 BT Error Code 2 Alphanumeric Variable Subsequent error codes as supplied by BT

15 BT Error Code 3 Alphanumeric Variable Subsequent error codes as supplied by BT

16 BT Error Code 4 Alphanumeric Variable Subsequent error codes as supplied by BT

17 BT Error Code 5 Alphanumeric Variable Subsequent error codes as supplied by BT

18 BT Error Code 6 Alphanumeric Variable Subsequent error codes as supplied by BT

19 BT Error Code 7 Alphanumeric Variable Subsequent error codes as supplied by BT

20 BT Error Code 8 Alphanumeric Variable Subsequent error codes as supplied by BT

Colt Cocom FTP User Guide GB 7.1 Page 64 of 97

Page 65: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Field #

Field Name Type Field Length

Format Description

21 BT Error Code 9 Alphanumeric Variable Subsequent error codes as supplied by BT

22 BT Error Code 10 Alphanumeric Variable Subsequent error codes as supplied by BT

23 Cease NTF

Number

Cease NTF Number

Table 19 - CPS Response Detail Record

Colt Cocom FTP User Guide GB 7.1 Page 65 of 97

Please Note: Each field must be delimited by a semi-colon (;) and the line should end

with a semi-colon.

Page 66: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

B.5.11CPS Response File Example

Response message example - Activation:This is the first response from BT for the 17th CLI from the request file

“99900000001.req”. Note the file name includes the CLI.

File name:99900000001_17_1.rsp

Header line:H;CoCom CPS Response;0.02.1;20040621-17:39:31;

Detail line(s):D;17;02071234567;A;Confirmed;;;21072004;20040621-

17:39:31;0;OK;0;Order OK;;;;;;;;;;;

Trailer line:T;1;;

Response message example - Unsolicited Cease:Note the file name includes the CLI.

File name:875_010000021_1.rsp

Header line:H;CoCom CPS Response;0.02.1;20050223-13:54:17;

Detail line(s):D;;01000000021;U;Cease Pending;;opt3;20050223-00:00:00;20050223-13:54:17;0;OK;;;;;;;;;;;;00000000;

Trailer line:T;1;;

Response message example – Change of Address:Note the file name includes the CLI.

File name:875_01000000023_1.rsp

Header line:H;CoCom CPS Response;0.02.1;20050223-11:32:43;

Detail line(s):

Colt Cocom FTP User Guide GB 7.1 Page 66 of 97

Page 67: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

D;;01000000023;U;COA Pending;;opt3;20050223-00:00:00;20050223-11:32:43;0;OK;;;;;;;;;;;;00000000;

Trailer line:

T;1;;

Response message example – CPS Retain:Note the file name includes the CLI.

File name:

875_01000000062_1.rsp

Header line:H;CoCom CPS Response;0.02.1;20050301-17:20:48;

Detail line(s):D;;01000000062;U;CPS Retain Pending;;opt3;20050301-00:00:00;20050301-17:20:48;0;OK;;;;;;;;;;;;00000000;

Trailer line:

T;1;;

Colt Cocom FTP User Guide GB 7.1 Page 67 of 97

Page 68: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

B.6 CPS Response Job File

The Response Job file is a flat file containing the name of a Response file and the Type

of Response. There is exactly one job file for one Response file.

The file is created and transmitted after the CPS Response file processing is complete.

The aim is to prevent access of the Response file by the Resellers while it is still open

for writing by Colt. Therefore, the Reseller must not attempt to access the Response file,

before a job file is transmitted by Colt.

Job files are always stored in the /job_out directory.

B.6.1 Character Coding

ASCII

B.6.2 File Mark-up Coding

No structured Mark-Up used

Semi column separators used

Variable length records

B.6.3 Compression/Decompression Algorithms

None used.

Colt Cocom FTP User Guide GB 7.1 Page 68 of 97

Page 69: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

CPS Response job file

Header Record{1 per file}

Detail Record{1 per file}

Trailer Record{1 per file}

B.6.4 File/Message Structure

Figure 7 - CPS Response Job File Structure

B.6.5 File Name

The file name is formatted by concatenating:

The file name of the associated CPS Response file

Additional extension “.job”

Example:

99900000001_17_1.rsp.job

Colt Cocom FTP User Guide GB 7.1 Page 69 of 97

Page 70: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

B.6.6 Header Record

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

1 Header Id Alphanume

ric

1 Mandatory H H for Header

2 Format

Description

Alphanume

ric

35 Optional Cocom CPS

Response job file

The type of job file

3 Version Alphanume

ric

6 Mandatory 0.02.1 Format version

4 Creation

Date

Timestamp 17 Mandatory Current Date Format:

YYYYMMDD-

hh:mm:ss

Example:

20040910-13:42:27

Table 20 - CPS Response Job Header Record

B.6.7 Detail Record

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

1 Data Record

Identifier

Alphanume

ric

1 Mandatory D D for Detail

2 Response

File name

Alphanume

ric

23 Mandatory Name of the associated

Response file

Format:

Dir/filename

Example:

Response/

99900000001_17_1.rsp

Colt Cocom FTP User Guide GB 7.1 Page 70 of 97

Please Note: Each field must be delimited by a semi-colon (;) and the line should end

with a semi-colon.

Page 71: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

3 Format Alpha 32 Mandatory plain Format of compression of

the Request file. Should be

text value ‘plain’

4 Request

Type

Alphanume

ric

32 Optional Defines the type of

Request:

CPS

CLI/CPS

Table 21 - CPS Response Job Detail Record

Colt Cocom FTP User Guide GB 7.1 Page 71 of 97

Please Note: Each field must be delimited by a semi-colon (;) and the line should end

with a semi-colon.

Page 72: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

B.6.8 Trailer Record

Ref Identifier/ Field Name

Data Type MaxLength

M/O Default Field Description / Notes

1 Trailer Id Alphanume

ric

1 Mandatory T T for Trailer

2 Number of

lines

Integer 3 Mandatory 1 Number of detail lines

3 Checksum Integer 10 Optional Blank Value generated

running Unix

checksum on this

block’s data records.

By default no

checksum is

performed and the

field is empty

Table 22 - CPS Response Job Trailer Record

B.6.9 CPS Response Job File Example

File name:

E200000001.rsp

Header Record:H;Cocom CPS Response Jobfile;0.02.1;20050417-15:32:47;

Detail Record:D;response/E200000001.rsp;plain;CPS;

Trailer Record:T;1;;

Colt Cocom FTP User Guide GB 7.1 Page 72 of 97

Please Note: Each field must be delimited by a semi-colon (;) and the line should end

with a semi-colon.

Page 73: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

B.7 Sample Response Files

B.7.1 CPS Request

In this example three CPS requests were submitted. In due course the following three

response files will be received. Note that these could arrive singly or together.

Response file for Activate 02081456123 (unsuccessful due to incorrect action code):H;CoCom CPS Response;0.02.1;20040816-18:08:09;

D;1;02081456123;?;;;;;20040816-18:08:09;1;DATA OUT OF RANGE (Action

is invalid);;;;;;;;;;;;;

T;1;;

Response Job File:H;Cocom CPS Response Jobfile;0.02.1;20040816-18:08:09;

D;response/99900000003_1_1.rsp;plain;CPS;

T;1;;

Response File for Activate 02081234567 (successful):H;CoCom CPS Response;0.02.1;20040812-14:08:39;

D;2;02081234567;C;Switched;;;20040812-00:00:00;20040812-

14:08:39;0;OK;0;Order OK;;;;;;;;;;;

T;1;;

Job File:H;Cocom CPS Response Jobfile;0.02.1;20040812-14:08:39;

D;response/99900000003_2_1.rsp;plain;CPS;

T;1;;

Response File for Activate 02071234555 (failed due to request already in progress):H;CoCom CPS Response;0.02.1;20040812-14:08:39;

D;3;02071234555;C;Reject;;;20040812-00:00:00;20040812-

14:08:39;0;OK;20;Conflicting Pending CPS Order on CLI;;;;;;;;;;;

T;1;;

Job File:H;Cocom CPS Response Jobfile;0.02.1;20040812-14:08:39;

D;response/99900000003_3_1.rsp;plain;CPS;

T;1;;

Colt Cocom FTP User Guide GB 7.1 Page 73 of 97

Page 74: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

B.7.2 CLI/CPS Request

In example C.3.3 a number of combined CLI/CPS requests were submitted. The first number

could not be activated as it is already activated with another Colt Reseller, the second one

was switched successfully and the third one was rejected by BT.

CLI Response File - Colt CLI processingH;Cocom Response Activation/Deactivation;0.02.1;20040818-12:41:54;

D;1;01179345321;A;20040818-12:41:54;2;OBJECT ALREADY EXISTS (Direct

conflict with <01179345321>);

D;2;01179345326;A;20040818-12:41:54;0;OK(Ok CPS pending);

D;3;01179345328;A;20040818-12:41:54;0;OK(Ok CPS pending);

T;3;;

Job File:H;Cocom Response Jobfile;0.02.1;20040818-12:41:54;

D;response/99900000008.rsp;plain;

T;1;;

CPS Response File – 1st CPS request

Response file for 1st activation request to activate CPS on 01179345321 (unsuccessful):H;CoCom CPS Response;0.02.1;20040821-14:08:39;

D;1;01179345321;A;;;;20040821-14:08:39;2;OBJECT ALREADY EXISTS

(Direct conflict with <CLI>);;;;;;;;;;;;;

T;1;;

Job File:H;Cocom CPS Response Jobfile;0.02.1;20040821-14:08:39;

D;response/99900000008_1_1.rsp;plain;CLI/CPS;

T;1;;

CPS Response File – 2nd CPS request

Response file for 2nd activation request to activate CPS on 01179345326 (successful):H;CoCom CPS Response;0.02.1;20040821-14:08:39;

D;2;01179345326;A;Switched;;;20040821-00:00:00;20040821-

14:08:39;0;OK;0;Order OK;;;;;;;;;;;

T;1;;

Job File:H;Cocom CPS Response Jobfile;0.02.1;20040821-14:08:39;

Colt Cocom FTP User Guide GB 7.1 Page 74 of 97

Page 75: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

D;response/99900000008_2_1.rsp;plain;CLI/CPS;

T;1;;

CPS Response File – 3rd CPS request

Response file for 3rd activation request in the range to activate CPS on 01179345328

(unsuccessful):H;CoCom CPS Response;0.02.1;20040821-14:08:39;

D;3;01179345328;A;Reject;;;20040821-00:00:00;20040821-

14:08:39;0;OK;59;Postcode and CLI failed to match;;;;;;;;;;;

T;1;;

Job File:H;Cocom CPS Response Jobfile;0.02.1;20040821-14:08:39;

D;response/99900000008_3_1.rsp;plain;CLI/CPS;

T;1;;

Colt Cocom FTP User Guide GB 7.1 Page 75 of 97

Page 76: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Appendix C File Level Errors

This section describes the Error file generated by the system if a Reseller Request file is

in the wrong format.

If a Request file is in the wrong format (it fails because of file-level validation) a single

Error file will be created in the form of a flat file containing the result of the file-level

validation of the Request. It is generated only if an error has been found. In addition,

when an error is found, the request file and the associated job file are renamed by

appending “.failed” at the end of the original file names.

Example:

99900000001.req-> 99900000001.req.failed

99900000001.req.job->99900000001.req.job.failed

C.1 Error File Format

C.1.1 Character Coding

ASCII

C.1.2 File Mark-up Coding

No structured Mark-Up used

2 spaces are used as a separator between the fields

Variable line length

C.1.3 Compression / Decompression Algorithms

None used

C.1.4 File/Message Structure

Cocom-SG-EN-FR-25-01-2016-v01.9 76 / 97

Page 77: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Error

Detail Record{Exactly 1}

Figure 8 - Error File Structure

Cocom-SG-EN-FR-25-01-2016-v01.9 77 / 97

Page 78: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

C.1.5 File Name

The file name is formatted by appending “.error” at the end of the original request file

Example:

86500000001.req -> 86500000001.req.error

C.1.6 Detail Record

There are no header or trailer records in this file.

Ref Identifier/ Field Name

Data Type Max Length

Field Description / Notes

1Request file

name

Alphanumer

ic11 Request file name

2 Date of Error Timestamp 17Date Format:

DD.MM.YYYY HH:MM:SS

3 Error CodeAlphanumer

ic10

Error code maintained by Cocom

“Error “ + errCode + “:”

Example:

Error 10: See Details Error: Reference source not

foundError: Reference source not found

4Error

MessageInteger 80

Error Text

Example:

Version number is incorrect

See Details Error: Reference source not

foundError: Reference source not found

Table 23 - Error Detail Record

C.1.7 File Error Example

Cocom-SG-EN-FR-25-01-2016-v01.9 78 / 97

Please Note: Each field must be delimited by a semi-colon (;) and the line should end

with a semi-colon.

Page 79: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

File name:

86500000001.req.error

Detail Record(s):

86500000001 30.04.2004 11:31:11 Error 10: Version number is

incorrect

Cocom-SG-EN-FR-25-01-2016-v01.9 79 / 97

Page 80: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Appendix D CDR File

The CDR file contains only CDR records in a fixed length format. A CDR file is made

available twice per day – once in the morning and once in the afternoon. The files are

delivered at approximately 9AM and 5PM CET.

The 9 AM CET file contains calls from 4PM CET the previous day until 8AM CET on

the current day

The 5 PM CET file contains calls from 8AM CET to 4PM CET on the current day

D.1 CDR File Format

D.1.1 Character Coding

ASCII

D.1.2 File Mark-up Coding

No structured Mark-Up used

Fixed length records

Fixed length fields, space filled

D.1.3 Compression/Decompression Algorithms

CDR files are delivered in Zip format (Unix GZip, MS Windows Zip). However, Colt

recognizes that this can be difficult for certain companies to receive and the CDR files

can be delivered in plain text if required. Please notify Colt Customer Services if you

need the CDR files to be delivered as plain text (Uncompressed) files.

Cocom-SG-EN-FR-25-01-2016-v01.9 80 / 97

Please Note: CDR files are delivered to your directory 7 days a week and will vary in

size depending on the level of traffic that your customers generate.

Page 81: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

D.1.4 File Naming

D.1.4.1 Twice Daily CDR

All unrated CDR files delivered to Cocom Web Manager and FTP have a filename in the

following format:-

<countrycode>_<profile>_<productidentifier>_<sequence no>_<date>.cdr.gz

Where:

<countrycode> in ISO 2 character format, note GB is used

<profile> is up to 5 alphanumerics and is the applicable profile for the product

<productidentifier> is the product identifier (1-2 alphanumerics) – see table below

<sequence no> is a rolling four digit sequence per <profile>_<product> combination

<date> is YYYYMMDDHHmmss

.cdr is the extension

.gz is where the file is zipped

Product Identifier Product name

01 Reseller Connect

00 Voice Line

10 SIP Trunking

11 IP Voice Line

12 IN for Resellers

13 Carrier VoIP

Example:

GB_AB1_01_0007_20110204170001.cdr.gz

D.1.4.2 Consolidated CDR

All Consolidated CDR files delivered to Cocom Web Manager and FTP have a filename

in the following format:-

<profile><transactionID>.cdr.zip.

Cocom-SG-EN-FR-25-01-2016-v01.9 81 / 97

Page 82: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Where:

<profile> is up to 5 alphanumeric and is the applicable profile for the product

<transactionID> is the combination of date and unique number

.cdr is the extension

.zip is where the file is zipped

Example: ANP20120105171.cdr.zip

D.1.5 Call Detail Record Format

The following call detail format is applicable for both CDR and Consolidated CDR.

The data lines are 229 bytes in length and organised as:

Ref NameBytes/Length

PositionAlpha/Numeric

Format &Description

1 Origin 20 1 N

Originating CLI with leading 0. Filler

spaces must be added to fill in the

spaces designated for a field.

2

Destination

(Terminating

)

20 21 NDestination 0 = Domestic and

National, Destination 00 = International

3 Product Type 2 41 N ‘01’=Indirect Service

4 Date 8 43 N YYYYMMDD

5 Time 8 51 N

HHMMSSss . Time duration is broken

up into tenths of a second. Fractions of

a second will be ignored.

6 Duration 8 59 NDuration of the call to the nearest 1/10th

of a second SSSSSSSs

7 Continuation 1 67 N

‘0’, ‘1’, ‘2’, ‘3’ or ‘5’ – normally a 0; will

be ignored for our purposes. To be

used only if calls are greater than 6

hours

8 Switch ID 25 68 N Unique switch identifier

9 Trunk 25 93 N Internal use only

Cocom-SG-EN-FR-25-01-2016-v01.9 82 / 97

Page 83: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

incoming

10Trunk

outgoing25 118 N Internal use only

11Account

Code20 143 A Not in use

12 Pulses in 6 163 N Not in use

13Pulses

generated6 169 N Not in use

14 Pulses sent 6 175 A

In use for Reseller Connect in the UK:

Charge Band defined by Regulator

(Ofcom) for calls to non-geographic

numbers. If no Charge Band is

available, the value is 000000

15Service

Indicator4 181 N

0000 for standard calls, 0001 for ISDN

calls

16Charged (C-

Num)20 185 N Not in use

17Dialled (D-

Num)20 205 N Not in use

18 Carrier 3 225 AThe Reseller profile of up to 3

alphanumerics

19End of

Record1 228 A Value of zero is shown

20 Line Feed 1 229

ASCII

Control

Character

Line Feed (ASCII Control Character not

visible in plain text editors

Table 24 - Call Detail Record Format

D.2 Sample Call Detail Record

Cocom-SG-EN-FR-25-01-2016-v01.9 83 / 97

Please Note: There is an ASCII Control Character (Line Feed, HEX 0A) after the last field

19 “End of record”. This Control character generates a new line for the next CDR and

shows that the actual CDR ends. Normally you can ignore this control character except

you use a HEX-Editor to process your CDRs.

Page 84: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

GB_AB1_01_0007_20110204170001.cdr.gz

Sample unrated CDRs in the new standard format:-

01733201234 08003851234012011120707595080000000560 01001 2133

2009 0000000000000000000000 AB10

02077911234 01494811234012011120708002360000000290 01001 3135

3061 0000000000000000000000 AB10

01799581234 07831101234012011120708011980000008800 01001 2133

3137 0000000000000000000000 AB10

01279771234 07760271234012011120707580040000031920 01001 2133

3137 0000000000000000000000 AB10

Cocom-SG-EN-FR-25-01-2016-v01.9 84 / 97

Page 85: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Appendix E Reference Data

E.1 Cocom Reference Data

E.1.1 File Validation CodesThe following table lists the potential error codes that may result from File level errors:

Code Field Description / Notes

1 Too many CLIs for one Request. Number must be no more than {500}

2 Incorrect checksum

3 Sequence number too low, the expected sequence number is {n}

4 Sequence number too high, the expected sequence number is {n}

5 There are too many or too few header records, there should be 1

6 Wrong header format

7 There are too many or too few trailer records, there should be 1

8 Wrong trailer format

9 Wrong number of detail records

10 Version number is incorrect

11 Request file does not exist or is unreadable

12 Job file does not exist or is unreadable

13 Configuration file could not be read for the given reseller!

14 Error during sequence processing!

15 Can not write the reseller error file!

16 Can not determine the checksum!

17 Wrong header format in job file!

18 Wrong data format in job file!

19 Wrong trailer format in job file!

20 Could not create request for service id <a>

Table 25 - File Level Errors

Cocom-SG-EN-FR-25-01-2016-v01.9 85 / 97

Page 86: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

E.1.2 Request Validation CodesThe following are examples of messages that may appear in the response file after a

CLI, a CPS or a CLI/CPS request has been processed by Cocom.

Note that if a CLI request is successfully validated the response code will be “0” and the

error text “OK”.

Additional responses may appear that are not listed below.

Colt Response Code

Colt Response Text

Description Request type

Countries

Explanation

0

okComment: Activated for

Action Change

CLI ALL The requested action has been

successfully completed

Ok CPS

pending

CPS

CLI/CPS

ALL CLI activation has been

successfully completed, CPS

request is pending

1 Data out

of range

CLI is invalid.

ALL ALL The format of CLI is invalid.

CLI must be a number.

Numeric 10 or 11 digits

including the leading zero. The

following prefixes are not

allowed: 00,07,08,09

Action is invalid

ALL ALL Invalid Action for provisioning

was requested (see A.3.1

Action Types)

For CLI A,D,M are allowed

For CPS B,C,E,G are allowed

Job Date is invalid

ALL ALL The date format is wrong. (The

previous system was lenient in

accepting invalid dates).

Invalid Customer

Request Date

CPS

CLI/CPS

ALL Possible Causes of Error –

Wrong Data Format supplied

for Carrier Preselection.

Cocom-SG-EN-FR-25-01-2016-v01.9 86 / 97

Page 87: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Colt Response Code

Colt Response Text

Description Request type

Countries

Explanation

Invalid CPS Level

CPS

CLI/CPS

ALL CPS Level is wrongly specified.

Permitted values are opt1,

opt2, opt1n2, opt3

Postal Code is invalidCPS

CLI/CPS

UK First or second part of UK

postcode is missing

field <OFCOM RID> is

mandatory

CLI

CPS

CLI/CPS

UK Applies to request type CLI

only if the requested action is

‘TRANSFER CLI’ (modify) and

the CLI is currently pre-

selected

OFCOM RID <RID> is

not valid for reseller

<XXX>

CLI

CPS

CLI/CPS

UK Applies to request type CLI

only if the requested action is

‘TRANSFER CLI’ (modify) and

the CLI is currently pre-

selected

Invalid WLR Flag

CPS

CLI/CPS

UK Invalid value for WLR Flag is

selected. Could be “y” or “n”

(not case sensitive)

2 object

already

exists

CPS Pending, object

already exists

CPS

CLI/CPS

ALL CLI is already active, however

CPS is pending

best match conflict with

cli <cli>ALL DE, IT There is a best match conflict,

which can happen if a CLI is

provisioned or deprovisioned

which is part of a stub

Cocom-SG-EN-FR-25-01-2016-v01.9 87 / 97

Page 88: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Colt Response Code

Colt Response Text

Description Request type

Countries

Explanation

direct conflict with cli

<cli>

ALL DE, IT The CLI is already provisioned

and has been tried to

provisioned again. The request

has been submitted for a range

of CLIs. The CLI this response

relates to is already active on

the switch. The CPS request is

proceeding normally.

You will probably get a

response for each CLI in the

range.

If this is a single occurrence in

the range investigation is

required.

CLI <cli> already activeALL ALL The CLI has been already

activated on the switch

CLI already active ALL ALL

cli is already activated

ALL ALL A CLI activation has already

been send and is now in

process

cli already activated by

modify

ALL ALL

Account of cli has been

modified

ALL ALL

original account for cli

has changed

ALL ALL

Could not process

current request -

Pending CPS request

CPS

CLI/CPS

Cocom-SG-EN-FR-25-01-2016-v01.9 88 / 97

Page 89: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Colt Response Code

Colt Response Text

Description Request type

Countries

Explanation

Account <account>

cannot modify its own cli

ALL ALL Reseller has tried to modify a

CLI which has already been

assigned

the target account must

be different from the

original account

ALL ALL

8 object

does not

exist

These error messages can

only occur for deactivation

requests

Account of cli has been

modified

ALL ALL

range not available ALL ALL

No CPS found for action

DEACTIVATE

CPS

CLI/CPS

CPS

CLI/CP

S

Account <account>

does not exist.

ALL ALL

Account <account>

cannot submit CPS

requests for CLI of

another account (best

match)

CPS

CLI/CPS

DE, IT

Account <account>

cannot submit CPS

requests for CLI of

another account (direct

conflict)

CPS

CLI/CPS

DE, IT

Cocom-SG-EN-FR-25-01-2016-v01.9 89 / 97

Page 90: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Colt Response Code

Colt Response Text

Description Request type

Countries

Explanation

Account <account>

cannot deactivate cli of

another account

ALL ALL

16unknow

n error

Reseller has not sufficient

rights or privileges to process

the requested action

Account is locked ALL ALL

account is not allowed to

activate

ALL ALL

account is not allowed to

deactivate

ALL ALL

account is not allowed to

modify

ALL ALL

account is not allowed to

perform a CPS activate

CPS

CLI/CPS

ALL

Table 26 - Cocom Validation Codes and Text

Message CodeMessage Type Message Description

Explanation

0 B2BGateway Success Message/OK

-1 B2BGateway

Unable to process your request

[additional explanation]

Validation Failed, Infrastructure

Error, e.g. missing request file,

wrong characters

0 cocom OK – Success

99 Cocom

Cannot process your request!

Please contact customer service

support!

No connection between B2B

Gateway and Cocom

Table 27 – B2B Gateway error Codes

Cocom-SG-EN-FR-25-01-2016-v01.9 90 / 97

Page 91: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

E.2 PTT Reference Data

The following tables are from documents produced by BT.

BT CPS Status Notification (CPSS) Reason codes

Code Description Notes0 Order OK

1 Obsolete

2 Low User Scheme (and similar affordability packages)

3 Obsolete

4 Obsolete

5 Obsolete

6 Obsolete

7 Obsolete

8 Obsolete

9 Obsolete

10 Telephone Number not found

11 Incoming calls only / Temporarily out of Service

12 CPS Order - Invalid/Incorrect CPS Operator ID

13 CPS Order - Not a main Telephone Number

Cocom-SG-EN-FR-25-01-2016-v01.9 91 / 97

Page 92: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Code Description Notes14 Obsolete

15 CPS Order - Routing Prefix

16 CPS Order - CPS Operator Order Incorrect

17 CPS Order - Option(s)

18 Obsolete

19 CPS Order – Timed Out. This is for Centrex Orders only.

20 Conflicting Pending CPS Order on CLI

21 Remove order for removal of non-existent CPS option

22 Obsolete

23 See below- under Cancel Other CPSA Error Codes CPSA Only

24 See below- under Cancel Other CPSA Error Codes CPSA Only

25 Cancel Pending Order which does not exist (Cancel Own)

26 Obsolete

27 Cancel Pending Order – Invalid Date

28 Invalid Day (eg. 30/02/2000)

29 Conflicting Service

30 Duplicate Order Number Raised

31 Access line ceased or stopped

32 Access line due to be ceased or stopped by CRD

33 Obsolete

34 Obsolete

35 Obsolete

36 Change pending order – invalid date

37 Change pending order which does not exist

38 Obsolete

39 Obsolete

Cocom-SG-EN-FR-25-01-2016-v01.9 92 / 97

Page 93: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Code Description Notes40 Obsolete

41 The Record Version is not as expected

42 Obsolete

43 Not a Valid Record Type

44 Obsolete

45 Obsolete

46 Obsolete

47 Obsolete

48 Temporary Service Installation

49 Renumber Cease_Notification_Number has not been allocated, or

option requested incorrect

50 Obsolete

51 Not enough Lead time for Remove Order

52 Obsolete

53 Renumber CLI already has current operator

54 Invalid Reseller ID

55 Obsolete

56 Obsolete

57 Renumber not possible on FeatureNet

58 Obsolete

59 Postcode and CLI failed to match

60 Postcode not present

61 Centrex – Order – Authorisation Letter Reference not present

62 Centrex – Order – Authorisation Letter Reference invalid (eg invalid

characters)

63 Centrex – Order/Authorisation Letter – Mismatch of CLI

64 Centrex – Authorisation Letter – CLI missing

Cocom-SG-EN-FR-25-01-2016-v01.9 93 / 97

Page 94: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Code Description Notes65 Centrex – Order/Authorisation Letter – Mismatch of CPS Option

66 Centrex – Authorisation Letter – CPS Option missing

67 Centrex – Authorisation Letter – More than one CPS Option selected

68 Centrex – Authorisation Letter – Account Number not valid for given

CLI

69 Centrex – Authorisation Letter – Account Number missing

70 Centrex – Authorisation Letter not signed

71 Centrex – Authorisation Letter not dated

72 Centrex – Authorisation Letter has already successfully matched an

order

73 Centrex – Authorisation Letter has already timed out

74 WLR – No pending WLR order found for given WLR CPS Setup Phase 4 Only

75 WLR – WLR CPS Setup order arrived too close to switch date Phase 4 Only

76 Change order not allowed for given order type

77 CPS Setup not allowed on a WLR line Phase 5 Only

78 WLR CPS Setup – Line is not currently WLR and no pending WLR

order found

Phase 5 Only

79 Setup order for same CPSO, same CPS RID, same CPS option

80 CPS Renumber order with change of RID

81 CPS Bulk Migration orders not allowed for given CPSO

82 CPS Bulk Migration orders not allowed on Centrex line

83 Rejected the CPS bulk migration order because of Same CPSO

84 CPS Bulk Migration order - Calls packages is not Like For Like

85 CPS Bulk Migration order for CLI subject to data freeze on switch

106 Telephone Number/details not found on AO system - probably another

CP's number

107 Telephone Number not in use

108 Invalid Telephone Number

Cocom-SG-EN-FR-25-01-2016-v01.9 94 / 97

Page 95: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Code Description Notes109 Invalid format Telephone Number (too long, too short or no leading

zero)

110 CPS Renumber with unexpected CLI

Table 28 – BT CPS Status Notification (CPSS) Reason Codes

E.3 BT CPS Cancel Other Notification (CPSS) Reason CodesNote: All ‘Cancel Other Reason Codes’ will become active upon launch of CPS Phase

Five. During CPS Phase Four, all Cancel Other transactions will have the Reason Code

populated as ‘0000’ – i.e. that there has been no attempt made to categorise the reason

for the cancellation. Cancel Other Reason Codes are returned in the Error code 1 field of

the CPSS record when the Record Type is set to ‘F’ and the Status Stage is set to ‘0’.

NOTE: A principle has been established within industry meetings for current and future

Cancel Other Reason Codes to be allocated according to an allowed range of numbers.

These are as follows:

9001-99 Range: Cancellation generated by BT Retail User

91xx Range: Requested by CPSO (but actioned by TW Service Centre)

92xx Range: Generated by CPS Service Centre (TW and ASG)

93xx Range: Auto-generated by CPS Gateway

94xx Range: Generated by “other” BTW systems/processes

9000 : Any cancellation reason not covered by the current agreed set of allocated

codes (as below)

Reason Code Description Notes0000 Cancel Other – Reason Uncategorised Phase 4 Only

9000 BT Cancel Other – Unknown Reason (none of the below) Phase 5 Only

9010 BTR Cancel Other – Slam – Customer no knowledge of transfer Phase 5 Only

Cocom-SG-EN-FR-25-01-2016-v01.9 95 / 97

Page 96: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

Reason Code Description Notes9020 BTR Cancel Other – Slam – Customer no consent to transfer Phase 5 Only

9030 BTR Cancel Other – Internal Customer miscommunication Phase 5 Only

9040 BTR Cancel Other – Line Cease/Spare Phase 5 Only

9310 BTW Cancel Other – Renumber has switched – pending CPS Setup

Cancelled

Phase 5 Only

9320 BTW Cancel Other – Renumber has switched – pending Remove

cancelled

Phase 5 Only

9330 BTW Cancel Other – Line has ‘stopped’ – pending CPS order

cancelled

Phase 5 Only

9340 BTW Cancel Other – Reselect has switched – pending Remove

cancelled

Phase 5 Only

Table 29 – BT CPS Cancel Other Notification Reason Codes

E.4 Troubleshooting Cocom

Cocom is requesting a lower or higher Sequence number

Error 3: Sequence number too low, the expected sequence number is {n}

Error 4: Sequence number too high, the expected sequence number is {n}Please check if you have used the right sequence number. If several job files have been

put together at the same time into the jobin-directory it could happen that the system will

reject several files because of wrong sequence number (see note in 3.2 for request File

processing). Please resend the files by putting the job files one after the other into the

jobin directory.

Error -1: Unable to process your request: Unrecognized Sender/Receiver - Unknown Document Type

Cocom-SG-EN-FR-25-01-2016-v01.9 96 / 97

Page 97: Introduction - Colt Technology · Web viewcarrier-voip ip-voice-line in-for-resellers reseller-voip-connect The profile is up to 5 alphanumeric and is either the account profile or

There is a connectivity problem between Cocom and a Colt integration server. Please

contact Customer Service Support.

Error 18: Wrong data format in job file!

The format of the Job file is wrong. E.g there is a line feed character or any other

unknown character in the file, that the system is not able to read it. Please check if the

right format is used to save the file. Character Coding needs to be ASCII.

Error 11: Request file does not exist or is unreadable

Please check if the request file has been put in the directory before the job file. If this is

the case please check the format of the Job file which may be wrong. E.g. there is a line

feed character or any other unknown character in the file, that the system is not able to

read it. Please check if the right format is used to save the file. Character Coding needs

to be ASCI.

Cocom-SG-EN-FR-25-01-2016-v01.9 97 / 97