cbrs alliance identifier management cbrsa-tr-0102 v1.0.0 · 2019-03-12 · within this shared hni....

CBRSAlliance3855SW153rdDriveBeaverton,[email protected]©2019CBRSAllianceAllRightsReserved

CBRSAllianceIdentifierManagement:DatabaseandUserInterfaceDesign

CBRSA-TR-0102

V1.0.0

March5,2019

mailto:[email protected]


LEGAL DISCLAIMERS AND NOTICES THIS SPECIFICATION IS PROVIDED "AS IS," WITHOUT ANY REPRESENTATION OR WARRANTY OF ANY KIND, EXPRESS, IMPLIED, OR STATUTORY; AND TO THE MAXIMUM EXTENT PERMITTED BY LAW, CBRS ALLIANCE, AS WELL AS ITS MEMBERS AND THEIR AFFILIATES, HEREBY DISCLAIM ANY AND ALL REPRESENTATIONS AND WARRANTIES, INCLUDING WITHOUT LIMITATION ANY WARRANTIES OF MERCHANTABILITY, TITLE, NON-INFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, ACCURACY, OR RELIABILITY, OR ARISING OUT OF ANY ALLEGED COURSE OF PERFORMANCE, DEALING OR TRADE USAGE. ANY PERMITTED USER OR IMPLEMENTER OF THIS SPECIFICATION ACCEPTS ALL RISKS ASSOCIATED WITH THE USE OR INABILITY TO USE THIS SPECIFICATION. THE PROVISION OR OTHER PERMITTED AVAILABILITY OF OR ACCESS TO THIS SPECIFICATION DOES NOT GRANT ANY LICENSE UNDER ANY PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS ("IPR"). FOR MORE INFORMATION REGARDING IPR THAT MAY APPLY OR POTENTIAL AVAILABILITY OF LICENSES, PLEASE SEE THE CBRS ALLIANCE IPR POLICY. CBRS ALLIANCE TAKES NO POSITION ON THE VALIDITY OR SCOPE OF ANY PARTY'S CLAIMED IPR AND IS NOT RESPONSIBLE FOR IDENTIFYING IPR. TO THE MAXIMUM EXTENT PERMITTED BY LAW, UNDER NO CIRCUMSTANCES WILL CBRS ALLIANCE, OR ANY OF ITS MEMBERS OR THEIR AFFILIATES, BE LIABLE FOR DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, SPECIAL, EXEMPLARY, PUNITIVE, OR OTHER FORM OF DAMAGES, EVEN IF SUCH DAMAGES ARE FORESEEABLE OR IT HAS BEEN ADVISED OR HAS CONSTRUCTIVE KNOWLEDGE OF THE POSSIBILITY OF SUCH DAMAGES, ARISING FROM THE USE OR INABILITY TO USE THIS SPECIFICATION, INCLUDING WITHOUT LIMITATION ANY LOSS OF REVENUE, ANTICIPATED PROFITS, OR BUSINESS, REGARDLESS OF WHETHER ANY CLAIM TO SUCH DAMAGES SOUNDS IN CONTRACT, WARRANTY, TORT (INCLUDING NEGLIGENCE AND STRICT LIABILITY), PRODUCT LIABILITY, OR OTHER FORM OF ACTION.

https://docs.wixstatic.com/ugd/0c1418_86da323bd9bd46e786d9ac111f06b16c.pdf


TableofContents1. Introduction.........................................................................................................................................12. CBRSIdentifiers.................................................................................................................................1

3. References............................................................................................................................................2

4. Glossary.................................................................................................................................................25. Conventions.........................................................................................................................................3

6. Status......................................................................................................................................................4

7. Database................................................................................................................................................67.1. Global.............................................................................................................................................7

7.2. SharedHNI(SHNI)...................................................................................................................77.3. IBN(IMSIBlockNumber)......................................................................................................8

7.4. Account..........................................................................................................................................9

7.5. Contact........................................................................................................................................117.6. CBRS-NID...................................................................................................................................12

7.7. MMEGI(MMEGroupID).....................................................................................................12

7.8. MacroeNBID(MENBI).......................................................................................................137.9. TrackingAreaCode(TAC).................................................................................................14

7.10. IDRecordChange................................................................................................................157.11. Statistic....................................................................................................................................15

7.12. Invoice......................................................................................................................................16

7.13. InvoiceItem...........................................................................................................................177.14. Product....................................................................................................................................17

8. UserInterfaceDefinition.............................................................................................................188.1. UserInterfaceDiagram.......................................................................................................18

8.2. Login............................................................................................................................................18

8.3. Dashboard.................................................................................................................................19


8.4. Contact........................................................................................................................................20

8.5. CBRS-NID...................................................................................................................................208.6. MMEGIportionofGUMMEI...............................................................................................20

8.7. MacroeNBIDportionofECGI..........................................................................................218.8. IBN................................................................................................................................................21

8.9. TrackingAreaCodeportionofTrackingAreaID.....................................................21

8.10. Confirmation.........................................................................................................................228.11. Payment...................................................................................................................................22

9. PageLayout.......................................................................................................................................23

10. IDTableRules...............................................................................................................................2411. AdministratorActions...............................................................................................................24

12. BackgroundTasks.......................................................................................................................25


ListofFiguresFigure1:CBRSIdentifierStateTransitions....................................................................................5

Figure2:IdentifierandOtherObjectRelationships...................................................................6

Figure3:UserInterfaceDiagram.....................................................................................................18

Copyright©2019CBRSAlliance|AllRightsReserved

1

1. IntroductionThisdocumentcontainsthedatabaseanduserinterfacedesignforasystemtomanageandadministerCBRSIdentifiers,

2. CBRSAllianceIdentifiersThefollowingidentifiersareimportantforCBRSSystems,andtheidentifiermanagementdatabasewilldocumentandpossiblymanagesomeaspectsofthelifecyclefor:

Identifier Definition CBRSRole

CBRS-NID CBRSNetworkID.InconjunctionwithSHNI,globallyanduniquelyidentifiesaCBRSNetwork.

Assignment

MMEGI 16bitpartoftheGUMMEIthatgloballyanduniquelyidentifiesanMME.

Assignment

MacroeNBID 20bitsoftheECGIthatgloballyanduniquelyidentifiesaMacroeNB.

Assignment

SHNI ASharedHNI,whichmaybeusedbyCBRSnetworksastheHNI.AssignedbyIMSIAdministrator.

Storageindatabase.

IBN IMSIBlockNumber.A4decimaldigitportionofanIMSIthatallowsaSharedHNIusertoobtainauniquerangeofIMSIcodesfortheirusers.

Storageindatabase.

TAC 16bitTrackingAreaCode.PartoftheTAI(TrackingAreaIdentifier)thatallowsmobilestoidentifyneighboringsystems.

Adviceonchoosinglocallyuniqueidentifiers

SeetheCBRSAllianceIdentifierGuidelines[1]formoreinformationontheseidentifiers,andthereasonswhysomeofthemneedtobemanaged.


2

3. References# Document

[1] CBRSAllianceIdentifierGuidelinesforSharedHNI.CBRSA-TR-0100.Inpress.

4. GlossaryTerm Definition

BCD BinaryCodedDecimal.Eachdecimaldigitsisencodedasfourbits,usingthevalues0-9(‘0000’through‘1001’),with10-15(‘1010’-‘1111’)unused.

ECGI EUTRANCellGlobalIdentifier.IntendedtogloballyanduniquelyidentifyaneNodeB,controllingagroupofcells.

GUMMEI GloballyUniqueMMEIdentifier

IBN IMSIBlockNumber.4BCDDigits

ID IdentifierorIdentity.Sometimesalsoreferredtoasa‘number’or‘code’.

IMSI InternationalMobileSubscriptionIdentity.ComposedofMCC+MCC+MSIN

MCC MobileCountryCode

MENBI MacroeNBID

MME MobilityManagementEntity

MNC MobileNetworkCode

MSIN MobileSubscriberIdentificationNumber.InthecaseofaSharedHNI,composedofIBN+UIN

CBRS-NID CBRSNetworkID.27bitnumber.


3

SHNI SharedCBRSHNI,composedofMCCandMNC,assignedtotheCBRSindustrybytheIMSIAdministrator.

TAC TrackingAreaCode.

TAI TrackingAreaIdentifier.SHNI+TAC.

UIN UserIdentityNumber.5BCDDigits.AllowsoneCBRSoperatortoassign100,000globallyuniqueIMSItotheirsubscribers.

5. Conventions• ‘#b’indicatesquantity‘#’ofbinarydigits(0or1).Alternatively,‘bbbb’

indicates4binarydigits.Longstringsofbinarydigitswillbeseparatedintogroupsoffour.

• ‘#d’indicatesquantity‘#’ofdecimaldigits.Alternatively,‘ddddd’indicates5decimaldigits.

• ‘#h’indicatesquantity‘#’ofhexadecimaldigits.Alternatively,‘hhh’indicates3hexadecimaldigits.

• Xrepresentsanunknown(unassigned)digit(decimalorhexadecimal).Thesedigitswillbeindividuallyassignedbytheoperator.

• Data/Displaytypesareoneofthefollowing:o Text.Astringofcharacters.o BCD.Binarycodeddecimaldisplayedasdecimaldigitso Decimal.Anintegerdisplayedasdecimaldigits.o Hex.Anintegerdisplayedinbase16.o Binary.Anintegerdisplayedinbase2.o Currency.AUSdollarvalue,displayedwiththe$signandtwodecimal

places.o Date.Year,monthday.o Time.Hours,minutes,secondso DateTime.DateandTimeinonedisplay.o Enumerated.Afieldthatmaycontainoneofalistofwords,each

representingauniquevalue.o Set.Afieldthatmaycontainzeroormoreofalistofwords.o Email.Atextstringthatisvalidatedasasyntacticallyvalidemail

address.o Phone.Atextstringthatisvalidatedasapossibleinternationalphone

number(e.g.digits,spaces,hyphens,parentheses,plussign,periods).o URL.Atextstringthatisvalidatedasasyntacticallyvalidweb

address.


4

o Link.Afieldthatcreatesajoinwithanothertable.Theimplementationwillvarydependingonthedatabasebeingused.

• Forthefournumericdisplaytypes,ifthenumberofdigitsisspecified,leadingzeroesareshown.

• Calculatednumericfields(e.g.hexorbinaryvalues)areshownas“Text”fields,toallowforformatting,suchasspacesbetweengroupsofdigits,forlegibility.

6. StatusEveryIDthatisassignedhasoneofasmallnumberofstatuses.Thestatusiscloselyassociatedwitha‘ReclamationDate’,thedateuponwhichanautomaticstatuschangeto‘Unassigned’willoccur.ThefollowingStateTransitionDiagramdefinesthestatus,andtheallowedtransitions.

Status Description Reclamation

(non-existent) IDswithvaluesaboveacounterkeptintheSharedHNItablewillnotyethaveadatabaserecord,andthereforewillnotyethaveanexplicitstatus,buttheyaretreatedasunassigned.

n/a

Unassigned AgroupofIDrecordscanbecreatedbytheadministratorasneeded,andallwillbeinitializedtothisstatus.

n/a

Selected Intheprocessofbeingselectedbyauser,butnotyetconfirmed.

1week

Pending Confirmedbyauser,butnotyetpaid. 1week

Assigned Paymentconfirmed,andassignedtoanoperator

n/a

Reclaiming Intheprocessofbeingtakenbackbecauseofevidencethatitisnolongerinuse(e.g.acompanyhasshutdownitsoperationsandcannotbecontacted).

1year

Releasing Intheprocessofbeingvoluntarilyreleasedbyanoperator.

1week


5

EveryIDwithastatuswillalsomaintaintheLastChangedate,andeverystatuschangewillcreatearecordinthe“IDRecordChange”table.IDswitheverystatusexceptUnassignedalwayshavealinktoanaccountrecord.IDswith“Unassigned”statuswillneverhavealinktoanaccountrecord.

Figure1:CBRSIdentifierStateTransitions

CBRS Identifier Status Transitions

Unassigned

Code(s) requestedAdd to basket

Basket confirmedSubmit for approval

Application approved

1 week later

Application rejected

Selected

Pending

Assigned

Reclaiming

Releasing

Explanation: Red circles are statuses (stored in database for each code). Green arrows indicate allowed transitions. Underlined text is a transition condition. Text below underline is the action (other than status change) that occurs upon status transition.

Operator returns code(s)

Evidence that codes are not in use

Returned or no action for 1 week

1 year later


6

7. DatabaseThedatabaseisillustratedasanEntity-Relationshipdiagram.Therectanglesrepresententities,akadatabasetables.Thearrowsrepresentone(noarrowhead)tomany(singlearrowhead)relationships1.Theentitiesidentifiedas‘Operator’willnotbestoredintheCBRSAlliancedatabase,astheseportionsofidentifiersaremanagedbytheSHNICBRSoperator.

Figure2:IdentifierandOtherObjectRelationships

Eachofthedatabasetablesisdescribedbelow.Notethat,duringimplementation,additionalfieldsmayberequiredforpracticalpurposes(suchascreatingoroptimizingjoins).Implementationoftheconnectionsbetweentables(joins)mayalsorequireadditionalfields(dependingonthedatabasesystem).TheseareimpliedbytheEntity-Relationshipdiagramabove,butaregenerallynotlistedinthetablesbelow.

1 Aone-to-manyrelationshipisactuallyaone-to-zero,oneormorerelationship.

Contact

IMSIBlock•  IBN

Network•  CBRS-NID

MMEGroup• MMEGI

Cell/eNodeB•  ECGI

Account•  CBRSacct#•  Loginusername

SharedHNI• MCC+MNC

MMECode

Cellnumber

IdenFfierandotherObjectRelaFonships

CBSD

Administrator

IMSI-A

CBRSA

Operator


7

7.1. GlobalThistablecontainsasinglerecordwithfieldsthatapplyacrosstheentiredatabase.

Field Datatype Description

NextavailableCBRS-NIDforrelease

Decimal 1..227.RepresentsthenextCBRS-NIDtobereleasedwithinthisSharedHNI.Initially1

AdminEmail Email Theemailaddresstowhichcustomerservicemessagesshouldbesent.

Selectedtimeout

Integer ThenumberofdaysbeforeaselectedcodeisreturnedtoUnassigned(suggested:7)

Reclaimingtimeout

Integer ThenumberofdaysbeforeacodebeingreclaimedbecomesUnassigned(suggested:365).

Releasingtimeout

Integer ThenumberofdaysbeforeacodebeingreleasedbecomesUnassigned(suggested:7).

7.2. SharedHNI(SHNI)TheSharedHNIorSHNIisassignedbytheIMSIAdministrator,butwillbestoredintheCBRSAlliancedatabase.Atpresentthereisonlyoneidentifier,buttheremaybeadditionalcodesassignedinthefuture,andthedatabaseisplannedwiththisinmind.

Field Datatype Description

MCC BCD Mandatory,3d

MNC BCD Mandatory,3d

NextavailableMMEGIforrelease

Hex 1..216.RepresentsthenextMMEGItobereleased.Initially1

NextavailableMacroeNBIDforrelease

Hex 1..220.RepresentsthenextMacroeNBIDtobereleased.Initially1


8

7.3. IBN(IMSIBlockNumber)

IBNsareassignedbytheIMSIAdministrator,butassigneeswillberequiredtoprovidethemforstorageintheCBRSAlliancedatabase.Thisisbeneficialforfutureroamingcapabilities(suchasroutingDiameterorRadiusmessagesbasedonIMSI)andforthegenerationofrecommendedTACvalues.

Field Datatype Restrictions

IBN BCD Mandatory,4d

BinaryValue Text Calculationfield(conversionofBCDdigitstobase2),16b.

FullvalueofIMSI Text MCC+MNC+IBN+XXXXX

ddd-ddd-dddd-XXXXX

CalculationfieldshowingentireIMSI(with‘X’representingadigittobeassignedbytheoperator).


9

7.4. AccountEveryorganizationgrantedaccesstothedatabasewillhaveasingleaccountrecord,whichwillbelinkedtosinglelogincredentials.

NOTE:ItiscurrentlyassumedthatloginprivilegesareheldattheAccountlevel,butthesemightbemovedtotheindividualContact.


Status Enumerated(‘Pending’,‘Operator’,‘Suspended’,‘Locked’,‘Other’).

Mandatory,notchangeablebyaccountowner.‘Pending’accountshavenotyetbeenapprovedby‘CBRSA’.Only‘Operator’accountscanapplyforIDs.Failedloginsmayputtheaccountin‘Locked’status,andnon-paymentoffeesinto‘Suspended’status.

Onlyan‘Operator’accountcanrequesttheassignmentofIDs.

Login Text Theloginnameforthisaccount.Mandatory,notchangeablebyaccountowner.

Loginprivileges Enumerated(Admin,Manager,Operator,Web)

An‘Adminhasfulldatabaseaccess.A‘Manager’canaccessallrecordsandperformnormalcustomerserviceandmaintenanceoperations.An‘Operator’canaccessonlytheirownIDrecords,andistheonlytypeofuserallowedtoallocateIDs.The‘Web’userisallowedtoviewbasicinformationforallassignedIDs.

Name Text Nameofaccount(e.g.nameofcompany).Mandatory

Phone Phone Mainphonenumber.


10

Mandatory.

Fax Phone Accountfaxnumber.Optional

Email Email MainemailaddressMustbevalidemailaddress

Address Text StreetAddressofaccount.Mandatory

City Text Nameofcityinaddress.Mandatory

State Text 2digitstatecode(e.g.MD,TX).Mandatory.UnvalidatedifcountryisnotUSA.

Zip Text Zipcode.Mandatory.UnvalidatedifcountryisnotUSA.

Country Text Nameofcountry.Mandatory,defaultstoUSA

Website URL Accountwebsite.Optional

CurrentSHNI Link LinkstothedefaultSHNItobeusedwhenrequestingCBRS-NID,ECGIorMMEGIcodes.

CreditorDebit Currency Modifiableonlybyadministrator.Apositivevalueisacredittotheuser,anegativevalueisanoutstandingamountowing.

RenewalDate Date Establishedas1yearafterfirstassignment,andincrementedwitheveryannualrenewal.


11

7.5. ContactEveryorganizationshouldhaveatleastthreecontactnamesinthedatabase.


Name,Last Text Lastnameofcontact.Mandatory

Name,First Text FirstnameofContact.Mandatory

Phone Phone Contactphonenumber.Mandatory

Fax Phone Contactfaxnumber.Optional

Email Email Contactemailaddress.Mandatory

Address Text StreetAddress.Optional

City Text Nameofcity.Optional

State Text Stateorprovince.Optional.ValidatedonlyifcountryisUSA.

Zip Text Zipcode.Optional.ValidatedonlyifcountryisUSA.

Country Text Nameofcountry.Mandatory.DefaultstoUSA.

Role Set(‘Invoice’,‘Technical’,‘Regulatory’)

Therole(s)ofthecontact.Optional.


12

7.6. CBRS-NIDRecordsinthistablearecreatedbytheassignmentprocessandonlythenameofthenetworkischangeablebytheaccountholder.


CBRS-NID Decimal DecimalvalueofCBRS-NID,0..227-Mandatory

Name Text Anarbitrarynameassignedtoidentifythenetwork(e.g.CentervilleCollegeCampus).Mandatory.Modifiable.

HexValue Text CBRS-NIDshownashhhhhhh.Calculationfield(conversiontohexadecimaldigits)

BinaryValue Text CBRS-NIDshownas27individualbits.Calculationfield(conversiontobinary)

Status Enumerated(see‘Status’section)

CurrentstatusofID.ProvisionedbytheIDmanagementprocess.

ReclamationDate Date DateuponwhichtheIDwillreturnto‘Unassigned’.ProvisionedbytheIDmanagementprocess.

7.7. MMEGI(MMEGroupID)

Recordsinthistablearecreatedbytheassignmentprocessandareunchangeablebytheaccountholder.


MMEGI(Dec) Decimal DecimalvalueofMMEGI,0..216.Mandatory

MMEGI(Hex) Text MMEGIshownashhhh.


13

Calculationfield(conversiontohexadecimaldigits)

MMEGI(Binary) Text MMEGIshownas16individualbits.Calculationfield(conversiontobinary)

FullValueofGUMMEI

Text MCC-MNC-MMEGI-XXddd-ddd-hhhhh-XX.

CalculationfieldtoshowfullGUMMEI,includingXXdigitstobeassignedbytheoperator.




7.8. MacroeNBID(MENBI)

Recordsinthistablearecreatedbytheassignmentprocessandareunchangeablebytheaccountholder.


MENBI(Dec) Decimal DecimalvalueofMacroeNBID,0..220.Mandatory

MENBI(Hex) Text MacroeNBIDshownashhhhh.Calculationfield(conversiontohexadecimaldigits)

MENBI(Binary) Text MacroeNBIDshownas20individualbits.Calculationfield(conversiontobinary)

FullValueofECGI Text MCC-MNC-MENBI-XX


14

ddd-ddd-hhhhh-XXCalculationfieldtoshowfullECGI,includingXXdigitstobeassignedbytheoperator.




7.9. TrackingAreaCode(TAC)RecordsinthistablearecreatedeverytimeanIBNisadded(ordeleted)andareunchangeablebytheaccountholder.Becausethiscodeisnotadministrableitdoesnothaveastatus.


TAC(Dec) Decimal DecimalvalueofTrackingAreaCode(16b,0-59999).Read-only

TAC(Hex) Text Calculatedhexadecimalvalue.

TAC(Binary) Text Calculatedbinaryvalue.

FullValueofTAI Text MCC-MNC-TAC(Hex)ddd-ddd-hhhh

CalculationfieldtoshowfullTAI.


15

7.10. IDRecordChangeRecordsinthistablearecreatedeverytimeastatuschanges.Thistablecanonlybequeriedbyadministrators,andservesasausefullogofactivityonthesystem.


IDValue Text ValueofID(CBRS-NID,MMEGI,ECGI).Mandatory

IDType Enumerated(‘CBRS-NID’,‘MMEGI’,‘MENBI’,‘IBN’)

Mandatory

ChangeDate Date Dateofstatuschange.Mandatory

NewStatus Enumerated(see‘Status’section)

Statusafterchange.Mandatory

OldStatus Enumerated(see‘Status’section)

Statusbeforechange.Mandatory

AccountName Nameofassociatedaccountbeforeorafterthestatuschange.2Mandatory

7.11. Statistic

Recordsinthistablearecreatedonthefirstofeverymonthreflectingthecurrentstatusofthedatabase.


StatisticDate Date Thiswillbethefirstdayofthemonthinwhichthestatisticiscalculated.Mandatory

Entity Enumerated:

• CBRS-NID_New• CBRS-NID_Total

Mandatory.‘New’referstothenumberofIDstransitioningto‘Assigned’intheprevious

2 ThisisastatictextfieldandnotalinktotheAccountrecord,sothatifanaccountrecordis

changed,orcodesaretransferredtoanotherentity,theaccountnameatthetimeofthestatuschangewillalwaysbepresent.StatuschangesareeithertoorfromUnassigned(inwhichcasetheaccountnamewhentheIDisnotUnassignedwillbeused)orbetweentwootherstatuses(inwhichcasetheaccountshouldbethesamebeforeandafter).


16

• IBN_New• IBN_Total• MMEGI_New• MMEGI_Total• MENBI_New• MENBI_Total

month.‘Total’referstothenumberofIDsinthe‘Assigned’statusatthebeginningofthemonth.

7.12. Invoice

Recordsinthistablecontaintheinformationfortheheaderofaninvoiceforanaccount.


Date Date Creationdateofinvoice,auto-assigned,unchangeable.

Number Decimal Uniqueinvoicenumber,auto-assigned,unchangeable.

Status Enumerated(Open,Paid,Cancelled)

Thestatusoftheinvoice,unchangeablebytheuser.


17

7.13. InvoiceItem

Recordsinthistablecontainoneitem(e.g.identifier)includedinaninvoice.Aninvoiceitemmaybealistedproduct(e.g.CBRS-NID)oradebit/credit.


Type Enumerated(Product,Debit,Credit)

Calculatedbysystem

ProductName Text Calculatedbysystem(e.g.nameofID)

Quantity Decimal CalculatedbysystemasnumberofIDsselectedbyuser.

Price Currency Calculatedbysystem(e.g.fromProducttable)attimeofinvoicecreation

Subtotal Currency QuantityxPrice

7.14. Product

ProductswillbeAssignment(initial)andRenewal(annual)feesforeachtypeofidentifier.


Name Text Ashortnamefortheproduct

Description Text Fulldescriptionofidentifierorotherproduct

Price Currency Priceofproduct.Omittedforaproductwithnodefinedprice(e.g.creditanddebit).


18

8. UserInterfaceDefinition8.1. UserInterfaceDiagram

Thisdiagramshowsthenormalflowthroughtheuserinterface.Each‘page’(implementationdoesnotnecessarilyhavetorepresenteachasaseparatewebpage)isdescribedseparately,below.Abluedotisacompactrepresentationforabuttonthatprovidesalinktoapagewiththesamename(e.g.NID).

Figure3:UserInterfaceDiagram

8.2. LoginAusercanenteravalidusernameandpasswordandwillberoutedtothe“Dashboard”.Alternatively,theusercanrequestapasswordresetwhichwillbesenttoalltheemailaddressesinallthecontactrecordsforthataccount/username.Anewusercanalsoregister,providingthefollowinginformation:

• Nameoforganization• Nameofpersonregistering

Dashboard

View/edit Account information, currrent SCH

LoginEmail

Review

Report

Qik ID

Confirmation

View/delete pending IDs

Payment

TAC

View only

KeyAction button

Screen

Customer Service action

Offline user action

Page link

Action

ID

Review

Email

Contact

View + Edit

Add

Reset

RegisterLogin

Email confirmation

CBRS-NID

View ID/edit name

MMEGI

View IDApply

Apply

IBN

View IDAdd

Cart

Payment

Pay or release codes

Pay

1 NID, 1 MMEGI,1 Macro ID

Macro eNB ID

View IDApply


19

• Phonenumber• Emailaddress• DescriptionofCBRSSpectrumUsage(tojustifyassignment).• Technologyused(‘LTE’or‘5G’)

Theuserwillbeinformedthattheirrequesthasbeensubmittedandtheywillbecontactedwithlogininformation(similartoapasswordreset)iftheirrequestisapproved.

Morethan5loginattemptswillputanaccountinto‘Locked’statusandonlyanadministratorcanrestoreittoservice.Aloggedinuserwithoutadministratoraccesscanonlyviewtheirowninformation(IDs,invoices,contacts).

8.3. DashboardThisisthecenteroftheapplicationoncetheuserisloggedin.

Data

Theaccountdatawillbeshownonthispage(e.g.contactinformation)andiseditable.

Buttons

• (Report)ThiswillproduceaPDFfilecontainingthelistofallIDsassociatedwiththisaccount,allaccountinformation,andthelistofallcontacts.

• (QikID)ItisexpectedthatmanyassignmentswillbeforasingleCBRS-NID,singleMMEGIandasmallnumberofMacroeNBIDs,sothisbuttonwillperformthisallocationinonestep.PartoftheprocesswillbetorequestanIBNfromtheuserwithanotethatadditionalIBNcodescanbeaddedtotheaccountseparately.TheuserwillberoutedtotheConfirmationPage.

• (Cart)Thiswillgotothe‘shoppingcart’confirmationpagewithoutassigninganynewIDs.

Links

Theusercanchoosetolinktooneofthefollowingpages.Eachlinkwillbeshownasabuttonwiththenameofthedestinationandthenumberofrecordsassociatedwiththisaccount(e.g.“CBRS-NID(5)”):

• Contact• CBRS-NID• MMEGI• MacroeNBID(MENBI)• IBN• TAC


20

8.4. ContactThispagewillpresentthelistofallcontactsassociatedwiththisaccount.

Data

Alistofrecordswillbedisplayed(scrollingifnecessary).Fieldsareeditableasdescribedabove.Eachrecordwillhaveabuttontodeletethecontact.

Buttons

• (Add)Thiswillroutetoapageorformwheretheinformationforanewcontactcanbeentered,andthensaved.

• (GoBack)Returntothedashboard.• (Delete)Buttononeverycontactrecordinlisttoremovethecontact.RequiresYes/Noconfirmationwhenpressed.

8.5. CBRS-NIDThispagewillpresentthelistofallCBRS-NIDcodesassociatedwiththisaccount.

Data

Alistofrecordswillbedisplayed(scrollingifnecessary).EachCBRS-NIDrecordwilldisplayallthedatafields.OnlytheNamefieldiseditable.

Buttons

• (Apply)Thiswillmarkone“Unassigned”CBRS-NIDcodeas‘Selected’,requestthenamefromtheuser,andgototheConfirmationPage.ThiswillalsosettheReclamationDate,LastChangeDate,andcreateaCodeChangerecord.

• (GoBack)Returntothedashboard.• (Delete)ButtononeveryCBRS-NIDrecordinlisttoreleasetheID,puttingitin“Releasing”status.

8.6. MMEGIportionofGUMMEI

ThispagewillpresentthelistofallMMEGIcodesassociatedwiththisaccount.

Data

Alistofrecordswillbedisplayed(scrollingifnecessary).EachMMEGIrecordwilldisplayallthedatafields.Nofieldsareeditable.

Buttons

• (Apply)ThiswillmarkoneMMEGIcodeas‘Selected’andgototheConfirmationPage.ThiswillalsosettheReclamationDate,LastChangeDate,andcreateaIDRecordChange.


21

• (GoBack)Returntothedashboard.• (Delete)ButtononeveryMMEGIrecordinlisttoreleasetheID,puttingitin“Releasing”status.

8.7. MacroeNBIDportionofECGI

ThispagewillpresentthelistofallMacroeNBIDsassociatedwiththisaccount.

Data

Alistofrecordswillbedisplayed(scrollingifnecessary).EachMacroeNBIDrecordwilldisplayallthedatafields.Nofieldsareeditable.

Buttons

• (Apply)Thiswillrequestthenumberofcodesfromtheuser(1-100).Oncereceived,itwillmarkthisnumberofMacroeNBIDcodesas‘Selected’andgototheConfirmationPage.ThiswillalsosettheReclamationDate,LastChangeDate,andcreateaIDRecordChangeforeachcode.

• (GoBack)Returntothedashboard.• (Delete)ButtononeveryECGIrecordinlisttoreleasetheID,puttingitin“Releasing”status.

8.8. IBNThispagewillpresentthelistofallIBNcodesassociatedwiththeaccountthatareusedtoformIMSIsbytheoperatorandtocreatealistofrecommendedTACvalues.

Data

Alistofrecordswillbedisplayed(scrollingifnecessary).EachIBNrecordwilldisplayallthedatafields.TheIDfieldcanbemodified(toanothervalidIBN)andrecordscanbedeleted.

Buttons

• (Add)ThiswillacceptavalidIBNcode(6d)fromtheuserandthencreateanewIBNrecord.ThisisdonewithoutgoingtotheConfirmationpage(sincetheuserisjustreportingthecodestheyreceivedfromtheIMSIadministrator).ThisactionwillalsocreaterecommendedTrackingAreaCodes.

• (GoBack)Returntothedashboard.

8.9. TrackingAreaCodeportionofTrackingAreaIDThispagewillpresentthelistofallrecommendedTrackingAreaCodesassociatedwiththeaccount.

EverytimeanIBNisaddedtothedatabaseforanaccount,the6associatedTrackingAreaCodeswillbeaddedforthesameaccountasdescribedin[1].


22

EverytimeanIBNisdeleted,the6associatedTrackingAreaCodeswillalsobedeleted.

Data

Theread-onlylistofrecommendedTrackingAreaCodevalueswillbeshown.

Buttons

• (GoBack)Returntothedashboard.

8.10. Confirmation

ThispagewillpresentthelistofallIDsinthe‘Selected’statusforthisaccount,the‘shoppingcart’

Data

Eachrecordwilldisplaythetypeofcode,itsnumericvalue,andthenumberofcodestobeassigned.ForCBRS-NID,theNamefieldcanbemodified.Nootherfieldscanbemodified.

Records,representingpendingassignments,canbedeletedbytheuser.

Buttons

• (Payment)AslongasthereismorethanoneselectedID,thisbuttonwillchangethelistofIDsto‘Pending’,createaninvoiceandroutetheusertothePaymentpage.

• (GoBack)Returntothedashboard.• (Delete)AbuttonbesideeachbuttontoreleasetheID(returningitto“Releasing”status).Y/Nconfirmationwillberequired.

8.11. Payment

Thispagewillpresentaninvoicecreatedfromtheshoppingcartinformation.Ifthereisacreditordebitontheaccount,thiswillbeaddedasalineitemtotheinvoice,andtheamountintheAccountrecordzeroedout.IftheaccountdoesnothaveaRenewalDateestablished,itwillbesettooneyearfromtoday.

Data

Theinvoicewillbedisplayedwithallinvoiceitems,inascrollingframeifnecessary.

Buttons

• (Pay)Theuserwillberequestedtoprovidecreditcardinformation,itwillbevalidated,andthepaymentwillbeattempted.Ifpaymentissuccessful


23

thenthestatusoftheinvoicewillchangeto“Paid”andthestatusofallidentifiersincludedontheinvoicewillbechangedto“Assigned”.

• (GoBack)Returntothedashboard.• (Release)Whenpressed,theuserwillhaveachoiceofreleasingtheidentifiers(“Releasing”status)orreturningthemtotheshoppingcart(“Selected”status).

9. PageLayoutPagelayoutwillhavethefollowingelements(exceptfortheloginpage):

GoBackicon CBRSABranding

Loggedinas Logout Help

Toolbar(page-specificbuttons)

Page-specificdata(masterrecord)

Listrecord1 Recordactionbutton

… Listrecordn Recordactionbutton

Thepagelayoutelementsare:

Item Description

GoBackicon Aniconthatreturnstheusertothepreviouspagewhenclicked.

CBRSABranding TheCBRSAlogo

Loggedinas Identificationoftheloggedinuser(e.g.“LoggedinasCentervilleManufacturingLtd.”)

Logout Abuttonthatlogstheuseroutoftheapplication

Help Willbringupapageofhelpinformationthatisrelevanttothatpage,plusalinktothefullonlinehelp.

Toolbar Page-specificbuttons.Mostpagesonlyhaveone

Page-specificdata Datafromthemasterrecord,ifapplicable.


24

Listrecordn Datafromthen’thsubsidiaryrecord

Recordactionbutton

Abuttonlinkedtotheassociatedsubsidiaryrecord(e.g.delete).

10. IDTableRulesThefollowingtablesummarizestheaccessanddisplayrulesforlistsofIDs.Acheckmarkindicatesanoperationthatisallowed,andacrossindicatesaforbiddenoperation.“R”indicatesthattheprocessofreturninganIDwillbeinitiated:

CBRS-NID MMEGI MacroeNBID IBN TAC

Editable Name ! ! ! !

ShowID " " " " "

ShowHex " " " ! "

ShowBinary " " " " "

ShowFull ! " " " "

Deletionallowed

R R R " !

11. AdministratorActionsThemaintasksfromtheautomatedsystemthathavetobehandledbyauserwith‘Manager’privilege,andthusmustalsobesupportedbythesystem:

• Reviewnewaccountregistrations.TheincominginformationwillautomaticallyberoutedintoanewAccountandContactRecordifapproved.

• CreatenewUnassignedcodes.TheAdministratorwillspecifythetype(CBRS-NID,MMEGIorMacroeNBID),numberofcodes,andtheSharedHNIrecordtouse,ifthereismorethanone.Recordswillbegeneratedwhileincrementingtheappropriate“nextcode”fieldintheSharedHNIrecord.

Theadministratormayneedtoperformothertasksthatarenotautomated,suchas:

• CreatinganHNIrecord.


25

• Mergingtwoaccounts.• Changingthestatusofanaccount.• ManuallychangethestatusofanID(e.g.toallowreclamationorrelease).• Manuallychanginganaccountorcontactemailtoallowapasswordreset

(securityriskiftheemailaddressdoesnotbelongtotheorganization,butmaybenecessaryifacompanychangesitsdomainnameandtheolddomainisnolongerworking).

• Manuallychangingthereclamationdate(e.g.ifanorganizationneedsmoretimetodecidewhatcodesitwillneedandsomeare‘Selected’).

• Addacreditordebit(amountowing)toanaccountrecord.

12. BackgroundTasksThefollowingtaskswilloccuronthesystem,inthebackground,e.g.onceaday,inthemiddleofthenight:

• EveryIDthathasaReclamationDatebeforetodaywillbesetto“Unassigned”(unlessthecurrentstatusis“Assigned”,whichshouldbeloggedasanerror).AnIDRecordChangewillbecreated.

• OnthefirstdayofeverymonthonerecordforeachtypeofstatisticwillbecreatedintheStatisticstable.

• AnoticewillbesenttotheAdministratorwithalistofallcodesinthefollowingstatuses:

o “Selected”,“Releasing”,“Reclaiming”withReclamationDatelessthan3daysinthefuture.

o “Pending”with“LastChange”datemorethan1dayinthepast.• Anoticewillbesenttoauserwithcodesthathavebeenin“Selected”or

“Pending”statusafter1day,and1daybeforereclamation,notifyingthemthatthecodeswillbereclaimediftheprocessisnotcompleted.

• Annually,aninvoicewiththeannualrenewalfeeforallassignedidentifierswillbegenerated.


26

AnnexA. RevisionHistoryVersion Date Description

1.0 March,2019 Initialversion

cbrs alliance identifier management cbrsa-tr-0102 v1.0.0 · 2019-03-12 · within this shared hni....

Documents