Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Product Lifecycle Management STATE MODEL

Product Lifecycle Management (PLM) is responsible for managing the entire lifecycle of the catalog element and its underlying components. This include all of the processes required to design, build, deploy, maintain and ultimately retire the catalog element.

When the macro conception of a catalog element is started the first status of the later is "In Study".
When the conception of the catalog element is accepted its status is changed to "In Design".
If the design is approved its status is changed to "In Test".
Then either the test is OK and then its status is changed to "Active" or the test is KO and its status is changed to "Rejected". The Rejected status is a final status.
When a catalog element is in an "Active" status it means it has been validated and tested, but it is still not available for customers.
When the beginning of marketing is reached, its status is changed to "Launched". At this moment customers can buy it.
If the catalog element is not launched, its status is changed to "Retired".
The same status is achieved when a catalog element reaches the end of marketing.
The "Retired" status means it can not be sold to any new customers, but previous customers can still have it.
When no more customer holds the catalog element, its status is changed to "Obsolete" meaning it can be removed from the catalog.

...

Catalog RESOURCE

The root entity for catalog management.
A Product Catalog is a collection of Product Offerings, intended for a specific DistributionChannel, enhanced with additional information such as SLA parameters, invoicing and shipping details. Each Product Offering in a Product Catalog combines pricing and availability information with Product Specifications that describe the relationships between Products, the Services used to realize the Products, and the Resources they require.
Below is a representation of the Catalog resource in JSON format.

{
"id": "10",
"href": "http://serverlocation:port/catalogManagement/catalog/10",
"version": "2.0",
"lastUpdate": "2013-04-19T16:42:23.0Z",
"type": "Product Catalog",
"category":
[
{
"id": "12",
"href": "http://serverlocation:port/catalogManagement/category/12",
"version": "2.0",
"name": "Cloud offerings"
}
],

"name": "Catalog Wholesale Business",
"lifecycleStatus": "Active",
"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z",
"endDateTime": "2013-06-19T00:00:00.0Z"
},

"relatedParty":
[
{
"id": "1234",
"href": "http://serverLocation:port/partyManagement/partyRole/1234",
"role": "Owner"
},

{
"role": "Reviser",
"name": "Roger Collins"
}
]
}

 


Anchor_Toc362514680_Toc362514680Field Descriptions :
Catalog: Is a collection of Product Offerings, intended for a specific DistributionChannel, enhanced with additional information such as SLA parameters, invoicing and shipping details.

...

Field

Description

id

Unique identifier of related party

href

Reference of the relatedParty, could be a party reference or a partyRole reference

name

Name of the related party

role

Role of the related party

validFor

The period for which the related party is linked to the entity


UML model:

...

Category RESOURCE

The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.
Resource IDs for categories are strings and are defined by the catalog application.
Below is a representation of the Category resource in JSON format.

...

Field

Description

description

Description of the category

href

Reference of the catalog

id

Unique identifier of the category

isRoot

If true, this Boolean indicates that the category is a root of categories

lastUpdate

Date and time of the last update

lifecycleStatus

Used to indicate the current lifecycle status

name

Name of the category

parentId

Unique identifier of the parent category

validFor

The period for which the category is valid

version

Category version


UML model:

...

Product Offering RESOURCE

The Product Offering resource represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
Note: isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true).
If false, then a productSpecification will be returned, but the bundledProductOfferings will be absent or empty and vice-versa if isBundle is true.
Below is a representation of the ProductOffering resource in JSON format.

one timeOne Time",
"unitOfMeasure": "",
"price":
{
"percentage": 100
},

"recurringChargePeriod": "",
"priceCondition": "apply if total amount of the order is greater than 300.00"
}
}
]
}

{
"id": "42",
"href": "http://serverlocation:port/productCatalogManagement/productOffering/42",
"version": "12.0",
"lastUpdate": "2013-04-19T16:42:23.0Z",
"name": "Virtual Storage Medium",
"description": "Virtual Storage Medium",
"isBundle": true,
"lifecycleStatus": "Active",
"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z",
"endDateTime": "2013-06-19T00:00:00.0Z"
},

"category":
[
{
"id": "12",
"href": "http://serverlocation:port/catalogManagement/category/12",
"version": "2.0",
"name": "Cloud offerings"
}
],

"channel":
[
{
"id": "13",
"href": "http://serverlocation:port/marketSales/channel/13",
"name": "Online Channel"
}
],

"place":
[
{
"id": "12",
"href": "http://serverlocation:port/marketSales/place/12",
"name": "France"
}
],

"bundledProductOffering":
[
{
"id": "15",
"href": "http://serverlocation:port/productCatalogManagement/productOffering/15",
"lifecycleStatus": "Active",
"name": "Offering 15"
},

{
"id": "64",
"href": "http://serverlocation:port/productCatalogManagement/productOffering/64",
"lifecycleStatus": "Active",
"name": "Offering 64"
}
],

"serviceLevelAgreement":
{
"id": "28",
"href": "http://serverlocation:port/slaManagement/serviceLevelAgreement/28",
"name": "Standard SLA"
},

"productSpecification":
{
"id": "13",
"href": "http://serverlocation:port/productCatalogManagement/productSpecification/13",
"version": "2.0",
"name": "specification product 1"
},

"serviceCandidate":
{
"id": "13",
"href": "http://serverlocation:port/serviceCatalogManagement/serviceCandidate/13",
"version": "2.0",
"name": "specification service 1"
},

"resourceCandidate":
{
"id": "13",
"href": "http://serverlocation:port/resourceCatalogManagement/resourceCandidate/13",
"version": "2.0",
"name": "specification resource 1"
},

"productOfferingTerm":
[
{
"name": "12 Month",
"description": "12 month contract",
"duration": "12",
"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z",
"endDateTime": "2013-06-19T00:00:00.0Z"
}
}
],

"productOfferingPrice":
[
{

"name": "Monthly Price",
"description": "monthlyprice",
"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z",
"endDateTime": "2013-06-19T00:00:00.0Z"
},

"priceType": "recurring",
"unitOfMeasure": "",
"price":
{
"taxIncludedAmount": 12,
"dutyFreeAmount": 10,
"taxRate": 20,
"currencyCode": "EUR",
"percentage": 0
},

"recurringChargePeriod": "monthly"
},

{

"name": "Usage Price",
"description": "usageprice",
"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z",
"endDateTime": "2013-06-19T00:00:00.0Z"
},

"priceType": "usage",
"unitOfMeasure": "second",
"price":
{
"taxIncludedAmount": 12,
"dutyFreeAmount": 10,
"taxRate": 20,
"currencyCode": "EUR",
"percentage": 0
},

"recurringChargePeriod": "",
"productOfferPriceAlteration":
{
"name": "Shipping Discount",
"description": "One time shipping discount",
"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z"
},

"priceType": "

Anchor
_GoBack_GoBack

...


Field Descriptions :
BundledProductOffering: A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.
Category: is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.

...

Field

Description

href

Reference of the resource candidate

id

Unique identifier of the resource candidate

name

Name of the resource candidate


UML model:

...


...

Product Specification RESOURCE

The ProductSpecification Resource is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Below is a representation of the ProductSpecification resource in JSON format.

...

Field

Description

href

Reference of the serviceSpecification

id

Unique identifier of the service specification

name

Name of the requiredServiceSpecification

version

Service specification version


UML model:

...

Export Job Resource

An ExportJob resource represents a TASK used to export resources to a File
The ExportJob resource supports the following properties:

...

{
        "id": "54",
        "href": "http:/api/catalogManagement/exportJob/54",
        "status": "running",
        "path": "partyManagement/",
        "content-type": "application/json",
        "errorLog": "",
        "creationDate": "2013-04-19T16:42:23-04:00",
        "completionDate": "2013-04-21T16:42:23-04:00",
        "url": "ftp://ftp.myCatalog.com/party/54"
    }   

 

UML Model:

...

Import Job Resource

An ImportJob resource represent a TASK used to import resources from a File
The ImportJob resource supports the following properties:

...

{
        "id": "54",
        "href": "http:/api/catalogManagement/importJob/54",
        "status": "completed",
        "path": "catalogManagement/",
        "content-type": "application/json",
        "errorLog": "",
        "creationDate": "2013-04-19T16:42:23-04:00",
        "completionDate": "2013-04-21T16:42:23-04:00",
        "url": "ftp://ftp.myCatalog.com/party/54"
    }   

 

UML Model:

...

Notification Resource Models

Two notification event types are defined:

...