PIP Connector

Version 21.0.7884


PIP Connector


The PIP Connector supports generating PIP service headers for outbound messages and processing service headers on inbound PIP messages.

Overview

When receiving a PIP message over RNIF, a PIP connector validates the PIP service headers against the settings configured for the connector. These settings include the PIP Code, PIP Version, etc. After validation, the PIP message payload is processed into the Receive folder for this connector, and passed along to the next connector connected in the flow.

When generating PIP messages, a PIP connector adds service headers from the settings configured for the connector. Once these service headers are applied, the resulting file in the Receive folder can be passed along to an RNIF connector for transport to the trading partner.

A PIP connector can also automatically generate acknowledgments for PIP messages. For more information, please see the Acknowledgments section.

Connector Configuration

This section contains all of the configurable connector properties.

Settings Tab

Connector Configuration

Settings related to the core operation of the connector.

  • Connector Id The static name of the connector. All connector-specific files are held in a folder by the same name within the Data Directory.
  • Connector Description An optional field to provide free-form description of the connector and its role in the flow.
  • Direction Whether the connector is handling PIP messages that were received or PIP messages that need to be sent.

PIP Settings

Settings related to the service headers of PIP messages. When sending PIP messages, these settings are applied as services headers in the resulting message. When receiving PIP messages, these settings are used to validate the incoming document.

  • PIP Code Identifies the standard business process associated with this message.
  • PIP Version Identifies the version of the PIP standard.
  • Business Activity Identifier Identifies a specific business activity. This code is found in table 3.2 of a PIP specification document.
  • Global Business Action Code Identifies a specific business action. This code is found in table 4.2 of a PIP specification document.
  • From Role The role initiating a business document exchange.
  • From Service The service from which a message is being sent.
  • To Role The role receiving the document in a business document exchange.
  • To Service The service to which a message is being sent.

Acknowledgments

Settings related to generating and requesting acknowledgments.

  • Acknowledgment Expected Whether an acknowledgment should be returned (when receiving) and requested (when sending).

Automation

Settings related to the automatic processing of files by the connector.

  • Send Whether messages arriving at the connector will automatically be processed.

Advanced Tab

Local Folders

Settings that determine the folder on disk that files will be processed from, and where they will be placed after processing.

  • Input Folder (Send) The connector can process files placed in this folder. If Send Automation is enabled, the connector will automatically poll this location for files to process.
  • Output Folder (Receive) After the connector finishes processing a file, the result will be placed in this folder. If the connector is connected to another connector in the flow, files will not remain here and will instead be passed along to the Input/Send folder for the connected connector.
  • Processed Folder (Sent) After processing a file, the connector will place a copy of the processed file in this folder if Save to Sent Folder is enabled. This copy of the file will not be passed along to the next connector in the flow.

Performance

Settings related to the allocation of resources to the connector.

  • Max Workers The maximum number of worker threads that will be consumed from the threadpool to process files on this connector. If set, overrides the default setting from the Profile tab.
  • Max Files The maximum number of files that will be processed by the connector each time worker threads are assigned to the connector. If set, overrides the default setting from the Profile tab.

Other Settings

Settings not included in the previous categories.

  • Send Filter A pattern filter to determine which files in the Send folder will be processed by the connector (e.g. *.edi). Negative patterns may be used to indicate files that should not be processed by the connector (e.g. -*.tmp). Multiple patterns may be separated by commas, with later filters taking priority except when an exact match is found.
  • Log Level The verbosity of logs generated by the connector. When requesting support, it is recommended to set this value to Debug.
  • Strict Schema Validation Whether the connector should validate the PIP against the DTD file and perform additional schema validation checks.
  • Log Subfolder Scheme By default, logs for transactions processed by the connector will be stored in the Logs subfolder for the connector. For connectors that process many transactions, it may be desirable to further divide the logs based on the datetime they were generated. When this setting is set to Daily, logs generated on the same day will be grouped in a subfolder;; when this setting is set to Weekly, logs generated in the same week will be grouped in a subfolder; and so on.

  • Log Messages Whether the log entry for a processed file will include a copy of the file itself.
  • Save to Sent Folder Whether files processed by the connector should be copied to the Sent folder for the connector.

Acknowledgments

Acknowledgments can be automatically generated and processed by the application.

Acknowledgments when Sending

You can send outbound PIPs directly to the RNIF connector, but note that you should disable the Require Acknowledgment setting in the RNIF connector that is working with the PIP connector.

When routing inbound messages, route inbound signal messages to the Outbound PIP that generated the document and new messages to the Inbound PIP that processes the request. To do this with the After Receive Event, configure the Send To Connector snippet, as shown in the following example:

<arc:select attr="PIPCode">
  <arc:case value="0C1">
    <arc:send connector="PIP-0C1-Receiver"/>
  </arc:case>
  <arc:case value="0C2">
    <arc:check value="[SignalMessage]">
      <arc:send connector="PIP-0C2-Response-Sender"/>
      <arc:else>
        <arc:send connector="PIP-0C2-Request-Receiver"/>
      </arc:else>
    </arc:check>
  </arc:case>
</arc:select>

Acknowledgments when Receiving

When using a PIP connector for processing incoming PIP messages, disable the Send Acknowledgment Automatically setting in the RNIF connector that is receiving the message. You can then check the Acknowledgment expected setting so that the connector automatically generates the acknowledgment and routes the message back to the RNIF connector you specify in the setting.