Вы находитесь на странице: 1из 72

Work Order Print Manager

User Manual
2009 Prometheus Group, Inc.

Work Order Print Manager User Manual

Table of Contents
Foreword

Part I Introduction

Part II Hardware and Software Requirements

Part III Functional Documentation

1 Print Manager...................................................................................................................................
Functions
9
Icons
..........................................................................................................................................................
Print
.........................................................................................................................................................
Preview (New
.........................................................................................................................................................
in 2008)
Refresh (obsolete)
.........................................................................................................................................................
Select all/Deselect
.........................................................................................................................................................
all
Expand/Collapse
.........................................................................................................................................................
All Folders
Save Selection
.........................................................................................................................................................
of Documents to Print
Cancel .........................................................................................................................................................
Help
.........................................................................................................................................................
Validate URL's
.........................................................................................................................................................
Previewing Induvidual
..........................................................................................................................................................
Documents
Selecting Printers
..........................................................................................................................................................
Configuration..........................................................................................................................................................
Option: Operation Level Printing (Version 2.00)

9
10
12
14
15
16
18
21
22
22
24
26
29

31

Part IV Technical Documentation

1 Adding WOPM
...................................................................................................................................
to the IW32 Enhancement Tab
31
2 Adding WOPM
...................................................................................................................................
Icon to IW32
48
3 Adding WOPM
...................................................................................................................................
to a list edit report
52
4 Installing the...................................................................................................................................
executable
52
5 Configuration
...................................................................................................................................
Options
54
6 Setting Up Shop
...................................................................................................................................
Papers
60
WOPM set up..........................................................................................................................................................
for SAPscripts
WOPM set up..........................................................................................................................................................
for Smart Forms

60
63

7 Release Notes
................................................................................................................................... 67
Version 2.00 ..........................................................................................................................................................
Version 2.01
.........................................................................................................................................................
Version 2.02
.........................................................................................................................................................
Version 2.03
.........................................................................................................................................................
Version 2.04
.........................................................................................................................................................
Version 2.05
.........................................................................................................................................................
Version 2.06
.........................................................................................................................................................
Version 2.07
.........................................................................................................................................................
/2.08
Version 2.09.........................................................................................................................................................
full transports
Version 2.10
.........................................................................................................................................................
Version 2.11
.........................................................................................................................................................
Version 2.12
.........................................................................................................................................................
Version 2.13
.........................................................................................................................................................

67
68
68
69
69
69
69
70
70
71
71
71
71

2009 Prometheus Group, Inc.

Contents

Version 2.14
.........................................................................................................................................................
- Full Transport
Version 2.15
.........................................................................................................................................................

Index

72
72

2009 Prometheus Group, Inc.

Work Order Print Manager User Manual

Introduction
This file can be downloaded as a PDF in this location: http://prometheusgroup.us/manuals/wopm/
WOPM.pdf.
The Work Order Print Manager (WOPM) streamlines the work order printing process by displaying all
documents related to a work order into a single screen. Work Order Print Manager gathers
documents on the work order itself, shop papers, functional location, equipment, materials, and
operations' document PRT's. The documents may be attached via object services or SAP DMS.
Documents are printed sequentially using a Windows executable file that sits on the end user's
desktop. This is our solution to one of the biggest problems with printing in standard SAP. Since SAP
uses asynchronous processing, smaller documents tend to be printed before larger documents without
regard to sequence. Print manager solves this issue by using Microsoft Windows to direct printing
traffic.
Also, note that no external servers are necessary to use print manager. The ABAP portion is delivered
as an SAP transport and an executable is installed on the user's computer.

Hardware and Software Requirements


Prometheus Group's software will work on your work station if the standard SAP front end is installed.
We enhance standard SAP by delivering a large amount content in a way, which is easy to use and
understand. While hardware is not a requirement, meeting these hardware specifications will greatly
enhance the overall user experience.
2009 Prometheus Group, Inc.

Hardware and Software Requirements

Recommended Hardware:
Screen resolution of 1280x1024 or better.
Work Order Print Manager is comprised of 2 software components. The ABAP component gathers,
previews, and displays the documents in a pop up screen. The ABAP programming also sends the
documents to local machine. The actual printing is handled with executable component. The
executable written in a programming language called C# . C# requires that Microsoft .NET Framework
2.0 is installed on any computer that will be running WOPM.
Required Software:
Microsoft .NET Framework 2.0
Windows 2000 or Windows XP with the latest service packs.

Functional Documentation
Using Work Order Print Manager is simple. There are two ways to call WOPM. The first way is to call
WOPM from a user exit on the work order header; the second way is selecting orders from a list edit
and pressing the print icon. From WOPM users may print, preview, and save selections for printing.
Note: Each installation may vary slightly. (i.e. the button text may be different, WOPM may be
attached to customer-specific transactions, etc).
To call Work Order Print Manager from IW32, click on the "Enhancement" tab and press the Work
Order Print Manager button.

2009 Prometheus Group, Inc.

Work Order Print Manager User Manual

Enhancement tab user exit with the print manager push button installed.

2009 Prometheus Group, Inc.

Functional Documentation

To call Work Order Print Manager from a list edit, select the order(s) you wish to print and press the
print icon.

2009 Prometheus Group, Inc.

Work Order Print Manager User Manual

After calling Work Order Print Manager you will see a pop-up. The pop up is in a tree format.
The top level of the tree expands into work orders.
o Work orders expand down into objects:
Shop papers
PRT documents
Equipment documents
Functional location documents
Material documents
Work order documents
Each object expands into individual documents for the object.
All work orders will at least have a shop paper folder. If a work order does not have any documents for
an object, the object folder is not displayed (see order 814400 below).

2009 Prometheus Group, Inc.

Functional Documentation

3.1

Print Manager Functions


In the following section we will cover WOPM functions in detail.

3.1.1

Icons
The following section describes each WOPM icon in detail.
Icon

2009 Prometheus Group, Inc.

Shortcu Description
t
Prints all selected documents from top to bottom as they are listed in
Ctrl + P
WOPM.
Shift + (Version 2.00): Preview the print package
F8

10

Work Order Print Manager User Manual

F5

(obsolete): Retrieves the current version of all documents.

F9

Select all check boxes for work order printing.

F7

Deselect all check boxes for work order printing.

Ctrl + F7 Expands all folders in the print manager pop up.


Ctrl + F8 Collapses all folders in the print manager pop up.
Shift + Saves the selection of documents to print.
F4
F12 Cancels and exits WOPM.
Shift + (Version 2.00):Takes user to the WOPM help manual
F1
Ctrl + F1 (Version 2.01):Validates URL links (i.e. \\server1\test.doc or H:\test.jpg)

3.1.1.1

Print
Pressing the print icon

will print the documents in the order they are listed in WOPM.

2009 Prometheus Group, Inc.

Functional Documentation

11

Version 2.00: All documents going to a specific printer are grouped into one PDF. This single PDF is
sent to the printer, this way other documents can not get inserted into your print package. Below is an
updated screen shot:

2009 Prometheus Group, Inc.

12

3.1.1.2

Work Order Print Manager User Manual

Preview (New in 2008)


Pressing the print icon

will allow the user to preview the document package as a PDF.

The resulting document is a single pdf that contains the 3 checked documents.

2009 Prometheus Group, Inc.

Functional Documentation

2009 Prometheus Group, Inc.

13

14

3.1.1.3

Work Order Print Manager User Manual

Refresh (obsolete)
Pressing refresh
retrieves any new documents added to the order and gets a current copy of all
the documents listed on screen. This button is only used when documents are actively being changed
or added just before creating a print package.
Below the refresh icon is pressed.

Pressing the refresh icon retrieves an additional document that was added in another SAP session.

2009 Prometheus Group, Inc.

Functional Documentation

3.1.1.4

Select all/Deselect all


The select all and deselect all icons all users to mass update the screen check boxes.
Note: A grey check box indicates an invalid link. These check boxes are modified.
Below is the effect of using the select all icon,

2009 Prometheus Group, Inc.

15

16

Work Order Print Manager User Manual

Below is the effect of using the deselect all icon,

3.1.1.5

Expand/Collapse All Folders


To expand and collapse the Work Order Print Manager file tree, users may use the following buttons:

2009 Prometheus Group, Inc.

Functional Documentation

Below is the effect of using the expand icon

Below is the effect of using the collapse icon

2009 Prometheus Group, Inc.

17

18

3.1.1.6

Work Order Print Manager User Manual

Save Selection of Documents to Print


Pressing the save icon
will save the current document selection for printing. The next time a user
takes the same order into WOPM, the previous document selections are defaulted in.
Version 2.00: The icon has been change to

Notice for the order no documents are selected for printing.

2009 Prometheus Group, Inc.

Functional Documentation

Next, shop papers 2010 and 2040 are selected and the save icon is pressed.

2009 Prometheus Group, Inc.

19

20

Work Order Print Manager User Manual

The next time this order is opened in WOPM, the previous selections are defaulted in.

2009 Prometheus Group, Inc.

Functional Documentation

3.1.1.7

21

Cancel
Pressing the cancel icon
order list edit.

2009 Prometheus Group, Inc.

returns you to the original transaction. This is usually IW32 or a work

22

3.1.1.8

Work Order Print Manager User Manual

Help
Pressing the help icon,
, takes you to the web version of this manual. The actual web address is
http://prometheusgroup.us/manuals/wopm/.
Note: Users will need access to the internet and corporate IT security policies also apply.

3.1.1.9

Validate URL's
Pressing this icon will validated URL's in the WOPM pop up screen. If a link is in valid the document
will be disabled. The status is normally set to inactive. If you set the status (active or inactive), it
remain if you are within the same SAP session; but not if you switch transactions.
Note: This process has been known to take a long time when using a VPN.

2009 Prometheus Group, Inc.

Functional Documentation

23

This WOPM screen has invalid documents, when checks are inactive these links look like active
ones.

If you toggle this icon to activate checks the bad links are deactivated.

2009 Prometheus Group, Inc.

24

3.1.2

Work Order Print Manager User Manual

Previewing Induvidual Documents


Users may preview documents by pressing "VIEW" to the right of the document.

The document will then be displayed on the computer via the default program for the document's file
type.

Version 2.00: The preview column now shows the actual location of the document for documents
saved as URL's. Any document that are generated or saved inside the SAP database (i.e. shop
papers and object service attachments) are listed as "Stored in SAP".
Version 2.00: Documents can also be previewed by double-clicking on the paper icon to the left of the
document.

Version 2.00: WOPM now validates URL's. If a bad URL exist the the checkbox and preview
capabilities are disabled. Below the users switched the document description with the actual URL in
the first file and got it right in the second file. The grey color in the check box is a visual indicatory that
the URL is a bad link.
2009 Prometheus Group, Inc.

Functional Documentation

2009 Prometheus Group, Inc.

25

26

3.1.3

Work Order Print Manager User Manual

Selecting Printers
The printers used in WOPM come from the list of printers installed on each user's computer. The
default printer from the user's front end machine is used to fill the printer column in Work Order Print
Manager. To change the printer for a particular document, click on the printer name to the right of the
document and select a printer from the list of printers. The document will now output to the selected
printer.
When starting WOPM, all documents are set to output to the user's Windows default printer.

Clicking on a printer from the printer column pop us a list of printers to select from. Making a selection
from the printer list will divert the document to the selected printer.

2009 Prometheus Group, Inc.

Functional Documentation

Version 2.00: Mass update printers. An mass update icon,


screen.

, has been added to Select Printer

To mass update printer take the following steps:


Step 1: select any printer. This takes you the "select printer" popup.

2009 Prometheus Group, Inc.

27

28

Work Order Print Manager User Manual

Step 2: Highlight the target printer and press the mass update icon.

Step 3: the result is that all printers are updated to the target printer.

2009 Prometheus Group, Inc.

Functional Documentation

3.1.4

29

Configuration Option: Operation Level Printing (Version 2.00)


Version 2.00: Operation level printing can be achieved by turning on the configuration switch
"SHOW_OPERATIONS" see the section "Configuration Options". Using operation level printing job
packages can be created for individual operations.
The column for order level printing remains; but several additional columns will appear for each
operation/sub-operation.

2009 Prometheus Group, Inc.

30

Work Order Print Manager User Manual

The document are output in the following sequence for each work order:

Note: The select all and deselect all option will only work for column "1".

2009 Prometheus Group, Inc.

Technical Documentation

31

Technical Documentation
Work Order Print Manager is a function module that can accept a list of SAP PM work orders for
printing. The function module may be called from any order or operation list edit. It may also be called
from IW32 with a single order number. The following section will cover how to integrate Work Order
Print Manager with IW32 using user exits and work order list edits. The section "Setting Up Shop
Papers" covers code modifications for SAPscript and Smart Form shop papers.

4.1

Adding WOPM to the IW32 Enhancement Tab


This is a step by step guide to activating the IW32 enhancement tab and adding a push button to call
the WOPM function module.

1. Enter transaction CMOD and create a new project.

2009 Prometheus Group, Inc.

32

Work Order Print Manager User Manual

2. Under the "Enhancement" section, add IWO10018 as an enhancement assignment.


.

2009 Prometheus Group, Inc.

Technical Documentation

3. Now, click the "Components" button. Under the "Components" section, double click into
EXIT_SAPLCOIH_018.

2009 Prometheus Group, Inc.

33

34

Work Order Print Manager User Manual

4. Double click into the include ZXWOCU15.

2009 Prometheus Group, Inc.

Technical Documentation

2009 Prometheus Group, Inc.

35

36

Work Order Print Manager User Manual

5. Copy and paste the following code to the include.


*----------------------------------------------------------------------*
*
INCLUDE ZXWOCU15
*
*----------------------------------------------------------------------*
EXPORT sap_caufvd_imp TO MEMORY ID 'YPG_IW18'.
CLEAR sy-ucomm.

6. Activate the program.

2009 Prometheus Group, Inc.

Technical Documentation

7. Back out to the enhancement screen and double click on EXIT_SAPLCOIH_019

8. Double click into include ZXWOCU16.

2009 Prometheus Group, Inc.

37

38

Work Order Print Manager User Manual

2009 Prometheus Group, Inc.

Technical Documentation

9. Copy and paste the following code into the include:


*----------------------------------------------------------------------*
*
INCLUDE ZXWOCU16
*
*----------------------------------------------------------------------*
FREE MEMORY ID 'YPG_IW18'.

10.Activate the program.

11.Back out to the enhancement screen and double click on the screen exit

2009 Prometheus Group, Inc.

39

40

Work Order Print Manager User Manual

12. Uncomment the sections of the code so that the screen's flow logic looks like this:

2009 Prometheus Group, Inc.

Technical Documentation

13. Double click into MODULE STATUS_0900. This takes you into the include ZXWOCO01.
14. Copy and past in the code below into the include file ZXWOCO01.
*----------------------------------------------------------------------*
***INCLUDE ZXWOCO01 .
*----------------------------------------------------------------------*
*&---------------------------------------------------------------------*
*&
Module STATUS_0900 OUTPUT
*&---------------------------------------------------------------------*
*
text
*----------------------------------------------------------------------*
module STATUS_0900 output.
*Prometheus - Begin
SET TITLEBAR 'WOPM test'.
*Prometheus - end
endmodule.

15. Activate the program.

2009 Prometheus Group, Inc.

" STATUS_0900

OUTPUT

41

42

Work Order Print Manager User Manual

16. Back out to the screen logic and double click on MODULE
ZXWOCI01.

USER_COMMAND_0900.

This takes you into the include

2009 Prometheus Group, Inc.

Technical Documentation

17. Paste the following code into the include ZXWOCI01.

DATA:sap_caufvd_imp LIKE caufvd.


MODULE user_command_0900 INPUT.
CASE sy-ucomm.
WHEN '+CUK'.
IMPORT sap_caufvd_imp FROM MEMORY ID 'YPG_IW18'.
DATA: icaufvd LIKE sap_caufvd_imp OCCURS 0 WITH HEADER LINE.
DATA: wa_t100 LIKE t100.
DATA: wa2_t100 LIKE t100.
CLEAR icaufvd.
REFRESH icaufvd.
icaufvd-aufnr = sap_caufvd_imp-aufnr.
icaufvd-sttxt = sap_caufvd_imp-sttxt.
"id.328
APPEND icaufvd.
IF icaufvd-aufnr CS '%'.
SELECT SINGLE *
INTO wa2_t100
FROM t100
WHERE sprsl = sy-langu
AND arbgb = 'LD'
AND msgnr = '185'.

*
*

CALL FUNCTION 'POPUP_TO_INFORM'


EXPORTING
titel
= sy-title
txt1
= ''
txt2
= wa2_t100-text
TXT3
= ' '
TXT4
= ' '
.
ELSE.
CALL FUNCTION 'Y_PGPM_ORDER_PRINT_MANAGER_1'
TABLES
caufvd_import = icaufvd.
CALL FUNCTION
CALL FUNCTION
CALL FUNCTION
CALL FUNCTION
CALL FUNCTION
Read Order Data

'CO_IT_SET_FLG_ITAB_NEW'.
'CO_BH_DATA_RESET'.
'CF_BT_CO_REFRESH'.
'NW_BT_AFAB_RESET'.
'CX_TM_TABLES_RESET'.

CALL FUNCTION 'PM_ORDER_DATA_READ'


EXPORTING
order_number
= icaufvd-aufnr
EXCEPTIONS
order_not_found = 1
OTHERS
= 2.
ENDIF.
CLEAR sy-ucomm.
ENDCASE.
ENDMODULE.

2009 Prometheus Group, Inc.

" USER_COMMAND_0900

INPUT

43

44

Work Order Print Manager User Manual

18. Activate the program.

2009 Prometheus Group, Inc.

Technical Documentation

2009 Prometheus Group, Inc.

45

46

Work Order Print Manager User Manual

19. Back out to the screen logic and click on the layout icon.

20. Add a push button to the screen. Then add text for the button and set the function code to +CUK.

2009 Prometheus Group, Inc.

Technical Documentation

2009 Prometheus Group, Inc.

47

48

Work Order Print Manager User Manual

21. Back out to the enhancement assignment screen.


22. Activate and distribute the entire project from CMOD.

4.2

Adding WOPM Icon to IW32


This is a step by step guide to insert an WOPM icon in the IW32 screen.
Note: this feature does not work for customers on ECC 6.0. Due to changes that SAP has made.
1. Save the file "saplcoih.e3000.txt" to a shared network drive. If you do not have this file please
contact your Prometheus Group representative to obtain it.
2. Activate GuiXT.

2009 Prometheus Group, Inc.

Technical Documentation

49

3. This will activate a scripting editor. You should now have a SAP session open and a GuiXT session
open. In the SAP session go to transaction IW32.

4. Next click on the profile button in GuiXT.


5. Fill in the network drive used in step 1.

2009 Prometheus Group, Inc.

50

Work Order Print Manager User Manual

6. Now, if you run transaction IW32 you will see the WOPM icon.

2009 Prometheus Group, Inc.

Technical Documentation

2009 Prometheus Group, Inc.

51

52

4.3

Work Order Print Manager User Manual

Adding WOPM to a list edit report


WOPM can also be added to a list edit. This code shows you how to call WOPM from an operation list
edit. In this example order and operation data is stored in an internal table called object_tab.
DATA: i_caufvd LIKE caufvd OCCURS 0 WITH HEADER LINE.
DATA: i_afvgd LIKE afvgd OCCURS 0 WITH HEADER LINE.
DATA: i_caufvd_duplicate LIKE caufvd OCCURS 0 WITH HEADER LINE.
CLEAR: i_caufvd.
REFRESH: i_caufvd.
LOOP AT object_tab WHERE selected = g_x.
*

Required for Print Manager


i_caufvd-aufnr = object_tab-aufnr.
i_caufvd-aufpl = object_tab-aufpl.

*
*
*

optional field: if you want to check on system status


before printing. yypg_ordvstxt can be obtained from with
the CALL FUNCTION 'STATUS_TEXT_EDIT'
i_caufvd-sttxt = object_tab-YYPG_ORDVSTXT.
"id.328
READ TABLE i_caufvd WITH KEY aufnr = object_tab-aufnr.
IF sy-subrc NE 0.
APPEND i_caufvd.
ENDIF.

Optional for operation level printing of shop papers


i_afvgd-aufnrd = object_tab-aufnr.
i_afvgd-vornr = object_tab-vornr.
i_afvgd-uvorn = object_tab-uvorn.
i_afvgd-aufpl = object_tab-aufpl.
i_afvgd-aplzl = object_tab-aplzl.
APPEND i_afvgd.
ENDLOOP.
CHECK sy-subrc = 0.

SORT i_caufvd BY aufnr.


DELETE ADJACENT DUPLICATES FROM i_caufvd COMPARING aufnr.

* Print manager function module


CALL FUNCTION 'Y_PGPM_ORDER_PRINT_MANAGER_1'
TABLES
caufvd_import = i_caufvd
afvgd_import = i_afvgd.

4.4

Installing the executable


WOPM uses an executable file to collate and send documents to networked printers. The reason and
executable is used is because SAP prints with asynchronously processing thus smaller documents
tend to get printed before larger documents. In WOPM, documents are printed in the ordered they are
displayed.
Another advantage is WOPM uses printer's attached to the computer's front end instead SAP printers,
which are often difficult to set up.
Steps to installing the WOPM executable file.
1. Prometheus Group will provide you with a file called "installPrintDiversion.exe"
2. copy this file into the directory that should hold the print manager executable (default is "C:\temp\",
but alternate locations can be defined in configuration.)
3. Run the executable file "installPrintDiversion.exe". The installation process will take 10-15 minutes.
When the program finishes installing you will see this popup message.

2009 Prometheus Group, Inc.

Technical Documentation

2009 Prometheus Group, Inc.

53

54

4.5

Work Order Print Manager User Manual

Configuration Options
Configuration options for WOPM can be accessed using transaction SM30. The
settings are in table YPG_WOPM_CONFIG. Checking the "Required" column
activates the specific function.

Version 2.00: Update list of configuration options.

2009 Prometheus Group, Inc.

Technical Documentation

55

CH I00
EC 01
K

Whenever a work order with a "created" system status is sent into WOPM, checking this option
will display the following message:

CH I00
EC 43
K

Whenever a work order with a "locked" system status is sent into WOPM, checking this option will
display the following message:

CH I00
EC 45
K

Whenever a work order with a "technically complete" system status is sent into WOPM, checking
this option will display the following message:

CH I00
EC 46
K

Whenever a work order with a "closed" system status is sent into WOPM, checking this option
will display the following message

2009 Prometheus Group, Inc.

56

Work Order Print Manager User Manual

CO ALL
NFI OW
G _S
AV
E
CO DE
NFI FA
G UL
T_E
XP
AN
D

Do not use this function

Checking this option automatically expands all folders when entering WOPM. See below:

If this option is not checked, the default view will look like the picture below and each folder can be
manually expanded.

2009 Prometheus Group, Inc.

Technical Documentation

57

CO DE
NFI FA
G UL
T_S
IMP
LE

Checking this option allows users to save document selections for printing.

CO SE
NFI LE
G CT
ED
_O
PS

Enabling this option will generate shop papers only for selected operations when calling WOPM
from an operation list edit. However, if WOPM is called from IW32 or an order list edit, WOPM
assumes all operations are selected for printing.

2009 Prometheus Group, Inc.

When saving document selections, mark items to be printed and press the save button. The next
time the order is called up from WOPM, the documents will be defaulted as checked or
unchecked.

This is a preview of a shop paper for an order with ten operation but only operation 0010 was

58

Work Order Print Manager User Manual

selected when calling WOPM.


Note: this options does not work in conjunction with "SHOW_OPERATIONS" setting.

CO SH
NFI OW
G _O
PE
RA
TIO
NS
CO ST
NFI AT
G US
_P
RT
CO SU
NFI BF
G OL
DE
RS
CO WK
NFI CT
G R
DE EQ
FA UIP
UL ME

Do not use

Sets the system status to PRT for printed orders and operations when shop papers are printed.

New for 2008:

New for 2008:


New for 2008:Default equipment documents as checked.

2009 Prometheus Group, Inc.

Technical Documentation

NT

Note: this option does not work for operation level printing.

DE FL
FA OC
UL
T

New for 2008:Default functional location documents as checked.

DE
FA
UL
T

New for 2008:Default material documents as checked.

MA
TE
RIA
L

59

Note: this option does not work for operation level printing.

Note: this option does not work for operation level printing.

DE OR
FA DE
UL R
T

New for 2008:Default order documents as checked.

DE PR
FA T
UL
T

New for 2008:Default PRT documents as checked.

FL
OC
_C
HE
CK

<fiel
dna
me
>

Enter a shop paper in the field "fieldname". When this option is enabled, the shop paper will be
disabled and not viewable in WOPM if there is no functional location on the order.

MA <fiel
TE dna
RIA me
L_C >
HE
CK

Enter a shop paper in the field "fieldname". When this option is enabled, the shop paper will be
disabled and not viewable in WOPM if there are no components on the order.

PU
RC
HA
SE
_R
EQ

Enter a shop paper in the field "fieldname". When this option is enabled, the shop paper will be
disabled and not viewable in WOPM if there are no external services or components on the order.

<fiel
dna
me
>

2009 Prometheus Group, Inc.

Note: this option does not work for operation level printing.

Note: this option does not work for operation level printing.

60

Work Order Print Manager User Manual

WO FIL
PM EN
AM
E
WO LO
PM CA
TIO
N

4.6

Specifies an alternate name for the WOPM executable.

Specifies the location where folder where temporary documents and the WOPM executable are
stored.

Setting Up Shop Papers


Shop paper need to be converted to a PDF documents to work with work order print manager. The
following instructions guide you on how to set up your shop papers to work with print manager.
Sapscript and Smart forms are handled a little bit differently, the sections below outline the process for
each.

4.6.1

WOPM set up for SAPscripts


This document details how to set up SAPscript shop paper for print manger.
1. Determine all shop paper programs that need to be converted. A list of shop
papers for SAP PM can be found using from transaction OIDF (you will need
SPRO authorizations to use OIDF).

2009 Prometheus Group, Inc.

Technical Documentation

61

2. Follow the remaining steps for each of the shop papers that need to be converted.
3. Open the output program in se38.
4. Find include that hold the form/endform for OPEN_FORM and CLOSE_FORM.
The include that usually hold this information is RIPRIF01.
5. In this include insert the highlighted code for global declarations
***INCLUDE RIPRIF01 .
* Prometheus Group - Begin
CONSTANTS:
c_iw18_convert2pdf(60)
c_iw18_filename(60)

VALUE 'YPGPM_IW18_CONVERT2PDF',
VALUE 'YPGPM_IW18_FILENAME'.

DATA:
v_iw18_convert2pdf(1) TYPE c,
v_iw18_filename LIKE rlgrap-filename.
* Prometheus Group - end*

6. Next find the form/endform for OPEN_FORM.


2009 Prometheus Group, Inc.

Insert the highlighted code (the

62

Work Order Print Manager User Manual

commented lines give you and idea where to place the code exactly).
*
*
*
*
*
*
*
*
*
*

itcpo-tdcopies
itcpo-tdnewid
itcpo-tdimmed
itcpo-tddelete
itcpo-tdcover
itcpo-tdcovtitle
itcpo-tdreceiver
itcpo-tdarmod
itcpo-tdtelenum
itcpo-tdteleland

=
=
=
=
=
=
=
=
=
=

wworkpaper-tdcopies.
wworkpaper-tdnewid.
wworkpaper-tdimmed.
wworkpaper-tddelete.
wworkpaper-tdcover.
wworkpaper-tdcovtitle.
wworkpaper-tdreceiver.
wworkpaper-tdarmod.
wworkpaper-tdtelenum.
wworkpaper-tdteleland.

"
"
"
"
"
"
"
"

copies
new spool entry
immediately
delete after
cover page
title for cover
report to ->
Archive mode

* Prometheus - Begin
CLEAR itcpo-tdgetotf.
IMPORT v_iw18_convert2pdf FROM MEMORY ID c_iw18_convert2pdf.
IF v_iw18_convert2pdf = 'X'.
itcpo-tdgetotf = 'X'.
ENDIF.
FREE MEMORY ID c_iw18_convert2pdf.
* Prometheus - End*

7. Next find the form/endform for CLOSE_FORM. Insert the highlighted code (the
commented lines give you and idea where to place the code exactly).
*----------------------------------------------------------------------*
*
FORM CLOSE_FORM.
*
*----------------------------------------------------------------------*
*
Close current open SAPSCRIPT form.
*
*----------------------------------------------------------------------*
*FORM close_form.
1
* Prometheus - Begin
DATA: v_iw18_binsize TYPE i.
"C11K900042
DATA: i_docs LIKE docs OCCURS 0 WITH HEADER LINE.
"C11K900042
DATA: i_itcoo LIKE itcoo OCCURS 0 WITH HEADER LINE.
"C11K900042
DATA: i_tline LIKE tline OCCURS 0 WITH HEADER LINE.
"C11K900042
IF v_iw18_convert2pdf = 'X'.
CALL FUNCTION 'CLOSE_FORM'
IMPORTING
result
= itcpp
TABLES
otfdata = i_itcoo
EXCEPTIONS " eg dest, spool nr etc
unopened = 1.

"C11K900042

PERFORM f_download_pdf TABLES i_itcoo.


ELSE.
* Prometheus - End*
*
*
*
*
*

CALL FUNCTION 'CLOSE_FORM'


IMPORTING
result
= itcpp " Information can be useful
EXCEPTIONS " eg dest, spool nr etc
unopened = 1.

* Prometheus - Begin
ENDIF.
CLEAR itcpo-tdgetotf.
* Prometheus - End
*ENDFORM.

8. At the very end of the include file please include the following code in its entirety.
FORM f_download_pdf TABLES t_otf STRUCTURE itcoo.
* C11K900042 Prometheus - Begin
DATA:
DATA:
DATA:
DATA:

v_iw18_binsize TYPE i.
i_docs LIKE docs OCCURS 0 WITH HEADER LINE.
i_itcoo LIKE itcoo OCCURS 0 WITH HEADER LINE.
i_tline LIKE tline OCCURS 0 WITH HEADER LINE.

* begin wopm (Version 2.00)

2009 Prometheus Group, Inc.

Technical Documentation

CONSTANTS:
c_iw18_shoppaper_tabl(60)
c_iw18_store_as_tabl(60)
c_iw18_binsize(60)
*end wopm (Version 2.00)

63

VALUE 'YPGPM_IW18_SHOPPAPER_TABL',
VALUE 'YPGPM_IW18_STORE_AS_TABL',
VALUE 'YPGPM_IW18_BINSIZE'.

IF v_iw18_convert2pdf = 'X'.
CALL FUNCTION 'CONVERT_OTF'
EXPORTING
format
max_linewidth
IMPORTING
bin_filesize
TABLES
otf
lines
EXCEPTIONS
err_max_linewidth
err_format
err_conv_not_possible
err_bad_otf
OTHERS
IF sy-subrc <> 0.

= 'PDF'
= 134
= v_iw18_binsize
= t_otf
= i_tline
=
=
=
=
=

1
2
3
4
5.

* MESSAGE ID SY-MSGID TYPE SY-MSGTY NUMBER SY-MSGNO


*

WITH SY-MSGV1 SY-MSGV2 SY-MSGV3 SY-MSGV4.


ENDIF.
CLEAR v_iw18_filename.
IMPORT v_iw18_filename FROM MEMORY ID c_iw18_filename.
FREE MEMORY ID c_iw18_convert2pdf.

* begin wopm (Version 2.00)


EXPORT i_tline TO MEMORY ID c_iw18_shoppaper_tabl.
EXPORT v_iw18_binsize TO MEMORY ID c_iw18_binsize.
* end wopm (Version 2.00)
IF NOT ( v_iw18_filename IS INITIAL ).
CALL FUNCTION 'WS_DOWNLOAD'
EXPORTING
filename
= v_iw18_filename
bin_filesize = v_iw18_binsize
filetype
= 'BIN'
TABLES
data_tab
= i_tline.
ENDIF.
EXPORT v_iw18_filename TO MEMORY ID c_iw18_filename.
ELSE.
ENDIF.
ENDFORM.

"f_download_pdf

9. Test the shop paper in wopm by previewing it from WOPM. If everything was
installed correctly the preview will appear in a PDF viewer (i.e. Adobe Acrobat).
4.6.2

WOPM set up for Smart Forms

STEP 1 find where the print


parameters are being set.

2009 Prometheus Group, Inc.

64

Work Order Print Manager User Manual

In the Global declarations copy these lines


* Prometheus Group - Begin
CONSTANTS:
c_iw18_convert2pdf(60)
VALUE 'YPGPM_IW18_CONVERT2PDF',
c_iw18_filename(60)
VALUE 'YPGPM_IW18_FILENAME'.
DATA:
v_iw18_convert2pdf(1) TYPE c,
v_iw18_filename LIKE rlgrap-filename.
* Prometheus Group - end*

*&---------------------------------------------------------------------*
*&
Form set_print_param
*&---------------------------------------------------------------------*
form set_print_param using
is_addr_key like addr_key
changing cs_control_param type ssfctrlop
cs_composer_param type ssfcompop
cs_recipient type swotobjid
cs_sender type swotobjid
cf_retcode type sy-subrc.
data:
data:
data:
data:
data:

ls_itcpo
lf_repid
lf_device
ls_recipient
ls_sender

type
type
type
type
type

itcpo.
sy-repid.
tddevice.
swotobjid.
swotobjid.

lf_repid = sy-repid.
* C11K900042 Prometheus - Begin
CLEAR ls_itcpo-tdgetotf.
IMPORT v_iw18_convert2pdf FROM MEMORY ID c_iw18_convert2pdf.
IF v_iw18_convert2pdf = 'X'.
ls_itcpo-tdgetotf = 'X'.
cs_control_param-getotf = 'X'.
cs_control_param-NO_DIALOG = 'X'.
ENDIF.
FREE MEMORY ID c_iw18_convert2pdf.
* C11K900042 Prometheus End

call function 'WFMC_PREPARE_SMART_FORM'


exporting
pi_nast
= nast
pi_addr_key
= is_addr_key
pi_repid
= lf_repid
importing
pe_returncode = cf_retcode
pe_itcpo
= ls_itcpo
pe_device
= lf_device
pe_recipient = cs_recipient
pe_sender
= cs_sender.

*
*

*
*
*
*

if cf_retcode = 0.
move-corresponding ls_itcpo to cs_composer_param.
CS_CONTROL_PARAM-NO_OPEN
CS_CONTROL_PARAM-NO_CLOSE
cs_control_param-device
= lf_device.
cs_control_param-no_dialog
= 'X'.
cs_control_param-preview
= xscreen.
cs_control_param-getotf
= ls_itcpo-tdgetotf.
cs_control_param-langu
= nast-spras.
CS_CONTROL_PARAM-REPLANGU1
CS_CONTROL_PARAM-REPLANGU2
CS_CONTROL_PARAM-REPLANGU3
CS_CONTROL_PARAM-STARTPAGE
endif.

2009 Prometheus Group, Inc.

Technical Documentation

endform.

65

" set_print_param

*/ C11K900042 Prometheus - Begin

STEP 2 find this call function that


give you job_output_info this info can be converted to
pdf.
CALL FUNCTION lf_fm_name
EXPORTING
archive_index
= toa_dara
archive_parameters
= arc_params
control_parameters
= ls_control_param
mail_recipient
= ls_recipient
mail_sender
= ls_sender
output_options
= options
user_settings
=''
caufvd
= caufvd
gs_ord
= gs_ord
gs_t
= gs_t
gs_ac
= gs_ac
gs_hdr_short_text_description = gs_hdr_short_text_description
gs_tip_description
= gs_tip_description
gs_short_text_description = gs_short_text_description
gs_long_description_text = gs_long_description_text
gs_func_loc
= gs_func_loc
gs_func_description
= gs_func_description
gs_eq_description
= gs_eq_description
gs_assem_description
= gs_assem_description
gs_loc
= gs_loc
gs_rm
= gs_rm
gs_es
= gs_es
gs_wt
= gs_wt
gs_fs
= gs_fs
gs_equ
= gs_equ
gs_assembly
= gs_assembly
gs_reported_by
= gs_reported_by
2009 Prometheus Group, Inc.

66

Work Order Print Manager User Manual

gs_created
= gs_created
gs_rev_txt
= gs_rev_txt
gs_supervisor_and_pager
= gs_supervisor_and_pager "remove
IMPORTING
document_output_info
= document_output_info
job_output_info
= job_output_info
job_output_options
= job_output_options
TABLES
afvgd
= iafvgd
EXCEPTIONS
formatting_error
=1
internal_error
=2
send_error
=3
user_canceled
=4
OTHERS
= 5.
IF sy-subrc <> 0.
retcode = sy-subrc.
PERFORM protocol_update.
*
get SmartForm protocoll and store it in the NAST protocoll
PERFORM add_smfrm_prot.
ENDIF.

IF v_iw18_convert2pdf = 'X'.
PERFORM f_download_pdf TABLES job_output_info-otfdata.
ELSE.

ENDIF.

C11K900042 Prometheus End

STEP 3 define the pdf download form


* DEVK944503 begin
*&--------------------------------------------------------------------*
*&
Form f_download_pdf
*&--------------------------------------------------------------------*
FORM f_download_pdf TABLES t_otf STRUCTURE itcoo.
* C11K900042 Prometheus - Begin
DATA: v_iw18_binsize TYPE i.
"C11K900042
DATA: i_docs LIKE docs OCCURS 0 WITH HEADER LINE.
"C11K900042
DATA: i_itcoo LIKE itcoo OCCURS 0 WITH HEADER LINE.
"C11K900042
DATA: i_tline LIKE tline OCCURS 0 WITH HEADER LINE.
"C11K900042
* begin wopm (Version 2.00)
CONSTANTS: c_iw18_shoppaper_tabl(60)

VALUE 'YPGPM_IW18_SHOPPAPER_TABL',

2009 Prometheus Group, Inc.

Technical Documentation

c_iw18_store_as_tabl(60)
c_iw18_binsize(60)
*end wopm (Version 2.00)

VALUE 'YPGPM_IW18_STORE_AS_TABL',
VALUE 'YPGPM_IW18_BINSIZE'.

IF v_iw18_convert2pdf = 'X'.
CALL FUNCTION 'CONVERT_OTF'
EXPORTING
format
=
max_linewidth
=
IMPORTING
bin_filesize
=
TABLES
otf
=
lines
=
EXCEPTIONS
err_max_linewidth
=
err_format
=
err_conv_not_possible =
err_bad_otf
=
OTHERS
=

'PDF'
134
v_iw18_binsize
t_otf
i_tline
1
2
3
4
5.

IF sy-subrc <> 0.
* MESSAGE ID SY-MSGID TYPE SY-MSGTY NUMBER SY-MSGNO
*
WITH SY-MSGV1 SY-MSGV2 SY-MSGV3 SY-MSGV4.
ENDIF.
CLEAR v_iw18_filename.
IMPORT v_iw18_filename FROM MEMORY ID c_iw18_filename.
FREE MEMORY ID c_iw18_convert2pdf.
* begin wopm (Version 2.00)
EXPORT i_tline TO MEMORY ID c_iw18_shoppaper_tabl.
EXPORT v_iw18_binsize TO MEMORY ID c_iw18_binsize.
*end wopm (Version 2.00)
IF NOT ( v_iw18_filename IS INITIAL ).
CALL FUNCTION 'WS_DOWNLOAD'
EXPORTING
filename
= v_iw18_filename
bin_filesize = v_iw18_binsize
filetype
= 'BIN'
TABLES
data_tab
= i_tline.
ENDIF.
EXPORT v_iw18_filename TO MEMORY ID c_iw18_filename.
ELSE.
ENDIF.
ENDFORM.

4.7

"f_download_pdf

Release Notes
Here you will find the latest updates and changes to WOPM.

4.7.1

Version 2.00
New Features:
Improved performance when calling WOPM
Ability to preview print packages
Ability to mass update printers
Configuration option to print by operation

2009 Prometheus Group, Inc.

67

68

Work Order Print Manager User Manual

Validate URLs
Configuration option added to include shop papers for notifications related to an order
Version number is identified in the WOPM popup title bar
4.7.1.1

Version 2.01
New Features:
Users now have the option of added WOPM as an icon to IW32 via GuiXT
Items addressed in this release:
need to populate table OP_PRINT_TAB for certain shop papers
Validate URL functionality if now a toggle option; due to slow performance over VPN's
Added ability to handle file extensions more than 3 characters long
Added validation of step for object services as in standard SAP
Table maintenance generated for table YPG_WOPM_CONFIG is added.
Blank URL's were not being validated
Order-Operation-Sub-operation watermarks can be added to each page of a document package
via configuration

4.7.1.2

Version 2.02
New Features:
When operation level printing is active, operation work center is shown under operation number
Ability to disable shop papers depending on system status. Similar to existing functionality that
warns users of certain system statuses on the order; but this simple deactivate the capability to
print the shop papers.
Ability to add a footer with Order#, Operation#, Sub-Operation, and printing date.
Integration with Work Clearance Application
Integration with KPro
Ability to split up print jobs by Order/operation/Sub-operation - for stapling and duplexing
printers.
Items addressed in this release:
Performance increase when calling up the WOPM. Search improved when looking up material
documents and in order data selection process.
2009 Prometheus Group, Inc.

Technical Documentation

4.7.1.3

69

Version 2.03
New Features:
When "show operation" functionality is turned on, the operation checkboxes will adopt "check" or
"uncheck" setting from the order level setting default.
WOPM pulls in maintenance plan object services documents for printing.
WOPM pulls in task list object services documents for printing.
Shop paper description is prefixed with the shop paper number
Equipment folder now shows the equipment # and equipment description
Functional location folder now shows the Floc # and Floc description

Items addressed in this release:


Sometimes printer can not be selected if printer names are similar
4.7.1.4

Version 2.04
New Features:
added ability to default maintenance plan and tasklist documents
Items addressed in this release:
short dump when the same PRT is added to the same operation multiple times
PRT's are printed too many times if the same PRT is attached to several operations.
When printer names are longer than 50 characters long, they can not be selected
Concatenate data carrier path with the filename for external storage systems

4.7.1.5

Version 2.05
Items addressed in this release:
Switch from WS_DOWNLOAD to GUI_DOWNLOAD because WS_DOWNLOAD is obsolete
according to SAP.

4.7.1.6

Version 2.06
Items addressed in this release:
Addressed difference between using KPro and not using KPro.

2009 Prometheus Group, Inc.

70

Work Order Print Manager User Manual

In YPG_WOM_CONFIG for item WOPM-LOCATION, accounted for the user leaving off the last
character slash, '\'.
Known issues:
Table maintenance dialog for YPG_WOPM_CONFIG is missing.
GUIXT transactions are missing.
4.7.1.7

Version 2.07 /2.08


New Features:
User exit added to allow customers to customize layout of documents in print manager.
Ability to optimize column widths for select, printer name,location and operation/subop columns.
option to not exit to the list edit after printing from WOPM.
notification shop papers have a separate folder than the order shop papers.
Items addressed in this release:
Added ability to disable header checkboxes for customers that only want to use operation level
printing.
Cancelling from WOPM exits too slowly even though nothing is printed or generated
Keep the sequence from list edit. WOPM needs to maintain the sequence from the list
edit...instead of always sorting by order number.
Delete the WOPM executable's log file after it reaches a size of 93kb.
Known issues:
The title in the wopm popup says Version 2.08, although the transports are labeled 2.07. As a
result the next delta will be called 2.09

4.7.1.8

Version 2.09- full transports


Special note:
This version of WOPM is a full installation transport of Work Order Print Manager that contains
WOPM 2.00-2.09. New and existing installations should use this transport. This is effectively
the new baseline for Work Order Print Manger. For example if a customer is on version 2.02
and would like to upgrade to version 2.10, he/she would import 2.09, and 2.10.
New Features:
WOPM now gathers documents for assembly listed on the order header tab.

2009 Prometheus Group, Inc.

Technical Documentation

71

WOPM gathers document related to objects on the order's object tab


Added an icon to deselect all operation check boxes
Customers are now able to optimize column widths
Items addressed in this release:
Force WOPM to the the Windows function to retrieve printer names due to SAP limitations.
Known issues:
4.7.1.9

Version 2.10
Items addressed in this release:
Changing printers for operation level documents does not work
Deleted operations still show up in the WOPM pop up.

4.7.1.10 Version 2.11


Items addressed in this release:
Slow WOPM loading time when looking up personnel related to a work center.
Some orders not showing up in WOPM when calling it from a customer specific program due to
leading zeros.

4.7.1.11 Version 2.12


Items addressed in this release:
Only the last material in the components tab shows up in WOPM
New Features:
Add, remove, change the columns with user exits in WOPM
Add, remove, change rows (or documents) with user exits in WOPM
4.7.1.12 Version 2.13
Items addressed in this release:
Confirmed operation not showing up in WOPM
Print operation as they are in the list edit screen. No sorting.

2009 Prometheus Group, Inc.

72

Work Order Print Manager User Manual

4.7.1.13 Version 2.14 - Full Transport


Special note:
This version of WOPM is a full installation transport of Work Order Print Manager that contains
WOPM 2.09-2.14. New and existing installations should use this transport. This is effectively
the new baseline for Work Order Print Manger. For example if a customer is on version 2.02
and would like to upgrade to version 2.15, he/she would import 2.14, and 2.15.
Items addressed in this release:
Deleted operation are displayed in the WOPM popup when show operation configuration is
turned on.
put in a user exit during printing so that backend data list can be modified just before printing.
4.7.1.14 Version 2.15

Items addressed in this release:


Services for object do not pull up in 46C
ECL viewer enabled for viewing CAD files.
Ability to create a "not released" watermark for CRTD orders.

2009 Prometheus Group, Inc.