Specification
BC-XOM Extension for Printer
Administration
Interface Version: 1.00
Document Version: 9
Date: December 28th 2015
BC-XOM Extension for Printer Administration
Content:
0
GLOSSARY ............................................................................................................................................... 4
1
INTRODUCTION ........................................................................................................................................ 5
2
FEATURES ................................................................................................................................................ 5
2.1
2.2
2.3
3
IMPLEMENTATION GUIDELINES ............................................................................................................ 6
3.1
3.2
3.3
3.4
3.5
3.6
4
PRINTER DEFINITION MAINTENANCE ....................................................................................................... 5
OMS DEFINITION MAINTENANCE ............................................................................................................ 5
LIMITATIONS.......................................................................................................................................... 5
GENERAL APPROACH ............................................................................................................................ 6
COMMUNICATION ................................................................................................................................... 6
CHANGE NOTIFICATIONS........................................................................................................................ 6
BC-XOM AND PAL ............................................................................................................................... 7
PRINTER NAMES .................................................................................................................................... 7
ADDITIONAL DOCUMENTATION................................................................................................................ 7
API .............................................................................................................................................................. 7
4.1
OVERVIEW ............................................................................................................................................ 7
4.1.1
Availability .................................................................................................................................. 7
4.1.2
Compatibility .............................................................................................................................. 8
4.1.3
Packaging ................................................................................................................................... 8
4.1.4
Authorization .............................................................................................................................. 8
4.2
DATA TYPES ......................................................................................................................................... 8
4.2.1
General Data Types ................................................................................................................... 8
4.2.1.1 ROMS, LOMS Identification .................................................................................................................... 8
4.2.1.1.1 Data Type SEXT_ROMS .................................................................................................................. 8
4.2.1.1.2 Data Type SEXT_LOMS ................................................................................................................... 8
4.2.2
Data Types for Printer Definition Maintenance ....................................................................... 8
4.2.2.1 Device Type Retrieval ............................................................................................................................. 8
4.2.2.1.1 Structure SEXT_DTYPE_DEF .......................................................................................................... 8
4.2.2.1.2 Table Type SEXT_DTYPE_DEF_TAB .............................................................................................. 9
4.2.2.2 Print Options Retrieval............................................................................................................................. 9
4.2.2.2.1 Structure SEXT_POPT_VAL ............................................................................................................. 9
4.2.2.2.2 Table Type SEXT_POPT_VAL_TAB .............................................................................................. 10
4.2.2.2.3 Structure SEXT_POPT_INFO ......................................................................................................... 10
4.2.2.2.4 Table Type SEXT_POPT_INFO_TAB............................................................................................. 10
4.2.2.2.5 Structure SEXT_POPT ................................................................................................................... 10
4.2.2.2.6 Table Type SEXT_POPT_TAB ....................................................................................................... 11
4.2.2.3 Spool Server Retrieval........................................................................................................................... 11
4.2.2.3.1 Structure SEXT_SPOO_SERVER .................................................................................................. 11
4.2.2.3.2 Table Type SEXT_SPOO_SERVER _TAB ..................................................................................... 12
4.2.2.4 Printer Long and Shortname Retrieval .................................................................................................. 12
4.2.2.4.1 Structure SEXT_PRINTER_NAME ................................................................................................. 12
4.2.2.4.2 Table Type SEXT_PRINTER_NAME_TAB ..................................................................................... 12
4.2.2.5 Printer Maintenance .............................................................................................................................. 12
4.2.2.5.1 TYPE SEXT_COV_LANG ............................................................................................................... 12
4.2.2.5.2 Structure SEXT_TRAY_FLAGS ...................................................................................................... 12
4.2.2.5.3 Structure SEXT_TRAY_INFO ......................................................................................................... 14
4.2.2.5.4 Structure SEXT_PRINTER_DEF .................................................................................................... 15
4.2.2.5.5 Table Type SEXT_PRINTER_DEF_TAB. ....................................................................................... 18
4.2.3
Data Types For OMS Definition Maintenance ....................................................................... 21
4.2.3.1 ROMS Definition .................................................................................................................................... 21
4.2.3.1.1 Structure SEXT_ROMS_DEF ......................................................................................................... 21
4.2.3.1.2 Structure SEXT_INST ..................................................................................................................... 24
4.2.3.1.3 Table Type SEXT_INST_TAB ......................................................................................................... 25
4.2.3.2 LOMS Definition .................................................................................................................................... 25
4.2.3.2.1 Structure SEXT_LOMS_DEF .......................................................................................................... 25
4.2.3.2.2 Table Type SEXT_LOMS_DEF_TAB.............................................................................................. 29
4.2.3.3 OMS Command Set Definition .............................................................................................................. 30
4.2.3.3.1 Structure SEXT_CMD_DEF ............................................................................................................ 30
-2-
BC-XOM Extension for Printer Administration
4.2.3.3.2
Table Type SEXT_CMD_DEF _TAB............................................................................................... 32
4.3
FUNCTION MODULES ........................................................................................................................... 32
4.3.1
Printer Definition Maintenance ............................................................................................... 32
4.3.1.1
4.3.1.2
4.3.1.3
4.3.1.4
4.3.1.5
4.3.1.6
4.3.1.7
4.3.1.8
4.3.1.9
4.3.2
Spool Server Retrieval........................................................................................................................... 32
Device Type Retrieval ........................................................................................................................... 32
Print Options Retrieval........................................................................................................................... 33
Printer Short Names Retrieval ............................................................................................................... 34
Printer Long Names Retrieval ............................................................................................................... 34
Printer Definition Retrieval ..................................................................................................................... 35
Printer Definition Creation ..................................................................................................................... 35
Printer Definition Deletion ...................................................................................................................... 37
Printer Definition Modification ................................................................................................................ 39
OMS Definition Maintenance .................................................................................................. 41
4.3.2.1 SAP Application Server Information Retrieval ....................................................................................... 41
4.3.2.2 ROMS Definition .................................................................................................................................... 41
4.3.2.2.1 Definition Retrieval .......................................................................................................................... 41
4.3.2.2.2 Definition Creation........................................................................................................................... 42
4.3.2.2.3 Definition Deletion ........................................................................................................................... 43
4.3.2.2.4 Definition Modification ..................................................................................................................... 44
4.3.2.3 LOMS Definition .................................................................................................................................... 45
4.3.2.3.1 Definition Retrieval .......................................................................................................................... 46
4.3.2.3.2 Definition Creation........................................................................................................................... 46
4.3.2.3.3 Definition Deletion ........................................................................................................................... 48
4.3.2.3.4 Definition Modification ..................................................................................................................... 49
4.3.2.4 Command Set Definition........................................................................................................................ 51
4.3.2.4.1 Definition Retrieval .......................................................................................................................... 51
4.3.2.4.2 Definition Creation........................................................................................................................... 52
4.3.2.4.3 Definition Deletion ........................................................................................................................... 53
4.3.2.4.4 Definition Modification ..................................................................................................................... 54
-3-
BC-XOM Extension for Printer Administration
0
Glossary
Acronym or abbreviation
Meaning
OMS
Output Management System.
CCMS
Computing Center Management System. A division
within SAP that deals with system management
issues.
XMI
CCMS Interface for eXternal Management tools. A
general framework for external system management
interfaces
SMAPI
System Management Application Programming
Interface. An interface for a particular system
management area. BC-XOM is a SMAPI for
connection of OMS systems to SAP NW spool
system. XOM is its SMAPI name.
BC-XOM
Generic Interface to SAP NW Spool System for
eXternal Output Management systems.
XOM
SMAPI name of BC-XOM.
ROMS
Real representation within SAP NW of an Output
Management System.
LOMS
Logical representation within SAP NW of an Output
Management System.
SAP NW
SAP NetWeaver.
CLI
Command Line Interface.
RFC
Remote Function Call.
OS
Operating System.
PDL
Page Description Language.
PAL
Printing Assistant for Landscapes (note 964501)
Printer
In this document the term printer is used to denote
an output device with device class “Standard
Printer”.
-4-
BC-XOM Extension for Printer Administration
1
Introduction
A specification of the already existing interface BC-XOM can be found under:
https://www.sdn.sap.com/irj/sdn/go/portal/prtroot/docs/library/uuid/f2dbc690-0201-0010-daa2-f52b947aa146
Up to now BC-XOM mainly deals with the runtime of the printing process i.e. sending a print job to an OMS
system and querying its status and to a limited extend the status of a printer.
In the API to external system management tools BC-XOM offered nearly no functionality for configuring the
involved resources on the NW system. This holds true for both the configuration of a particular OMS system
and especially for the configuration of its associated printers.
This shortcoming of BC-XOM is addressed with “BC-XOM Extension for Printer Administration”.
2
Features
To ease the overall OMS configuration overhead BC-XOM Extension for Printer Administration contains the
following additional features:
1. API for maintenance/access of OMS printer definition in SAP NW system.
2. API for maintenance/access of OMS definition in SAP NW system.
2.1
Printer Definition Maintenance
The administrator of an OMS gets control over the SAP NW printer definition belonging to the OMS . No
double maintenance is required in the SAP NW system and in the OMS system. The following functionality is
provided:

Create, view, modify and delete OMS printer definition.

Retrieve available spool servers from SAP NW system.

Retrieve available device types from a SAP NW system.

Retreive list of already occupied printer long and short names.
2.2
OMS Definition Maintenance
The administrator of an OMS system gets control over its OMS definition in an SAP NW system with the
following functionality:

Create, view, modify and delete ROMS definition.

Create, view, modify and delete LOMS definition.

Create, view, modify and delete associated command set definition.
2.3
Limitations
Limitations in printer administration via BC-XOM Extension for Printer Administration compared to the SAP
Spool administration (transaction SPAD) are:

Short name of a printer cannot be automatically generated.
SPAD allows a printer short name to be generated automatically if not specified. BC-XOM Extension
for Printer Administration requires both printer name and printer short name to be specified.
-5-
BC-XOM Extension for Printer Administration

Administration of output devices with device classes different from “Standard Printer” (e.g.
Archiving program, Fax or Device Pool) is not supported.

Administration of printers with access methods different from E is not supported.

Turning off host spooler query for status of output requests is not supported.

Specifying additional SAPScript and SmartForms information is not supported.

Setting log and trace flags is not supported.

Setting of authorization groups for printers is not supported.
Limitations in OMS administration via BC-XOM Extension for Printer Administration compared to transaction
SPAD:

Setting the option “transmit print data stream via RFC to the OMS” in case of an RFC enabled LOMS
is not supported. (Print data steam transmission via RFC is not supported anyhow. Please see note
700571 “”)

Creation of ROMS and LOMS with output type “Fax” is not supported.

Setting of Host Spool Attribute Records for ROMs is not supported.
3
Implementation guidelines
3.1
General approach
Without the new extension BC-XOM users had to define printers twice: once in the SAP system and once in
the OMS system certified for BC-XOM. Also for creating the definition of LOMS and ROMS on the SAP
system they needed to logon to each SAP system they wanted to connect to the OMS system.
With the new features of BC-XOM Extension for Printer Administration OMS vendors now can build their
software in a way that printer definitions and OMS definitions need to be maintained only once on the OMS
system. With the extension it is then possible to distribute the definitions automatically via RFC to the
connected SAP systems provided they are on a release that supports BC-XOM Extension for Printer
Administration.
3.2
Communication
The BC-XOM Extension for Printer Administration can be used by calling its functions via RFC. Therefore the
OMS needs to run as an RFC client (analog to the BC-XOM RFC callback scenario).
3.3
Change Notifications
In case of a printer definition change on the SAP NW system an attached OMS system may want to get
notified and update its internal printer definition accordingly.
This requirement is to a limited extent already supported by the old BC-XOM interface:
An OMS system that supports any type of callback (device or job callback) will receive by calling either
SXMI_XOM_DEVICES_CALLBACK or SXMI_XOM_JOBS_CALLBACK an indication in output parameter
CONFIG_DEVICES whether a modification of the associated SAP NW printer has taken place. In such a
case the OMS system is required to reconfigure its device list by calling SXMI_XOM_DEVICES_QUERY.
This call nevertheless does not unveil the printer details.
-6-
BC-XOM Extension for Printer Administration
With BC-XOM Extension for Printer Administration it is now possible to complement the information by
retrieving the printer definition details with the according function modules of section 4.3.1.
The same holds true for changes performed on the NW system regarding the LOMS and ROMS definition.
3.4
BC-XOM and PAL
From SAP NW 7.02 and 7.20 on PAL supports distribution of printers with access method E. Distribution
takes place from one PAL central system to several PAL target systems. PAL controlled printers are
administered centrally from the PAL central system and cannot be modified on the target system itself.
It is possible to create and modify printers via BC-XOM and to assign them to PAL printer groups. See SAP
note 2027390 (http://service.sap.com/sap/support/notes/2027390) for more information.
3.5
Printer names
It is important to keep printer long and printer short names consistent over the whole system landscape as
especially the printer short names are part of transportable customizing objects of different applications. To
find free names for printer long and shortnames the function modules
SXMI_XOM_PRI_LONG_NAME_QUERY and SXMI_XOM_PRI_SHORT_NAME_QUERY can and should
be used.
The OMS system must provide end users a possibility to define a range of possible short names (interactive
or via customizing) in order to minimize conflicts with short names.
3.6
Additional documentation
As an additional information for the different API elements described below it is recommended to read the
user documentation for the corresponding SAP administration transactions:

Printer definition, LOMS and ROMS in transaction SPAD:
Please check the according sections in the SAP Printing Guide at http://help.sap.com/ .
Direct acess via: http://help.sap.com/saphelp_nw70/helpdata/en/d9/4a8eb751ea11d189570000e829fbbd/frameset.htm

Additional print options:
http://service.sap.com/output  Media Library  Documentation  Print Options User Guide
4
API
4.1
Overview
4.1.1
Availability
BC-XOM Extension for Printer Administration will be available from SAP NW release

7.02

7.20
BC-XOM Extension for Printer Administration will bring XOMs XMI version from 0.1 to 0.2 :

Major version: 0.
-7-
BC-XOM Extension for Printer Administration

Minor version: 2.
4.1.2
Compatibility
BC-XOM Extension for Printer Administration provides extended functionality and is completely downward
compatible to existing versions of BC-XOM. Functionality and interfaces of older versions of BC-XOM are
not changed.
4.1.3
Packaging
All function modules belong to the function group SXOM.
4.1.4
Authorization
The user ID that uses BC-XOM Extension for Printer Administration API needs to have authorization profile
‘S_ADMI_FCD’ , id ‘S_ADMI_FCD’ field ‘SPAD’.
4.2
Data Types
NOTE: Flags are mapped to a character data type of length 1. Such a flag is set to TRUE if its value is not
blank or initial.
4.2.1
General Data Types
4.2.1.1
ROMS, LOMS Identification
4.2.1.1.1 Data Type SEXT_ROMS
Data Type Name: SEXT_ROMS.
Basic Type: CHAR10.
Semantic: Name of ROMS.
4.2.1.1.2 Data Type SEXT_LOMS
Data Type Name: SEXT_LOMS.
Basic Type: CHAR6.
Semantic: Name of LOMS.
4.2.2
Data Types for Printer Definition Maintenance
4.2.2.1
Device Type Retrieval
4.2.2.1.1 Structure SEXT_DTYPE_DEF
Structured Type Name: SEXT_DTYPE_DEF
Field name
Type
Technical type
PATYPE
RSPOPTYPE
CHAR8
PNAME
RSPONAME
CHAR30
Attribute semantic:
-8-
BC-XOM Extension for Printer Administration

PATYPE:
Name of the device type.

PNAME:
Short description of the device type.
4.2.2.1.2 Table Type SEXT_DTYPE_DEF_TAB
Type SEXT_DTYPE_DEF_TAB is a table type with lines of type SEXT_DTYPE_DEF.
4.2.2.1.3 Table type SEXT_PRINTER_DEF_EXT_TAB
Type SEXT_PRINTER_DEF_TAB_EXT is a table type with lines of type SEXT_PRINTER_DEF_EXT.
4.2.2.1.4 Structure SEXT_URDT
Structured Type Name: SEXT_URDT
Type
Technical type
Meaning
URDT
CHAR8
name of URDT
URDT_DESC
CHAR30
description of URDT
URDT_LANG
table of CHAR2
list of supported languages
Structure SEXT_URDT describes the capabilities of an Unicode reference device type (URDT).
4.2.2.1.5 SEXT_URDT_TAB
Type SEXT_URDT_TAB is a table type with lines of type SEXT_URDT_TAB.
4.2.2.2
Print Options Retrieval
4.2.2.2.1 Structure SEXT_POPT_VAL
Structured Type Name: SEXT_POPT_VAL
Field name
Type
Technical type
OPTVAL
RSPOPOSS_OPTVAL
INT1
VALUETEXT_EN
RSPOPOSS_OPTVAL_STRING_EN
CHAR60
VALUETEXT
RSPOPOSS_OPTVAL_STRING
CHAR60
Attribute semantic:

OPTVAL:
Integer value of a print option.

VALUETEXT_EN:
English description of print option value.
-9-
BC-XOM Extension for Printer Administration

VALUETEXT:
Translated description of print option value. The translation language is determined by the logon
language.
4.2.2.2.2 Table Type SEXT_POPT_VAL_TAB
Type SEXT_POPT_VAL_TAB is a table type with lines of type SEXT_POPT_VAL.
4.2.2.2.3 Structure SEXT_POPT_INFO
Structured Type Name: SEXT_POPT_INFO
Field name
Type
Technical type
POPTION
RSPOPOSS_OPTID
INT1
OPTNAME
RSPOPOSS_OPTNAME
CHAR60
OPTTYPE
SEXT_CHAR
CHAR1
OPTVALTAB
SEXT_POPT_VAL_TAB
Table type
IS_VENDORDEF
SEXT_FLG
CHAR1
Attribute semantic:

POPTION:
ID of the print option.

OPTNAME:
Name of the print option (in logon language).

OPTTYPE:
Type of the print option: L=List,C=Checkbox,U=Userstring.

OPTVALTAB:
Possible values of a print option.

IS_VENDORDEF:
Flag. If set this print option is defined by a printer vendor and not a SAP system print option.
4.2.2.2.4 Table Type SEXT_POPT_INFO_TAB
Type SEXT_POPT_INFO_TAB is a table type with lines of type SEXT_POPT_INFO.
4.2.2.2.5 Structure SEXT_POPT
Structured Type Name: SEXT_POPT
Field name
Type
Technical type
POPTION
RSPOPOSS_OPTID
INT1
SEL_OPTVAL
RSPOPOSS_OPTVAL
INT1
Attribute semantic:
- 10 -
BC-XOM Extension for Printer Administration

POPTION:
Print option ID.

SEL_OPTVAL:
Value ID of the print option. The value 0 identifies a print option as a whole.
4.2.2.2.6 Table Type SEXT_POPT_TAB
Type SEXT_POPT_TAB is a table type with lines of type SEXT_POPT.
4.2.2.3
Spool Server Retrieval
4.2.2.3.1 Structure SEXT_SPOO_SERVER
Structured Type Name: SEXT_SPOO_SERVER
Field name
Type
Technical type
PAMSSERVER
MSNAME
CHAR20
PAHOST
RSPOHOST
CHAR32
TEXT
RSPODESC
CHAR64
LOGICAL
RSPOLOGFLG
CHAR1
RUNMODE
RSPOSRVMOD
CHAR1
ALTSRV
RSPOALTSRV
CHAR20
MAPPEDTO
RSPOMAPSRV
CHAR20
SPOOLSRV
RSPOSPOSRV
CHAR20
Attribute semantic:

PAMSSERVER:
Name of the Spool Server.

PAHOST:
Hostname of the Spool Server.

TEXT:
Description of the Spool Server.

LOGICAL:
Flag. Set if Spool Server is a logical server.

RUNMODE:
Flag. Set if Load balancing is enabled.
This field is used to control which method the system uses to determine a spool server for
processing output requests.
If checked the system searches for the server with the lowest load in the hierarchy of logical and
alternative servers you defined. This server then takes over output request processing. SAP cannot
guarantee that a printer’s spool requests are processed sequentially.
If not checked the output requests are assigned statically to this spool server or its logical mapping.
- 11 -
BC-XOM Extension for Printer Administration

ALTSRV:
Alternative spool server. The server that is to be used if the specified server is down or not available.
If load balancing is activated, the load is distributed between the two servers.

MAPPEDTO:
Assigned spool server. Specifies which spool server the logical server maps to. All requests sent to
this logical server will be transferred to the server set in the mapping.

SPOOLSRV:
Specifies which REAL spool server is assigned for processing. If the associated spool server is a
real spool server the field SPOOLSRV is identical to the spool server.
4.2.2.3.2 Table Type SEXT_SPOO_SERVER _TAB
Type SEXT_SPOO_SERVER _TAB is a table type with lines of type SEXT_SPOO_SERVER.
4.2.2.4
Printer Long and Shortname Retrieval
4.2.2.4.1 Structure SEXT_PRINTER_NAME
Structured Type Name: SEXT_PRINTER_NAME
Field name
Type
Technical type
LNAME
RSPOLNAME
CHAR30
SNAME
RSPOPSHORT
CHAR4
Attribute semantic:

LNAME:
Printer long name.

SNAME:
Printer short name.
4.2.2.4.2 Table Type SEXT_PRINTER_NAME_TAB
Type SEXT_PRINTER_NAME_TAB is a table type with lines of type SEXT_PRINTER_NAME.
4.2.2.5
Printer Maintenance
4.2.2.5.1 TYPE SEXT_COV_LANG
Elementary type: CHAR 2.
Semantic: Identifies the language of the printer cover page (if applicable).
4.2.2.5.2 Structure SEXT_TRAY_FLAGS
Structured Type Name: SEXT_TRAY_FLAGS
Field name
Type
Technical type
- 12 -
BC-XOM Extension for Printer Administration
FTRY1
SEXT_FLG
CHAR1
FTRY2
SEXT_FLG
CHAR1
FTRY3
SEXT_FLG
CHAR1
FTRY4
SEXT_FLG
CHAR1
FTRY5
SEXT_FLG
CHAR1
FTRY6
SEXT_FLG
CHAR1
FTRY7
SEXT_FLG
CHAR1
FTRY8
SEXT_FLG
CHAR1
FTRY9
SEXT_FLG
CHAR1
FTRY10
SEXT_FLG
CHAR1
FTRYM
SEXT_FLG
CHAR1
FTRYENV
SEXT_FLG
CHAR1
FTRYMENV
SEXT_FLG
CHAR1
Attribute semantic:

FTRY1:
Flag. Set to TRUE if paper format of tray 1 of the associated printer is to be specified. See type
SEXT_TRAY_INFO.

FTRY2:
Flag. Set to TRUE if paper format of tray 2 of the associated printer is to be specified. See type
SEXT_TRAY_INFO.

FTRY3:
Flag. Set to TRUE if paper format of tray 3 of the associated printer is to be specified. See type
SEXT_TRAY_INFO.

FTRY4:
Flag. Set to TRUE if paper format of tray 4 of the associated printer is to be specified. See type
SEXT_TRAY_INFO.

FTRY5:
Flag. Set to TRUE if paper format of tray 5 of the associated printer is to be specified. See type
SEXT_TRAY_INFO.

FTRY6:
Flag. Set to TRUE if paper format of tray 6 of the associated printer is to be specified. See type
SEXT_TRAY_INFO.

FTRY7:
Flag. Set to TRUE if paper format of tray 7 of the associated printer is to be specified. See type
SEXT_TRAY_INFO.

FTRY8:
Flag. Set to TRUE if paper format of tray 8 of the associated printer is to be specified. See type
SEXT_TRAY_INFO.

FTRY9:
Flag. Set to TRUE if paper format of tray 9 of the associated printer is to be specified. See type
SEXT_TRAY_INFO.

FTRY10:
Flag. Set to TRUE if paper format of tray 10 of the associated printer is to be specified. See type
SEXT_TRAY_INFO.
- 13 -
BC-XOM Extension for Printer Administration

FTRYM:
Flag. Set to TRUE if paper format of the manual feed tray of the associated printer is to be specified.
See type SEXT_TRAY_INFO.

FTRYENV:
Flag. Set to TRUE if paper format of the envelope tray of the associated printer is to be specified.
See type SEXT_TRAY_INFO.

FTRYMENV:
Flag. Set to TRUE if paper format of the manual feed envelope tray of the associated printer is to be
specified. See type SEXT_TRAY_INFO.
4.2.2.5.3 Structure SEXT_TRAY_INFO
Structured Type Name: SEXT_TRAY_INFO
Field name
Type
Technical type
TFLAGS
SEXT_TRAY_FLAGS
CHAR13
TRAY1
RSPOFORMAT
CHAR8
TRAY2
RSPOFORMAT
CHAR8
TRAY3
RSPOFORMAT
CHAR8
TRAY4
RSPOFORMAT
CHAR8
TRAY5
RSPOFORMAT
CHAR8
TRAY6
RSPOFORMAT
CHAR8
TRAY7
RSPOFORMAT
CHAR8
TRAY8
RSPOFORMAT
CHAR8
TRAY9
RSPOFORMAT
CHAR8
TRAY10
RSPOFORMAT
CHAR8
TRAYMANU
RSPOFORMAT
CHAR8
TRAYENV
RSPOFORMAT
CHAR8
TRAYMANENV
RSPOFORMAT
CHAR8
Attribute semantic:

TFLAGS:
Flags indicating for which trays of the associated printer page formats should be set. See type
SEXT_TRAY_FLAGS.

TRAY1:
Page format for printer tray 1. Freely definable name for a page format. The name identifies the page
format in spool processing types and in SAPscript forms.
Examples:
ANY, DINA3, DINA4, DINA5, EXECUTIV, FORMDISP, INCH11, INCH12, INCH2, INCH4, INCH4C,
INCH5, INCH6, INCH7, INCH8, JPHAGAKI, JPLEGAL1, JPLEGAL2, LEGAL, LETTER, LINE_21.

TRAY2:
Page format for printer tray 2. See attribute TRAY1.

TRAY3:
Page format for printer tray 3. See attribute TRAY1.
- 14 -
BC-XOM Extension for Printer Administration

TRAY4:
Page format for printer tray 4. See attribute TRAY1.

TRAY5:
Page format for printer tray 5 See attribute TRAY1.

TRAY6:
Page format for printer tray 6. See attribute TRAY1.

TRAY7:
Page format for printer tray 7. See attribute TRAY1.

TRAY8:
Page format for printer tray 8. See attribute TRAY1.

TRAY9:
Page format for printer tray 9. See attribute TRAY1.

TRAY10:
Page format for printer tray 10. See attribute TRAY1.

TRAYMANU:
Page format for manual feed printer tray. See attribute TRAY1.

TRAYENV:
Page format for envelope printer tray. See attribute TRAY1.

TRAYMANENV:
Page format for manual feed envelope printer tray. See attribute TRAY1.
4.2.2.5.4 Structure SEXT_PRINTER_DEF
Structured Type Name: SEXT_PRINTER_DEF
Field name
Type
Technical type
NAME
RSPOLNAME
CHAR30
PADEST
RSPOPSHORT
CHAR4
PAMSSERVER
MSNAME
CHAR20
TRAY_INFO
SEXT_TRAY_INFO
Structure
PALOMS
SEXT_LOMS
CHAR6
PATYPE
RSPOPTYPE
CHAR8
PAMODEL
RSPOMODEL
CHAR20
PASTANDORT
RSPOPLOCAT
CHAR64
PAMSG
RSPOPMSG
CHAR64
PADEVGRP
RSPODGRP
CHAR30
PADISABLED
RSPODISABL
CHAR1
PAPROSNAME
RSPOPRNAME
CHAR50
PADFLTSTTL
RSPODSTITL
CHAR1
COVER_PAGE_LNG
SEXT_COV_LANG
CHAR 2
PADFLTUTTL
RSPODUTITL
CHAR1
PAMONI
RSPOMONI
CHAR1
- 15 -
BC-XOM Extension for Printer Administration
PASYNC
RSPOSYNC
CHAR1
PADUPCOPY
RSPODUPCOP
CHAR1
COLORPRT
RSPOCOLPRT
CHAR1
PRINTMODE
RSPOPRTMD
CHAR1
INPUTTRAY
RSPOINTRAY
CHAR3
POPT
SEXT_POPT_TAB
Table type
POPT_PRE
SEXT_POPT_TAB
Table type
Attribute semantic:

NAME:
Long name of the printer.

PADEST:
Short name of the printer.

PAMSSERVER
Name of the spool server.

TRAY_INFO:
Paper format information of printer trays.

PALOMS:
Name of the associated LOMS.

PATYPE:
Device type of associated printer.

PAMODEL:
Name of the printer model.

PASTANDORT:
Location of the printer.

PAMSG:
Status message (or copy of location).
You can use this field to display a special message regarding a printer to your users.
If this field is empty, the text in field PASTANDORT is displayed in the list of printers. If you enter a
message in this field, then this message is displayed instead of the PASTANDORT description.
Examples:
Suppose you have entered the following Location text for printer LPR2: Computing center line printer
in RZ-22.
If this printer breaks down, you can enter a message in this field to let users know it has broken
down.

PADEVGRP:
Authorization group for printers.
You can assign a printer to an authorization group. You can enter the name of an authorization
group instead of a printer in a user authorization. The user is then authorized to use all printers in
this authorization group.

PADISABLED:
Flag. Printer not released. Select this field to prevent SAP users from sending output requests to this
printer. The users will be able to create output requests for this printer, but the system will display a
message telling them the printer is locked.

PAPROSNAME:
Long name of printers for host spooler. Name of the printer in the host system.
- 16 -
BC-XOM Extension for Printer Administration
On Windows systems, you can find this name (\\P12345\PRINTER1, for example) in the print
manager.

PADFLTSTTL:
Flag. Print SAP cover page. Set this flag if you want a cover page to be printed out along with print
requests at this printer.
A cover page is only printed if one was defined in the cover page action of the formatting actions
used by the printer. All SAP device types have predefined cover pages.
Users can change the default setting and decide whether to print a cover page (if one is defined) or
not.

COVER_PAGE_LNG:
Language to be used for cover page.
Examples:


DE
German

EN
English

FR
French
PADFLTUTTL:
Print default host spool cover page. Specify whether the cover page defined by the host spooler for
this printer should be printed by default. You can choose from the following settings:
o
<blank>
Do not print host spooler cover page.
o
D
Print host spooler cover page as set at printer
o
X
Always print host spooler cover page.
Users can decide themselves whether to print a cover page when they select their print options.

PAMONI:
Flag. Monitor using monitoring infrastructure.
If this option is activated, the monitoring architecture monitors job processing as well as the host
spool requests for this device. The system adds an entry for this device under the spool - devices
node of the relevant spool server. The entry is updated by the system.
This object uses part of the memory in the shared memory segment of the monitoring architecture.
This memory is limited; if a large number of printers are monitored, you may not be able to add
additional objects to be monitored (even if the objects are of a different type). This is the reason why
monitoring is optional.

PASYNC:
Flag. Synchronization of requests of a printer.
The default is to process output requests in the order they are created.
If multiple spool work processes are defined on the application server for this printer, multiple output
requests from this printer can be processed in parallel. If you want to do this, deselect the check box.
If this option is not selected, some requests may overtake others, as they will not be processed in
the order they were created.

PADUPCOPY:
Create a print request for each copy.
Indicates whether a print request should be generated for every copy. If this field is selected, the
spool system will send a separate print request for each copy of a document to be printed.
You can usually leave this field blank. It is required only if the printer is attached to a PC running
OS/2 Version 1.3. The OS/2 print manager cannot print multiple copies of a document from a single
SAP print request. To print multiple copies, the SAP system must therefore send separate print
requests to the print manager.
If you leave the field blank, then the SAP spool system sends only one print request, no matter how
many copies of a document are to be printed.
Possible values:
- 17 -
BC-XOM Extension for Printer Administration
o
<blank>
Copy counter to host spool system.
o
X
Pass copies as separate Output Request in SAP system.
o
N
Only pass one copy to host spool system.

COLORPRT:
Flag whether or not printer supports color printing. This field specifies whether the physical printer
supports color printing. Most SAP printer drivers require this information to determine which print
commands to generate (color, or black and white).

PRINTMODE:
Controls duplex printing. Possible values:

o
<blank> Default.. Use printer default setting.
o
S
SIMPLEX: Print on one side.
o
D
DUPLEX: Print on both sides.
o
T
TUMBLE DUPLEX: Print both sides reversed.
INPUTTRAY:
Determines which paper tray to use. Possible values:
o
<blank> Default tray.
o
1
Paper tray 1.
o
2
Paper tray 2.
o
3
Paper tray 3.
o
4
Paper tray 4.
o
5
Paper tray 5.
o
6
Paper tray 6.
o
7
Paper tray 7.
o
8
Paper tray 8.
o
9
Paper tray 9.
o
10
Paper tray 10.
o
ENV
Paper tray for envelopes.

POPT:
List of disabled print options. (Per default all available print options are enabled).

POPT_PRE:
List of preselected print options.
4.2.2.5.5 Table Type SEXT_PRINTER_DEF_TAB.
Type SEXT_PRINTER_DEF_TAB is a table type with lines of type SEXT_PRINTER_DEF.
4.2.2.5.6 Structure RSPOATTR
Structured Type Name: RSPOATTR
- 18 -
BC-XOM Extension for Printer Administration
Type
Technical type
PARAM
CHAR16
VALUE
CHAR200
The following values are supported:
PARAM
VALUE
Meaning
URDT
e.g. URDTC
Name of Unicode reference
device type (URDT)
NO_UPE_FOR_ALI
‘X’ or ‘ ‘
no UPE mechanism for ABAP
lists
USE_ONLY_TTF
‘X’ or ‘ ‘
always embed fonts
UPE_PCL_T15
‘X’ or ‘ ‘
use type-15 font header
PAXSHIFT
4-byte-integer
shift output horizontally
PAYSHIFT
4-byte-integer
shift output vertically
PAXSHUNIT
CH, MM, IN, CM, or PT
unit for horizontal shift
PAYSHUNIT
CH, MM, IN, CM, or PT
unit for vertical shift
S_PRINTTICKET
name of print ticket
‘X’ or ‘ ‘
S_PRINTTICKETDEF
marks as default print ticket
S_CPC_CS_PRG
name of PAL printer group
‘X’ or ‘ ‘
S_CPC_PRINTER
marks printer as central printer
4.2.2.5.7 Table type SEXT_DEVICE_ATTRIBUTES
Type SEXT_DEVICE_ATTRIBUTES is a table type with lines of type RSPOATTR.
4.2.2.6
Printer Retrieval
4.2.2.6.1 Structure SEXT_PRINTER_DEF_EXT
Structured Type Name: SEXT_PRINTER_DEF_EXT
Field name
Type
Technical type
NAME
RSPOLNAME
CHAR30
ATTR
RSPOATTR
deep structure
Attribute semantic:

NAME:
Long name of the printer.
- 19 -
BC-XOM Extension for Printer Administration

ATTR
deep structure for extended printer attributes consisting of the fields PARAM (CHAR16) and VALUE
(CHAR200). The following values are supported:
PARAM
VALUE
Meaning
URDT
e.g. URDTC
Name of Unicode reference
device type (URDT)
NO_UPE_FOR_ALI
‘X’ or ‘ ‘
no UPE mechanism for ABAP
lists
USE_ONLY_TTF
‘X’ or ‘ ‘
always embed fonts
UPE_PCL_T15
‘X’ or ‘ ‘
use type-15 font header
PAXSHIFT
4-byte-integer
shift output horizontally
PAYSHIFT
4-byte-integer
shift output vertically
PAXSHUNIT
CH, MM, IN, CM, or PT
unit for horizontal shift
PAYSHUNIT
CH, MM, IN, CM, or PT
unit for vertical shift
S_PRINTTICKET
name of print ticket
S_PRINTTICKETDEF
‘X’ or ‘ ‘
marks as default print ticket
S_CPC_CS_PRG
name of PAL printer group
4.2.2.6.2 Table type SEXT_PRINTER_DEF_EXT_TAB
Type SEXT_PRINTER_DEF_TAB_EXT is a table type with lines of type SEXT_PRINTER_DEF_EXT.
4.2.2.7
PAL groups retrieval
4.2.2.7.1 Structure SEXT_PAL_PGROUP_ID
Structured Type Name: SEXT_PAL_PGROUP_ID
Field name
Type
Technical type
PGNAME
SPCPCPGNAME
CHAR32
DESCRIPTION
TEXT240
CHAR240
4.2.2.7.2 Table type SEXT_PAL_PRINTER_GRP_TABLE
Type SEXT_PAL_PRINTER_GRP_TABLE is a table type with lines of type SEXT_PAL_PGROUP_ID.
4.2.2.7.3 Structure SEXT_PAL_TSGROUP_ID
Structured Type Name: SEXT_PAL_TSGROUP_ID
Field name
Type
Technical type
TSGNAME
SPCPCTSGNAME
CHAR32
DESCRIPTION
TEXT240
CHAR240
4.2.2.7.4 Table type SEXT_TARGET_SYSTEM_GRP_TABLE
- 20 -
BC-XOM Extension for Printer Administration
Type SEXT_TARGET_SYSTEM_GRP_TABLE is a table type with lines of type
SEXT_PAL_TSGROUP_ID.
4.2.3
Data Types For OMS Definition Maintenance
4.2.3.1
ROMS Definition
4.2.3.1.1 Structure SEXT_ROMS_DEF
Structured Type Name: SEXT_ROMS_DEF
Field name
Type
Technical type
NAME
SEXT_ROMS
CHAR10
DESCR
SEXT_DESC
CHAR60
OMSFLAGS
SEXT_OFLGS
CHAR60
STARTINST
SEXT_TRGT
CHAR40
STARTCMD
SEXT_CMD
CHAR132
RECONFIG
SEXT_IVMIN
NUM3
CMD_INTFCE
SEXT_FLGCI
CHAR1
RFC_INTFCE
SEXT_FLGRI
CHAR1
JOB_QUERY
SEXT_FLGJQ
CHAR1
JOB_CANCEL
SEXT_FLGJC
CHAR1
POLL_JOBS
SEXT_FLGJP
CHAR1
CALLB_JOBS
SEXT_FLGJB
CHAR1
CALLB_DEVS
SEXT_FLGDB
CHAR1
DEV_QUERY
SEXT_FLGDQ
CHAR1
Attribute semantic:

NAME:
Name of real OMS.
A real output management system (ROMS) describes the attributes of an output management
system available on a chosen platform and supported by SAP. Before you can define devices in the
SAP system for this ROMS, you must define at least one logical output management system (LOMS)
for it. In the LOMS, you define actual operational parameters for the ROMS or its devices. The
possible ways of configuring the LOMS depend on how the ROMS is configured.

DESCR:
Description of the real OMS.

OMSFLAGGS:
OMS configuration flag.
Use this field to enter additional options or parameters that will be returned to the OMS in two cases:
- 21 -
BC-XOM Extension for Printer Administration
o
You can transfer the contents of the OMS configuration field to the OMS using SUBMIT
commands. To set whether the character string in this field is entered in an OMS command,
you use the corresponding option in the SUBMIT command definition in the LOMS
command groups.
o
In addition, the content of the OMS configuration field is always returned to the OMS when
you use an RFC callback. Both for an ROMS and LOMS, the content of the field is returned
to the callback client when the client starts and when the Reply Message Group is
reconfigured. The OMS uses the same method to send confirmations to the SAP system for
output requests assigned to the same RMG.

STARTINST:
Target for callback.
Enter the name of the SAP server that is to output the command to start the callback client. SAP
usually expects that any SAP server can output OMS commands. The OMS may require a specific
host to output the initialization command. In that case, you can specify that host in this field.

STARTCMD:
Command line model for access method E.
This field describes a template for a command line to call an OMS command. The command line can
be structured as required.
If an entry is used in the path then you must make sure that it is placed in front of the command
template. If not, the template can contain several commands (depending on the shell possibilities of
the operating system on which the command will be executed).
Alongside regular elements of the shell command syntax, other SAP-specific replacement characters
can also be used. These begin with a '&' character. If the command is to contain a '&' character then
this must be written as '&&'. The following replacement parameters are defined:
&C Number of copies
&D Department of the recipient
&F Name of file with the print date (including path)
&f Name of file without path
&H/<x>/<y>/ <x>, if host spool cover page required, <y> otherwise
&I Job name with DB ID
&J Job name without DB ID
&L Format type
&M Client of spool request owner
&m Client of print request owner
&O (SAP)Name of spool request owner
&o (SAP)Name of print request owner
&P Name of external printer
&p Path name of output file
&R Name of recipient
&S Name of SAP printer
&T Title
&t Fax number. (No native Fax support in SAP spool system).
&U Host spool cover page required (X=yes, N=no)
&Y SAP priority (1-99) 1 is the highest priority
&N Spool request number
&n Output request number
Alongside these standard parameters the following parameters are also available for the OMS
command template:
&EI SAP spool ID
&EG Confirmation group
&ES SAP instance name for callback (if required, otherwise "-")
&ET Maximum buffer time for callback events
&EA Maximum number of buffered events
&EP Fax recipient (future addition). (No native Fax support in SAP spool system).
&E1 SAP flag of LOMS
&E2 OMS flag of LOMS
- 22 -
BC-XOM Extension for Printer Administration
&E3 SAP flag of ROMS
&E4 OMS flag of ROMS
An operating system-specific masking of special characters is necessary for the correct handling of
command arguments. This also applies to the currently set values for the parameters.
To do this the following mechanism is used:
UNIX: The characters \, ', " and $ are masked by a \ . A separate \ is represented by \\ . Parameters
should be bracketed with " characters, so that the special characters (including blank characters) are
correctly transmitted (for example: '&T').
Windows/NT: The character " is masked with a \ . All \ characters before a " character are masked.
% characters are replaced by # characters. This is necessary, as there is no way of masking the
variable substitution of the NT shell.

RECONFIG:
Time interval for a reconnect.
If a callback target is unavailable, the OMS attempts to reconnect to this SAP instance cyclically.
This value represents the duration of the cycle (in seconds) for reattempting a connection. This value
is valid for all logical output management systems in a real output management system.

CMD_INTFCE:
Flag. OMS tasking possible using command line interface.
In the ROMS configuration, this field indicates whether or not an output management system
supports the command line interface for tasking. In the LOMS configuration, it specifies whether the
command line interface is to be used for devices of this LOMS.

RFC_INTFCE:
Flag. OMS tasking via RFC interface possible
In ROMS configuration, this field indicates whether or not an output management system supports
the RFC tasking interface.
In LOMS configuration, this field indicates whether or not the RFC tasking interface is to be used for
devices of this LOMS.

JOB_QUERY:
Flag. OMS job query possible.
Switch for specifying whether SAP spool request administration can be used to interactively query
the status of requests in the output management system.



Meaning for real output management system (ROMS) configuration:
Select this field if the ROMS supports interactive querying of individual jobs.

Meaning for logical output management system (LOMS) configuration:
Select this field if interactive querying of individual jobs is possible for devices of this LOMS.
JOB_CANCEL:
Flag. OMS jobs can be deleted.
Switch for specifying whether SAP spool request administration can be used to delete requests
processed by the output management system.

Meaning for real output management system (ROMS) configuration:
Select this field if the ROMS supports job deletion.

Meaning for logical output management system (LOMS) configuration:
Select this field if jobs in the OMS can be deleted from within the SAP system.
POLL_JOBS:
Flag. OMS job polling possible.
Switch for specifying whether the output management system supports job polling (cyclical query).
- 23 -
BC-XOM Extension for Printer Administration



o
Meaning for real output management system (ROMS) configuration:
Select this field if the ROMS supports job polling for querying the spool work process for the
status of a job.
o
Meaning for logical output management system (LOMS) configuration:
Select this field if the job status is confirmed by polling the spool work process.
CALLB_JOBS:
Flag. OMS job callback possible.
Switch for specifying whether the output management system supports job callback.

Meaning for real output management system (ROMS) configuration:
Select this field, if the ROMS supports job callback.

Meaning for logical output management system (LOMS) configuration:
Select this field if the job status replay is sent through callback.
CALLB_DEVS:
Flag. OMS device callback possible.
Switch for specifying whether the output management system supports device callback.

Meaning for real output management system (ROMS) configuration:
Select this field, if the ROMS supports device callback.

Meaning for logical output management system (LOMS) configuration:
Select this field if the response indicating device status is sent through callback. Only then can
you query device events from the device configuration.
DEV_QUERY:
Flag. OMS queue query possible.
Switch for specifying whether the output management system supports interactive device queue
querying.

Meaning for real output management system (ROMS) configuration:
Select this field if the ROMS supports interactive querying of individual device queues.

Meaning for logical output management system (LOMS) configuration:
Select this field if interactive querying of queues is possible for devices in this LOMS.
4.2.3.1.2 Structure SEXT_INST
Structured Type Name: SEXT_INST
Field name
Type
Technical type
STARTINST
SEXT_TRGT
CHAR40
HOST
MSHOST
CHAR60
TEXT
RSPODESC
CHAR64
OPSYS
SYOPSYS
CHAR10
HAS_SPOO_SRV
SEXT_FLG
CHAR1
IS_LOGICAL
SEXT_FLG
CHAR1
CURRENT_SPOO
SEXT_TRGT
CHAR40
Attribute semantic:
- 24 -
BC-XOM Extension for Printer Administration

STARTINST:
Name of a SAP NW instance.

HOST:
Name of the machine this instance runs on.

TEXT:
Description of this instance.

OPSYS:
Name of the operating system of the associated SAP NW instance.
Examples are:
o
HP-UX
o
Linux
o
OSF1
o
SINIX
o
WindowsNT
o
SunOS
o
AIX

HAS_SPOO_SRV:
Flag. True if this instance has at least one spool workprocess.

IS_LOGICAL:
Flag. True if this instance is a logical instance. See field CURRENT_SPOO.

CURRENT_SPOO:
If this instance is a logical instance this field contains the instance it is currently mapped to.
4.2.3.1.3 Table Type SEXT_INST_TAB
Type SEXT_INST_TAB is a table type with lines of type SEXT_INST.
4.2.3.2
LOMS Definition
4.2.3.2.1 Structure SEXT_LOMS_DEF
Structured Type Name: SEXT_LOMS_DEF
Field name
Type
Technical type
NAME
SEXT_LOMS
CHAR6
DESCR
SEXT_DESC
CHAR60
RNAME
SEXT_ROMS
CHAR10
CMDSERVER
SEXT_CSRV
CHAR40
CALLBTRGT
SEXT_TRGT
CHAR40
OMSFLAGS
SEXT_OFLGS
CHAR60
- 25 -
BC-XOM Extension for Printer Administration
CMD_GROUP
SEXT_CGRP
CHAR1
CMD_INTFCE
SEXT_FLGCI
CHAR1
RFC_INTFCE
SEXT_FLGRI
CHAR1
USE_POLL
SEXT_FLGJP
CHAR1
DEV_QUERY
SEXT_FLGDQ
CHAR1
CALLB_DEVS
SEXT_FLGDB
CHAR1
JOB_QUERY
SEXT_FLGJQ
CHAR1
JOB_CANCEL
SEXT_FLGJC
CHAR1
USE_POPUPS
SEXT_FLGPU
CHAR1
CALLB_JOBS
SEXT_FLGJB
CHAR1
USE_FILE
SEXT_FLGDF
CHAR1
USE_FRFC
SEXT_FLGDR
CHAR1
CLASS
SEXT_RLVL
NUM2
VANISH_ERR
SEXT_FLGVE
CHAR1
DCALLBIV
SEXT_INTVL
NUM3
DCALLBAMNT
SEXT_AMNT
NUM3
JCALLBIV
SEXT_INTVL
NUM3
JCALLBAMNT
SEXT_AMNT
NUM3
RETRYIV
SEXT_INTVL
NUM3
Attribute semantic:

NAME:
Logical output management system.
Logical output management systems (LOMS) can be assigned to each maintained real output
management system (ROMS). The LOMS defines a subset of attributes of the ROMS, which are to
be valid for a group of printers. You must then assign this LOMS to each device that is accessed
using access method 'E'.
Logical output management systems allow you to operate the devices of a real output management system in
different modes. For example, you can operate a group of important devices in callback mode, and at the same
time operate other devices in the conventional polling mode.

DESCR:
Description of the LOMS definition.

RNAME:
Real output management system.
A real output management system (ROMS) describes the attributes of an output management
system available on a chosen platform and supported by SAP.
Before you can define devices in the SAP system for this ROMS, you must define at least one logical
output management system (LOMS) for it. In the LOMS, you define actual operational parameters
for the ROMS or its devices. The possible ways of configuring the LOMS depend on how the ROMS
is configured.
- 26 -
BC-XOM Extension for Printer Administration

CMDSERVER:
Instance for executing OMS commands.
This server is used to output anonymous commands, that is, commands that are not matched to a
specific server based on the device definition. Anonymous commands are all output management
system (OMS) commands except SUBMIT and POLLING.

CALLBTRGT:
Target for callback.
Enter the name of the SAP server that is to output the command to start the callback client.
SAP usually expects that any SAP server can output OMS commands. The OMS may require a
specific host to output the initialization command. In that case, you can specify that host in this field.

OMSFLAGS:
OMS configuration flags.
Use this field to enter additional options or parameters that will be returned to the OMS in two cases:
o
You can transfer the contents of the OMS configuration field to the OMS using SUBMIT
commands. To set whether the character string in this field is entered in an OMS command,
you use the corresponding option in the SUBMIT command definition in the LOMS
command groups.
o
In addition, the content of the OMS configuration field is always returned to the OMS when
you use an RFC callback. Both for an ROMS and LOMS, the content of the field is returned
to the callback client when the client starts and when the Reply Message Group is
reconfigured. The OMS uses the same method to send confirmations to the SAP system for
output requests assigned to the same RMG.

CMD_GROUP:
Command group ID (Letter A … Z) that identifies the command group to be used for this LOMS.
Applies only if USE_CMD flag is set for this LOMS.

CMD_INTFCE:
Flag. OMS tasking possible using command line interface.
In the ROMS configuration, this field indicates whether or not an output management system
supports the command line interface for tasking.
In the LOMS configuration, it specifies whether the command line interface is to be used for devices
of this LOMS.

RFC_INTFCE:
Flag. OMS tasking via RFC interface possible.
In ROMS configuration, this field indicates whether or not an output management system supports
the RFC tasking interface.
In LOMS configuration, this field indicates whether or not the RFC tasking interface is to be used for
devices of this LOMS.
Note that it is not supported to select the ‘Data by file’ and the ‘Data direct’ option here.
LOMS definitions created by this XOM extension will be set to the ‘Data by file’ option.

USE_POLL:
Flag. Job polling possible.

DEV_QUERY:
Flag. OMS queue query possible.
Switch for specifying whether the output management system supports interactive device queue
querying.
- 27 -
BC-XOM Extension for Printer Administration


o
Meaning for real output management system (ROMS) configuration:
Select this field if the ROMS supports interactive querying of individual device queues.
o
Meaning for logical output management system (LOMS) configuration:
Select this field if interactive querying of queues is possible for devices in this LOMS.
CALLB_DEVS:
Flag. OMS device callback possible.
Switch for specifying whether the output management system supports device callback.
o
Meaning for real output management system (ROMS) configuration:
Select this field, if the ROMS supports device callback.
o
Meaning for logical output management system (LOMS) configuration:
Select this field if the response indicating device status is sent through callback. Only then
can you query device events from the device configuration.
JOB_QUERY:
Flag. OMS job query possible.
Switch for specifying whether SAP spool request administration can be used to interactively query
the status of requests in the output management system.

o
Meaning for real output management system (ROMS) configuration:
Select this field if the ROMS supports interactive querying of individual jobs.
o
Meaning for logical output management system (LOMS) configuration:
Select this field if interactive querying of individual jobs is possible for devices of this LOMS.
JOB_CANCEL:
Flag. OMS jobs can be deleted.
Switch for specifying whether SAP spool request administration can be used to delete requests
processed by the output management system.
o
Meaning for real output management system (ROMS) configuration:
Select this field if the ROMS supports job deletion.
o
Meaning for logical output management system (LOMS) configuration:
Select this field if jobs in the OMS can be deleted from within the SAP system.

USE_POPUPS:
Flag. Status dialog boxes.
When using access method 'E' in conjunction with callbacks, status dialog boxes can be sent to the
user who has initiated printing. Set this flag to activate the dialog boxes.

CALLB_JOBS:
Flag. Use OMS job callback.
Switch for specifying whether the output management system supports job callback.
NOTE: Use mutually exclusive with flag USE_POLL.

USE_FILE:
Flag. Indicates if print data is to be transferred via file to the OMS. Applies only in case of flag
USE_RFC is set.
NOTE: Mutually exclusive with flag USE_FRFC.
NOTE: Currently this is the only supported transfer method.

USE_FRFC:
Flag. Indicates if print data is to be transferred via RFC call to the OMS. Applies only in case of flag
USE_RFC is set.
NOTE: Mutually exclusive with flag USE_FILE.
NOTE: Currently this transfer method in NOT supported. If you check this flag an exception is raised.

USE_POLL:
Flag. Use OMS job polling.
Switch for specifying whether the output management system supports job callback.
NOTE: Use mutually exclusive with flag CALLB_JOBS.
- 28 -
BC-XOM Extension for Printer Administration

CLASS:
Event report level for OMS callbacks.
Report level for events of output management systems. The value describes the level up to which
events are reported to the R/3 system.
Meaning of the different values:
o
01 Final messages (including 'done' and error messages): The job is not resumed or
processed further; as far as the spool system is concerned, the job is completed.
o
02 Problem messages: Problems that require user interaction
o
03 Problem messages: Problems that the system can solve
o
04 Status changes: Includes internal statuses of the output management system that are not
reproduced in the SAP system (in particular the change from 'waiting' to 'printing').
o
05 Information: Further information. Additional levels of detail can be defined with larger
number values according to your output management system (for example, change in queue
position).
A value always includes the events assigned to lower values. For every problem message ('problem'
error class), an event reporting the elimination of the problem is reported using the same report level
('information' error class).

VANISH_ERR:
Flag: Error handling for OMS polling.
The polling interface defines that there must be at least one final status confirmation for a job. It
cannot simply disappear from the job list without a confirmation by the SAP spool system. This flag
controls the behavior of the spool system if this should happen.
If you set this flag, the print request concerned acquires the status 'incorrect'; otherwise it is
accepted as 'done'.
NOTE: Flag will only be considered if flag USE_POLL is set.

DCALLBIV:
If an OMS supports device callback this attribute specifies the amount of time in seconds after which
a callback has to be performed.

DCALLBAMNT:
If an OMS supports device callback this attribute specifies the number of device events an OMS is
allowed to cache before a callback has to be performed.

JCALLBIV:
If an OMS supports job callback this attribute specifies the amount of time in seconds after which a
callback has to be performed.

JCALLBAMNT:
If an OMS supports job callback this attribute specifies the number of job events an OMS is allowed
to cache before a callback has to be performed.

RETRYIV:
If an OMS supports callback this attribute specifies the number of seconds to wait for the OMS until
a previously unsuccessful callback shall be performed again.
4.2.3.2.2 Table Type SEXT_LOMS_DEF_TAB
Type SEXT_LOMS_DEF_TAB is a table type with lines of type SEXT_LOMS_DEF.
- 29 -
BC-XOM Extension for Printer Administration
4.2.3.3
OMS Command Set Definition
4.2.3.3.1 Structure SEXT_CMD_DEF
Structured Type Name: SEXT_CMD_DEF
Field name
Type
Technical type
OPSYS
SYOPSYS
CHAR10
LCMD
SEXT_LCMD
CHAR6
CMD
SEXT_CMD
CHAR132
Attribute semantic:
o
OPSYS:
Name of the OS of the SAP NW application server instance the command is to be carried out.
Examples:
o HP-UX
o Linux
o OSF1
o SINIX
o WindowsNT
o SunOS
o AIX
o
LCMD:
Logical command. Possible values are:
o ‘CANCEL’:
The associated real command will be carried out from the specified application server
(see attribute ‘CMDSERVER’ in structure SEXT_LOMS_DEF) in case of job
cancellation.
o ‘DPOLL’:
The associated real command will be carried out from the specified application server
(see attribute ‘CMDSERVER’ in structure SEXT_LOMS_DEF) in case of device polling.
o ‘DQUERY’:
The associated real command will be carried out from the specified application server
(see attribute ‘CMDSERVER’ in structure SEXT_LOMS_DEF) in case of device query.
o ‘JQUERY’:
The associated real command will be carried out from the specified application server
(see attribute ‘CMDSERVER’ in structure SEXT_LOMS_DEF) in case of job query.
o ‘PATH’:
The associated real command string will be placed in front of the command string of a
‘CANCEL’, ‘DPOLL’, ‘DQUERY’, ‘JQUERY’ or ‘SUBMIT’ command.
o ‘SUBMIT’:
The associated real command will be carried out from the specified application server
(see attribute ‘CMDSERVER’ in structure SEXT_LOMS_DEF) in case of a print job
submission to the OMS.
o
CMD:
The real command to be carried out from the associated SAP NW application server instance
(see attribute ‘CMDSERVER’ of structure SEXT_LOMS_DEF).
- 30 -
BC-XOM Extension for Printer Administration
This field describes a template for a command line to call an OMS command. The command line
can be structured as required.
If an entry is used in the path then you must make sure that it is placed in front of the command
template. If not, the template can contain several commands (depending on the shell possibilities
of the operating system on which the command will be executed).
Alongside regular elements of the shell command syntax, other SAP-specific replacement
characters can also be used. These begin with a '&' character. If the command is to contain a '&'
character then this must be written as '&&'. The following replacement parameters are defined:
&C
&D
&F
&f
&H/<x>/<y>/
&I
&J
&L
&M
&m
&O
&o
&P
&p
&R
&S
&T
&t
&U
&Y
&N
&n
Number of copies
Department of the recipient
Name of file with the print date (including path)
Name of file without path
<x>, if host spool cover page required, <y> otherwise
Job name with DB ID
Job name without DB ID
Format type
Client of spool request owner
Client of print request owner
(SAP)Name of spool request owner
(SAP)Name of print request owner
Name of external printer
Path name of output file
Name of recipient
Name of SAP printer
Title
Fax number
Host spool cover page required (X=yes, N=no)
SAP priority (1-99) 1 is the highest priority
Spool request number
Output request number
Alongside these standard parameters the following parameters are also available for the OMS
command template:
&EI
&EG
&ES
&ET
&EA
&EP
&E1
&E2
&E3
&E4
SAP spool ID
Confirmation group
SAP instance name for callback (if required, otherwise "-")
Maximum buffer time for callback events
Maximum number of buffered events
Fax recipient (future addition). No native Fax support in SAP spool system.
SAP flag of LOMS
OMS flag of LOMS
SAP flag of ROMS
OMS flag of ROMS
An operating system-specific masking of special characters is necessary for the correct handling
of command arguments. This also applies to the currently set values for the parameters.
To do this the following mechanism is used:
UNIX: The characters \, ', " and $ are masked by a \ . A separate \ is represented by \\ .
Parameters should be bracketed with " characters, so that the special characters (including
blank characters) are correctly transmitted (for example: '&T').
Windows/NT: The character " is masked with a \ . All \ characters before a " character are
- 31 -
BC-XOM Extension for Printer Administration
masked. % characters are replaced by # characters. This is necessary, as there is no way of
masking the variable substitution of the NT shell.
4.2.3.3.2 Table Type SEXT_CMD_DEF _TAB
Type SEXT_CMD_DEF _TAB is a table type with lines of type SEXT_CMD_DEF.
4.3
Function Modules
The existing XOM SMAPI will be supplemented by the function modules stated in this section.
A XMI Logon is required for all function modules to be used. (This is the reason why the ROMS appears in
the function module interfaces).
SAPs internal XMI and spool logging mechanism will be used to trace OMS operations on SAP objects like
printers and ROMS, LOMS and LOMS command sets.
4.3.1
Printer Definition Maintenance
4.3.1.1
Spool Server Retrieval
Function Module: SXMI_XOM_SPOO_SRV_QUERY
Import Parameters:
Parameter name
Parameter type
ROMS
SEXT_ROMS
Export Parameters:
Parameter name
Parameter type
SERVERS
SEXT_SPOO_SERVER _TAB
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the provided ROMS is not known.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.
Description:
This function module returns a list of all available spool servers on the executing SAP NW system.
4.3.1.2
Device Type Retrieval
Function Module: SXMI_XOM_DEVTYPE_QUERY.
Import Parameters:
- 32 -
BC-XOM Extension for Printer Administration
Parameter name
Parameter type
ROMS
SEXT_ROMS
SHOW_URDT
SEXT_FLG
Export Parameters:
Parameter name
Parameter type
DEVTYPES
SEXT_DTYPE_DEF_TAB
URDT_INFO
SEXT_URDT_TAB
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the provided ROMS is not known.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.
Description:
This function module returns a list of all available device types on the executing SAP NW system. If
SHOW_URDT is requested, the function returns a list of available Unicode reference device types (URDTs).
4.3.1.3
Print Options Retrieval
Function Module: SXMI_XOM_POPT_QUERY.
Import Parameters:
Parameter name
Parameter type
ROMS
SEXT_ROMS
PATYPE
RSPOPTYPE
Export Parameters:
Parameter name
Parameter type
POPT
SEXT_POPT_INFO_TAB
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the provided ROMS is not known.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.
- 33 -
BC-XOM Extension for Printer Administration

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.

DEVTYPE_UNKNOWN
The specified device type does not exist.
Description:
This function module returns a list of all possible printer options associated to a certain device type. If a
printer with print options is to be created, this function module has to be called beforehand to retrieve
available print options.
If the device type does not support print options the parameter POPT is empty.
4.3.1.4
Printer Short Names Retrieval
Function Module: SXMI_XOM_PRI_SHORT_NAME_QUERY
Import Parameters:
Parameter name
Parameter type
ROMS
SEXT_ROMS
PATTERN
STRING
Export Parameters:
Parameter name
Parameter type
SHORTNAMES
SEXT_PRINTER_NAME_TAB
Tables:
None.
Exceptions:

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.
Description:
This function module returns a list of all occupied printer short names in the system matching the pattern
provided in the parameter PATTERN. Wildcards are the usual wildcards as used in SQL statements:
%
_
4.3.1.5
matches any sequence of characters
matches one single character
Printer Long Names Retrieval
Function Module: SXMI_XOM_PRI_LONG_NAME_QUERY
Import Parameters:
Parameter name
Parameter type
ROMS
SEXT_ROMS
PATTERN
STRING
Export Parameters:
Parameter name
Parameter type
- 34 -
BC-XOM Extension for Printer Administration
LONGNAMES
SEXT_PRINTER_NAME_TAB
Tables:
None.
Exceptions:

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.
Description:
This function module returns a list of all occupied printer long names in the system matching the pattern
provided in the parameter PATTERN. Wildcards are the usual wildcards as used in SQL statements:
%
_
matches any sequence of characters
matches one single character
4.3.1.6
Printer Definition Retrieval
Function Module: SXMI_XOM_PRINTER_QUERY.
Import Parameters:
Parameter name
Parameter type
ROMS
SEXT_ROMS
DEVICE
RSPOLNAME
GET_EXTENDED
SEXT_FLG
Export Parameters:
Parameter name
Parameter type
PRINTERS
SEXT_PRINTER_DEF_TAB
PRINTERS_EXT
SEXT_PRINTER_DEF_EXT_TAB
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the provided ROMS is not known.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.
Description:
This function module returns a list of all printers assigned on the executing SAP NW system to a ROMS
specified in input parameter ROMS. Wildcards are not allowed. If a value is provided for parameter DEVICE,
settins of a single printer can be returned.
4.3.1.7
Printer Definition Creation
Function Module: SXMI_XOM_PRINTER_CREATE.
- 35 -
BC-XOM Extension for Printer Administration
Import Parameters:
Parameter name
Parameter type
ROMS
SEXT_ROMS
PRNT_DEF
SEXT_PRINTER_DEF
ADDITIONAL_SETTINGS
SEXT_DEVICE_ATTRIBUTES
Export Parameters:
None.
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the provided ROMS is not known.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.

NOT_AUTHORIZED
The RFC user has not sufficient authorization to perform the intended operation. Needed
authorization: Autorization Object: S_RFC (Field: SXOM), S_ADMI_FCD (Field SPAD).

INVALID_PRINTER_LONG_NAME
The specified printer long name was incorrect. Allowed characters:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_-.:() '.

INVALID_PRINTER_SHORT_NAME
The specified printer short name was incorrect. Allowed characters:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_-.:() '

COLLISION_IN_SHORT_NAME
A printer with the specified short name already exists.

COLLISION_IN_LONG_NAME
A printer with the specified long name already exists.

LOMS_UNKNOWN
The specified LOMS name is not known to the system.

ROMS_LOMS_MISMATCH
The specified LOMS name does not belong to the ROMS name provided.

DEVTYPE_UNKNOWN
The specified device type is not known to the system.

SPOOL_SERVER_UNKNOWN
The specified spool server is not known to the system.

INVALID_COVER_PAGE_LANGUAGE
The specified cover page language is not known to the system. Check specification of structure
SEXT_PRINTER_DEF.

INVALID_PRINTMODE
The specified printmode is not known to the system. Check specification of structure
SEXT_PRINTER_DEF.

INVALID_INPUT_TRAY
The specified input tray is not known to the system. Check specification of structure
SEXT_PRINTER_DEF.
- 36 -
BC-XOM Extension for Printer Administration

INVALID_PRINT_OPTION
The specified print option is not known to the system or not valid for the specified device type.

IS_LOCKED
The associated printer is currently being edited.

INVALID_DUP_COPY_SETTING
The specified duplication copy parameter is invalid. Check specification of structure
SEXT_PRINTER_DEF.

DEVICE_FLUSH_FAILED
The system could not flush the printer definition to other system instances. The associated printer
has been created but it is currently known only to the NW system instance the RFC has connected
to.

DB_OPERATION_FAILED
The printer could not be created due to an database operation problem.

CASC_DEVTYPE_ON_NON_UC_SYSTEM
The specified device type supports cascading fonts and is not suitable for this non Unicode system.

UNKNOWN_ERROR
An unspecified error has occurred. The associated printer has been created or not. Availability of the
printer should be checked with Function Call SXMI_XOM_PRINTER_QUERY. In case that the
printer has not been created the printer creation operation should be repeated. In case that the
printer was created a printer change operation should be performed.
Description:
This function module creates an OMS printer specified in parameter PRNT_DEF on the executing SAP NW
system. The printer will be assigned to the LOMS definition specified in attribute PALOMS of parameter
PRNT_DEF.
Required attributes of parameter PRNT_DEF are:

NAME:
Long name of the printer.

PADEST:
Short name of the printer.

PAMSSERVER:
Name of the associated spool server.

PALOMS:
Name of the associated LOMS.

PATYPE:
Device type of associated printer.
For possible values of parameter ADDITIONAL_SETTINGS, see 4.2.2.5.6 .
4.3.1.8
Printer Definition Deletion
Function Module: SXMI_XOM_PRINTER_DELETE.
Import Parameters:
Parameter name
Parameter type
ROMS
SEXT_ROMS
- 37 -
BC-XOM Extension for Printer Administration
PRNT_DEF
SEXT_PRINTER_DEF
Export Parameters:
None.
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the provided ROMS is not known.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.

NOT_AUTHORIZED
The RFC user has not sufficient authorization to perform the intended operation. Needed
authorization: Autorization Object: S_RFC (Field: SXOM), S_ADMI_FCD (Field SPAD).

PRINTER_UNKNOWN
The specified printer could not be found on the system. Note that both short name and long name of
the printer have to match.

FOREIGN_ROMS
The specified printer does not belong to the specified ROMS.

JOBS_PENDING
The specified printer has still print jobs pending.

UNKNOWN_ERROR
An unspecified error has occurred. It can not be guaranteed that the associated printer has been
deleted. Check for printer existence with Function Module SXMI_XOM_PRINTER_QUERY and
repeat the delete operation if indicated.

IS_LOCKED
The printer is currently being edited.

USED_IN_DEVICE_POOL
The printer is still being used in a device pool.

DEVICE_FLUSH_FAILED
The printer has been deleted. But the broadcast to other NW instances failed.

NAME_AMBIGUOUS
The printer could not be deleted because the printer name referes to more than one printer in the
database. Note that this may happen if the printers long or short name have been modified in SPAD
or in the database directly using invalid charactes.

USED_IN_PAL
The printer could not be deleted because it is still used in the central printer distribution tool (PAL).
Description:
This function module will remove a printer definition from the executing SAP NW system.
Existing spool requests will be deleted.
If there are print request pending on this printer an error will be issued and the printer will not be deleted.
- 38 -
BC-XOM Extension for Printer Administration
Required attributes of parameter PRNT_DEF are:

NAME:
Long name of the printer.

PADEST:
Short name of the printer.
4.3.1.9
Printer Definition Modification
Function Module: SXMI_XOM_PRINTER_CHANGE.
Import Parameters:
Parameter name
Parameter type
ROMS
SEXT_ROMS
PRNT_DEF
SEXT_PRINTER_DEF
ADDITIONAL_SETTINGS
SEXT_DEVICE_ATTRIBUTES
Export Parameters:
None.
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the provided ROMS is not known.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.

NOT_AUTHORIZED
The RFC user has not sufficient authorization to perform the intended operation. Needed
authorization: Autorization Object: S_RFC (Field: SXOM), S_ADMI_FCD (Field SPAD).

PRINTER_UNKNOWN
The specified printer does not exist in the system. Note that printer long name and printer short
name have to match.

INVALID_PRINTER_LONG_NAME
The specified printer long name was incorrect. Allowed characters:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_-.:() '.

INVALID_PRINTER_SHORT_NAME
The specified printer short name was incorrect. Allowed characters:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_-.:() '

LOMS_UNKNOWN
The specified LOMS name is not known to the system.

ROMS_LOMS_MISMATCH
The specified LOMS name does not belong to the ROMS name provided.

DEVTYPE_UNKNOWN
The specified device type is not known to the system.
- 39 -
BC-XOM Extension for Printer Administration

SPOOL_SERVER_UNKNOWN
The specified spool server is not known to the system.

INVALID_COVER_PAGE_LANGUAGE
The specified cover page language is not known to the system. Check specification of structure
SEXT_PRINTER_DEF.

INVALID_PRINTMODE
The specified printmode is not known to the system. Check specification of structure
SEXT_PRINTER_DEF.

INVALID_INPUT_TRAY
The specified input tray is not known to the system. Check specification of structure
SEXT_PRINTER_DEF.

INVALID_PRINT_OPTION
The specified print option is not known to the system or not valid for the specified device type.

IS_LOCKED
The associated printer is being edited.

INVALID_DUP_COPY_SETTING
The specified duplication copy parameter is invalid. Check specification of structure
SEXT_PRINTER_DEF.

DEVICE_FLUSH_FAILED
The system could not flush the printer definition to other system instances. The associated printer
has been updated but changes are currently known only to the NW system instance the RFC has
connected to.

DB_OPERATION_FAILED
The printer could not be updated due to a database problem.

CASC_DEVTYPE_ON_NON_UC_SYSTEM
The specified device type supports cascading fonts and is not suitable for this non Unicode system.

UNKNOWN_ERROR
An unspecified error has occurred. The associated printer has been updated or not. The definition of
the printer should be checked with function module SXMI_XOM_PRINTER_QUERY. In case that the
printer has not been updated the updated operation should be repeated.
Description:
This function module will change a printer definition on the executing SAP NW system.
Required attributes of parameter PRNT_DEF are:

NAME:
Long name of the printer.

PADEST:
Short name of the printer.

PAMSSERVER:
Name of the associated spool server.

PALOMS:
Name of the associated LOMS.

PATYPE:
Device type of associated printer.
4.3.1.10 PAL Group Retrieval
Function Module: SXMI_XOM_PAL_GROUPS_QUERY
- 40 -
BC-XOM Extension for Printer Administration
Export Parameters:
Parameter name
Parameter type
PRINTER_GROUPS
SEXT_PAL_PRINTER_GRP_TABLE
TARGET_SYSTEM_GROUPS
SEXT_TARGET_SYSTEM_GRP_TABLE
Exceptions:

NOT_LOGGED_ON
No XMI logon was performed before performing this action.
Description:
This function module lists the available PAL printer and target system groups.
4.3.2
OMS Definition Maintenance
4.3.2.1
SAP Application Server Information Retrieval
Function Module: SXMI_XOM_APPSRV_QUERY.
Import Parameters:
Parameter name
Parameter type
ROMS
SEXT_ROMS
Export Parameters:
Parameter name
Parameter type
APPSRV
SEXT_INST_TAB
Tables:
None.
Exceptions:

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.
Description:
This function module lists the available instances of a SAP NW system.
4.3.2.2
ROMS Definition
4.3.2.2.1 Definition Retrieval
Function Module: SXMI_XOM_ROMS_QUERY.
Import Parameters:
Parameter name
Parameter type
ROMS
SEXT_ROMS
Export Parameters:
- 41 -
BC-XOM Extension for Printer Administration
Parameter name
Parameter type
ROMS_DEF
SEXT_ROMS_DEF
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the provided ROMS is not known.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.

INVALID_ROMS_NAME
The ROMS name specified contains invalid characters. Allowed characters are:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_-.:() '.
Description:
This function module will return the definition of a ROMS in the SAP NW system.
4.3.2.2.2 Definition Creation
Function Module: SXMI_XOM_ROMS_CREATE.
Import Parameters:
Parameter name
Parameter type
ROMS_DEF
SEXT_ROMS_DEF
Export Parameters:
None.
Tables:
None.
Exceptions:

INVALID_ROMS_NAME
The name of the ROMS provided is not valid. Valid characters are:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_-.:() '.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.

NOT_AUTHORIZED
The user is not authorized to perform the required operation. Needed authorization: Autorization
Object: S_RFC (Field: SXOM), S_ADMI_FCD (Field SPAD).

ROMS_ALREADY_EXISTS
An equally named ROMS definition already exists in the system. A create operation therefore cannot
be performed.
- 42 -
BC-XOM Extension for Printer Administration

STARTINST_UNKNOWN
The specified startinstance is not known. The create operation cannot be performed.

IS_LOCKED
The ROMS definition is being edited.

DB_OPERATION_FAILED
The ROMS definition could not be written to the database.

ROMS_FLUSH_FAILED
The transportation of the ROMS definition to other application server instances of this NW system
failed. The ROMS definition has been created but failed to be transported to all application server
instances.

ROMS_INTERFACE_MISSING
Neither a RFC nor an command line interface was specified in the ROMS definition.

UNKNOWN_ERROR
An unknown error has occurred. Creation or flush of the ROMS definition cannot be guaranteed. In
this case it is suggested to check the creation of the associated ROMS definition via Function
Module SXMI_XOM_ROMS_QUERY and to perform the creation or update action if necessary.
Description:
This function module creates a ROMS definition on the SAP NW system.
An existing ROMS definition will not be overwritten. In this case this function module will return with an error.
NOTE: A ROMS definition has to be created before an associated LOMS definition can be created.
4.3.2.2.3 Definition Deletion
Function Module: SXMI_XOM_ROMS_DELETE.
Import Parameters:
Parameter name
Parameter type
ROMS
SEXT_ROMS
Export Parameters:
None.
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the provided ROMS is not known.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.

NOT_AUTHORIZED
The user is not authorized to perform the required operation. Needed authorization: Autorization
Object: S_RFC (Field: SXOM), S_ADMI_FCD (Field SPAD).
- 43 -
BC-XOM Extension for Printer Administration

LOMS_STILL_EXISTS
At least one LOMS is still existing that refers to this ROMS.

IS_LOCKED
The ROMS is being used.

DB_OPERATION_FAILED
The delete databse operation failed for unknown reason. It is suggested to repeat the delete
operation.

ROMS_FLUSH_FAILED
The delete operation has been completed but there was an error updating other application server
instances on the delete operation of the ROMS.

UNKNOWN_ERROR
An unknown error has occurred. Deletion of ROMS cannot be guaranteed. It is suggested to check
the ROMS existence again with Function Module SXMI_XOM_ROMS_QUERY and re-perform the
deletion if necessary.
Description:
This function module will remove a ROMS definition from the executing SAP NW system.
If there are LOMS definitions still associated to this ROMS an error will be issued and the ROMS definition
will not be deleted.
4.3.2.2.4 Definition Modification
Function Module: SXMI_XOM_ROMS_CHANGE.
Import Parameters:
Parameter name
Parameter type
ROMS_DEF
SEXT_ROMS_DEF
Export Parameters:
None.
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the provided ROMS is not known.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.

NOT_AUTHORIZED
The user is not authorized to perform the required operation. Needed authorization: Autorization
Object: S_RFC (Field: SXOM), S_ADMI_FCD (Field SPAD).

IS_LOCKED
The ROMS is currently being edited.

DB_OPERATION_FAILED
The ROMS definition could not be updated in the database. It is suggested to re-perform the update
operation.
- 44 -
BC-XOM Extension for Printer Administration

ROMS_FLUSH_FAILED
The update operation was performed successfully but could not be propagated to other application
server instances of the system. It is suggested to re-perform the update operation.

CANNOT_DELETE_JOB_QUERY
The ROMS definition could not be updated. In the existing ROMS definition the flag JOB_QUERY
was set. The update operation tried to unset this flag. This was not possible because at least one
associated LOMS definition still existed with this flag set.

CANNOT_DELETE_CALLB_JOBS
The ROMS definition could not be updated. In the existing ROMS definition the flag CALLB_JOBS
was set. The update operation tried to unset this flag. This was not possible because at least one
associated LOMS definition still existed with this flag set.

CANNOT_DELETE_CALLB_DEVS
The ROMS definition could not be updated. In the existing ROMS definition the flag CALLB_DEVS
was set. The update operation tried to unset this flag. This was not possible because at least one
associated LOMS definition still existed with this flag set.

CANNOT_DELETE_USE_POLL
The ROMS definition could not be updated. In the existing ROMS definition the flag USE_POLL was
set. The update operation tried to unset this flag. This was not possible because at least one
associated LOMS definition still existed with this flag set.

CANNOT_DELETE_JOB_CANCEL
The ROMS definition could not be updated. In the existing ROMS definition the flag JOB_CANCEL
was set. The update operation tried to unset this flag. This was not possible because at least one
associated LOMS definition still existed with this flag set.

CANNOT_DELETE_DEV_QUERY
The ROMS definition could not be updated. In the existing ROMS definition the flag DEV_QUERY
was set. The update operation tried to unset this flag. This was not possible because at least one
associated LOMS definition still existed with this flag set.

CANNOT_DELETE_RFC_INTFCE
The ROMS definition could not be updated. In the existing ROMS definition the flag RFC_INTFCE
was set. The update operation tried to unset this flag. This was not possible because at least one
associated LOMS definition still existed with this flag set.

CANNOT_DELETE_CMD_INTFCE
The ROMS definition could not be updated. In the existing ROMS definition the flag CMD_INTFCE
was set. The update operation tried to unset this flag. This was not possible because at least one
associated LOMS definition still existed with this flag set.

ROMS_INTERFACE_MISSING
The updated ROMS definition would contain neither the RFC_INTFCE flag nor the CMD_INFCE flag
set to true.

UNKNOWN_ERROR
An unknown error has occurred. The success of the update operation can not be guaranteed. It is
suggested to check the ROMS defintition with Function Module SXMI_XOM_ROMS_QUERY and reperfrom the update operation if necessary.
Description:
This function module will change a ROMS definition on the executing SAP NW system.
4.3.2.3
LOMS Definition
- 45 -
BC-XOM Extension for Printer Administration
4.3.2.3.1 Definition Retrieval
Function Module: SXMI_XOM_LOMS_QUERY.
Import Parameters:
Parameter name
Parameter type
ROMS
SEXT_ROMS
Export Parameters:
Parameter name
Parameter type
LOMS_DEF
SEXT_LOMS_DEF_TAB
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the provided ROMS is not known.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.

INVALID_LOMS_NAME
The specified loms name is not valid. Valid characters are:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_-.:() '.
Description:
This function module will return the definition of a LOMS in the SAP NW system. The function module will
return a list of LOMS definitions associated to a specified ROMS.
4.3.2.3.2 Definition Creation
Function Module: SXMI_XOM_LOMS_CREATE.
Import Parameters:
Parameter name
Parameter type
LOMS_DEF
SEXT_LOMS_DEF
Export Parameters:
None.
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the provided ROMS is not known.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.
- 46 -
BC-XOM Extension for Printer Administration

INVALID_LOMS_NAME
The specified loms name is not valid. Valid characters are:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_-.:() '.

NOT_AUTHORIZED
The user is not authorized to perform the required operation. Needed authorization: Autorization
Object: S_RFC (Field: SXOM), S_ADMI_FCD (Field SPAD).

ALREADY_EXISTS
The specified LOMS already exists.

CMDSERVER_UNKNOWN
The provided command server is not known to the system.

CMDSERVER_NOT_SPOO
The provided command server has no spool work process.

CMDSERVER_REQUIRED
The flag CMD_INTFCE has been set but no command server has been provided.

CALLBACK_TARGET_UNKNOWN
The specified callback target is not known to the system.

CALLBACK_TARGET_REQUIRED
The flag CALLB_JOBS or CALLB_DEVS has been set but no callback target has been provided.

NO_INTERFACE_SPECIFIED
Neither the flag CMD_INTFCE nor the flag RFC_INTFCE has been set.

INTERFACE_TWICE_SPECIFIED
The flags CMD_INTFCE and RFC_INTFCE have been set simultaneously. A LOMS can only
support on operation mode at a time.

INVALID_FLAG_RFC_INTFCE
The flag RFC_INTFCE has been set although the associated ROMS definition does not allow this
operation mode (i.e. the ROMS flag RFC_INTFCE has not been set).

INVALID_FLAG_CMD_INTFCE
The flag CMD_INTFCE has been set although the associated ROMS definition does not allow this
operation mode (i.e. the ROMS flag CMD_INTFCE has not been set).

INVALID_FLAG_DEV_QUERY
The flag DEV_QUERY has been set although the associated ROMS definition does not allow device
query (i.e. the ROMS flag DEV_query has not been set).

INVALID_FLAG_USE_POLL
The flag USE_POLL has been set although the associated ROMS definition does not allow job
polling (i.e. the ROMS flag POLL_JOBS has not been set).

INVALID_FLAG_CALLB_DEVS
The flag CALLB_DEVS has been set although the associated ROMS definition does not allow device
callback (i.e. the ROMS flag CALLB_DEVS has not been set).

INVALID_FLAG_JOB_QUERY
The flag JOB_QUERY has been set although the assocated ROMS definition does not allow job
query (i.e. the ROMS flag JOB_QUERY has not been set).

INVALID_FLAG_JOB_CANCEL
The flag JOB_CANCEL has been set although the associated ROMS definition does not allow job
cancel (i.e. the ROMS flag JOB_CANCEL has not been set).

INVALID_FLAG_CALLB_JOBS
The flag CALLB_JOBS has been set although the associated ROMS definition does not allow job
status callback (i.e. the ROMS flag CALLB_JOBS has not been set).

INVALID_FLAG_USE_FRFC
The flag USE_FRFC was specified. Transfer of the print data stream via RFC is currently not
supported.
- 47 -
BC-XOM Extension for Printer Administration

NO_FLAG_USE_FILE_SPECIFIED
The flag USE_FILE was not specified. Currently file transfer is the only way to transfer the print data
stream.

INVALID_CLASS
The provided event report level in CLASS is not valid. See field CLASS of structure
SEXT_LOMS_DEF.

IS_LOCKED
The LOMS is being edited.

DB_OPERATION_FAILED
The creation of the specified LOMS did not succeed due to database problems. Try to reperform the
creation action.

LOMS_FLUSH_FAILED
The associated LOMS definition has been created but failed to be transported to other application
server instances. Try to update the LOMS definition via function module
SXMI_XOM_LOMS_CHANGE or flush the LOMS manually from transaction SPAD.

CALLB_AND_POLLING_SET
The value of the mutual exclusive parameters USE_POLL and CALLB_JOBS are both set to true.

UNKNOWN_ERROR
An unknown error has occurred. The success of the create operation can not be guaranteed. It is
suggested to check the LOMS defintition with Function Module SXMI_XOM_LOMS_QUERY and reperfrom the create operation if necessary.
Description:
This function module creates a LOMS definition on the SAP NW system.
An existing LOMS definition will not be overwritten. In this case this function module will return with an error.
4.3.2.3.3 Definition Deletion
Function Module: SXMI_XOM_LOMS_DELETE.
Import Parameters:
Parameter name
Parameter type
LOMS
SEXT_LOMS_DEF
ROMS
SEXT_ROMS
Export Parameters:
None.
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the provided ROMS is not known.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.

INVALID_LOMS_NAME
The specified LOMS name is not valid. Valid characters are:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_-.:() '.
- 48 -
BC-XOM Extension for Printer Administration

INVALID_ROMS_NAME
The specified ROMS name is not valid. Valid characters are:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_-.:() '.

LOMS_UNKNOWN
The specified LOMS is not known by the system.

PRINTER_STILL_EXISTS
At least one printer exists in the system attached to this LOMS.

COMMAND_SET_STILL_EXISTS
At least one command set associated to this LOMS still exists in the system.

IS_LOCKED
The LOMS is being edited.

DB_OPERATION_FAILED
The deletion of the specified LOMS did not succeed due to database problems. Try re-perform the
deletion action.

LOMS_FLUSH_FAILED
The associated LOMS definition has been deleted but failed to be transported to other application
server instances.

UNKNOWN_ERROR
An unknown error has occurred. The success of the delete operation can not be guaranteed. It is
suggested to check the LOMS defintition with function module SXMI_XOM_LOMS_QUERY and to
reperfrom the delete operation if necessary.
Description:
This function module will remove a LOMS definition from the executing SAP NW system.
NOTE: If there are printers or command sets still associated to this LOMS an error will be issued and the
LOMS definition will not be deleted.
4.3.2.3.4 Definition Modification
Function Module: SXMI_XOM_LOMS_CHANGE.
Import Parameters:
Parameter name
Parameter type
LOMS_DEF
SEXT_LOMS_DEF
Export Parameters:
None.
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the provided ROMS is not known.

LOMS_UNKNOWN
The name of the provided LOMS is not known to the system.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.
- 49 -
BC-XOM Extension for Printer Administration

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.

INVALID_LOMS_NAME
The specified loms name is not valid. Valid characters are:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_-.:() '.

NOT_AUTHORIZED
The user is not authorized to perform the required operation. Needed authorization: Autorization
Object: S_RFC (Field: SXOM), S_ADMI_FCD (Field SPAD).

CMDSERVER_UNKNOWN
The provided command server is not known to the system.

CMDSERVER_NOT_SPOO
The provided command server has no spool work process.

CMDSERVER_REQUIRED
The flag CMD_INTFCE has been set but no command server has been provided.

CALLBACK_TARGET_UNKNOWN
The specified callback target is not known to the system.

CALLBACK_TARGET_REQUIRED
The flag CALLB_JOBS or CALLB_DEVS has been set but no callback target has been provided.

NO_INTERFACE_SPECIFIED
Neither the flag CMD_INTFCE nor the flag RFC_INTFCE has been set.

INTERFACE_TWICE_SPECIFIED
The flags CMD_INTFCE and RFC_INTFCE have been set simultaneously. A LOMS can only
support on operation mode at a time.

INVALID_FLAG_RFC_INTFCE
The flag RFC_INTFCE has been set although the associated ROMS definition does not allow this
operation mode (i.e. the ROMS flag RFC_INTFCE has not been set).

INVALID_FLAG_CMD_INTFCE
The flag CMD_INTFCE has been set although the associated ROMS definition does not allow this
operation mode (i.e. the ROMS flag CMD_INTFCE has not been set).

INVALID_FLAG_DEV_QUERY
The flag DEV_QUERY has been set although the associated ROMS definition does not allow device
query (i.e. the ROMS flag DEV_QUERY has not been set).

INVALID_FLAG_USE_POLL
The flag USE_POLL has been set although the associated ROMS definition does not allow job
polling (i.e. the ROMS flag POLL_JOBS has not been set).

INVALID_FLAG_CALLB_DEVS
The flag CALLB_DEVS has been set although the associated ROMS definition does not allow device
callback (i.e. the ROMS flag CALLB_DEVS has not been set).

INVALID_FLAG_JOB_QUERY
The flag JOB_QUERY has been set although the assocated ROMS definition does not allow job
query (i.e. the ROMS flag JOB_QUERY has not been set).

INVALID_FLAG_JOB_CANCEL
The flag JOB_CANCEL has been set although the associated ROMS definition does not allow job
cancel (i.e. the ROMS flag JOB_CANCEL has not been set).

INVALID_FLAG_CALLB_JOBS
The flag CALLB_JOBS has been set although the associated ROMS definition does not allow job
status callback (i.e. the ROMS flag CALLB_JOBS has not been set).

INVALID_FLAG_USE_FRFC
The flag USE_FRFC was specified. Transfer of the print data stream via RFC is currently not
supported.
- 50 -
BC-XOM Extension for Printer Administration

NO_FLAG_USE_FILE_SPECIFIED
The flag USE_FILE was not specified. Currently file transfer is the only way to transfer the print data
stream.

INVALID_CLASS
The provided event report level in CLASS is not valid. See field CLASS of structure
SEXT_LOMS_DEF.

IS_LOCKED
The LOMS is being edited.

DB_OPERATION_FAILED
The update of the specified LOMS did not succeed due to database problems. Try to reperform the
update action.

LOMS_FLUSH_FAILED
The associated LOMS definition has been updated but failed to be transported to other application
server instances. Try to update the LOMS definition again or flush the LOMS manually from
transaction SPAD.

CALLB_AND_POLLING_SET
Callback and polling have been set although they are mutual exclusive.

UNKNOWN_ERROR
An unknown error has occurred. The success of the create operation can not be guaranteed. It is
suggested to check the LOMS defintition with Function Module SXMI_XOM_LOMS_QUERY and reperfrom the create operation if necessary.
Description:
This function module will change a LOMS definition on the executing SAP NW system.
4.3.2.4
Command Set Definition
4.3.2.4.1 Definition Retrieval
Function Module: SXMI_XOM_CMDS_QUERY.
Import Parameters:
Parameter name
Parameter type
LOMS
SEXT_LOMS
Export Parameters:
Parameter name
Parameter type
CMDS
SEXT_CMD_DEF _TAB
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the ROMS assoziated with the provided LOMS is unknown.

LOMS_UNKNOWN
The name of the provided LOMS is not known to the system.
- 51 -
BC-XOM Extension for Printer Administration

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.

INVALID_LOMS_NAME
The specified loms name is not valid. Valid characters are:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_-.:() '.
Description:
This function module will return the definition of a set of command sets associated to a LOMS.
4.3.2.4.2 Definition Creation
Function Module: SXMI_XOM_CMDS_CREATE.
Import Parameters:
Parameter name
Parameter type
LOMS
SEXT_LOMS
CMDS
SEXT_CMD_DEF
Export Parameters:
None.
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the ROMS assoziated with the provided LOMS is unknown.

LOMS_UNKNOWN
The name of the provided LOMS is not known to the system.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.

INVALID_LOMS_NAME
The specified loms name is not valid. Valid characters are:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_-.:() '.

NOT_AUTHORIZED
The user is not authorized to perform the required operation. Needed authorization: Autorization
Object: S_RFC (Field: SXOM), S_ADMI_FCD (Field SPAD).

INVALID_LOGICAL_COMMAND
The specified logical command (field LCMD) is not valid. See specification of structure
SEXT_CMD_DEF.

COMMAND_ALREADY_EXISTS
A command set already exists for the specified combination of operating system, logical command
and LOMS (field OPSYS, LCMD and LNAME of structure SEXT_CMD_DEF).

IS_LOCKED
The LOMS is being edited.

DB_OPERATION_FAILED
The command set has not been created due to database problems. Try to recreate the command
set.
- 52 -
BC-XOM Extension for Printer Administration

LOMS_FLUSH_FAILED
The command set has been created but failed to be transported to other application server instances
of the system. Try to update the command set via Function Module SXMI_XOM_CMDS_CHANGE of
manually flush the associated LOMS definition in transaction SPAD.

UNKNOWN_ERROR
An unknown error has occurred. Check the existence of the associated command set via function
module SXMI_XOM_CMDS_QUERY and reperform the creation action if necessary.
Description:
This function module creates a command set associated to s LOMS definition on the SAP NW system.
4.3.2.4.3 Definition Deletion
Function Module: SXMI_XOM_CMDS_DELETE.
Import Parameters:
Parameter name
Parameter type
LOMS
SEXT_LOMS
CMDS
SEXT_CMD_DEF
Export Parameters:
None.
Exceptions:

ROMS_UNKNOWN
The name of the ROMS assoziated with the provided LOMS is unknown.

LOMS_UNKNOWN
The name of the provided LOMS is not known to the system.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.

INVALID_LOMS_NAME
The specified loms name is not valid. Valid characters are:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_-.:() '.

NOT_AUTHORIZED
The user is not authorized to perform the required operation. Needed authorization: Autorization
Object: S_RFC (Field: SXOM), S_ADMI_FCD (Field SPAD).

INVALID_LOGICAL_COMMAND
The specified logical command (field LCMD) is not valid. See specification of structure
SEXT_CMD_DEF.

COMMAND_DOES_NOT_EXIST
A command set does not exist for the specified combination of operating system, logical command
and LOMS (field OPSYS, LCMD and LNAME of structure SEXT_CMD_DEF).

IS_LOCKED
The LOMS is being edited.

DB_OPERATION_FAILED
The command set has not been deleted due to database problems. Try to delete the command set
again.
- 53 -
BC-XOM Extension for Printer Administration

LOMS_FLUSH_FAILED
The command set has been deleted but failed to be transported to other application server instances
of the system. Manually flush the associated LOMS definition in transaction SPAD.

UNKNOWN_ERROR
An unknown error has occurred. Check the existence of the associated command set via Function
Module SXMI_XOM_CMDS_QUERY and re-perform the deletion action if necessary.
Tables:
None.
Description:
This function module will remove a command set definition for a specified LOMS on the executing SAP NW
system.
4.3.2.4.4 Definition Modification
Function Module: SXMI_XOM_CMDS_CHANGE.
Import Parameters:
Parameter name
Parameter type
LOMS
SEXT_LOMS
CMDS
SEXT_CMD_DEF
Export Parameters:
None.
Tables:
None.
Exceptions:

ROMS_UNKNOWN
The name of the ROMS assoziated with the provided LOMS is unknown.

LOMS_UNKNOWN
The name of the provided LOMS is not known to the system.

NOT_LOGGED_ON
No XMI logon was performed before performing this action.

CANT_LOG_ACTION
The intended action could not be logged by the XMI framework.

INVALID_LOMS_NAME
The specified loms name is not valid. Valid characters are:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_-.:() '.

NOT_AUTHORIZED
The user is not authorized to perform the required operation. Needed authorization: Autorization
Object: S_RFC (Field: SXOM), S_ADMI_FCD (Field SPAD).

INVALID_LOGICAL_COMMAND
The specified logical command (field LCMD) is not valid. See specification of structure
SEXT_CMD_DEF.

COMMAND_DOES_NOT_EXIST
The specified command set does not exist for the specified combination of operating system, logical
command and LOMS (field OPSYS, LCMD and LNAME of structure SEXT_CMD_DEF).
- 54 -
BC-XOM Extension for Printer Administration

IS_LOCKED
The LOMS is being edited.

DB_OPERATION_FAILED
The command set has not been updated due to db problems. Try to update the command set again.

LOMS_FLUSH_FAILED
The command set has been updated but failed to be transported to other application server
instances of the system. Try to update the command set again or manually flush the associated
LOMS definition in transaction SPAD.

UNKNOWN_ERROR
An unknown error has occurred. Check the existence of the associated command set via Function
Module SXMI_XOM_CMDS_QUERY and re-perform the update action if necessary.
Description:
This function module will change the commands in the command set specified in parameter CMDS.
- 55 -