Reporting on SCG Portal

Version v1.0, October 2022

 

Introduction

The SCG’s Voice and Messaging console (SCG Portal) enables users to create, view and save detailed reports of calls and messages processed by SCG. Users can generate the reports using different filters such as: Channel Type, Message State, Sender Address ID, datetime, among others.

Purpose of this document

This document provides step by step guide on how to generate, view and save calls and messages reports via the SCG Portal

Reports Menu

When you login to SCG Portal, in the Dashboard screen you will find the Reports option on the left vertical menu.

screen1.jpg

The Reports menu provides 2 options: Messages and Calls.

Reports: Messages option

screen2.jpg

This option runs reports of messages, and the following filters can be used when generating reports.  

Filters:

Channel Type:

Optional filter to specify the selection of message sent by a specific Channel type. When selected, the report will include messages for the filter channel. You can select from a list of values including:

  • SMS
  • MMS
  • VOICE
  • WECHAT
  • WHATSAPP
  • FACEBOOK
  • PUSH
  • RCS
  • LINE

screen3.jpg

 

Message State:

Optional filter to specify the selection of message with a specific State. When selected, the report will include messages for the filter channel. You can select from a list of values including:

  • CREATED
  • SENT
  • DELIVERED
  • READ
  • CONVERTED
  • FAILED
  • SCHEDULED
  • TEST
  • PAUSED
  • RECIBED
  • PROCESSED
  • QUEUED
  • MEDIA_REQUESTED
  • CLICKTHRU

screen4.jpg

 

Sender Address ID:

Optional filter to specify the selection of messages by a specific Sender Address ID. When specified, the report will include messages from the Sender Address ID only.

screen5.jpg

 

Time period:

Mandatory filter to specify the messages creation time period. When executed, the report will retrieve all messages with created_date in the range of the selected Time Period. Possible selections are:

  • Last 7 days: In this case the report will include all messages created in the last 7 days.
  • Last 30 days: In this case the report will include all messages created in the last 30 days.

Custom period: In this case the system pops-up date and time fields to specify the “From” date-time and the “To” date-time.

screen6.jpg

 

Mobile Number:

Optional filter to specify the messages destination mobile number. When specified, the report will retrieve all messages with the indicated mobile number as destination.

screen7.jpg

 

To execute the report, after setting the filters just click the “View Report” button:

screen8.jpg

 

When the report is run the following data is displayed:

Output columns:

The reports output columns on screen are:

  • ID
  • Message Request ID
  • Application ID
  • From Address
  • To Address
  • Type
  • Direction
  • Body
  • Price
  • PNV Price
  • Translation Price
  • State
  • Fragment Count
  • Created Date
  • Verify Sms
  • Recipient Verified Sms Enabled
  • External ID

The data is now on the browser screen:

screen9.jpg

 

Reports / Calls option

screen10.jpg

 

This option runs reports of calls, and the following filters can be used when generating reports.

Filters:

Direction:

Optional filter to specify the selection of calls by IN or OUT. When selected, the report will include calls for the selected direction. You can select from a list of values including:

screen11.jpg

 

 

Call State:

Optional filter to specify the selection of calls by STARTED, ACTIVE or COMPLETED. When selected, the report will include calls accordingly:

screen12.jpg

 

 

Failure Code:

Optional filter to specify the selection of calls by an extensive list of failure codes. When selected, the report will include calls accordingly:

screen13.jpg

 

 

Sender Address ID:

This filter works the same way as in the Messages reports.

 

 

Time Period:

This filter works the same way as in the Messages reports.

 

 

Output columns:

The reports output columns on screen are:

  • ID
  • Bridge ID
  • From
  • To
  • Direction
  • State
  • Date

 

 

Exporting / Downloading the report data

The reports resulting data shown on your browser can be exported to a file in your file system. Before export the data you can exclude unwanted columns from all the data columns on the screen:

 

For each column a check box is available to exclude (uncheck) from the output file.

screen14.jpg

 

To export the reports resulting data just click on the “Export” button:

screen15.jpg

 

This will create an export job and is ready for processing:

screen16.jpg

 

To review the export process status click on the “Last Export Status” button:

screen17.jpg

The export status is displayed:

screen18.jpg

 

To download the exported data to an output file just click “Download your export” link:

The SCG portal will download the data to CS file on your file system showing a progress bar as the downloading advances:

screen19.jpg

When the download ends your browser will shows a downloaded file available:

screen20.jpg

Finally you can open the downloaded file:

screen21.jpg

 

Was this article helpful?
0 out of 0 found this helpful

0 Comments

Please sign in to leave a comment.