User Interface: SAP BC-XOM Integration

External Output Management (BC-XOM) is an interface allows an SAP Application Server to spool a Raw Data Interface (RDI), XML for Smart Forms (XSF), XML for SAP Interactive Forms by Adobe (XFP), or XML file to Spectrum.

The following panels are available when you configure an SAP BC-XOM integration by using Loftware Spectrum® Integration for use with SAP® Applications.

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. The length of this name must be 12 characters or fewer. For more information, see Configure SAP ERP for BC-XOM Communication.

Menu and Ribbon

The following commands are available from the ribbon in Integrations .

Ribbon Commands

Icon	Command	Description
	New	Create a new object of a specific type.
	Open	Open an existing object.
	Save	Save the displayed object.
	Delete	Delete the displayed object.
	Undo Edits	Reverse the most recent action on an object.
	Redo	Reapply the previously undone action to an object.

File Menu

Command	Description
Close	Close the current object.
Close All	Close all objects that you have open.
Save	Save the object.
Save As	Save a copy of the object under a different name.
Delete	Delete the displayed object.

Home

Button	Command	Description
	Start Integration	Make an integration available.
	Stop Integration	Make an integration unavailable.
	Refresh	Update the displayed data.

View

Button	Command	Description
	Properties	You can configure or view properties when you view any type of integration. For more information, see Properties below.
	Tags	You can categorize an integration by assigning tags to it. For more information about using tags, see Categorize an Integration.
	Service Management	If your Spectrum environment is configured to support distributed services, View > Service Management allows you to configure failover of integration services between Spectrum Application Servers. These options are also available in the Service Management page in System . Important! Whenever you add a new device, data service, integration, or facility, you must ensure that the service is activated on all Spectrum Application Servers on which it should be available to run and started on at least one. In an environment with only one Spectrum Application Server, these types of services are automatically activated and started when they are created. For more information, see High Availability with Distributed Services.

Button

Command

Description

Properties

You can configure or view properties when you view any type of integration. For more information, see Properties below.

Tags

You can categorize an integration by assigning tags to it. For more information about using tags, see Categorize an Integration.

Service Management

If your Spectrum environment is configured to support distributed services, View > Service Management allows you to configure failover of integration services between Spectrum Application Servers. These options are also available in the Service Management page in System System Management .

Important! Whenever you add a new device, data service, integration, or facility, you must ensure that the service is activated on all Spectrum Application Servers on which it should be available to run and started on at least one. In an environment with only one Spectrum Application Server, these types of services are automatically activated and started when they are created. For more information, see High Availability with Distributed Services.

General

The following options are available in the General panel when you use Loftware Spectrum® Integration for use with SAP® Applications to configure an SAP BC-XOM integration.

Note: You must configure each of the options displayed.

Option	Description
Job Target Folder	The unique folder in Spectrum to which status information about print jobs related to this integration should be directed. A different job target folder must be configured for each integration. For more information, see Configure a Job Target Folder.
Default Process	A process to be applied to the integration. Although this field is required, you can select the Generic Document Process in the root folder if you have not configured a custom process that should be applied.
Transaction Size	For a stacked job, the maximum number of labels to allow in a batch. This value is used during job management for packaging print job details into jobs and should be set 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 to print to the same device, the transaction size should be set to 201 or greater. In this example, a transaction size value of 100 would produce 2 batches which may result in unexpected behavior.
Run As	A Spectrum user account under which requests received from outside of Spectrum are run. This account must have at least the INTEGRATOR role or equivalent permissions and is typically not an interactive user. For more information, see Configuring a Run As User for Integrations.

SAP

The following options are available in the SAP panel when you use Loftware Spectrum® Integration for use with SAP® Applications to configure an SAP BC-XOM integration.

Note: You must configure each of the options displayed.

Option	Description
SAP System Name	The name of the SAP Application Server, typically 8 characters in length.
SAP Client	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.
SAP Username	An SAP user name. For information on the required SAP authorizations, see Configure an SAP User for Spectrum.
SAP Password	The password for the user name provided in the SAP Username field.
Load Balance Connection	Whether to support SAP Load Balancing connection mode or SAP Single Server connection mode. SAP Load Balancing permits multiplexing of communication with all SAP Systems in your environment. : Use SAP Load Balancing connection mode. : Use SAP Single Server connection mode. Note: The mode that you specify determines which options are displayed immediately following the Load Balance Connection option. Note: SAP load balancing is not related to Spectrum distributed services.

SAP Load Balancing Connection Mode

These options are displayed only if the Load Balance Connection check box is selected.

Note: SAP load balancing is not related to Spectrum distributed services.

Option	Description
SAP Message Server (MSHOST)	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.
SAP Group	The SAP logon group. A load balancing group automatically optimizes the selection of application server for performance.
SAP System ID (R3NAME)	The name of the SAP R/3 System.
SAP Message Server Port (MSSERV)	The load balancing service.

SAP Single Server Connection Mode

These options are displayed only if the Load Balance Connection check box is cleared.

Option	Description
SAP IP Address (GWHOST)	The IPv4 address of the SAP Application Server.
SAP System Number	The two-digit identification number for the SAP instance to which to connect.

Advanced

The following options are available in the Advanced panel when you use Loftware Spectrum® Integration for use with SAP® Applications to configure an SAP BC-XOM integration.

Option	Description
OMS	The name of the Output Management System to configure to print to Spectrum.
XML Stylesheet	For XSF, XFP, or XML data, enter the UNC path to a shared folder or a path to a local folder on the Spectrum Application Server of the stylesheet to use for converting data 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 Spectrum built-in stylesheet is used. If you are creating a custom stylesheet, it is recommended that you use the Spectrum 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 Spectrum 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 Spectrum built-in stylesheet is used. If you are creating a custom stylesheet, it is recommended that you use the Spectrum 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 Spectrum for your organization: `http://spectrum-server:8080/downloads/sap-xfp.xsl.template`
Process Audit Data	If selected, audit data is processed by Spectrum. Audit data is not required by Spectrum. Note: For RDI data, if you require fields from the Header record or other record types that are not Data records, you must select this option.
Use Extended Field Names	RDI and XSF: If selected, the form (window), field (element), and symbol names must be included when referring to a data map entry generated from an RDI or XSF data record. If cleared, only the symbol name is needed to refer to a data record. XFP: If selected, the hierarchy of element names must be included when referring to a data map entry generated from an XFP data record. If cleared, only the name of the element containing the data is used.
Use Legacy Extended Field Separator for XML Data	If selected, an underscore (_) is used as the field separator for extended field names. Otherwise, the forward slash (/) separator is used. Note: This option is available only if Use Extended Field Names is selected.
New Label on Repeat RDI Data Record Field Names	If selected, a new label is generated if a duplicate data field name is encountered during RDI processing. Note: For XSF, a new label is generated on duplicate smartxsf and data elements. For XML, specify a custom stylesheet in XML Stylesheet that handles new label behavior.
Send Job Status to SAP	If selected, Spectrum sends the job status to SAP ERP.
LPS Style Processing	If selected, Spectrum processes RDI data in the same manner as LPS.

Archive Options

The following options are available in the Archive Options panel when you use Loftware Spectrum® Integration for use with SAP® Applications to configure an SAP BC-XOM integration.

Option	Description
Archive Original Job File	Whether to save a copy of the original print job file to the Archive Folder when the print job is completed. : The file is not archived. (Default) : The file is saved to the Archive Folder. Note: Selecting this option is recommended only while testing because it generates additional files.
Archive XML	Whether to save a copy of the XML file produced by Spectrum to the Archive Folder when the job is completed. : The file is not archived. (Default) : The file is saved to the Archive Folder. Note: Selecting this option is recommended only while testing because it generates additional files.
Archive Folder	A UNC path to a shared folder or a path to a local folder on the Spectrum Application Server, such as \\Server01\Archive or C:\Archive. The folder that you specify is created if it does not exist. Using a path to a mapped drive is not recommended. Job files and associated XML files produced by Spectrum can be archived to this folder. Note: This option is displayed only if Archive Original Job File or Archive XML is selected.

Option

Description

Archive Original Job File

Whether to save a copy of the original print job file to the Archive Folder when the print job is completed.

: The file is not archived. (Default)

: The file is saved to the Archive Folder.

Note: Selecting this option is recommended only while testing because it generates additional files.

Archive XML

Whether to save a copy of the XML file produced by Spectrum to the Archive Folder when the job is completed.

: The file is not archived. (Default)

: The file is saved to the Archive Folder.

Note: Selecting this option is recommended only while testing because it generates additional files.

Archive Folder

A UNC path to a shared folder or a path to a local folder on the Spectrum Application Server, such as \\Server01\Archive or C:\Archive. The folder that you specify is created if it does not exist. Using a path to a mapped drive is not recommended. Job files and associated XML files produced by Spectrum can be archived to this folder.

Note: This option is displayed only if Archive Original Job File or Archive XML is selected.

Properties

The following properties can be configured or viewed by clicking View > Properties when you view any type of integration with Loftware Spectrum®.

Option	Description
Integration Name	A unique name for this connectivity bridge between Spectrum and another application. Required. 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 Spectrum interprets a name. If you will be installing the Spectrum application on a computer running Windows Server, and transferring data between Spectrum instances, see the "Transferring Spectrum Data in a Compressed File" section of the Loftware Spectrum Data Transfer Guide.
Description	A description for this integration.
Integration Type	The type of integration. One of the following values is displayed: File Drop, Oracle, Cloud, SAP RFC, SAP BC-XOM, Event JMS Producer, Event JMS Consumer, Event ActiveMQ Connection, Event Amazon SQS Connection, Event Oracle AQ Connection, Event Direct Processing, Event Message Converter, Event Socket Consumer, Event File Consumer, Event File Producer, Event Email Consumer, or Event Email Producer
Configured Status	This property is not displayed until the integration has been saved for the first time. Started Stopped
Status	This property is not displayed until the integration has been saved for the first time. Service Up: The service is online. Service Down: The service is unreachable and possibly offline.
Creation Information	Created By: The user name of the creator of the integration. Created On: The date the integration was created. Modified By: The last user to change the integration. Modified On: The date the integration was last changed.