Install PIPs into Sterling B2B Integrator

Edit online

About this task

The following steps describe how to install PIPs into Sterling B2B Integrator:

Procedure

  1. You can download the information about any PIPs you need to install from the RosettaNet Standards website. The document that you download contains information about the values for the PIP description, PIP roles, and other information required to add the PIP. From the document you can also determine whether the PIP is a One-Action PIP or Two-Action PIP. A One-Action PIP consists of a document sent by the PIP Initiator, to which the PIP Responder replies with a Receipt Acknowledgment. A Two-Action PIP is more complex, consisting of two or more actions.
  2. The <install_dir>/data/RosettaNet directory contains the oneactionpipdeftemplate.xml and twoactionpipdeftemplate.xml files. Choose the file that is appropriate for the PIP you are adding and copy the file to a new name. For example, the 3A4 PIP is a two-action PIP, so for this PIP you should use the two-action PIP def template.
  3. Use the file downloaded from the RosettaNet site as a guide when filling in values for the various fields. An example for the One-Action PIP 2A10 is the following:
    Note: The TODO comments may be misleading, because they do not appear in the correct places. The TO_ROLE, for example, is the PIP Responder's role, not the PIP Initiator's Role as the TODO comment implies.
    
<?xml version="1.0" encoding="utf-8"?>
<RosettaNetPIPDefinitions>
<PIP_DEF>
<!-- TODO: Insert PIP code here -->
<PIP_CODE>2A10</PIP_CODE>
<!-- TODO: Insert PIP initiator's role here -->
<TO_ROLE>Design Engineering Information Receiver</TO_ROLE>
<!-- TODO: Insert PIP responder's role here -->
<FROM_ROLE>Design Engineering Information Sender</FROM_ROLE>
<!-- TODO: Insert PIP initiator's service here -->
<TO_SERVICE>Process Design Engineering Information Service</TO_SERVICE>
<!-- TODO: Insert PIP responder's service here -->
<FROM_SERVICE>Design Engineering Message Information Service</FROM_SERVICE>
<!-- TODO: Insert PIP version here -->
<PIP_VERSION>V01.00</PIP_VERSION>
<RNIF_VERSION>All</RNIF_VERSION>
<!-- TODO: Insert PIP description here -->
<PIP_DESCRIPTION>Distribute Design Engineering Information</PIP_DESCRIPTION>
<STATUS>3</STATUS>
<TYPE>1</TYPE>
<RESPONSE_MODE>1</RESPONSE_MODE>
<SENDER_WFD_NAME>PIP2A10_V01.00_Design-Eng-Info-Sender_Private</SENDER_WFD_NAME>
<RESPONDER_WFD_NAME>PIP2A10_V01.00_Design-Eng-Info_Receiver_Private</RESPONDER_WFD_NAME>
<NONREPUD_REQ>1</NONREPUD_REQ>
<TIME_TO_ACK>120</TIME_TO_ACK>
<TIME_TO_ACK_ACCEPT>-1</TIME_TO_ACK_ACCEPT>
<TIME_TO_PERFORM>1440</TIME_TO_PERFORM>
<RETRY_COUNT>3</RETRY_COUNT>
<AUTH_REQ>1</AUTH_REQ>
<NONREPUD_OF_ORIGIN>1</NONREPUD_OF_ORIGIN>
<PIP_STEP>
<STEP_ID>1</STEP_ID>
<!-- TODO: Insert PIP step #1 name here -->
<PIP_BUS_ACTION>Distribute Design Engineering Information Action</PIP_BUS_ACTION>
<TIME_TO_ACK_RCPT>120</TIME_TO_ACK_RCPT>
<TIME_TO_ACK_ACPT>-1</TIME_TO_ACK_ACPT>
<TIME_TO_RESPOND>1440</TIME_TO_RESPOND>
<IN_TIME_TO_PERFORM>1</IN_TIME_TO_PERFORM>
<AUTH_REQ>1</AUTH_REQ>
<NONREPUD_REQ>1</NONREPUD_REQ>
<SECURE_TRANSP_REQ>1</SECURE_TRANSP_REQ>
<DSIG_REQ>1</DSIG_REQ>
<SSL_REQ>1</SSL_REQ>
</PIP_STEP>
<PIP_STEP>
<STEP_ID>2</STEP_ID>
<PIP_BUS_ACTION>Receipt Acknowledge</PIP_BUS_ACTION>
<TIME_TO_ACK_RCPT>-1</TIME_TO_ACK_RCPT>
<TIME_TO_ACK_ACPT>-1</TIME_TO_ACK_ACPT>
<TIME_TO_RESPOND>1440</TIME_TO_RESPOND>
<IN_TIME_TO_PERFORM>0</IN_TIME_TO_PERFORM>
<AUTH_REQ>1</AUTH_REQ>
<NONREPUD_REQ>1</NONREPUD_REQ>
<SECURE_TRANSP_REQ>1</SECURE_TRANSP_REQ>
<DSIG_REQ>1</DSIG_REQ>
<SSL_REQ>1</SSL_REQ>
</PIP_STEP>
</PIP_DEF>
</RosettaNetPIPDefinitions>
  4. Once the template has been correctly filled out, save the file as 2A10template.xml and close the file. You can add the new PIP into Sterling B2B Integrator by invoking pipdefloader.sh (or pipdefloader.cmd if you are using the Windows operating system) in the following way: pipdefloader.sh 2A10template.xml nodelete (the nodelete option prevents existing PIP definitions from being overwritten).
  5. The compressed file downloaded from the RosettaNet site may contain DTD files or schema files. Load the DTD(s) or Schema(s) into Sterling B2B Integrator by choosing Deployment > Schemas from the Sterling B2B Integrator menu and follow the prompts displayed.
  6. Just as there are oneactionpipdeftemplate.xml and twoactionpipdeftemplate.xml files, there are also business process template files provided for you in the <install_dir>/data/rosettanet/templates. These are the five files:
    • Launch_PIP_Private_Template.bpml
    • OneActionPIP_Initiator_Private_Template.bpml
    • OneActionPIP_Responder_Private_Template.bpml
    • TwoActionPIP_Initiator_Private_Template.bpml
    • TwoActionPIP_Responder_Private_Template.bpml

    The launch template is used for testing the PIP. Its functionality is to place the input file into ProcessData as the Primary Document. Choose the template business processes appropriate to the PIP to be used (that is, use the one-action PIP templates for one-action PIPs, and choose the two-action PIP templates if implementing a two-action PIP). Follow the TODO instructions in each business process template file for instructions on how to customize the business process so that it is specific to that particular trading partner and PIP type.

  7. It will also be necessary to set up records for Identity, Transport, Document Exchange, Delivery Channel, Packaging, Profile, and Contract information for each partner in the business relationship.
    Note: Because the RosettaNet user interface does not have a wizard, you need to set these records up manually. In the Sterling B2B Integrator Trading Partner interface, use Trading Partner > Setup > Advanced to configure the above information.