The RosettaNet Implementation Framework (RNIF) is the protocol for packaging, routing, and transferring RosettaNet XML documents. Each interaction between two companies is defined by a Partner Interface Process (PIP) specification. A PIP is essentially the definition of an XML document to be exchanged with a partner and the rules of how the document is exchanged.

Defining the RNIF Endpoint

This table describes the fields you used to define the RNIF Endpoint.

Interfacing with RNIF

Since each PIP is, in essence, a different document channel, a PIP code must be identified with each document to be sent and/or received. If you use only one PIP and it is a single-action PIP, then the PIP can be automatically identified; otherwise, a PIP code must be associated with a document either via the PUT command or by using the CIC proprietary RosettaNet document wrapper as outlined below.

Outgoing Documents

Example wrapper for an outgoing request (single-action or two-action PIP):

<w:pip xmlns:w="http://www.cleo.com/protocols/RosettaNet/wrapper/1.0" pipCode="3A1" pipVersion="*">  
<w:serviceContent>
    ...    
PIP XML service content request document goes here
    ...  
</w:serviceContent>
</w:pip> 

Example wrapper for an outgoing response (two-action PIPs only): 

<w:pip xmlns:w="http://www.cleo.com/protocols/RosettaNet/wrapper/1.0" pipCode="3A1" pipVersion="*" 
              pipInstanceId="1234567" actionType="response">  
<w:serviceContent>
    ...
    PIP XML service content response document goes here
    ...
  </w:serviceContent>
</w:pip>

For an outbound message, the following attributes are used in root <pip> element:

The service content can be specified three ways: as an XML fragment, text as part of a CDATA section, or as Base64 encoded data.

Content as XML Fragment

...
<w:serviceContent> 
<Pip3A1QuoteRequest>
... 
</Pip3A1QuoteRequest> 
</w:serviceContent> 
...

Content as CDATA Section

...
<w:serviceContent>
  <![CDATA[
  <!DOCTYPE Pip3A1QuoteRequest SYSTEM "3A1_MS_V02_00_QuoteRequest.dtd">
  <Pip3A1QuoteRequest>
    ...
  </Pip3A1QuoteRequest>
  ]]>
</w:serviceContent>
... 

Content as Base64 Encoded Data

...
<w:serviceContent encoding="base64">
  [base64 content goes here]
</w:serviceContent>
... 

Incoming Documents

Incoming messages can be written in several formats. The raw content can be written as a stand-alone file or the content can be wrapped in XML as described in the previous section.

To control the format of the incoming message, use the Incoming Content Format menu on the Inbound tab and select Two-action only. If Two-action only is selected, then all one-action PIPs will be written in the Original format and the two-action PIPs will follow the Incoming Content Format selection. If Two-action only is not selected, then both one-action and two-action PIPs follow the Incoming Content Format selection. If Original is selected in the Incoming Content Format pull-down menu, then the content is written in separate stand-alone files. If the pull-down selection is Wrapped XML, then the content is wrapped as specified in the previous section, with the content written as an inline XML fragment. If the selection is Wrapped CDATA, the content is saved as text within a CDATA section within the wrapper. If the selection is Wrapped BASE64, then the content is encoded as Base64 data.

For a wrapped incoming message, the following attributes are added to the root <pip> element for your convenience:

Working with PIPs

You can add new PIPs, edit existing PIPs, and delete PIPs directly from within CIC Cockpit.  In addition, you can add new PIPs from scratch or from one of several templates provided with CIC.

Adding a new PIP

When you add a completely new PIP, CIC displays a blank form where you can enter information about the PIP.  See PIP Editor for information about the various fields you can enter data in when creating a PIP.

When you save your work, CIC adds the PIP to the PIP List.

Adding a PIP from a template

To add a PIP based on a template, select the template from the drop down list. CIC creates a PIP accordingly and adds it to the PIP List.

Deleting a PIP

In the PIP list, select the check box for the PIP you want to delete and click the Delete button.

Editing a PIP

Click the name of a PIP in the list to open it in the PIP Editor.  See The PIP Editor.

Make updates as needed and click OK to save your work.  

The PIP Editor

The PIP Editor is displayed when you click the PIP entry in the PIP list. Any field can be updated for pre-defined or user-defined PIPs. PIP specifications can be obtained from RosettaNet at http://www.rosettanet.org/Standards/RosettaNetStandards/PIPDirectory/tabid/476/Default.aspx . The values for the fields in these tabs can be obtained from these specifications. 

General Tab

Use the General tab to specify general naming information for the PIP. 

Content Tab

Use the Content tab to specify information related to sending and receiving general message parts.

Request Tab

Use the Request tab to define the rules for an incoming or outgoing message request.

Request Ack Tab

Use the Request Ack tab to define the rules for a request acknowledgment.

Response Tab

The Response tab defines the rules for a response message. This tab is enabled when the Has Response check box is selected on the Request tab.

Response Ack Tab

Use the Response Ack tab to define the rules for response acknowledgment. This tab is enabled when the Has Response check box is selected on the Request tab.

RNIF Endpoint commands

PUT

Send one or more files to the host.

PUT -DEL "source" "destination" [pipCode]= .. [pipVersion]= ..  [pipInstanceId]= .. [actionType]=request|response 

SET

Change a property value. The new value only affects the commands that follow the SET.

SET property=value

Valid properties for the SET command are as follows:

WAIT

Pause execution.

WAIT seconds