WF Sap
WF Sap
WF Sap
Table of Contents
Introduction ................................................................................................................................................. 5
Welcome .................................................................................................................................................... 5
About this guide ......................................................................................................................................... 5
Typographical conventions ........................................................................................................................ 6
Creating workflows ..................................................................................................................................... 7
Creating workflows: Overview ................................................................................................................... 7
Creating workflow shells ............................................................................................................................ 7
Creating workflow steps ............................................................................................................................ 7
Assigning workflow steps to workflow shells ............................................................................................. 8
Activating workflows .................................................................................................................................. 8
Assigning default recipients ....................................................................................................................... 9
Processor pre-allocation and assignment matrix ...................................................................................... 9
Line-item approval ................................................................................................................................... 11
Workflow step conditions ......................................................................................................................... 12
Deleting workflows ................................................................................................................................... 15
Other configuration tasks ........................................................................................................................ 16
Overview .................................................................................................................................................. 16
User management ................................................................................................................................... 16
Email templates ....................................................................................................................................... 20
One-time vendor fields in the Web Application ....................................................................................... 29
Viewing PROCESS DIRECTOR documents ........................................................................................... 29
Creating field statuses ............................................................................................................................. 30
Integrating with the SAP Business Workflow .......................................................................................... 33
Programs and functions ........................................................................................................................... 51
Overview .................................................................................................................................................. 51
ARCHIV_NOTE_LATE ............................................................................................................................ 52
ARCHIV_WCLOG_REPAIR .................................................................................................................... 52
DUE_DATE_CHECK ............................................................................................................................... 53
/COCKPIT/WC_CHK_DEL_USRS .......................................................................................................... 54
WC_DEBUG ............................................................................................................................................ 54
WC_RFC_LOG ........................................................................................................................................ 55
WC_SET_NOT_ARCHIVED ................................................................................................................... 55
WC_UMA_PASSWD_INIT ...................................................................................................................... 55
3
WORK CYCLE 7.2 SAP Configuration Guide
WC_USER_UPDATE .............................................................................................................................. 56
WC_WEB_LOGGING.............................................................................................................................. 58
XPRA_V720_SP0 .................................................................................................................................... 58
Appendix A – IMG ..................................................................................................................................... 59
Setting the Web Application URL ............................................................................................................ 59
Defining the workflow .............................................................................................................................. 59
Defining workflow steps ........................................................................................................................... 61
Optional settings for workflow steps ........................................................................................................ 68
Workflow steps, assign processors ......................................................................................................... 71
Workflow processes and step conditions ................................................................................................ 72
Activate workflows ................................................................................................................................... 74
Set up general workflow texts.................................................................................................................. 74
Activate authorization checks in WORK CYCLE ..................................................................................... 75
Message transformation for checks ........................................................................................................ 76
Limit attachment visibility in applications ................................................................................................. 77
Email settings .......................................................................................................................................... 77
Presentation and interface....................................................................................................................... 80
User management ................................................................................................................................... 94
Set notes................................................................................................................................................ 100
Schedule background processing ......................................................................................................... 101
Amendments ......................................................................................................................................... 102
Creating field statuses ........................................................................................................................... 102
Appendix B – User Exits......................................................................................................................... 105
Overview ................................................................................................................................................ 105
Developing User Exits ........................................................................................................................... 106
List of User Exits .................................................................................................................................... 107
Appendix C – Other tasks ...................................................................................................................... 163
Copying forms to another client ............................................................................................................. 163
Support for other languages .................................................................................................................. 164
Index ......................................................................................................................................................... 165
4
WORK CYCLE 7.2 SAP Configuration Guide
Introduction
Welcome
Welcome to the ReadSoft WORK CYCLE 7.2 – SAP Configuration Guide.
WORK CYCLE is the workflow component for PROCESS DIRECTOR Accounts Payable, for approving
invoices. SAP users can perform these tasks inside the SAP environment. For non-SAP users, a Web
Application is available.
This document explains how you can configure WORK CYCLE to suit the requirements of your
organization.
Note: This guide explains how to configure WORK CYCLE for PROCESS DIRECTOR Accounts Payable
only. For information on configuring workflows for other process types, refer to the PROCESS
DIRECTOR 7.2 SAP Configuration Guide.
Creating workflows
Details about some programs and functions to perform routine tasks, such as sending emails for
overdue invoices.
IMG
5
WORK CYCLE 7.2 SAP Configuration Guide
User Exits
Descriptions for the 40 User Exit interfaces/templates that come packaged with WORK CYCLE.
Other tasks
Typographical conventions
The following typographical conventions are used:
Variables that have to be replaced by an actual value are italicized or appear in <>.
6
WORK CYCLE 7.2 SAP Configuration Guide
Creating workflows
Creating workflows: Overview
There are four steps to create a workflow:
The above four steps are the minimum required to get a workflow up and running.
3. Enter a Maximum processing time, in days, Selection list order, Workflow type.
4. Specify values for the remaining settings, which are all optional.
7
WORK CYCLE 7.2 SAP Configuration Guide
3. Specify a workflow.
4. Specify the workflow step that will be the first step in the workflow.
6. Repeat steps 4-5 for each subsequent step in the workflow, using positions, 2, 3, 4, etc.
Note: A workflow step can be assigned to more than one workflow shell. For example, if you create a
general approval workflow step intended for a manager, you can use this step in multiple workflows,
without having to recreate the same workflow step for each workflow.
Activating workflows
Activating workflows is the last step in creating workflows. You must activate your workflow in order for it
to be used.
1. Go to /COCKPIT/WI7.
Do this only if you wish to restrict a workflow to one or both of these parameters.
If you want to make the workflow available for both types of documents, create a new entry and
specify the other document type.
8
WORK CYCLE 7.2 SAP Configuration Guide
Note: The Business Solution Package contains other methods for determining the workflow recipient; for
example, based on the creator of the purchase order.
9
WORK CYCLE 7.2 SAP Configuration Guide
10
WORK CYCLE 7.2 SAP Configuration Guide
Line-item approval
Line and accounting items for MM and FI invoices can be approved individually, including by different
processors. This feature is intended for documents where different people are responsible for different
items on invoices. The workflow steps are completed when all the processors have either approved or
rejected their items.
Process description
The following describes the basic features of line-item approval:
1. A workflow is started for a document with multiple line or accounting items.
2. Recipients are either entered manually by the PROCESS DIRECTOR user, or determined by a
User Exit.
3. Workflow processors can open the document and view and approve all the items assigned to
them, as well as the unassigned items.
4. After all the items have been approved or rejected, the workflow step is completed.
Note: You should activate line-item approval for only one step per workflow.
As no items are pre-assigned to anyone, workflow recipients can initially view all the items in the
document. After approving one or more items, these items are cleared and other workflow
recipients can no longer view or approve them.
Pre-workflow start: Users can be manually assigned to each line item in PROCESS DIRECTOR
Accounts Payable. Alternatively, users can be determined via the Step User Exit 2: Determine
processor of step. ReadSoft recommends this method as the best practice.
11
WORK CYCLE 7.2 SAP Configuration Guide
Overview
Workflow step conditions are rules that determine whether a step has been started or not. For example, in
a typical two-step FI approval workflow, you may only want to have the second approval step performed if
the value for an invoice is above a certain amount. You create conditions based on the values of certain
fields, and can have more than one condition for a step.
This will be the first condition executed. Subsequent steps will be 2, 3, and so on.
4. Specify the Structure and Internal field that the condition is based on.
Note: If using the COSTCENTER field in the Account assignments table, the From value and To
value must be 10 digits long. For example, for cost center 2500, enter 0000002500. Otherwise,
the step condition will not be activated.
5. Set Inclusion/exclusion to Including if you want the From/To values included in the step
condition.
For example, use GE – Greater than or equal to from-value to create a condition based on an
amount exceeding the value in the From value field.
Note: Enter the values in the SAP internal format. For example, for cost center 1000, enter
0000001000; for vendor 2500, enter 0000002500.
8. Select an Opening bracket or Closing bracket, if there are multiple step conditions and you
want to perform two or more conditions together before performing another.
9. If more than one condition is created, use AND or OR for the Boolean operator, as appropriate.
12
WORK CYCLE 7.2 SAP Configuration Guide
Example
To create a step condition for a gross amount exceeding 1000 EUR or 1400 USD, you need the following
four items:
Setting Value
Item/Sequence 1
Inclusion/exclusion Including
Setting Value
Item/Sequence 2
Inclusion/exclusion Including
13
WORK CYCLE 7.2 SAP Configuration Guide
Setting Value
Boolean operator OR
Setting Value
Item/Sequence 3
Inclusion/exclusion Including
Setting Value
Item/Sequence 4
14
WORK CYCLE 7.2 SAP Configuration Guide
Setting Value
Inclusion/exclusion Including
Deleting workflows
Before deleting any workflows or workflow steps, ensure that no documents are currently active in them.
You must either wait for these documents to finish, or recall the documents from the workflow.
You can use /COCKPIT/1 to view which documents are currently active for specified workflows and
workflow steps, by using the Workflow ID and Workflow step ID fields.
15
WORK CYCLE 7.2 SAP Configuration Guide
Email templates
For all other configuration topics, refer to the IMG reference in Appendix A.
User management
Overview
SAP users, provided they have the appropriate authorization, can access WORK CYCLE in both SAP
and the Web Application by using the regular username and password. In addition, you can create
WORK CYCLE users who can access the Web Application. This is an easy way for non-SAP users to
access and participate in workflows.
Creating users
Importing users
Creating users
You can create WORK CYCLE users who can access the Web Application.
1. Go to /COCKPIT/WUM.
Leave it blank if you want the system to generate one automatically (see the User
generation setting in /COCKPIT/WI6 for the methods of creating a username).
16
WORK CYCLE 7.2 SAP Configuration Guide
4. Complete the details for the user and click the Continue icon.
A password for the user is displayed. You can specify a default initial password in /COCKPIT/WI6. If no
default password is set, a random password is generated.
Tip: Activate the sending of emails to newly-created users. You can do this by enabling the Create or
delete setting in /COCKPIT/WI6.
The function module must map and save the data to the /COCKPIT/TWC_UMP table (which
contains the WORK CYCLE users).
2. Go to /COCKPIT/WI6.
3. Enter the name of the function module you created in the Mapping module.
4. Go to /COCKPIT/WUM.
2. Map the fields you want to import between the LDAP directory (Attribute name) and WORK
CYCLE (Internal field name).
If you want to modify any imported values, you can write your own function module and specify it
here as well.
This program imports the user data using the mapping table in /COCKPIT/WI27.
17
WORK CYCLE 7.2 SAP Configuration Guide
SAP users
1. Go to /COCKPIT/WUM1.
4. Specify the users and user groups that belong to this user group.
When documents are sent to workflow recipients, the substitutes who can view them can be filtered:
1. Go to /COCKPIT/WI33.
2. Enter a substitute profile and save (you can only specify one).
Result
Substitutes with the defined profile in /COCKPIT/WI33 are the preferred substitutes for the
document (see Rules below).
18
WORK CYCLE 7.2 SAP Configuration Guide
Substitutes created in the Web Application are assigned to this profile automatically (there is no
Profile field in the Web Application).
Rules
If no profile is specified in /COCKPIT/WI33, the substitute Profile setting is ignored and the
documents are available for all the substitutes.
If a profile is specified in /COCKPIT/WI33, the documents are available only to the substitutes with
this profile. If no substitutes have this profile, the documents are available to the substitutes that
have no profile specified.
Example
Settings
User 1: Jones
Substitute Profile
Muller PD
Schmidt ALL
User 2: Smith
Substitute Profile
Muller [None]
/COCKPIT/WI33
Profile
PD
Action
Two separate documents are sent to Jones (100) and Smith (200).
19
WORK CYCLE 7.2 SAP Configuration Guide
Result
Substitute Available documents
Schmidt [None]
Email templates
Overview
Templates are used for workflow emails, which are sent at various times, such as when a workflow is
started, is overdue, and so on. WORK CYCLE comes with its own templates, and you can also create
your own.
With HTML emails, URLs can be displayed as more user-friendly hyperlinks, rather than as long URLs.
Header, line-item, and account assignment data can also be displayed in HTML emails (and not in plain
text emails).
1. Go to /COCKPIT/WI30.
20
WORK CYCLE 7.2 SAP Configuration Guide
Creating templates
There are two steps to creating email templates:
Use plain text. Even if you have activated HTML emails, the text will be formatted as HTML
before being sent. You can specify the styles in the HTML start template.
There are built-in templates that you can use or copy to your own templates and modify.
There are variables that you can use in the text (for example, &WEB_CYCLE_USER_NAME& to insert
the recipient's name).
2. Activate the use of the text in either the workflow step (for workflow starts) configuration or the
general workflow text configuration.
For plain text emails, no further configuration is required. For HTML emails, please refer to Creating
HTML email templates.
/COCKPIT/WEB_CYCLE_TEMPL_HTM
(for HTML emails)
Substitute /COCKPIT/WEB_CYCLE_TAKEOVER
taking over
processing
21
WORK CYCLE 7.2 SAP Configuration Guide
Starting a /COCKPIT/WEB_CYCLE_SUBST
workflow – email
to active
substitutes
Answering a /COCKPIT/WEB_CYCLE_ANSWER
query
Forwarding a /COCKPIT/WEB_CYCLE_FORWARD
workflow
Variable Description
&SENDER_NAME& The full name of the person who starts the workflow,
as saved in /SU01.
22
WORK CYCLE 7.2 SAP Configuration Guide
Variable Description
23
WORK CYCLE 7.2 SAP Configuration Guide
Variable Description
* MOBILE APPROVAL must be active for the link to appear in the email.
24
WORK CYCLE 7.2 SAP Configuration Guide
If no documetn data exists in the line item, account and multi-account assignment tables, these tables are
not displayed in the emails.
Variable Description
&WORKFLOW_HISTORY& Displays the current log of the workflow (basically the same
information that is presented in the workflow status in the SAP GUI
and in the Web Application). It also includes any notes that have been
created in WORK CYCLE.
Note: The workflow history table is not included in the emails sent for
the first step of workflows.
&MOBILE_BUTTONS& Displays the Approve, Reject and Note buttons for MOBILE
APPROVE (MOBILE APPROVE must be activated.
Note: MOBILE APPROVAL must first be active for the workflow step
(/COCKPIT/MAI2).
To specify how many fields per row are displayed, see the Fields number per row setting in
/COCKPIT/WI30.
25
WORK CYCLE 7.2 SAP Configuration Guide
3. Specify the HTML code to use for the HTML Start, HTML End and MOBILE APPROVAL links.
4. Specify the display names for the links to the Web Application.
5. Under Fields number per row, enter the number of fields to be displayed in each table row.
6. Select Add Multi acc. ass. to items to include multi-account assignment fields (for MM
documents) in the line-item table. If not selected, multi-account assignment fields are displayed
as a separate table.
7. If MOBILE APPROVAL is active for a workflow step, only one field is displayed per table row and
the Field numbers per row setting is not used. By selecting Ignore MOBILE APPROVAL,
the Field numbers per row setting is used.
Default table display for MOBILE APPROVAL, with only one field per row:
26
WORK CYCLE 7.2 SAP Configuration Guide
PROCESS DIRECTOR Accounts Payable comes with templates that you can use for both these:
/COCKPIT/HTML_START and /COCKPIT/HTML_END.
If you want to create your own templates, you should copy the code from these default templates to your
own files. The main thing to change is the styles, to change the appearance of the HTML emails.
27
WORK CYCLE 7.2 SAP Configuration Guide
1. Upload the image you want to use to the SAP Web Repository.
2. Go to /COCKPIT/WI30.
Note: Enter the image ID in the repository, not the original filename.
Note: There is no requirement for the image filename. It does not have to be backgrnd.gif, as
it appears in the HTML start template. PROCESS DIRECTOR links your image with this filename
automatically.
Note: Not all email programs (including some versions of Microsoft Office) support background images
for HTML emails. In this case, the background image appears as an email attachment.
2. Select Binary data for WebRFC applications and click the Find button.
6. Click Import.
Note: There is no requirement for the image filename. It does not have to be backgrnd.gif, as
it appears in the HTML start template. PROCESS DIRECTOR Accounts Payable links your image
with this filename automatically.
28
WORK CYCLE 7.2 SAP Configuration Guide
3. Specify a Vendor number if the field should be displayed for that vendor only.
5. Under Display, specify whether the field is displayed (Normal field), if a value must be entered
(Mandatory field), is read-only (Only display), or hidden (Hide).
6. Specify the Priority number. This determines the row order in which the fields are displayed
(lowest to highest value).
29
WORK CYCLE 7.2 SAP Configuration Guide
1. Go to /COCKPIT/WI25 and specify the user group for whom this tab is displayed.
4. Under Field status identification, specify if header fields, line-item fields, and/or account
assignment fields should be made read-only.
Checking No account assignment line with MM invoices hides the account assignment fields
section for the FI items in MM documents.
30
WORK CYCLE 7.2 SAP Configuration Guide
6. Specify the individual fields that will be hidden, read-only, mandatory, or normal.
Note: Mandatory fields here prevent the document from being saved if the field has no value.
8. Go to /COCKPIT/WI3.
9. Open the desired workflow step and enter the name of the Field status you created.
Note: The field status is activated for only the selected workflow step, and not for PROCESS
DIRECTOR. Field statuses for PROCESS DIRECTOR are activated in /COCKPIT/C24.
Example
Objective: To make all header fields read-only, except for:
Assignment Hidden
31
WORK CYCLE 7.2 SAP Configuration Guide
Result:
32
WORK CYCLE 7.2 SAP Configuration Guide
Overview
1. Go to SAP transaction, SWDD.
3. Create a Container element—this is what is responsible for mapping a WORK CYCLE workflow
step to an SAP Business Workflow step.
4. Set up the workflow start event—this lets WORK CYCLE trigger an SAP Business Workflow
when a WORK CYCLE workflow step is started.
7. Activate your workflow definition—this finalizes the configuration and takes it into production.
Additional information
As a supplement to the information in this topic, Ginger Gatling's SDN eLearning session "Building a
Workflow from Scratch" (requires SDN login) provides a tutorial-style introduction to developing SAP
Business Workflows.
A popup appears, prompting you to enter an abbreviation and name for the workflow definition:
2. Confirm.
33
WORK CYCLE 7.2 SAP Configuration Guide
Another popup appears, asking you to create an Object Directory entry for the workflow definition:
1. Select the Workflow Container tab and double-click the item, <Double-Click to Create>:
34
WORK CYCLE 7.2 SAP Configuration Guide
2. Enter an element, name and description and the object type, /COCKPIT/W. Your screen should
look like this:
3. Select the Properties tab and check the Parameter settings > Import check box.
35
WORK CYCLE 7.2 SAP Configuration Guide
4. Confirm.
2. Select the Version-Independent (Task) > Start Events tab and add these settings:
Required settings
36
WORK CYCLE 7.2 SAP Configuration Guide
3. Then activate the event linkage by clicking the button . You will be prompted for a customizing
request.
Note: In some customer implementations, the activation may need to be executed manually in
every client and system.
4. Next, configure the event binding by clicking the button . The Change Binding for Workflow
popup appears.
5. Drag and drop the Event container field, _EVT_OBJECT onto your new workflow container,
SingleDocumentLink, as shown here:
37
WORK CYCLE 7.2 SAP Configuration Guide
8. If an event is raised, the instance of the object which raised the event is available in the Event
container field, _EVT_OBJECT. This field must be copied into the corresponding field in the
Workflow Container. This is the field, SingleDocumentLink, which was created in the workflow
step. It is the only available field for event binding because it is the only field marked as an Input
field.
6. Confirm.
38
WORK CYCLE 7.2 SAP Configuration Guide
Now you can specify how the work item recipients will be determined.
1. Click the toolbar button . The Maintain Agent Assignment dialog box is displayed.
3. Select the General task option and confirm. This setting allows all SAP users as possible work
item recipients.
39
WORK CYCLE 7.2 SAP Configuration Guide
Required settings
5. Confirm.
40
WORK CYCLE 7.2 SAP Configuration Guide
3. In the Control tab, open the Task drop-down menu and select Create task:
41
WORK CYCLE 7.2 SAP Configuration Guide
Required settings
Abbr PDWCProcess
Method DISPLAY
42
WORK CYCLE 7.2 SAP Configuration Guide
5.
6. You can also add some documentation for the task in the Description tab (optional).
7. Next, you need to ensure that the work item will disappear from the Workplace if it has been
canceled, retracted or finished from within PROCESS DIRECTOR Accounts Payable or WORK
CYCLE. To configure this, select the Terminating events tab and define a terminating event:
Required settings
Element _WI_OBJECT_ID
Event FINISHED
43
WORK CYCLE 7.2 SAP Configuration Guide
9. The Create Object Directory Entry popup appears and prompts you to assign a package. Enter
an appropriate Z package.
Warning: Be sure to double-check your work before returning to the activity definition, as then
you will no longer be able to edit the task.
10. Click the SAP GUI toolbar button to return to the activity definition dialog box.
12. Confirm.
13. Now use the search help to select an expression for the Agents assignment:
44
WORK CYCLE 7.2 SAP Configuration Guide
14. Select the expression, Container > SingleDocumentLink > User, as shown here:
45
WORK CYCLE 7.2 SAP Configuration Guide
15. Confirm.
16. Specify the agent assignment by clicking the button in Task Properties. The Maintain Agent
Assignment dialog box is displayed.
19. Return to the Workflow Builder by clicking the SAP GUI toolbar button twice.
Click the toolbar button to generate and activate the runtime version of the workflow.
Your screen should now look like this:
46
WORK CYCLE 7.2 SAP Configuration Guide
3. In the Task field, double-click the task number to open the task details.
47
WORK CYCLE 7.2 SAP Configuration Guide
4. Select the Container tab or the Container button on the toolbar (depending on your SAP
version).
6. Select ABAP Dictionary Reference and enter the structure, /COCKPIT/SWC_DUMMY and the
field URL. Your screen should look like this:
48
WORK CYCLE 7.2 SAP Configuration Guide
9. Expand the SingleDocumentLink workflow container on the left-hand side and drag and drop
the DocumentSingleLink field to the SingleDocumentLink task container on the right-hand
side.
49
WORK CYCLE 7.2 SAP Configuration Guide
A new entry is added in the table, Binding Workflow -> Step 'WORK CYCLE process'.
50
WORK CYCLE 7.2 SAP Configuration Guide
Name* Description
WC_CHK_DEL_USRS Checks whether a user who no longer exists, is still assigned to user
groups or workflow steps, or as a substitute.
WC_DEBUG Enables the creation of log entries for PROCESS DIRECTOR and
WORK CYCLE RFC calls, including those by the Web Application and
User Exits.
WC_RFC_LOG Displays all the RFC log entries (a record of RFC calls made by the
Web Application).
WC_SET_NOT_ARCHIVED Resets the ARCHIVED flag so that the workflow can be archived
again.
WC_WEB_LOGGING Records all the RFC calls made by the Web Application. Used in
conjunction with WC_DEBUG.
51
WORK CYCLE 7.2 SAP Configuration Guide
Name* Description
XPRA_V720_SP0 Required to enable searching for WUM users by email addresses after
upgrading to PROCESS DIRECTOR 7.2 from a previous version. Also
required in order that the user-type independent search help on
workflow start functions correctly after an upgrade.
* All programs and functions are contained within the /COCKPIT/ namespace.
ARCHIV_NOTE_LATE
Archives notes that have not been archived normally.
This program archives internal notes and all other notes that have not yet been archived with the
workflow. All the notes relevant to the workflow are already automatically archived when terminating the
workflow. Notes that have been entered after the termination of the workflow and internal notes (are not
displayed in the workflow) can be archived with this program.
Workflow notes can be created by workflow recipients in WORK CYCLE and the Web Application and are
visible there, while internal notes can be created only in /COCKPIT/1 and are not visible in WORK CYCLE
or the Web Application.
ARCHIV_WCLOG_REPAIR
Archives workflows that have not yet been archived. Sometimes the archiving can fail (for example, a
wrong configuration could result in the archive being offline).
If this program also fails to archive your workflow, follow this procedure:
1. Run /COCKPIT/WC_SET_NOT_ARCHIVED.
This program resets the ARCHIVED flag so that the workflow can be archived again.
52
WORK CYCLE 7.2 SAP Configuration Guide
DUE_DATE_CHECK
You can use the DUE_DATE_CHECK program to send reminder emails for overdue workflows. Use the
standard SAP transaction, /SE38 to run the program once, or /SM36 to schedule it as a background job.
Setting Description
Workflow due date Specify if the program should only run for workflows whose due date is
past this date.
Overdue to specified date Select if you have specified a due date above.
Send collective emails You can set collective versus individual email sending in the
customizing of the workflow step. The program, when executed, will
check for processors who have received a workflow step and are now
due a new collective email.
WEB CYCLE user The user specified here is used as the sender of collective emails.
53
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
S – SAP user
G – User group
Show application log on Displays the SAP application log after the program has been executed.
finish
Object and Sub-object The object and sub-object that are included in the messages in the
SAP application log.
/COCKPIT/WC_CHK_DEL_USRS
Checks whether a user who no longer exists, is still assigned:
To user groups
To workflow steps
As a substitute
WC_DEBUG
Enables the creation of log entries for PROCESS DIRECTOR and WORK CYCLE RFC calls,
including those by the Web Application and User Exits. It can be used for debugging purposes. You can
record log entries for calls made by specific users.
54
WORK CYCLE 7.2 SAP Configuration Guide
WC_RFC_LOG
Displays all the RFC log entries (a record of the RFC calls made by the Web Application) stored in the
/COCKPIT/TWC_LOG table. That is, it displays all the log entries created by the WC_WEB_LOGGING function.
Setting Description
Show RFC log Displays the RFC log file saved in the /COCKPIT/TWC_LOG table.
Put separator after Displays a horizontal line between entries, after each specified period.
seconds
Delete all RFC log Deletes all the RFC log entries saved in the /COCKPIT/TWC_LOG table.
entries
WC_SET_NOT_ARCHIVED
This program resets the archive flag so that the workflow can be archived again with
/COCKPIT/ARCHIV_WCLOG_REPAIR.
/COCKPIT/WC_SET_NOT_ARCHIVED can be used for workflows that have been marked as archived, but
actually have the archive missing.
WC_UMA_PASSWD_INIT
This program is used to reset passwords for WORK CYCLE users, or to force them to change their
passwords when they next log in.
Setting Description
Selection
Email (in uppercase The email adress(es) of the WORK CYCLE user(s).
letters)
Language key The language setting for the WORK CYCLE user(s).
55
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
New password
Test run Displays a log of users whose passwords will be reset, without actually
performing the reset operation (where reset is either generating a new
password or forcing the user to change their password; see below).
Password is being Generates a new password for the WORK CYCLE user(s).
regenerated
User must change Forces WORK CYCLE user(s) to change their password(s) the next time
password
they log in.
WC_USER_UPDATE
This program is used to import users from an LDAP directory.
Setting Description
LDAP server The LDAP server ID configured in the SAP system. (They can be viewed
and managed using the LDAP transaction.)
Search filter Allows you to import only selected users, based on search criteria.
The default search filter is (&(objectclass=user)(mail=*)), which selects all
users.
Example: To select only users from a specific user group, you might use
(&(objectCategory=group)(description=Sales)).
System user active Uses the current SAP system user to log on to the LDAP server.
56
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
If this setting is not selected, you must specify the username and
password for an LDAP domain account to be used instead (see below).
User ID for logon Username for the LDAP domain account to log on to the LDAP server.
Password for logon Password for the LDAP domain account to log on to the LDAP server.
Send email Existing users whose data is updated are notified via email.
Retrieve WORK CYCLE Recalls (cancels) all workflows that are currently being processed by a
user whose data is updated.
Exclude from update Specify users whose data will not be updated by the import (even if
updated data exists).
Attribute value The value for the above field. If this value is found in any of the existing
users, they are deleted.
Note: The WC_USER_UPDATE program searches for the value in the
WORK CYCLE field that the above LDAP Attribute name has been
mapped to in /COCKPIT/WI27.
Delete all others Deletes any existing user whose data is not updated by the import.
Exclude from delete Specify existing users who are not deleted (only valid if Delete all others
is active).
Commit database Saves the imported data. If unselected, WC_USER_UPDATE performs a test
changes
run only and no data is imported or changed.
57
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Show application log on Displays the log after the import has been completed.
finish
Sub object The name of the Sub object to use to classify the log.
WC_WEB_LOGGING
This function module records all the RFC calls made by the Web Application. You should activate it in the
WC_DEBUG program. The resulting log messages can be viewed using the WC_RFC_LOG program.
XPRA_V720_SP0
This program is required only if you have upgraded to PROCESS DIRECTOR 7.2 from a previous version
and created Web Application (WUM) users in that previous version. This program ensures that it is
possible to search for WUM users by email addresses.
58
WORK CYCLE 7.2 SAP Configuration Guide
Appendix A – IMG
Setting the Web Application URL
/COCKPIT/WI1
Setting Description
URL of WORK CYCLE Web The URL that is used in email templates for workflow starts, reminders,
Application
and so on.
Note: This URL does not affect the setup or configuration of the Web
Application.
Setting Description
Workflow description The description of the workflow that appears in PROCESS DIRECTOR
Accounts Payable.
Maximum processing The period in which the workflow must be completed, after which daily
time, in days
reminder emails are sent.
Selection list order An integer that determines the position of the workflow in the workflow
selection list in PROCESS DIRECTOR Accounts Payable. 0 places the
workflow at the top of the list.
59
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
The values for this field for each workflow do not have to be in
sequential order. For example, you could have 0 = Workflow1, 5 =
Workflow2, 20 = Workflow3.
Save notes in archive Notes created in WORK CYCLE are saved in the archive.
Omit Determines whether Fridays, Saturdays and Sundays are used in the
Friday/Saturday/Sunday
calculation of the Maximum processing time (above).
You can select only a factory calendar or a holiday calendar, not both.
If both are selected, the factory calendar is used. If you want to use
both a factory and holiday calendar, assign a holiday calendar to a
factory calendar in /OY05, and then select a factory calendar here for
the workflow.
PD document type for The PD document type used when creating documents using WORK
document creation
CYCLE.
Mandatory note Before the workflow can be started, a WORK CYCLE note must be
created.
60
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Necessary settings
Setting Description
Step The description of the workflow step that appears in PROCESS DIRECTOR Accounts
description
Payable and WORK CYCLE.
Workflow 1 - Release: Document cannot be edited; only approved or rejected. Notes can
type be added. Document cannot be edited in PROCESS DIRECTOR Accounts
Payable while in a workflow.
Text of The text label of the Approve/Release button in the Web Application.
release
function Note: In the SAP GUI, the tooltip text is always Approve document.
61
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Subject of The subject of the email sent to the recipient(s) of the workflow step.
email
message
Text for the The content of the email sent to the recipient(s) of the workflow step. There are pre-
confirmation
installed templates you can use or copy and edit. For example:
email
/COCKPIT/WEB_CYCLE_START.
Field status The field status to apply to the document when it is opened in WORK CYCLE.
Note: If you leave the Field status blank, then no document edits are permitted.
Validity The period in which the workflow step must be completed, after which reminder emails
period
are sent.
Note that the sum total of the validity periods for all the workflow steps assigned to a
workflow must equal the Maximum processing time in the workflow configuration.
Interval for For overdue workflow steps, the interval of sending reminder emails (in days).
reminder
emails
Optional settings
Setting Description
Forward Determine if documents can be forwarded to other users, and if queries can be sent.
Not allowed
Document cannot be forwarded. Queries cannot be sent.
X - Forward
Document can be forwarded. Queries cannot be sent.
1 - Queries without document handover
Queries are allowed. After a query is sent, the document remains in the
sender's worklist. Forwarding is not allowed.
62
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
All recipients If activated, all the recipients of the workflow step must approve/release the
must
document in order for the document to move to the next workflow step, or for the
process
workflow to be completed (when the workflow step is the last in the workflow).
If deactivated, after one recipient has approved/released the document, the document
moves to the next workflow step/the workflow is completed.
Line Permits each line item (MM invoices) and accounting lines (FI invoices) to be
item/account
approved by separate processors. For example, when each processor is responsible
approval
for a different cost center.
Note: To use this feature, you must also select All recipients must process, above.
Send emails Determines if recipients of the workflow step receive an email notification, and if so,
what kind of email (single or collective, and if the document image is included as an
attachment.
Individual email without image attachment
A single email is sent to each recipient of the workflow step. The document
image is not included.
X - No email
No email is sent. Recipients must manually check their WORK CYCLE
worklists for new documents.
63
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
S - Collective email
A collective email is sent to each recipient of the workflow step. Collective
emails are scheduled and sent using the DUE_DATE_CHECK program.
Reject Specifies what happens when the workflow is rejected. The workflow can be canceled
completely, or the document can be returned to the first or previous workflow step
recipient or processor.
A recipient is the person to whom the workflow step is sent. A processor is the person
who actually approves or rejects the workflow step. In most cases, this will be the
same person. However, if the recipient forwards the document to another person, or
the recipient’s substitute processes the document, the processor is not the same
person as the recipient. Thus, it is possible to specify whether the document should
be returned to the person who received the workflow step or to the person who
actually processed it.
Important
If it is possible for this step to be a start step of a workflow, you must set this to: 1
Cancel the workflow.
Back to PROCESS DIRECTOR processor.
Document remains in the workflow, but a PROCESS DIRECTOR Accounts
Payable user must determine what action to take (cancel workflow, send
document to another recipient, etc.)
64
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
1 - Cancel workflow
Entire workflow is canceled.
Email Determines if notification emails are archived or not and if these emails can be edited
archive
before sending in WORK CYCLE.
X - Archive as a note
Notification emails are recorded as notes. Emails cannot be changed in
WORK CYCLE.
65
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Doc. upload Determines if processors can attach additional files to the document in the Web
Application.
Agent
Setting Description
Any email address Email users can be recipients of the workflow step.
Internet users WORK CYCLE users can be recipients of the workflow step.
Pre-assign processors Determines which users can be recipients and if any are pre-allocated.
66
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
1 - In WORK CYCLE*
The processor can only be assigned manually in WORK
CYCLE.
* Workflow step recalls are not possible when this option is active.
User Exits
You can activate User Exits at the following points to perform some action(s):
67
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Note settings
Setting Description
Note required Specifies when a note must be created before performing the following
steps:
Print cover sheet? This setting displays a Print cover sheet button when the document is
opened in the Web Application. When clicked, a PDF is opened in a
popup window that displays a cover sheet for the document.
Form name The name of the PDF form to use for the cover sheet.
68
WORK CYCLE 7.2 SAP Configuration Guide
Recipient settings
Setting Description
Single recipient of Only one user can be the recipient of the document. Other processors
workflow step
cannot be added.
Permitted recipient check Restrictions on which users can be recipients of a document in the
workflow step:
– None
Forward to arbitrary The document can be forwarded to users not listed in /COCKPIT/WUM2
processors
(non-default users).
* Only applicable if the Pre-allocate agent setting in /COCKPIT/WI3 is
set to Default or No default.
Query arbitrary The document can be forwarded to users not listed in /COCKPIT/WUM2
processors
(non-default users).
* Only applicable if the Pre-allocate agent setting in /COCKPIT/WI3 is
set to Default or No default.
PD message type Determines whether unassigned steps are checked when a workflow is
start/continue
started or continued in PROCESS DIRECTOR.
When a workflow is started or continued, if no recipient has been
assigned to certain steps and step customizing only allows a
PROCESS DIRECTOR user to assign steps, the user can be informed
of these missing step recipients by a pop-up:
69
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
The first character of this flag refers to the workflow start, the second
line refers to the workflow continuation.
Please note that recipients must be entered in the first item when a
workflow is started, and in the next item when a workflow is continued.
If this is not done, an error message will appear, which cannot be
overruled by any of the settings described here .
No processor takeover for As a result of setting this flag, automatic processing does not take
substitution
place if the step of a workflow goes to two processors, and one of the
processors is also the substitute of the other processor and takes over
processing.
Use
It makes sense to set this flag if all processors must process the
workflow step, and in the case of substitutes, manual take over of
processing by the substitute should be enforced, even though the
substitute is also a recipient of the workflow step.
Dependencies
The prerequisite for this is that the workflow step must be processed by
all recipients (All recipients must process).
Example
70
WORK CYCLE 7.2 SAP Configuration Guide
Default recipient type This setting determines the default recipient type. If only one user type
is defined in the workflow step settings, this user type is defaulted. If
several user types are defined in the step settings, it is possible to
define the default user type here.
Show all lines By default, workflow processors see only those lines that are assigned
to them, or the lines that are not assigned to anyone. Via this Show all
lines configuration option, it is possible to display the items (in read-
only mode) assigned to the other processors, rather than hiding them.
In this table, you pre-allocate recipients to workflow steps. To display the table, select a Workflow
ID/Workflow step combination and double-click Workflow processors.
Setting Description
Workflow processor The ID of the user who is a pre-allocated recipient of the workflow step.
S – SAP user
G – User group
Set default Indicates the user is a default processor (there can be more than one)
for the workflow step. The Pre-assign processors setting in the
workflow step configuration determines if non-default and/or default
users are pre-allocated to the step when the step is started. See the
Processor pre-allocation and assignment matrix for details.
71
WORK CYCLE 7.2 SAP Configuration Guide
There are two tables in this transaction. The first is to allocate workflow steps to workflow shells. The
next, accessed by double-clicking Define step conditions, is to specify conditions that the workflow step
must meet, for it to be executed.
Workflow processes
Setting Description
Position The position of the workflow step in the workflow, where 1 is the first
step in a workflow, 2 is the second step, and so on.
Note: A workflow step can be used in/assigned to more than one
workflow.
Step conditions
Setting Description
Item/Sequence Multiple conditions can be created. The Item number is the sequence
or order in which the condition is calculated.
72
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Internal field The name of the PROCESS DIRECTOR field that the condition
calculation is based on.
Inclusion/exclusion Indicates whether the From and To values (below) are included in the
calculation or not.
Comparative options The function to commpare the From and To values (below).
EQ – Same as from-value
NE – Different to from-value
From value/To value The values used in the calculation of the condition.
Note: To avoid errors, enter the values in the SAP internal format. For
example, for cost center 1000, enter 0000001000; for vendor 2500,
enter 0000002500.
Opening bracket/Closing If more than two conditions are specified, opening and closing brackets
bracket
can be used to perform a calculation block of two or more conditions,
before the next condition is calculated.
73
WORK CYCLE 7.2 SAP Configuration Guide
Activate workflows
/COCKPIT/WI7
Setting Description
FI/MM FI or MM documents.
In this table, you specify the Subjects and Texts of workflow emails for the following uses:
Use Description
Recalling a Sent when a workflow step is recalled, or the entire workflow is canceled.
workflow
Processing by a Sent to the original recipient of a workflow when a substitute takes over the
different user processing of a document.
74
WORK CYCLE 7.2 SAP Configuration Guide
Use Description
Collective emails Collective emails are emails that contain links to more than one document, which
are sent using the /COCKPIT/DUE_DATE_CHECK program. Collective emails are
activated in the workflow step configuration and are a replacement for sending
individual emails for every workflow a user receives.
In addition, you also specify the Sender of the email, which can be any SAP user.
Sending queries Sent when a user sends a query about a document to another user.
Forwarding a Sent when a user forwards a workflow to another user for processing.
workflow
There are built-in templates that you can use or modify for the email texts.
The text used for sending emails to workflow recipients is specified in the workflow step configuration
(Text for the confirmation email).
Setting Description
Authorization object The name of the SAP authorization object employed to permit access
to WORK CYCLE. If no authorization object is specified, all the SAP
users can access WORK CYCLE.
75
WORK CYCLE 7.2 SAP Configuration Guide
You have the ability to change the type of messages that are presented for different checks, as well as
suppress them completely. This applies to both PROCESS DIRECTOR and SAP messages. It could be
useful, for example, if you do not wish to have coding block (COBL) error messages appear for the
documents where no cost center has been assigned. You can apply such rules for all the workflow steps,
or restrict them to specific workflow steps.
Setting Description
Message check time The time when the check that you wish to change occurs.
Message ID The message class. See /SE91. The message class contains a
collection of messages (see Message No. below).
All PROCESS DIRECTOR message classes are saved in /COCKPIT/*.
Message No. The message ID. The actual message you wish to change or suppress.
See /SE91 for a list of message numbers and the message text.
Any message If active, the rule applies to all the messages; the Message ID and
Message No. are ignored.
Action The change to the type of message or error that is generated. Or,
whether the message is suppressed/ignored.
76
WORK CYCLE 7.2 SAP Configuration Guide
Here you can restrict which types of attachments in PROCESS DIRECTOR can be viewed in the Web
Application.
Setting Description
Web application The part of the Web Application where the attachment is to be hidden:
Document type The PROCESS DIRECTOR archive document type, which has to be
hidden.
Email settings
Email settings
/COCKPIT/WI30
Setting Description
Format P - Plain text: Emails are sent in plain text format. The remaining
settings in this table are ignored.
77
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
HTML start The start of the HTML email, from the <HTML> tag to the <BODY> tag.
Default: /COCKPIT/HTML_START
HTML end The end of the HTML email, from the </BODY> tag to the </HTML>
tag.
Default: /COCKPIT/HTML_END
MOBILE APPROVAL links The formatting of the MOBILE APPROVAL links for approving,
rejecting and adding notes to documents.
Default: /COCKPIT/HTML_MOBILE_BUTTONS
Number of fields per row The number of fields to appear in each table row.
A field consists of the field name and the field value. That is, two cells
are displayed.
Note: This setting is not used if MOBILE APPROVAL is active for a
workflow step. In this case, only one field/row is displayed.
Add multi acc. ass. to Determines if multi-account assignment fields (for MM documents) are
items
included as part of the line-item table, or is displayed as a separate
table.
Ignore MOBILE If MOBILE APPROVAL is active for a workflow step, only one field is
APPROVAL
displayed per table row and the Field numbers per row setting is not
used. By selecting Ignore MOBILE APPROVAL, the Number of
fields per row setting is used.
78
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Disable email background If you do not want to use a background image in the email, check this
check box.
Background The ID of the image to use for the background of the email.
If no background image is specified, the default (backgrnd.gif) is
used:
Use this table to specify the display names for the document URLs. That is, instead of displaying the
URL, a display name is used for the hyperlink.
Setting Description
Alias &WEB_CYCLE_DIRECT_DOCUMENT_LINK&
The URL of the Web Application for the list of documents to be
approved.
&WEB_CYCLE_DOCUMENT_LIST_LINK&
Same as above: The URL of the Web Application for the list of
documents to be approved. (Two aliases/variables exist to
provide backward compatibility with the previous versions of
PROCESS DIRECTOR Accounts Payable.)
&WEB_CYCLE_SINGLE_DOCUMENT_LINK&
The URL of the Web Application for a single document.
&WEB_CYCLE_SINGLE_SIGN_ON_LINK&
The URL of the Web Application logon page.
&WEB_CYCLE_SUBST_DOC_LIST_LINK&
The URL of the list of documents from a person for whom
another person is a substitute.
79
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Use this table to specify which fields are displayed in the HTML workflow emails.
Setting Description
Internal field name The name of the field in PROCESS DIRECTOR Accounts Payable.
This table lists the fields that can be displayed in the Web Application. If a field is not listed here, it cannot
be displayed in the Web Application.
Setting Description
80
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
* You can extend the /COCKPIT/SORDER table using fields from the BAPIEKPO (purchase order) and
BAPIEKBES (purchase order history) tables using the CI_COCKPIT_ORDER include.
Setting Description
No account assignment The account assignment fields for FI items in MM documents are
line with MM invoices
hidden.
81
WORK CYCLE 7.2 SAP Configuration Guide
Screen variants
Setting Description
PO data ...
Setting Description
H - Hide
82
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
M - Mandatory field
Normal field
Maintain default layouts for the WORK CYCLE transaction overview screen
/COCKPIT/WI12
Here you can specify the default layout, using variants, of the following sections in the WORK CYCLE
document list:
Displays menu items to execute custom functions. Use the PROCESS DIRECTOR User Exit 12
(/COCKPIT/USEX_CUSTFCT_PROCESS) to link menu items to functions.
Setting Description
83
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Setting Description
Op. mode Specifies whether the function should lock the document (no other
changes permitted while locked) or not.
Process several Specifies whether the function can be executed on more than one
documents
document simultaneously.
In this table, you can specify the permitted document types that can be uploaded in the Web Application.
The document types are the ones created for PROCESS DIRECTOR during installation, in /OAC2.
Document types must be listed here in order for Web Application users to upload files of that type in the
Web Application.
84
WORK CYCLE 7.2 SAP Configuration Guide
In this table, you list the archive document types to use when Web Application users fill in and submit
forms. If this table is empty, the first matching entry in /COCKPIT/C15 is used.
Setting Description
File name of form The filename (as it appears in the Web Application) of the form.
Document type The archive document type to use for the form. The document types
are the ones created for PROCESS DIRECTOR during installation, in
/OAC2.
This table contains additional fields displayed on the History > New invoice selection tab, when
searching for processed documents. These selection fields are also displayed in the SAP GUI Workflow
> Display releases (history) popup. The default fields are:
Workflow name
85
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Warning: Use the Radio button selection type only with fields with an
applicable type. Using it with fields whose types are CHARACTER or
INTEGER will result in incorrect search results.
Status description The display text for the field in the Web Application. If no text is
entered, the standard field name from the data dictionary is used.
Sequence The order in which the fields are displayed (lowest to highest value).
Note: The remaining configured fields are available via the Other selection fields button. Only simple
From-To selections are allowed; it is not possible to define ranges or single values.
86
WORK CYCLE 7.2 SAP Configuration Guide
In these tables, you can override and add additional search helps provided by the system. However, this
applies to only the Web Application.
Setting Description
Function module The function module that provides the search help for the specified
field.
Setting Description
Field name in search help The name of the field to display in the search results.
87
WORK CYCLE 7.2 SAP Configuration Guide
You must include the field that you added in the above table. It may be
the same (PROCESS DIRECTOR) field or the corresponding SAP
field.
Example: If TAX_CODE (a PROCESS DIRECTOR field) was in the
above table, you must add MWSKZ (an SAP field) to this table. If you
added FOLLOW_UP (a PROCESS DIRECTOR table) to the above table,
you can also add FOLLOW_UP to this table.
Priority The order of the fields, starting on the left with 1, then 2, 3, and so on.
ABAP type The data type (for example, Character string, Date, Time, etc.)
No. of characters The length of the field to display the field values.
Search/display Determines whether the field can used as input for searching and/or
displayed in the search results.
S – Search
D – Display
B – Both
Label The label of the field in the search form and the header of the result list
column.
Warning: If the label is not available in the language in which the user
is currently logged on, the entire field will not be displayed in the
search help.
88
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Table name Any table or structure that contains the field name and where a search
help has been provided for that field. Typically, this would be either:
/COCKPIT/SHDR_DISP
/COCKPIT/SITEM_DISP
/COCKPIT/SACCT_DISP
/COCKPIT/TACCAS
Search help name An elementary search help with the search help provided in the
table/structure above.
This table contains the default search helps for the Web Application. If you want to add/edit/suppress any
search help, do not edit this table; use /COCKPIT/WI19 instead.
Setting Description
89
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Function module The function module that provides the search help for the specified
field.
Field name in search help The name of the field to display in the search results.
Priority The order of the fields, starting on the left with 1, then 2, 3, and so on.
ABAP type The data type (for example, Character string, Date, Time, etc.)
No. of characters The length of the field to display the field values.
Search/display Determines whether the field can used as an input for searching and/or
displayed in the search results.
S – Search
D – Display
B – Both
Label The label of the field in the search form and the header of the result list
column.
90
WORK CYCLE 7.2 SAP Configuration Guide
Table name Any table or structure that contains the field name and where a search
help has been provided for that field.
Search help name An elementary search help with the search help provided in the
table/structure above.
Here you specify the user group that can view PROCESS DIRECTOR documents in the Web Application
(that is, any PROCESS DIRECTOR document, not just ones sent to these users in a workflow). You can
only specify one user group.
Setting Description
This table contains the document selection criteria for the PD documents tab.
Setting Description
91
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Alternative assignment The display text for the field in the Web Application. If no text is
entered, the standard field name from the data dictionary is used.
Sequence The order in which the fields are displayed (lowest to highest value).
When the ability to create invoices in the WORK CYCLE Web Application has been given (by activating
the wb_create parameter in webcycle-app.properties), you can list the default values for the
header fields.
Setting Description
PD document type The PROCESS DIRECTOR document type. A blank entry here will
make a value the default for all documents, unless an entry exists with
a specific document type.
Internal field name The name of the PROCESS DIRECTOR header field.
92
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Field value The value that is displayed for the field when creating a new invoice.
This table lists the one.time vendor fields that are displayed for the vendor record in the Web Application.
Setting Description
Vendor The name of the vendor. Can be used to apply different field settings to different vendors. If
left blank, the field setting is applied to all the vendors.
H - Hide
M - Mandatory field
Force a value to be entered in the field before the document can be saved.
Normal field
Priority The row position of the field, with 0 being the highest row. If more than one field has the
same row number, the fields are sorted alphabetically.
93
WORK CYCLE 7.2 SAP Configuration Guide
User management
This is the mapping table used by /COCKPIT/WC_USER_UPDATE to import users from an LDAP directory to
WORK CYCLE.
Setting Description
Internal field name A WORK CYCLE user field. Use the search help for possible fields
(from the /COCKPIT/TWC_UMP table).
Function module Optional. Use a function module to modify the import data before it is
saved in /COCKPIT/TWC_UMP. No standard function module exists—
you must write your own to modify the data as you wish.
This table contains various settings regarding the creation of new WORK CYCLE users.
Setting Description
User generation The method used to create WORK CYCLE usernames (if one is
not specified).
– Random name
Random characters are used to compose usernames.
94
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Mapping module The function module used to import user data from a file.
/COCKPIT/WC_MAP_IMP_EXAMPLE is a built-in example that can
be used to import users from CSV files.
Initial password The initial password for all users. Each user must change this
initial password when they first log in.
Use eMails
Create Mail Txt The email text to send to newly created users.
Mail Text to Subs The email text to send to substitutes for newly created or deleted
users.
Lock or unlock Sends an email to users who have been locked or unlocked.
Mailtext The email text to send to users who have been locked or
unlocked.
Mailtext The email text to send to users when their password changes.
95
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Duplicate check
Check user ID Validates whether an SAP user with the same user ID already
exists.
Check mail address Validates whether an SAP user with the same mail address
already exists.
Check name (first Validates whether an SAP user with the same first name and last
name/last name)
name already exists (for example: John Smith).
Check name (last Validates whether an SAP user with the same last name and first
name/first name)
name already exists (for example: Smith John).
You can create, edit and delete users, as well as perform the other tasks described below.
To perform most of these actions, you must first enter the username in the Workflow processor field.
Create Open the User data dialog box to enter the details of the new user.
Change Open the User data dialog box to change the details of an existing
user.
Display Open the User data dialog box to display the details of an existing
user.
96
WORK CYCLE 7.2 SAP Configuration Guide
Lock Lock the user. If the user is logged on when you apply the lock, they
can continue to work in the current session.
Warning: Locking or deleting users may result in unfinished workflows.
For example, if the locked or deleted user is the sole user assigned to
the last workflow step, the workflow cannot be completed. In such
cases, the workflow must be recalled.
Import Open the Import user dialog box, where you can specify the file to
import users from. The function module for performing the import is
specified in /COCKPIT/WI6.
97
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Assigned processors
User type There are three kinds of users that can be included in user
groups:
S – SAP user
G – User group
98
WORK CYCLE 7.2 SAP Configuration Guide
When search help is used inside SAP to select the users for a workflow (for example, when a PROCESS
DIRECTOR user starts a workflow), the search help for finding users looks at all users of the specified
user type (SAP, WORK CYCLE, and User Group). However, you can restrict which users are searched
by:
1. Writing a function for the specific user search you wish to implement.
2. Specifying the User type for which this search will be used in the above table.
Note: This configuration only affects user search helps for WORK CYCLE in the SAP GUI. It does not
affect user search helps in the Web Application.
Setting Description
User type The type of user for which the search help function will be used.
G – User group
Here you specify the substitute profile in SAP that takes precedence when allocating substitutes. The
profile is also assigned to new substitutes created using the Web Application.
See Using a substitute profile for the full explanation.
99
WORK CYCLE 7.2 SAP Configuration Guide
Set notes
Here you can restrict which types of attachments to PROCESS DIRECTOR can be viewed in the Web
Application.
Setting Description
Document type WORK The document type to use for archiving WORK CYCLE notes. The
CYCLE notes document type must be listed in /OAC2.
If PDF is used, a form must be entered for the creation of the PDF (see
Form for creating PDFs below). The /COCKPIT/TEXT form is
available, but can be changed if a new form has to be used.
Form for creating PDFs The form to use to create PDFs from WORK CYCLE notes. Mandatory
if archiving as PDFs.
Document type internal The document type to use for archiving internal notes.
notes
100
WORK CYCLE 7.2 SAP Configuration Guide
Setting Description
Comment symbol for note The character to use to denote comments in the note's title (which
title
displays the note's metadata, such as Subject, Creator, etc.). For
example, using * will result in:
*** 24 / 24 ********************************************************************
********************************************************************************
These settings are system based and may not be changed. They are supplied as default WORK CYCLE
settings. However, further note types can be defined for individual extensions, which must exist in the
customer's own SAP area; meaning they begin with Z* or Y*.
101
WORK CYCLE 7.2 SAP Configuration Guide
Amendments
Setting Description
User Exits The ID of the PROCESS DIRECTOR template that the User Exit is
based on. It is necessary for the correct connection of the User Exit to
the processes, to be adjusted.
4. Under Field status identification, specify if header fields, line-item fields, and/or account
assignment fields should be made read-only.
Checking No account assignment line with MM invoices hides the account assignment fields
section for the FI items in MM documents.
6. Specify the individual fields that will be hidden, read-only, mandatory, or normal.
Note: Mandatory fields here prevent the document from being saved if the field has no value.
102
WORK CYCLE 7.2 SAP Configuration Guide
8. Go to /COCKPIT/WI3.
9. Open the desired workflow step and enter the name of the Field status you created.
Note: The field status is activated for only the selected workflow step, and not for PROCESS
DIRECTOR. Field statuses for PROCESS DIRECTOR are activated in /COCKPIT/C24.
Example
Objective: To make all header fields read-only, except for:
Assignment Hidden
103
WORK CYCLE 7.2 SAP Configuration Guide
Result:
104
WORK CYCLE 7.2 SAP Configuration Guide
Interface structure
The interface structures and tables in the local interface of the User Exit function templates start with I, E,
and C.
Prefix Description
105
WORK CYCLE 7.2 SAP Configuration Guide
The User Exit templates are saved in various /COCKPIT/* function groups.
Note: Be sure to copy the function module to your own custom function group.
106
WORK CYCLE 7.2 SAP Configuration Guide
107
WORK CYCLE 7.2 SAP Configuration Guide
108
WORK CYCLE 7.2 SAP Configuration Guide
LDAP User Exit Assign LDAP attribute to WORK CYCLE user field
1
109
WORK CYCLE 7.2 SAP Configuration Guide
After a user has started the Send to workflow action and before the Start Workflow in WORK
CYCLE dialog box is displayed.
In this case, the User Exit is used to adjust the list of workflows available in the popup window.
In this case, the User Exit is used to prevent a workflow from being started.
Template
FUNCTION /COCKPIT/WC_USEX_BEFORE_START.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" EXPORTING
*" REFERENCE(EC_PROC_WC) LIKE /COCKPIT/THIST-PROCESS
*" TABLES
110
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" CHANGING
*" EXCEPTIONS
*" ERROR_OCCURED
ENDFUNCTION.
Example
The following example prevents the TestWorkflow workflow from being started:
FUNCTION Z_BL872_WC_USEX_BEFORE_START.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" EXPORTING
*" TABLES
111
WORK CYCLE 7.2 SAP Configuration Guide
*" CHANGING
*" REFERENCE(EC_WEBCYCLE_ID)
*" EXCEPTIONS
*" ERROR_OCCURED
*"----------------------------------------------------------------------
IF ec_webcycle_id EQ 'TestWorkflow'.
ls_message-type = 'E'.
ls_message-id = 'Error'.
ls_message-number = '002'.
RAISE error_occured.
ELSE.
ls_message-id = 'Warning'.
ls_message-number = '001'.
APPEND ls_message TO et_message.
ENDIF.
ENDFUNCTION.
112
WORK CYCLE 7.2 SAP Configuration Guide
Template
FUNCTION /COCKPIT/WC_USEX_TEXT_ADAPT.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" OPTIONAL
*" OPTIONAL
*" REFERENCE(IC_DOCU_OBJECT) LIKE DOKHL-OBJECT OPTIONAL
*" EXPORTING
113
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" TABLES
ENDFUNCTION.
User Exit 902 – Determine all WORK CYCLE workflows for one processor
This User Exit is called at the end of the API function that determines the list of documents that are in
WORK CYCLE for a specific user.
Template
FUNCTION /cockpit/wc_usex_docs_for_user.
*"----------------------------------------------------------------------
*" TABLES
ENDFUNCTION.
114
WORK CYCLE 7.2 SAP Configuration Guide
User Exit 903 – Change WORK CYCLE notes and releases to be archived
This User Exit is called immediately before the WORK CYCLE workflow log is written to the archive. If the
No standard flag is set, the standard print functionality that creates an archive document from the actual
lines of text, is skipped.
Template
FUNCTION /cockpit/wc_usex_docs_for_user.
*"----------------------------------------------------------------------
*" IMPORTING
*" /COCKPIT/THDR
*" REFERENCE(IB_UPDATETASK) LIKE BOOLE-BOOLE
*" EXPORTING
*" TABLES
*" ERROR_OCCURED
ENDFUNCTION.
115
WORK CYCLE 7.2 SAP Configuration Guide
Template
FUNCTION /COCKPIT/WC_USEX_SUBJ_ADAPT.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" OPTIONAL
*" REFERENCE(IC_WC_NAME) LIKE /COCKPIT/SWC_WEBCYCLE-WC_NAME
*" OPTIONAL
*" OPTIONAL
*" OPTIONAL
*" OPTIONAL
*" EXPORTING
*" REFERENCE(EB_NO_STANDARD) LIKE BOOLE-BOOLE
*" CHANGING
116
WORK CYCLE 7.2 SAP Configuration Guide
Template
FUNCTION /COCKPIT/WC_USEX_REMINDER.
*"----------------------------------------------------------------------
*" IMPORTING
*" /COCKPIT/TWCS
*" REFERENCE(IS_HEADER) LIKE /COCKPIT/THDR STRUCTURE
*" /COCKPIT/THDR
*" /COCKPIT/SWC_STEP
*" OPTIONAL
*" EXPORTING
*" REFERENCE(EB_NO_STANDARD) LIKE BOOLE-BOOLE
*" TABLES
117
WORK CYCLE 7.2 SAP Configuration Guide
Template
FUNCTION /COCKPIT/WC_USEX_AFTER_START.
*"----------------------------------------------------------------------
*" IMPORTING
*" CHANGING
*" EXCEPTIONS
*" ERROR_OCCURED
ENDFUNCTION.
118
WORK CYCLE 7.2 SAP Configuration Guide
Template
FUNCTION /COCKPIT/WC_USEX_AFTER_REMIND.
*"----------------------------------------------------------------------
*" IMPORTING
*" TABLES
*" ET_MESSAGES STRUCTURE BAPIRET2 OPTIONAL
ENDFUNCTION.
Template
FUNCTION /COCKPIT/WC_USEX_START_MAIL.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" EXPORTING
*" REFERENCE(EB_NO_STANDARD) LIKE BOOLE-BOOLE
*" TABLES
119
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" CHANGING
*" EXCEPTIONS
*" ERROR_OCCURED
ENDFUNCTION.
Template
FUNCTION /COCKPIT/WC_USEX_SUBST_GET.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
120
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" EXPORTING
*" TABLES
*" EXCEPTIONS
*" NOT_FOUND
ENDFUNCTION.
User Exit 910 – Own logic for determining user type and email
This User Exit is called at the beginning of the function that determines the user type from a user ID or the
user type and the user ID from an email address. If the No standard flag is set, the standard procedure
for user (type) determination is skipped.
Template
FUNCTION /COCKPIT/WC_USEX_USRTYPE_GET.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" EXPORTING
121
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" EXCEPTIONS
*" USER_DOESNT_EXIST
*" NO_EMAIL_ADDRESS
ENDFUNCTION.
Template
FUNCTION /COCKPIT/WC_USEX_SUBTE_GET.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" REFERENCE(I_USER) LIKE /COCKPIT/TWCS-WC_USER
*" EXPORTING
*" REFERENCE(EB_NO_STANDARD) LIKE BOOLE-BOOLE
*" TABLES
*" ET_SUBSTITUTION STRUCTURE /COCKPIT/S_SUBSTITUTION
*" EXCEPTIONS
*" NOT_FOUND
122
WORK CYCLE 7.2 SAP Configuration Guide
Template
ENDFUNCTION.
Template
FUNCTION /COCKPIT/WC_USEX_SEND_MAIL.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" EXPORTING
*" TABLES
*" CHANGING
123
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" /COCKPIT/TWC_CML-WC_REC_USR_TYPE
*"----------------------------------------------------------------------
ENDFUNCTION.
124
WORK CYCLE 7.2 SAP Configuration Guide
Template
FUNCTION /COCKPIT/WC_USEX_FINISHED.
*"----------------------------------------------------------------------
*" IMPORTING
*" /COCKPIT/SWC_IF
*" REFERENCE(IS_WEBCYCLE) LIKE /COCKPIT/SWC_WEBCYCLE STRUCTURE
*" /COCKPIT/SWC_WEBCYCLE
*" TABLES
*" CHANGING
*" /COCKPIT/SHDR_IF
*" /COCKPIT/TWC
*" EXCEPTIONS
*" ERROR_OCCURED
ENDFUNCTION.
125
WORK CYCLE 7.2 SAP Configuration Guide
User Exit 914 – Adjust call of SAP API for sending emails
With this User Exit, it is possible to adjust almost every parameter of an email (for example, the subject
and sender).
Template
FUNCTION /COCKPIT/WC_USEX_API_MAIL.
*"----------------------------------------------------------------------
*" TABLES
*" CHANGING
*" SODOCCHGI1
ENDFUNCTION.
*"----------------------------------------------------------------------
* !! IMPORTANT !!
126
WORK CYCLE 7.2 SAP Configuration Guide
Template
FUNCTION /COCKPIT/WC_USEX_CHECK_COBL.
*"----------------------------------------------------------------------
*" /COCKPIT/SACCT_IF
*" REFERENCE(IS_HEADER) LIKE /COCKPIT/SHDR_IF STRUCTURE
*" /COCKPIT/SHDR_IF
*" EXPORTING
*" TABLES
*" CHANGING
127
WORK CYCLE 7.2 SAP Configuration Guide
User Exit 916 – Adjust/Replace account assignment block check for vendor
Ps
This User Exit provides an interface to disable or adjust the Accounts Payable Coding Block check
(COBL_INT check). The main purpose of this User Exit is to disable this check under certain
circumstances, or to modify the data before the check is performed. If the No standard flag is set, the
standard check is replaced. If the flag is not set, the User Exit is executed in addition to (and before) the
standard check.
Template
FUNCTION /COCKPIT/WC_USEX_CHECK_APCOBL.
*"----------------------------------------------------------------------
*" IMPORTING
*" /COCKPIT/SACCT_IF
*" /COCKPIT/SHDR_IF
*" EXPORTING
ENDFUNCTION.
*"----------------------------------------------------------------------
DATA:
128
WORK CYCLE 7.2 SAP Configuration Guide
Template
TRANSPORTING msgv1.
CHECK sy-subrc EQ 0.
ls_index = sy-tabix.
SELECT SINGLE txt FROM tj01t INTO ls_txt WHERE vrgng = 'COIN' AND
spras = sy-langu.
CHECK sy-subrc EQ 0.
Template
FUNCTION /cockpit/wc_usex_data_check.
*"----------------------------------------------------------------------
*" IMPORTING
*" REFERENCE(IS_WEBCYCLE) LIKE /COCKPIT/SWC_IF STRUCTURE
129
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" /COCKPIT/SWC_IF
*" /COCKPIT/SHDR_IF
*" TABLES
ENDFUNCTION.
*"----------------------------------------------------------------------
* the WebApp.
EXPORTING
i_type = 'E'
i_id = '/COCKPIT/CHK'
i_number = '005'
i_message_v1 = it_item-invoice_item
TABLES
c_tab_messages = et_messages.
ENDLOOP.
ENDFUNCTION.
130
WORK CYCLE 7.2 SAP Configuration Guide
Template
Template
FUNCTION /COCKPIT/WC_USEX_FILE_UPLOAD .
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" EXPORTING
*" REFERENCE(EB_NO_STANDARD) LIKE BOOLE-BOOLE
*" TABLES
*" IT_CONTENT STRUCTURE TBL1024
131
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" ERROR_OCCURED
ENDFUNCTION.
Template
FUNCTION /cockpit/wc_usex_get_due_date.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" /COCKPIT/SWC_WEBCYCLE
*" /COCKPIT/SWC_STEP
*" EXPORTING
*" VALUE(ED_DUE_DATE) LIKE /COCKPIT/TWCS-WC_DUEDATE
132
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" TABLES
*" CHANGING
*" EXCEPTIONS
*" DUE_DATE_UNREACHABLE
ENDFUNCTION.
User Exit 920 – Amend work item creation for SAP Business Workflow
When a workflow is started, a work item for the SAP Business Workplace is created. This User Exit
provides the possibility to modify the data that is used to create this work item. If the No standard flag is
set, the standard function to create the work item is not called.
Template
FUNCTION /COCKPIT/WC_USEX_WORKITEM.
*"----------------------------------------------------------------------
*" EXPORTING
*" REFERENCE(EB_NO_STANDARD) LIKE BOOLE-BOOLE
*" TABLES
133
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" CHANGING
*" EXCEPTIONS
*" ERROR_OCCURED
ENDFUNCTION.
User Exit 921 – Adapt what data the Web Application gets
This User Exit is called after the complete document data is read upon a “data get” call from the Web
Application. All the document data is available and can be modified in any way. The User Exit call is the
last statement in the “data get” RFC. Therefore, ensure that the messages table is properly filled. Also, do
not raise an exception.
Template
FUNCTION /cockpit/wc_usex_rfc_data_get.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
134
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" OPTIONAL
*" 999
*" CON_FALSE
*" SPACE
*" TABLES
*" ET_ITEM STRUCTURE /COCKPIT/SITEM_IF OPTIONAL
135
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" CHANGING
ENDFUNCTION.
136
WORK CYCLE 7.2 SAP Configuration Guide
Template
FUNCTION /cockpit/wc_usex_get_multi.
*"----------------------------------------------------------------------
*" CHANGING
*" ERROR_OCCURED
ENDFUNCTION.
137
WORK CYCLE 7.2 SAP Configuration Guide
User Exit 923 – User check during logon to the Web Application
This User Exit provides the possibility to authenticate a user when logging on to the Web Application by
using the user ID and password. The user ID is passed as IC_USER_EMAIL and the password as
IC_PASSWORD. If the No standard flag is set, the User Exit replaces the standard authentication. If so, the
User Exit must not only verify the existence of the user and the correctness of the password, but must
also determine the user ID, the user type and the user language.
The User Exit is also called when a user changes the password in the Web Application. In such cases,
the user ID and type are already known, so they are passed, instead of IC_USER_EMAIL.
IC_NEWPASSWORD is filled with the new password specified by the user.
Template
FUNCTION /COCKPIT/WC_USEX_RFC_USER_CHK.
*"----------------------------------------------------------------------
*" EXPORTING
ENDFUNCTION.
*"----------------------------------------------------------------------
138
WORK CYCLE 7.2 SAP Configuration Guide
Template
Template
FUNCTION /COCKPIT/WC_USEX_WEB_SUB_SET.
*"----------------------------------------------------------------------
*" IMPORTING
*" TABLES
139
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" OTHERS
ENDFUNCTION.
Template
FUNCTION /COCKPIT/WC_USEX_SAP_SUB_SET.
*"----------------------------------------------------------------------
User Exit 926 – Adapt search help determination for check tables
This User Exit is called when a “check table”-based value search is called from the Web Application. The
User Exit can override settings from the search help configuration in order to influence the search
behavior.
Template
FUNCTION /COCKPIT/WC_USEX_SHLP_BYTABLE.
*"----------------------------------------------------------------------
140
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" OPTIONAL
*" OPTIONAL
*" EXPORTING
*" /COCKPIT/CWCSHSH
ENDFUNCTION.
Template
FUNCTION /COCKPIT/WC_USEX_LOGON_SET.
*"----------------------------------------------------------------------
*" CHANGING
*" REFERENCE(CS_MESSAGE) LIKE BAPIRET2 STRUCTURE BAPIRET2
*" OPTIONAL
*"----------------------------------------------------------------------
ENDFUNCTION.
141
WORK CYCLE 7.2 SAP Configuration Guide
Template
FUNCTION /cockpit/wc_usex_cpd_get.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" /COCKPIT/THDR
*" TABLES
*" /COCKPIT/TCPDK
ENDFUNCTION.
Template
FUNCTION /COCKPIT/WC_USEX_CPD_SET.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" REFERENCE(IS_HEADER) LIKE /COCKPIT/THDR STRUCTURE
142
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" /COCKPIT/THDR
*" /COCKPIT/TCPDK
*" EXPORTING
*" TABLES
ENDFUNCTION.
Template
FUNCTION /COCKPIT/WC_USEX_USER_PW_RESET.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" EXPORTING
*" REFERENCE(EC_PASSWORD) LIKE BAPIUID-PASSWORD
*" /COCKPIT/TWB_UMP
*" REFERENCE(ES_MESSAGE) LIKE BAPIRET2 STRUCTURE BAPIRET2
*" CHANGING
143
WORK CYCLE 7.2 SAP Configuration Guide
FUNCTION /COCKPIT/WC_USEX_USER_GET.
*"----------------------------------------------------------------------
*"*"Lokale Schnittstelle:
*" IMPORTING
*" EXPORTING
*"----------------------------------------------------------------------
144
WORK CYCLE 7.2 SAP Configuration Guide
Template
**SAMPLE CODING
*ec_user = 'SCHMIDT'.
*ENDIF.
ENDFUNCTION.
Template
FUNCTION /cockpit/wc_usex_user_get2.
*"----------------------------------------------------------------------
*"*"Lokale Schnittstelle:
*" IMPORTING
145
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" OPTIONAL
*" CHANGING
*"----------------------------------------------------------------------
DATA:
lt_split LIKE TABLE OF /cockpit/twc_ump-name WITH HEADER LINE,
CASE ic_usertype.
WHEN con_sap_user.
146
WORK CYCLE 7.2 SAP Configuration Guide
Template
SEPARATED BY space.
WHEN con_internet_user.
IF sy-subrc NE 0.
* to 'Lastname, Firstname'
IF sy-subrc EQ 0.
CLEAR cc_name.
LOOP AT lt_split.
lc_lastname = lt_split.
AT LAST.
SEPARATED BY space.
EXIT.
ENDAT.
ENDLOOP.
ENDIF.
147
WORK CYCLE 7.2 SAP Configuration Guide
Template
CONDENSE cc_name.
ENDIF.
WHEN con_partner_user.
* nothing todo
WHEN OTHERS.
* nothing todo
ENDCASE.
* CASE ic_usertype.
* WHEN con_sap_user.
** nothing todo
* WHEN con_internet_user.
* IF sy-subrc EQ 0.
* SEPARATED BY space.
* ENDIF.
* WHEN con_partner_user.
** nothing todo
* WHEN OTHERS.
** nothing todo
* ENDCASE.
ENDFUNCTION.
148
WORK CYCLE 7.2 SAP Configuration Guide
Template
FUNCTION /cockpit/wc_usex_approved_get.
*"----------------------------------------------------------------------
*"*"Lokale Schnittstelle:
*" IMPORTING
*" TABLES
*" IR_WC_ID STRUCTURE /COCKPIT/RWC_ID
*" NOT_FOUND
*"----------------------------------------------------------------------
149
WORK CYCLE 7.2 SAP Configuration Guide
Template
TYPES:
BEGIN OF ys_user_map,
END OF ys_user_map.
STATICS:
DATA:
sb_old_user = con_true.
ls_user_map-new_wc_usertype = con_sap_user.
150
WORK CYCLE 7.2 SAP Configuration Guide
Template
ls_user_map-new_wc_user = 'GERKE'.
ls_user_map-old_wc_usertype = con_sap_user.
ls_user_map-old_wc_user = 'GERKE2'.
new_wc_user = ic_wc_user.
IF sy-subrc EQ 0.
EXPORTING
ic_wc_usertype = ls_user_map-old_wc_usertype
ic_wc_user = ls_user_map-old_wc_user
ic_language = ic_language
ib_all_wcs = ib_all_wcs
TABLES
ir_wc_id = ir_wc_id
ir_timestamp = ir_timestamp
it_input_sel = it_input_sel
et_header = lt_header
et_webcycle = lt_webcycle
et_approved = lt_approved
et_approver = lt_approver
et_flag = lt_flag
et_messages = lt_messages
EXCEPTIONS
not_found =1
151
WORK CYCLE 7.2 SAP Configuration Guide
Template
OTHERS = 2.
ENDIF.
CLEAR sb_old_user.
ENDFUNCTION.
Template
FUNCTION /COCKPIT/WC_USEX_GET_FLOW.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*"----------------------------------------------------------------------
*@US@aa => Signature of Creator, e.g. HH for Harry Hirsch
152
WORK CYCLE 7.2 SAP Configuration Guide
Template
ENDFUNCTION.
FUNCTION /COCKPIT/WC_USEX_NOTE_CHECK.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" /COCKPIT/SWC_IF
*" EXCEPTIONS
*" ERROR_OCCURED
*"----------------------------------------------------------------------
153
WORK CYCLE 7.2 SAP Configuration Guide
Template
ENDFUNCTION.
LDAP User Exit 1 - Assign LDAP attribute to WORK CYCLE user field
Template
FUNCTION /cockpit/wc_usex_ldapsimplemap.
*"----------------------------------------------------------------------
*"*" Local interface:
*" IMPORTING
*" EXPORTING
ENDFUNCTION.
Search help User Exit – Search help for a field in the Web Application
This User Exit is called when a value is searched (using search help) in the Web Application. The User
Exit can override settings from the search help configuration, to influence the search behavior.
Template
FUNCTION /cockpit/wc_usex_shlp.
*"----------------------------------------------------------------------
*" IMPORTING
154
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" TABLES
*" EXCEPTIONS
*" NO_SHLP_FOUND
*" INVALID_GUID
ENDFUNCTION.
*"----------------------------------------------------------------------
* it_input_fields-name eq 'COMP_CODE'
* it_input_fields-value eq '1*'
* only company codes which start with the digit one are requested
et_results-num = '0'.
et_results-name = 'COMP_CODE'.
et_results-value = '0001'.
APPEND et_results.
et_results-num = '0'.
et_results-name = 'NAME'.
APPEND et_results.
et_results-num = '1'.
et_results-name = 'COMP_CODE'.
155
WORK CYCLE 7.2 SAP Configuration Guide
Template
et_results-value = '1000'.
APPEND et_results.
et_results-num = '1'.
et_results-name = 'NAME'.
APPEND et_results.
Template
FUNCTION /cockpit/wc_usex_conditions.
*"----------------------------------------------------------------------
*" IMPORTING
*" /COCKPIT/SHDR_IF
*" /COCKPIT/SWC_STEP
*" REFERENCE(IS_WC_FLOW) LIKE /COCKPIT/SWC_FLOW STRUCTURE
*" TABLES
*" IT_ITEM STRUCTURE /COCKPIT/SITEM_IF
156
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" EXCEPTIONS
*" NOT_VALID
ENDFUNCTION.
In addition to determining the recipient of a document, you can also use this User Exit to assign line and
accounting items to processors. Use the ET_ITM_RCVR structure for this purpose.
Template
FUNCTION /cockpit/wc_usex_receivers.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" /COCKPIT/SWC_WEBCYCLE
*" REFERENCE(IS_WC_STEP) LIKE /COCKPIT/SWC_STEP STRUCTURE
*" /COCKPIT/SWC_STEP
157
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" TABLES
*" EXCEPTIONS
*" NOT_FOUND
*"----------------------------------------------------------------------
* is 'Q' on query
et_receiver-wc_usertype = 'S'.
et_receiver-wc_user = 'WCTEST1'.
APPEND et_receiver.
et_receiver-wc_user = 'WCTEST2'.
APPEND et_receiver.
158
WORK CYCLE 7.2 SAP Configuration Guide
Template
et_receiver-wc_user = 'WCTEST3'.
et_receiver-wc_def_user = 'X'.
APPEND et_receiver.
et_receiver-wc_user = 'WCTEST4'.
APPEND et_receiver.
ENDFUNCTION.
This User Exit is activated per workflow step, and must be specified in Logic after the step action has
been performed in the workflow step definition (/COCKPIT/WI3).
Template
FUNCTION /COCKPIT/WC_USEX_CHECK_ACTION .
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" /COCKPIT/SWC_IF
*" REFERENCE(IS_WEBCYCLE) LIKE /COCKPIT/SWC_WEBCYCLE STRUCTURE
*" /COCKPIT/SWC_WEBCYCLE
159
WORK CYCLE 7.2 SAP Configuration Guide
Template
*" TABLES
*" CHANGING
*" /COCKPIT/SHDR_IF
*" EXCEPTIONS
*" ERROR_OCCURED
*"----------------------------------------------------------------------
ENDFUNCTION.
160
WORK CYCLE 7.2 SAP Configuration Guide
This User Exit is activated per workflow step, and must be specified in Logic after the step has been
released in the workflow step definition (/COCKPIT/WI3).
Template
FUNCTION /COCKPIT/WC_USEX_AFTER_EXEC.
*"----------------------------------------------------------------------
*" IMPORTING
*" REFERENCE(IS_WC_DATA) LIKE /COCKPIT/SWC_IF STRUCTURE
*" /COCKPIT/SWC_IF
*" /COCKPIT/SWC_STEP
*" TABLES
*" /COCKPIT/SHDR_IF
*" EXCEPTIONS
*" ERROR_OCCURED
ENDFUNCTION.
161
WORK CYCLE 7.2 SAP Configuration Guide
Template
FUNCTION /COCKPIT/WC_USEX_USER_CHECK.
*"----------------------------------------------------------------------
*"*"Local interface:
*" IMPORTING
*" /COCKPIT/SHDR_IF
*" OPTIONAL
*" EXPORTING
ENDFUNCTION.
162
WORK CYCLE 7.2 SAP Configuration Guide
2. Go to /SE71.
4. Enter the Form name, Source client and Target form (name).
163
WORK CYCLE 7.2 SAP Configuration Guide
164
WORK CYCLE 7.2 SAP Configuration Guide
Index
/ /COCKPIT/WUM2 71
/COCKPIT/C31 79 A
/COCKPIT/C32 80 accounting lines
/COCKPIT/WBI7 92 approving individually 11
/COCKPIT/WC_WCID 59 activating workflows 8
/COCKPIT/WI1 59 appearance
/COCKPIT/WI10 101 HTML email templates 27
/COCKPIT/WI11 80 ARCHIV_NOTE_LATE 52
/COCKPIT/WI12 83 ARCHIV_WCLOG_REPAIR 52
/COCKPIT/WI13 75 archiving
/COCKPIT/WI14 83 notes 52
/COCKPIT/WI16 85 attachments
/COCKPIT/WI17 68 supported for upload in Web App 84
/COCKPIT/WI19 87 C
/COCKPIT/WI22 76 conditions 12
/COCKPIT/WI24 85 creating 12
/COCKPIT/WI25 91 configuration
/COCKPIT/WI26 91 other tasks 16
/COCKPIT/WI27 94 copying/forms to other clients 163
/COCKPIT/WI28 77 D
/COCKPIT/WI29 93 deleting
/COCKPIT/WI3 61 workflows 15
/COCKPIT/WI30 77 documents
/COCKPIT/WI33 99 viewing ones not in a workflow 29
/COCKPIT/WI4 72 E
/COCKPIT/WI5 99 email templates
/COCKPIT/WI6 94 built-in 21
/COCKPIT/WI7 74 changing HTML styles 27
URL 59
/COCKPIT/WI8 100
using HTML 26
/COCKPIT/WI9 74
emails
/COCKPIT/WUM1 98
165
WORK CYCLE 7.2 SAP Configuration Guide
166
WORK CYCLE 7.2 SAP Configuration Guide
167
WORK CYCLE 7.2 SAP Configuration Guide
168