Introduction - Colt Technology Services … · Web viewIf the file is incorrect or fails at this...
Transcript of Introduction - Colt Technology Services … · Web viewIf the file is incorrect or fails at this...
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
VersionIssue Date
Description of change from previous version
Distributed
Generic Body 6.001/03/200
5
Remove Dial-up and VPN specific
information to separate documents.
Re-structure sections
DE 6.129/07/200
5
New layout.
Includes new messages from Cocom
DE 6.231/10/200
5
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
DE 6.302/03/200
6
Add new description of Error Code in
Table 27
Added in Table 1 that an error message
will be send for CPS-Requests if CLI
activation request is in progress
New chapter 8 Tips, tricks and rules
Update of chapter E 4 Troubleshooting
Cocom
Change in chapter A.1.3 Detail records:
CPS activation for range is changed
(Field CLI and Range Start)
DE 6.4 20/09/200
6 Correction of examples (Reseller IDs)
Colt Cocom FTP User Guide DE 7.4 2/ 74
Adding error message for VoIP
DE 6.515/04/200
9Maintenance & Support updated
DE 6.614/02/201
1
Updated to reflect introduction of
enhanced Cocom
DE 6.701/04/201
1Section on unrated CDRs updated
DE 6.826/08/201
1
Added more detailed information about
the new CDR format and updated Error
Messages in E.1.2 Request Validation
Codes
DE 6.917/11/201
1
Clarifications made to the FTP flie
validation code 18
DE 7.020/01/201
2
Updated with details of the consolidated
CDR feature
DE 7.106/05/201
5
DTAG decommission their ESAA
interface and replace it with WITA as of
30/06/2015. Updates reflect the new appt
timeslot field in a CPS request and new
DTAG Response Codes & messages.
DE 7.213/08/201
5
Updated to reflect the replacement of the
optional premise number field with the
mandatory Building number field for an
Activate CPS request & bulk request.
DE 7.3 01/02/16 Updated to reflect Colt rebranding.
DE 7.404/03/201
7
Replaced VoIP Access with SIP Trunking
and change in the notification period for
planned maintenance work in section 6
Colt Cocom FTP User Guide DE 7.4 3/ 74
Table of Contents1 INTRODUCTION.................................................................................................5
2 SERVICE OUTLINE............................................................................................62.1 OUTLINE PROCESS........................................................................................6
2.2 TECHNICAL INFRASTRUCTURE.........................................................................7
2.2.1 Overview..................................................................................................7
2.2.2 Directory Structure...................................................................................7
2.2.3 File Naming Standard............................................................................10
3 SERVICE REQUESTS......................................................................................113.1 OVERVIEW...................................................................................................11
3.2 REQUEST FILE PROCESSING........................................................................14
3.3 VALIDATION RULES AND CHECKS..................................................................15
4 SERVICE RESPONSES....................................................................................174.1 COLT RESPONSES.......................................................................................17
4.2 PTT RESPONSES.........................................................................................17
5 CDR FILES........................................................................................................18
6 MAINTENANCE AND SUPPORT.....................................................................19
7 TIPS, TRICKS & RULES...................................................................................20
8 GLOSSARY.......................................................................................................21
Colt Cocom FTP User Guide DE 7.4 4/ 74
1 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 DE 7.4 5/ 74
2 Service Outline
2.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.
Figure 1 Colt Reseller support infrastructure
Colt Cocom FTP User Guide DE 7.4 6/ 74
2.2 Technical Infrastructure
2.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. This method is
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.
2.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 DE 7.4 7/ 74
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
voipt123
de
reseller-connect
a1 /bin/cdr/cli_list/err_in/err_out/jobin/jobout/lib/request/responsevoip-access
123/bin/cdr/jobout/lib
atreseller-connect
a2 /bin/cdr/cli_list…………..
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
Colt Cocom FTP User Guide DE 7.4 8/ 74
The profile is up to 5 alphanumerics 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.
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 DE 7.4 9/ 74
2.2.3 File Naming Standard
Files transferred to and from Colt are all uniquely identified and adhere to the
following naming convention.
The filenames will consist of three parts:
1. The first digits are assigned by Colt and will be your unique identifier / profile,
which is up to 5 alphanumerics
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 abc would be a pair of
files:
abc00000001.req
abc00000001.req.job
The Colt response would be another pair of files:
abc00000001.rsp
abc00000001.rsp.job
Colt Cocom FTP User Guide DE 7.4 10/ 74
3 Service Requests
3.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
Not Permitted.
You need to deactivate CPS first, and
then submit another request to
Colt Cocom FTP User Guide DE 7.4 11/ 74
processed
If the CLI is inactive – CLI is
activated on the Switch then the
CPS is processed
deactivate the CLI after the CPS has
been deactivated.
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 2.2.3 File Naming Standard 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:
1) You will upload a request file
2) Followed by uploading the corresponding job file
3) 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 3.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 CLI is not active an
acknowledgement will be sent.
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.
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
Colt Cocom FTP User Guide DE 7.4 12/ 74
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 DE 7.4 13/ 74
3.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 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.
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 DE 7.4 14/ 74
3.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 (2.2.3)
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 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
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 Level
Colt Cocom FTP User Guide DE 7.4 15/ 74
After 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
The request action codes must be valid (A.3 Reference Data)
The date needs to be in the right format (See also Appendix A)
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 E.1.2 Request
Validation Codes.
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 DE 7.4 16/ 74
4 Service Responses
4.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
4.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 E.2 PTT Reference Data.
Colt Cocom FTP User Guide DE 7.4 17/ 74
5 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 unrated CDRs
collected by the Colt network since the last file, typically each 12 hours.
In addition, you can request a consolidated CDR file using Cocom Web Manager
and this consolidated CDR file will be delivered to both Cocom Web Manager and
FTP. More details are provided in Appendix D.
The files are provided in a pre-defined, fixed length format. These files are detailed
in Appendix D
Colt Cocom FTP User Guide DE 7.4 18/ 74
6 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 DE 7.4 19/ 74
7 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. Less 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 reserve 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 E.1.1 File Validation Codes Of Cocom Reference Data.
Colt Cocom FTP User Guide DE 7.4 20/ 74
8 Glossary
Term Description
CLI 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 DE 7.4 21/ 74
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 (include CLI activation) 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 StructureEach 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
Please Note: A List of all CLIs will appear in the “all_cli” Folder in FTP after the first
request was successfully processed.
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
Colt Cocom FTP User Guide DE 7.4 22/ 74
that the Reseller ID in the file-name is written in lower cases due to the UNIX Server
can’t process files with capital letters in the file name.
A.1.2 Header Record
There 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 Mandatory 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 Mandatory 0.01.1 File Format
Version. This is a
required value and
should be the
default value
unless otherwise
instructed by Colt
4 Creation
Date
Timestamp 17 Mandatory Current Date in
format
YYYYMMDD-
hh:mm:ss
Example:
20040430-
13:42:27
Current Date in
format
YYYYMMDD-
hh:mm:ss
Table 3 - Request Header RecordNote: Each field must be delimited by a semi-colon (;) and the line should end with a
semi-colon.
Colt Cocom FTP User Guide DE 7.4 23/ 74
A.1.3 Detail Records
There can be up to 500 detail records per Request file.
CLI-only Detail RecordsThere can be up to 500 detail lines per Request file.
Ref
Identifier/ Field Name
Data Type
MaxLength
M/O Default Field Description / Notes
1 Data
Record
Identifier
Alpha 1 Mandator
y
D Must be character “D”
(without quotes)
2 Request
Number
Integer Variab
le
Mandator
y
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 Numeric 5-22 Mandator
y
None Telephone number
Because CLIs can only
be activated with the
leading area code the
CLI has to begin with a
leading 0. If there is no
leading zero it will be
added by Colt.
Colt Cocom FTP User Guide DE 7.4 24/ 74
Ref
Identifier/ Field Name
Data Type
MaxLength
M/O Default Field Description / Notes
4 Action Alpha 1 Mandator
y
None Request Type CLI:
A = Add to Switch
D = Deactivate on
Switch
M = Modify on Switch
Only customer with
‘modify’-authorisation
are allowed to use the
‘modify CLI’ transaction.
To prevent customers
for unauthorised use of
the ‘modify CLI’
transaction, they must
request an ‘activate CLI’
first.
5 Job date Alphanume
ric
17 Mandator
y
None Current Date in format
YYYYMMDD-hh:mm:ss
Example:
20041015-13:42:27
6 Not used Blank
7 Not used Blank
8 Not used Blank
9 Not used Blank
10 Not used Blank
11 Not used Blank
12 Not used Blank
13 Not used Blank
14 Not used Blank
15 Not used Blank
Colt Cocom FTP User Guide DE 7.4 25/ 74
Ref
Identifier/ Field Name
Data Type
MaxLength
M/O Default Field Description / Notes
16 Not used Blank
17 Not used Blank
Table 4 Request Detail Record Format
Note 1: Although fields 6-17 are not currently used, they need to appear in the
request by including the semi-colon that indicates the end of the field. Please see
for a sample Request file.
Note 2: The line should end with a semi-colon (;)CPS and CLI/CPS Detail Records
There can be up to 500 detail lines per Request file.
Ref
Identifier/ Field Name
Data Type
MaxLength
M/O Default Field Description / Notes
1 Data
Record
Identifier
Alpha 1 Mandatory D Must be character “D”
(without quotes)
2 Request
Number
Integer Variable 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.
Colt Cocom FTP User Guide DE 7.4 26/ 74
Ref
Identifier/ Field Name
Data Type
MaxLength
M/O Default Field Description / Notes
3 CLI Numeri
c
5-22 Mandatory None Telephone number
Because CLIs can only be
activated with the leading
area code the CLI has to
begin with a leading 0. If
there is no leading zero it
will be added by Colt.
CLIs with the following
prefixes cannot be used in
CPS requests:
00
01
0190
0800
0900
Due to changes to Cocom
only “Stamm-Nr” is allowed
here, independently of how
many CLI blocks were
activated by Colt. The
“Stamm-Nr” needs to be a
valid DTAG number. It is
not possible to send
smaller parts of a range or
a single Number out of a
range to DTAG as it would
be rejected (RNG). A CPS
request with part of the
range will lead to a best
match conflict and not sent
to DTAG.
Colt Cocom FTP User Guide DE 7.4 27/ 74
Ref
Identifier/ Field Name
Data Type
MaxLength
M/O Default Field Description / Notes
4 Action Alpha 1 Mandatory None Request Type CLI/CPS or
CPS:
C = Add to Switch and
Activate Pre-selection
Note: D is not allowed.
5 Job date Timesta
mp
17 Mandatory None Current Date in format
YYYYMMDD-hh:mm:ss
Example:
20041015-13:42:27
6 Customer
Request
Date
Numeri
c
8 Mandatory YYYYMM
DD
Deutsche Telekom accepts
a Preferred Date of
Implementation
Format = YYYYMMDD
Minimum timeframe is
three working days.
7 CPS
Level
Alphanu
meric
9 Mandatory None The type of CPS service
required.
For both CPS-only and
CLI/CPS requests:
CPS_5 – Local AND
distance(Bundle)
CPS_4 – Local OR
distance (DTAG activate
either local or distance or
both, depending on which
value is not active)
CPS_3 – Distance
CPS_2 – Local
8 Area
Code
Numeri
c
6 Mandatory None City code with a leading
zero
Colt Cocom FTP User Guide DE 7.4 28/ 74
Ref
Identifier/ Field Name
Data Type
MaxLength
M/O Default Field Description / Notes
9 Caller
Number
Numeri
c
9 Mandatory None Telephone number without
extension
10 Range
Start
Numeri
c
6 Optional None Only required when a block
of contiguous caller
numbers is passed to
DTAG.
The number of digits
entered for Range Start
and Range End must be
identical, otherwise the
request will be rejected by
Cocom as the range
information is not properly
validated. E.g.
Valid combination: Range
start: 00, Range End: 99.
Invalid combination: Range
Start: 0, Range End: 99.
Partial range combinations
are allowed, e.g. 00-09 or
10-19 or 20-29 or 90-99
Notes: Ranges apply to
CPS-only requests. There
is no range feature
associated with CLIs.
The “Stamm-Nr” needs to
be known by DTAG.
If specifying a range, the
Internal Switchboard value
must be provided.
Colt Cocom FTP User Guide DE 7.4 29/ 74
Ref
Identifier/ Field Name
Data Type
MaxLength
M/O Default Field Description / Notes
11 Range
End
Numeri
c
6 Optional None Please refer to rule in
Range Start field
description.
12 Internal
Switchbo
ard
Numeri
c
6 Optional None Required if specifying a
number range for a CPS
request submission.
Numeric value with one
digit.
13 First
name
Alphanu
meric
30 Optional None For residential subscribers this field is
mandatory or the order
will be rejected by DTAG.
In the case of a Corporate
customer this field should
be blank.
14 Party
Name
Alphanu
meric
60 Mandatory None Customer Name
Either:
Company name
Surname for a private
customer.
15 Street Alphanu
meric
40 Mandatory None Street number or PO Box
number
16 Building
Number
Alphanu
meric
10 Mandatory None Building Number
17 Postal
Code
Alphanu
meric
10 Mandatory None Postal code
18 City Alphanu
meric
40 Mandatory None City or Town
19 Country Alpha 2 Optional None Country using the ISO-
3166 code. DE will be
used here.
Colt Cocom FTP User Guide DE 7.4 30/ 74
Ref
Identifier/ Field Name
Data Type
MaxLength
M/O Default Field Description / Notes
20 Appointm
ent Time
Slot
Numeri
c
1 Optional None Possible values are ‘7’ or
‘9’.
Enter “9” for 0800-1200
CET(Mon-Sat)
Enter “7” for 1200-1600
CET(Mon-Fri)
Default value is “9”
If the customer request
date is a Saturday, select
“9“ for timeslot: 0800-1200
CET
Table 5 Request Detail Record FormatNote: Each field must be delimited by a semi-colon (;) and the line should end with a
semi-colon.
A.1.4 Trailer Record
Ref
Identifier/ Field Name
MaxLength
M/O Field Description / Notes
1 Trailer Id 1Mandator
y
T for Trailer
Must be first field on last line in file
2
Number of
Records in
this block
3 Optional Maintained by Reseller
3 Checksum 10 Optional
Value generated running Unix checksum on this
block’s data records. By default no checksum is
performed and the field is empty
Table 6 - Request Trailer RecordNote: Each field must be delimited by a semi-colon (;) and the line should end with a
semi-colon.
Colt Cocom FTP User Guide DE 7.4 31/ 74
A.1.5 Request File Examples
CLI-only request message exampleFile name:
abc00000001.req
Header Record:H;CLI Request;0.01.1;20041015-11:31:11;
Detail Record(s):D;1;02401606823;A;20041015-11:31:11;;;;;;;;;;;;;
D;2;024514843694;D;20041015-11:31:11;;;;;;;;;;;;;
D;3;02451490514;A;20041015-11:31:11;;;;;;;;;;;;;
D;4;02451900519;A;20041015-11:31:11;;;;;;;;;;;;;
Trailer Record:T;4;;
CPS request message exampleFile name:
abc00000002.req
Header Record:H;CPS Request;0.01.1;20041015-12:27:00;
Detail Record(s):D;1;06918273605;C;20041015-
12:27:00;20041022;CPS_3;069;18273605;;;;Max;Headroom;Gartenstr
.;5;60338;Frankfurt;DE;7;
D;2;0694711;C;20041015-
12:27:00;20041019;CPS_2;069;4711;00;99;2;Sam;Hill;Erlenstr.;10
;60283;Frankfurt;DE;9;
D;3;06946190;C;20041015-
12:27:00;20041026;CPS_4;069;46190;10;19;6;John;Doe;Buchenweg;3
b;60139;Frankfurt;DE;9;
Trailer Record:T;3;;
CLI/CPS request message example
File name:abc00000003.req
Header Record:H;Combined CLI/CPS Request;0.01.1;20041018-09:22:16;
Colt Cocom FTP User Guide DE 7.4 32/ 74
Detail Record(s):D;1;0123456789;C;20150421-
15:01:36;20150512;CPS_2;211;987654321;2001;2001;;TEST;KR;Bergi
sche Landstr;1;40629;DÜSSELDORF;DE;7;
D;1;0123456889;C;20150421-
15:07:42;20150516;CPS_2;69;987655621;2005;2005;;TEST;KR;
Herriotstrasse;1;60528;Frankfurt;DE;9;
Trailer Record:T;3;;
Colt Cocom FTP User Guide DE 7.4 33/ 74
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
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
The file sequence number – 8 characters left padded with zeros
File extension “.req.job”
Example:
ab100000001.req.job
(Service Profile) ab1 + 00000001 (File sequence number)
Colt Cocom FTP User Guide DE 7.4 34/ 74
A.2.6 Header Record
Ref
Identifier/ Field Name
MaxLength
M/O Field Description / Notes
1 Header Id 1Mandator
y
H for Header
Must be the first Field on the First line of the file
2Format
DescriptionN/A Optional
Free format text for support Example:
CLI Requests
3 Version N/AMandator
y
Format version
Must be 0.01.1 unless advised otherwise by Colt.
4Creation
DateN/A
Mandator
yCurrent Date in format YYYYMMDD-hh:mm:ss
Table 7 - Job Header RecordNote: Each field must be delimited by a semi-colon (;) and the line should end with a
semi-colon.
A.2.7 Detail Record
Ref
Identifier/ Field Name
MaxLength
M/O Field Description / Notes
1Data Record
Identifier1 Mandatory D for Detail
2Request File
nameN/A Mandatory
Name of the associated Reseller Request file
Format: Dir/filename
Example: request/abc00000001.req.job
3 Format N/A MandatoryFormat of compression of the Request file. This
should be the text value ‘plain’.
4 Request Type N/A Mandatory
Defines the type of Request:
CLI
CPS
CLI/CPS
Colt Cocom FTP User Guide DE 7.4 35/ 74
Table 8 - Job Detail RecordNote: Each field must be delimited by a semi-colon (;) and the line should end with a
semi-colon.
Colt Cocom FTP User Guide DE 7.4 36/ 74
A.2.8 Trailer Record
Ref
Identifier/ Field Name
MaxLength
M/O Field Description / Notes
1 Trailer Id 1Mandator
y
T for Trailer
Must be the First field
2Number of
lines3
Mandator
yNumber of detail lines
3 Checksum N/A Optional
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:
abc000000001.req.job
Records:
H;CPS Request;0.01.1;20041030-11:31:11;
D;request/abc000000001.req;plain;CPS;
T;1;;
Colt Cocom FTP User Guide DE 7.4 37/ 74
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
CPS and CLI / CPS Action Types
Action Code
Action Code Action Code
C CPS Request
Request Preselection 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
Table 11 – CLI / CPS Action Types
Colt Cocom FTP User Guide DE 7.4 38/ 74
A.4 Request Examples
The following example requests are for Reseller AAC.
A.4.1 CLI-only Requests
This is from a German (DE) Reseller AAC to Deactivate CLI 02451910984 and to
Activate CLIs 02451901509 and 02451904415.
Request File:H;CLI Requests;0.01.1;20041015-09:50:28;
D;1;02451910984;D;20041015-09:50:28;;;;;;;;;;;;;
D;2;02451901509;A;20041015-09:50:28;;;;;;;;;;;;;
D;3;02451904415;A;20041015-09:50:28;;;;;;;;;;;;;
T;3;;
Job File:H;CLI Request Job File;0.01.1;20041015-09:50:28;
D;request/aac00000006.req;plain;CLI;
T;1;;
A.4.2 CPS Requests
This is from a German (DE) Reseller AAC to Activate CPS on CLIs 02151761585 and
02161307496.
Request File:H;CoCom CPS Aktivierung Requests;0.01.1;20150421-15:20:25;
D;1;02151761585;C;20150421-
15:20:25;20150512;CPS_2;211;987654321;2001;2001;;TEST;KR;Bergische
Landstr;1;40629;DÜSSELDORF;DE;7;
D;1;02161307496;C;20150421-
15:07:42;20150516;CPS_2;69;987655621;2005;2005;;TEST;KR;
Herriotstrasse;1;60528;Frankfurt;DE;7;
Colt Cocom FTP User Guide DE 7.4 39/ 74
Job File:H;CPS Only Request;0.01.1;20041015-15:08:27;
D;request/aac00000009.req;plain;CPS;
T;1;0;
A.4.3 CLI/CPS Requests
This is from a German (DE) Reseller AAC to activate three CLIs and to activate CPS
on the CLIs.
Request File:H;CLI/CPS Request;0.01.1;20041018-10:50:13;
D;1;069520522;C;20150421-15:01:36 -
15:20:25;20150512;CPS_2;211;987654321;2001;2001;;TEST;KR;Bergische
Landstr;1;40629;DÜSSELDORF;DE;7;
D;2;069288662;C;20150421-15:01:36 -
15:20:25;20150512;CPS_2;211;987654321;2002;2002;;TEST;KR;Bergische
Landstr;1;40629;DÜSSELDORF;DE;7;
D;3;069412890;C;20150421-15:01:36 -
15:07:42;20150516;CPS_2;69;987655621;2003;2003;;TEST;KR;
Herriotstrasse;1;60528;Frankfurt;DE;9;
T;3;;
Job File:H;CLI/CPS Request;0.01.1;20041018-10:50:13;
D;request/aac000000011.req;plain;CLI/CPS;
T;1;;
Colt Cocom FTP User Guide DE 7.4 40/ 74
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 DE 7.4 41/ 74
CLI Response
Header Record{1 per file}
Detail Record{n per file}
Trailer Record{1 per file}
B.1.2 File/Message Structure
Figure 3 - CLI Response Structure
B.1.3 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: abc00000001.req
Response file will be: abc00000001.rsp
B.1.4 Header Record
Ref
Identifier/ Field Name
MaxLength
Field Description / Notes
1 Header Id 1 H for Header
2Format
Description35
The type of response file
e.g. Cocom Response Activation/Deactivation
3 Version 6Format version
Must be: 0.01.1
4 Creation Date 17 Current Date in format YYYYMMDD-hh:mm:ss
Table 12 - CLI Response Header Record
Colt Cocom FTP User Guide DE 7.4 42/ 74
Note: Each field will be delimited by a semi-colon (;) and the line will end with a semi-
colon.
B.1.5 Detail Record
Field Number
Field Name Type Field Length
Format Description
1 Data Record
Identifier
Alpha 1 D for data line
2 Request No. Numeric Variable Request number provided in the request.
3 CLI Numeric 22 CLI which has been processed. Inherited
from Request.
4 Action Alpha 1 Populated from the corresponding
original ACTION value in Reseller
Request Data record.
For invalid action types the value is “?”
5 Colt Response
Date
Alphanumeric 17 Date and time when the response is
processed by Colt
6 Colt Response
Code
Integer Variable Cocom Error Code – refer to E.1.2
Request Validation Codes.
7 Colt Response
Text
Alpha Variable Cocom Error Text – refer to E.1.2
Request Validation Codes.
Table 13 - CLI Response Detail RecordNote: Each field will be delimited by a semi-colon (;) and the line will end with a semi-
colon.
Fields holding data from the PTT may or may not be populated.
If Resellers are using automated procedure we strongly recommend that only field
number 6 is been programmed to deduct further error processing.
Colt Cocom FTP User Guide DE 7.4 43/ 74
B.1.6 Trailer Record
Ref
Identifier/ Field Name
MaxLength
Field Description / Notes
1 Trailer Id 1 T for Trailer
2Number of
Detail Lines3 Number of Detail Lines
3 Checksum 10
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
Note: Each field will be delimited by a semi-colon (;) and the line will end with a semi-
colon.
B.1.7 Response File Example
File name:
abc00000001.rsp
Header line:H;Cocom Response Activation/Deactivation;0.01.1;20041015-12:42:49;
Detail line(s):D;1;02401606823;A;20041015-12:42:49;0;OK;
D;2;024514843694;D;20041015-12:42:49;0;OK;
D;3;02451490514;A;20041015-12:42:49;0;OK;
D;4;02451900519;A;20041015-12:42:49;0;OK;
Trailer line:T;4;;
Colt Cocom FTP User Guide DE 7.4 44/ 74
B.2 CLI Response File Example
This is an example of a response to a CLI request with one unsuccessful CLI
activation, one successful activation of a range and one successful CLI deactivation.
Response FileH;Cocom Response Activation/Deactivation;0.01.1;20041021-
14:29:46;
D;1;02451910984;D;20041021-14:29:46;0;OK;
D;2;02451901509;A;20041021-14:29:46;0;OK;
D;3;02451904415;A;20041021-14:29:46;2;OBJECT ALREADY EXISTS
(direct conflict with <02451904415>);
T;3;;
Job File:H;Cocom Response Jobfile;0.01.1;20041021-14:29:46;
D;response/aac00000004.rsp;plain;
T;1;;
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.
Colt Cocom FTP User Guide DE 7.4 45/ 74
CLI Response job file
Header Record{1 per file}
Detail Record{1 per file}
Trailer Record{1 per file}
B.3.1 File/Message Structure
Figure 4 - 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:
abc00000002.rsp.job
B.3.3 Header Record
Ref
Identifier/ Field Name
MaxLength
Field Description / Notes
1 Header Id 1 H for Header
2Format
Description35
Description of the type of job file
e.g. Cocom Response Job file
3 Version 6Format version
Must be 0.01.1.
4 Creation Date 17 Current Date in format YYYYMMDD-hh:mm:ss
Table 15 - Response Job Detail RecordNote: Each field will be delimited by a semi-colon (;) and the line will end with a
semi-colon.
Colt Cocom FTP User Guide DE 7.4 46/ 74
B.3.4 Detail Record
Ref
Identifier/ Field Name
MaxLength
Field Description / Notes
1Data Record
Identifier1 D for Detail
2Response File
name22
Name of the associated CLI Response file
Format: Dir/filename
Example: Response/abc00000002.rsp
3 Format 32Format of compression of the Response file. Should
be text value ‘plain’
Table 16 - Response Job Detail RecordNote: Each field will be delimited by a semi-colon (;) and the line will end with a
semi-colon.
B.3.5 Trailer Record
Ref
Identifier/ Field Name
MaxLength
Field Description / Notes
1 Trailer Id 1 T for Trailer
2 Number of lines 3Number of detail lines
3 Checksum 10
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 RecordNote: Each field will be delimited by a semi-colon (;) and the line will end with a
semi-colon.
Colt Cocom FTP User Guide DE 7.4 47/ 74
B.4 CLI Request and Response File Example
The following example responses are from requests by Reseller BEC.
In this example, the CLI 0691234568 was requested for deactivation, which wasn’t
successful, because the CLI wasn’t assigned to Reseller BEC. The activation request for CLI
069987659 was successful.
File name:bec00013253.req
Request File:H;CLI Request;0.01.1;20051007-18:00:11;
D;1;0691234568;D;20051007-18:31:11;;;;;;;;;;;;;
D;2;069987659;A;20051007-18:31:11;;;;;;;;;;;;;
T;2;;
File name:bec00013253.rsp
Response File:H;Cocom Response Activation/Deactivation;0.01.1;20051007-22:06:31;
D;1;0691234568;D;2005.10.07-18:03:16;8;object does not exist (account
<BEC> cannot deactivate cli of another account);
D;2;069987659;A;2005.10.07-18:04:38;0;ok;
T;2;;
File name:
bec00013253.rsp.job
Request Job FileH;CLI Request;0.01.1;20051007-18:01:11;
D;request/BE00013253.req;plain;CLI;
T;1;;
File name:
bec00013253.req.job
Response Job File:H;Cocom CPS Response Jobfile;0.01.1;20051007-22:06:31;
D;response/bec00013253.rsp;plain;CLI;
T;1;;
Colt Cocom FTP User Guide DE 7.4 48/ 74
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 DTAG.
The possible codes send by DTAG can be found in E.2 PTT Reference Data
When a CPS request is for a range of individual CLIs, there will be one CPS
response file for each CLI within the range.
The Response message is placed in a dedicated Reseller directory on the Colt
server /response.
B.5.1 Response Times
The response time from Deutsche Telekom is within 5 working days.
The acknowledgement of an order is usually received on the business day after the
order was submitted however it can be longer and there is no SLA for the
acknowledgement.
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 DE 7.4 49/ 74
CPS Response
Header Record{1 per file}
Detail Record{1 per file}
Trailer Record{1 per file}
B.5.5 File/Message Structure
Figure 5 - 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 – the number of the response file (there will be only one for
each request)
File extension “.rsp”
Example: abc00000001_17_1.rsp
Where:
abc 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 DE 7.4 50/ 74
B.5.7 File Naming – CPS Response file for a CLI within a range
This section describes the name of the CPS response file for a CLI within a range which
is the same as for a single CLI.
The file name is formatted by concatenating:
The associated Request file name
“_”
Response number – the number of the response file (there will be only one for
each request)
File extension “.rsp”
Example: abc00000002_2_1.rsp
Where:
abc Unique Colt assigned Service Profile
00000002 File sequence number
2 The Line Info of an individual CPS request within the Request file
1 Response number – the first response for the CPS request
B.5.8 File Naming – CPS Unsolicited Cease
Deutsche Telekom does not send unsolicited cease messages.
B.5.9 Header Record
Ref Identifier/ Field Name
MaxLength
Field Description / Notes
1 Header Id 1 H for Header
2Format
Description35
The type of Response file
Example: CPS Deactivation Response
3 Version 6 Format version must be 0.01.1
4 Creation Date 17 Current Date in format YYYYMMDD-hh:mm:ss
Table 18 - CPS Response Header RecordNote: Each field will be delimited by a semi-colon (;) and the line will end with a semi-
colon.
Colt Cocom FTP User Guide DE 7.4 51/ 74
B.5.10CPS Response Detail Record
Ref
Identifier/ Field Name
Data Type
MaxLength
M/O Default Field Description / Notes
1 Data
Record
Identifier
Alpha 1 Mandator
y
D D for data line
2 Request
Number
Numeric Variab
le
Mandator
y
Request Number
provided in the Request.
3 CLI Numeric 22 Mandator
y
CLI which has been
processed. Inherited from
Request.
4 Action Alpha 1 Mandator
y
Populated from the
corresponding original
ACTION value in CPS
Reseller Request Data
record.
For CLI/CPS requests &
CPS-only requests the
value is “C”.
For invalid action types
the value is “?”
5 Area code Numeric 6 Mandator
y
None City code provided in the
request
6 Caller
number
Numeric 9 Mandator
y
None Telephone number
provided in the Request
7 Date and
Time
Alphanume
ric
17 Mandator
y
None Date and time the
response was processed
8 Error code Integer Variab
le
Mandator
y
Cocom Error Code –
refer to: E.1.2 Request
Validation Codes
Colt Cocom FTP User Guide DE 7.4 52/ 74
Ref
Identifier/ Field Name
Data Type
MaxLength
M/O Default Field Description / Notes
9 Error text Alpha Variab
le
Mandator
y
Cocom Error Text – refer
to: E.1.2 Request
Validation Codes
10 PTT
Response
Code
Alpha Variab
le
PTT Error Code – refer
to:
E.2 PTT Reference Data
11 PTT
Response
Description
Alpha Variab
le
PTT Error Description –
refer to:
E.2 PTT Reference Data
Table 19 - CPS Response Detail RecordNote: Each field will be delimited by a semi-colon (;) and the line will end with a semi-
colon.
Colt Cocom FTP User Guide DE 7.4 53/ 74
B.5.11Trailer Record
Ref Identifier/ Field Name
MaxLength
Field Description / Notes
1 Trailer Id 1 T for Trailer
2Number of Detail
Lines3 Number of Detail Lines
3 Checksum 10
Value generated running Unix checksum on this
block’s data records. By default no checksum is
performed and the field is empty.
Table 20 - CPS Response Trailer RecordNote: Each field will be delimited by a semi-colon (;) and the line will end with a semi-
colon.
CPS Response File ExampleResponse message example - Activation:
This is the response from Deutsche Telekom for the 2nd CLI in the request file
“cab00000009.req”
File name:
cab00000009_2.rsp
Header line:
H;Cocom CPS Response;0.01.1;20041022-17:39:31;
Detail line(s):
D;2;02161307496;C;0216;1307496;20041022-17:39:31;0;OK
(Auftrag ausgeführt);0010;Auftrag ausgeführt;
Trailer line:
T;1;;
Colt Cocom FTP User Guide DE 7.4 54/ 74
CPS Response job file
Header Record{1 per file}
Detail Record{1 per file}
Trailer Record{1 per file}
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.
B.6.4 File/Message Structure
Figure 6 - CPS Response Job File Structure
Colt Cocom FTP User Guide DE 7.4 55/ 74
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:
ade00000001_17_1.rsp
B.6.6 Header Record
Ref Identifier/ Field Name
MaxLength
Field Description / Notes
1 Header Id 1 H for Header
2Format
Description35
The type of job file
e.g. Cocom CPS Response job file
3 Version 6 Format version must be 0.01.1
4 Creation Date 17Current Date in format YYYYMMDD-hh:mm:ss
Example: 20050410-13:42:27
Table 21 - CPS Response Job Header RecordNote: Each field will be delimited by a semi-colon (;) and the line will end with a semi-
colon.
B.6.7 Detail Record
Ref Identifier/ Field Name
MaxLength
Field Description / Notes
1Data Record
Identifier1 D for Detail
2Response File
name 22
Name of the associated Response file
Format: Dir/filename
Example: Response/ade00000001_17_1.rsp
3 Format 32Format of compression of the Request file. Should be text
value ‘plain’
Colt Cocom FTP User Guide DE 7.4 56/ 74
Ref Identifier/ Field Name
MaxLength
Field Description / Notes
4 Request Type 32Defines the type of Request:
CPS
Table 22 - CPS Response Job Detail RecordNote: Each field will be delimited by a semi-colon (;) and the line will end with a semi-
colon.
Trailer Record
Ref Identifier/ Field Name
MaxLength
Field Description / Notes
1 Trailer Id 1 T for Trailer
2Number of
lines3 Number of detail lines
3 Checksum 10
Value generated running Unix checksum on this block’s
data records. By default no checksum is performed and
the field is empty
Table 23 - CPS Response Job Trailer RecordNote: Each field will be delimited by a semi-colon (;) and the line will end with a semi-
colon.
B.6.8 CPS Response Job File Example
File name:
ade00000001.rsp
Header Record:
H;Cocom CPS Response Jobfile;0.01.1;20050417-15:32:47;
Detail Record:
D;response/ade00000001.rsp;plain;CPS;
Trailer Record:
T;1;;
Colt Cocom FTP User Guide DE 7.4 57/ 74
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 as single
messages or together.
Response file for Activate 06918273605 (successful):H;Cocom CPS Response;0.01.1;20041018-18:08:09;
D;1;06918273605;C;069;18273605;20041018-18:08:09;0;OK (Auftrag
ausgeführt);0010;Auftrag ausgeführt;
T;1;;
Response Job File:H;Cocom CPS Response Jobfile;0.01.1;20041018-18:08:09;
D;response/abc00000013_6_1.rsp;plain;CPS;
T;1;;
Response File for Activate 0694711 (interim positive response to indicate Preselection Ort or Fern will be activated later by Deutsche Telekom – no action required by you):
H;Cocom CPS Response;0.01.1;20041022-14:08:39;
D;2; 0694711;C;069;4711;20041022-00:00:00;-1;STATUS UPDATE (Der
Auftrag wird teilausgeführt);0006; Der Auftrag wird
teilausgeführt;
T;1;;
Response Job File:H;Cocom CPS Response Jobfile;0.01.1;20041022-14:08:39;
D;response/abc00000013_2_1.rsp;plain;CPS;
T;1;;
Response File for Activate 06946190 (failed):H;Cocom CPS Response;0.01.1;20041021-14:08:39;
D;3;06946190;C;069;46190;20041021-14:08:39;16;UNKNOWN ERROR (ONKZ
oder Rufnummer unbekannt);1000;ONKZ oder Rufnummer unbekannt;
T;1;;
Response Job File:H;Cocom CPS Response Jobfile;0.01.1;20041021-14:08:39;
D;response/abc000000013_3_1.rsp;plain;CPS;
T;1;;
Colt Cocom FTP User Guide DE 7.4 58/ 74
CLI/CPS RequestIn the example below - a combined CLI/CPS request was 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 Deutsche Telekom.
CLI Response File - Colt CLI processingH;Cocom Response Activation/Deactivation;0.01.1;20041018-12:41:54;
D;1;069520522;A;20041018-12:41:54;2;OBJECT ALREADY EXISTS (Direct
conflict with <069520522>);
D;2;069288662;A;20041018-12:41:54;0;OK (CPS pending);
D;3;069412890;A;20041018-12:41:54;0;OK (CPS pending);
T;3;;
Job File:H;Cocom Response Jobfile;0.01.1;20041018-12:41:54;
D;response/cab00000011.rsp;plain;CLI/CPS;
T;1;;
CPS Response File – 1st CPS request
Response file for 1st activation request to activate CPS on 069288662 (successful):
H;Cocom CPS Response;0.01.1;20041018-14:08:39;
D;1;069520522;C;069;520522;20041018-14:08:39;0;OK(Auftrag
ausgeführt);0010;Auftrag ausgeführt;
T;1;;
Job File:H;Cocom CPS Response Jobfile;0.01.1;20041021-14:08:39;
D;response/cab00000011_2.rsp;plain;CLI/CPS;
T;1;;
CPS Response File – 2nd CPS request
Response file for 2nd activation request in the list, to activate CPS on 069412890
(unsuccessful):
H;Cocom CPS Response;0.01.1;20041021-15:22:16;
D;3; 069412890;C;069;412890;20041021-15:22:16;16;UNKNOWN ERROR(Die
Anschrift ist nicht bekannt);1001; Die Anschrift ist nicht
bekannt;
T;1;;
Job File:
Colt Cocom FTP User Guide DE 7.4 59/ 74
H;Cocom CPS Response Jobfile;0.01.1;20041021-15:22:16;
D;response/cab00000011_3.rsp;plain;CLI/CPS;
T;1;;
CPS Response File – 3rd CPS request
Response file for 3rd activation request to activate CPS on 069520522 where Deutsche
Telecom respond with a revised CPS activation date:
H;Cocom CPS Response;0.01.1;20041018-14:08:39;
D;1;069520522;C;069;520522;20041018-14:08:39;-1;STATUS UPDATE(Der
Auftrag wird manuell bearbeitet. Die Bearbeitungszeit kann sich
daher verlängern);0070;Der Auftrag wird manuell bearbeitet. Die
Bearbeitungszeit kann sich daher verlängern;
T;1;;
Job File:H;Cocom CPS Response Jobfile;0.01.1;20041018-14:08:39;
D;response/cab00000011_1.rsp;plain;CLI/CPS;
T;1;;
CPS Response File – 3rd CPS request
Response file for 3rd activation request to activate CPS on 069520522 where Deutsche
Telecom respond with a revised CPS activation date:
H;Cocom CPS Response;0.01.1;20041019-14:11:39;
D;1;069520522;C;069;520522;20041019-14:11:39;-1;STATUS UPDATE(Der
Ausführungstermin wurde von Telekom manuell geändert
(verbindlicherLiefertermin = 2004-12-05));0005;Der
Ausführungstermin wurde von Telekom manuell geändert
(verbindlicherLiefertermin = 2004-12-05);
T;1;;
Job File:H;Cocom CPS Response Jobfile;0.01.1;20041019-14:11:39;
D;response/cab00000011_1.rsp;plain;CLI/CPS;
T;1;;
CPS Response File – 3rd CPS request
Response file for 3rd activation request to activate CPS on 069520522 where Deutsche
Telecom confirm CPS has been activated:
H;Cocom CPS Response;0.01.1;20041025-14:10:39;
D;1;069520522;C;069;520522;20041025-14:10:39;0;OK(Auftrag
ausgeführt);0010; Auftrag ausgeführt;
Colt Cocom FTP User Guide DE 7.4 60/ 74
T;1;;
Job File:H;Cocom CPS Response Jobfile;0.01.1;20041025-14:10:39;
D;response/cab00000011_1.rsp;plain;CLI/CPS;
T;1;;
Colt Cocom FTP User Guide DE 7.4 61/ 74
Error
Detail Record{Exactly 1}
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:
abc00000001.req-> abc00000001.req.failed
abc00000001.req.job -> abc00000001.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
Figure 7 - Error File Structure
Colt Cocom FTP User Guide DE 7.4 62/ 74
C.1.5 File Name
The file name is formatted by appending “.error” at the end of the original request file
Example:
abc00000001.req-> abc00000001.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
nameAlphanumeric 11 Request file name
2 Date of Error Timestamp 17Date Format:
DD.MM.YYYY HH:MM:SS
3 Error Code Alphanumeric 10
Error code maintained by Cocom
“Error “ + errCode + “:”Example:
Error 10: See Details E.1.1File Validation Codes
4Error
MessageInteger 80
Error Text Example:
Version number is incorrect
See Details E.1.1File Validation Codes
Table 24 - Error Detail RecordNote: Each field will be delimited by a semi-colon (;) and the line will end with a semi-
colon.
C.1.7 File Error Example
File name:
abc00000001.req.error
Detail Record(s):
abc00000001 30.04.2004 11:31:11 Error 10: Version number is incorrect
Colt Cocom FTP User Guide DE 7.4 63/ 74
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
Please note that 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.
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.
Colt Cocom FTP User Guide DE 7.4 64/ 74
D.1.4 File Name
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
14 Reseller VoIP Connect
Example:
de_abc_01_0001_20101208090122.cdr.gz
Colt Cocom FTP User Guide DE 7.4 65/ 74
D.2 Call Detail Record Format
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.
2Destination
(Terminating)20 21 N
Destination 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
9Trunk
incoming25 93 N Internal use only
10 Trunk outgoing 25 118 N Internal use only
11 Account Code 20 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 N Not in use
15Service
Indicator4 181 N
0000 for standard calls, 0001 for ISDN
calls
16Charged (C-
Num)20 185 N Not in use
17 Dialled (D- 20 205 N Not in use
Colt Cocom FTP User Guide DE 7.4 66/ 74
Num)
18 Carrier 3 225 AThe Reseller profile of up to 3
alphanumerics
19 End of Record 1 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 25 - Call Detail Record Format
D.3 Sample Call Detail Record
06960621234 069566061234012011011911481500000000401 00067
6960621234 0000 069566061234AAX0
06960621234 017622211234012011011911514400000008401 00067
6960621234 0000 017622211234AAX0
06960621234 0625271234012011011911543300000002801 00067
6960621234 0000 0625271234AAX0
D.4 Consolidated CDR Request
This 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.
Colt Cocom FTP User Guide DE 7.4 67/ 74
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.
Please note: In Germany, the header and trailer records will no longer appear in the
unrated CDR file. They will appear as a single file in the “jobout” FTP-folder
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 50: Consolidated CDR request - Select profile
Colt Cocom FTP User Guide DE 7.4 68/ 74
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
Figure 51: 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 52: Consolidated CDR Request: Transaction Result
D.5 Consolidated CDR Download
Within 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.
Colt Cocom FTP User Guide DE 7.4 69/ 74
3 4 5
6
34
5
6
D.6 Consolidated CDR File Format
All 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 D1 – D3.
Colt Cocom FTP User Guide DE 7.4 70/ 74
Appendix E Reference Data
E.1 Cocom Reference Data
E.1.1 File Validation Codes
The following table lists the potential error codes that may result from File level errors:
Code Field Description / Notes Additional Information
-1 Unable to process your request:
Unrecognized Sender/Receiver -
Unknown Document Type
There is a connectivity problem between CoCom
and a Colt integration server. Please contact
Customer Services.
1 Too many CLIs for one Request.
Number must be no more than {500}
3 Sequence number too low, 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 4.1Overview). Please
resend the files by putting the job files one after
the other into the jobin directory.
4 Sequence number too high, the
expected sequence number is {n}
6 Wrong header format
8 Wrong trailer format
10 Version number is incorrect Version number in file is not 0.01.1 (for Germany
only, for other countries, version needs to be
0.02.1)
Cocom-SG-EN-FR-25-01-2016-v01.9 71 / 89
Code Field Description / Notes Additional Information
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 ASCII.
12 Job file does not exist or is
unreadable
Follow-up action is dependent on the error code:
12 2;OBJECT ALREADY EXISTS (cli is
already activated)
As long as a CLI-activation process is pending
(error message: 2 object already exists cli is
already activated), no other action on this CLI
will be processed. All actions send during this
time will be rejected and have to be sent again.
12 2;OBJECT ALREADY EXISTS (cli
already active)
If a CLI is already active this warning message
will be send for a CLI/CPS request, but not for a
CPS-Request, but the CPS-part will be
processed in for CPS and CLI/CPS-requests.
18 Wrong data format in job file
<Error details describing which field
in which record has failed>
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. These issues may occur if you transfer
data between different operating systems like
Windows and UNIX. For a sample error code
please look below this table.
18 Wrong data format in request file
<Error details describing which field
in which record has failed>
99 Please contact the customer support
to reset your sequence number
immediately!
Sequence number of file reached 99999999
Cocom-SG-EN-FR-25-01-2016-v01.9 72 / 89
Table 26 - File Level ErrorsSample Error Format for Error Code 18:cs00000002 15.03.2011 02:49:48 Error 18 : Wrong data format in request file
Flat file schema validation failed. Error received for Record No 2,Record
Reference D , field JobDate at position 4 is: String
could not be formatted properly. 14032011-17:46:43 is either an invalid
date or doesn't meet the format: yyyyMMdd-HH:mm:ss.
Error received for Record No 3,Record Reference D , field JobDate at
position 4 is: String could not be formatted properly. 14
032011-17:46:43 is either an invalid date or doesn't meet the format:
yyyyMMdd-HH:mm:ss.
Cocom-SG-EN-FR-25-01-2016-v01.9 73 / 89
E.1.2 Request Validation Codes
The 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
Explanation
0 ok Comment: Activated
for Action Change
CLI The requested action has been
successfully completed
Ok CPS
pending
CPS
CLI/CPS
CLI activation has been successfully
completed, CPS request is pending
-1 Status
Update
CPS
CLI/CPS
Interim response sent by Deutsche
Telekom, no action required by you.
1 Data out
of range
CLI is invalid. ALL The format of CLI is invalid. CLI must
be a number (min 5 digits, max 22
digits)
Action is invalid. ALL Invalid Action for provisioning was
requested (only A, D, M, C, see A.3.1
Action Types)
Job Date is invalid. ALL The date format is wrong. (The
previous system was lenient in
accepting invalid dates).
Customer
RequestDate is
Invalid.
CPS
CLI/CPS
Possible Causes of Error – Wrong
Data Format supplied for Carrier
Preselection.
CPS Level is Invalid CPS
CLI/CPS
CPS Level is wrongly specified
Cocom-SG-EN-FR-25-01-2016-v01.9 74 / 89
Invalid area Code CPS
CLI/CPS
Area Code is missing or invalid
Invalid Caller
Number
CPS
CLI/CPS
Caller Number missing or invalid
Range Start is invalid CPS
CLI/CPS
Range Start is not a number (see
Format description A.1.3Detail
Records)
Range End is invalid CPS
CLI/CPS
Range end is not a number (see
Format description A.1.3Detail
Records)
PartyName is Invalid CPS
CLI/CPS
Missing Party name
Building Number is
Invalid
CPS
CLI/CPS
Building Number missing or invalid
Street is invalid CPS
CLI/CPS
Missing a value for Street
Postal Code is
invalid
CPS
CLI/CPS
Missing a value for Postal Code field
City is invalid CPS
CLI/CPS
Missing a value for City field
2 object
already
exists
CPS Pending, CLI
already active
CLI/CPS CLI is already active, however CPS is
pending
best match conflict
with cli <cli>ALL 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 75 / 89
direct conflict with cli
<cli>ALL The CLI is already provisioned and has
been tried to provisioned again. The
request could have been submitted
also 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 is already
activated
CLI A CLI activation has already been send
and is now in process
cli already activated
by modify
CLI A CLI activation has already been send
by a modify command and is now in
process
Account of cli has
been modified
ALL Will be send if and only if there is a
pending modify request on the cli the
Reseller requested a deactivate for
AND the modify has been issued by a
different Reseller
original account for
cli has changed
ALL Will be send if and only if there is a
pending modify request on the cli the
Reseller requested to activate for.
Could not process
current request -
Pending CPS
request
CPS
CLI/CPS
Will be sent in case the Reseller
requests any action on a CLI while
there is a CPS request that is either
still pending in Cocom which was sent
in the last 7 days OR no final response
has been received from the PTT. More
information provided below this table.
Cocom-SG-EN-FR-25-01-2016-v01.9 76 / 89
Account <account>
cannot modify its
own cli
CLI Reseller has tried to modify a CLI
which has already been assigned to
him
8 object
does not
exist
Best match conflict
with cli <cli>CLI The CLI or the number range is active
on the own or another account
CLI A deactivation request has been send
for a CLI which is not active
Account of cli has
been modified
ALL
range not available ALL
No CPS found for
action DEACTIVATE
CPS
CLI/CPS
Account <account>
does not exist.
ALL
Account <account>
cannot submit CPS
requests for CLI of
another account
(best match)
CPS
CLI/CPS
Reseller has not sufficient rights or
privileges to process the requested
action
Account <account>
cannot submit CPS
requests for CLI of
another account
(direct conflict)
CPS
CLI/CPS
Account <account>
cannot deactivate cli
of another account
ALL
16 Unknown
error
Account is locked ALL
account is not
allowed to activate
ALL
Cocom-SG-EN-FR-25-01-2016-v01.9 77 / 89
account is not
allowed to deactivate
ALL
account is not
allowed to modify
ALL
Modify between
Voice and VoIP not
allowed
CLI Reseller tried to modify a CLI from a
Voice ID (Reseller Voice connect) to a
VoIP ID (Reseller VoIP connect) or
CLI from VoIP ID to Voice ID.
account is not
allowed to perform a
CPS activate
CPS
CLI/CPS
Table 27 - Cocom Validation Codes and Text
Message
Code
Message
Type Message Description
Explanation
0 B2BGateway Success Message/OK
-1 B2BGateway
Unable to process your request
[additional explanation]
Validation Failed, e.g.
Infrastructure Error from
Cocom, missing request
file, wrong characters
0 cocom OK – Success
99 Cocom Cannot process your request! No connection between
Cocom-SG-EN-FR-25-01-2016-v01.9 78 / 89
Please Note: A CPS request will be successfully validated and sent to DTAG, even if the CLI was pre-selected successfully in the past. This is due to the fact that CPS deactivation requests may have been sent direct to DTAG, since the original CPS request.
Please contact customer
service support!
B2B Gateway and
Cocom
Table 28 – B2B Gateway error Codes
Cocom-SG-EN-FR-25-01-2016-v01.9 79 / 89
E.2 PTT Reference Data
The following tables are from documents produced by the Deutsche Telekom.
E.2.1 Interim status codes
These response codes reflect the interim status from Deutsche Telekom and do not require
any action from you in Cocom.
Error Code
Description Explanation
0000 Keine Änderung zum Auftrag Der Auftrag wird regulär weiterbearbeitet.
Kein Handlungsbedarf.
0002 Der Kundenwunschtermin liegt
ausserhalb des betrieblich
möglichen Zeitrahmens oder ist
kein vertraglicher Arbeitstag.
(verbindlicherLiefertermin = 2015-
05-21)
Der neue Ausführungstermin kann folgende Gründe haben:
- Bei DSL: Kundenwunschtermin (KWT) unterschreitet die
Mindestvorlaufzeit gemäß Dienstvertrag
- Es wurde ein nicht vertraglich vereinbarter Arbeitstag
ausgewählt
- Die Vorlaufzeit bis zur Lieferung ist betrieblich nicht
ausreichend
Der verbindliche Liefertermin wird entsprechend angepasst
und übermittelt.
Kein Handlungsbedarf.
0003 Telekom hat zum
Kundenwunschtermin keine
ausreichenden Kapazitäten
(verbindlicherLiefertermin = 2015-
05-21)
Es liegen keine ausreichenden personellen oder
technischen Ressourcen zum Kundenwunschtermin (KWT)
vor. Daher wird der nächstmögliche Termin übermittelt.
Das Verhalten ist für Standardaufträge und
Terminverschiebungen identisch.
Kein Handlungsbedarf.
0005 Der Ausführungstermin wurde von
Telekom manuell geändert
(verbindlicherLiefertermin = 2014-
05-21)
Es handelt sich um eine Terminanpassung durch die
Telekom (z.B. im Rahmen eines Projektes). I.d.R. wird der
neue Termin mit dem Provider abgestimmt.
Aufgrund technischer Hindernisse erfolgt eine manuelle
Terminänderung heute auch ohne Abstimmung mit dem
Provider.
Kein Handlungsbedarf.
Cocom-SG-EN-FR-25-01-2016-v01.9 80 / 89
Error Code
Description Explanation
0006 Der Auftrag wird teilausgeführt Nur ein Teil der beauftragten Produkte kann bereitgestellt
werden. Die bereitgestellten Produkte sind Bestandteil der
ABM.
Beispiel:
Bestellung von Preselection Ort und Preselection Fern. Ist
das Produkt Preselection Ort mit „Teilausführung zulassen“
gekennzeichnet, aber Preselection Ort nicht möglich, wird
Preselection Fern dennoch bereitgestellt. Ist
„Teilausführung zulassen“ nicht gekennzeichnet, wird der
gesamte Auftrag abgelehnt.
Kein Handlungsbedarf.
0070 Der Auftrag wird manuell bearbeitet.
Die Bearbeitungszeit kann sich
daher verlängern.
Kein Handlungsbedarf.
Table 29 Deutsche Telekom Interim Status Update Result Codes
E.2.2 Positive Result Code
Error Code
Description Explanation
0010 Auftrag ausgeführt Kein Handlungsbedarf.
Table 30 Deutsche Telekom Positive Result Code
E.2.3 Negative Result Codes
Error Code
Description Explanation
1000 ONKZ oder Rufnummer unbekannt. Zum Identifikator für die Bestandssuche über die
ONKZ/Rufnummer oder Rechnungsnummer (bei
Anlagenanschlüssen) ist kein Bestand bei der Telekom
vorhanden.
Cocom-SG-EN-FR-25-01-2016-v01.9 81 / 89
Error Code
Description Explanation
1001 Die Anschrift ist nicht bekannt. Die übermittelte Anschrift wurde überprüft und konnte nicht
eindeutig plausibilisiert werden.
Falls in der ABBM das Meldungsattribut „Standort A korrekt“
befüllt ist, dann validieren Sie bitte die vorgeschlagene
Adresse mit dem Endkunden und senden Sie den Auftrag
erneut.
Ansonsten überprüfen Sie die Adressdaten und senden Sie
den Auftrag erneut.
1002 Straßenname ist unbekannt Der im Standort A übergebene Straßenname ist bei der
Deutschen Telekom nicht referenziert.
1003 Der Kundenwunschtermin liegt
außerhalb des zulässigen
Zeitrahmens.
Sie haben die maximale Vorlaufzeit überschritten.
Bitte geben Sie einen Kundenwunschtermin (KWT) an, der
innerhalb der zulässigen Vorlaufzeit liegt, und stellen Sie
den Auftrag erneut ein.
1004 Es liegt eine Kündigung des
Anschlusses oder eine
Rufnummernänderung am
Anschluss vor.
Der Meldungscode wird nur verwendet wenn der Endkunde
einen Bestand (Rufnummer oder Anschluss) bei der
Telekom unterhält.
ERLM: Der Endkunde hat seinen Telekomanschluss
gekündigt, wodurch die Telekom die Kündigung des DSL
des Providers angestoßen hat. Die Erledigung der DSL-
Kündigung wird über die ERLM mitgeteilt.
ABBM: Der Anschluss, auf den sich der Auftrag bezieht, ist
bereits durch den Endkunden bei der Telekom gekündigt
worden. Der Kündigungsauftrag ist noch nicht ausgeführt.
Der Ausführungstermin der Kündigung liegt zeitlich vor dem
Kundenwunschtermin des Providerauftrags.
Cocom-SG-EN-FR-25-01-2016-v01.9 82 / 89
Error Code
Description Explanation
1006 Der Auftrag ist derzeit nicht
möglich. Es wurden Änderungen
am Anschluss beauftragt. Das
beauftragte Produkt kann erst nach
Erledigung dieses Auftrags erteilt
werden.
Es ist noch ein offener Auftrag der Telekom zu diesem
Anschluss vorhanden. Ein neuer Auftrag darf frühestens 1
Tag nach dem mitgelieferten Erledigungsdatum des offenen
Auftrags eingestellt werden..
Der MC tritt auch in folgenden Fällen auf:
-die Telekom hat bereits einen Wechselwunsch des
Endkunden zur Telekom erfasst. Bitte reagieren Sie in
diesem Fall auf die Portierungsanzeige beim
Portierungskennungsinhaber. Eine Kündigung ist nicht mehr
notwendig.
- der Endkunde hat bereits bei der Telekom seinen
Anschluss gekündigt, die Kündigung ist noch nicht
ausgeführt, kann aber nicht mehr storniert werden. Bitte
stellen Sie anstelle eines Auftrags mit dem Gf VBL einen
Auftrag mit Gf NEU unter Angabe der Vormieterdaten ein.
Sollte kein offener Auftrag vorliegen, kontaktieren Sie vor
erneutem Einstellen des Auftrags bitte das Clearing-Team.
1007 Bei dem vorliegendem
Geschäftsfall ist das
Änderungskennzeichen für dieses
Produkt nicht zulässig.
Die Änderungskennzeichen „Storno“ und
„Terminverschiebung“ sind vertraglich nicht für diese
Produkt-Geschäftsfall-Kombination vereinbart.
Bitte stellen Sie für den betroffenen Auftrag die vertragliche
Grundlage sicher.
Cancel CPS request is not possible in Cocom
1008 Die bestellte Konfiguration besteht
bereits.
Bitte prüfen Sie Ihre Bestandssituation.
1010 Es ist bereits Bestand des
Auftraggebers vorhanden.
Es liegt eine Beauftragung zu einem bereits bestehenden
Bestand vor.
Möglicherweise ist die angegebene Vertragsnummer nicht
korrekt.
Cocom-SG-EN-FR-25-01-2016-v01.9 83 / 89
Error Code
Description Explanation
1012 Es liegt bereits ein Auftrag für
diesen Anschluss vor. Ihr Auftrag
kann erst nach Erledigung des noch
offenen Auftrags erteilt werden.
Es ist noch ein offener Auftrag eines anderen Providers zu
diesem Anschluss vorhanden. Bitte stellen Sie den neuen
Auftrag frühestens 1 Tag nach dem mitgelieferten
Erledigungsdatum des offen Auftrags ein.
Der MC tritt auch auf, wenn ein weiterer
Anbieterwechselauftrag in WITA vorliegt. Bitte beantworten
Sie in diesem Fall zunächst die vorliegende AKM-PV
1013 Externe Auftragsnummer ist nicht
eindeutig oder nicht korrekt
Die externe Auftragsnummer darf nur exklusiv je Auftrag
verwendet werden. Ausgenommen hiervon sind
Stornierungs- und Terminverschiebungsaufträge.
Bitte überprüfen Sie, ob die entsprechende
Auftragsnummer bereits verwendet wurde bzw. ob diese
korrekt ist.
1018 Der Besteller ist nicht berechtigt für
den Kunden zu bestellen
Eine Bestellung im Auftrag Dritter ist nur möglich, wenn
entsprechende Vollmachten dazu vorliegen.
Bitte überprüfen Sie, ob eine Vollmacht vorliegt bzw.
beauftragen Sie die Mandantenfunktion.
Bei AUS-BUE ist die Bestellung im Namen Dritter nicht
vorgesehen.
1020 Das Zeitfenster ist nicht vereinbart Es können nur (Sonder-) Zeitfenster gebucht werden, für
die eine Vereinbarung vorliegt.
Bitte überprüfen Sie Ihre vertraglich vereinbarten (Sonder-)
Zeitfenster, und senden Sie den Auftrag erneut
Ab OSS Version 7.00 ist die Angabe des Zeitfensters Pflicht
1021 Der Auftrag wurde nicht korrekt
verarbeitet. Versuchen Sie es zu
einem späteren Zeitpunkt noch
einmal
Der Auftrag ist bei der Bearbeitung in eine Fehlersituation
gelaufen, die sich durch Neuerteilung des Auftrags lösen
lässt.
Stellen Sie den Auftrag am Folgetag erneut ein. Sollte diese
Fehlermeldung dann erneut kommen, kontaktieren Sie bitte
das Clearingteam (Colt Reseller Support).
Cocom-SG-EN-FR-25-01-2016-v01.9 84 / 89
Error Code
Description Explanation
1023 Ihr Auftrag ist derzeit aus
technischen Gründen nicht
bearbeitbar. Bitte versuchen Sie es
zu einem späteren Zeitpunkt erneut
Bitte übermitteln Sie den Auftrag zum angegebenen
Wiedervorlagetermin erneut.
Sofern kein Wiedervorlagetermin mitgesendet werden
konnte, stellen Sie den Auftrag frühestens am Folgetag
erneut ein (Empfehlung 3 AT nach Erhalt der ABBM).
1031 Die Anlage enthält einen maliziösen
Code
Die Anlage ist möglicherweise virenbehaftet.
Bitte überprüfen Sie die Anlage auf Viren und übermitteln
Sie den Auftrag inklusive Anhang erneut.
1033 Termin für Anbieterwechsel vor
einem arbeitsfreien Tag ist nicht
möglich
Aufträge im Anbieterwechsel mit Geschäftsfall
Verbundleistung, Providerwechsel und NEU mit
Vorabstimmungs-ID mit einem KWT auf einen Tag vor
einem arbeitsfreien Tag (z.B. Samstag oder Arbeitstag vor
einem Feiertag) werden abgelehnt (gemäß Vorabstimmung
und Spezifikation Anbieterwechsel).
Bitte stellen Sie einen erneuten Auftrag mit einem
korrektem Terminwunsch ein.
1051 Der Auftrag ist bei vorhandener
Bestandssituation nicht möglich
Betrifft Storno und Terminverschiebung:
Ein Storno bzw. eine Terminverschiebung ist erst nach
Versendung einer QEB zum Ursprungsauftrag möglich.
Bitte warten Sie diese ab und senden Sie dann den Storno
bzw. die Terminverschiebung erneut.
Der Ursprungsauftrag konnte nicht gefunden werden.
1086 Kundenauftrag ist nicht stornierbar,
da Stornierung bereits angestoßen.
Es wurde bereits eine Stornierung eingestellt.
Kein Handlungsbedarf.
Cancel CPS request is not possible in Cocom
Cocom-SG-EN-FR-25-01-2016-v01.9 85 / 89
Error Code
Description Explanation
1087 Eine Stornierung ist nicht möglich. Der Stornoabbruch kann verschiedene Ursachen haben:
Die Buchung des Ursprungsauftrags ist in den IT-Systemen
der Telekom bereits so weit fortgeschritten, dass keine
Stornierung des Auftrags möglich ist.
Ursprungsauftrag ist bereits abgebrochen: Eine Stornierung
ist bei einem bereits abgebrochenem Auftrag nicht mehr
möglich. Keine Handlungsmöglichkeit.
Cancel CPS request is not possible in Cocom
1089 Der Auftrag wurde bereits
durchgeführt. Eine Stornierung ist
nicht mehr möglich.
Bitte warten Sie die ENTM ab und kündigen Sie dann den
Bestand des entsprechenden Einzelvertrags.
Keine Handlungsmöglichkeit.
Cancel CPS request is not possible in Cocom
1102 Produkt oder Geschäftsfall nicht
zulässig
Bitte wählen Sie ein anderes Produkt, das den vertraglichen
Vereinbarung entspricht, und stellen Sie den Auftrag erneut
ein. Bzw. stellen Sie die vertragliche Grundlage für den
Auftrag sicher. Hierzu kontaktieren Sie bitte den
Carriermanager.
Im GF AUS-BUE: Bitte wählen Sie einen anderen
Dienstvertrag/ Leistungsnummer, da die gewählte
Leistungsnummer nicht vereinbarte Produkte für diesen GF
beinhaltet.
1193 Der juristische Nachfolger (Erbe)
kündigt das Vertragsverhältnis
Der Endkunde ist verstorben. Der juristischem Nachfolger
des Endkunden hat das Vertragsverhältnis gekündigt Es ist
daher nicht mehr möglich, den noch nicht ausgeführten
Auftrag auszuführen. Bei Fragen nehmen Sie bitte mit dem
juristischem Nachfolger des Endkunden Kontakt auf.
1194 Der Endkunde verweigert die
Herstellung
Der Endkunde hat der Telekom Deutschland untersagt die
Leitung herzustellen, oder der Zugang zum APL wird
verweigert
Bitte nehmen Sie Kontakt mit Ihrem Endkunden zur Klärung
des konkreten Sachverhalts auf.
Cocom-SG-EN-FR-25-01-2016-v01.9 86 / 89
Error Code
Description Explanation
1195 Der Insolvenzverwalter des
Endkunden kündigt das
Vertragsverhältnis
Der Endkunde hat Insolvenz angemeldet. Der
Insolvenzverwalter des Endkunden hat das
Vertragsverhältnis gekündigt Es ist daher nicht mehr
möglich, den noch nicht ausgeführten Auftrag auszuführen.
Bei Fragen nehmen Sie bitte mit dem Insolvenzverwalter
Kontakt auf.
1196 Der Endkunde kann die beauftragte
Leistung nicht mehr abnehmen
Der Telekom Deutschland ist es aus Gründen die beim
Endkunden zu suchen sind nicht mehr möglich den Auftrag
auszuführen.
Gründe die nicht mit anderen MC abgedeckt sind.
Bitte nehmen Sie Kontakt mit Ihrem Endkunden zur Klärung
des konkreten Sachverhalts auf.
1199 Die Voraussetzung für die
Bereitstellung ist nicht mehr
gegeben. Der Auftrag wurde
abgebrochen.
Der Endkundenwunsch kann nicht realisiert werden.
Beispielsweise ist das Produkt auf der vorhandenen
technischen Infrastruktur nicht bereitstellbar.
Keine weiteren Handlungsmöglichkeiten.
2001 Die Leistungsnummer ist nicht
plausibel oder nicht eindeutig
Der angegebenen Leistungsnummer kann kein
Dienstvertrag zugeordnet werden.
Bitte prüfen Sie die Leistungsnummer und stellen den
Auftrag mit geänderter Leitungsnummer neu ein.
2004 Der Eingangskanal ist nicht
zulässig.
Bitte überprüfen Sie den gewählten Eingangskanal
hinsichtlich der vertraglich vereinbarten Eingangskanäle,
und stellen Sie den Auftrag über den zulässigen
Eingangskanal erneut ein.
5500 Der Anschlussinhaber ist falsch Der Anschlussinhaber ist unter der Rufnummer nicht in den
Systemen der Telekom geführt. Bei Preselection erfolgt
keine AKM-PV. Information kann aus diesem Grund nicht
übergeben werden.
Bitte überprüfen Sie den Anschlussinhaber, und stellen Sie
den Auftrag erneut ein.
Table 31 Deutsche Telekom Negative Result Codes
Cocom-SG-EN-FR-25-01-2016-v01.9 87 / 89
E.2.4 Negative Result Codes
These are system failure errors. Please contact Colt Reseller Support if you receive any of
these error messages.
Error Code
Description Explanation
0987 Ein angegebener
Produktbezeichner ist ungültig
Der angegebene Produktbezeichner ist nicht in der
Produktbezeichner-Tabelle der genutzten
Orderschnittstellenversion enthalten.
Bitte überprüfen Sie die Schreibweise. Ggf. ist eine andere
Orderschnittstellenversion erforderlich um das gewünschte
Produkt bestellen zu können..
0990 Funktion aktuell nicht unterstützt,
Freigabe wird gesondert bekannt
gegeben
Betrifft die Funktionen/Attribute, die in der aktuellen
Orderschnittstellenversion beschrieben sind, aber erst zu
einem späteren Zeitpunkt freigeschaltet werden.
0991 Die parametrisierte Lastobergrenze
ist erreicht, bitte versuchen Sie es
zu einem späteren Zeitpunkt erneut.
Der Auftrag wurde nicht oder nicht vollständig
entgegengenommen.
Bitte stellen Sie den Auftrag zu einem späteren Zeitpunkt
erneut ein
0993 Versionsnummer fehlerhaft Die angegebene Versionsnummer der genutzten
Orderschnittstelle passt nicht zur vertraglichen
Vereinbarung.
Bitte überprüfen Sie die technischen Einstellungen ihrer
Schnittstelle unter Beachtung der vertraglichen
Vereinbarung und stellen Sie den Auftrag erneut ein.
0995 Datenstruktur ungültig Die Datenstruktur des Auftrags ist fehlerhaft. Der Auftrag
wurde nicht vollständig übermittelt oder das Zielprodukt ist
mit dem gewählten Geschäftsfall nicht kombinierbar.
Stellen Sie sicher, dass das Format und der Inhalt des
Auftragsdokumentes der vereinbarten
Schnittstellenbeschreibung entsprechen, nehmen Sie
Korrekturen vor und stellen Sie den Auftrag erneut ein.
Cocom-SG-EN-FR-25-01-2016-v01.9 88 / 89
Error Code
Description Explanation
0996 Dokumententyp der Anlage ist
unzulässig
Es wurde ein Dokumententyp in der Anlage verwendet der
gemäß Beschreibung der OSS nicht vorgesehen ist.
Bitte überprüfen Sie den Dokumententyp der Anlage und
ändern diesen in einen zugelassenen Typ. Senden Sie den
Auftrag dann erneut.
0999 Technischer Fehler Ein nicht näher spezifizierter Fehler wurde während der
Bearbeitung des Auftrages erkannt.
Bitte überprüfen Sie die technischen Einstellungen ihrer
Schnittstelle unter Beachtung der vertraglichen
Vereinbarung und stellen Sie den Auftrag erneut ein. Sofern
dies nicht erfolgreich ist, kontaktieren Sie das Clearing-
Team.
Table 32 Deutsche Telekom Negative System Failure Code
Cocom-SG-EN-FR-25-01-2016-v01.9 89 / 89