Documentation
Markdown Templates
| Type | Link |
|---|---|
| Architecture | Architecture Document |
| Requirements | Requirements & Use Cases Document |
| Supporting | Supporting Documents (Objects) |
| Tech_Spec | Techincal Specification Document |
| Whitepaper | Whitepaper Document |
| Work_Item | Work Item Document |
The Enabler Template Repo contains the documents listed above. When creating a new Enabler, copy this template into the GitHub OMA Organization account.
Word Templates
Word Document templates are available via this table or link.
Published Documents
How to find an OMA Published Document
- In addition to OMA Portal documents, OMA publish regularly Technical Documents and White Papers
| Type | Before 31st August 2020 | After 31st August 2020 |
|---|---|---|
| OMA Technical Specifications | OMA Publication | OMA Publication OMA LwM2M Specifications and MD2HMTL |
| OMNA Registries | OMNA Registries | OMNA Registries LwM2M Registry in GitHub |
| OMA Profiles | OMA Profiles | New LwM2M Objects available via, GitHub LwM2M Schemas available via FTP New profile data, other than LwM2M available via FTP, unless the Specifications are developed in GitHub |
| OMA API | OMA API | |
| OMA Packages |
JSD - JSD
WSDL - WSDL DTDs - DTDs |
|
Legacy Documents
This link legacy-documents.html opens a web page explaining how and where to find OMA Legacy documents.
Permanent Documents
| Document Type (abbr) | File Name (examples) | Description |
|---|---|---|
| AD | OMA-AD-DM-VX_Y_Z-YYYYMMDD-S | Architecture Document |
| CHARTER | OMA-CHARTER-DM-YYYYMMDD-S | Charter |
| DDS | OMA-DDS-Charging_Data-VX_Y_Z-YYYYMMDD-S | Data Definition Specification |
| ERELD | OMA-ERELD-LightweightM2M-VX_Y_Z-YYYYMMDD-S | Enabler Release Definition Document |
| ERP | OMA-ERP-LightweightM2M-VX_Y_Z-YYYYMMDD-S | Enabler Release Package (zip archive) |
| ET_RPT | OMA-ET_RPT-Multimedia-Messaging-VX_Y_Z-YYYYMMDD-S | Enabler Test Report |
| ETR | OMA-ETR-BCAST-VX_Y_Z-YYYYMMDD-S | Enabler Test Requirements |
| ETS | OMA-ETS-LightweightM2M-VX_Y_Z-YYYYMMDD-S | Enabler Test Specifications |
| INF | OMA-INF-HTM_SupportFiles_XSD-YYYYMMDD-S | Informational Document |
| IOP_RPT | OMA-IOP_RPT-REST_NetAPI_CAB-VX_Y_Z-YYYYMMDD-S | Enabler IOP Report |
| LS | OMA-LS_1087-ARC_WG_Reply_to_GSMA_RCS_MaaP_API_Taskforce_on_Spec_Status-YYYYMMDD-S | Outgoing Liaison Statement |
| ORG | OMA-ORG-Process-VX_Y_Z-YYYYMMDD-S | OMA Working process and procedures |
| RD | OMA-RD-DM-VX_Y_Z-YYYYMMDD-S | Requirements Document |
| RRELD | OMA-RRELD-LWM2M_SWMGMT-VX_Y_Z-YYYYMMDD-S | Reference Release Definition Document |
| RRP | OMA-RRP-REST_NetAPI_Common-VX_Y_Z-YYYYMMDD-S | Reference Release Package (zip archive) |
| SUP | OMA-SUP-XML_LWM2M_EventLog-VX_Y_Z-YYYYMMDD-S | Support Document (non-specification) |
| TEMPLATE | OMA-TEMPLATE-Spec-VX_Y_Z-YYYYMMDD-S | Templates |
| TS | OMA-TS-LightweightM2M_Core-VX_Y_Z-YYYYMMDD-S | Technical Specification |
| WID | OMA-WID-LwM2M_Complex_Data_Types-VX_Y_Z-YYYYMMDD-S | Work Item Docudment |
| WP | OMA-WP-LightweightM2M_5G_IoT_UN-SDG | White Paper |
| xxRR | OMA-CONRR-EVC-V1_0-20150527-I | Review Report (where xx is AD, RD or CON) |
State
The values in the <State> field represent the condition of the document, reflecting the level of completion or approval. The values used for the <State> field on OMA permanent documents are as defined in the following table.
| <State> | Purpose | Description |
|---|---|---|
| ‘A’ | Approved | Final level of approval for a document. Used for documents reaching this point following either the IOP Validation or end of Public Review sequence. No revision, with the current version number, may be created for the specification. Requires approval or notification to the TP and, where needed, subsequent Board Approval. |
| ‘C’ | Candidate | A version of the document intended for validation and/or public review. Candidate versions may be revised without changing the version number. Requires approval or notification to the TP and, where needed, subsequent Board Approval |
| ‘D’ | Draft | An intermediate version of a document during the development process. Drafts can be revised by the WG as frequently as needed. |
| ‘I’ | Information | A reporting state for a permanent document that is not normallya mainproduct of theorganization(e.g. Review reports and Templates). The ‘I’ state is used to bestow status on a document (e.g.final version of review report) that normally is just progressed as a draft. |
| ‘H’ | Historic | A reporting state used for documents that have been marked as obsolete (see section 12.1.45). Requires approval or notification to the TP and subsequent Board Approval. |
Note that document states from OMA affiliates which may be used on their existing documents may not be accommodated or mappable into this list but SHOULD be preserved and not reused if there is any risk of confusion.
The following are examples of permanent document names using the permanent document numbering convention:
- OMA-TS-DLOTA-V1_0-20020620-D
- OMA-WAP-AD-WML-V2_0-20010620-A
- OMA-SYNCML-RD-SYNCPROT-V1_1-20020215-A
Version
The large majority of permanent public documents contain a Version, VX_Y_Z, (with the exception of a WhitePaper among others). See Semantic Version section for further details.