Telecom Expense Management

Telecom Expense Management Afaria® Version 6.6 FP1

Afaria 6.6. FP1 Telecom Expense Management

2

Copyright © 2011 by Sybase, Inc. All rights reserved.

This publication pertains to Sybase software and to any subsequent release until otherwise indicated in new

editions or technical notes. Information in this document is subject to change without notice. The software

described herein is furnished under a license agreement, and it may be used or copied only in accordance

with the terms of that agreement. To order additional documents, U.S. and Canadian customers should call

Customer Fulfillment at (800) 685-8225, fax (617) 229-9845. Customers in other countries with a U.S.

license agreement may contact Customer Fulfillment via the above fax number. All other international

customers should contact their Sybase subsidiary or local distributor. Upgrades are provided only at

regularly scheduled software release dates. No part of this publication may be reproduced, transmitted, or

translated in any form or by any means, electronic, mechanical, manual, optical, or otherwise, without the

prior written permission of Sybase, Inc. Sybase trademarks can be viewed at the Sybase trademarks page at

http://www.sybase.com/detail?id=1011207. Sybase and the marks listed are trademarks of Sybase, Inc. A ®

indicates registration in the United States of America.

SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks

or registered trademarks of SAP AG in Germany and in several other countries all over the world.

Java and all Java-based marks are trademarks or registered trademarks of Sun Microsystems, Inc. in the

U.S. and other countries.

Unicode and the Unicode Logo are registered trademarks of Unicode, Inc.

All other company and product names used herein may be trademarks or registered trademarks of the

respective companies with which they are associated.

Use, duplication, or disclosure by the government is subject to the restrictions set forth in subparagraph

(c)(1)(ii) of DFARS 52.227-7013 for the DOD and as set forth in FAR 52.227-19(a)-(d) for civilian

agencies.

Sybase, Inc., One Sybase Drive, Dublin, CA 94568


3

Contents

PREFACE .......................................................................................................................... 5

AFARIA TELECOM EXPENSE MANAGEMENT (TEM) ........................................ 6

TEM Subscriber Data Collected by Device Type ...................................................................................... 6

TEM Voice Call Details Collected by Device Type .................................................................................... 7

TEM Data Connection Details Collected by Device Type ......................................................................... 8

TEM Message Details Collected by Device Type ....................................................................................... 9

TEM LICENSING .......................................................................................................... 10

TEM IMPLEMENTATION .......................................................................................... 11

Device Requirements by Device Type ........................................................................................................11

CONFIGURING TEM GENERAL SETTINGS ......................................................... 13

Configuring TEM Settings for International Roaming ............................................................................13

Configuring TEM Settings for Data Views ...............................................................................................14

Enabling TEM Cleanup ..............................................................................................................................15

Customizing TEM Cleanup Schedule ........................................................................................................16

TEM DATA COLLECTION ......................................................................................... 17

TEM Data Collection Frequency ...............................................................................................................17

Starting TEM Data Collection ....................................................................................................................18

Stopping TEM Data Collection ..................................................................................................................18

Reprompting User for TEM Enrollment ...................................................................................................18

Removing TEM Data of a Single Subscriber ............................................................................................19

TEM REPORTS.............................................................................................................. 20

Running TEM Reports ................................................................................................................................20


4

TEM DATA VIEWS ....................................................................................................... 21

Latitude and Longitude in TEM Data View .............................................................................................21

Displaying Data Views ................................................................................................................................22

Displaying Device Location on Map ..........................................................................................................22

Creating Custom Data Views .....................................................................................................................23

TEM WEB SERVICES .................................................................................................. 24


5

Preface

Afaria 6.6 FP1 introduces Telecom Expense Management (TEM) for monitoring and

reporting telecommunication activities.

This document is intended for the person responsible for operating the Afaria server. You

need a working knowledge of the device types you plan to support.


6

Afaria Telecom Expense Management (TEM)

Afaria Telecom Expense Management allows administrators to monitor and report

telecom activities occurring on enrolled devices.

Depending on the device type, monitored activities include:

Cellular data

Wi-Fi data

Outgoing and incoming phone calls

Outgoing and incoming SMS and MMS messages

International roaming status and usage

Related topics:

TEM Subscriber Data Collected by Device Type

TEM Voice Call Details Collected by Device Type

TEM Data Connection Details Collected by Device Type

TEM Message Details Collected by Device Type

TEM Subscriber Data Collected by Device Type

Definitions of subscriber data, such as IMSI, ICCID, and MSISDN, collected by each

device type.

Subscriber Data iOS

*

An

dro

id

Bla

ckB

erry

**

Definitions

IMSI International Mobile Subscriber Identity,

conforming to International

Telecommunication Union (ITU)

standard

ICCID Integrated Circuit Card Identifier,

conforming to International

Telecommunication Union (ITU)

standard

Cell ID Last reported cell ID

On CDMA networks, the Base Station

ID (BID)

Current Afaria Client ID Afaria client global unique identifier

(GUID)

Current Device ID iOS – Unique Device Identifier (UDID)


7

Android and BB GSM devices -

International Mobile Equipment Identity

(IMEI)

MSISDN Mobile Subscriber Integrated Services

Digital Network Number, which is the

literal phone number as reported by the

device. Not all SIM cards are pre-

programmed with their MSISDN,

particularly in Europe.

Home MCC Home network Mobile Country Code

Home MNC Home network Mobile Network Code

TEM Last Collected Date on which TEM data was last posted

on the server by the device

Last MCC Last reported Mobile Country Code

(MCC)

Last MNC Last reported Mobile Network Code

(MNC)

On CDMA networks, the network

System Identifier (SID)

Latitude Last reported approximate latitude, based

on crowd-sourced Wi-Fi hotspot and

mobile cell tower location

Longitude Last reported approximate longitude,

based on crowd-sourced Wi-Fi hotspot

and mobile cell tower location

Location Last Determined Date and time of the last location change

Opt In User’s answer to request for TEM

Enrollment (accepted/declined)

Roaming Change Date Date and time of the last roaming state

change

Status of Location Services Status of Location Services on the device

(enabled/disabled)

*iOS 5 devices do not collect ICCID.

** For all BlackBerry devices, the ability to collect latitude and longitude depends on:

The wireless service provider; and

If the device connects to a BlackBerry Enterprise Server (BES), on BES

policy settings.

TEM Voice Call Details Collected by Device Type

Definitions of voice call details, such as cell ID and MCC, collected by each device type.


8

Voice Call Details iOS

An

dro

id

Bla

ckB

erry

Definitions

Remote Party Remote party phone number

Start Time Start time of the call event

End Time End time of the call event

Duration Duration of call event

Call Direction Outbound or inbound call

Cell ID Mobile cell ID at the start of connection

On CDMA networks, the Base Station ID (BID)

at the start of the connection

Roaming State Roaming status

Latitude Latitude generated at the start of a call

Longitude Longitude generated at the start of a call

MCC Mobile Country Code of the network on which

the call event occurred

MNC Mobile Network Code of the network on which

the call event occurred

End Time does not appear in data views and reports.

TEM Data Connection Details Collected by Device Type

Definitions of data connection details, such as Bearer Type and MNC, collected by each

device type.

Data Connection

Details iOS

An

dro

id

Bla

ckB

erry

*

Definitions

Start Time Start time of the connection

End Time End time of the connection

Duration Duration of the connection

Bearer Type Network type, such as CMDA, GSM and Wi-Fi,


Connection Name Network name

Access Point Name Access Point Name

Cell ID Mobile cell ID at the start of connection




Latitude Latitude generated at the start of connection


9

Longitude Longitude generated at the start of connection


the connection occurred

MNC Mobile Network Code of network on which the

connection occurred

Sent Number of bytes transmitted

Received Number of bytes received

End Time does not appear in data views and reports.

*BlackBerry CDMA OS 5 and 6 devices do not collect data connection details.

TEM Message Details Collected by Device Type

Definitions of message details, such as cell ID and Type, collected by each device type.

Message Details iOS

An

dro

id

Bla

ckB

erry

Definitions

Remote Party Remote party phone number

Start Time Start time of the message event

Message Direction Outbound or inbound message

Type SMS or MMS

Cell ID Mobile cell ID at the time the message is sent


at the time the message is sent


Latitude Latitude generated when message is

initiated/received

Longitude Longitude generated when message is

initiated/received


the message event occurred

MNC Mobile Network Code of the network on which

the message event occurred


10

TEM Licensing

The Inventory Manager license includes TEM.

If you are a new Afaria customer, request the Inventory Manager license for the

device type of interest.

For Afaria customers who are upgrading:

o If you are already licensed for Inventory Manager, upgrading to the Afaria 6.6

FP1 provides you with TEM.

o If you are not licensed for Inventory Manager, obtain the Inventory Manager

license for the device type of interest and upgrade to Afaria 6.6 FP1.

Related topics:

Afaria Telecom Expense Management (TEM)

TEM Implementation


11

TEM Implementation

Configure TEM settings on the Afaria server and prepare the devices that support TEM.

No additional server components are required.

Use the Afaria Administrator to configure TEM settings on a tenant-by-tenant basis.

On iOS devices, the Afaria application must continuously run for TEM to be able to

monitor activities. Enabling Location Services for Afaria keeps the Afaria application

continuously running in the background.

Preparing the device varies by device type and requires the following:

If an Afaria client is not installed on the device, have the user install the Afaria

client and enroll in Afaria device management.

For iOS devices, the user must authorize location services during the client

installation and enable Location Services for the Afaria application.

If an Afaria client is already installed, upgrade to the current release.

Related topics:

Device Requirements by Device Type

Configuring TEM General Settings


Hardware, operating system (OS) version, and configuration requirements for devices

enrolled in TEM.

Client Type iOS

An

dro

id

Bla

ckB

erry

OS Version 4.3 and 5 2.2, 2.3, 3.0, and

3.1

5, 6, and 7

Hardware Device must report

an IMSI, which is

associated with a

SIM card for

cellular services.

Embedded MMC

Memory or SD Card


12

Device

Configurations

For TEM to work on

iOS devices, Location

Services must be

authorized during client

installation and enabled

specifically for the

Afaria application.

To collect location

information,

Wireless Location

Service must be

enabled.

To collect location

information,

Locations Services

must be set to

Location On and

Location Data must be

set to Enabled.

Related topic:

TEM Implementation


13


Enable and configure TEM data collection by configuring TEM general settings on the

Afaria Administrator.

Configuring TEM settings does not require you to restart the Afaria server service unless

you want to initiate TEM data collection.

1. On Afaria Administrator, open the Server configuration > Properties >

Component configuration > Telecom Expense Management page.

2. On the General Settings tab, select Enable TEM Collection.

3. (Optional) To collect the phone numbers of remote devices, select Collect

Remote Party Phone Numbers.

4. (Optional) To collect the location of the device at the time an activity occurs,

select Collect Subscriber Location Information.

5. (Optional) To prompt the user to accept or decline TEM, select Prompt

Subscriber for TEM Enrollment and compose the enrollment notification for

users to view on their devices.

When TEM collection is enabled for the first time, the actual data collection begins after

you restart the Afaria server service and the device successfully connects to the server.

Next

If you do not want to start data collection at the next service restart, unselect Enable

TEM Collection.

Related topics:


Configuring TEM Settings for International Roaming

Configuring TEM Settings for Data Views

TEM Data Collection

Configuring TEM Settings for International Roaming

To notify users that their devices are in an international roaming state and that additional

charges may apply, configure TEM roaming settings.




3. On the Roaming Settings tab:

a. Select Enable Roaming Notification.

b. (Optional) Customize notification content.


14

c. (Optional) To reduce the number of notifications when near a roaming

boundary, set the length of time a device must be in roaming status before

the notification appears.

4. Save changes.

5. If you do not want to begin or resume TEM data collection at the next service

restart, return to the General Settings tab and unselect Enable TEM Collection.

If TEM is enabled, a notification appears on the device every time the device enters

international roaming.

Related topic:



To customize how TEM data appears in data views, configure TEM settings for data

views.

Afaria provides a high level of customization to allow you to model data views on the

details of your enterprise mobility plan.



2. On the Data Views tab:

Set the start day in the month of the current and previous accounting

periods.

To customize Activity threshold views, set the threshold fields for each

type of activity occurred in the local network and while in a roaming state.

To customize Exceed threshold summary views, set the percentage

threshold value for each type of activity occurred in the local network and

while in a roaming state.

3. Save changes.

Examples:

Your enterprise mobile plan includes these prepaid activities, for each accounting

period and for each subscriber:

o Local network:

1000MB for data

700 outgoing messages

Unlimited outgoing local calls

Unlimited incoming calls and messages


15

o Roaming:

400MB for data

500 messages (both outgoing and incoming)

300 minutes for calls (both outgoing and incoming)

Set the threshold field for each activity accordingly. For example, enter “700” in

the outgoing message field of the local network; and “0” in the outgoing calls

field of the local network.

Incoming calls and messages in the local network are usually unlimited prepaid

activities. Therefore, you need not set thresholds for those activities.

The Activity threshold views show the percentage of the prepaid activities that

each subscriber has carried on during either the current or previous accounting

period. For example, if a subscriber has sent 350 messages while in the local

network, the Message % column of the Message Threshold Summary view shows

“50%”.

To flag subscribers who are about to exceed the prepaid activities allowed by your

enterprise mobile plan, set the percentage value for each activity to 95%.

The Exceed Threshold Summary view lists all subscribers who have exceeded

95% for any of the prepaid activities. A subscriber, who has exceeded the

percentage threshold for one kind activity, but not for all others, continues to

appear in the Exceed Threshold Summary view.

Related topic:

TEM Data Views

Enabling TEM Cleanup

To remove aged TEM data from your system, enable and configure TEM cleanup.



2. On the Cleanup Settings tab:

a. Select Enable TEM cleanup.

b. (Optional) Set the number of days to keep TEM data before it is removed

from your system.

When TEM cleanup is enabled, Afaria automatically removes aged TEM data at the time

of the default schedule (12:00 a.m. every day) or at the time specified in your custom

TEM cleanup schedule.

Related topics:



16

Customizing TEM Cleanup Schedule

Customizing TEM Cleanup Schedule

To customize the time at which the Afaria Server deletes aged TEM data, use the

schedule editor.

The TEM cleanup schedule applies to all tenants for which you have enabled TEM

cleanup.

1. On Afaria Administrator, open the Server configuration > Server Schedule >

TEM Cleanup page.

2. Click Edit to open the schedule editor.

3. Specify your schedule settings.

4. (Optional) On the Advanced tab:

a. Specify a date range during which the schedule runs.

b. Set the schedule to run on a recurring basis.

5. Click OK.

When TEM cleanup is enabled, Afaria removes aged TEM data at the time and frequency

you have set in your schedule. You can review your schedule settings in the summary on

the TEM Cleanup page.

Related topic:

Enabling TEM Cleanup


17

TEM Data Collection

By default, TEM data collection is disabled. When you enable data collection, you can

specify whether users are prompted for authorization.

Starting data collection:

If user’s authorization is not required, TEM data collection begins after you

enable TEM collection; restart the Afaria server service; and the device connects

to the server.

If user’s authorization is required, TEM data collection begins after the user

accepts TEM enrollment. The user’s response (accept/decline) is sent back to the

Afaria server and appears in the Opt-in column of the Subscribers view.

A device retains its TEM collection preference (accept/decline) when it changes

tenant. However, if the user has previously declined and you move the device to a

tenant where user’s acceptance of TEM is not required, TEM collection begins

without further notification to the user.

Ongoing data collection:

TEM data is associated with a subscriber. If a device has a SIM, the subscriber is

identified by the SIM's IMSI or ICCID. A SIM can move from device to device,

therefore TEM data associated with the SIM moves from device to device.

On iOS devices, TEM data collection stops automatically if the user turns off

location services for more than 10 minutes.

Related topics:


Starting TEM Data Collection

TEM Data Collection Frequency

The frequency at which Afaria collects TEM data from enrolled devices varies by device

type.

For iOS devices, Afaria collects TEM data once a day between 2:00 p.m. and

3:00 p.m. (server local time).

For Android devices, Afaria collects TEM data at the frequency based on the

heartbeat settings defined in the Configuration Manager Channel.

For BlackBerry devices, Afaria collects TEM data when either of these events

occurs:


18

o The user opens the Afaria application on the device and successfully

establishes a connection to the server.

o The administrator sends an outbound notification to the devices of

interest.

Starting TEM Data Collection

To start collecting TEM data from devices, enable collection and restart the Afaria server

service.




3. Save changes.

4. Restart the Afaria server service on the Home > Server Status page.

After you restart the server, Afaria begins collecting TEM data for a device upon that

device connecting to the server. If you have selected Prompt Subscriber for TEM

Enrollment in the General Settings page, collection begins for a device after the user of

that device accepts TEM enrollment.

Related topics:

TEM Data Collection

Stopping Collecting TEM Data


Stopping TEM Data Collection

To stop collecting TEM data for all the devices, disable TEM collection and restart the

Afaria server service.



2. On the General Settings tab, unselect Enable TEM Collection.

3. Save changes.

4. Restart the Afaria server service on the Home > Server Status page.

After you restart the server, TEM data collection stops for each device upon that device

connecting to the server.

Related topic:

TEM Data Collection

Reprompting User for TEM Enrollment

To resend the enrollment notification to a user who has previously accepted or declined

enrollment, use the Reprompt menu option from the Subscribers view.


19

The Opt In column in the Subscribers view shows whether the user has previously

accepted or declined enrollment.

Before you reprompt, verify that Prompt Subscriber for TEM Enrollment is selected

on the TEM General Settings tab.

1. On Afaria Administrator, open the Data Views > Telecom Expense

Management> Subscribers view page.

2. Right-click the row of the subscriber to whom you want to resend the notification.

3. Click Reprompt.

Upon reprompting, the user receives either the default enrollment notification or the

custom notification you set on the TEM General Settings page.

Related topic:


Removing TEM Data of a Single Subscriber

To remove all TEM data of a single subscriber, use the All Clients view.

1. On Afaria Administrator, open the Data Views > Clients > Client views > All

clients page.

2. Right-click the row associated with the subscriber of interest and click Delete.

3. Select Remove Telecom Expense Management Data.

4. Click OK.

All TEM Data collected for the subscriber is deleted, regardless of when it was collected.


20

TEM Reports

TEM reports display TEM data in a predefined and presentable format.

The following reports are available:

Activity Details report – activity details for one or more devices over a user-

defined data range.

Activity Summary report - summary of activities, except Wi-Fi activities, for all

devices over a user-defined date range.

In the reports, subscribers are identified by one of the following identifiers in descending

order of priority: Phone Number, Afaria Device ID (aka Afaria Client Friendly Name),

IMSI, ICCID, Client Name, and Device ID.

TEM activities date and time are displayed in UTC.

For data connection events that are smaller than 1KB, TEM reports list the numbers of

bytes sent or received as “0”.

Related topic:

Running TEM Reports

Running TEM Reports

To review TEM data in a predefined and presentable form, run TEM reports on the

Reports page.

1. Open the Home > Reports page.

2. Double-click Telecom Expense Management to display the available predefined

reports.

3. Right-click the report of interest.

4. Click Open this report.

5. (Optional) Set filtering criteria:

a. Select date range

b. Type phone number

If necessary, use wildcards.

6. Click Run.

The report appears in a Crystal Report Viewer.

Related topic:

TEM Reports


21

TEM Data Views

TEM data views display subsets of TEM data stored in your database tables.

Available data views include:

System-defined views, which include:

o Subscribers view – lists all subscribers who have connected to the Afaria

server at least once after you enable TEM.

o Roaming subscriber view – lists subscribers whose last known state was

roaming.

o Exceed threshold summary views – list subscribers who have exceeded

user-defined thresholds for at least one kind of activity within an

accounting period.

o Activity summary views – show aggregate values for data, calls and

messages activities for each subscriber within an accounting period.

o Activity thresholds views – let you compare aggregate values for data,

calls and messages activities to user-defined thresholds.

o Location view – shows last determined latitude and longitude of devices

enrolled in TEM.

o Network info – read-only view listing worldwide cellular networks.

Activity Details view for each subscriber – shows all activities, one by one,

carried on by a subscriber.

Custom views that you create with a view editor.

When applicable, TEM data views aggregate and display data based on current and

previous accounting periods. Each accounting period is one month. Change the period

start date in the month to match the billing cycle of your cellular provider.

TEM activities date and time are displayed in UTC.

Related topics:


Latitude and Longitude in TEM Data Views

Displaying Data Views

Latitude and Longitude in TEM Data View

Definitions for longitude and latitude values in the Location view.

Value Definition

<longitude >

<latitude>

Last retrieved approximate longitude and

latitude of the device, based on crowd-

sourced Wi-Fi hotspot and mobile cell

tower location. Level of accuracy varies by

device type. For iOS and Android,


22

accuracy requested is 1KM (0.62 mi.).

Unknown The location of the device is temporarily

unknown.

Disabled Location services are disabled on the

device.

Not Collected Collection of Subscriber Location

Information is disabled on the TEM

General Settings page of the Afaria

Administrator.

Unsupported The device does not support location

services. This is uncommon.


To review TEM data, display the system-defined data views or any custom-defined data

views.


Management page.

2. In the left pane, click the view of interest.

The view appears in the right pane.

3. (Optional) To display the Activity Details view for a single subscriber:

a. In the left pane, click Subscribers view.

b. Right-click the subscriber of interest and select Activity Details.

4. (Optional) To export the view, click the Export icon on the toolbar.

Related topics:


TEM Data Views

Displaying Device Location on Map

To display the last reported location of the device, use the Bing map available in the

Location view.

Maps are available only for devices for which Afaria has collected longitude and latitude.


Management page.

2. In the left pane, choose Location view.

3. Right-click the row of the subscriber of interest, then click Map.

The Location view also shows the date and time when the device location was last

determined, based on the local time zone of the browser session of the Afaria

Administrator console.

Related topic:


23

Latitude and Longitude in TEM Data View

Creating Custom Data Views

To customize how TEM data appears, use the view editor to create a custom data view.


Management page.

2. Open the View Editor:

a. On the toolbar, click the first icon from the left.

b. Select View from the drop-down menu.

3. Configure the view settings in the View Editor:

a. Name the view and add one or more columns.

b. (Optional) Enter a description for the view and add one or more criteria.

c. (Optional) To display the equivalent SQL statement of the view, click

Display SQL statement.

4. Click OK.

The custom data view you created appears in the left pane along with the system-defined

data views.

Related topics:

TEM Data Views



24

TEM Web Services

Afaria includes Web methods that retrieve TEM data. You can use these methods for

custom application integration or development using SOAP1, SOAP2, or HTML.

Afaria provides a Web services page that lists the Web methods and allows developers to

test them. The page is available at http://<Afaria host server name>/<Afaria IIS Virtual

Directory>/ PublicWebServices/TEM/TEMDBLookup.asmx.

Use methods to retrieve:

All TEM subscriber records for a specific Afaria tenant

All voice call events for a subscriber for a date range

All message events for a subscriber for a date range

All data events for a subscriber for a date range

All voice, message and data connections for a subscriber for a date range

List of subscribers for a specific Afaria tenant who are currently roaming

Telecom Expense Management

Documents

Transcript of Telecom Expense Management