About Us  |  Membership |  Help
Log In |  Register

Standardized Interfaces & APIs

Download Center

The Integration Framework is composed of two essential types of assets: Enterprise Architecture Guidebooks and Standardized Interfaces.
  • Current versions of all interfaces as of Frameworx Release 14 are found on this page
  • To download previous releases of interfaces, please refer to the interface archive
  • Architecture Guidebooks and other documents that make up the latest Integration Framework Architecture and Governance release can be found on the latest Integration Framework - Architecture and Governance release page.
Guide to Documents:
RN = Release Note
BA = Business Agreement
IA = Information Agreement
RI = Reference Implementation
CTK = Conformance Test Kit
IIS = Interface Implementation Specifications
All = Zip File with Entire Package
   
Page Navigation:
Standardized Interfaces
Specification Documents
IPDR
MTOSI
OSS/J
MTNM
  Standardized Interfaces

Operations Management Interfaces
Interface
Number
Version
 Maturity Level Deliverable
Status

RN BA
IA
IIS
All
New
in this Release
Fault Management
Maintenance, Protection, Alarm Control (MPAC) TIP_MPAC_RN
TIP_MPAC_BA
TIP_MPAC_IA
1.0
4 TM Forum Approved


Resource Alarm Management (RAM)
TIP_RAM_RN
TIP_RAM_BA TIP_RAM_IA 
TIP_RAM_RICTK
1.1
1.1
1.1
0.3.2
4
TM Forum Approved
                       

Inventory
Basic Resource Inventory
TMF_BRI_RN
TMF_BRI_BA
1.0 TM Forum Approved




(1)

(1)
 


                     
Common Resource Inventory  TMF422  1.0  4 TM Forum Approved
           Check
                     
Generic Inventory TIP_GIN_RN
TIP_GIN_BA
TIP_GIN_IA
TIP_GIN_IIS
INV_RI_CTK
TIP_GIN_UG
                        2.0
4
 TM Forum Approved
 




Ordering










Ordering
TIP_ORD_BA
TIP_ORD_UG
1.0
3
Member Evaluated





Resource/ Activation                    
Resource Provisioning  TMF_RPRV_BA 1.0   4 TM Forum Approved
          Check 
Policy
Policy Information Exchange TIP_PIE_RN
TIP_PIE_BA
TIP_PIE_IA
1.1

 TM Forum Approved

Security
Operator User Management
TIP_OUM_RN
TIP_OUM_BA
TIP_OUM_IA
TIP_OUM_IIS
3.0
4 TM Forum  Approved







Single Sign-On
TIP_SSO_RN
TIP_SSO_BA
TIP_SSO_IA
TIP_SSO_IIS
1.0
 4
                        TM Forum Approved






Security Compliance Audit Automation TMF_SCA_BA 0.9
4
TM Forum Approved






Service Management
Simple Management API

   
 




SES Management Interface
 TMF525
TMF617
TMF_SMI_IA
1.8
1.1
4
                        4
TM Forum Approved

 
 

Service Problem Management (SPM)
TIP_SPM_RN
TMF522
TIP_SPM_IA
1.2
1.5
1.0
4
TM Forum Approved
 
         
Performance Management
Performance Monitoring Management 2.1
TIP_PM_Mon_RN
TIP_PM_Mon_BA
TIP_PM_Mon_IA
TIP_PM_Mon_IIS
1.1
1.9
1.1
1.1.0
4                         TM Forum Approved


Performance Thresholding Management R1.0 TIP_PM_Thr_RN
TIP_PM_Thr_BA
TIP_PM_Thr_IA
TIP_PM_Thr_IIS
1.2
1.9
1.0.1
1.0.1
TM Forum Approved

NGCOR Performance Management Requirements Mapping  TR222  1.0  4 TM Forum Approved
          Check 
TIP Performance Management IPDR Streaming Protocol Plan  TMF067  1.0  4  TM Forum Approved            Check
Expedited Interfaces
Customer Query, Update and Notification Business Agreement
TMF_CQU_BA
2.0
TM Forum Approved
 




Profiling and Templates










Configuration and Profiling Business Agreement
TMF_CFG_BA
1.1.2
           4
TM Forum Approved





Catalog to Catalog Interface
Collection of use cases for inter-Catalog management communications implemented via the a Catalog-to-Catalog interface GB978 2.0.2 4 TM Forum Approved




Check
  1. The IA and IIS (WSDL/XSD) specifications of the Generic Query Interface should be used for the BRI solution, since the operations of the Generic Query Interface are directly applicable without change. However, at run time, resource specific specializations of the generic artifacts must be used as parameters of these operations, as indicated in the TMF_BRI_BA document.
 
 
Interface Development  
Document
Number
Version
Maturity Level
Deliverable
Status
Comments Download
New
in this Release
Interface Development
 
TM Forum Interface Development Tooling Release Notes

1.2
N/A
Reference Material
 

TM Forum Interface Development Tooling

1.2
4
TM Forum Approved  

TIP Adapter Scaffold
TMF064
0.3
4
TM Forum Approved  

Generic Update
TR188
2.0
4
TM Forum Approved  
                       

Generic Query
TR189RN
TR189
TR189 FAQ
2.0
4
TM Forum Approved   
                       

Generic Inventory User Guide
TIP_GIN _UG
1.0
4
TM Forum Approved



Generic Notification Requirements Business Agreement
TMF_GNTF _BA
1.0
4
TM Forum Approved


                       

NGCOR Inventory Management Requirements Response
TR203
1.0

 TM Forum Approved
   
 


Generic Import-Export Technical Report TR207 1.0 TM Forum  Approved
Inventory Scenarios for the Product, Service and Resource Domains of the SID model TR219   1.0.1 3 Member Evaluated    
Interface Deployment
 
Probable Causes Technical Specification  
TMF063
1.5 4 TM Forum Approved
                          

Check
NGCOR Fault Management Requirements Mapping
TR184
1.1 4 TM Forum Approved  
                       

3GPP SA5 - TM Forum TIP Fault Management Harmonization TR
TR183
1.3
4
TM Forum Approved  
                       

OSS/J FM RAM Adapter
TMF065
0.3
4
TM Forum Approved  

Interface Deployment Scenarios Technical Report
TR175
3.0
4
TM Forum Approved
 
                       

Logical Resource:  Network Model Advancements and Insights  TR215 0.5.3
4 TM Forum Approved
     
 Logical Resource: Network Function Model  TR225 0.1.1   3  Member Evaluated     Check 


IPDR

IPDR
Interface/Deliverable
Version
Maturity Level
Deliverable
Status
Download
 RN320 Release Notes for IPDR Technical Specifications  
Business Solution Requirements
Business Solution Requirements: Resource Data Collection and Distribution (RDC&D)
3.7
4
TM Forum Approved a.k.a. Network Data Management - Usage
Business Solution Requirements: Supplier/Partner Settlements For Next Generation IP-Based Services
1.2
4
TM Forum Approved
Transport Protocol Specifications1
IPDR Streaming Protocol Specification
2.8
4
TM Forum
Approved

IPDR/File Transfer Protocol specification 3.9
4
TM Forum
Approved

IPDR/Capability File Format specification
3.9
4
TM Forum
Approved

Encoding Specifications
IPDR/XDR Encoding Format
3.8
4
TM Forum
Approved

IPDR XML Encoding
3.7
4
TM Forum
Approved

Design and Implementation Guides
IPDR Service Specification Design Guide
3.11
4
TM Forum
Approved

Example Service Specifications
IPDR Service Spec: IPTV
3.8
4
TM Forum
Approved

Service Specification - Streaming Media
3.7
4
TM Forum
Approved

Service Specification - VoIP 3.7
 4 TM Forum
Approved 
 
Service Specification - Public WLAN Access 3.7  4  TM Forum
Approved
 

  1. A Reference Implementation is also available for this specification – download here.
 
 
MTOSI

The files listed below make up the latest release of the MTOSI interface suite, MTOSI 3.0.

MTOSI
Interface/Deliverable
Number
Version
Maturity Level
Deliverable
Status
Download  
New in this Release
General
Framework
TMF518_FMW
TMF612_FMW
TMF864_FMW_XML
3
4
TM Forum Approved
 

Resource Management & Operations
NetworkResourceBasic (NRB)
TMF518_NRB
TMF612_NRB
TMF864_NRB_XML
3
4
TM Forum Approved  


NetworkResourceFulfillment(NRF)
TMF518_NRF
TMF612_NRF
TMF864_NRF_XML
3
4
TM Forum  Approved  


NetworkResourceAssurance(NRA)
TMF518_NRA
TMF612_NRA
TMF864_NRA_XML
3
4
TM Forum  Approved  


ManageResourceInventory(MRI)
TMF518_MRI
TMF612_MRI
TMF864_MRI_XML
3
4
TM Forum Approved  


ResourceProvisioning(RP)
TMF518_RP
TMF612_RP
TMF864_RP_XML
3
4
TM Forum  Approved  


ResourceTroubleManagement (RTM) TMF518_RTM
TMF612_RTM
TMF864_RTM_XML
3
4
TM Forum  Approved  


ResourcePerformanceManagement (RPM)  TMF518_RPM
TMF612_RPM
TMF864_RPM_XML
 3 4
TM Forum  Approved
   

Service Management & Operations
ServiceBasic (SB)
TMF518_SB
TMF612_SB
TMF864_SB_XML
3
4
TM Forum Approved
 


ServiceActivation(SA)
TMF518_SA
TMF612_SA
TMF864_SA_XML
3
4
TM Forum  Approved
 


ManageServiceInventory(MSI)
TMF518_MSI
TMF612_MSI
TMF864_MSI_XML
3
4
TM Forum  Approved
 


 Ancillary Documents
MTOSI 3.0 Release Notes
RN306
3
N/A
Reference Material
 


MTOSI 3.0 Download Instructions
ReadMe
3
N/A
Reference Material
 
MTOSI 3.0 Implementation Statement
MTOSI_R2-1_DDP_Maps
3
4
TM Forum  Approved
 
Remote Unit Provisioning - Support for MTOSI GPON and DSL Technologies FSD Release Notes

1.0
N/A
Reference Material
 
Remote Unit Provisioning - Support for MTOSI GPON and DSL Technologies FSD

1.0
4
TM Forum Approved
 
Remote Unit Provisioning - Supporting Document

1.0
4
TM Forum Approved
 
MTOSI GPON Enhancements Living-List

1.0
4
TM Forum Approved
 
MTOSI GPON Profile Technical Report
TR190
1.2
4
TM Forum Approved
 

Activation and Provisioning Evolution Plan (MTOSI and OSS/J)  TMF_APEP  1.0.3 4 TM Forum Approved
     Check
 

OSS/J
 
These files represent the latest release of the OSS/J interface; older versions of the APIs can be found here. The OSS/J Design Guidelines describe the modeling patterns and design choices that have been used for the three integration profiles available for the OSS/J APIs: Java EE, XML over JMS, and Web Services, and can be downloaded here.

SOA Enablement APIs

   Downloads1  Available Profiles
API  Version
Specifications2
RI
CTK3
Questionaire
Java
XML/
JMS
 WS
Trouble Ticket 1.2
Source
Binary
Check
Check
Check
Inventory 1.2
Source
Binary
Check
Only Specs
Only Specs
Fault Management 1.0
Source
Binary
Check
Check
Check
Order Management 1.0
Source
Binary
Check
Check
Check
Discovery 1.0
Source
Binary
Check
Only Specs
Only Specs
Common 1
Source
Binary

Check
Check
Check
Other APIs5
API  Common API6
Specifications2
RI
CTK3
Questionaire


Service Activation
1.0




Billing Mediation
1.0




QoS
1.0


Source
Binary

SQM Proposed Final Draft
1.5

Not Available Yet
Not
Available
Yet
Not
Available
Yet

  1. Notwithstanding any statements to the contrary, TM Forum is a co-owner of the copyright on these files. Copyright © 2007-2010 TM Forum. All rights Reserved.
  2. The specifications of the OSS/J APIs downloadable from this page are copies of the corresponding OSS/J API specifications available from the JCP website. Two different licenses are associated with the specifications of the OSS/J APIs: the license from the JCP "Specification Lead" company associated with the OSS/J specifications downloadable from the JCP website ("JCP license"), and the TM Forum license associated with the OSS/J specifications downloadable from this page ("TM Forum license"). If you are seeking to create and distribute an implementation of an OSS/J specification only under the auspices of the TM Forum, which also allows partial or full implementations of OSS/J APIs without having the implementations to have passed the applicable TCK (provided that the licensee does not assert that a partial implementation is "conformant" under the TM Forum's policies), then the terms and conditions of the TM Forum License shall control. If, however, you are seeking to create and distribute an implementation of an OSS/J specification under the auspices of the Java Community Process, you need to download the specification from the JCP website and accept the terms and conditions of the accompanying Specification License, which only grants certain rights for distributed implementations that do pass the applicable TCK. The companies that serve as Specification Leads under the JCP for the OSS/J APIs available for download from this page have consented to this dual licensing approach. The download file for each Specification includes the documentation, the Java interfaces, the XML Schema and the Web Services description in WSDL format.
  3. In order to self-certify an application that implements the interface in compliance to the standard, you need to use this conformance test suite and execute this certification process.
  4. In order to self-certify an application that uses (as a client) a compliant interface, you need to fill in this questionnaire and execute this certification process.
  5. Notwithstanding any statements to the contrary, TM Forum is a co-owner of the copyright in these files. Copyright © 2008 TM Forum. All rights Reserved. 
  6. Version of the Common API this functional API is based on.


MTNM
 
MTNM
Interface/Deliverable
Maturity Level
Deliverable
Status
RN
Implementation Guide
BA
 IA IDL
All
**NEW*** MTNM Release 4.0  4 TM Forum Approved            
MTNM Release 3.5
4
TM Forum Approved
RN312
TMF814A
TMF513
TMF608
TMF814

 


Specification Documents

Specification Documents
Document
Type
Maturity Level
Download
New in this Release
Resource Management
Resource & Service Assurance across GPON, Ethernet & MPLS-TP FDD FDD
4

Resource & Service Assurance -- GPON, Ethernet, MPLS/TP FSD  FSD  4    Check
GPON Networks Management FDD
3
GPON Service Provisioning in FTTO Scenarios FDD  4    Check
MPLS-TP Management Model FDD

 MPLS-TP Features Specification Document FSD  3    Check
Service Management
Ethernet Resource & Service Management
FDD
3
 
IP Resource & Service Management FDD 3
 
Ordering and Activation

Ordering and Activation Interface Study

FDD

3

 
Resource and Service Assurance
Performance Management
FDD
 3
 
Resource FM Harmonization FDD
3

Test & Diagnostics FDD 
3

Architecture
Profiles/Templates FDD
3

Equipment and External Plant FDD
3

Connectionless, Connection Oriented Convergence and TP Modelling FDD
3

Backup and Redundancy FDD
3

 
Paid Advertisement