Integrate with SAP BC-XOM
Loftware Enterprise SP Integration for use with SAP® Applications allows Loftware Enterprise SP to register with an SAP Application Server as a virtual device to which SAP Advanced Business Application Programming (ABAP) applications and forms can print.
You can configure as many SAP BC-XOM integrations as your Loftware Enterprise SP license allows. More than one integration may point to the same SAP Application Server, but each must be configured to refer to a different Output Management System (OMS) with the SAP Spool Administration (SPAD) transaction of SAP ERP. A single SAP BC-XOM integration can accept RDI, XSF, XFP, and XML data, but an OMS has a single output device that can only send one data type. That data type can change on the SAP Application Server without any changes to the Loftware Enterprise SP integration.
Before You Begin: Before you create each SAP BC-XOM integration, you must configure SAP ERP to permit integration of the full BC-XOM interface with Loftware Enterprise SP. The name that you intend to use for the integration must be incorporated into the Submit command in the Logical Output Management System (LOMS) on the SAP Application Server. The length of this name must be 12 characters or fewer. For more information, see Configure SAP ERP for BC-XOM Communication.
To create an SAP BC-XOM integration that allows print requests from an SAP Application Server to be processed by Loftware Enterprise SP, do the following.
- In Integrations
> SAP BC-XOM to create a new SAP BC-XOM integration.
- In the General panel, configure the following details about SAP.
- A different job target folder must be configured for each integration. For Job Target Folder, select a unique folder in Loftware Enterprise SP to which status information about print jobs related to this integration should be directed.
- For Default Process, select either a process that you have created that should be applied to the integration, or else select the Generic Document Process in the root folder.
- For Transaction Size, enter the number of labels to allow in a batch. It is recommended to set this value to be greater than the size of any expected batch of print job details you may need to send. For example, if you have a stacked job with 200 labels being printed to the same device, the transaction size should be set to 201 or greater.
- For Run As, select the Loftware Enterprise SP user account under which print requests from SAP applications should be run. This user account must have at least the INTEGRATOR role or equivalent permissions.
- In the SAP panel, configure the following details.
- For SAP System Name, enter the name of the SAP Application Server, typically 8 characters in length.
- For SAP Client, enter the three-digit identification number from SAP Transaction SCC4. This is the client ID with which the SAP user specified by the SAP Username is authorized to log on.
- For SAP Username and SAP Password, enter SAP credentials for the integration to use when connecting.
- To support SAP Load Balancing connection mode to permit multiplexing of communication with all SAP Systems in your SAP environment, select Load Balance Connection. Otherwise, clear the check box to use SAP Single Server connection mode instead.
- If you selected Load Balance Connection, configure the following options.
- For SAP Message Server (MSHOST), enter the name or IP address of the message server that performs load balancing of communication between application servers in an SAP System. This name must be the same on all application servers belonging to the same SAP System.
- For SAP Group, enter the name of the SAP logon group.
- For SAP System ID (R3NAME), enter the name or IP address of the SAP R/3 System.
- For SAP Message Server Port (MSSERV), enter the name of the load balancing service used for SAP.
- If you cleared Load Balance Connection, configure the following options.
- For SAP IP Address, enter the IPv4 address of the SAP Application Server.
- For SAP System Number, enter the two-digit identification number for the SAP instance to which to connect.
- In the Advanced panel, configure the following details.
- For OMS, enter the name of the Output Management System to configure to print to Loftware Enterprise SP.
- For XML Stylesheet, you can specify a stylesheet to use for converting XSF, XFP, or XML data to XML (LPS). Enter the UNC path to a shared folder or a path to a local folder on the Loftware Application Server where the stylesheet is stored. The specified stylesheet must transform XSF, XFP, or XML files to XML (LPS).
Important! Review the following information for your data type.
- XSF: If a stylesheet is not specified and the incoming request is XSF, the Loftware Enterprise SP built-in stylesheet is used. If you are creating a custom stylesheet, it is recommended that you use the Loftware Enterprise SP XSF stylesheet template as a starting point. To view the XSF stylesheet template, enter the following in the address field of your browser, where
spectrum-server
is the name of the server hosting Loftware Enterprise SP for your organization:http://spectrum-server:8080/downloads/sap-smartforms.xsl.template
- XML: If a stylesheet is not specified and the incoming request is XML, the data must be in XML (LPS) format.
- XFP: If a stylesheet is not specified and the incoming request is XFP, the Loftware Enterprise SP built-in stylesheet is used. If you are creating a custom stylesheet, it is recommended that you use the Loftware Enterprise SP XFP stylesheet template as a starting point. To view the XFP stylesheet template, enter the following in the address field of your browser, where
spectrum-server
is the name of the server hosting Loftware Enterprise SP for your organization:http://spectrum-server:8080/downloads/sap-xfp.xsl.template
- XSF: If a stylesheet is not specified and the incoming request is XSF, the Loftware Enterprise SP built-in stylesheet is used. If you are creating a custom stylesheet, it is recommended that you use the Loftware Enterprise SP XSF stylesheet template as a starting point. To view the XSF stylesheet template, enter the following in the address field of your browser, where
- The following options are available for RDI processing and XSF/XFP processing when using the built-in stylesheet or when using a custom stylesheet that includes the parameters described in XFP Format Reference for SAP BC-XOM Integrations.
- Select Process Audit Data to have Loftware Enterprise SP include audit data if data is needed for certification or other purposes or, for RDI data, if you require fields from the Header record or other record types that are not Data records.
- Select Use Extended Field Names for RDI and XSF to include form, field, and symbol names in the field names generated from data, or for XFP to include the hierarchy of element names. Otherwise, only the symbol name is used.
- For XML data, if you selected Use Extended Field Names, you can select Use Legacy Extended Field Separator for XML Data to use an underscore (_) as the field separator for extended field names. Otherwise, the forward slash (/) separator is used.
- To generate a new label if a duplicate data field name is encountered in RDI data, select New Label on Repeat RDI Data Record Field Names.
- To send the job status to SAP, select Send Job Status to SAP.
- To have Loftware Enterprise SP process RDI in the same manner as LPS, select LPS Style Processing.
- In the Archive Options panel, it is recommended that you clear Archive Original Job File and Archive XML check boxes except during testing. However, for Archive Folder you must enter a UNC path to a shared folder or a path to a local folder on the Loftware Application Server to which files can be saved if archiving is turned on. For example, \\Server01\Archive or C:\Archive. If the folder does not exist, it is created.
- In the Properties pane, enter a description of the purpose of the integration.
- Click File > Save or click Save
in the toolbar.
- In the Save dialog box, enter a name for the integration.
Important! For SAP BC-XOM integrations, the Integration Name must match the name included in the Submit command in the Logical Output Management System (LOMS) on the SAP Application Server. For more information, see Configure SAP ERP for BC-XOM Communication.
Characters permitted in names
The following characters are permitted in the name: letters, numbers, parentheses, square brackets, ampersands, plus signs, commas, semi-colons, and tildes. Additionally, the following characters are permitted but cannot begin or end the name: spaces, double quotation marks, single quotation marks, hyphens, underscores, periods, and grave accents. For letters, the case that you specify is displayed, but case is ignored when Loftware Enterprise SP interprets a name. If you will be installing the Loftware Enterprise SP application on a computer running Windows Server, and transferring data between Loftware Enterprise SP instances, see the "Transferring Data in a Compressed File" section of the Loftware Enterprise SP Data Transfer Guide.
- In the left pane of the Save dialog box, select the folder in which to save the integration. You can click a folder to display subfolders.
- Click OK to save the integration. Creation information is displayed in the Properties pane.
- In the Save dialog box, enter a name for the integration.
- In the ribbon, click Home > Start Integration.
- To verify that the integration has started, view the Status in the Properties pane.
After the integration is started, it becomes available as a virtual device to which SAP ABAP applications and forms can print until the integration is stopped. If the integration is stopped or cannot be accessed due to network issues, print requests remain pending.
Tip: To ensure that SAP BC-XOM integrations and SAP RFC integrations can function successfully, use only uppercase text in the Data Ref fields in label templates in Label Design
Important! Whenever you add a new device, data service, integration, or facility, you must ensure that the service is activated on all Loftware Application Servers on which it should be available to run and started on at least one. In an environment with only one Loftware Application Server, these types of services are automatically activated and started when they are created. For more information,