This document contains material, which is intellectual property of Polaris Wireless Inc and may not be

reproduced in any form without written (email) consent from Polaris.

Site License Tool
User Guide

Number:

Version: 0.1

Date: 11/14/2013

Site licensing Tool
Document Number: Page
Version: 0.1
Polaris Wireless Confidential
ii


Table of Contents

Revision History ............................................................................................................................ ii
1. Introduction ..............................................................................................................................3
2. Site Licensing File ....................................................................................................................3
2.1 File naming convention ................................................................................................................. 3
2.2 Site License File Content .............................................................................................................. 4
3. Tool usage ..................................................................................................................................4
3.1 Create Site License File (Encrypt) .................................................................................................. 5
3.2 Decrypt Site License File ............................................................................................................... 5
4. Reference ...................................................................................................................................6




Revision History
Version Date Author Change
0.1

14
th
November 2013 Amar Initial document




1. Introduction
This document describes site license file information and options available to encrypt/descript
site license file.

This site license file will be input to SMLC and LAM to enable and disable site license.
2. Site Licensing File
Site license file contains following information

Carrier Name
RAT Type
Location method
License Expiry Time
List of sites (identified by site names in Type 2 data).
END
2.1 File naming convention
Site license file has the following naming convention.

SiteLicense_<CarrierName>_<RAT>_<LOCATION METHOD>_<Expiry Time>.lic

I. Carrier Name - operator or Carrier name information.

II. RAT - can be one of the following values .
o GSM
o UMTS
o LTE

III. Location Method only WLS value is supported.
o WLS

IV. Expiry Time yyyyMMddhhmmss is format of this field.

yyyy is four digits of year e.g. 2013
MM is two digits of month e.g. 07
dd is two digits of day e.g. 04
hh is two digits of hour in 24 hour format e.g. 20
mm is two digits of minutes e.g. 09
ss is two digits of seconds e.g. 59

Site licensing Tool
Document Number: Page
Version: 0.1
Polaris Wireless Confidential
4
Example of site license files names:
SiteLicense_polaris_GSM_WLS_20131014131400.lic
SiteLicense_polaris_UMTS_WLS_20121011151515.lic
SiteLicense_POLARIS_LTE_WLS_00001030101000.lic
2.2 Site License File Content
Each field is separator by new line ( \n) only. Tool automatically adds new line between each
field. Site licensing file contain below Tag and values and they are separated by :

CARRIER: Carrier is present in 1
st
line in the file and contains name of
carrier/operator.

RAT: RAT is present in 2
nd
line in the file and contains either
o GSM
o UMTS
o LTE

LOCATION METHOD: Location method is present in 3
rd
line in the file. Currently
only WLS Location method is supported.

LICENSEEXPIRYTIME: Expiry time of the license is present in 4
th
line in the file.

Format of this field is as follows,

yyyy is four digits of year e.g. 2013 (Range is 0000 to 9999);
MM is the two digits of the month e.g 07 (Range is 01 to 12 )
dd is two digits of day e.g. 04 (Range is 01 to 31)
hh is two digits of hour in 24 hour format e.g. 20 ( Range is 00 to 23)
mm is two digits of minutes e.g. 09 (Range is 00 to 59)
ss is two digits of seconds e.g. 59 (Range is 00 to 59)

The time is specified in UTC time.

Licensed sites: Fifth line onwards, license file contains sites that are licensed for WLS.
Each line contains one site name as present in Type2 data. User need to create a file
containing WLS sites one per line and this file will be input to tool.

End of file: End of file is represented by END text.

3. Tool usage
Tool provides below two options,

# ./SiteLicense_R<Version Number>

Site licensing Tool
Document Number: Page
Version: 0.1
Polaris Wireless Confidential
5
Usage options
Encrypt: ./SiteLicense -e
Decrypt: ./SiteLicense -d
3.1 Create Site License File (Encrypt)
First create a site file that will contain WLS sites that need to be licensed. Only one site name
should be present in one line and next site should be separated by new line feed.

Tool does not validate content of site names in site file, so user need to make sure to provide
correct values.

Use vi or any editor to create site file containing sites names in it. e.g. site1, site2, site3 etc

For example:
# cat sites.txt
site1
site2
site3
site4
site5

After site file is created, run tool with option -e to create site license file.


# ./SiteLicense -e
Carrier Name: POLARIS
RAT [1-GSM, 2-UMTS, 3-LTE]: 1
License Expiry time [yyyyMMddhhmmss]: 20131231230000
File Name Containing WLS Sites: sites.txt
Site License file created: SiteLicense_POLARIS_GSM_WLS_20131231230000.lic

3.2 Decrypt Site License File
Run tool with option -d to descript site license file.

# ./SiteLicense -d
Site License filename: SiteLicense_POLARIS_GSM_WLS_20131231230000.lic
Site License file decrypted: SiteLicense_POLARIS_GSM_WLS_20131231230000.lic.txt

# cat SiteLicense_POLARIS_GSM_WLS_20131231230000.lic.txt
CARRIER:POLARIS
RAT:GSM
Site licensing Tool
Document Number: Page
Version: 0.1
Polaris Wireless Confidential
6
LOCATION METHOD:WLS
LICENSEEXPIRYTIME:20131231230000
site1
site2
site3
site4
site5
END

If user want to append one or more sites to an existing license file, then
First descript the site license file
Create site file with new sites in it.
Re create license file using option -e
4. Reference

FS - Site License 1.0