B2B Trading Partner Management SAP PI

Agenda TPM templates Functional profiles Trading partner profiles Trading partner agreements TPM administration settings TPM runtime access TPM UDFs © 2014 SAP AG or an SAP affiliate company. All rights reserved. 2 How to access TPM ? You follow the procedure below to access B2B TPM application: 1. You need to 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 Security Guide. 2. Enter the URL format as http:<localhost:port>/b2bic in the Web browser and logon to B2B Integration Cockpit application. 3. To access Trading Partner Management tool, choose Trading Partner Management. 4. Important: – Before referring this guide, make sure you are on the following SP and patch level of B2B components: B2B Add-On SP2 o B2B ToolKit SP2 Patch 12 o XI CONTENT B2B TOOLKIT 1.0 Patch 3 o XI CONTENT B2B MAPPING KIT 1.0 Patch 2 Note: It is important to install latest patch for PIB2BTOOLKIT on SP02 level to benefit from this TPM feature. © 2014 SAP AG or an SAP affiliate company. All rights reserved. 3 Trading partner Management TPM User © 2014 SAP AG or an SAP affiliate company. All rights reserved. 4 TPM templates You access and create TPM template in TPM system by choosing Trading Partner Management > Profiles > Templates . 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 © 2014 SAP AG or an SAP affiliate company. It is created for specific business requirements. 6 . 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 What is a TPM template? o TPM template consists of unique set of values that are defined by the user. All rights reserved. What kind of templates can be created? o Templates are custom build forms that stores generic data which can be reusable. All rights reserved.TPM template What are Key-pair values? o A set of property keys and associated values that are defined in a template are known as Key-value Pairs. and . status Indicator fields etc. Few examples are Material Code Mapping. EDI separators for partners. Based of your business requirement you can create different templates. a template can consists of the following information: © 2014 SAP AG or an SAP affiliate company. 7 . Important: These keys and values are case sensitive. Functional profiles You access and create TPM template in TPM system by choosing Trading Partner Management > Profiles > Functional Profiles . Functional profile What is a functional profile? o Functional profile is a collection of TPM templates that uses custom key value for that can be accessed during message mapping o The default key-value pairs defined in a template are applied to test and production values. You can configure the system environment in Administration >Configuration © 2014 SAP AG or an SAP affiliate company. During message mapping runtime. either the test or production value is returned based on the selected system environment under “Administration”. All rights reserved. You cannot add a new key-value pair to an existing profile but you can edit any existing values in a profile. 9 . 10 . Choose this button To add a template to apply templates to a profile. choose to the profile Define a name Add for the functional profile Parameters from the applied templates are displayed here © 2014 SAP AG or an SAP affiliate company. All rights reserved. Functional profile What is the purpose of a functional profile? o You use functional profiles to group different templates. For more information about UDF’s. o Functional profile can be independent or can be attached to a trading partner agreement. All rights reserved. 11 . the functional profiles values can be used for messages mapping o You can access functional profile during runtime either by calling an agreement or by directly calling a Functional profile Name using predefined UDF’s . Functional profiles themselves can be reused across different partners. refer the TPM User Defined Functions © 2014 SAP AG or an SAP affiliate company. During runtime based on the conditions in an agreement. Functional profile The figure below describes a runtime message mapping scenario. © 2014 SAP AG or an SAP affiliate company. you can build a functional profile for processing transaction requirements such as material codes. wherein an Idoc XML file is mapped to an EDI XML file using a functional profile that is defined as per an agreement. partner specific delimiters and so on. Use Case For example. 12 . All rights reserved. Trading partner profiles You access Partner Profiles in TPM system by choosing Partners tab page. . classification details and so on. 14 . All rights reserved.Trading partner profile What is purpose of trading partner profile? o Trading partner profile provides a central access to the following partner related information and configuration: • Identity and classification parameters such as partner name. intending and so on that are used to configure generic converter module Partner Profile Add/ Edit/ View/ Copy/ Search Identity and EDI Message Certificates EDI Runtime Exceptional Custom Contacts and classification Type and Ack Roll Over Parameters conditions via Parameters Documents requirements agreements reference © 2014 SAP AG or an SAP affiliate company. • 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. partner type. This data also get passed to monitoring so that you can created User Defined Search Attributes and perform a search based on these parameters. All rights reserved. Define the partner details Provide classification of the trade Determine the Party Name (or attach existing Party) from Integration Directory © 2014 SAP AG or an SAP affiliate company. 15 . These details can be using during local message monitoring for searching EDI messages via UDS. You can select Partner Type as self. This is needed during runtime. Below are the important fields and their description that needs to be configured You should also create a Profile for your own organization. while creating Agreements and also an essential part for monitoring.General tab The general tab page consists of information that are partner specific and the classification categories. phone. You can provide multiple contacts and provide a short description about the contact along with the address in two separate fields.Contacts tab This tab page you provide the details of the trading partners such as e-mail. mobile and so on. All rights reserved. Note: This information is NOT used during runtime © 2014 SAP AG or an SAP affiliate company. 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. 17 . the reference to documents provides you a central screen for accessing all partner related data. All rights reserved. Though TPM does not provides you a Document Management system. © 2014 SAP AG or an SAP affiliate company. Determine unique ID Define the that has been agency Define the agency assigned to the qualifier scheme that is partner code implemented © 2014 SAP AG or an SAP affiliate company. ) Predefined UDFs in message mapping provides you the access to these identities (ie. agency qualifier code and target qualifier code to get the right unique identifier value for the partner. CustomerNo and so on. You can also define your own custom identifiers (for example.Identities tab You provide the details such as identifier. 18 . agency code. All rights reserved. SupplierNo. You cannot define same values for a given combination of Agency Code and identifier for multiple partners. Please make sure you define the correct values in identities. you can provide one identifier code. There is a F4 help from which you can choose the standard agencies. Very Important: This is the core of TPM during runtime and monitoring . and agency scheme for identifying business partners. TRADACOMS. © 2014 SAP AG or an SAP affiliate company. EANCOM. X12. 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.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. 19 . You can also select XML messages and manually type the Message Type and Version value. You can add the following EDI formats currently (EDIFACT. Odette). The values in the drop down will appear only if you imported the correct required content via EDI Content Manager. All rights reserved. for inbound and outbound EDI communications. All rights reserved. values will be used by Generic Converter module during time to set the corresponding fields in a EDI message. This module automatically read the EDI message information for sender and receiver identifiers. If no values are there in dynamic headers. How to access information during runtime? You have to use TPMContentAccessModule as first module on the sender channel during runtime in your Integrated Configuration scenario. © 2014 SAP AG or an SAP affiliate company. such as EDIFACT. 20 .EDI acknowledgement tab This functionality enables the processing of EDI acknowledgements. EANCOM and ANSI X12. find the corresponding TPM Partners and fill the correct dynamic headers for acknowledgment processing as defined in TPM Enable the check box Read from dynamic headers in EDI Seperator receiver channel. For Outbound. You can configure it now based on individual partners. For Inbound. EDI Seperator receiver channel will use the current default configuration from the channel. settings are same as provided by EDI Separator receiver channel. Select and save the settings as per the requirement that can be used during runtime. you cannot change it from the partner screen. All rights reserved. By clicking the link you can only view the functional profile.Functional profile tab In this tab page you can add functional profiles that are specific to a trading partner. This information is not used during run time but is an essential step if you want to define agreements. As functional profiles are reusable and can be used across multiple partners. 21 . © 2014 SAP AG or an SAP affiliate company. 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. 22 .Agreements tab You use this functionality to store partner agreements. refer the Trading partner agreement slide. For more information about agreements. © 2014 SAP AG or an SAP affiliate company. All rights reserved. You choose Create to create agreement and then save the changes. All rights reserved.Certificates tab You can define the automatic certificate Rollovers for NWA certificates in Profiles > Certificate section. By default. You can also define the backup view to archive the replaced certificate. the expiry time of certificate is selected as Rollover time. edit and store certificates in Profiles > Certificate section. You can customize this time according to your need. Currently. 23 . Time when Time when Certificate the validity the Name of the certificate is certificate extended expires © 2014 SAP AG or an SAP affiliate company. You cannot add/store a new certificate form this screen. new certificate replace the old active certificate. You can also add. You can only access the certificate that have already been uploaded in NWA. After RollOver. you can only view the certificate profiles related to a specific trading partner in the Certificate Tab of Partner Profile. Trading partner agreements You access partner agreements in TPM system by choosing Agreements tab page. . One via a separate “Agreements” tab and other way is to access from the partner profile screen under Agreement tab. There is NO functional difference. Only those agreements will appear under partner profile’s Agreement tab that are related to that partner. © 2014 SAP AG or an SAP affiliate company.Trading partner agreements What is an agreement? Agreement is conditional rule that can be defined in TPM. Agreements can be accessed in TPM via two different options. 25 . All rights reserved. Based on the condition. maintain agreements in bulk irrespective of partners. You can go to separate Agreement tab in case you want to search. 3) Functional Profile (custom key-value parameters) [through UDFs in Message Mapping] . 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]. All rights reserved.* EDIFACT . UN EDIFACT ORDERS 96A or .* ) © 2014 SAP AG or an SAP affiliate company.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:. 26 . All rights reserved. If it is outbound. 27 . Condition/Rules Response Returned if a Parameter 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. it displays the values from Receiver Partner © 2014 SAP AG or an SAP affiliate company. All rights reserved. o You would like to maintain/access custom parameters (functional profiles) based on certain agreement conditions. Trading partner agreements Is agreement definition mandatory in a Partner Profile? What are the benefits? o No. You can remove the value from EDI parameter fields and leave them blank. indent etc. Is it mandatory to define both EDI parameters and Functional Profile both in an agreement? o No. it is optional. See use cases below What are typical use cases when I would like to use this agreement? o 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. 28 . You can access trading partner management and change the parameters directly in TPM configurations without redeploying the scenarios in runtime. © 2014 SAP AG or an SAP affiliate company. encoding.) o 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 defined either of them or both based on your usecase. New way of defining is via TPM based on the Agreements. 29 . © 2014 SAP AG or an SAP affiliate company. 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. then converter module (if enabled for TPM) takes the value as per agreement definition and does not access Control Key scenario association table. EDI converter Module during runtime checks “Control Key association table” to find the right Control key to use for that PI scenario. SAP ships all the rules for different EDI versions in default Control Key known as “SAP” or “SAP-EANCOM”. All rights reserved. If it is set.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. All rights reserved. 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.Trading partner agreements What are the special considerations to define EDI parameters in the agreement.enable” should be true o You can define zero or more parameters depending on your usecase. o Whenever you create a new agreement.. How it is accessed during runtime? o You have to add TPMContentAccessModule in your configuration scenarios before the Generic converter module. default EDI values are displayed on the agreement If the valuesscreen. are blank. 30 . converter module will replace it will the value defined in module context in integration directory or will use the default values during runtime © 2014 SAP AG or an SAP affiliate company. During PI runtime (for converter module parameters). 31 . only A will be used o During Functional profile Access from Message Mapping. One (Marked as A) is mandatory and other (Marked as B on next slide) is optional o Both can be defined together. agreement has two parts. All rights reserved. you can access parameters based on either A or B A © 2014 SAP AG or an SAP affiliate company.Trading partner agreements What are the options possible while defining an agreement? o While defining. 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 © 2014 SAP AG or an SAP affiliate company. All rights reserved. 32 . 33 . 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). 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. 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 © 2014 SAP AG or an SAP affiliate company. For example. If you have different sender/receivers id's for Test and Production. Then it looks for the matching agreement condition between two partners along with other condition parameters. All rights reserved. o During Runtime. Trading partner agreements What are mandatory and optional partner parameters while defining partners in an agreement? o Partner Name is mandatory while identifiers are optional. o If you are defining strictly. it is recommended to use “. 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. 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 *.* ” in Message release and version field. o Important :If you have a bulk interchange of different message types together. Agreement condition can be defined on an interchange level (and not on individual message level) o If you have a bulk Interchange with same message types in it.* ” in Message Type and Message Version field. Both ways are accepted. Trading partner agreements What is the best way of defining message type in an agreement condition? o Depending on your usecase. © 2014 SAP AG or an SAP affiliate company. 34 . you can define the agreement with exact message release version or “ . direction and EDI Format. TPM agreement condition is completely flexible.* ”. o Tip: If you want to use same EDI Parameters and Functional Profile parameters for the same Partner. make sure you define “. All rights reserved. * 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. So. o PI runtime gives priority to exact matching agreement. then the invoice will be used.you want to apply encoding A. make sure your definition is aligned with the runtime behavior.* and in this case specialization to invoice cannot be maintained. then it is important that you define agreement with . 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 . in above case.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. However for Invoices you would like to use encoding B. if you define an agreement with Invoice and the interchange contain only one or more invoices. 35 . One with . If you have invoices as part of bulk interchange with different message types.receiver partner and direction combination. You can define two agreements for the same sender partner . o 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 © 2014 SAP AG or an SAP affiliate company. All rights reserved. TPM runtime access . It is recommended to use EDISearchParametersModule as it enables monitoring based on sender ID. This parameter needs to be set for the TPMContentAccessModule only in the ICO(s) where EDI Separator receiver channel is used.ediAckProfile to true. This parameter when it is set to true is required for applying the TPM settings to EDI Separator Receiver channel. before using TPM content access module parameter. o Set enable. It will then fetch the a) Control Key info and b) module parameters info as per TPM agreement. Important: In case if you are using EDISearchParametersModule. 37 . o Depending on the Inbound/Outbound EDI processing.enable of genericConverterModule to “true”. and correlation number.TPM runtime access During runtime. The module reads parameters from TPM related to EDI acknowledgment settings and publishes them to PI processing pipe-line. All rights reserved. then it should be used in order such that it is before genericConverterModule and used after TPMContentAccessModule. Important: You must use enable. interchange number. © 2014 SAP AG or an SAP affiliate company. Set the value of module parameter tpm. you need to add this module either on sender or receiver side respectively o This module should be added before generic converter module. receiver ID. information defined in the TPM can be accessed in the following manner: o You need to add TPMContentAccessModule in your Integration scenarios wherever you have EDI document processing. o Enable the checkbox “Read From Dynamic header” in EDI Seperator receiver channel to apply the TPM settings.edisepUsage parameter as a precautionary step. 38 . All rights reserved. (See Next Slide) 2) Enable acknowledgement related settings from TPM so that EDI Separator can apply the settings.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.TPM runtime access . 3) Enable module related EDI parameters as defined in TPM agreement © 2014 SAP AG or an SAP affiliate company. 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. receiver id is considered. TPM runtime access .com/xi/XI/EDISeparator/EDISeparator © 2014 SAP AG or an SAP affiliate company. o PartnerName o SenderPartnerName o ReceiverPartnerName o PartnerType o SenderPartnerType o ReceiverPartnerType o PartnerIndustry o SenderPartnerIndustry o ReceiverPartnerIndustry o PartnerRegion o SenderPartnerRegion o ReceiverPartnerRegion o PartnerParentGroup o SenderPartnerParentGroup o ReceiverPartnerParentGroup o PartnerPIParty o SenderPartnerPIParty o ReceiverPartnerPIParty NOTE: While creating an UDS. 39 . All rights reserved. you have to use the following Dynamic header namespace http://sap. sender id is considered 2) For Outbound messages.monitoring You can create the UDS and enable search on the following parameters from TPM. TPM administration settings You access administration settings in TPM system by choosing Administration tab . trasferring from Dev to QA or QA to Production) in the landscape. © 2014 SAP AG or an SAP affiliate company. 41 . it completely overwrites the existing data.Administration You can enable the change log You can export/import the TPM configuration settings in the form of a file. when you import a TPM configuration file into other system (eg. All rights reserved. make sure corresponding directory content is already transported.e. Important: Before Importing the TPM content on a different system landscape. all existing data/information is replaced by the content included in the current import file i. Important: According to current behavior. Appendix . refer assigning user roles for managing B2B application in B2B Security Guide.Assigning user roles for managing the TPM tool For more information about TPM roles. © 2014 SAP AG or an SAP affiliate company. 43 . All rights reserved. agency agency – Agency Name qualifier code and agency scheme – Agency Scheme scheme getAgreementID senderParty – Sender Partner Identifier Returns the TPM agreement senderQual – Sender Partner Agency qualifier code ID for given PI parameters. 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. and receiverID – Receiver Partner Identifier so on.TPM User Defined Functions (UDF) TPM UDF’s Description Arguments Returns the Integration agency . receiverID.Party Name for a given Party .Agency Qualifier Code getParty directory Party name for scheme . receiverParty – Receiver Partner Identifier The values should match receiverQual – Receiver Partner Agency qualifier code exactly as defined in senderService – Sender Business Component agreement receiverService – Receiver Business Component interf – Interface namespace – Interface Namespace getAgreementID Choose this UDF if you need senderID – Sender Partner Identifier to retrieve parameters such senderIDQual – Sender Partner Agency Qualifier Code as senderID.Agency Scheme given values partyIdentifier .Message direction © 2014 SAP AG or an SAP affiliate company. All rights reserved. 44 .Identifier Name getPartyID Returns the Identifier value partyName. All rights reserved. The values msg_protc –Message format should match exactly as msg_type – Message type defined in agreement msg_ver – Message version msg_subver – Message subversion msg_rel – message release msg_agency – Message Agency direction – Message direction getFunctionalProfileName Returns Functional Profile agreementID – Agreement ID name for the given agreement ID as defined in TPM.TPM User Defined Functions (UDF) TPM UDF’s Description Arguments getAgreementID Returns the TPM agreement senderProfileID – Sender Partner name ID for given Partner receiverProfileID – Receiver Partner Name Parameters. To be used with getAgreementID function getFunctionalProfileProperty Returns value of a given profileName – Functional Profile name functional Profile’s key keyName – key name as defined in functional profile getSystemEnvironment Returns the current activated system environment test or production from TPM. 45 . getIdentity Returns the required identity sourceID – Partner Identifier for the given partner ID and sourceQual – Source partner qualifier agency code Qualifier code targetQual – Target partner qualifier agency code © 2014 SAP AG or an SAP affiliate company. msg_subver – Message subversion 11. msg_type – Message type getAgreementID 7.Example. msg_protc – Message Format 6. All rights reserved.Accessing TPM information using UDF 1. 46 . receiverID – Receiver Partner Identifier 4. msg_rel – Message release 9. senderID – Sender Partner Identifier 2.Message direction © 2014 SAP AG or an SAP affiliate company. receiverIDQual – Receiver Partner Agency Qualifier Code 5. direction. msg_agency – Message agency 10. msg_ver – Message version 8. senderIDQual – Sender Partner Agency Qualifier Code 3. All rights reserved.Thank you © 2014 SAP AG or an SAP affiliate company. . or to develop or release any functionality mentioned therein. SAP AG or its affiliated companies have no obligation to pursue any course of business outlined in this document or any related presentation. All forward-looking statements are subject to various risks and uncertainties that could cause actual results to differ materially from expectations. Readers are cautioned not to place undue reliance on these forward-looking statements. Please see http://global12. and they should not be relied upon in making purchasing decisions. and/or platform directions and functionality are all subject to change and may be changed by SAP AG or its affiliated companies at any time for any reason without notice. Nothing herein should be construed as constituting an additional warranty. This document. and SAP AG or its affiliated companies shall not be liable for errors or omissions with respect to the materials. promise. or functionality.© 2014 SAP AG or an SAP affiliate company. © 2014 SAP AG or an SAP affiliate company. or any related presentation. if any. The only warranties for SAP AG or SAP affiliate company products and services are those that are set forth in the express warranty statements accompanying such products and services. and SAP AG’s or its affiliated companies’ strategy and possible future developments. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG (or an SAP affiliate company) in Germany and other countries. National product specifications may vary. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG or an SAP affiliate company. code. These materials are provided by SAP AG or an SAP affiliate company for informational purposes only. products. without representation or warranty of any kind.com/corporate-en/legal/copyright/index.sap. 48 . All rights reserved. In particular. which speak only as of their dates.epx for additional trademark information and notices. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. or legal obligation to deliver any material. The information in this document is not a commitment.