Refnums

OTM provides the flexibility to associate custom attributes — also called refnums — to every transaction object such as Order Base, Order Release, and Shipment. Developers can use these refnums to store client-specific values like source system information, custom dates, and other custom fields. Note that newer versions of OTM also have attribute (flex field) columns for the same purpose, which are covered in a separate post.

To create a refnum, navigate to the specific business object menu. For a Shipment refnum:

Shipment Management > Power Data > Qualifiers > Shipment Reference Number Qualifiers > New

Enter the following values:

  • Shipment Reference Number Qualifier: Give a name to the qualifier
  • Updates Allowed: Controls how inbound XML updates the refnum value. 'One, Update' replaces the existing value with the incoming value. 'One, Do not Update' preserves the existing value. 'Many' creates an additional refnum with the same qualifier when new values arrive via inbound XML.
Note: When using the 'Many' option, the Qualifier ID and Value combination must be unique so that inbound XML transmissions do not fail.

Once the refnum qualifier is defined, you can use it to enter data just like any other attribute — select the qualifier from the dropdown, enter a value, and save:

OTM refnum entry on shipment screen

You can also add refnum values in inbound XML. Refer to the OTM schema GlogXML.xsd for details.

Questions & Discussion

Have a question about this topic? Post it below using your GitHub account. Comments are visible to everyone and help other OTM consultants with the same question.