-
Notifications
You must be signed in to change notification settings - Fork 86
KIT Artefacts
General:
- The documentation of a KIT can grow and change
- Think about the customer perspective / who will be using this kit and needs to understand it
- How to create the kit documentation in Github is explained here: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/wiki/How-to-create-a-KIT-website%3F
The vision describes the strategic objectives of a KIT and how it aims to inspire solution providers.
Deliverables:
- Vision catch phrase + context
- Mission catch phrase
- Context to the use case
Starting with the vision of the KIT (one or two catching phrases)
Example from BPDM:
Unique business partner data sets for the whole data space. Basis for integration value-adding services in the area of business partner data management.
The missions of the KIT
The mission explains why we are providing the KIT describing a concrete industry problem.
Example from BPDM: “The Kit provides a homogenous semantic with an open data model, high data quality and one access point to the business partner data sets.”
Giving more context with explaining the connection to the use case
Example from BPDM:
The BusinessPartner Kit provides high-quality data records of business partners called golden record, including a unique identifier, the business partner number (BPN).
…
The business value describes the benefits for an service provider by using a KIT in order to create a commercial or non-profit solution for the Catena-X marketplaces.
Deliverable: About 3 to 5 top business values (title + description)
Example from BPDM:
One open data model: Application and Service provider can reduce investments to integrate due to one data model / API specification and open interface. The pool API enables the integration and offering of value-added services and innovation based on high-quality master data.
Access to new market potentials: Potential to scale customer group and access new market potentials via Catena-X marketplace and shared service network. The BP Kit enables an interoperable foundation for value-added services.
The unique identifier: BPN is the unique number to identify and find partners in the Catena-X network. It will also provide high quality data sets from business partners, their legal unit, sites and addresses.
This gives more insights into the use case or domain itself.
- Todays challenge
- Values for taking the challenge
- Benefits for OEM, SME, Solution Provider
Deliverable: Status quo, challenge and the benefits from different perspectives
Example from BPDM:
Business Partner KIT comes from the use case Business Partner Data Management.
Status Quo / Todays challenge:
Most of today’s automotive companies have to invest a significant amount to keep their individual partner master data updated and correct, since outdated or incorrect data records result in federal fines and wrong claims / billing processes. The industry spends a vast amount into an area that is non differentiating, regulated and executed redundantly across the partners.
For this, cutting individual company costs by offering the golden master data record as a shared service and proactively reduce Business Partner risk via collaborative value-add services.
This will become the industry’s largest golden record collection as a shared and cost-optimized service (quality tested by the biggest players).
OEMs and small-medium enterprises can:
- Reduce today’s individual investments in master data mgt.
- Re-allocate freed-up resources to differentiating / critical tasks
- Time to value within 6 months, due to standard interfaces and mapping tools (e.g. SAP)
- Increase data quality and use industry collective wisdom to act pro-actively (e.g. fraud alerts)
Solution Provider:
- Reduce investments to integrate due to one Data Model and open interface.
- The Kit enables the offering of value-add services and innovation based on golden record and collective wisdom.
- Potential to scale customer group and access new market potentials via marketplace and shared service network.
A tutorial provides educational resources that provides step-by-step guidance on how to use a KIT. Tutorials can be delivered in various formats, such as videos or written text. It may also provide additional resources for further exploration of the topic.
Deliverables:
- Description
- Tutorial video or screenshot documentation
A whitepaper outlines the overall objectives of a KIT regarding a specific business problem. It provides readers with background information on the topic, identifies key challenges and solutions to those challenges, evaluates alternative approaches to solving the business problem at hand, and offers recommendations for action.
Deliverable:
- Description
- Link to the whitepaper
The semantic data models are a method of structuring data that includes semantic information that adds a basic meaning to the data and the relationships that lie between them to enable interoperability.
Deliverables:
- Description
- Link to the semantic data models (GitHub)
Logic / schemas provides a definition of the minimum viable business process that must be implemented to enable interoperability.
Deliverables: Description
- Business Architecture
- Access & Usage Policies
Links to the relevant standards (Association Library)
... provides developers with resources to accelerate the development of apps and services.
Deliverable:
- Introduction to the API
- Whats the main focus of the API
- Integration of the OpenAPI file
Example from DataChain KIT: The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.
Example for OpenAPI integration:
https://eclipse-tractusx.github.io/docs/kits/Business%20Partner%20Kit/Software%20Development%20View/Pool%20Api/business-partner-data-management-pool
Deliverable:
- Description on how to use the sample data
- File with sample data
Deliverable:
- Description
- Link to repository
Deliverable:
- Arch42
- Usage examples
- More explaination on how to use the API in different scenarios
... provides resources to deploy and operate centralized & decentralized Catena-X offerings in your IT environment (e.g., on-prem, cloud).
Deliverables: Quick Setup Guide / Installation Instructions
- Prerequisites (if they exist)
- Authorization information
- Deployment Deployment Scripts