text
stringlengths 1
761
| file_name
stringclasses 554
values |
|---|---|
Draft versions of specifications may be made available in the responsible Groups' directories. Such versions shall be clearly distinguishable from "official" versions by substituting "d" for the hyphen before the version code. Thus:
aabbbdxyz.eee
(for example, 28033d410.zip). Such files shall never appear in the official specification directories. | 21900-i10.docx |
The foregoing file format using three characters for the version number is valid as long as none of the three version elements (major, technical, editorial) exceeds the value 35, since the characters 0..9, a..z represent a base-36 value. If any one or more of the three version elements exceeds 35 then the file format shall be modified to use two decimal characters in the range 00 to 99 for each element, i.e. six characters in all. | 21900-i10.docx |
EXAMPLE 5: Version 15.35.0 of TS 29.341 would have the file name 29341-fz0.
Version 15.36.0 of TS 29.341 would have the file name 29341-153600.
(The file extension is omitted for clarity.) | 21900-i10.docx |
For specification part and sub-part numbers, one or two characters may be used, 0..9 or 00..99. Ideally the intended number of parts and sub-parts should be known when the first specification numbers are allocated so that the correct number of digits can be used from the outset, ensuring that filenames are correctly sorted when listed. | 21900-i10.docx |
EXAMPLE 6: Permissible filenames for multi-part specifications (file extensions omitted for clarity):
29341-1-5
29342-2-15
29343-13-21
29344-08-55
29345-19-6
Part and sub-part numbers shall not use characters a..z, but shall always be one- or two-digit decimal values. | 21900-i10.docx |
Table 6: Characters used in filenames to represent numeric values – single character
Value
Character
Remarks
0
0
Only for use in version number fields. Part / sub-part numbers and file numbers start at 0 or 1 (or 00 or 01 – see table 6A).
1
1 | 21900-i10.docx |
1
1
2
2
3
3
4
4
5
5
6
6
7
7 | 21900-i10.docx |
7
7
8
8
9
9
10
a
11
b
12
c
13
d | 21900-i10.docx |
13
d
14
e
15
f
16
g
17
h
18
i
19
j | 21900-i10.docx |
19
j
20
k
21
l
22
m
23
n
24
o
25
p | 21900-i10.docx |
25
p
26
q
27
r
28
s
29
t
30
u
31
v | 21900-i10.docx |
31
v
32
w
33
x
34
y
35
z
Higher values – see table 6A. | 21900-i10.docx |
z
Higher values – see table 6A.
Table 6A: Characters used in filenames to represent numeric values – two character
Value
Character
Remarks
0
00
1
01
2
02 | 21900-i10.docx |
2
02
...
9
09
10
10
11
11
...
34
34 | 21900-i10.docx |
34
34
35
35
36
36
37
37
...
98
98
99 | 21900-i10.docx |
98
98
99
99
Higher values for further study if necessary
5B Availability and distribution of OpenAPI specification files | 21900-i10.docx |
5B Availability and distribution of OpenAPI specification files
As described in the clause 5.3.1 of 3GPP TS 29.501 [6], 3GPP Technical Specifications describing an API or common data types shall include an annex documenting the corresponding OpenAPI specification file. | 21900-i10.docx |
For a TS agreed by the WG to be sent to TSG for approval to come under change control, the responsible MCC officer, in preparing that version (normally v2.0.0) shall, in conjunction with its rapporteur, check that the OpenAPI specification file(s) is(are) syntactically correct | 21900-i10.docx |
. This exercise should be accomplished in time to meet the deadline for submission of TDocs to the TSG plenary meeting. If errors are detected at this stage, the rapporteur should ask delegates to raise corrective pCR(s) to be sent directly to the TSG to correct the draft TS | 21900-i10.docx |
. The TSG shall be requested to approve both the draft TS and any such pCRs as a package, and if the package is approved, MCC shall incorporate those pCRs into the TS when preparing the first under-change-control version. | 21900-i10.docx |
Prior to a TSG plenary meeting, the responsible MCC officer shall prepare CR Packs for all WG-agreed CRs in the usual manner | 21900-i10.docx |
. For those CRs which change the OpenAPI specification file(s) of the TS, the MCC officer and/or the rapporteur shall perform a trial implementation of those CRs which affect the OpenAPI specification file(s), and again check that the resulting specification file(s) is(are) syntactically correct | 21900-i10.docx |
. If errors are detected at this stage, the rapporteur should request authors of problematic CRs to provide corrective revisions of those CRs to be sent directly to the TSG as company contributions. The TSG shall be asked to approve all WG-agreed CRs for which no problems were detected plus the company revision CRs addressing the problematic ones | 21900-i10.docx |
. Ideally, not only the CR Packs containing the original WG-agreed CRs but also the revised, company-provided, CRs should be provided in time to meet the deadline for submission of TDocs to the TSG plenary meeting. | 21900-i10.docx |
Before making available any new version of a TS containing an OpenAPI specification file, the responsible MCC officer shall extract the (syntax checked and verified) OpenAPI specification file from the annex of the TS and make it available as a stand-alone file in UTF-8 format as specified in IETF RFC 3629 [7]. The file name shall follow the conventions defined in 3GPP TS 29.501 [6] clause 5 | 21900-i10.docx |
.501 [6] clause 5.3.6 unless the TS containing an OpenAPI specification file indicates a different file name. | 21900-i10.docx |
If a new version of a TS containing an OpenAPI specification file is approved without any change to the contained OpenAPI specification file(s), the responsible MCC officer shall not modify the existing UTF-8 formatted OpenAPI specification file.
All the UTF-8 formatted OpenAPI specification files documented by TS shall be stored by the MCC officer in the following locations: | 21900-i10.docx |
- https://forge.3gpp.org/rep/all/5G_APIs, and
- in the zip file containing the Word file of the new version of the TS (which is itself stored in the usual places).
5C Normative availability and distribution of stage 3 specification files | 21900-i10.docx |
5C Normative availability and distribution of stage 3 specification files
In this option, the normative code parts of the stage 3 specification shall be normatively stored in the 3GPP Forge repository.
The TS document specifying the stage 3 definition shall indicate that the 3GPP Forge repository is normative for the corresponding stage 3 specification files and: | 21900-i10.docx |
- The TS document shall contain a link to a 3GPP Forge repository tag that implicitly includes the versioning information about the TS, e.g. https://forge.3gpp.org/rep/sa5/MnS/-/tree/Tag_Rel18_SA100;
- The TS document shall contain the directory path where the files are stored, e.g. "yang-models"; | 21900-i10.docx |
- The TS document shall contain the name of the files specified by this TS;
- The TS document shall not contain a copy of the stage 3 specification files.
Before making available any new version of a TS specifying stage 3 files, the responsible MCC officer shall download the specification files from 3GPP Forge and store them in the zip file containing the new version of the TS document. This zip file shall be published in the usual places. | 21900-i10.docx |
All OpenAPI stage 3 specification files referenced by the TS document shall also be stored by the MCC officer in the following location:
- https://forge.3gpp.org/rep/all/5G_APIs.
6 Work Items
6.0 Introduction
6.0.1 Introduction: why manage a project? | 21900-i10.docx |
6.0.1 Introduction: why manage a project?
In any complex engineering venture, it is necessary to plan the project, to monitor its progress, and to be able to determine whether it is being completed on schedule and within budget. In many ways, the concepts and constraints which apply to an engineering project can also be applied to system standardization activity.
6.0.2 How to manage a project? | 21900-i10.docx |
6.0.2 How to manage a project?
Any project needs to have its goals defined. It is then possible to analyse the steps needed to achieve each goal, starting from the status quo.
It will often be desirable to first produce a feasibility report, which is to be undertaken in the context of a Study Item. | 21900-i10.docx |
Study Item:
An initial study, resulting in a Technical Report, which typically performs a feasibility study for additional functionality. If the results of the study are positive, one or more subsequent Feature-type Work Items may follow.
A feasibility study may include commercial as well as technical considerations. This analysis will naturally lead to defining the new features which it is wished to add to the existing system. | 21900-i10.docx |
Feature:
New, or substantially enhanced functionality which represents added value to the existing system. | 21900-i10.docx |
A feature should be more or less self-contained - that is, each feature can be viewed as an optional extra, which can be added or not as a function of market demand. Network operators and equipment manufacturers can decide using commercial considerations whether or not to implement a feature. The description of a feature need not be technically precise, but should represent a concept which can be understood at a service level | 21900-i10.docx |
. It should answer the question: what do I get for my money? A feature should normally embody an improved service to the customer and / or increased revenue generation potential to the supplier. | 21900-i10.docx |
This being the case, most features would be the responsibility of TSG-SA WG1. The ensemble of the features of a particular release of the system represents the difference between that release and the previous release.
A feature can be considered as a high-level goal for project management purposes. But most features will be quite complex, and will need to be broken down into simpler elements or building blocks for the purpose of specifying precise functionality. | 21900-i10.docx |
Work on a study item or feature may be carried out by multiple working groups spanning one or more TSGs. In the case of multi-TSG study items and features, all such TSGs should be shown in the work plan as being responsible for the study item or feature; this should be refined as soon as possible into an identification of the individual working groups responsible. To allow work to progress, the Work Item Descriptions (see clause 6 | 21900-i10.docx |
. To allow work to progress, the Work Item Descriptions (see clause 6.1) may be approved by one TSG before formal contribution has been received by other involved TSGs and WGs, which should review the Work Item Description in a timely manner, and provide their own input as soon as possible. | 21900-i10.docx |
Building block:
A sub-division of a feature, representing a coherent set of technical functionality which would generally be expected to reside in a single system element. | 21900-i10.docx |
A building block shall be defined in technical terms, and its description will require an understanding of the architecture of the overall system. A building block should generally be restricted to a single physical or logical entity or a single protocol such as "terminal" or "call control". This implies a generic or object-oriented approach. A building block should normally be the responsibility of a single TSG. | 21900-i10.docx |
In the case of very simple features, a single building block may suffice, in which case the feature and its building block are synonymous. | 21900-i10.docx |
To implement a building block it will generally be necessary further to subdivide the functionality into smaller tasks, each representing a closely specified and easily comprehended activity. Such work tasks may not only be divided by technical content, but potentially by phase | 21900-i10.docx |
. Such work tasks may not only be divided by technical content, but potentially by phase. So, for example, it is necessary to define service aspects fully (one or more work tasks) before considering functional information flows (one or more work tasks) which in turn will be followed by detailed protocol specification (one or more work tasks). | 21900-i10.docx |
Work task:
A sub-division of a building block, representing a self-contained, well-scoped and well-scheduled item of work. | 21900-i10.docx |
It is at this lowest hierarchical level of breakdown that estimations of work content and thus time scales can be calculated. From the estimated schedules of all work tasks which comprise a building block, and from their inter-dependences, can be derived the overall schedule for the "parent" building block. From the schedules of all component building blocks, the time-to-completion of the parent feature can be estimated. A work task will almost certainly be the responsibility of a single Working Group. | 21900-i10.docx |
The output of a work task shall be:
- One or more new Technical Specifications (or Reports); and / or
- Change Requests to existing TSs / TRs.
Features, building blocks and work tasks are the three specific types of "Work Item". | 21900-i10.docx |
Features, building blocks and work tasks are the three specific types of "Work Item".
In the case of very simple building blocks, a single work task may suffice, in which case the building block and its work task are synonymous.
Work Item:
A generic term used to encompass study item, feature, building block and work task. | 21900-i10.docx |
All Work Items, whatever their class (feature, building block or work task) require:
- A precise definition of content ("scope");
- An estimated schedule, with milestones to track progress if possible; (in the case of building blocks and features, the schedule can be derived from those of the component work tasks); | 21900-i10.docx |
- A named person to act as rapporteur (in effect, the manager of the Work Item);
- At least four Member Organizations supporting the Work Item and willing to offer active participation in its realization.
6.0.3 Types of modification to specifications
The possible modifications of the specifications are basically of different natures: | 21900-i10.docx |
The possible modifications of the specifications are basically of different natures:
- Error corrections: modifications which correct overlooked errors or inconsistencies in the specifications.
- Enhancements: modifications that enhance the system, e.g. by new services or features, or by improving performance or decreasing costs. | 21900-i10.docx |
Modifications of the correction category (i.e. Category F) are ongoing maintenance tasks and are handled with CRs bearing the code of the Work Item that was used to introduce the affected feature, for the original Release in which it was introduced. Corresponding mirror CRs (i.e. Category A) may be produced for subsequent releases as applicable, using the same Work Item code | 21900-i10.docx |
. See also clause 6.2 covering the case where such a CR is not introduced into the TS or TR at the Release with which that Work Item is associated. | 21900-i10.docx |
Modifications of the enhancement category (i.e. Category B or C) are handled within the concept of Work Items or as "technical enhancements". (See clause 6.2.) Note that prior approval of the WID by the TSG is needed before any substantial work is launched | 21900-i10.docx |
. If that work can be completed within one TSG cycle, the new WID may be approved at the same TSG meeting at which the enhancement CRs are presented. See clause 6.1 for the creation of Work Items. | 21900-i10.docx |
6.1 Creation of a Work Item
When new or enhanced functionality of the 3GPP system is considered desirable an Individual Member of 3GPP (or group thereof) may make a proposal by submitting a Work Item Description (WID) sheet to the relevant TSG or TSG WG: | 21900-i10.docx |
- For new services, features or functions, the TSG responsible for Services and System Aspects is the relevant TSG. This TSG shall assign prime and, if necessary, secondary responsible TSGs for the corresponding Work Items.
- For pure performance enhancements, other TSG WGs may be responsible.
The relevant TSG WG should study and refine the WID before passing it on to the TSG for adoption. | 21900-i10.docx |
No substantial work shall commence in a TSG WG prior to a decision of the responsible TSG.
The actual WIDs to be used and guidance on how to apply them shall be distributed by the Support Team.
The TSG shall not approve a Work Item unless the WID has been properly filled in to the extent possible. | 21900-i10.docx |
The Support Team shall maintain a database of Work Items, and make it available on the 3GPP file server and portal.
A Work Item normally implies the creation of new specification and Change Requests to existing specifications.
6.2 Types of Work Item
Modifications of the standard could in principle be of two different types: | 21900-i10.docx |
Modifications of the standard could in principle be of two different types:
- New services/features/functions that in general affect several specifications and involve several TSGs / WGs;
- Technical enhancements or improvements that affect one or a small number of specifications and involve a single or a few Groups only. | 21900-i10.docx |
Modifications of the latter type may be submitted to the Working Group(s) and then to the TSG directly as a Change Request without prior presentation/agreement of a WI Description sheet. Such CRs shall instead refer to the pseudo Work Item 'Technical Enhancements and Improvements'. The CRs relating to this type of modification shall be tagged with the work item code TEI<x> where <x> represents the Release number: e | 21900-i10.docx |
.g. for Release 16, the code would be "TEI16". | 21900-i10.docx |
TEI Work Item codes shall not be used where an appropriate Work Item code exists.
TEI Work Item codes should not be used for the definition of new services/features/functions (i.e. Category B CRs).
TEI Work Item codes should not be used alone for functional modification of existing services/features/functions (i.e. Category C CRs). | 21900-i10.docx |
Nevertheless, if a feature is functionally modified by a Category C CR using a TEI<x> Work Item code, the code(s) for the Work Item(s) which introduced that feature shall be used, plus the appropriate TEI<x> code for the first Release in which the CR is introduced.
If
- it is clear that the modification(s) can be completed within one TSG cycle, and | 21900-i10.docx |
- the normal stage 1, 2, 3 sequence of CRs does not require one additional meeting cycle in each affected TSG,
then a TEI code may be used. TEI codes shall not be used where the development of modification(s) and interactions with other WGs are likely to prolong the outcome for a period of time greater than this; in such cases, a new specific Work Item shall be created instead. | 21900-i10.docx |
For smaller features that are handled with Category B and/or Category C CRs within one TSG cycle, a provisional Work Item code shall be used before the CR(s) and the companion WID are submitted for approval to the TSG. | 21900-i10.docx |
Notwithstanding the provisions of clause 4.10.2, TEI<x> is also to be used in a Category F and any related Category A CR(s) which add to or modify TR/TS content introduced in a Release prior to <x> and where no appropriate Release <x> Work Item exists | 21900-i10.docx |
. In this case the code(s) for the Work Item(s) which introduced the relevant TR/TS content shall be used, plus the appropriate TEI<x> code for the first Release in which the CR is introduced. The same TEI<x> shall be used in all mirror (i.e. Category A) CRs. | 21900-i10.docx |
Example: TR/TS content is introduced into TS 23.456 under the Release 13 Work Item ABCD by means of a Rel-13 CR. Much later, an error is identified in the TR/TS content introduced by that Rel-13 CR which of course appears in the current Release 13 version of 23.456. | 21900-i10.docx |
According to the provisions of clause 4.10.0, a category F CR would be introduced into the current Release 13 version tagged with Work Item ABCD, together with category A (mirror) CRs to the Release 14, 15, etc versions of 23.456, each also tagged with code ABCD. | 21900-i10.docx |
However, it is felt that the seriousness of the error does not warrant taking the correction all the way back to Release 13, and so the category F CR is instead written to the current Release 15 version of 23.456. This is tagged with the Work Item codes ABCD and TEI15. Category A CRs are written to the Release 16, etc versions of 23.456, and these are also tagged with Work Item codes ABCD and TEI15. | 21900-i10.docx |
NOTE : The order in which multiple Work Item codes appear on a CR cover sheet is not significant. (Thus in the foregoing example, the CRs could equally well show "ABCD, TEI15" or "TEI15, ABCD".)
The use of a TEI Work Item code alone should be avoided whenever possible, and any use of a TEI Work Item code should be considered very carefully. | 21900-i10.docx |
For the other types of modification, the provisions of clause 6.3 apply.
6.3 Start and continuation of the work and responsibilities
6.3.1 General
An early task when elaborating a Work Item is to identify the tasks related to the WI and to allocate them to the TSGs and TSG Sub-Groups. | 21900-i10.docx |
In most cases the tasks from a WI can be split immediately into the following areas:
- Service requirements
- System/Architectural requirements and implications
- Protocol specifications
Service requirements: | 21900-i10.docx |
- Protocol specifications
Service requirements:
The responsibility of the service requirements can usually be allocated immediately at the creation/adoption of the WI. Occasionally another Group may be given responsibility for the service requirements. In any case, however, it should be a single group and one that reports directly to the TSG.
System/Architectural requirements and implications: | 21900-i10.docx |
System/Architectural requirements and implications:
In addition, the responsibility for system/architectural requirements should be allocated immediately, even though the implications and requirements normally will be seen only after the study on service/system requirements have been initiated. The responsibility for the system/architectural requirements shall be given to a single body to guarantee the consistency of the adopted solution. | 21900-i10.docx |
The choice of group should not pre-determine the technical choices and in many cases, the responsibility for system and architectural requirement study needs a widening of the competency and a readiness to look at a variety of technical aspects. This can be obtained either by drawing the attraction of the suitable experts (e.g., by setting special meetings or clear meeting dates) or by the organization of joint meetings. | 21900-i10.docx |
TSG SA shall maintain the overall consistency of the system architecture despite the numerous modifications due to various Work Items. TSG SA, shall ensure the co-ordination of the development of general architecture concepts and their applications to individual Work Items, and should thus also draw attention and expertise from other Groups.
Protocol specifications: | 21900-i10.docx |
Protocol specifications:
The responsibility for the elaboration of the protocol specifications cannot, in most cases, be allocated at the early stages since it depends on the technical implementation choices and hence on the results of the study of the service/system requirements as well as on the architectural conclusions. | 21900-i10.docx |
The identification of new protocols to be specified and/or existing protocols to be enhanced shall be derived from the system/architectural requirements. In general, modifications of existing protocols shall be done by the TSG WG in charge of the protocol in question, whilst the responsibility for development of new protocols shall be allocated by the TSG based on proposals from the TSG WG on system/architecture | 21900-i10.docx |
. Then, whether the actual work is done in the TSG WG itself or in an ad hoc subgroup thereof is at the discretion of that TSG WG. | 21900-i10.docx |
6.3.2 Role of the work item rapporteur
Every Work Item shall have a rapporteur. The rapporteur should be selected from regular attendees of the primary responsible Group and shall be selected from supporting companies. The role of the rapporteur is to:
- Monitor the progress of the work in all WGs for the WI. | 21900-i10.docx |
- Monitor the progress of the work in all WGs for the WI.
- Report to the responsible WG and produce a report to the WG plenary on progress.
- Provide feedback to allow the work plan to be updated.
- Keep the WI sheet up-to-date.
- Identify the completion of the WI. | 21900-i10.docx |
- Identify the completion of the WI.
NOTE: Updates of WI sheets require approval by the responsible WG/TSG.
6.4 Realization of Work Items
6.4.1 Planning and categorization of the deliverables (and control thereof)
Planning: | 21900-i10.docx |
Planning:
An initial time plan should be set up at an early point. As a basis, the time plan should include at least the following points:
1. Presentation for principle agreement of the service requirements;
2. Presentation for principle agreement of the architectural/system implications and requirements;
3. Presentation for information of the drafts of all needed deliverables, | 21900-i10.docx |
3. Presentation for information of the drafts of all needed deliverables,
4. Presentation for approval of all needed deliverables.
The time plan shall include realistically achievable dates for each step. | 21900-i10.docx |
The time plan shall include realistically achievable dates for each step.
The WI Status List shall also contain information about existing and planned permanent and semi-permanent documents related to the WI, e.g. future specifications as well as interim/temporary requirements "specifications", including the responsible Group, the rapporteur, the state of the documents, expected completion dates, etc.
Categorization: | 21900-i10.docx |
Categorization:
Before the substantial work on a Work Item starts, the WI shall be examined in the light of its technical and commercial dependency with respect to the existing specifications as well as with respect to other Work Items. Aspects that shall be considered and settled at an early stage are:
- Required versus acceptable time scales;
- Whether the WI has an impact on User Equipment or not; | 21900-i10.docx |
- Whether the WI has an impact on User Equipment or not;
- Whether the WI has an architectural impact or not;
- To which degree the WI needs to specify (and hence how much can be left "open", to speed up the work);
- Whether the WI can be technically and/or commercially combined/grouped with other WIs; | 21900-i10.docx |
Unless the above aspects are sorted out at the beginning of (or prior to) the work, the risk of getting inefficient and non-optimal specifications increases and the control of the work becomes difficult and unmanageable.
6.4.2 Choice of deliverables
The SI will be realized as a new Technical Report ("feasibility study report"). | 21900-i10.docx |
The SI will be realized as a new Technical Report ("feasibility study report").
The WI will be realized as new specifications and/or amendments to existing specifications; the exact structure lies with the individual TSG Sub-Groups and the TSG. Typically, a new feature may result in at least three completely new specifications (stages 1, 2 and 3) but may also cause amendments to the major protocol specifications. | 21900-i10.docx |
6.4.3 Contents of deliverables
6.4.3.1 Service requirements
This task, allocated and controlled according to the provisions above, consists in describing in details the aim of the Work Item, as seen by those for which a service is provided, e.g. end users, operators, service providers, etc. | 21900-i10.docx |
In many cases it is desirable that, prior to the actual service requirements specification being produced, an initial combined service and system/architectural requirements and considerations document is produced, involving both service oriented and implementation expertise | 21900-i10.docx |
. In particular when an ad hoc task force is charged with performing a study on a certain WI (aspect) such a starting point document should be produced and then used as a basis for the TSG SGs when carrying out the detailed work on service requirements/descriptions and technical realization specifications | 21900-i10.docx |
. Such setting-the-basis documents should generally be kept for some time after the actual work on the detailed specifications has progressed to a mature level (mainly for the purpose of easing the understanding and to shorten the interaction and negotiation period between service requirements and system/architectural and technical restrictions). | 21900-i10.docx |
Such 'setting-the-basis' document can also be used to describe the project management of a Work Item (to collect all prepared but not yet approved CRs related to the WI in question).
It may be appropriate to perform the above work in the context of a Study Item, prior to embarking on concrete specification work.
6.4.3.2 Technical realization specifications | 21900-i10.docx |
6.4.3.2 Technical realization specifications
These cover both the overall architectural and interface specific detailed specifications. The architectural implications and requirements need to be identified at a very early stage, for the purpose of knowing which parts of the standard (and hence of the system) are affected by a WI, and for the purpose of supporting the identification of cross-WI similarities (and hence more overall efficient solutions). | 21900-i10.docx |
The overall co-ordination of the architectural/system requirements is with a single group as stated above, whilst the ensuing detailed protocol definitions and specifications may be distributed over several groups (according to their scope).
6.4.3.3 Test specifications
Changes to the core specifications may have impact on the test specifications. The corresponding changes to test specifications should be approved before publication the new core specifications.
6.4.4 Early implementation | 21900-i10.docx |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.