Managing SAP GLM+ Integration

This feature must be installed by Loftware Professional Services.

This feature is available only in the Loftware Cloud Enterprise SP edition of Loftware Enterprise SP.

After Loftware Professional Services has installed and configured support for SAP GLM+ integration into your Loftware Enterprise SP environment, you may choose to make changes to the configuration.

Unlike many other integration types in Loftware Enterprise SP, you manage SAP GLM+ integration in Application Design by using a business rule, in Process Design by using a process, and in System System Management by using a dynamic REST endpoint rather than in Integrations by using an integration. Also unlike many other integration types, SAP GLM+ integration does not require the creation of a Run As user or a dedicated Loftware Enterprise SP user.

WARNING: During installation of SAP GLM+ integration support for Loftware Enterprise SP, a Loftware Services Technical Consultant creates an Event File Consumer integration named LopImporter. Running this integration will overwrite any changes that you have made to the SAP_GLM_BR business rule, GLM_Process process, and blanklabel label template in the SAPGLM folder. Running it will also overwrite all configuration of those objects that Loftware Professional Services performed.

Important! Alert the SAP BASIS administrator if any of the items listed in Gather Information for Use in SAP GLM+ change later.

Business Rule for SAP GLM+ Integration

The business rule A collection of component sets or business rule components that can be used to incorporate logic or to add, change, or remove data or print parameters after a print request is submitted but before printing occurs. Business rules are similar to form rules, but provide more robust functionality. Business rules are created on the Application Design page and can be designed using the Configurator or programmed using XML. SAP_GLM_BR is run whenever a request is received by the dynamic REST endpoint that supports SAP GLM+ integration. This business rule was installed and configured by Loftware Professional Services to support SAP GLM+ integration.

This business rule responds to the following requests:

Return label template status (LABEL_STATUS)
Return a print preview (PREVIEW)
Print labels (PRINT)
Return job status to SAP GLM+ (PRINT_STATUS)
Return the list of devices (PRINTERS)

This business rule includes six component sets, each of which consists of a custom trigger A means of running an action, rule, or data service. Includes a trigger source if interactive (such as a button, a prompt, or a form) and a trigger event (such as clicking a button, entering text at a prompt, loading a form, or submitting a job). For example, you can specify a particular button as a trigger source that Data Providers can click to perform a query of a database. and one or more component blocks. When a request is received, the REST endpoint triggers the MapData event in the business rule. This trigger event runs a component set that determines the type of request received and then initiates a trigger event that runs another component set to respond to the request.

Important! The business rule contains fully-qualified references to itself and to the items listed in Gather Information for Loftware Professional Services for SAP GLM+ Integration. If the names or paths to these folders and objects change, you must update this business rule accordingly. The following list and comments within the business rule can help you identify where changes would be required.

MapData: Read data, determine request type, and route request

The MapData component set is run directly by the REST endpoint and is the first one in the business rule to be run. It reads the data received, determines the type of request (return label template status, return a print preview, print labels, return job status, or return the list of devices), and processes the request accordingly. To process requests, this component set triggers events that run other component sets in this business rule.

The MapData trigger runs a Run Map Data Script component block configured to use the Nashorn script engine. It also runs Conditional True/False component blocks.

The following variable in this component set has been configured for your Loftware Enterprise SP environment. If changes are made to your environment, then you must update the value of this variable accordingly.

Variable	Description
jobTargetFolder	The dedicated job target folder for print jobs related to SAP GLM+.

Important! The Conditional True/False component blocks include the fully-qualified name of the SAP_GLM_BR business rule. If the name or path to this business rule is changed, you must update the references in this business rule.

LabelStatus: Return label template status

This LabelStatus component set determines whether the requested label template is in a published When version control is used, a version for which the minor version number is zero. Users with some permissions can print only the latest published version. state so that it can be used to print labels.

The LabelStatus trigger runs a Run Data Map Script component block configured to use the Nashorn script engine. The LabelStatus trigger event occurs if the request type received is LABEL_STATUS.

Variable	Description
prefix	The dedicated folder for label templates to be used with SAP GLM+.

PreviewLabel: Return a print preview

The PreviewLabel component set returns a preview of the label output in PDF format to SAP GLM+.

The PreviewLabel trigger runs a Run Data Map Script component block configured to use the Nashorn script engine. The PreviewLabel trigger event occurs if the request type received is PREVIEW.

The following variables in this component set have been configured for your Loftware Enterprise SP environment. If changes are made to your environment, then you must update the values of these variables accordingly.

Variable	Description
labelPrefix	The dedicated folder for label templates to be used with SAP GLM+.
imagePrefix	The folder for images to be used with SAP GLM+. This is typically Images\User Images.

PrintLabel: Print labels

The PrintLabel component set prints the requested labels and returns the Job ID or an error message to SAP GLM+.

The PrintLabel trigger runs a Run Data Map Script component block configured to use the Nashorn script engine. The PrintLabel trigger event occurs if the request type received is PRINT.

Variable	Description
labelPrefix	The dedicated folder for label templates to be used with SAP GLM+.
imagePrefix	The folder for images to be used with SAP GLM+. This is typically Images\User Images.
devicePrefix	The folder for devices to be used with SAP GLM+.
process	The process used to support SAP GLM+ integration.

Important! The PrintLabel component block includes the name of the blanklabel label template, which is used for PRE and POST labels. If the name of this label template is changed, you must update the references in this business rule.

PrintStatus: Return job print status to SAP GLM+

The PrintStatus component set returns the status of a requested Job ID to SAP GLM+. The status returned is one of the following.

	Job status in Loftware Enterprise SP	Value returned to SAP GLM+
If the job successfully printed	Completed	True
If the job is currently printing	Printing	Printing
If the job was not successful	(varies)	False

The PrintStatus trigger runs a Run Data Map Script component block configured to use the Nashorn script engine. The PrintStatus trigger event occurs if the request type received is PRINT_STATUS.

The business rule is version controlled. For information about version control in Loftware Enterprise SP, see Working in a Version-Controlled Environment.

For information about managing a business rule, see Designing Business Rules with the Configurator.

Business Rule Manipulation of Data

Loftware Enterprise SP requires each data ref within a print request to be unique. To achieve this, the SAP_GLM_BR business rule (specifically in the PrintPreview and PrintLabel component sets) manipulates the data during processing. In particular, the data ref for each variable field becomes /Body/ followed by the Item ID from the XML received. If the print request includes duplicate Item IDs that end in SY (denoting a Symbol (image)), then a sequential integer (beginning with zero) is appended to each of those Item IDs. Otherwise, the values of duplicate Item IDs included in a print request are concatenated.

For more about data refs generated from Item IDs, see Designing Label Templates for SAP GLM+ Integration.

Process for SAP GLM+ Integration

The process GLM_Process is used by the business rule SAP_GLM_BR when submitting a job. It is a process of the simple process type. This process was installed and configured by Loftware Professional Services to support SAP GLM+ integration.

For information about managing a process, see Designing Business Rules with the Configurator. For information about the properties of a simple process, see User Interface: Simple Process.

Dynamic REST Endpoint for SAP GLM+ Integration

The dynamic REST endpoint sap-glm-integration runs the business rule SAP_GLM_BR. This REST endpoint was created and configured by Loftware Professional Services to support SAP GLM+ integration.

Important! Do not change the name of the sap-glm-integration REST endpoint. The name of this REST endpoint is part of the path that the SAP BASIS administrator enters when configuring SAP GLM+ integration in your SAP environment.

Important! The dynamic REST endpoint contains a fully-qualified reference to the SAP_GLM_BR business rule. If the name or path to the business rule changes, you must update the dynamic REST endpoint accordingly.

For information about managing dynamic REST endpoints, see Managing Dynamic REST Endpoints.

Devices for SAP GLM+ Integration

Anytime that you configure additional devices in Loftware Enterprise SP or change the names of devices, you should alert the SAP BASIS administrator so that these devices can be activated in your SAP environment. If the SAP BASIS administrator is unfamiliar with the process, direct them to the Loftware Integration for SAP® GLM+ Installation and Configuration Guide, which is available via Loftware Components: Loftware Integration for SAP GLM+.

Label Templates and Images for SAP GLM+ Integration

If the names of label templates used with SAP GLM+ integration change, alert your SAP BASIS administrator. Also, if more label templates (not including secondary label templates such as those used for PRE and POST labels) are configured for use with SAP GLM+ integration, alert your SAP BASIS administrator.

Important! The label template, blanklabel, that was installed by Loftware Professional Services to support SAP GLM+ integration, is used by the SAP_GLM_BR business rule when a print request requires a PRE label or a POST label. If the name of this label template is changed, the business rule must be updated accordingly.

For guidance about label templates and images for use with SAP GLM+ integration, see Designing Label Templates for SAP GLM+ Integration.