Predefined Callable Objects

Form

Data Input Form

Type: Web Dynpro Component (GP Interface)

Functionality: Provides a form for data input.

Component: com.sap.caf.eu.gp.ui.wdco.dataform.WDCODataForm

Application: sap.com/caf~eu~gp~ui~wdco

Output parameters: To enable the form processor to enter data and to send it to the system, you must define output parameters. At runtime, they are available as input fields and the data is sent to the framework when the process step is complete.

Result states:

• SUBMIT - Reached when the data entered is submitted.

Data Display Form

Type: Web Dynpro Component (GP Interface)

Functionality: Displays the input data passed to the callable object. The callable object also provides an OK button to enable the explicit completion of the object execution.

Component: com.sap.caf.eu.gp.ui.wdco.datadisp.WDCODataDisplay

Application: sap.com/caf~eu~gp~ui~wdco

Input parameters: To map the output of the other callable objects and to get the displayed data, you must define input parameters.

Result states:

• SUBMIT - Reached when the data entered is submitted.

Data Display and Acknowledgement

Type: Web Dynpro Component (GP Interface)

Functionality: Displays the input data passed to the callable object. Users can acknowledge that they have read the data as well as enter a comment. Optionally, they can also notify other process contributors by sending an acknowledgement notification via e-mail.

Component:com.sap.caf.eu.gp.ui.wdco.acknowledge.WDCOAcknowledge

Application: sap.com/caf~eu~gp~ui~wdco

Input parameters: To map the output of the other callable objects and get the displayed data, you must define input parameters.

Configuration parameters:

• Technical Name(mail.techname) - technical name of the e-mail template.

  You can select one of the e-mail templates you (or the administrator of the system) have created in advance.

  More information: Managing E-Mail Templates

• Recipients (mail.recipients)

  You can configure an e-mail notification to the following process contributors upon acknowledgement:

  • Initiator - Only the initiator receives a message.
  • Owner - Only the owner receives a message.
  • Contributor - Everyone who has already contributed to the process receives a message.
  • Processor - Only the processor receives a message.
  • Administrator - Everyone who has an administrator receives a message.
  • Overseer - Everyone who has an overseer role receives a message.

  More information: Process Roles

Result states:

• ACKNOWLEDGE - Reached when the user has chosen option Acknowledge.
• ACKNOWLEDGE_MAIL - Reached when the user has chosen option Acknowledge & Notify.

Process Control

Visual Approval

Type: Web Dynpro Component (GP Interface)

Functionality: Enables users to approve or reject certain requests.

Component: com.sap.caf.eu.gp.ui.wdco.approval.WDCOApproval

Application: sap.com/caf~eu~gp~ui~wdco

Input parameters: You can create input parameters that you typically map to the output of a preceding action in a process.

Output parameters:

• Processor (output.processor) - Processor of the request.
• Date (output.date) - Exact date and time of the request action.
• Comment (output.comment) - Additional comments.

Configuration parameters:

Using the configuration parameters of the callable object, you can configure it to notify selected process contributors that the request has been approved or rejected. You can set up different e-mail templates for approval or rejection.

• Approve e-mail(approve.mail.techname) - Technical name of the e-mail template to be sent in case of approval. You can select one of the e-mail templates you (or the administrator of the system) have created in advance.

  More information: Managing E-Mail Templates

• Recipients for approval(approve.mail.recipients) - Determines the recipients of the mail in case of approval. You can choose the same recipients as in Data Display and Acknowledgement.
• Reject e-mail(reject.mail.techname) - Technical name of the e-mail template to send in case of rejection.
• Recipients for rejection(reject.mail.recipients) - Determines the recipients of the mail in case of rejection. You can choose the same options as for approval.

Result states:

• APPROVE - The request has been approved.
• REJECT - The request has been rejected.

Interactive Form or File Approval

Type: Web Dynpro Component (GP Interface)

Functionality: Used for displaying online a form or file that can be approved or rejected.

• For forms, you can use it in a process in which a form is sent by e-mail. As soon as the form is submitted back to the system, the receiver can view it, save a copy of the form, and depending on his or her decision, can approve or reject it.
• For files, you can use it in a process in which a file is uploaded to the system. The receiver can view or download the file, and subsequently approve or reject it.

Component: com.sap.caf.eu.gp.ui.wdco.approveform.WDCOApproveForm

Application: sap.com/caf~eu~gp~ui~wdco

Input parameters: In addition to the input parameters listed below, you can define your own parameters.

Result states:

• APPROVE

  - The document has been approved.

• REJECT -

  The document has been rejected.

On the Set Configuration screen, you can optionally rename the existing result states (and their corresponding button labels) or create new ones.

Offline Approval

Type: Java Callable Object for background execution

Functionality: Enables users to approve or reject a request, and to notify process contributors of their decision.

com.sap.caf.eu.gp.callobj.bckgd.offline.approval.OfflineApprovalCallableObject

Container: caf~eu~gp~actions

Input parameters:

• State mode(state.mode) - Default input parameter.

In addition, you can define other input parameters and configure e-mail notifications, in the same way as for Visual Approval.

Output parameters:

• Task identifier(output.taskid) - Unique identifier of the task.
• Date (output.date) - Exact date and time of the request action.

Configuration parameters:

• Approval Mail Technical Name(approval.mail.techname) - Technical name of the e-mail template to be sent in the case of an approval. You can select one of the e-mail templates you (or the administrator of the system) have created in advance.

  More information: Managing E-Mail Templates

• Approval Recipients(approval.mail.recipients) - Determines who the recipients of the mail are. You can choose the following recipients:
  • Process Initiator - only the initiator receives a message.
  • Process Owner - only the owner receives a message.
  • Process Contributors - everyone who has already contributed to the process receives a message.

  More information: Process Roles

• Rejection Mail Technical Name(rejection.mail.techname) - Technical name of the e-mail template to be sent in the case of a rejection. You can choose the same options as for an approval.
• Rejection Recipients(rejection.mail.recipients) - Determines who the recipients of the mail are in the case of a rejection. You can choose the same options as for approval.
• Approval value for state mode(approval.state.mode) - Approval value for state mode - the value that must match the input parameter state.mode to result in an approval.

  (default: approve)

Result states: The same as for Visual Approval.

Decision (Comparison to Predefined Value)

Type: Java Callable Object for background execution

Functionality: Compares the input to a predefined comparison value.

com.sap.caf.eu.gp.callobj.misc.SingleValueDecisionCO

Container: caf~eu~gp~actions

Input parameters:

• Input parameter(input) - Default input parameter.

Configuration parameters:

• Comparison value(compareto) - Defines the value against which the input is compared.

Result states:

• EQUAL - Input and comparison values are equal.
• DIFFERENT - Input and comparison values are not equal.

Numeric Decision

Type: Java Callable Object for background execution

Functionality:Compares the values of two numbers depending on the comparison operator you configure.

com.sap.caf.eu.gp.callobj.misc.NumericDecisionCO

caf~eu~gp~actions

Input parameters:

• First input parameter

  (first.input.parameter)

  - The first number of type Double.
• Second input parameter

  (second.input.parameter)

  - The second number of type Double.

Configuration parameters:

• Comparison parameter

  (compare)

  - Defines a comparison operator. It can be one of the following:

  Sign	Comparator Meaning
  =	Equal
  <>	Different
  >	Greater than
  >=	Greater than or equal
  <	Less than
  <=	Less than or equal

Result states:

• TRUE - The result of the expression is true.
• FALSE - The result of the expression is false.

Initiate Process (Using Predefined Template)

Type: Java Callable Object for background execution

Functionality: Starts a process using an existing process template. To be able to initiate a process using this callable object, process roles must be configured with default values. The process template must be active.

To get the ID of a process template, open it in Design time and choose the Instantiation tab.

Class: com.sap.caf.eu.gp.callobj.bckgd.processinitiation.ProcessInitiationCO

Container: caf~eu~gp~actions

Configuration parameters:

• Template ID (templateId)  - Process template to be initiated.

Result states:

• COMPLETED - Reached on successful completion.

Exceptions:

• INVALID_TEMPLATE_ID - Returned when the system cannot find an active template with the specified ID.
• INVALID_ROLES - Returned when the process roles are not configured (for example, if defaults have not been set).
• INITIATION_FAILURE - Returned if the system fails to start the process.

Terminate Process

Type: Java Callable Object for background execution

Functionality: Stops the current process.

Class: com.sap.caf.eu.gp.callobj.bckgd.stopprocess.StopProcessCO

Container: caf~eu~gp~actions

Result states: No result state is set.

Exceptions:

• STOP_PROCESS_FAILED - Returned when the system is unable to stop the current process.

User Management

Choose a User

Type: Web Dynpro Component (GP Interface)

Functionality: Provides a user interface for choosing a user from user management. Returns the unique identifier of the user as well as additional data in its output data structure.

Component: com.sap.caf.eu.gp.ui.wdco.pickuser.WDCOPickUser

Application: sap.com/caf~eu~gp~ui~wdco

Output parameters:

• Unique ID

  (uniqueId)

  - Unique ID of the user found.
• User Date(userdata) - A predefined structure that holds details about the user found (for example, address, phone number, company).

Result states:

• COMPLETE - Reached on successful completion.

Read User Information

Type: Java Callable Object for background execution

Functionality: Reads and returns user information based on the unique ID, the logon ID, or the current user. If you enter one of the three options, detailed information about the user appears as an output.

com.sap.caf.eu.gp.callobj.ume.GetUserInfoCO

Container: caf~eu~gp~actions

Input parameters:

• Unique ID(UNIQUE_ID) - User unique ID.
• Unique Name(UNIQUE_NAME) - User name.
• Logon ID(LOGON_ID)  - User logon ID.

Output parameters:

• Unique ID(uniqueid) - Unique ID of the user found.
• User Data(userdata) - A predefined structure that holds details about the user found (for example, address, phone number, company).

Configuration parameters:

• Resolution Mode(RESOLUTION_MODE) -You can choose whether to perform the search for the currently logged user or the criterion is the user's:
  • Unique ID (for example, USER.PRIVATE_DATASOURCE.un:Guest)
  • Unique name (for example, Guest)
  • Logon ID

Result states:

• COMPLETED - Reached on successful completion.

Assign Users to Process Role

Type: Java Callable Object for background execution

Functionality: Assigns users to a process role.

com.sap.caf.eu.gp.callobj.processrole.ProcessRoleAssignmentUserCO

Container: caf~eu~gp~actions

Input parameters:

• UserList (User_List) - List of the users to be assigned to the role. It holds the unique IDs of the users.

Result states:

• manresolve.completed- Reached on successful manager resolution completion.

Return Process Role Member List

Type: Java Callable Object for background execution

Functionality: Enables you to get the users assigned to the roles for the current process.

com.sap.caf.eu.gp.callobj.processrole.UserListResolutionCO

Container: caf~eu~gp~actions

Output parameters:

• UserList (User_List) - List of users assigned to the roles in the current process.

Result states:

• manresolve.completed- Reached on successful manager resolution completion.

User Mapping (Conversion between AS Java and AS ABAP Identities)

Type: Java Callable Object for background execution

Functionality: Converts AS Java (UME) unique user IDs to the corresponding AS ABAP IDs and vice versa.

Class: com.sap.caf.eu.gp.callobj.manager.UserMappingBackgroundCO

Container: caf~eu~gp~actions

Input Parameters:

• User List (User_List) - A list of the user(s) unique IDs that need to be converted.

Output Parameters:

• Mapped User List (Mapped_User_List) - A list of the converted user IDs.

Configuration Parameters:

• System Name - The system name specifies the corresponding AS ABAP system, for which the user mapping is configured. A System Landscape object must be configured in the portal with the same system alias.
• Mapping Direction (AS Java to AS ABAP) - The default mapping direction converts UME IDs of the AS Java to the corresponding AS ABAP IDs. If this configuration property is deselected, the conversion is done in reverse direction.

Result States:

• usermapresolve.completed - Reached on successful ID resolution.

Exceptions:

• noactive.plvar - Returned when no active plan variant is available.
• system.name.invalid - Returned when the specified system name is not valid.

Check User

Type: Java Callable Object for background execution

Functionality: Checks whether a specified user is unique. This is done by searching the UME for a particular user by user ID and name. If the search returns multiple results, they are available as a structure.

Class: com.sap.caf.eu.gp.callobj.bckgd.checkuser.CheckUser

Container: caf~eu~gp~actions

Input parameters:

• User ID(input.user.id) - mandatory
• User Name(input.user.name)

Output parameters:

• Output: User unique ID (output.user.id) - Unique ID of the user found, if any.
• Output: Found Users(output.users) - List of the users found in case no unique user is found.

Result states:

• ONE_USER - A single user matches the search criteria.
• ZERO_USERS - No users match the search criteria.
• MANY_USERS - Multiple users match the search criteria.

Miscellaneous

Read System Properties

Type: Java Callable Object for background execution

Functionality: Returns a list of system properties.

Class: com.sap.caf.eu.gp.callobj.system.SystemPropertiesCO

Container: caf~eu~gp~actions

Output parameters:

• Read System Properties(sysprops) - System properties returned by the callable object. This is a list of name-value pairs.

Configuration parameters:

• Property Prefix(prefix) - Returns all properties that start with this property prefix.

Result states:

• COMPLETED - Reached on successful completion.

Write to System Log

Type: Java Callable Object for background execution

Functionality: Writes information text to the system log.

Class: com.sap.caf.eu.gp.callobj.system.SystemLogCO

Container: caf~eu~gp~actions

Input parameters:

• Log text

  (text)

  - Text to be added to the system log.

Configuration parameters:

• Severity level

  (severity)

  - The severity level can be one of the following:
  • Information message
  • Warning message
  • Error message
• Log entry prefix

  (app_prefix) -

  Prefix for the information text. This helps to identify the log entries of the various applications.

Result states:

• COMPLETED - Reached on successful completion.

Current State Information (Date and Time, for example)

Type: Java Callable Object for background execution

Functionality: Returns information about the current system state (date, time, language code).

Class: com.sap.caf.eu.gp.callobj.misc.CurrentStateInfoCO

Container: caf~eu~gp~actions

Output parameters:

• Current date - (CURRENT_DATE)
• Current time -(CURRENT_TIME)
• Current date and time - (CURRENT_DATETIME) - Time stamp, consisting of current date and time
• Current date (Text) - (CURRENT_DATE_TEXT) - Current date available as a string
• Current time (text) - (CURRENT_TIME_TEXT) - Current time available as a string
• Current time (text) - (CURRENT_DATETIME_TEXT) - Time stamp, consisting of current date and time available as a string
• Time stamp (RFC 1123) - (CURRENT_TIMESTAMP_RFC1123) - Time stamp (RFC 1123) available as a string
• Time stamp (RFC 850) - (CURRENT_TIMESTAMP_RFC850) - Time stamp (RFC 850) available as a string
• Time stamp (ANSI) - (CURRENT_TIMESTAMP_ANSI) -  Time stamp (ANSI) available as a string
• Time stamp (R/3 Format) - (CURRENT_TIMESTAMP_R3) - Time stamp (R/3 Format) available as a string
• Time stamp (ISO 8601) - (CURRENT_TIMESTAMP_IS8601) - Time stamp (ISO 8601) available as a string
• System fallback language code - (LANG_SYS_FALLBACK) - System fallback language code in lowercase
• System fallback language code (upper case) - (LANG_SYS_FALLBACK_UCASE) - System fallback language code in uppercase

Result states:

• COMPLETED - Reached on successful completion.

Send Notification

Type: Java Callable Object for background execution

Functionality: Sends a notification e-mail to specified process contributors.

Class: com.sap.caf.eu.gp.callobj.mail.NotificationCO

Container: caf~eu~gp~actions

Input parameters:

• Recipient E-Mail Address(email_address) - The recipient address for the e-mail to be sent.

You can also add any other input parameters.

Configuration parameters:

• E-Mail template(MIME) - Technical name of the e-mail template to be sent. You can select one of the e-mail templates you (or the administrator of the system) have created in advance.

  More information: Managing E-Mail Templates

• Send to (CONTRIBUTOR) - Process contributors who are going to receive notification. You can choose one of the following:
  • Current processors - The members of the current process role receive a message (default).
  • Initiator - Only the initiator receives a message.
  • Owner - Only the owner receives a message.
  • Overseer - Everyone who has an overseer role receives a message.
  • Administrator - Only the administrator receives a message.
  • All Contributors - Everyone who has already contributed to the process receives a message.
  • E-Mail Address passed as Context Parameter - The message is delivered to the address specified in the email_address input parameter.

Result states:

• COMPLETE - Reached on successful completion.

Exceptions:

• SendMailException - Returned when problems with mail communication occur.

Send an E-Mail in Background with Attachment (Optional)

Type: Java Callable Object for background execution

Functionality: Sends a notification e-mail message with attachments to a specified recipient.

com.sap.caf.eu.gp.callobj.mail.NotificationCOWithAttachment

caf~eu~gp~actions

Input parameters:

• Recipient E-Mail Address(email_address) - The default recipient of the e-mail message.
• Attachment (ATTACHMENT_1) - A list of one or more attachments. The parameter is of type Structure Template(namespace

  com.sap.caf.eu.gp.types.File

  ) and has the predefined structure for a File.

  If you want to define additional parameters of type File Structure Template, make sure you stick to the following naming convention for the technical name: ATTACHMENT_<parameter_name>.

Configuration parameters:

See Send Notification callable object above.

Result states:

• COMPLETE

  - Reached on successful completion.

Exceptions:

• SendMailException - Returned when problems with mail communication occur.

File Input

Type: Web Dynpro Component (GP Interface)

Functionality: Uploads any file and transfers it across the process flow as a context parameter. Once you have uploaded the file, you can download or view its contents in a subsequent process step.

com.sap.caf.eu.gp.ui.wdco.fileinput.WDCOFileInput

sap.com/caf~eu~gp~ui~wdco

Input parameters:You can define any parameters.

Output parameters:

Configuration parameters:

• Maximum file size

  (message.MAX_FILE_SIZE_TEXT) -

  maximum file size allowed to be uploaded.

Send an E-Mail

Type: Web Dynpro Component (GP Interface)

Functionality: Sends an e-mail to one or more recipients, specified by their e-mail addresses. It provides a user-friendly layout for the e-mail header (From, To, Copy, Subject) and text fields, as well as an option for uploading file attachments.

The From, To, Subject and E-Mail Text fields are mandatory. The From field is automatically filled with the current user's e-mail address and is read-only.

com.sap.caf.eu.gp.ui.wdco.sendemail.WDCOSendEmail

sap.com/caf~eu~gp~ui~wdco

Input parameters: You can define any parameters although you are not required to do so.

Process Initiation Steps

Process Template Selection

Type: Web Dynpro Component (GP Interface)

Functionality: Allows the selection of a process template for initiation.

Component: com.sap.caf.eu.gp.ui.wdco.processtemplate.WDCOProcessTemplate

sap.com/caf~eu~gp~ui~wdco

Output parameters:

• Template ID(templateID) - Process template to be initiated.

Result states:

• COMPLETED - Reached on successful completion.

Process Input Parameters

Type: Web Dynpro Component (GP Interface)

Functionality: Allows the process input parameters to be set at initiation.

Component: com.sap.caf.eu.gp.ui.wdco.processinput.WDCOProcessInput

sap.com/caf~eu~gp~ui~wdco

Input parameters:

• Template ID(templateID) - Process template to be initiated.

Output parameters:

• Input Parameters Value(inputParamsValue) - Packed value.

Result states:

• COMPLETED - Reached on successful completion.

Exceptions:

• INVALID_TEMPLATE_ID - Returned when the system cannot find an active template with the specified ID.

Process Role Assignment

Type: Web Dynpro Component (GP Interface)

Functionality: Allows process role assignment at initiation.

Component: com.sap.caf.eu.gp.ui.wdco.processroles.WDCOProcessRoles

sap.com/caf~eu~gp~ui~wdco

Input parameters:

• Template ID(templateID) - Process template to be initiated.

Output parameters:

• Roles(roleList) - Types Structure,List.
  • Role Technical Name(roleTechName)
  • User ID(userID) - Type Structure- User Unique IDs.

Result states:

• COMPLETED - Reached on successful completion.

Exceptions:

• INVALID_TEMPLATE_ID - Returned when the system cannot find an active template with the specified ID.

Process Data

Type: Web Dynpro Component (GP Interface)

Functionality: Allows process-specific data to be set at initiation.

Component: com.sap.caf.eu.gp.ui.wdco.processdata.WDCOProcessData

sap.com/caf~eu~gp~ui~wdco

Input parameters:

• Template ID(templateID) - Process template to be initiated.

Output parameters:

• Process Title(processTitle) - Process instance title.
• Process Initiator(processInitiator) - Process initiator unique ID.
• Process Description(processDescriptionuserID) - Process instance description.

Result states:

• COMPLETED - Reached on successful completion.

Exceptions:

• INVALID_TEMPLATE_ID - Returned when the system cannot find an active template with the specified ID.

Process Initiation

Type: Web Dynpro Component (GP Interface)

Functionality: Initiates a process of a selected template, role assignments, input parameters, and data.

Component: com.sap.caf.eu.gp.ui.wdco.processinitiation.WDCOProcessInitiation

sap.com/caf~eu~gp~ui~wdco

Input parameters:

• Template ID(templateID) - Process template to be initiated.
• Input Parameters Value(inputParamsValue) - Packed value.
• Roles(roleList) - Types Structure,List.
  • Role Technical Name(roleTechName)
  • User ID(userID) - Type Structure- User Unique IDs.
• Process Title(processTitle) - Process instance title.
• Process Initiator(processInitiator) - Process initiator unique ID.
• Process Description(processDescriptionuserID) - Process instance description.

Configuration parameters:

• Without Confirmation(autoStart) - Initiate process without showing confirmation dialog.

Result states:

• COMPLETED - Reached on successful initiation of the process.
• CANCELLED - Reached on cancellation of the process initiation.

Exceptions:

• INVALID_TEMPLATE_ID - Returned when the system cannot find an active template with the specified ID.
• INVALID_ROLES - Returned when the process roles are not configured (for example, if defaults have not been set).
• INITIATION_FAILURE - Returned when the system fails to start the process.

Additional

Input Data

Type: Web Dynpro Component (GP Interface)

Functionality: Displays the input data passed to the callable object and provides a form for data input.

Component: com.sap.caf.eu.gp.ui.wdco.input.WDCOInput

sap.com/caf~eu~gp~ui~wdco

Input parameters:

• To display the data that is exposed as an output from other callable objects, you must define and map input parameters.

Output parameters:

• To enable the form processor to enter data and to send it to the system, you must define output parameters. At runtime, they are available as input fields and the data is sent to the GP framework when the process step is complete.

Result states:

• COMPLETE - Reached on successful completion.

Loop

Type: Web Dynpro Component (GP Interface)

Functionality: Provides a loop decision dialog with description text and two buttons generating different result states (for the loop to be continued or terminated).

Component: com.sap.caf.eu.gp.ui.wdco.loop.WDCOLoop

sap.com/caf~eu~gp~ui~wdco

Configuration parameters:

• Description(TN_DESCRIPTION) - Provides a short description of the loop.
• 'Once More' Button Name(TN_ONCE_MORE_TEXT) - The label of the button for starting a new iteration.
• 'End Loop' Button Name(TN_ONCE_END_LOOP) - The label on the button for loop termination.

Result states:

• ONCE_MORE - Reached on loop continuation.
• TERMINATE - Reached on loop termination.