printer

1. list

Input parameters:

Field name Description Type Size Mandatory
ROMS LOMS name Text 10 Yes
DEVICE Printer name Text 30 Yes

Output Parameters:

Field name Description Type Size
ROMS ROMS name Text 10
NAME Printer long name Text 30
PADEST Printer short name Text 4
PAMSSERVER Spool server name Text 20
PALOMS Associated LOMS name Text 6
PATYPE Device type of associated printer Text 8
PAMODEL Printer model name Text 20
PASTANDORT Printer location Text 64
PAMSG Status message or copy of location Text 64
PADEVGRP Authorization group for printers Text 30
PADISABLED Printer disabled Boolean 1
PAPROSNAME Printer long name for host spooler.

Printer name is in the host system.

Text 50
PADFLTSTTL Print SAP cover page Boolean 1
COVER_PAGE_LNG Language to be used for cover page: EN, DE, FR, etc. Text 2
PADFLTUTTL Print default host spool cover page.
  • <blank>: Does not print host spooler cover page.
  • D: Prints host spooler cover page as set at printer.
  • X: Always prints host spooler cover page.
Text 1
PAMONI Monitor using monitoring infrastructure Boolean 1
PASYNC Synchronization of printer requests Boolean 1
PADUPCOPY Create a print request for each copy
  • <blank>: Copies counter to host spool system.
  • X: Passes copies as separate Output Request in SAP system.
  • N: Passes only one copy to host spool system.
Text 1
COLORPRT Whether or not printer supports color printing Boolean 1
PRINTMODE Controls duplex printing
  • <blank>: uses printer defaults (default)
  • S: Simplex
  • D: Duplex
  • T: Tumble duplex
Text 1
INPUTTRAY Paper tray to use
  • <blank>: Default tray.
  • 1: Paper tray 1.
  • 2: Paper tray 2.
  • 3: Paper tray 3.
  • 4: Paper tray 4.
  • 5: Paper tray 5.
  • 6: Paper tray 6.
  • 7: Paper tray 7.
  • 8: Paper tray 8.
  • 9: Paper tray 9.
  • 10: Paper tray 10.
  • ENV: Paper tray for envelopes.
Text 3
TRAY1 Page format for printer tray 1 Text 8
TRAY2 Page format for printer tray 2 Text 8
TRAY3 Page format for printer tray 3 Text 8
TRAY4 Page format for printer tray 4 Text 8
TRAY5 Page format for printer tray 5 Text 8
TRAY6 Page format for printer tray 6 Text 8
TRAY7 Page format for printer tray 7 Text 8
TRAY8 Page format for printer tray 8 Text 8
TRAY9 Page format for printer tray 9 Text 8
TRAY10 Page format for printer tray 10 Text 8
TRAYMANU Page format for manual feed printer tray Text 8
TRAYENV Page format for envelope printer tray Text 8
TRAYMANENV Page format for manual feed envelope printer tray Text 8
FTRY1 Paper format of tray 1 enabled Boolean 1
FTRY2 Paper format of tray 2 enabled Boolean 1
FTRY3 Paper format of tray 3 enabled Boolean 1
FTRY4 Paper format of tray 4 enabled Boolean 1
FTRY5 Paper format of tray 5 enabled Boolean 1
FTRY6 Paper format of tray 6 enabled Boolean 1
FTRY7 Paper format of tray 7 enabled Boolean 1
FTRY8 Paper format of tray 8 enabled Boolean 1
FTRY9 Paper format of tray 9 enabled Boolean 1
FTRY10 Paper format of tray 10 enabled Boolean 1
FRTYM Paper format of the manual feed tray enabled Boolean 1
FTRYENV Paper format of the envelope tray enabled Boolean 1
FTRYMENV Paper format of the envelope tray enabled Boolean 1
Extended attributes
URDT Name of Unicode reference device type (URDT) Text 200
NO_UPE_FOR_ALI No UPE mechanism for ABAP lists ('X' or <blank>) Text 1
USE_ONLY_TTF Always embed fonts ('X' or <blank>) Text 1
UPE_PCL_T15 Use type-15 font header ('X' or <blank>) Text 1
PAXSHIFT Shift output horizontally (4-byte integer) Text 10
PAYSHIFT Shift output vertically (4-byte integer) Text 10
PAXSHUNIT Unit for horizontal shift (CH, MM, IN, CM, or PT) Text 2
PAYSHUNIT Unit for vertical shift (CH, MM, IN, CM, or PT) Text 2
S_PRINTTICKET Name of print ticket Text 200
S_PRINTTICKETDEF Marks as default print ticket ('X' or <blank>) Text 1
S_CPC_CS_PRG Name of PAL printer group Text 200
S_CPC_PRINTER Marks printer as central printer ('X' or <blank>) Text 1
Print options (disabled, pre-selected)

PATYPE dependent (zero, one, or more pair entries)

POPTION ID of the print option Text (0-9) 1
OPTNAME Name of the print option (in logon language) Text 60
IS_VENDORDEF If set, this print option is defined by a printer vendor, instead of the SAP system. Text 1
OPTTYPE Type of the print option
  • L: List
  • C: Checkbox
  • U: User string
Text 1
Print sub-options

POPTION dependent (zero, one, or more pair entries)

OPTVAL Integer value of a print option. In case of disabled options, when set to 0, all sub-options are disabled. Text (0-9) 1
VALUETEXT_EN English description of print option value. Text 60
    Note:
  • Print options, such as field name and values, are device dependent. Most devices do not have any print options.

Available paper types for TRAY1, TRAY2, etc.: ANY, DINA3, DINA4, DINA5, EXECUTIV, FORMDISP, INCH11, INCH12, INCH2, INCH4, INCH4C, INCH5, INCH6, INCH7, INCH8, JPHAGAKI, JPLEGAL1, JPLEGAL2, LEGAL, LETTER, LINE_21, LINE_22, MX-IMSS1, MX-IMSS2, MX-SHCP, ONHELP, ONLINE. Some options may not be available.

$ pdsap NPL list printer roms=dummy device="DUMMY Printer DL2130" 
            NAME: DUMMY Printer DL2130
          PADEST: 2130
      PAMSSERVER: lord10_NPL_00
          PALOMS: DUMMY
          PATYPE: DL2130
         PAMODEL: Latest model
      PASTANDORT: Right here, right now!
           PAMSG: A message here.
        PADEVGRP: Z
      PADISABLED: 
      PAPROSNAME: dummy.location
      PADFLTSTTL: X
  COVER_PAGE_LNG: EN
      PADFLTUTTL: D
          PAMONI: X
          PASYNC: X
       PADUPCOPY: N
        COLORPRT: X
       PRINTMODE: T
       INPUTTRAY: 1
           TRAY1: LETTER
           FTRY1: X
           TRAY2: 
           FTRY2: s
           TRAY3: 
           FTRY3: 
           TRAY4: 
           FTRY4: 
           TRAY5: 
           FTRY5: 
           TRAY6: 
           FTRY6: 
           TRAY7: 
           FTRY7: 
           TRAY8: 
           FTRY8: 
           TRAY9: 
           FTRY9: 
          TRAY10: 
          FTRY10: 
        TRAYMANU: INCH2
           FRTYM: X
         TRAYENV: INCH4
           FRTYM: X
      TRAYMANENV: INCH5
        FTRYMENV: X

||         PARAM: PAXSHUNIT
||         VALUE: MM
|
||         PARAM: PAYSHUNIT
||         VALUE: MM
|
||         PARAM: S_CPC_OMS_MAN 
||         VALUE: DUMMY

||       POPTION: 1
||       OPTNAME: Input Tray
||  IS_VENDORDEF: 
||       OPTTYPE: L
||||          OPTVAL      : 1
||||          VALUETEXT_EN: SSF (Single-Sheet Feeder)
|||
||||          OPTVAL      : 2
||||          VALUETEXT_EN: Tray 1
||||          disabled    : X
|||
||||          OPTVAL      : 3
||||          VALUETEXT_EN: Tray 2
||||          pre-selected: X
|
||       POPTION: 3
||       OPTNAME: Print in Color
||  IS_VENDORDEF: 
||       OPTTYPE: L
||      disabled: X
||||          OPTVAL      : 1
||||          VALUETEXT_EN: Print in Color
|||
||||          OPTVAL      : 2
||||          VALUETEXT_EN: Print in Grayscale
|
||       POPTION: 4
||       OPTNAME: Double-sided Printing
||  IS_VENDORDEF: 
||       OPTTYPE: L
||||          OPTVAL      : 1
||||          VALUETEXT_EN: Duplex Long Edge Binding
||||          disabled    : X
|||
||||          OPTVAL      : 2
||||          VALUETEXT_EN: Duplex Short Edge Binding
||||          pre-selected: X
|||
||||          OPTVAL      : 3
||||          VALUETEXT_EN: Simplex
||||          disabled    : X

2. create

Input parameters:

Field name Description Type Size Mandatory
ROMS Name of ROMS Text 10 Yes
NAME Printer long name Text 30 Yes
PADEST Printer short name Text 4 Yes
PAMSSERVER Spool server name Text 20 Yes
PALOMS Associated LOMS name Text 6 Yes
PATYPE Device type of associated printer Text 8 No
PAMODEL Printer model name Text 20 No
PASTANDORT Printer location Text 64 No
PAMSG Status message Text 64 No
PADEVGRP Authorization group for printers Text 30 No
PADISABLED Printer disabled Boolean 1 No
PAPROSNAME Printer long name for host spooler.

Printer name is in the host system.

Text 50 Yes
PADFLTSTTL Print SAP cover page Boolean 1 No
COVER_PAGE_LNG Language to be used for cover page (EN, DE, FR, etc.) Text 2 No
PADFLTUTTL Print default host spool cover page.
  • <blank>: Does not print host spooler cover page.
  • D: Prints host spooler cover page as set at printer.
  • X: Always prints host spooler cover page.
Text 1 No
PAMONI Monitor using monitoring infrastructure Boolean 1 No
PASYNC Synchronization of requests of a printer Boolean 1 No
PADUPCOPY Create a print request for each copy:
  • <blank>: Copy counter to host spool system
  • X: Pass copies as separate Output Request in SAP system
  • N: Only pass one copy to host spool system
Text 1 No
COLORPRT Whether or not printer supports color printing Boolean 1 No
PRINTMODE Controls duplex printing:
  • <blank>: use printer defaults (default)
  • S: Simplex
  • D: Duplex
  • T: Tumble duplex
Text 1 No
INPUTTRAY Paper tray:
  • <blank>: Default tray.
  • 1: Paper tray 1.
  • 2: Paper tray 2.
  • 3: Paper tray 3.
  • 4: Paper tray 4.
  • 5: Paper tray 5.
  • 6: Paper tray 6.
  • 7: Paper tray 7.
  • 8: Paper tray 8.
  • 9: Paper tray 9.
  • 10: Paper tray 10.
  • ENV: Paper tray for envelopes.
Text 3 No
TRAY1 Page format for printer tray 1 Text 8 No
TRAY2 Page format for printer tray 2 Text 8 No
TRAY3 Page format for printer tray 3 Text 8 No
TRAY4 Page format for printer tray 4 Text 8 No
TRAY5 Page format for printer tray 5 Text 8 No
TRAY6 Page format for printer tray 6 Text 8 No
TRAY7 Page format for printer tray 7 Text 8 No
TRAY8 Page format for printer tray 8 Text 8 No
TRAY9 Page format for printer tray 9 Text 8 No
TRAY10 Page format for printer tray 10 Text 8 No
TRAYMANU Page format for manual feed printer tray Text 8 No
TRAYENV Page format for envelope printer tray Text 8 No
TRAYMANENV Page format for manual feed envelope printer tray Text 8 No
FTRY1 Paper format of tray 1 enabled Boolean 1 No
FTRY2 Paper format of tray 2 enabled Boolean 1 No
FTRY3 Paper format of tray 3 enabled Boolean 1 No
FTRY4 Paper format of tray 4 enabled Boolean 1 No
FTRY5 Paper format of tray 5 enabled Boolean 1 No
FTRY6 Paper format of tray 6 enabled Boolean 1 No
FTRY7 Paper format of tray 7 enabled Boolean 1 No
FTRY8 Paper format of tray 8 enabled Boolean 1 No
FTRY9 Paper format of tray 9 enabled Boolean 1 No
FTRY10 Paper format of tray 10 enabled Boolean 1 No
FRTYM Paper format of the manual feed tray enabled Boolean 1 No
FTRYENV Paper format of the envelope tray enabled Boolean 1 No
FTRYMENV Paper format of the envelope tray enabled Boolean 1 No
Extended attributes  
URDT Name of Unicode reference device type (URDT) Text 200 No
NO_UPE_FOR_ALI No UPE mechanism for ABAP lists ('X' or <blank>) Text 1 No
USE_ONLY_TTF Always embed fonts ('X' or <blank>) Text 1 No
UPE_PCL_T15 Use type-15 font header ('X' or <blank>) Text 1 No
PAXSHIFT Shift output horizontally (4-byte integer) Text 10 No
PAYSHIFT Shift output vertically (4-byte integer) Text 10 No
PAXSHUNIT Unit for horizontal shift (CH, MM, IN, CM, or PT) Text 2 No
PAYSHUNIT Unit for vertical shift (CH, MM, IN, CM, or PT) Text 2 No
S_PRINTTICKET Name of print ticket Text 200 No
S_PRINTTICKETDEF Marks as default print ticket ('X' or <blank>) Text 1 No
S_CPC_CS_PRG Name of PAL printer group Text 200 No
S_CPC_PRINTER Marks printer as central printer ('X' or <blank>) Text 1 No
Print options (disabled, pre-selected)

PATYPE dependent

 
ADD_S_POPTION Add pre-selected print option in format POPTION:OPTVAL [(0-9):(0-9)]. The option can be added multiple times. Text 3 No
ADD_D_POPTION Add disabled print option in format POPTION:0 or POPTION:OPTVAL [(0-9):(0-9)]. The option can be added multiple times. Text 3 No

    Note:
  • The only wildcard character supported is % and you can specify it as a placeholder in PADEST field value. Wildcard character _, underscore character, is not supported in PADEST field value.

    When the printer short name is already used, the pdsap command return the following error:

    ERROR: Short printer name 'PRT2' is in use. Enter a different short printer name
     or use one of the following: PRTA, PRTB, PRTC.

Available paper types for TRAY1, TRAY2, etc.: ANY, DINA3, DINA4, DINA5, EXECUTIV, FORMDISP, INCH11, INCH12, INCH2, INCH4, INCH4C, INCH5, INCH6, INCH7, INCH8, JPHAGAKI, JPLEGAL1, JPLEGAL2, LEGAL, LETTER, LINE_21, LINE_22, MX-IMSS1, MX-IMSS2, MX-SHCP, ONHELP, ONLINE. Some may not be available.

3. modify

Input parameters:

Field name Description Type Size Settable Mandatory
ROMS ROMS name Text 10 No Yes
NAME Printer long name Text 30 No Yes
PAMSSERVER Spool server name Text 20 Yes No
PALOMS Associated LOMS name Text 6 Yes No
PATYPE Device type of associated printer Text 8 Yes No
PAMODEL Printer model name Text 20 Yes No
PASTANDORT Printer location Text 64 Yes No
PAMSG Status message Text 64 Yes No
PADEVGRP Authorization group for printers Text 30 Yes No
PADISABLED Printer disabled Boolean 1 Yes No
PAPROSNAME Printer long name for host spooler.

Printer name is in the host system.

Text 50 Yes Yes
PADFLTSTTL Print SAP cover page Boolean 1 Yes No
COVER_PAGE_LNG Language to be used for cover page (EN, DE, FR, etc.) Text 2 Yes No
PADFLTUTTL Print default host spool cover page
  • <blank>: Does not print host spooler cover page.
  • D: Prints host spooler cover page as set at printer.
  • X: Always prints host spooler cover page.
Text 1 Yes No
PAMONI Monitor using monitoring infrastructure Boolean 1 Yes No
PASYNC Synchronization of requests of a printer Boolean 1 Yes No
PADUPCOPY Create a print request for each copy
  • <blank>: Copies counter to host spool system.
  • X: Passes copies as separate Output Request in SAP system.
  • N: Passes only one copy to host spool system.
Text 1 Yes No
COLORPRT Whether or not printer supports color printing Boolean 1 Yes No
PRINTMODE Controls duplex printing
  • <blank>: use printer defaults (default)
  • S: Simplex
  • D: Duplex
  • T: Tumble duplex
Text 1 Yes No
INPUTTRAY Paper tray to use
  • <blank>: Default tray.
  • 1: Paper tray 1.
  • 2: Paper tray 2.
  • 3: Paper tray 3.
  • 4: Paper tray 4.
  • 5: Paper tray 5.
  • 6: Paper tray 6.
  • 7: Paper tray 7.
  • 8: Paper tray 8.
  • 9: Paper tray 9.
  • 10: Paper tray 10.
  • ENV: Paper tray for envelopes.
Text 3 Yes No
TRAY1 Page format for printer tray 1 Text 8 Yes No
TRAY2 Page format for printer tray 2 Text 8 Yes No
TRAY3 Page format for printer tray 3 Text 8 Yes No
TRAY4 Page format for printer tray 4 Text 8 Yes No
TRAY5 Page format for printer tray 5 Text 8 Yes No
TRAY6 Page format for printer tray 6 Text 8 Yes No
TRAY7 Page format for printer tray 7 Text 8 Yes No
TRAY8 Page format for printer tray 8 Text 8 Yes No
TRAY9 Page format for printer tray 9 Text 8 Yes No
TRAY10 Page format for printer tray 10 Text 8 Yes No
TRAYMANU Page format for manual feed printer tray Text 8 Yes No
TRAYENV Page format for envelope printer tray Text 8 Yes No
TRAYMANENV Page format for manual feed envelope printer tray Text 8 Yes No
FTRY1 Paper format of tray 1 enabled Boolean 1 Yes No
FTRY2 Paper format of tray 2 enabled Boolean 1 Yes No
FTRY3 Paper format of tray 3 enabled Boolean 1 Yes No
FTRY4 Paper format of tray 4 enabled Boolean 1 Yes No
FTRY5 Paper format of tray 5 enabled Boolean 1 Yes No
FTRY6 Paper format of tray 6 enabled Boolean 1 Yes No
FTRY7 Paper format of tray 7 enabled Boolean 1 Yes No
FTRY8 Paper format of tray 8 enabled Boolean 1 Yes No
FTRY9 Paper format of tray 9 enabled Boolean 1 Yes No
FTRY10 Paper format of tray 10 enabled Boolean 1 Yes No
FRTYM Paper format of the manual feed tray enabled Boolean 1 Yes No
FTRYENV Paper format of the envelope tray enabled Boolean 1 Yes No
FTRYMENV Paper format of the envelope tray enabled Boolean 1 Yes No
URDT Name of Unicode reference device type (URDT) Text 200 Yes No
NO_UPE_FOR_ALI No UPE mechanism for ABAP lists ('X' or <blank>) Text 1 Yes No
USE_ONLY_TTF Always embed fonts ('X' or <blank>) Text 1 Yes No
UPE_PCL_T15 Use type-15 font header ('X' or <blank>) Text 1 Yes No
PAXSHIFT Shift output horizontally (4-byte integer) Text 10 Yes No
PAYSHIFT Shift output vertically (4-byte integer) Text 10 Yes No
PAXSHUNIT Unit for horizontal shift (CH, MM, IN, CM, or PT) Text 2 Yes No
PAYSHUNIT Unit for vertical shift (CH, MM, IN, CM, or PT) Text 2 Yes No
S_PRINTTICKET Name of print ticket Text 200 Yes No
S_PRINTTICKETDEF Marks as default print ticket ('X' or <blank>) Text 1 Yes No
S_CPC_CS_PRG Name of PAL printer group Text 200 Yes No
S_CPC_PRINTER Marks printer as central printer ('X' or <blank>) Text 1 Yes No
ADD_S_POPTION Add pre-selected print option in format POPTION:OPTVAL [(0-9):(0-9)]. The option can be added multiple times. Text 3 Yes No
DEL_S_POPTION Remove pre-selected print option in format POPTION:OPTVAL [(0-9):(0-9)]. The option can be added multiple times.

Because of limitations, the print options set when the SAP printer was created cannot be removed with this tool. You can only set additional print options. To remove print options use SAP NetWeaver SAPGUI.

Text 3 Yes No
ADD_D_POPTION Add disabled print option in format POPTION:0 or POPTION:OPTVAL [(0-9):(0-9)]. The option can be added multiple times. Text 3 Yes No
DEL_D_POPTION Remove disabled print option in format POPTION:0 or POPTION:OPTVAL [(0-9):(0-9)]. The option can be added multiple times.

Because of limitations, the print options set when the SAP printer was created cannot be removed with this tool. You can only set additional print options. To remove print options use SAP NetWeaver SAPGUI.

Text 3 Yes No

Available paper types for TRAY1, TRAY2, etc.: ANY, DINA3, DINA4, DINA5, EXECUTIV, FORMDISP, INCH11, INCH12, INCH2, INCH4, INCH4C, INCH5, INCH6, INCH7, INCH8, JPHAGAKI, JPLEGAL1, JPLEGAL2, LEGAL, LETTER, LINE_21, LINE_22, MX-IMSS1, MX-IMSS2, MX-SHCP, ONHELP, ONLINE. Some options may not be available.

4. delete

Input parameters:

Field name Description Type Size Mandatory
ROMS ROMS name Text 10 Yes
NAME Printer long name Text 30 Yes
PADEST Printer short name Text 4 Yes
    Note:
  • In SAP, boolean values for various field are: True for a value that is not empty, while False for an empty value.
  • When modifying an SAP object (ROMS, LOMS, etc.), any value not set by user on command line is retained as it is. To erase a value for a specific field, set its value to empty.