1.1 Overview

This section describes how to exchange a ChangeObject from an external PLM system to the SAP system and vice versa. As a result, either an SAP ECM or SAP Change Record is created or updated.
The Integration allows doing the following use cases:

Direction: External PLM System --> SAP

Create a new SAP ECM in SAP
Create a new SAP Change Record in SAP
Update an SAP ECM in SAP
Update an SAP Change Record in SAP
Transfer attachments and assign them to SAP ECM or SAP Change Record

Direction: SAP --> External PLM System

Create a Change Object in the external PLM system based on an SAP Engineering Change Master
Create a Change Object in the external PLM system based on an SAP Engineering Change Record
Update a Change Object in the external PLM system based on an SAP Engineering Change Master
Update a Change Object in the external PLM system based on an SAP Change Record
Transfer a Change Object attachment based on a linked DIR to an SAP Engineering Change Master
Transfer a Change Object attachment based on a linked DIR to an SAP Engineering Change Record

Supported Entities	ECC	S/4HANA Cloud, private edition	S/4HANA Cloud, public edition
Engineering Change Master	SUPPORTED	SUPPORTED
Change Record		SUPPORTED

2. Object Definition

Fieldname

Description

PLMSI Behaviour

key

Key of the ChangeObject

MANDATORY

id

ChangeObject id

Value	Scenario	Behavior
blank	SAP ECM	The integration generated the next free number for an SAP ECM
blank	SAP Change Record	The integration generated the next free number for an SAP Change Record
provided value	SAP ECM	In case the ECM does not exist, an ECM is created with the provided id. In case the ECM exists, the ECM is updated. The prerequisite is that the ECM is under integration control.
provided value	SAP Change Record	In case the CR does not exist, an CR is created with the provided id. In case the CR exists, the CR is updated. The prerequisite is that the ECM is under integration control.

type

ChangeObject type

Scenario	Behavior
SAP Change Record	Mapped to SAP Change Record Type. See PLMSI config
SAP ECM	no differentiation

version

ChangeObject version

Value	Behavior
blank	Accepted

tempPLMId

temporary PLM ID of the business entity

The PLM ID is provided if the direction of External PLM System --> SAP or in the response.

tempERPId

temporary ERP ID of the business entity

The ERP ID is provided if the direction of SAP --> External PLM System or in the response. The ERP Id contains the concatenated SAP ECM Number or SAP Change Record number.

Attributes

OPTIONAL

validFrom

Contains date and time of the FROM effectivity or release date directly assigned to the object.

e.g. "2022-12-01T07:42:28Z"

This property is only influencing the business logic in case a DV is represented by an SAP DIR with Revision Levels

Value	Scenario	Behavior
blank or every date below 01-01-1900	SAP ECM	An SAP Engineering Change Master is created with valid-from date of 01.01.1900 to create the Material Master Revision Level
blank or every date below 01-01-1900	SAP Change Record	An SAP Engineering Change Master is created implicitly with valid-from date 01.01.1900. This so-called main ECM is used to control the validity of the solutions items with the same validity.
provided value	SAP ECM	An SAP Engineering Change Master is created with the provided valid-from to create the Material Master Revision Level
provided value	SAP Change Record	An SAP Engineering Change Master is created implicitly with the provided valid-from date 01.01.1900. This so-called main ECM is used to control the validity of the solutions items with the same validity.

status

Contains the status of the business object

The combination of DM Status and DM Maturity is translated based on the PLMSI configuration:

Scenario	Behavior
SAP ECM	ECM status
SAP Change Record	Change Record user status

maturity

Contains the maturity of the business object

displayURL

URL for data federation a show link to SAP/TC object

URL for the WebGui SAPGUI for SAP ECM or Fiori for Change Record

names[]

Contains multi-language short descriptions.

OPTIONAL Behavior: You either have to provide names[] or descriptions [] during initial create of a CO

Linked to the SAP SAP ECM/CR short text.

language

Language (according to ISO 639-1)

ISO Language Key like e.g. "EN,"DE", ...

value

Short text

Text

descriptions[]

Contains multi-language descriptions.

OPTIONAL

Behavior: You either have to provide names[] or descriptions [] during the initial create of a PV

Linked to the SAP SAP ECM/CR long text.

language

Language (according to ISO 639-1)

ISO Language Key like e.g. "EN,"DE", ...

value

Long text

Text

relatedProductVersions[]

Product versions as referenced items

OPTIONAL

key

ProductVersion Key ( see ProductVersion MDM definition)

Scenario	Direction	Behavior
SAP ECM	PLM2SAP	Ignored
SAP ECM	SAP2PLM	The material masters known to the integration with an OMR are transferred. RelationType is determined based on PLMSI outbound Configuration.
SAP Change Record	PLM2SAP	Material Masters are added to the Change Record as Change Items. The Change Record item relevance type is set based on the PLMSI configuration for the received DM relation type.
SAP Change Record	SAP2PLM

relationType

Relation types like e.g. affected, reference, problem

relatedDocumentVersions[]

Product versions as referenced items

OPTIONAL

key

DocumentVersion Key ( see DocumentVersion MDM definition)

Scenario	Direction	Behavior
SAP ECM	PLM2SAP	Ignored
SAP ECM	SAP2PLM	The Document Info Records known to the integration with an OMR are transferred. RelationType is determined based on PLMSI outbound Configuration.
SAP Change Record	PLM2SAP	Document Info Records are added to the Change Record as Change Items. The Change Record item relevance type is set based on the PLMSI configuration for the received DM relation type.
SAP Change Record	SAP2PLM

relationType

Relation types like e.g. affected, reference, problem

relatedStructureVersions[]

Product versions as referenced items

OPTIONAL

key

StructureVersion Key ( see StructureVersion MDM definition)

Scenario	Direction	Behavior
SAP ECM	PLM2SAP	Ignored
SAP ECM	SAP2PLM	The BOMs known to the integration with an OMR are transferred. RelationType is determined based on PLMSI outbound Configuration.
SAP Change Record	PLM2SAP	BOMs are added to the Change Record as Change Items. The Change Record item relevance type is set based on the PLMSI configuration for the received DM relation type.
SAP Change Record	SAP2PLM

relationType

Relation types like e.g. affected, reference, problem

relatedProductionOperationLists[]

ProductionOperationList as referenced items

OPTIONAL

key

ProductionOperationList Key ( see ProductionOperationList MDM definition)

Scenario	Direction	Behavior
SAP ECM	PLM2SAP	Ignored
SAP ECM	SAP2PLM	The classic PP routings known to the integration with an OMR are transferred. RelationType is determined based on PLMSI outbound Configuration.
SAP Change Record	PLM2SAP	ignored
SAP Change Record	SAP2PLM	ignored

relationType

Relation types like e.g. affected, reference, problem

Stakeholders[]

Stakeholder Collection

OPTIONAL

key

Key of one stakeholder

not linked

- id

not linked

- type

Can be defined in PLMSI Configuration and must be aligned with the sending/receiving system

role[]

Roles of a stakeholder like e.g. Requester, Approver, ...

not linked

- code

Can be defined in PLMSI Configuration and must be aligned with the sending/receiving system

name

Stakeholder name

Readable Name. Info only

email

Stakeholder email

In the case of the SAP Change Record scenario, the system tries to find an SAP Business Partner with the same e-mail address. If a BP is found, the BP will be entered as Change Coordinator of the SAP Change Record. The applicable stakeholder role code is "Responsible". The default logic is implemented as part of the Enhancement point /PLMS/EI_CR_RESPONSIBLE and can be deactivated or changed by an own implementation.

extensionFields[]

extension fields to exchange additional attributes

OPTIONAL

Extension Fields can be mapped based on the PLMSI Field and Value mapping (FVM) to SAP standard fields and DIR classification.

key

Key to identifying the extension field

Key must be unique per entity

subkey

SubKey to further identify the extension field

The subkey must be unique per entity and per key.

displayName

Readable name for the extension field

Display name of readability only and for data federation

value

Value of the extension field

Only one of the value fields must be provided. An error message is returned if more than one value field is filled.

The value can also be empty/initial.

valueDescription

Value Description

valueInt

Value Integer

valueDec

Value Decimal

valueDate

Value Date

valueDuration

Value Duration

Payload Examples: Direction → PLM2SAP & SAP2PLM

Page tree

03 - ChangeObject

1.1 Overview

2. Object Definition

Fieldname

Description

PLMSI Behaviour

Payload Examples: Direction → PLM2SAP & SAP2PLM