Notes on Function Modules (SAP Library

Notes on Function Modules

Use

The following function modules define the technical part of the CS-SDL interface.

The export parameters, import parameters, and interface tables are defined in these function modules. You also find the fields and structures that are used.

As an SAP customer, you require the function modules if you want to program your own system.

As an SAP partner, you require the function modules in order to be certified for this interface.

The following function modules for current communication with the external scheduling system are delivered with the CS-SDL interface:

PM_ORDER_EXTERN_BOOK_DEFAULT

PM_ORDER_EXTERN_SCHED_APPOINT

PM_ORDER_EXTERN_SCHED_DEFAULT

PM_ORDER_EXTERN_SCHED_DIALOG

READ_WORKLOAD

The following function module is used for reading master data from the SAP System to the external scheduling system.

PM_ORDER_EXTERN_MASTER_DATA

Activities

Notes on individual parameter components that are used in all function modules and which you must take into account when implementing an external scheduling system:

Parameter Name	Component	Data Type	Length	Short Text
ORDER_ HEADER	ORDER_ NUMBER	CHAR	12	Order number

The component ORDER_NUMBER is the key field of the order.

Parameter Name	Component	Data Type	Length	Short Text
ORDER_ HEADER	OWN_LOGICAL_SYSTEM	CHAR	10	Logical system

If a logical system has been defined in the SAP System, it will be made available to you in this component. Use of this system is optional.

Parameter Name	Component	Data Type	Length	Short Text
ORDER_ HEADER	PREFERRED_ ENGINEER	NUMC	8	Object ID

Depending on the partner settings in Customizing, this component places the desired technician at your disposal.

Parameter Name	Component	Data Type	Length	Short Text
ORDER_ HEADER	STATUS	CHAR	4	Individual object status (short form)

This component informs you of the system status. The following fixed values are possible:

CRTD = created (Order created)

REL = released (Order released)

CLSD = completed (Order completed)

LKD = locked (Order locked)

Parameter Name	Component	Data Type	Length	Short Text
OPERATIONS	ID	NUMC	8	General counter for the order

The component ID is the key field for the operation.

Parameter Name	Component	Data Type	Length	Short Text
OPERATIONS	SUB_COUNTER	CHAR	4	Sub-operation

This component is active, but will not be transferred to the interface in Release 4.6C. Only operations and no sub-operations will be transferred to the interface.

Parameter Name	Component	Data Type	Length	Short Text
OPERATIONS	UPDATE_FLAG	CHAR	1	Update indicator

This component has the following fixed values:

I = insert (Insert operation)

U = update (Update operation)

C = confirm (Finally confirm operation)

D = delete (Delete operation)

Error Handling

There are two ways of dealing with errors:

You can use the exceptions defined in the function modules. The SAP System displays an error message if these exceptions are triggered.
If you use the parameters ERROR_CODE and ERROR_DESCRIPTION, the SAP System displays these two parameters as an error message to the end user.