SAP S/4HANA Extension


Installation

  • Go to Extensions → Marketplace → Search for extension SAP S/4HANA Extension → Click the Install action in "ACTIONS" menu


SAP S4HANA Market Place
Figure 1. SAP S/4HANA Extension at Marketplace

SAP S4HANA Extension Installation 1
Figure 2. SAP S/4HANA Extension Installation : Step 1

SAP S4HANA Extension Installation 2
Figure 3. SAP S/4HANA Extension Installation : Step 2

SAP S4HANA Extension Installation 3
Figure 4. SAP S/4HANA Extension Installation : Step 3

SAP S4HANA Extension Installation 4
Figure 5. SAP S/4HANA Extension Installation : Step 4

SAP S4HANA Extension Installation 5
Figure 6. SAP S/4HANA Extension Installation : Complete

Upgrade

  • Upgrading the extension can be done easily from the Marketplace itself.

    • Go to Extensions → Marketplace → Search for extension SAP S/4HANA Extension → Click the Upgrade action in "ACTIONS" menu


SAP S4HANA Extension Upgrade 1
Figure 1. SAP S/4HANA Extension Upgrade : Step 1

  • The changes available in the new version of the extension can be seen under the Changelog screen while upgrading.


SAP S4HANA Extension Upgrade 2
Figure 2. SAP S/4HANA Extension Upgrade : Change Log

  • Continue on the upgrade window similar to the installation steps.


Configurations

  • Configuration properties are pre-populated which user can modify as per the requirement.

  • There are different tabs like CONNECTION, DATA SETTINGS and ENDPOINTS from which the user can configure the properties to get SAP S/4HANA connector working.

  • Configure the following properties from Extensions → Settings.

Attribute Mapping

Attribute mapping feature helps the user to map 3DEXPERIENCE attributes with SAP S/4HANA attributes from UI. If there is no mapping found for the attribute then configured SAP S/4HANA Default Value will be used in the payload. Default attribute mappings configuration are shown below.


1. ATTRIBUTES

SAP S4HANA Extension Settings Attributes 1
ATTRIBUTES:Base Unit
3DX Name Unit Of Measure

SAP Name

BaseUnit

Value Mapping

UOM

Value Max Length

SAP Default Value

KG


SAP S4HANA Extension Settings Attributes 2
ATTRIBUTES:Bill of Material Item Unit
3DX Name Bill of Material Item Unit

SAP Name

BillOfMaterialItemUnit

Value Mapping

UOM

Value Max Length

SAP Default Value

KG


SAP S4HANA Extension Settings Attributes 3
ATTRIBUTES:BOM Header Base Unit
3DX Name BOM Header Base Unit

SAP Name

BOMHeaderBaseUnit

Value Mapping

UOM

Value Max Length

SAP Default Value

KG


SAP S4HANA Extension Settings Attributes 4
ATTRIBUTES:Product Group
3DX Name Product Group

SAP Name

Material Group

Value Mapping

Value Max Length

SAP Default Value

ZFORK


SAP S4HANA Extension Settings Attributes 5
ATTRIBUTES:Product Type
3DX Name Type

SAP Name

Product Type

Value Mapping

ProductType

Value Max Length

SAP Default Value

FERT


SAP S4HANA Extension Settings Attributes 6
ATTRIBUTES:Weight Unit
3DX Name Net Weight

SAP Name

WeightUnit

Value Mapping

WeightUnit

Value Max Length

SAP Default Value

KG


2. MAPPINGS

SAP S4HANA Extension Settings Mappings 1
MAPPINGS:ProductType
3DX Value SAP S/4HANA Value

Appliance Product Part

ROH

Assembled Product Part

FERT

Closure Part

ROH

Consumer Kit Part

HAWA

Consumer Unit Part

HAWA

CreateAssembly

FERT

Display Unit Part

VERP

Electrical Part

ROH

Finished Product Part

FERT

Formulation Part

ROH

Handling Unit Part

VERP

Hardware Part

ROH

Kit Part

HAWA

Label Part

ROH

Manufacturing Part

ROH

Material Part

ROH

Mechanical Part

ROH

Packaging Assembly Part

VERP

Packaging Component Part

VERP

Packaging Material Part

VERP

Pallet Part

VERP

Part

ROH

Phantom Part

ROH

Product Data Part

ROH

Promotional Item

UNBW

Raw Material

ROH

Semi-Finished Product Part

HALB

Software Part

ROH

Supplier Equivalent Part

ROH

Support Part

DIEN

Synthetic Part

ROH

Tool Part

FHMI

Trade Unit Part

HAWA

Transport Unit Part

VERP

VPMReference

ROH

XBOM Kit Part

HAWA


SAP S4HANA Extension Settings Mappings 2
MAPPINGS:UOM
3DX Value SAP S/4HANA Value

LB

LB

IN

''

MM

MM

MM2

MM2

MM3

MM3

YD

YD

Batch

%

%

PPM

PPM

MG

MG

CG

G

G

KG

KG

OZ

OZ

T

TO

ML

ML

CL

CL

GA

GAL

PT

PT

QT

QT

CONE

GR

GRO

ROLL

ROL

FT

FT

EA

EA

CM

CM

CM2

CM2

CM3

CCM

FT2

FT2

FT3

FT3

IN2

|2

IN3

|3

LITER

L

M

M

M2

M2

M3

M3


SAP S4HANA Extension Settings Mappings 3
MAPPINGS:WeightUnit
3DX Value SAP S/4HANA Value

g

G

kg

KG

cg

mg

MG

lb

LB

oz

OZ

T

TO


Connection

This tab allows user to configure the properties required for communication between 3DEXPERIENCE and SAP S/4HANA.

3. CONNECTION

SAP S4HANA Extension Settings Connection
Variable Description Example
  • 3DEXPERIENCE Agent id

3DEXPERIENCE Agent id for Extension

  • 3DEXPERIENCE Agent secret

3DEXPERIENCE Agent secret for Extension

  • Base URL to SAP

Base url of SAP S/4HANA

https://<host address>

  • Security Context

Security context to be used else default from 3DExperience will be used

VPLMProjectLeader.Company Name.Common Space

  • SAP Client ID

Client id of SAP S/4HANA

500

  • SAP S/4HANA Login name

User name to login to SAP S/4HANA

  • SAP S/4HANA Password

Password for the user name

  • SAP S/4HANA Version

SAP S/4HANA Version for version-specific payload handling

2023 or 1909

Regex won’t work with security context. Actual value is to be used.

Data Settings

This tab allows user to configure the properties that help in generating payload.


4. DATA SETTINGS

The below shown values are from a demo point of view.
SAP S4HANA Extension Settings Data Settings

Common Data Settings

Variable Description Example
  • 3DSpace tenant

Url for 3DSpace tenant

https://<host address>

  • BOM Line Condensed

-

true

  • Default Quantity

Single item quantity

1

  • Document Created by CAD

-

false

  • Include Revision Version

Example; A.1

false

  • Industry Sector

-

M

  • Inventory Valuation Procedure

-

S

  • Language

EN = English

EN

  • Plant number

-

1100

  • Price Unit Quantity

-

1

  • Product Configurable

-

true

  • Valuation class for FERT

Valuation class for product type FERT at SAP S/4HANA

7920

  • Valuation class for ROH

Valuation class for product type ROH at SAP S/4HANA

3000

BOM

Variable Description Example
  • BOM Category

-

M

  • BOM Header Qty Baseunit

-

1

  • BOM Item Category

-

C

  • BOM Variant Usage

2 = Engineering BOM, Default = 2

2

  • Multiple BOM Alt

false

Change

Variable Description Example
  • Change Number Release Key

-

0

  • Change Number Status

-

1

  • Material

SAP Object Type

Material

  • Material BOM

SAP Object Type

MaterialBOM

Document

Variable Description Example
  • Attachment type code for document

Mode of sending document to SAP S/4HANA

URL / FILE

  • Business Object Type Name

BUS1001006

  • Convert document to PDF

Convert Microsoft Office documents to PDF format before transmitting them as files to SAP S/4HANA.

false

  • File Download URL

URL to download file when attachment type code is URL

${sap.s4hana.3dspace.tenant}/#app:ENXWDOC_AP/content:X3DContentId=

MBOM

Variable Description Example
  • MBOM Variant Usage

1 = Production BOM, Default = 1

1

BOP Resources

Variable Description Example
  • Work Center Category Code

Category code to push 3DX resource to SAP

0001

  • Bulkfetch Batch Size limit

Max resource records per batch when fetching from SAP

20

  • Capacity Internal ID

Internal ID for capacity

0

  • WorkCenter Is To Be Deleted

Mark resource for deletion

false

  • Validity Start Date

Resource validity start date

2024-12-31

  • Validity End Date

Resource validity end date

9999-12-31

  • Standard Work Formula Param Group

Parameter group for standard work formula

SAP1

  • Marked Backflush

Material component is marked for backflush

false

Bill of Process(BOP)

Variable Description Example
  • Starting Operation Sequence

BOP operations’ starting sequence number

100

  • BillOfOperations Status

BOP status

1

  • BillOfOperations Usage

BOP usage type

1

  • Responsible Planner Group

Planner group for the operation

01

  • Minimum Lot Size Quantity

-

1

  • Maximum Lot Size Quantity

-

999999

  • Sequence Category

Sequence category ID

0

  • Operation Control Profile

Operation control profile ID

YBM1

  • Operation Unit

Unit of measure for operation

EA

  • OpQty to BaseQty Numerator

Numerator for operation quantity conversion

1

  • OpQty to BaseQty Denominator

Denominator for operation quantity conversion

1

  • Operation Reference Quantity

Quantity for operation reference

1

BOP Product Version

Variable Description Example
  • BillOfOperations Type

Production version operation type

N

  • UsgeProblty With Vers Ctrl In Pct

Usage probability with version control

0

  • Material Base Unit

Base unit of measure for the material

EA

  • Material Min. Qty

Minimum material quantity

0

  • Material Max. Qty

Maximum material quantity

99999999

  • Cost Lot Size

Costing lot size for production version

0

  • MRP Controller

MRP controller for production version

THK

  • MRP Responsible

MRP responsible person

THK

  • Routing Status Text

Routing check status text

Not yet checked

  • Version Lock Text

Lock text for the version

Not locked


5. DEVELOPMENT

As of release V1 , the DEVELOPMENT tab is meant for development environment. It is used to generate Item numbers and Change Action numbers as required by the destination system (SAP S/4HANA).

Endpoints

This tab allows user to configure the endpoints where payload needs to be sent at SAP S/4HANA.


6. ENDPOINTS

SAP S4HANA Extension Settings Endpoints

Change, Attachment & Material

Variable Description Example
  • BOM URI

SAP S/4HANA API used to send payload for Send BOM & Send BOM with CA use case

sap/API_BILL_OF_MATERIAL_SRV;v=2/MaterialBOM

  • CA URI

SAP S/4HANA API used to send payload for Send CA use case

sap/opu/odata/sap/API_CHANGEMASTER;v=2/A_ChangeMaster

  • Item Revise URI

SAP S/4HANA API used to send payload for Revise Engineering Item use case

sap/opu/odata/sap/API_PRODUCT_SRV/A_Product('<ITEM_NAME>')

  • Material CA URI

SAP S/4HANA API used to send payload for Associate CA use case

sap/opu/odata/sap/API_CHANGEMASTER; v=2/('<CA_NUMBER>')/to_ChangeMstrObMgReMaterial

  • Product URI

SAP S/4HANA API used to send payload for Send Engineering Item use case

sap/opu/odata/sap/API_PRODUCT_SRV/A_Product

  • Send Attachment as Link URI

SAP S/4HANA API used to send attachment as link for Send Document use case

/sap/opu/odata/sap/API_CV_ATTACHMENT_SRV/CreateUrlAsAttachment? MIMEType='${MIME_TYPE}'&UrlDescription='${URL_DESC}'& Url='${DOC_LINK}'&BusinessObjectTypeName='${BUS_OBJ_TYPE} '&LinkedSAPObjectKey='${SAP_OBJ_KEY}'&SemanticObject=''

  • Send Attachment URI

SAP S/4HANA API used to send attachment for Send Document use case

sap/opu/odata/sap/API_CV_ATTACHMENT_SRV/AttachmentContentSet

  • Send Description URI

SAP S/4HANA API used to payload for Send Product Description use case

/sap/opu/odata/sap/API_PRODUCT_SRV/A_ProductDescription( Product='${ITEM_NAME}',Language='${LANGUAGE}')

  • Send Basic Text URI

SAP S/4HANA API used to payload for Send Basic Text use case

/sap/opu/odata/sap/API_PRODUCT_SRV/A_ProductBasicText (Product='${ITEM_NAME}',Language='${LANGUAGE}')

  • Send Attributes URI

SAP S/4HANA API used to send payload for syncing attributes (Net Weight, Weight Unit) for Send Engineering Material Attributes use case

/sap/opu/odata/sap/API_PRODUCT_SRV/A_Product('${ITEM_NAME}')

  • Token URI Endpoint

SAP S/4HANA API to fetch the token

sap/opu/odata/sap/API_PRODUCT_SRV/

Resource of Bill Of Process (BOP)

Variable Description Example

Send workcenter URI

URI to send BOP resource item

/sap/opu/odata4/sap/api_work_center/srvd_a2x/sap/workcenter/ ${WORKCENTER_CODE}/WorkCenterHeader

Fetch Resource detail URI

URI to fetch Resource details from 3dx

/resources/v1/modeler/dsrsc/dsrsc:Resource/${RESOURCE_ID}? $mask=dsmvrsc:ResourceMask.Details

Bill Of Process (BOP)

Variable Description Example

Send BOP URI

URI to send BOP to SAP

/sap/opu/odata/sap/API_PRODUCTION_ROUTING/ProductionRoutingHeader

Fetch WorkCenterInternalID URI

URI to fetch the WorkCenterInternalID by the work center and plant from SAP

/sap/opu/odata4/sap/api_work_center/srvd_a2x/sap/workcenter/ ${WORKCENTER_CODE}/WorkCenterHeader?$filter=${FILTER} and Plant eq '${PLANT}'&$select=Plant,WorkCenterInternalID,WorkCenter

Fetch 3dx BOP URI

URI to bulk fetch the Resource items from 3dx

/resources/v1/modeler/dsrsc/dsrsc:Resource/bulkfetch

Fetch 3dx BOP URI

URI to fetch the bill of process from 3dx

/resources/v1/modeler/dsprcs/dsprcs:MfgProcess/${OBJ_ID}? $mask=dsprcs:MfgProcessMask.Structure.ModelView.Index

BOP Product Version

Variable Description Example

Send BOP Product version URI

URI to send Product version for the BOP sent to SAP

/sap/opu/odata4/sap/api_production_version/srvd_a2x/sap/ productionversion/${WORKCENTER_CODE}/ProductionVersion

  • SAP S/4HANA service is available out of the box. This SAP S/4HANA service is mapped with the events under event mapping.

  • As of release 2.0.0 , additional services are available out of the box.

    • SAP S/4HANA Release

    • SAP S/4HANA Revise

    • A Service corresponds to a job queue. Every event mapping needs to specify to which service it belongs. A service can be configured to run its jobs in sequence OR parallel execution. Either create a single service to handle all the events or create separate services for each event mapping.

Event Mapping

  • Need to enable what events needs to be published from the DS tenant using Event Publishing app.

    • Event mapping holds the information about which use-case needs to be executed when the event is received. It is a binding between the event and job-request.

DS Event Publishing

Example for configured events publishing are as follows
Engineering item → Created, Status Changed, Versioned, etc…​


  • Event mapping need to be created so that required use case should get executed on receiving the event from DS tenant. While creating the events we need to provide the details like

    • Service name

    • Agent

    • Event class and its type

    • Configuration to be invoked

  • Following event mapping is available out of the box.

Events

Event Categories & Types

Created Status Changed Versioned Computed Connected Disconnected

⊟ Event Category :
    Collaborative Spaces Control
 
├ 🗎 Document

├ 🧊 Engineering Item

Manufacturing Item icon Manufacturing Item

Manufacturing Resource BOP Resource

Manufacturing Process icon Bill Of Process(BOP)

 
 

 

🔵

🔵

🔵

🔵

🔵

🔵

🔵

⊟ Event Category : Change
    Process

├ 🄲🄰 Change Action

 
 

🔵

🔵

   


  • SAP-S/4HANA-Create-Eng-Material-Send-Eng-Material - gets invoked on creation of an Engineering item in DS tenant.

  • SAP-S/4HANA-Send-CA - gets invoked on creation of Change Action in DS tenant.

  • SAP-S/4HANA-Send-BOM - gets invoked on release of an Engineering item in DS tenant.

  • SAP-S/4HANA-Release-CA-Send-BOM - gets invoked on release of a Change Action in DS tenant.

  • SAP-S/4HANA-Revise-Engineering-Item - gets invoked on creation of revision of an Engineering item in DS tenant.

  • SAP-S/4HANA-Send-Document - gets invoked on release of an Engineering item in DS tenant.

  • SAP-S/4HANA-Sync-Attributes - gets invoked on release of an Engineering item in DS tenant.

  • SAP-S/4HANA-Send-Description - gets invoked on creation of revision of an Engineering item in DS tenant.

  • SAP-S/4HANA-Send-Basic-Text - gets invoked on creation of revision of an Engineering item in DS tenant.

  • SAP-S/4HANA-Send-Manufacturing-Item - gets invoked on creation of a Manufacturing item in DS tenant.

  • SAP-S/4HANA-Send-MBOM - gets invoked on release of a Manufacturing item in DS tenant.

  • SAP-S/4HANA-Send-Resource - gets invoked on promoting the Resource Item to FROZEN in the DS tenant.

  • SAP-S/4HANA-Send-BOP - gets invoked on promoting the Workplan object known as Bill Of Process(BOP) to FROZEN in the DS tenant.

SAP S/4HANA use cases use token to connect to the destination url for sending the payload.

In general, any SAP S/4HANA use case, use the below javascript classes.

Component Details

1. Use case invoker

It invokes the processor of the specific use case. The invoker is also responsible to pass in the optional set of properties to the use case processor

2. Processor

It has the logic to fetch the data, build the payload and send it to SAP S/4HANA using the Destination Handler.

3. Token Resolver

It fetches the authentication token by connecting to the corresponding SAP S/4HANA url

4. Destination Handler

It has the logic to connect to the SAP S/4HANA urls by performing necessary actions and send the payload.

5. Logger

Logs the details of the items being accessed in the use case.

6. Helper

It has the methods to build the payload for SAP S/4HANA.

7. Util

It has the utility methods that helps to transform the payload data.