topologyconfig.dtd
: Elements - Entities - Source | Intro - Index
FRAMES / NO FRAMES
<conformance-test-config> | Root element |
This document allows you to specialize the configuration of the emulated RFSSs involved in a test. The ISSI emulation consists of multiple RFSSs, SU's and groups that are defined in the associated systemtopology.xml file for a test suite and inherited by the globaltopology.xml file for that test suite. The globaltopolgy.xml file is where you set SU and group associations. Here is where you define things like Group membership and other test specific behabiors. In this file you will specify user and group profiles as well as timers, registration and other such information. This is a specialization of the attributes of these emulated entities that are defined in the corresponding global-topology.xml file. The contents of the xml document are interpreted in the context of an associated globaltopology.xml. The rfss names and group names here are tied to the rfss and group names that are defined in globlatopology.xml.
Element's model:
<conformance-test-config>'s children Name Cardinality rfssconfig Any number sgconfig Any number suconfig Any number
<conformance-test-config>'s attributes Name Values Default THEARTBEAT 10000 traceOrder
(rfssconfig*, suconfig*, sgconfig*)
@THEARTBEAT | Attribute of conformance-test-config |
Timer values that you can set up ( override defaults) for this test.
Default value: 10000
@traceOrder | Attribute of conformance-test-config |
Comma separated list of rfss names for ordering the vertical lines of the sequence diagram to make it more readable. If this attribute is left out, then the trace is ordered in the order of sent messages (i.e. if RFSS_A sends a message before RFSS_B then it appears before RFSS_B in the sequence diagram ).
<rfssconfig> | Child of conformance-test-config |
This defines the configuration of an RFSS.
Element's model:
<rfssconfig>'s children Name Cardinality unknown-unit Any number
<rfssconfig>'s attributes Name Values Default groupCallInviteProcessingTime 0 groupRegistrationExpiresTime UNBOUNDED id isAdvancedRtpResourceManagementSupported true, false false isCallingSuInitrans true, false true isInterestedInLosingAudio true, false false maxRtpPorts UNBOUNDED queryGroupCredentialsBeforeRegistration true, false false querySuCredentialsBeforeRegistration true, false false registerConfirmTime 0 rfResourcesAvailable true, false true rfssName servedGroupLeaseTime UNBOUNDED
(unknown-unit*)
<unknown-unit/> | Child of rfssconfig |
An unknown unit is a unit that the RFSS does not know about. No nested tags for this one. An RFSS that sees PTT request from an unknown Unit will reject the PTT Request.
<unknown-unit>'s attributes Name Values Default suName
This element is always empty.
<suconfig> | Child of conformance-test-config |
Defines an SU. An SU has an associated User Profile which the Home RFSS keeps. The nested forbidden tag is a list of RFSSs that the Home RFSS will not allow to register an SU from for the given SUID.
Element's model:
<suconfig>'s children Name Cardinality forbidden Any number userprofile One or none
<suconfig>'s attributes Name Values Default homeRfssKnowsAboutMeFor 0, UNBOUNDED UNBOUNDED homeRfssRegistersMeFor 0, UNBOUNDED UNBOUNDED id initialState on, off off inviteProcessingDelay 0 isAvailable true, false true registerOnForce true, false true servingRfssReferencesMeFor 0, UNBOUNDED UNBOUNDED suName
(userprofile?, forbidden*)
<sgconfig> | Child of conformance-test-config |
A group configuration tag. A group is statically configured with one or more subscribers. Each subscriber is an SU. A group has a group profile that is stored at the group home.
Element's model:
<sgconfig>'s children Name Cardinality forbidden Any number groupprofile One or none subscriber At least one
<sgconfig>'s attributes Name Values Default groupName homeRfssKnowsAboutMeFor UNBOUNDED id
(subscriber+, groupprofile?, forbidden*)
<subscriber/> | Child of sgconfig |
Defines a Subscriber. A subscriber to a group is an SU.
<subscriber>'s attributes Name Values Default suName
This element is always empty.
@suName | Attribute of unknown-unit |
The unknown SU symbolic name. Must be specified in the associated globaltopology.xml
Required
<forbidden/> | Child of sgconfig, suconfig |
The tag that defines an RFSS that a given RFSS will not accept registrations from.
<forbidden>'s attributes Name Values Default operation REGISTER, REGISTER-QUERY, ALL ALL rfssName
This element is always empty.
@operation | Attribute of forbidden |
This is a local policy for the home RFSS for the given SU. It defines what REGISTER operations are allowable from a given RFSS. This addresses tests which generate FORBIDDEN responses from an RFSS. This attribute allows you to specify a local policy on registration.
Possible values: REGISTER, REGISTER-QUERY, ALL - Default value: ALL
@rfssName | Attribute of forbidden |
the rfssName (inherited from globaltopology.xml).
Required
@id | Attribute of rfssconfig |
Element identifier.
@rfssName | Attribute of rfssconfig |
- The symbolic name which we use to refer to the RFSS in the test system. This must reference an RFSS in the global topology file.
Required
@groupRegistrationExpiresTime | Attribute of rfssconfig |
- the time for which the home SU remembers its groups (default is infinity ).
Default value: UNBOUNDED
@servedGroupLeaseTime | Attribute of rfssconfig |
- the time for which we keep registration of a served Group member (default is infinity or until the group has no served SU in our range).
Default value: UNBOUNDED
@groupCallInviteProcessingTime | Attribute of rfssconfig |
- the time that the RFSS takes to respond to a group call INVITE in seconds.
Default value: 0
@rfResourcesAvailable | Attribute of rfssconfig |
- true if RF resources are available at the rfss.
Possible values: true, false - Default value: true
@maxRtpPorts | Attribute of rfssconfig |
- the max number of available RTP ports ( to emulate limited RTP resources ) .
Default value: UNBOUNDED
@querySuCredentialsBeforeRegistration | Attribute of rfssconfig |
if true, query before registration when an unregistered SU tries to register itself
Possible values: true, false - Default value: false
@queryGroupCredentialsBeforeRegistration | Attribute of rfssconfig |
if true, then before sending a register to a group, query the group credentials first.
Possible values: true, false - Default value: false
@registerConfirmTime | Attribute of rfssconfig |
- time that it takes to confirm an SU during Register CONFIRM processing. If non zero, a session progress 183 is sent out while the registration is being confrimed.
Default value: 0
@isAdvancedRtpResourceManagementSupported | Attribute of rfssconfig |
- a flag that indicates whether the RFSS supports advanced resource management.
Possible values: true, false - Default value: false
@isInterestedInLosingAudio | Attribute of rfssconfig |
- a flag that indicates whether the RFSS is interested in losing audio.
Possible values: true, false - Default value: false
@isCallingSuInitrans | Attribute of rfssconfig |
- a flag that controls the setting of c-initrans for su to su calls. This is used by the called home RFSS
Possible values: true, false - Default value: true
@suName | Attribute of suconfig |
its name
Required
@id | Attribute of suconfig |
a symbolic id which can be used in the testscript.xml to refer to this SU.
@initialState | Attribute of suconfig |
on or off
Possible values: on, off - Default value: off
@homeRfssKnowsAboutMeFor | Attribute of suconfig |
time for which home recognizes this SU
Possible values: 0, UNBOUNDED - Default value: UNBOUNDED
@homeRfssRegistersMeFor | Attribute of suconfig |
time for which home keeps registration records Right now only 0 and UNBOUNDED are supported.
Possible values: 0, UNBOUNDED - Default value: UNBOUNDED
@servingRfssReferencesMeFor | Attribute of suconfig |
Simulates how long the serving RFSS keeps a record of this SU in its mobility table.
Possible values: 0, UNBOUNDED - Default value: UNBOUNDED
@inviteProcessingDelay | Attribute of suconfig |
time to process INVITE If RF resources not available by this time, the SU sends a BUSY.
Default value: 0
@registerOnForce | Attribute of suconfig |
Re-register automatically when force register is presented for this su.
Possible values: true, false - Default value: true
@isAvailable | Attribute of suconfig |
determines whether this SU is available to take incoming SU to SU calls.
Possible values: true, false - Default value: true
@id | Attribute of sgconfig |
- A link which is referenced in the testscript.xml file.
@groupName | Attribute of sgconfig |
- The symbolic name of the group. Refers to a group name defined in globalconfig.xml
Required
@homeRfssKnowsAboutMeFor | Attribute of sgconfig |
the time for which the home RFSS keeps a record of this group (defaults to "unbounded").
Default value: UNBOUNDED
@suName | Attribute of subscriber |
- the SU Name of the subscriber. Must be defined in the associated globaltopology.xml file
Required
<userprofile> | Child of suconfig |
A user profile may be specified as in Table 23 of the 102 BACA spec or it may be specified in xml attribute form. If specified in PCDATA form, then it overrides the xml attribute setting.
<userprofile>'s attributes Name Values Default accessPermission None, Full, Emergency Full availCheckSupported AvailabilityCheck, DirectCall, AvailabilityCheckAndDirectCall AvailabilityCheckAndDirectCall groupCallPermission None, NonEmergency, Emergency, EmergencyAndNonEmergency EmergencyAndNonEmergency interconnectPermission 0, 1, 2, 3 0 interconnectSecurity 1, 2, 3 1 isFullDuplex true, false true isSecureCapable true, false false unitToUnitCallPermission None, Receive, Initiate, ReceiveAndInitiate None unitToUnitCallPriority 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 1 unitToUnitCallSetupPreference AvailabilityCheck, DirectCall AvailabilityCheck
@availCheckSupported | Attribute of userprofile |
Whether or not availability check is supported (same as u-availcheck )
Possible values: AvailabilityCheck, DirectCall, AvailabilityCheckAndDirectCall - Default value: AvailabilityCheckAndDirectCall
@isFullDuplex | Attribute of userprofile |
whether or not the unit is full duplex. Note that it is the same as u-dup
Possible values: true, false - Default value: true
@accessPermission | Attribute of userprofile |
System access permission ( same as u-access)
Possible values: None, Full, Emergency - Default value: Full
@isSecureCapable | Attribute of userprofile |
Secure capable attribute ( same as u-sec )
Possible values: true, false - Default value: false
@groupCallPermission | Attribute of userprofile |
the group call permission (u-gcall)
Possible values: None, NonEmergency, Emergency, EmergencyAndNonEmergency - Default value: EmergencyAndNonEmergency
@unitToUnitCallPermission | Attribute of userprofile |
the unit to unit call permission (u-ucall)
Possible values: None, Receive, Initiate, ReceiveAndInitiate - Default value: None
@unitToUnitCallPriority | Attribute of userprofile |
The priority for unit to unit calls (u-upri)
Possible values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 - Default value: 1
@interconnectPermission | Attribute of userprofile |
The interconnect permission. (u-iccall)
Possible values: 0, 1, 2, 3 - Default value: 0
@interconnectSecurity | Attribute of userprofile |
The interconnect security parameter ( u-icsec )
Possible values: 1, 2, 3 - Default value: 1
@unitToUnitCallSetupPreference | Attribute of userprofile |
The call setup preference (u-prefsetup)
Possible values: AvailabilityCheck, DirectCall - Default value: AvailabilityCheck
<groupprofile> | Child of sgconfig |
The group profile for this group.
<groupprofile>'s attributes Name Values Default accessPermission EmergencyOnly, NonEmergencyAllowed NonEmergencyAllowed announcementGroup confirmedGroupCallSetupTime emergencyCapable EmergencyCallsAllowed, EmergencyCallsNotAllowed EmergencyCallsAllowed emergencyPreemption NonRuthless, Ruthless NonRuthless groupPriority 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 1 groupSecurityLevel ClearOnly, SecureOnly, ClearAndSecure ClearAndSecure interconnectFlag true, false false interconnectSecurity Clear, Secure Clear interruptMode NeverAllowed, PriorityInterruptAllowed, AlwaysAllowd NeverAllowed rfHangTime
@accessPermission | Attribute of groupprofile |
Defines whether or not the group is allowed to make non-emergency calls. (g-access)
Possible values: EmergencyOnly, NonEmergencyAllowed - Default value: NonEmergencyAllowed
@announcementGroup | Attribute of groupprofile |
Defines the announcement group for the group. (g-agroup)
@groupPriority | Attribute of groupprofile |
Defines the priority of the group. (g-pri)
Possible values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 - Default value: 1
@emergencyCapable | Attribute of groupprofile |
Defines whether or not emergency calls MAY be made on the group. (g-ecap)
Possible values: EmergencyCallsAllowed, EmergencyCallsNotAllowed - Default value: EmergencyCallsAllowed
@emergencyPreemption | Attribute of groupprofile |
Defines whether ruthless or non-ruthless pre-emption is used for emergency calls. (g-eprempt)
Possible values: NonRuthless, Ruthless - Default value: NonRuthless
@rfHangTime | Attribute of groupprofile |
Defines the hang-timer for the group. (g-rfhangt)
@confirmedGroupCallSetupTime | Attribute of groupprofile |
Defines the confirmed call setup timer for the group. (g-ccsetupt)
@interruptMode | Attribute of groupprofile |
Defines under what conditions talk-group members MAY interrupt each other during a call (g-intmode)
Possible values: NeverAllowed, PriorityInterruptAllowed, AlwaysAllowd - Default value: NeverAllowed
@groupSecurityLevel | Attribute of groupprofile |
Defines the allowable security levels of the call (g-sec)
Possible values: ClearOnly, SecureOnly, ClearAndSecure - Default value: ClearAndSecure
@interconnectFlag | Attribute of groupprofile |
Defines whether or not the group MAY have PSTN sourced calls (g-ic)
Possible values: true, false - Default value: false
@interconnectSecurity | Attribute of groupprofile |
Defines the required security level at the beginning of an interconnect call. (g-icsecstart)
Possible values: Clear, Secure - Default value: Clear