Cocom FTP and Web ManagerUser Guide for Carrier VoIP
Version: 1.8
Date Written: 08.03.2017
Table of Contents
1 Introduction...............................................................................................................................6
2 Cocom FTP................................................................................................................................6
2.1 Overview.............................................................................................................................6
2.2 Directory structure...............................................................................................................7
2.3 CDR Files............................................................................................................................9
2.4 Consolidated CDR Request..............................................................................................10
2.5 Consolidated CDR Download...........................................................................................12
2.6 Consolidated CDR File Format:........................................................................................12
2.7 Maintenance and support.................................................................................................13
3 Cocom Web Manager.............................................................................................................13
3.1 Overview...........................................................................................................................13
3.2 System requirements........................................................................................................13
3.3 Using Cocom web manager..............................................................................................14
3.3.1 Login To Colt Online Application...............................................................................14
3.3.2 Access To Cocom Web Manager..............................................................................15
3.3.3 Welcome Page On Cocom Web Manager................................................................16
3.4 CDR Delivery....................................................................................................................17
3.4.1 CDR File Delivery and Naming Convention..............................................................17
3.4.2 CDR Download..........................................................................................................20
3.4.3 CDR File Format.......................................................................................................21
3.4.4 Consolidated CDR Request......................................................................................21
3.4.5 Consolidated CDR Search........................................................................................23
3.4.6 Consolidated CDR Download....................................................................................23
3.4.7 Consolidated CDR File Format:................................................................................24
3.5 View Reseller Data............................................................................................................25
Carrier VoIP User manual_v1.8 2
3.6 Documents........................................................................................................................27
3.6.1 User Guides...............................................................................................................27
3.6.2 VPN Access...............................................................................................................27
3.7 Cocom Web Manager Exit................................................................................................28
4 Maintenance & Support..........................................................................................................29
5 Glossary..................................................................................................................................29
6 Appendix A: CDR File for all countries other than Germany.............................................31
6.1 CDR File Format...............................................................................................................31
6.1.1 Character Coding......................................................................................................31
6.1.2 File Mark-up Coding..................................................................................................31
6.1.3 Compression/Decompression Algorithms.................................................................31
6.1.4 File Name..................................................................................................................31
6.2 Call Detail Record Format.................................................................................................33
6.3 Sample Call Detail Record................................................................................................34
7 Appendix B: CDR File of Germany........................................................................................35
7.1 CDR File Format...............................................................................................................35
7.1.1 Character Coding......................................................................................................35
7.1.2 File Mark-up Coding..................................................................................................35
7.1.3 Compression/Decompression Algorithms.................................................................35
7.1.4 File Name..................................................................................................................35
7.2 Call Detail Record Format for Germany............................................................................37
7.3 Sample Call Detail Record for Germany...........................................................................38
8 Appendix C: Colt Error codes...............................................................................................38
9 Appendix D: Country Codes..................................................................................................39
Carrier VoIP User manual_v1.8 3
Table of Figures
Figure 1 - Consolidated CDR request - Select profile......................................................................10
Figure 2 - Consolidated CDR Request.............................................................................................11
Figure 3 - Consolidated CDR Request: Transaction Result.............................................................11
Figure 4 - Colt Online Login Screen.................................................................................................14
Figure 5 - Colt Online Welcome Screen..........................................................................................15
Figure 6 - Web Manager Welcome Screen...................................................................................16
Figure 7 - Search Profile Screen...................................................................................................19
Figure 8 - CDR Search Screen......................................................................................................19
Figure 9 - CDR List Screen............................................................................................................20
Figure 10 - CDR Download Screen...............................................................................................20
Figure 11 - Consolidated CDR request - Select profile....................................................................21
Figure 12 - Consolidated CDR Request...........................................................................................22
Figure 13 - Consolidated CDR Request: Transaction Result...........................................................22
Figure 14 - Consolidated CDR Search.............................................................................................23
Figure 15 - Consolidated CDR Download (1)...................................................................................24
Figure 16 - Consolidated CDR Download (2)...................................................................................24
Figure 17 - View Reseller Data........................................................................................................26
Figure 18 - User Guides Screen......................................................................................................27
Figure 19 - Help – VPN Access Screen...........................................................................................28
Figure 20 – User guide...................................................................................................................28
Carrier VoIP User manual_v1.8 4
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.
Version
Issue Date Description of change from previous version
1.0 09-Oct-08 First version of user manual
1.1 16-Nov-11 Updated to reflect enhanced Cocom
1.2 20-Jan-12 Updated to reflect new consolidated CDR feature
1.3 05-Nov-12 Updated with details of Contact Centre Services
1.4 22-Nov-12 Updated with details of Number Hosting Services
1.5 22-Jul-15 Updated to reflect the UK & FR Regulatory impacts on the unrated
CDRs for calls to non-geographic numbers.
1.6 09-dec-15 Updated to Reflect the new COLT logo and browser related
information
1.7 02-Mar-17 Replaced VoIP Access with SIP Trunking, change in the notification
period for planned maintenance work in section 4,addition of new
countries in section 9
1.8 08-Mar-17 We now support an enhanced ISDN service over SIP, which is a next
generation version of Voice Line. Unrated CDRs for Voice Line (v) will
be available under “IP Voice Line” in Cocom.
Carrier VoIP User manual_v1.8 5
1 IntroductionColt Technology services (Colt) has provided you with an electronic interface for the daily transfer of call detail records (CDR).This system is referred to as Cocom.
FTP
This interface allows you to retrieve the CDRs resulting from your end-customers’ traffic within the Colt network.
This document describes the process of how to successfully retrieve CDR files from Colt.
Cocom Web Manager
Cocom Web Manager is a Graphical User Interface (GUI) and enables Colt customers (Resellers and Carriers) to process transactions easily and on demand.
This document describes how to use the Graphical User Interface for logging in and downloading CDRs from Web Manager.
2 Cocom FTP
2.1 OverviewThe 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.
Carrier VoIP User manual_v1.8 6
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 Directory structureFiles 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 Carrier VoIP across one or more Colt countries.
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/responsecarrier-voip
C4123/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
Carrier VoIP User manual_v1.8 7
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
contact-centre
in-number-hosting
geo-number-hosting
The profile is up to 5 alphanumerics and is the service profile
Service profiles are set up per service instance. Service profiles enable Colt to continue to support multiple customer service profiles being billed on the same Colt billing account (BCN) and provide unrated CDRs per service profile to Cocom.
The unrated CDR files will be generated in separate files by profile 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):
/jobout the directory where Colt will deposit job files, one for each response file/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
Carrier VoIP User manual_v1.8 8
2.3 CDR FilesTwice a day, every day of the week, Colt will deposit a file of Call Detail Records (CDR) into your /cdr directory on the server. This will contain all of the CDRs collected by the Colt network since the last file, typically each 12 hours. The CDR files are provided in a pre-defined, fixed length format. CDR file format description has been detailed in the Appendix.
CDR file naming standard
Files transferred to and from Colt are all uniquely identified and adhere to the following file format
<countrycode>_<profile>_<productidentifier>_<sequence no>_<date>.cdr.gz
Where:
<countrycode> in ISO 2 character format, note GB to be used
<profile> is up to 5 alphanumerics and is the applicable profile for the product
<productidentifier> is the product identifier (1-2 alphanumerics) – see table below
<sequence no> is a rolling four digit sequence per <profile>_<product> combination
<date> is YYYYMMDDHHmmss
cdr.gz is where the file is zipped
Product Identifier Product name01 Reseller Connect00 Voice Line10 SIP Trunking11 IP Voice Line (Voice Line (v))12 IN for Resellers13 Carrier VoIP14 Reseller VoIP Connect15 Geographic Number Hosting16 IN Number Hosting17 Contact Centre
Carrier VoIP User manual_v1.8 9
2.4 Consolidated CDR RequestThis feature enables you to place a request for a consolidated CDR file through Cocom Web
Manager, accessed via Colt Online. Up to 90 days of CDRs can be requested, e.g. a consolidated
file of a week's worth of CDRs and these files will be delivered to both Cocom Web Manager &
Cocom FTP.
In Cocom Web Manager, click on “CDR” and on the left side of the screen select “Consolidated
CDR Request” . Search for the specific Profile.
Figure 1 - Consolidated CDR request - Select profile
Carrier VoIP User manual_v1.8 10
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 2 - Consolidated CDR Request
Select Start (From) and End (To) date by clicking on the calendar Symbol and choose
the preferred date. Click on the Button “Consolidated CDR”
Your Consolidated CDR request will be processed. A transaction ID will be displayed to the
user, along with a message “Consolidated CDR file “ <profile><transactionID>.cdr.zip” will be
ready for download within the next 2 hours.”
Figure 3 - Consolidated CDR Request: Transaction Result
Carrier VoIP User manual_v1.8 11
3 4 5
6
3 4
5
6
2.5 Consolidated CDR DownloadWithin 2 hours the consolidated CDR file will be available in the Cocom FTP /cdr file under the
product & profile which you used in your request.
2.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 A.
Carrier VoIP User manual_v1.8 12
2.7 Maintenance and supportThe Cocom B2B Gateway Server is available 24 x 7 x 365.
The Cocom server is generally available around the clock except for brief periods where Colt has to carry out essential system maintenance. These regular maintenance windows are:
04:00 to 05:30 GMT daily
05:00 – 06:30 CET daily
This allows you to retrieve files overnight and at times that suit your own IT processing needs, although help and support is only available during normal office hours.
Should we need to temporarily suspend access to the server, for planned maintenance, you will be notified at least 5 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.
Customer Service is available during normal office hours, from Monday to Friday except during Public Holidays.
3 Cocom Web Manager
3.1 OverviewThe following features are available for carriers and resellers in the Cocom Web Manager.
CDR Delivery
CDR Delivery allows you to download CDRs which will be delivered twice a day by default.
3.2 System requirementsIn order to use Cocom Web Manager you won’t need any additional software or development. A Browser and an Internet connection will be sufficient.
Internet Explorer 6.0, Internet Explorer 8.0, Mozilla Firefox 40 and Google Chrome 45 are the recommended browser versions on which the application has been tested.
Carrier VoIP User manual_v1.8 13
3.3 Using Cocom web managerThe following section describes the login to Cocom Web Manager, the functionalities for downloading CDRs as well as general functions to download customer data and user guides.
3.3.1 Login To Colt Online Application
Access to Cocom Web Manager is fully integrated into Colt’s customer portal Colt Online. Via your single login on Colt Online you can access all your Voice & VoIP products from Colt on Cocom Web Manager.
Please use your Colt Online access with the following URL:
www.colt.net/online
The following Login screen will appear:
Figure 4 - Colt Online Login Screen
Please proceed with the following steps:
Enter your Username (Authenticated by Colt in your Welcome letter)
Enter your Password (Authenticated by Colt in your Password letter)
Click on the button “Login” to access Colt Online.
Carrier VoIP User manual_v1.8 14
5
4
3
2
6
1
2
3
1
When you first login, you will be requested to change your password.
If you have forgotten your password, please click on “Forgotten your password”. You
are then requested to enter your “Login ID” and your “E-Mail” address. A new password
will be sent to you by Colt Customer Service.
If you want to create a new account, please click on “Request Login”, you will be then
requested to enter your customer data to create a new account.
Here you can choose the language you prefer.
3.3.2 Access To Cocom Web ManagerYou can access Cocom Web Manager via Sales Tools in the top navigation bar:
Figure 5 - Colt Online Welcome Screen
Place the mouse over the “Sales Tools” Main menu
The “Cocom Web Manager” Sub menu item with link is displayed if you are an
authorized user to access Cocom Web Manager. Click the “Cocom Web Manager” Sub
menu link. The Cocom Web Manager application will be invoked and open the
Welcome page in a new browser. Your user credentials are authenticated and enable
you to access the Web Manager application
Carrier VoIP User manual_v1.8 15
Please Note: Cocom Web Manager Sub menu item with link will not be displayed if the user is not
authorized to access Cocom Web Manager.
4
5
6
2
1
1
2
3.3.3 Welcome Page On Cocom Web Manager
The Welcome page will display all available Service Profiles for Carrier VoIP under the Reseller
Domain name which is authorized for you.
The Reseller Domain is only held in Cocom Web Manager and is a shortened version of your
company name.
Service profiles are set up per service instance. Service profiles enable Colt to continue to
support multiple customer service profiles being billed on the same Colt billing account (BCN) and
provide unrated CDRs per service profile to Cocom.
Your service profiles will conform to the new standard of up to 5 alphanumerics.
All your service profiles across all countries are aggregated under your Reseller Domain. The
status has two different values. “Disabled” stands for a Reseller Domain which has been created
but is not allowed to complete any activity.
A Reseller Domain with the status “Active” is allowed to perform functional activities based on
profiles.
Figure 6 - Web Manager Welcome Screen
On the right top corner you will find the “Home”, “Contact Us” and “Logout” navigations.
Click ”Home” link, will refresh the screen and display the Welcome page. If you want to
contact your Colt Customer Services, click on the ”Contact Us” link. A screen with
Carrier VoIP User manual_v1.8 16
1
2
3
4
2 43
1
6
5
5
phone numbers and E-Mail address of our Colt Customer Service for each of the
countries will be displayed.
On the right corner under the top navigation bar, you can see that you are logged in
with your Username
Users are allowed to access the menus according to the Web manager Role and product-related permissions.
The welcome page displays the authorized main menu items for the User and placing the mouse over each menu will display the sub menu items with links.
3.4 CDR DeliveryCDR delivery allows you to download unrated CDRs from Cocom Web Manager which will be delivered twice a day by default.
The following sections describe the CDR delivery functionality in more detail, including::
CDR File Delivery and Naming Convention
Select Reseller Profile for CDR Download
CDR Search
CDR Download
Consolidated CDRs
3.4.1 CDR File Delivery and Naming Convention Twice a day, every day of the week, Colt will deposit a file of unrated Call Detail Records (CDR) into Cocom Web Manager. This will contain all of the unrated CDRs collected by the Colt network since the last file, typically every 12 hours.
The unrated CDRs will be delivered 2 working days after the call has been made.
Files transferred to and from Colt are all uniquely identified and adhere to the following file format
Carrier VoIP User manual_v1.8 17
Please Note:Your Cocom Web Manager login is dependent on your user role.
Please Note: The first CDR file will appear in Cocom Web Manager after the first
call has been made.
<countrycode>_<profile>_<productidentifier>_<sequence no>_<date>.cdr.gz
Where:
<countrycode> in ISO 2 character format, note GB to be used
<profile> is up to 5 alphanumerics and is the applicable profile for the product
<productidentifier> is the product identifier (1-2 alphanumerics) – see table below
<sequence no> is a rolling four digit sequence per <profile>_<product> combination
<date> is YYYYMMDDHHmmss
cdr.gz is where the file is zipped
Product Identifier Product name01 Reseller Connect00 Voice Line10 SIP Trunking11 IP Voice Line (Voice Line (v))12 IN for Resellers13 Carrier VoIP14 Reseller VoIP Connect15 Geographic Number Hosting16 IN Number Hosting17 Contact Centre
The CDR files are provided in a pre-defined fixed length format. These files are detailed in Appendix A.
Select Profile for CDR Download
Go to “CDR” at the top navigation bar and subsequently click on “CDR Download” the below
screen will appear. After clicking on the “Search Profile” button without typing a search term,
an overview of your existing products and profiles will be displayed . You can search for CDRs
for a particular service profile by typing the profile and click on the “Search Profile” button. Then click on the arrow on the right hand side under Search.
Carrier VoIP User manual_v1.8 18
1 2 34 5
Figure 7 - Search Profile Screen
After clicking on the “Arrow” button, a CDR Search page will be displayed.
Figure 8 - CDR Search Screen
In the headline , you can see the product and profile which you have just chosen.
Unrated CDRs will be delivered to Cocom two days after the call has been made.
The number of CDR files will be restricted to your defined timeframe. To display the CDR files
enter a start date in the “From” field and an end date in the “To” field. Enter the date in the format: DD/MM/YYYY, or alternatively click on the “Calendar Symbol” to select the preferred date. For each profile you can see the corresponding OCN and BCN – note these values are not editable in Cocom Web Manager. .
Now click on the “Search” button to search for all unrated CDRs in the specified time frame or
click on the “Clear” button to clear all entered fields.
Carrier VoIP User manual_v1.8 19
1
2 3
67
1
2
3
4
5
1
2 3
4 5
6 7
3.4.2 CDR Download After Clicking on “Search” button, a CDR list will be displayed as shown in the below screenshot. The result will be displayed according to Product and Profile. Files displayed will be in the standard format with the file size and CDR date and time stamps.
Figure 9 - CDR List Screen
Select a specific CDR file and click on “Download CDR” .
Figure 10 - CDR Download Screen
After clicking on the required link, a save dialog box opens as shown in the above screenshot.
You will be asked to either “Open" / “Save” the file or “Cancel” the download. Select the appropriate function.
Only CDRs from the last 90 calendar days will be available.
Carrier VoIP User manual_v1.8 20
Please Note:Only the last 90 calendar days of unrated CDRs are available for download.
1
1
3.4.3 CDR File FormatAll your CDR files in your reseller domain will be either zipped or plain CDR format. This has been
setup based on your input to the Reseller setup form. We recommend you select zipped CDRs to
ensure CDR download is completed efficiently.
3.4.4 Consolidated CDR RequestThis feature enables you to place a request for a consolidated CDR file through Cocom Web
Manager. Up to 90 days of CDRs can be requested, e.g. a consolidated file of a week's worth of
CDRs.
Click on “CDR” and on the left side of the screen select “Consolidated CDR Request”.
Search for the specific Profile.
Figure 11 - Consolidated CDR request - Select profile
Carrier VoIP User manual_v1.8 21
Please note: The extension .cdr may be used by other application like Corel draw and
therefore may open automatically the file. Please use the function “open with” to open it
with an editor in the CSV-Format
12
1
2
Figure 12 - 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 13 - Consolidated CDR Request: Transaction Result
Carrier VoIP User manual_v1.8 22
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.
3 4 5
6
3 4
5
6
3.4.5 Consolidated CDR Search
Click on “Search Consolidated CDR” link from left menu bar to reach to following page. You
can then input the transaction id for your Consolidated CDR file and click on search button
Figure 14 - Consolidated CDR Search
If you do not enter a Transaction ID at all and leave this blank, all successfully processed
transactions for the last 5 calendar days will be displayed for the selected service profile.
Please note if you enter part of the transaction ID, a “No result found” message will be displayed.
3.4.6 Consolidated CDR Download
After Clicking on “Search” button, a Consolidated CDR list will be displayed as shown in the
screenshot below. The result will be displayed according to the Product and Profile. The File
displayed will be in the standard format with the file size and CDR date and time stamp.
If the file is not present for a specific transaction ID search, it will display following error message
“No data available for selected time range”.
If the transaction ID is incorrect or invalid, the a “No Result found” message will be shown.
Carrier VoIP User manual_v1.8 23
789
9
78 9
Figure 15 - Consolidated CDR Download (1)
Select a specific Consolidated CDR file and click on “Download Consolidated CDR”
Figure 16 - Consolidated CDR Download (2)
3.4.7 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
Carrier VoIP User manual_v1.8 24
10
10
.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 A.
3.5 View Reseller DataClick on ”View Reseller Data” Sub menu link under “Maintain Accounts” main menu to view your Reseller data. This will provide you with the following information:
Your Reseller Domain name
Your Reseller Domain ID
Your Colt Online username(s)
Your customer numbers (OCNs)
Your Legal customer name
Country
Product
Billing Account (BCN)
Service Profile
Access Type e.g. Web Manager (WM) / FTP / XML
The details you can view relate to your Reseller Domain and your view will be restricted based on your user role and permissions.
As a Customer Administrator you can see this information only for your own reseller domain and if you have requested a user to be set up they may see a restricted set of data within your reseller domain, as defined by you.
After clicking “View Reseller Data” the following screen will be displayed.
Carrier VoIP User manual_v1.8 25
Figure 17 - View Reseller Data
Enter text or select the required search criteria and click on the “Search” button, and the corresponding data will be displayed. ”Clear” will clear all data in the search criteria fields.
You will see a link to username details – these are your user contact details held in Colt Online. Under the Address link you will see the legal company details we have on record.
Carrier VoIP User manual_v1.8 26
Please note: This reseller data can be exported and saved as MS Excel, which may
prove useful for you, if you wish to clarify what your users can access, or if you wish to
have a record of profiles required for future product orders.
3.6 DocumentsIn Cocom Web Manager you can find all product related documentation for your Colt Reseller and Carrier Voice products.
This includes product user guides and VPN access software and instructions.
Under the Help function you can access the latest version of all Colt documents.
3.6.1 User Guides
After clicking on “User Guides” from “Help” Tab Menu, the below page will appear and you can download the FTP or Web Manager user guides from the link.
Figure 18 - User Guides Screen
3.6.2 VPN AccessThe Cocom server currently supports FTP access to dedicated and protected directories that have been created specifically for your business. Access to the server is via a dedicated VPN client, provided by Colt. These methods are detailed in separate documents, which you can download in the “Help” menu.
Click “VPN Access” Sub menu link under “Help” and from here you can download the files and
related user guides.
Carrier VoIP User manual_v1.8 27
1
12
1
Figure 19 - Help – VPN Access Screen
3.7 Cocom Web Manager Exit
Users can logout from Cocom Web Manager by clicking on the Logout link on Cocom Web
Manager. The user will be then logged out in both systems: Cocom Web Manager and Colt Online.
You can close the Browser window after logging out.
Figure 20 – User guide
Carrier VoIP User manual_v1.8 28
1
1
1
2
4 Maintenance & SupportThe Cocom B2B Gateway Server is available 24 x 7 x 365.
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.
Customer Service is available during normal office hours, from Monday to Friday
except during Public Holidays.
5 GlossaryTerm DescriptionB2B Business to Business:
typically takes the form of automated processes between trading partners and is performed in much higher volumes than business-to-consumer (B2C) applications.
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. In Cocom 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. Rated CDRs can be found in Colt Online alongside your Colt invoice, in a monthly or quarterly file.
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 and download CDRs.
CSV Character Separated Values orComma Separated Values:file format is a tabular data format that has fields separated by the comma character and quoted by the double quote character. If a field’s value contains a double quote character it is escaped with a pair of double quote characters.
The CSV file format does not require a specific character encoding, byte order or line terminator format.
FTP File Transfer Protocol:is a software standard for transferring computer files between machines with widely different operating systems. It belongs to the application layer of the Internet protocol suite.
GB Great Britain
Carrier VoIP User manual_v1.8 29
Term DescriptionHTML Hyper Text Mark up Language:
is a markup language designed for the creation of web pages and other information viewable in a browser. HTML is used to structure information -denoting certain text as headings, paragraphs, lists etc.- and can be used to define the semantics of a document
HTTP HyperText Transfer Protocol):is the primary method used to convey information on the World Wide Web. The original purpose was to provide a way to publish and receive HTML pages. The default TCP port of HTTP is 80.
HTTPS HyperText Transfer Protocol Secure:is the secure version of HTTP, the communication protocol of the World Wide Web. It was invented by Netscape Communications Corporation to provide authentication and encrypted communication and is used in electronic commerce.
Instead of using plain text socket communication, HTTPS encrypts the session data using either a version of the SSL (Secure Socket Layer) protocol or the TLS (Transport Layer Security) protocol, thus ensuring reasonable protection from eavesdroppers, and man in the middle attacks. The default TCP port of HTTPS is 443.
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), Deutsche Telekom (Germany), British Telecom (UK), Telia (Sweden), KPN (Netherlands), Belgacom (Belgium), Austria Telekom (Austria), Telecom Italia (Italy), Eircom (Ireland), Portugal PTT (Portugal), Telefonica (Spain), Teledenmark (Denmark). Swisscom (Switzerland).
SMTP Simple Mail Transfer Protocol:is a relatively simple, text-based protocol, where one or more recipients of a message are specified (and in most cases verified to exist). The message text is transferred to the specified recipients.SMTP uses TCP port 25.
URL Uniform Resource Locator:or Web address, is a standardized address name layout for resources (such as documents or images) on the Internet (or elsewhere). First created by Tim Berners-Lee for use on the World Wide Web, the currently used forms are detailed by Internet standard RFC 1738.
WWW World Wide Web:is an information space in which the items of interest, referred to as resources, are identified by global identifiers called Uniform Resource Identifiers (URLs). The term is often mistakenly used as a synonym for the Internet, but the Web is actually a service that operates over the Internet.
XML eXtensible Mark up Language:is a W3C-recommended general-purpose markup language for creating special-purpose markup languages. It is a simplified subset of SGML, capable of describing many different kinds of data. Its primary purpose is to facilitate the sharing of data across different systems, particularly systems connected via the Internet.
Carrier VoIP User manual_v1.8 30
6 Appendix A: CDR File for all countries other than GermanyThe 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.
6.1 CDR File Format
6.1.1 Character Coding
ASCII
6.1.2 File Mark-up Coding No structured Mark-Up used
Fixed length records
Fixed length fields, space filled
6.1.3 Compression/Decompression AlgorithmsCDR 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 the Colt Customer Services if you need the CDR files to be delivered as plain text (Uncompressed) files.
6.1.4 File NameAll 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
Carrier VoIP User manual_v1.8 31
<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 name01 Reseller Connect00 Voice Line10 SIP Trunking11 IP Voice Line (Voice Line (v))12 IN for Resellers13 Carrier VoIP14 Reseller VoIP Connect15 Geographic Number Hosting16 IN Number Hosting17 Contact Centre
Example:AT_C1234_13_0001_20101208090122.cdr.gz
Carrier VoIP User manual_v1.8 32
6.2 Call Detail Record FormatThe data lines are 217 bytes in length and organised as:
Ref Name Bytes Position Alpha/num Justification Format & Description
1 Incoming Switch ID 7 1 A L
2 Outgoing Switch ID 7 8 A L
3 Record Sequence Number 15 15 A L Numeric left justified or
spaces4 Link Field 2 30 A L 0/1/2/3
5 Record Type 2 32 A X Space fill
6 Start Date 8 34 N X YYYYMMDD
7 Start Time 8 42 N X HHMMSShh
8 Duration 10 50 N X 00HHMMSShh
9 A-Number 28 60 A L Originating number
10 B-Number 28 88 A L
In use for Carrier VoIP in UK & France: the Charge Band defined by Regulator(Ofcom UK/Arcep FR) for calls to non-geographic numbers will precede the destination number. If no Charge Band is available, the destination number only will be shown.
11 Incoming Route / Trunk ID 20 116 A L
12 Outgoing Route / Trunk ID 20 136 A L
13 Incoming Product ID 4 156 A L
14 Outgoing Product ID 4 160 A L
15 Call Direction 1 164 A X Upper case char – I / O / T
16 Network Time 8 165 A X Space fill
17 Reason for Cleardown 4 173 A X Space fill
18 Data Volume 10 177 A X Zeros / Space fill
19 Data Unit 8 187 A X Space fill
20 Repair Indicator 1 195 A X Space fill
21 User Summary 20 196 A L Incoming trunk ID for transit calls
22 End of Record 1 216 A X
23 Line Feed 1 217 ASCII LFLine Feed (HEX 0A) only visible when processing CDRs with HEX_Editors
Carrier VoIP User manual_v1.8 33
6.3 Sample Call Detail Record
FTA 63923241800 02011102508035404000001088300000000 017141234 SIC41234 DACC T 0000000000 C4210C41234
FTA 63923263800 020111025080427050000004290 065491234 SIC41234 DACC T 0000000000 C4210C41234
Please note:
The CDR file contains CDR records in a fixed length format only.
The data lines are 217 bytes in length.
The first CDR file is generated once the first call has been made and if no calls are made, then no files will be delivered.
Carrier VoIP User manual_v1.8 34
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.
.
7 Appendix B: CDR File of GermanyThe 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.
7.1 CDR File Format
7.1.1 Character Coding
ASCII
7.1.2 File Mark-up Coding No structured Mark-Up used
Fixed length records
Fixed length fields, space filled
7.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 the Colt Customer Services if you need the CDR files to be delivered as plain text (Uncompressed) files.
7.1.4 File NameAll 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
Carrier VoIP User manual_v1.8 35
<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 name01 Reseller Connect00 Voice Line10 SIP Trunking11 IP Voice Line (Voice Line (v))12 IN for Resellers13 Carrier VoIP14 Reseller VoIP Connect15 Geographic Number Hosting16 IN Number Hosting17 Contact Centre
Example:DE_C4321_13_0001_20101208090122.cdr.gz
Carrier VoIP User manual_v1.8 36
7.2 Call Detail Record Format for GermanyThe data lines are 199 bytes in length and organised as:
Ref Name Bytes Position Alpha/num Justification Format & Description
1 Incoming Switch ID 7 1 A L
2 Outgoing Switch ID 7 8 A L
3 Record Sequence Number 15 15 A L Numeric left justified or
spaces4 Link Field 2 30 A L 0/1/2/3
5 Record Type 2 32 A X Space fill
6 Start Date 8 34 N X YYYYMMDD
7 Start Time 8 42 N X HHMMSShh
8 Duration 10 50 N X 00HHMMSShh
9 A-Number 28 60 A L Originating number
10 B-Number 28 88 A L Destination number
11 Incoming Route / Trunk ID 20 116 A L
12 Outgoing Route / Trunk ID 20 136 A L
13 Incoming Product ID 4 156 A L
14 Outgoing Product ID 4 160 A L
15 Call Direction 1 164 A X Upper case char – I / O / T
16 Network Time 8 165 A X Space fill
17 Reason for Cleardown 4 173 A X Space fill
18 Data Unit 1 177 A X Space fill
19 User Summary 20 178 A X Incoming trunk ID for transit calls
20 End of Record 1 198 A X
21 Line Feed 1 199 ASCII LFLine Feed (HEX 0A) only visible when processing CDRs with HEX_Editors
Carrier VoIP User manual_v1.8 37
7.3 Sample Call Detail Record for Germany
FTA 478692429 02011070402322909000000179407791234 00390521611234 SIC42313 DACC T C4231C42313
FTA 478692431 02011070402323108000000176107791234 00390521611234 SIC42313 DACC T C4231C42313
Please note:
The CDR file contains CDR records in a fixed length format only.
The data lines are 199 bytes in length.
The first CDR file is generated once the first call has been made and if no calls are made, then no files will be delivered.
8 Appendix C: Colt Error codes
Carrier VoIP User manual_v1.8 38
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
Please note: There is an ASCII control character (Line Feed, HEX 0A) in the last field (20) “Line
Feed”. 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
Message Code
Message Type Message Description
Explanation
0 B2BGateway Success Message/OK
-1 B2BGatewayUnable to process your request
[additional explanation]
Validation Failed, e.g. Infrastructure Error from Cocom, missing request
file, wrong characters0 cocom OK – Success
99 Cocom
Cannot process your request! Please contact customer service
support!
No connection between B2B Gateway and Cocom
9 Appendix D: Country Codes
Country Code Country Name
AT AustriaBE BelgiumDE GermanyES SpainFR FranceGB Great BritainIE IrelandIT ItalyNL NetherlandsSE SwedenDK DenmarkPT PortugalCH Switzerland
Carrier VoIP User manual_v1.8 39