Overview
Deliver filtered performance report as CSV or ZIP file, at a scheduled time and/or frequency.
Click 
button on Scheduled Performance Report Summary screen.
|
Description
New Performance Report Order |
|
Name
|
Name the Report.
|
Description
|
Optional. Type/paste any extra descriptive information which might be useful for identifying the report.
|
Search Options
|
1. Select the type of message, and its delivery status.
Message Type
|
The type of message to run the report for. Select from the drop-down menu:
Default: SMS
Options:
SMS Voice Messaging AT&T GSM
|
Message Status
|
The delivery status of the messages to report on. Select from the drop-down menu:
Default: Sent (MT)
Options:
Sent (MT - Mobile-Terminated) Received (MO - Mobile-Originated) All
|
2. Narrow the results by company, user and/or a specific order name.
Company
|
The company/sub-customer to return results for. Select from the drop-down menu.
Default: The parent company of the current user.
|
|
Note: If the root customer (i.e. the highest level user in the hierarchy) is selected, results will be returned for that customer and all sub-customers in the hierarchy. |
User
|
An individual user to return results for. Select from the drop-down menu.
Default: The current user who is logged in
Select 'All Users' to return results for everyone owned by the customer selected in Company field.
|
Order Name |
A specific order name to return results for. Select from the drop-down menu.
Default: NONE - will return all orders based on Company and User selection.
|
3. Choose the time and date period for the range of results which will be returned:
Date Scope
|
Indicates whether the report is querying the client application or the connection from AT&T GSMS towards the operator network.
|
Time Zone
|
The regional time zone for the reporting period. Select from the drop-down menu.
Default: The current user's time zone as configured on AT&T GSMS.
|
Start/End Date |
The date range for required report results. Click
Default: Today's date e.g. 06/30/2022
|
Start/End Time |
A specific start and end time (in 24 hour format) on the above start and end dates for the required report results.
Default: Start Time - 00:00; End Time - 23:59
|
Output Interval
|
The time interval against which to measure message activity in the report. Select from the drop-down menu.
e.g. PER DAY - returns the number of messages sent each day within the date and time periods selected.
Default: PER DAY
Options:
PER MONTH PER DAY PER HOUR PER MINUTE PER SECOND
|
|
Maximum search timespan is one month (up to 31 days) within the recent 90 days period. Contents that are more than 90 days are automatically wiped from the system thereafter. AT&T GSMS will adjust the start/end date regardless of what is entered by the user. This can be modified at a portal level. Raise a help ticket via help@sopranodesign.com for more information. |
4. Choose how you want results to be displayed and grouped:
Cost Center Label
|
Optional cost center label, if known. Further narrows results according to a custom Cost Center Label value which can be assigned to users within the company.
Default: None
|
Group By |
Group results together by a particular shared value.
Can be used only when Output Type is LIST or when scheduling a report.
Default: NONE
Options:
COST CENTRE LABEL COUNTRY CUSTOMER STATUS USER |
Delivery Options
|
1. Choose when and how to deliver report.
Delivery Frequency
|
When the report will be delivered. Select from the drop-down menu.
Default: IMMEDIATE
Options:
EVERY 15 MINUTES - generate and deliver results every 15 minutes.
DAILY - generate and deliver results once a day, at a specific date and time
IMMEDIATE - generate and deliver report now.
ONCE - generate report on one occasion, at a specific date and time.
MONTHLY - generate and deliver results once a month, at a specific date and time.
|
|
Note: AT&T GSMS uses the scheduled start date/time +1 day/month to calculate data range, and delivers report each day until the specified end date. Overrides any dates specified in 'Search Options'.
e.g. Daily - if report is scheduled to run on Feb 5 at 12pm with a delivery frequency of 'Daily' then the report will collect all data from Feb 4 12pm to Feb 5 12pm.
e.g. Monthly - if report is scheduled to run on Feb 4 12pm with a delivery frequency of 'Monthly' then the report will collect all data from Jan 4 12pm to Feb 4 12pm. |
Delivery Method
|
How the report will be delivered. Select from the drop-down menu.
Default: EMAIL
Options:
FTP HTTP SFTP
The Settings options will change depending on selected Delivery Method.
|
Settings
|
Enter address or security credentials to ensure report is delivered according to the chosen method. The available options will change depending on selected Delivery Method.
Default: Email Settings
Options:
Email Settings
•Primary Email - Valid email address where report should be emailed (Default: current user's username) •Second Email - If delivery fails to primary email, delivery will be attempted to this address
FTP/HTTP/SFTP Settings
•Hostname - Valid host name or IP address •Username - Username to be forwarded for authentication purposes when logging into remote server •Password - Username to be forwarded for authentication purposes when logging into remote server
|
NOTES:
|
If users are not familiar with server settings or do not know if these options are available, it is recommended to choose 'Email' as delivery method. |
|
Check your mail domain rules as you may not be able to receive emailed message report order results if the email is too large. |
|
If the volume of message report results is large, the receiving HTTP server must be big enough to accommodate them. |
Start/End Date
|
The date range for required report results. Click
|
Start/End Time |
A specific start and end time (in 24 hour format) on the above start and end dates for the required report results.
|
2. Choose how to name and format Report file(s):
Zip Report File
|
Choose whether to compress the Report file (ZIP) for delivery. Click check box to toggle.
Default:
If box is not checked, the file will be delivered in CSV format.
|
(deliver as ZIP file)Naming Convention
|
The file naming convention can be set as a string with variables representing data parameters.
Default: Name of Order (adapted from Summary tab)
If Delivery Method is FTP/SFTP, it may include either an absolute file path:
e.g. /an/absolute/path/myReport
or a relative one:
e.g. relative/path/myReport
The following variables are also supported for appending date information to reflect when the report was delivered:
yyyyMMddHHmm yyyyMMdd yyyyMdHHmm yyyyMd yyMMddHHmm yyMMdd yyMdHHmm yyMd
e.g. myReport-yyyyMMdd = myReport-06/30/2022.CSV
|
Once all required fields are complete:
|
Store changes and exit
|
|
If 'Delivery Frequency' is 'IMMEDIATE', this button launches the order.
|
|
If 'Delivery Frequency' is 'ONCE', or a recurring value (e.g. 'DAILY'), this button activates the order so that it will be sent at that time (and/or frequency).
|
|
Undo any changes and exit.
|
