B2B Trading Partner Management SAP PI

Age Ag end nda a



TPM temp emplat lates



Func Functional onal profiles ofiles



Tra rad ding par artn tner er profiles ofiles



Tra rad ding par artn tner er ag agreement reements s



TPM ad admin minist istra rattion se on sett ttiings ngs



TPM runt runtime ime access



TPM UDFs UDFs

© 2014 SAP AG or an SAP affiliate company. A ll rights reserved.

2

Age Ag end nda a



TPM temp emplat lates



Func Functional onal profiles ofiles



Tra rad ding par artn tner er profiles ofiles



Tra rad ding par artn tner er ag agreement reements s



TPM ad admin minist istra rattion se on sett ttiings ngs



TPM runt runtime ime access



TPM UDFs UDFs


2

How Ho w to to access TP TPM M?

You follow the procedure below to access B2B TPM application: 1.

You need to assign assign user roles for managing the TPM tool. Without these roles being added to your user, you wouldn't have access to Trading Partner Management. For more information about required TPM roles, refer assigning user roles for managing B2B application in B2B in B2B Security Guide. Guide.

2.

Enter the URL format as http:/b2bic in the Web browser and logon to B2B Integration Cockpit application.

3.

To access Trading Partner Management tool, choose Trading Partner Management. Management .

4.

Important: Important :

– Befo rring wing SP and patc eforre refe eferri ng thi this gu guiide, make sure you ar are on the foll fo llo owing pat ch level of B2B components ponents: B2B AddAdd-On SP2

 o

B2B Tool oolKit SP2 Patc Patch 12

o

XI CONTE NTENT B2B NT B2B TOOLKIT OOLKIT 1.0 Patc Patch 3

o

XI CONTE NTENT B2B NT B2B MAPPIN APPING KIT KIT 1.0 Patc Patch 2

s im po s s t pat c ch fo r v s Not e po r r tant tant to i n ns ta ta ll l ll l ate ate s r PIB2B PIB2B T TOOLKI O OLKI T T on on SP02 l e ev e el l to to benef i it f r r o o m m th th i is T P P M M featu featu r r e. e. e: It i s


3

Trading partner Manage anagem ment TPM User


4

TPM templates

You access and create TPM template in TPM system by choosing T ra ding Partner Management > Profiles > Templates

TPM template 

o

What is a TPM template? TPM template consists of unique set of values that are defined by the user. It is created for specific business requirements. Each value in the template represents referential information that are defined as per the business transaction. You can attach a template to multiple functional profile.

TPM Template Property Key

Default Value



What type of parameters are found in a template?

o

A template consists of the following parameters: o

Display Name

o

Display Type

o

Code List

o

Property Key

o

Default Value


6

TPM template  o



o

What are Key-pair values? A set of property keys and associated values that are defined in a template are known as Key-value Pairs. I m po r tant : These keys and values are case sensitive.

What kind of templates can be created? Templates are custom build forms that stores generic data which can be reusable. Based of your business requirement you can create different templates. Few examples are Material Code Mapping, EDI separators for partners, status Indicator fields etc. and , a template can consists of the following information:


7

Functional profiles

You access and create TPM template in TPM system by choosing Trading Partner Management > Profiles > Functional Profiles

Functional profile 

o

o

What is a functional profile? Functional profile is a collection of TPM templates that uses custom key value for that can be accessed during message mapping

The default key-value pairs defined in a template are applied to test and production values. You cannot add a new key-value pair to an existing profile but you can edit any existing values in a profile. During message mapping runtime, either the test or production value is returned based on the selected system environment under “Administration”. You can configure the system environment in Ad mi n is t ra t io n > Conf ig u ra t io n


9

Define a name for the functional profile

To add a template to a profile, choose Add

Choose this button to apply templates to the profile

Parameters from the applied templates are displayed here


10

Functional profile 

o

o

o

What is the purpose of a functional profile? You use functional profiles to group different templates. Functional profiles themselves can be reused across different partners. Functional profile can be independent or can be attached to a trading partner agreement. During runtime based on the conditions in an agreement, the functional profiles values can be used for messages mapping You can access functional profile during runtime either by calling an agreement or by directly calling a Functional profile Name using predefined UDF’s . For more information about UDF’s, refer the TPM User Defined Functions


11

Functional profile

The figure below describes a runtime message mapping scenario, wherein an Idoc XML file is mapped to an EDI XML file using a functional profile that is defined as per an agreement.

Use Case For example, you can build a functional profile for processing transaction requirements such as material codes, partner specific delimiters and so on.


12

Trading partner profiles

You access Partner Profiles in TPM system by choosing Pa rt ne rs tab page.

Trading partner profile What is purpose of trading partner profile?



Trading partner profile provides a central access to the following partner related information and configuration:

o

•

Identity and classification parameters such as partner name, partner type, classification details and so on. This data also get passed to monitoring so that you can created User Defined Search Attributes and perform a search based on these parameters.

•

Defining certificate rollover from NWA key store

•

Custom parameters such as functional profiles

•

Details on agreements that are defined for specific trading partners

•

Details of EDI run time parameters such as encoding, intending and so on that are used to configure generic converter module Partner Profile Add/ Edit/ View/ Copy/ Search

Identity and classification

EDI Message Type and Ack requirements

Certificates Roll Over


EDI Runtime Parameters

Exceptional conditions via agreements

Custom Parameters

Contacts and Documents reference

14

General tab 

The general tab page consists of information that are partner specific and the classification categories. These details can be using during local message monitoring for searching EDI messages via UDS.



Below are the important fields and their description that needs to be configured



You should also create a Profile for your own organization. You can select Partner Type as self. This is needed during runtime, while creating Agreements and also an essential part for monitoring.

Define the partner details

Provide classification of the trade

Determine the Party Name (or attach existing Party) from Integration Directory


15

Contacts tab







This tab page you provide the details of the trading partners such as e-mail, phone, mobile and so on. You can provide multiple contacts and provide a short description about the contact along with the address in two separate fields.

Note: This information is NOT used during runtime


16

Documents tab



In this tab page you provide the references to existing documents



You can provide short description on each saved documents and edit them as per your requirement.



Though TPM does not provides you a Document Management system, the reference to documents provides you a central screen for accessing all partner related data.


17

Identities tab 

You provide the details such as identifier, agency code, and agency scheme for identifying business partners.



There is a F4 help from which you can choose the standard agencies.



You can also define your own custom identifiers (for example, SupplierNo, CustomerNo and so on. )



Predefined UDFs in message mapping provides you the access to these identities (ie. you can provide one identifier code, agency qualifier code and target qualifier code to get the right unique identifier value for the partner.



Very Important: This is the core of TPM during runtime and monitoring . Please make sure you define the correct values in identities. You cannot define same values for a given combination of Agency Code and identifier for multiple partners.

Determine unique ID that has been assigned to the partner


Define the agency qualifier code

Define the agency scheme that is implemented

18

Messages tab 

This provides a consolidated view on messages that are getting exchanged between the trading partners



In the message format column press F4 and select the required EDI message format and select relevant message type.



You can add the following EDI formats currently (EDIFACT, EANCOM, X12, TRADACOMS, Odette). The values in the drop down will appear only if you imported the correct required content via EDI Content Manager.



You can also select XML messages and manually type the Message Type and Version value. You can use this feature to defined agreements based on XML and use the functional profile for different conditions for XML related scenarios.



This information is not used during runtime however it is a mandatory step before defining an agreement.


19

EDI acknowledgement tab 

This functionality enables the processing of EDI acknowledgements, such as EDIFACT, EANCOM and ANSI X12, for inbound and outbound EDI communications. Select and save the settings as per the requirement that can be used during runtime.



For Inbound, settings are same as provided by EDI Separator receiver channel. You can configure it now based on individual partners. For Outbound, values will be used by Generic Converter module during time to set the corresponding fields in a EDI message.

How to access information during runtime? 

You have to use T PM C ontentAcc es s M odu l e as first module on the sender channel during runtime in your Integrated Configuration scenario. This module automatically read the EDI message information for sender and receiver identifiers, find the corresponding TPM Partners and fill the correct dynamic headers for acknowledgment processing as defined in TPM



Enable the check box R ead f ro m d y na mi c heade rs in EDI Seperator receiver channel. If no values are there in dynamic headers, EDI Seperator receiver channel will use the current default configuration from the channel.


20

Functional profile tab 

In this tab page you can add functional profiles that are specific to a trading partner.



In the functional profile column press F4 and select the relevant functional profile and save the changes.



For more information about functional profiles, refer to the Functional profile slide.





By clicking the link you can only view the functional profile. As functional profiles are reusable and can be used across multiple partners, you cannot change it from the partner screen. This information is not used during run time but is an essential step if you want to define agreements.


21

Agreements tab 

You use this functionality to store partner agreements. You choose Cr eate to create agreement and then save the changes.



For more information about agreements, refer the Trading partner agreement slide.


22

Certificates tab 

You can define the automatic certificate Rollovers for NWA certificates in P ro f il e s > C er t i fi ca te section.



Currently, you can only view the certificate profiles related to a specific trading partner in the Certificate te section. Tab of Partner Profile. You can also add, edit and store certificates in P ro f il e s > C er t if i ca



By default, the expiry time of certificate is selected as Rollover time. You can customize this time according to your need.



You cannot add/ store a new certificate form this screen. You can only access the certificate that have already been uploaded in NWA.



After RollOver, new certificate replace the old active certificate. You can also define the backup view to archive the replaced certificate. Certificate Name


Time when the validity of the certificate expires

Time when the certificate is extended

23

Trading partner agreements

You access partner agreements in TPM system by choosing Ag re e me nt s tab page.

Trading partner agreements What is an agreement? 

Agreement is conditional rule that can be defined in TPM. Based on the condition, 3 components can be selected during runtime 1)

Control Key to be used for this message/partner conversion [by generic Converter Module] (refer EDI Content Manager documentation)

2)

EDI parameters (converter module parameters based on EDI message type) [by GenericConverterModule].

3)

Functional Profile (custom key-value parameters) [through UDFs in Message Mapping] .

Agreements can be accessed in TPM via two different options. One via a separate “Agreements” tab and other way is to access from the partner profile screen under Ag re e me nt tab. There is NO functional difference. Only those agreements will appear under partner profile’s Ag re e me nt tab that are related to that partner. You can go to separate Ag re e m ent tab in case you want to search, maintain agreements in bulk irrespective of partners.


25

Trading partner agreements

What all parameters are included in condition? o

Sender Partner Name (Mandatory) Sender Partner Unique Identifier (Optional)

o

Receiver Partner Name (Mandatory) Receiver Partner Unique Identifier (Optional)

o

Direction (Inbound/Outbound )

o

Message Type related Parameters (examples:. UN EDIFACT ORDERS 96A or .* EDIFACT .* )


26

Condition/ Rules Parameter

Response Returned if a condition Matches

Used by Generic converter Module Used during Message Mapping

1 2

3 Note: Functional Profiles can be selected only if you have already attached to the partner profile. If agreement is Inbound, it displays the values from Sender Partner. If it is outbound, it displays the values from Receiver Partner


27

Trading partner agreements 

Is agreement definition mandatory in a Partner Profile? What are the benefits? o



o

o

o



o

No, it is optional. See use cases below

What are typical use cases when I would like to use this agreement? You have a VAN scenario where you are sending/ receiving data for multiple partners via single communication channel but you would like to use different EDI runtime parameters for each partner (eg. encoding, indent etc.) You would like to maintain all EDI related runtime parameters for a partner centrally even if they are common so that you don’t have to change it in converter modules during everytime there is a change request. You can access trading partner management and change the parameters directly in TPM configurations without redeploying the scenarios in runtime. You would like to maintain/access custom parameters (functional profiles) based on certain agreement conditions.

Is it mandatory to define both EDI parameters and Functional Profile both in an agreement? No, you can defined either of them or both based on your usecase. You can remove the value from EDI parameter fields and leave them blank.


28

Trading partner agreements What is the relevance of Control Key in agreements? 

Control Key is a versioning mechanism available in EDI Content Manager through which runtime get to know the ruleset version to be used for XML-EDI or EDI-XML version. SAP ships all the rules for different EDI versions in default Control Key known as “SAP” or “SAP-EANCOM”. Users can customize the standard ruleset definitions by creating their own Control Key (versions)



Current way of defining relation between runtime and Control Key is through Control Key Association table and you can define the specific Control Key to be used by PI runtime scenarios. EDI converter Module during runtime checks “Control Key association table” to find the right Control key to use for that PI scenario.



New way of defining is via TPM based on the Agreements. If it is set, then converter module (if enabled for TPM) takes the value as per agreement definition and does not access Control Key scenario association table.


29

Trading partner agreements What are the special considerations to define EDI parameters in the agreement. How it is accessed during runtime? o

You have to add TPMContentAccessModule in your configuration scenarios before the Generic converter module. You need to add it either on the sender or receiver side depending on your Inbound/Outbound EDI processing scenarios

o

Value for Generic converter module parameter “tpm.enable” should be true

o

You can define zero or more parameters depending on your usecase.

o

Whenever you create a new agreement, default EDI values are displayed on the agreement screen. If the values are blank,, converter module will replace it will the value defined in module context in integration directory or will use the default values during runtime


30

Trading partner agreements  o

o

o

What are the options possible while defining an agreement? While defining, agreement has two parts. One (Marked as A) is mandatory and other (Marked as B on next slide) is optional Both can be defined together. During PI runtime (for converter module parameters), only A will be used During Functional profile Access from Message Mapping, you can access parameters based on either A or B

A


31

Trading partner agreements Separate UDFs are available for accessing both the agreement conditions. 

What is the usecase of Optional Agreement Option B?

In case you would like to access agreement (and hence) Functional Profile on basis of standard PI Parameters in the agreement condition

B


32

Trading partner agreements 

o

o

What are mandatory and optional partner parameters while defining partners in an agreement? Partner Name is mandatory while identifiers are optional. During Runtime, PI finds the partner name on the basis of incoming/outgoing EDI message from the “senderid+ qualifier” and “receiver id+qualifier” fields and finds the matching partner names. Then it looks for the matching agreement condition between two partners along with other condition parameters.

For example, If you have different sender / receivers id's for Test and Production, there are two options: – Create two separate agreement rows based on these different sender and/or receiver ids for Test and Production (or define in Test and change in production). OR – Create a single agreement row and leave the identifier field blank so that same agreement/ condition can be used in both Test and Production


33

Trading partner agreements  o

o

o

o

o

What is the best way of defining message type in an agreement condition? Depending on your usecase, TPM agreement condition is completely flexible. You can define the agreement with exact matching values of an incoming/outgoing EDI payload or you can make it flexible by defining fields as *. If you are defining strictly, then make sure the incoming/outgoing EDI document exactly matches with the EDI message definition in agreement otherwise runtime will not be able to access the correct agreement.

Important :If you have a bulk interchange of different message types together, make sure you define “.* ” in Message Type and Message Version field. Agreement condition can be defined on an interchange level (and not on individual message level) If you have a bulk Interchange with same message types in it, you can define the agreement with exact message release version or “ .* ”. Both ways are accepted.

Tip: If you want to use same EDI Parameters and Functional Profile parameters for the same Partner, direction and EDI Format, it is recommended to use “.* ” in Message release and version field.


34

Trading partner agreements Example usecases where you may need to defined more than one agreement for the same partner and direction but for different message types: 1)

Either you are exchanging different EDI formats with the partner (eg. EDIFACT and X12) and for each you have to maintain a different converter module and/or functional profile parameter values.

2)

You are exchanging a bulk interchange with the partner having different messages and for all messages except invoices ,you want to apply encoding A. However for Invoices you would like to use encoding B. You can define two agreements for the same sender partner ,receiver partner and direction combination. One with .* in message type and version and other one with Invoice specifically mentioned in Message Type and/or Release

Important: If you are defining more than one agreement, make sure your definition is aligned with the runtime behavior. o

o

PI runtime gives priority to exact matching agreement. So, in above case, if you define an agreement with Invoice and the interchange contain only one or more invoices, then the invoice will be used. If you have invoices as part of bulk interchange with different message types, then it is important that you define agreement with .* and in this case specialization to invoice cannot be maintained. Runtime access the agreement in the following priority (for the same partners and direction) wherever applicable Message Format -> Message Agency -> Message release -> Message Type -> Message Subversion/Association Code -> Message Version


35

TPM runtime access

TPM runtime access 

o

During runtime, information defined in the TPM can be accessed in the following manner: You need to add TPMContentAccessModule in your Integration scenarios wherever you have EDI document processing. e na ut i ona r y s tep, befo r e u si n m us t u se b te r a s a p re ca g T P M c ontent a cc e ss le.e d ise pU sa g e pa r a me m odu l e pa r a me te r. Im po rt an t: You

o

o

o

o

Set enab l e.ed iA ck Pr o f il e to true. This parameter when it is set to true is required for applying the TPM settings to EDI Separator Receiver channel. The module reads parameters from TPM related to EDI acknowledgment settings and publishes them to PI processing pipe-line. This parameter needs to be set for the T PM C ontentAcc e ss M odu le only in the ICO(s) where EDI Separator receiver channel is used. Depending on the Inbound/Outbound EDI processing, you need to add this module either on sender or receiver side respectively This module should be added before generic converter module. Set the value of module parameter o rt e rM odu l e to “true”. It will then fetch the a) Control Key info and b) module tp m. enab l e of gene ri cC n ve parameters info as per TPM agreement. Enable the checkbox “Read From Dynamic header” in EDI Seperator receiver channel to apply the TPM settings.

Im po rt an t : In

Pa r am case if you are using E DI Sea r ch ete r s Mo du l e, then it should be used in order such that it is before o r te rM odu l e and used after T PM Pa r am odu le gene ri cC n ve C ontentAcc e ss Mo du l e. It is recommended to use E DI Sea r ch e te r sM as it enables monitoring based on sender ID, receiver ID, interchange number, and correlation number.


37

TPM runtime access - monitoring

TPMContentAccessModule when added does the following: 1)

Enable monitoring related parameters in XI message headers so that you can create UDS in local message monitoring and enable search. (See Next Slide)

2)

Enable acknowledgement related settings from TPM so that EDI Separator can apply the settings.

3)

Enable module related EDI parameters as defined in TPM agreement


38

TPM runtime access - monitoring 





You can create the UDS and enable search on the following parameters from TPM. Sender Partner and Receiver Partner Information is set based on the sender and receiver ids from the Inbound/Outbound EDI message Partner Name information is set based on the following:

1)

For Inbound EDI messages, sender id is considered

2)

For Outbound messages, receiver id is considered.

o

Pa r tne rN am e

o

Sende rP a rt ne rN am e

o

rP R ec ei ve a rt ne rN am e

o

Pa r tne rT y pe

o

e Sende rP a rt ne rT yp

o

rP R ec ei ve a rt ne rT y pe

o

Pa r tne r Indu st r y

o

Sende rP a rt ne rI ndu st r y

o

ei ve rP R ec a rt ne rI ndu st ry

o

Pa r tne rR eg i on

o

Sende rP a rt ne rR eg i on

o

rP R ec ei ve a rt ne rR eg i on

o

Pa r tne r Pa r entG ro up

o

Sende rP a rt ne rP a re ntG ro up

o

rP R ec ei ve a rt ne rP a r entG ro up

o

Pa r tne r PIPa rt y

o

Sende rP a rt ne rP IPa r ty

o

rP R ec ei ve a rt ne rP IPa rt y

NOTE: While creating an UDS, you have to use the following Dynamic header namespace http:// s ap.c om / x /XI/E i D ISepa ra to r /E DI Sepa ra to r © 2014 SAP AG or an SAP affiliate company. A ll rights reserved.

39

TPM administration settings

You access administration settings in TPM system by choosing Ad mi ni st ra t i on tab

Administration










You can enable the change log You can export/ import the TPM configuration settings in the form of a file.

Important: Before Importing the TPM content on a different system landscape, make sure corresponding directory content is already transported. Important: According to current behavior, when you import a TPM configuration file into other system (eg. trasferring from Dev to QA or QA to Production) in the landscape, all existing data/ information is replaced by the content included in the current import file i.e. it completely overwrites the existing data.

41

Appendix

Assigning user roles for managing the TPM tool

For more information about TPM roles, refer assigning user roles for managing B2B application in B2B Security Guide.


43

TPM User Defined Functions (UDF) TPM UDF’s

Description

Arguments

getParty

Returns the Integration directory Party name for given values

agency - Agency Qualifier Code scheme - Agency Scheme partyIdentifier - Identifier Name

Returns the Identifier value for a given Party , agency qualifier code and agency scheme

partyName- Party Name agency – Agency Name scheme – Agency Scheme

getPartyID

getAgreementID Returns the TPM agreement ID for given PI parameters. The values should match exactly as defined in agreement

getAgreementID

Choose this UDF if you need to retrieve parameters such as senderID, receiverID, and so on.


senderParty – Sender Partner Identifier senderQual – Sender Partner Agency qualifier code receiverParty – Receiver Partner Identifier receiverQual – Receiver Partner Agency qualifier code senderService – Sender Business Component receiverService – Receiver Business Component interf – Interface namespace – Interface Namespace senderID – Sender Partner Identifier senderIDQual – Sender Partner Agency Qualifier Code receiverID – Receiver Partner Identifier receiverIDQual – Receiver Partner Agency Qualifier Code msg_protc – Message Format msg_type – Message type msg_ ver – Message version msg_ rel – Message release msg_agency – Message agency msg_ subver – Message subversion direction- Message direction 44

TPM User Defined Functions (UDF) TPM UDF’s

Description

Arguments

getAgreementID

Returns the TPM agreement ID for given Partner The values Parameters. should match exactly as defined in agreement

senderProfileID – Sender Partner name receiverProfileID – Receiver Partner Name msg_protc – Message format msg_type – Message type msg_ ver – Message version msg_ subver – Message subversion msg_ rel – message release msg_agency – Message Agency direction – Message direction

getFunctionalProfileName

Returns Functional Profile name for the given agreement ID as defined in TPM. To be used with getAgreementID function

agreementID – Agreement ID

getFunctionalProfileProperty

Returns value of a functional Profile’s key

profileName – Functional Profile name keyName – key name as defined in functional profile

getSystemEnvironment

Returns the current activated system environment test or production from TPM.

getIdentity

Returns the required identity for the given partner ID and Qualifier code


given

sourceID – Partner Identifier sourceQual – Source partner qualifier agency code targetQual – Target partner qualifier agency code

45

Example- Accessing TPM information using UDF 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11.

senderID – Sender Partner Identifier senderIDQual – Sender Partner Agency Qualifier Code receiverID – Receiver Partner Identifier receiverIDQual – Receiver Partner Agency Qualifier Code msg_protc – Message Format msg_type – Message type msg_ ver – Message version msg_ rel – Message release msg_agency – Message agency msg_ subver – Message subversion direction- Message direction


getAgreementID

46

Thank you


B2B Trading Partner Management SAP PI

Recommend Documents