TMF679 v5 Resource Mappings

Before using the TMF679 resource mappings, refer these.

Constraints and Limitations

TMF679 API is integrated with the RLM’s Qualification and Product List APIs.
TMF679 acts as a data type conversion layer with minimum validations.
- It receives the request in TMF defined format.
- After the basic validation, converts the input request to RLM’s qualification request payload.
- After receivig the response back from RLM, converts the response back to the TMF defined response.
As TMF679 implements the instant CheckProductOfferingQualification and QueryProductOfferingQualification, any data from TMF is not stored. The majority of the processing is handled by RLM.
Only Id values are considered for the CheckProductOfferingQualification and QueryProductOfferingQualification, details such as product name, category name, and related party name are ignored.

These default mappings are supported for the TMF679 resources.

TMF Field	Description	Is Mandatory as per TMForum?	Is supported in POST?	Salesforce Object
@type	When sub-classing, this defines the sub-class extensible name.	No	Yes
channel	A ChannelRef. The channel to which the resource reference to.	No	No
description	Description of the CheckProductOfferingQualification.	No	No
note	Extra information about a given entity.	No	No
checkProductOfferingQualificationItem	A CheckProductOfferingQualificationItem.	Yes	Yes	checkProductOfferingQualificationItem Mapping
provideAlternative	An indicator which when the value is “true” means that alternative solutions should be provided.	No	No
provideResultReason	An indicator which when the value is “true” means that result reason are expected for available or not of product offering.	No	Yes
relatedParty	RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity.	Yes	Yes	RelatedPartyOrPartyRole sub-resource fields mapping
requestedQualificationCompletionDate	Deadline date when the requester expected a qualification answer.	No	No
state	A TaskStateType. Possible values for the state of a task. ENUMERATED with values: * acknowledged * rejected * inProgress * cancelled * done * terminatedWithError	No	Yes
creationDate	Date and time when the CheckProductOfferingQualification was created.	No	Yes
contextDefinition	String, Accepts the custom context Definition for processing the request.	No	Yes
contextMapping	String, Accepts custom contextMapping to process the request.	No	Yes
qualificationProcedure	String, Accepts custom qualification Procedure to process the request	No	Yes

CheckProductOfferingQualificationItem

TMF Field	Description	Is Mandatory as per TMForum?	Is Mandatory for Salesforce?	Supported	Salesforce Object	Supported Methods
@type	When sub-classing, this defines the sub-class extensible name.	No	No	Yes		POST
action	Action to be performed on a ProductOffering or product in order to be qualified.	No	No	No
id	Identifier of the CheckProductOfferingQualification item.	No	No	No
@baseType	When sub-classing, this defines the super-class.	No	No	No
@schemaLocation	A URI to a JSON-Schema file that defines additional attributes and relationships.	No	No	No
alternateProductOfferingProposal	Alternate product Offering proposal is used when the requested product offering is not available with characteristic and date asked for. An alternate proposal could be a distinct product offering or product Spec close to requested one or same as requested but with a different activation date.	No	No	No
category	Reference to a category in the catalog.	No	No	No
eligibilityResultReason	Reason for understanding the eligibility result.	No	No	No
expectedActivationDate	Date when the requester look for productOfferingQualification activation.	No	No	No
note	Extra information about a given entity.	No	No	No
product	The polymorphic attributes @type, @schemaLocation & @referredType are related to the Product entity and not the ProductRefOrValue class itself.	No	No	No
productOffering	ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.	No	Yes	Yes	ProductOffering sub-resource fields mapping	POST
promotion	Promotion reference. Promotion Resource is used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases.	No	No	No
qualificationItemRelationship	Structure used to describe relationship between productOfferingQualification item from the same ProductOfferingQualification.	No	No	No
qualificationItemResult	Qualification result for this checkProductOfferingQualification item. It could be qualified (request productOffering or productSpecification are available), unqualified (requested not available and not alternate available), alternate (requested not available but alternate proposal available).	No	No	Yes		POST
state	State of the CheckProductOfferingQualification item.	No	No	Yes		POST
terminationError	Extra information about a given entity.	No	No	No		POST

ProductOfferingQualification Sub-resources

ProductOffering

TMF Field	Description	Is Mandatory as per TMForum?	Is Mandatory for salesforce?	Supported	Salesforce Object	Salesforce Field	Supported Methods
id	Unique identifier.	No	Yes	Yes	Product2	Id	POST
name	Name of the referred entity.	No	No	Yes	Product2	Name	POST
@type	When sub-classing, this defines the sub-class extensible name.	No	No	Yes
version	Version of the product offering.	No	No	No
@baseType	When sub-classing, this defines the super-class.	No	No	No
@schemaLocation	A URI to a JSON-Schema file that defines additional attributes and relationships.	No	No	No
@referredType	The actual type of the target instance when needed for disambiguation.	No	No	No

RelatedPartyOrPartyRole

TMF Field	Description	Is Mandatory as per TMForum?	Is Mandatory for Salesforce?	Supported	Salesforce Object	Supported Methods
@type	When sub-classing, this defines the sub-class Extensible name	Yes	No	Yes		POST
@schemaLocation	A URI to a JSON-Schema file that defines additional attributes and relationships.	No	No	No
@baseType	When sub-classing, this defines the super-class.	No	No	No
partyOrPartyRole	A PartyOrPartyRole.	No	No	Yes	PartyRef sub-resource fields mapping	POST
role	Role played by the related party or party role in the context of the specific entity it is linked to.	Yes	No	Yes		POST

PartyRef

TMF Field	Description	Is Mandatory as per TMForum?	Is Mandatory for Salesforce?	Supported	Salesforce Object	Salesforce Field	Supported Methods
@type	When sub-classing, this defines the sub-class extensible name.	No	No	Yes
@schemaLocation	A URI to a JSON-Schema file that defines additional attributes and relationships.	No	No	No
@referredType	The actual type of the target instance when needed for disambiguation.	Yes	Yes	Yes
@baseType	When sub-classing, this defines the super-class.	No	No	No
id	Unique identifier.	No	Yes	Yes	Account	Id	POST
name	Name of the referred entity.	No	Yes	Yes	Account	Name	POST
href	Hyperlink reference.	No	No	No

QueryProductOffering

TMF Field	Description	Is Mandatory as per TMForum?	Is Mandatory for Salesforce?	Supported	Salesforce Object	Supported Methods
creationDate	A DateTime. Date and time when the QueryProductOfferingQualification was created.	Yes	Yes	Yes		GET
description	A String. Description of the QueryProductOfferingQualification.	No	No	No
effectiveQualificationDate	A DateTime. Effective date to QueryProductOfferingQualification completion.	Yes	Yes	Yes		GET
expectedQualificationCompletion Date	A DateTime. Expected date rom the server to provide an answer for the query qualification request.	No	No	No
expirationDate	A DateTime. Date the qualification response expires.	No	No	No
note	A Note. Extra information about a given entity.	No	No	No
Category	TMF679 Product Offering Qualification A CategoryRef. Reference to a category in the catalog.	No	No	Yes	Category subresource Mapping	POST/GET
channel	TMF679 Product Offering Qualification A ChannelRef. The channel to which the resource reference to. For example, channel for selling product offerings, channel for opening a trouble ticket and so on.	No	No	No	channel subresource Mapping
qualifiedProductOfferingItem	A QueryProductOfferingQualificationItem.	No	No	Yes	qualifiedProductOfferingItem subresource Mapping	GET
relatedParty	A RelatedPartyOrPartyRole. RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity.	Yes	Yes	Yes	relatedParty sub-resource Mapping	POST/GET
requestedQualificationCompletion Date	A DateTime. Deadline date when the requester expected a qualification answer.	No	No	No
searchCriteria	A QueryProductOfferingQualificationItem.	No	No	No
state	A TaskStateType. Possible values for the state of a task. ENUMERATED with values: * acknowledged * rejected * inProgress * cancelled * done * terminatedWithError	Yes	Yes	Yes		GET
@baseType	A String. When sub-classing, this defines the super-class.	No	No	No
@schemaLocation	A String. A URI to a JSON-Schema file that defines additional attributes and relationships.	No	No	No
@type	A String. When sub-classing, this defines the sub-class Extensible name.	Yes	No	Yes		GET

QueryProductOffering Sub-resources

qualifiedProductOfferingItem

TMF Field	Description	Is Mandatory as per TMForum?	Is Mandatory for Salesforce?	Supported	Salesforce Object
@type	A String. When sub-classing, this defines the sub-class extensible name.	Yes	No	Yes
id	A String. A unique identifier.	Yes	Yes	Yes	NA(Sequence Number)
productOffering	A ProductOfferingRef. ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.	Yes	Yes	Yes	productOffering Mapping
Product	A ProductRefOrValue. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Product entity and not the ProductRefOrValue class itself.	No	No	Yes	Product Mapping
Promotion	A PromotionRef. Promotion reference. Promotion Resource is used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases.	No	No	No
qualificationItemRelationship	A ProductOfferingQualificationItemRelationship. Structure used to describe relationship between productOfferingQualification item from the same ProductOfferingQualification.	No	No	No

productOffering

TMF Field	Description	Is Mandatory as per TMForum?	Is Mandatory for Salesforce?	Supported	Salesforce Object	Salesforce Field
href	A String. Hyperlink reference.	No	No	Yes
id	A String. A unique identifier.	Yes	Yes	Yes	Product2	Id
name	A String. Name of the referred entity.	No	Yes	Yes	Product2	Name
version	A String. Version of the product offering.	No	No	No
@baseType	A String. When sub-classing, this defines the super-class.	No	No	No
@referredType	A String. The actual type of the target instance when needed for disambiguation.	No	No	No
@schemaLocation	A String. A URI to a JSON-Schema file that defines additional attributes and relationships.	No	No	No
@type	A String. When sub-classing, this defines the sub-class Extensible name.	Yes	Yes	Yes

productMapping

TMF Field	Description	Is Mandatory as per TMForum?	Is Mandatory for Salesforce?	Supported	Salesforce Object
id	A String. A unique identifier.	Yes	Yes	Yes	NA (sequence Number)
@type	A String. When sub-classing, this defines the sub-class Extensible name.	Yes	Yes	Yes
agreementItem	An AgreementItemRef. It’s an Agreement item that has been executed previously.	No	No	No
billingAccount	A BillingAccountRef. BillingAccount reference. A BillingAccount is a detailed description of a bill structure.	No	No	No
creationDate	A DateTime. Date and time when the product was created.	No	No	No
description	A String. Description of the product. It could be copied from the description of the Product Offering.	No	No	No
href	A String. Hyperlink reference.	No	No	No
intent	An IntentRefOrValue. Intent Ref (if Intent already exists) or Value (if Intent be created or its details be presented).	No	No	No
isBundle	A Boolean. If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering.	No	No	No
isCustomerVisible	A Boolean. If true, the product is visible by the customer.	No	No	No
name	A String. Name of the product. It could be the same as the name of the product offering	No	No	No
orderDate	A DateTime. Date when the product was ordered.	No	No	No
place	A RelatedPlaceRefOrValue. Entity reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the RelatedPlace entity and not the RelatedPlaceRefOrValue class itself.	No	No	No
product	A ProductRefOrValue. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Product entity and not the ProductRefOrValue class itself.	No	No	No
productCharacteristic	A Characteristic. Describes a given characteristic of an object or entity through a name/value pair	No	No	No	product Characteristic Mapping
productOffering	A ProductOfferingRef. ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information	No	No	No
productOrderItem	A RelatedOrderItem. It’s a Order item that has been executed previously.	No	No	No
productPrice	A ProductPrice. Description of price and discount awarded	No	No	No
productRelationship	A ProductRelationship. Used to describe relationship between product.	No	No	No
productSerialNumber	A String. Serial number for the product. This is typically applicable to tangible products e.g. Broadband Router	No	No	No
productSpecification	A String. Description of the product specification.	No	No	Yes	Product Specification Mapping
productTerm	A ProductTerm. Description of a productTerm linked to this product. This represent a commitment with a duration.	No	No	No
realizingResource	A ResourceRef. Resource reference, for when Resource is used by other entities.	No	No	No
relatedParty	A RelatedPartyOrPartyRole. RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity.	No	No	No
startDate	A DateTime. Date from which the product starts.	No	No	No
status	A ProductStatusType. Possible values for the status of the product	No	No	No
terminationDate	A DateTime. Date when the product was terminated.	No	No	No
@baseType	A String. When sub-classing, this defines the super-class.	No	No	No
@schemaLocation	A String. A URI to a JSON-Schema file that defines additional attributes and relationships.	No	No	No
@type	A String. When sub-classing, this defines the sub-class Extensible name.	No	No	No

productSpecification

TMF Field	Description	Is Mandatory as per TMForum?	Is Mandatory for Salesforce?	Supported	Salesforce Object	Salesforce Field
id	String, A unique identifier.	Yes	Yes	Yes	Product2	Id
@type	A String. When sub-classing, this defines the sub-class Extensible name.	Yes	Yes	Yes
name	A String. Name of the referred entity.	No	Yes	Yes	Product2	Name

TMF Field	Description	Is Mandatory as per TMForum?	Is Mandatory for Salesforce?	Supported	Salesforce Object	Salesforce Field	Supported Methods
Id	A String. Unique identifier.	Yes	Yes	Yes	ProductCategory	Id	POST/GET
name	A String. Name of the referred entity.	No	No	Yes	ProductCategory	Name	POST/GET
version	A String. Version of the category.	No	No	No
@baseType	A String. When sub-classing, this defines the super-class.	No	No	No
@referredType	A String. The actual type of the target instance when needed for disambiguation.	No	No	No
@type	A String. When sub-classing, this defines the sub-class Extensible name.	Yes	Yes	Yes			GET
href	A String. Hyperlink reference.	Yes	Yes	Yes			GET

RelatedParty

TMF Field	Description	Is Mandatory as per TMForum?	Is Mandatory for Salesforce?	Supported	Salesforce Object	Supported Methods
@type	When sub-classing, this defines the sub-class extensible name.	Yes	No	Yes		POST/GET
@schemaLocation	A URI to a JSON-Schema file that defines additional attributes and relationships.	No	No	No
@baseType	When sub-classing, this defines the super-class.	No	No	No
partyOrPartyRole	A PartyOrPartyRole.	No	No	Yes	PartyOrPartyRole resource Mapping	POST/GET
role	Role played by the related party or party role in the context of the specific entity it is linked to.	Yes	No	Yes		POST/GET

PartyOrPartyRole

TMF Field	Description	Is Mandatory as per TMForum?	Is Mandatory for Salesforce?	Supported	Salesforce Object	Salesforce Field	Supported Methods
@type	When sub-classing, this defines the sub-class extensible name.	No	No	Yes			POST/GET
@schemaLocation	A URI to a JSON-Schema file that defines additional attributes and relationships.	No	No	No
@referredType	The actual type of the target instance when needed for disambiguation.	Yes	Yes	Yes			POST/GET
@baseType	When sub-classing, this defines the super-class.	No	No	No
id	Unique identifier.	No	Yes	Yes	Account	Id	POST/GET
name	Name of the referred entity.	No	Yes	Yes	Account	Name	POST/GET
href	Hyperlink reference.	No	No	No

TMF679 v5 Resource Mappings

Constraints and Limitations

CheckProductOfferingQualificationItem

ProductOfferingQualification Sub-resources

ProductOffering

RelatedPartyOrPartyRole

PartyRef

QueryProductOffering

QueryProductOffering Sub-resources

qualifiedProductOfferingItem

productOffering

productMapping

productSpecification

Category

RelatedParty

PartyOrPartyRole