RDI Format Reference for SAP BC-XOM Integrations
From the perspective of SAP ERP, Loftware Enterprise SP acts as an Output Management System (OMS). SAP ERP sends the data for a request in Raw Data Interface (RDI), XML for Smart Forms (XSF), or XML format. You can configure the data with values for Loftware Enterprise SP-specific symbol names to override default values.
The OMS Submit command invokes the CLI to pass RDI data to an SAP BC-XOM integration in Loftware Enterprise SP. The RDI data should follow the standard SAP RDI format and should include Loftware Enterprise SP-specific name and value pairs to ensure proper printing.
RDI data has two components:
- The Header contains information about the device, such as the device type and form name.
- The Data contains the information to be printed. This component can contain information related to multiple labels.
Each data line in RDI data can contain a name that includes a reference to a form (window), a field (element), and a symbol name followed by a value to be associated with that name. Loftware Enterprise SP automatically translates the RDI into XML.
Note: In an SAP BC-XOM integration, you can configure the Use Extended Field Names to Refer to RDI or XSF Data Records option to control whether only the symbol name is needed to refer to an RDI data record or whether the window and element names must also be used in the reference. If you are migrating from Loftware Connector, it is recommended that you select Use Extended Field Names to Refer to RDI or XSF Data Records.
The following is override information for use with Loftware Enterprise SP:
- The defined Window name for Loftware Enterprise SP override information is LABEL.
- The defined Element name for Loftware Enterprise SP override information is HEADER.
- The override field lines must come before the label data lines. They are an indication of a new set of label data.
- The HEADER element name should only be used for Loftware Enterprise SP override fields. The processing is different than for regular label data and may produce unexpected results.
RDI Input Examples
The following RDI input example files are provided to give you a starting point.
- Example with override fields: Shipping001
- SAP-generated example without override fields: ZMEDRUCK2
Here are additional tips to help you with your RDI input file:
- Override field lines must be placed before label data lines.
- Use the correct SAP RDI Header Record structure, as outlined above.
- Do not place extra override field lines after the label data lines for a label.
- Data fields using the HEADER element name do not get processed the same as regular label data and result in unexpected output.
- The SAP Spool ID passed to Loftware Enterprise SP in the job request will appear in the processed job data as field Integration_SAP_SPOOLID.
Field Names
The following table lists the Loftware Enterprise SP-specific field names and an explanation of the value associated with each name. You can use these symbol names to override values in RDI and XSF headers. Before you can do so, you must configure these symbol names in SAP ERP and incorporate them into an ABAP program or SAPscript.
Extended Field Name | Field Name | Value |
---|---|---|
LABEL_HEADER_LW_PRINTERNAME |
LW_PRINTERNAME |
Device name (Alias) of the selected device. |
LABEL_HEADER_LW_JOBNAME |
LW_JOBNAME |
The name for a specific job in Loftware Enterprise SP. |
LABEL_HEADER_LW_TRAY |
LW_TRAY |
|
LABEL_HEADER_LW_QUANTITY |
LW_QUANTITY |
|
LABEL_HEADER_LW _DUPLICATES |
LW_DUPLICATES |
Important! For RDI, the LW_DUPLICATES value is used as is. For XSF and XML, the XML (LPS) processor subtracts 1 from the LW_DUPLICATES value. |
LABEL_HEADER_LW_LABEL |
LW_LABEL |
The label template to use with a job. |
LABEL_HEADER_LW_PAGES |
LW_PAGES |
|
LABEL_HEADER_LW_INLINE_DOCUMENT |
LW_INLINE_DOCUMENT |
Required for printing external files. Print an external file, such as a PDF, without associating the file with label template. |
LABEL_HEADER_LW_INLINE_TYPE |
LW_INLINE_TYPE |
Required for printing external files. The list of supported external file types. For example, INLINE_PDF. |
LABEL_HEADER_LW_LABEL_RANGES |
LW_LABEL_RANGES |
A set of comma delimited label ranges to reprint in a multi-label or quantity reprint. When printing external files, this is the range of pages to print. An asterisk is a wildcard value that resolves to the last label printed. |
LABEL_HEADER_LW_PAGE_HANDLING |
LW_PAGE_HANDLING |
The page handling for imaged files. Maintains aspect ratios. ACTUAL_SIZE: Do not increase or decrease the image size on the page. Default value. FIT: Increase or decrease the image size as appropriate to fit the page. INCREASE: Increase the image size of undersized images only to fit the page. DECREASE: Decrease the image size of oversized images only to fit the page. CUSTOM: Increase or decrease the image size as specified in !PAGE_CUSTOM!. |
LABEL_HEADER_LW_PAGE_CUSTOM |
LW_PAGE_CUSTOM |
Required if !PAGE_HANDLING! is CUSTOM. For imaged files, the percentage as an integer value to increase or decrease the image size on the page. A value greater than 100 will increase the image size, and a value less than 100 will decrease the image size on the page. Can be used when printing external files. Default: 100. |
LABEL_HEADER_LW_FORCE_IMAGE |
LW_FORCE_IMAGE |
When printing external files, whether to force the file to print as an imaged file. TRUE: An external file is imaged regardless if the target device is configured and supports the !INLINE_TYPE! natively. FALSE: Default value. |
LABEL_HEADER_LW_TARGET_MEDIA_HEIGHT |
LW_TARGET_MEDIA_HEIGHT |
Required if !PAGE_HANDLING! is not CUSTOM. For imaged files, the height of the target media size in thousandths of an inch (mils), unless specified otherwise in !TARGET_MEDIA_UNITS!. |
LABEL_HEADER_LW_TARGET_MEDIA_WIDTH |
LW_TARGET_MEDIA_WIDTH |
For imaged files, the width of the target media size in thousandths of an inch (mils), unless specified otherwise in !TARGET_MEDIA_UNITS!. |
LABEL_HEADER_LW_TARGET_MEDIA_UNITS |
LW_TARGET_MEDIA_UNITS |
The target unit of measurement. Can be used when printing external files. INCHES: Thousandths of an inch (mils). Default value. CM: Centimeter. MM: Millimeter. |