BAPI for transaction IW31 (creating a work order)

[Former Member]

Hi all,

I need to be able to create a work order ( IW31) using ABAP code and was wondering if any knew if there was a BAPI that should be used for this functionality.

Thanks in advance

Mart

[Former Member · Accepted solution]

hi,

You can use

BAPI_ALM_ORDER_MAINTAIN.

Have a look at the following documentation.

FU BAPI_ALM_ORDER_MAINTAIN

____________________________________________________

Text

Process Maintenance-/Service Order

Functionality

This Business Application Programming Interface (BAPI) is used for changing maintenance- or service orders and their lower-level objects. The following objects of an order can be processed (for restrictions, see the note at the end of the documentation):

Order header

Partner

User status

Order operations

Relationships

Components

Long texts for order header, operations, and components

Function

Calling up this BAPI once allows you to perform all the operations. For this the system supplies the function module with a method table containing the methods to be performed. The entries in the method table refer to data records in the optionally filled-out data tables. All the methods from the method table are performed. Alternatively, just lower- level objects from existing orders can be changed.

You can process the transferred data with the Business Add-In (BAdI) IBAPI_ALM_ORD_MODIFY to, for example, merge data from the external system with data from the R/3 system. The BAdI is called up as soon as the transferred data is converted into the internal format. The tests then take place after this.

Construction of Method Table

REFNUMBER Reference number for linking object methods - attributes

The reference number is the line of the database which contains the corresponding data. The data table is determined by the object type.

OBJECTTYPE Object category

The object category specifies which object from the order should be processed. The key words listed here are not language-dependent and must be transferred exactly as they are. The following objects exist:

HEADER Order header

PARTNER Partner data

USERSTATUS User status

OPERATION Operation data

RELATION Relationships

COMPONENT Components

TEXT Long texts

(empty) ,General BAPI functions (save)

METHOD Methods

The methods with which the data should be processed. The following functions exist:

CREATE Create objects

CHANGE Change objects

DELETE Delete objects

RELEASE Release

TECHNICALCOMPLETE Technically complete

ATPCHECK Availability check

CALCULATE Calculate

SCHEDULE Schedule

DELELTEDSEX Delete the status for external scheduling at operation level

SAVE Save all data

DIALOG Call-up dialog. See explanation below.

TRACE Write trace file in the specified file to the frontend

OBJECTKEY SAP external object key

This key is for assigning the lower-level objects correctly to the corresponding objects, as there is always just one key in the data table. The key must have the following structure:

1-12 Order number

When creating orders with internal number assignment, a reference number beginning with % must be entered here. The BAPI then returns this number and the number actually assigned.

13-16 Operation number

17-20 Sub-operation number

For relationships, the key is structured as follows:

1-12 ,Order number from

13-16 Operation number from

17-28 Order number to

29-32 Operation number to

The following methods are permissible for the individual objects:

HEADER:

CREATE, CHANGE, RELEASE, TECHNICALCOMPLETE, ATPCHECK, CALCUALTE, SCHEDULE

OPERATION

CREATE, CHANGE, DELETE, DELETEDSEX

PARTNER, RELATION, COMPONENT, USERSTATUS, TEXT:

CREATE, CHANGE, DELETE

(empty):

SAVE, DIALOG, TRACE

Data tables and update tables

The objects have one or more data tables. For some objects you can specify which of the fields specified in the structure should be changed. For this you must set the field in the corresponding table to X as in the data table. If no update-table is transferred, then only those fields are set that have a value that is not initial. This simplifies the transfer data. However, this means it is not possible to delete fields. If an update structure should only be specified for some data records, the table with the update fields must nonetheless have the same amount of lines as the data table. The empty lines are then treated as if no update structure was transferred. The objects "Partner", "User Status", and "Text" have no update tables. The whole data record is always copied here.

References

The objects use the field REFNUMBER from the method table to refer to the lines in the data table. Counting always begins with 1. In doing this, REFNUMBER also refers to the update table. However, in the method table there is a second reference to higher-level objects for lower-levels objects. The field OBJECTKEY must be filled with order number, operation number, and sub-operation number, as specified above. If lower-level objects of a newly-created order should be changed, then you must enter a temporary order number that must begin with %. Several orders can be numbered serially, for example, with %00000000001, %00000000002 ... .

The following objects have special treatment for REFNUMBER:

Partner

Texts

Partners have an order number in the data table. During processing of the method table, all those entries in the data table are processed which have an order number that is the same as that in the line to which the method refers. Thus, through just one entry in the method table, several partners can be changed.

Texts are composed of two tables. The first table (IT_TEXT) is made up of the header data of the text. Here you must specify the object and the first and last line of the text table (respectively inclusive, counting from 1). Through this, a line segment is specified in the text line table (IT_TEXT_LINES).

Peculiarities in processing

The BAPI processes the transferred methods in a particular sequence, which must not correspond to the sequence in the methods table.

Write trace file

Change user status time period 1

Delete objects (dependent first)

Create new objects

Change existing or newly-created objects

Change user status time period 2

Status change of order

Save data

The methods are performed such that lower-level objects can also be assigned to newly-created objects. For example, first the operations are created, and then the components. Long texts can also be created for the objects.

Components have an exceptional position. Components are created through the assignment to an operation, that is, using the "key" order/ operation (item number). However, as this is not the unique component key, you can only access the components to change them, delete them, or add long texts by using the reservation number/-item, which is only given after saving. This means that, for example, you cannot create a long text when you create the component.

User status changes can take place at two different time points. Time point 1 is before the object changes, time point 2 is after the object changes and before the status change of the system. These time points should be defined in the transfer table in the field CHANGE_EVENT. The field documentation contains the possible values.

The external scheduling is offered by the BAPI as a special function. THe BAPI can set the date field directly at the operation level, and select the operation with the status DSEX "Date set by external system". This status prevents any further scheduling of the operation, it keeps the transferred dates. For this, set the category 'X' in the restriction categories. When reading the operation, this category is also returned, independent of the category of restriction set in the dialog. To delete the status, you can call up the method DELETEDSEX for the object operation. The external scheduling cannot be influenced in the dialog. All changes to the scheduling restrictions in the dialog are saved as normal, but are not relevant for the scheduling as long as the status DSEX is active.

Every time the BAPI is called up, a SAVE or DIALOG method must be transferred. Normally, calling up a BAPI is seen as a transaction. All data that is changed in the BAPI should be saved to the database immediately. The BAPI checks whether a SAVE method exists, otherwise it terminates processing. A test run of the BAPI is composed of a normal call-up using the SAVE method and a subsequent BAPI_TRANSACTION_ROLLBACK. To call up the BAPI without the SAVE method, for example, to realize dialog transactions, the BAPI can be called up with the DIALOG method. This switches off the check for the SAVE method. The processor must then ensure that later either a SAVE method or a BAPI_TRANSACTION_ROLLBACK is called up.

A BAPI_TRANSACTION_COMMIT without SAVE method terminates processing in the update to ensure that no inconsistent data is written to the database. The processor who called up the BAPI does not receive any confirmation for the termination of the update in the target system. This logic is necessary as the order data was flagged for updating with BAPI_TRANSACTION_COMMIT through the SAVE method. However, the status information was already flagged for updating when the BAPI was called up. A BAPI_TRANSACTION_COMMIT without SAVE method then just saves the status information and would generate inconsistent orders, if the updating was not terminated.

Customer Enhancement

The BAdI IBAPI_ALM_ORD_MODIFY can be used to change the transferred data. The BAdI is called up after the conversion of the transfer structure into the structures used internally. Additional data can be transferred using the table EXTENSION_IN. Only then is the data checked.

Example

The following examples should clarify the use.

Creating an order

OBJECTKEY should be filled with a temporary key. The BAPI returns this key together with the assigned order number in the return table ET_NUMBERS . The order number in the HEADER table should also be filled with the number. For external number assignment, the external number should be specified. The update structure can be transferred if necessary.

Methods table

REFNUMBER OBJECTTYPE METHOD OBJECTKEY

1 HEADER CREATE %00000000001

IT_HEADER

ORDERID ORDER_TYPE PLANPLANT ...

%00000000001 PM01 1000 ...

Creating an order with operation and long text

Methods table

REFNUMBER OBJECTTYPE METHOD OBJECTKEY

1 HEADER CREATE %00000000001

1 OPERATION CREATE %00000000001

1 TEXT CREATE %000000000010010

IT_HEADER

ORDERID ORDER_TYPE PLANPLANT ...

%00000000001 PM01 1000 ...

IT_OPERATION

ACTIVITY SUB_ACTIVITY CONTROL_KEY WRK_CNTR ...

10 PM01 MECHANIC ...

IT_TEXT

ACTIVITY ... TEXTSTART TEXTEND

10 ... 1 2

IT_TEXT_LINES

TDFORMAT TDLINE

• Longtext for operation 10, line 1

• Line 2 of the long text

Notes

Using the BAPI to process the order data cannot support all the functions of the transaction. This applies in particular for the following functions:

Order header data

The object list cannot be processed.

Refurbishment orders are not supported.

The estimated costs cannot be processed - only the estimated overall costs of the order.

Notification data cannot be processed with the order BAPI. Even if the settings in Customizing are such that the orders and notifications can be maintained on one screen, no notification is created for the order.

Permits cannot be processed.

The order addresses cannot be processed.

Individual partner addresses cannot be maintained.

The settlement rule cannot be maintained.

Order functions

Printing the papers is not possible.

Locking and unlocking the order is not possible.

Accepting and rejecting quotations is not possible.

Business completion is not possible.

Flagging for deletion is not possible.

The log cannot be displayed.

User default values are not used.

The field selection is not checked.

The Customer Exits/BAdIs are not executed completely.

Joint ventures are not supported.

Funds Management is not supported.

Investment orders are not supported.

No integration of service products with task lists possible.

No integration of configurable service products possible.

Assignment of sales document items with service products in accordance with the aforementioned conditions.

Operation data

A change of the control key in the operation is not possible, if this leads to a change of the processing type (internal-/external processing)

User status change not possible.

Production resources and tools cannot be processed.

Service lines cannot be processed.

Task list integration is not supported.

Linking operations with object list is not supported.

Component data

User status change not possible.

BOM data cannot be processed.

The delivery address cannot be processed.

Further Information

See also the documentation for the individual transfer tables.

Parameters

IT_METHODS

IT_HEADER

IT_HEADER_UP

IT_HEADER_SRV

IT_HEADER_SRV_UP

IT_USERSTATUS

IT_PARTNER

IT_PARTNER_UP

IT_OPERATION

IT_OPERATION_UP

IT_RELATION

IT_RELATION_UP

IT_COMPONENT

IT_COMPONENT_UP

IT_TEXT

IT_TEXT_LINES

EXTENSION_IN

RETURN

ET_NUMBERS

Exceptions

Function Group

IBAPI_ALM_ORDER

~~Guduri

[Former Member]

BAPI_SERVICENOTIFICAT_CREATE

[Former Member]

Check if BAPI_ALM_ORDER_MAINTAIN helps. It has good documentation in SE37. Please go thru that.

ashish

[Former Member]

Hi,

thanks for the replies, i did try BAPI_ALM_ORDER_MAINTAIN but was not sure it would do the job.

Using the documentation and an SAP program i managed to create the following program but it returns an error in the error table saying 'Order %00000000001 cannot be saved, since no operation is maintained' . does anyone know how i can solve this?

types: begin of t_order.

include structure BAPI_ALM_ORDER_METHOD.

types: end of t_order.

data: it_methods type standard table of t_order,

wa_methods like line of it_methods,

lt_methods like line of it_methods,

return TYPE TABLE OF bapiret2,

et_numbers TYPE TABLE OF bapi_alm_numbers,

it_component TYPE TABLE OF bapi_alm_order_component,

lt_component TYPE bapi_alm_order_component,

it_header TYPE TABLE OF bapi_alm_order_headers_i,

lt_header TYPE bapi_alm_order_headers_i.

DATA: l_caufvd TYPE caufvd.

• l_afpo-aufnr = x_docno.

• Set order number

l_caufvd-aufnr = '%00000000001'.

• Convert to external BAPI format

CALL FUNCTION '/USE/CAUFVD_TO_BAPI_ALM_ORDER'

EXPORTING

caufvd = l_caufvd

CHANGING

bapi_alm_order_headers_i = lt_header.

CLEAR lt_header-loc_wk_ctr.

lt_header-ORDER_TYPE = 'ZPM2'.

lt_header-PLANT = 'PLANT'.

lt_header-PLANPLANT = 'PLANT'.

lt_header-MN_WK_CTR = 'PMELE1'.

lt_header-START_DATE = sy-datum.

lt_header-pmacttype = '003'.

lt_header-short_text = 'This is a bapi test wo'.

APPEND lt_header TO it_header.

• Set up methods

• Header

CLEAR wa_methods.

wa_methods-refnumber = '1'.

wa_methods-objecttype = 'HEADER'.

wa_methods-method = 'CREATE'.

wa_methods-objectkey = '%00000000001'.

APPEND wa_methods TO it_methods.

CLEAR wa_methods.

wa_methods-refnumber = '1'.

wa_methods-method = 'SAVE'.

wa_methods-objectkey = '%00000000001'.

APPEND wa_methods TO it_methods.

CALL FUNCTION 'BAPI_ALM_ORDER_MAINTAIN'

TABLES

IT_METHODS = it_methods

IT_HEADER = it_header

• IT_COMPONENT = it_component

RETURN = return

ET_NUMBERS = et_numbers

.

Thanks in advance

Mart

[Former Member]

Can you commit database changes using BAPI_TRANSACTION_COMMIT function module after bapi call and see once?

ashish

[Former Member]

No even with BAPI_TRANSACTION_COMMIT no changes are made to the database table AFIH, is this the correct table to look in?

Regards

Mart

[Former Member]

It is mandatory for an order to have at least one operation. Please create an operation by populating the operation structure, and include the same in the methods.

This should solve the issue.

Thanks,

Srihari

[Former Member]

Excellent thanks for that,

I have now added the following code to include an operation which has removed the previous error. Unfortunately i am now getting the following error 'You must enter an order number to change an order'

CLEAR lt_methods.

lt_methods-refnumber = '1'.

lt_methods-objecttype = 'OPERATION'.

lt_methods-method = 'CREATE'.

wa_methods-objectkey = '%00000000001'.

APPEND lt_methods TO it_methods.

lt_operation-activity = '10'.

• lt_operation-SUB_ACTIVITY =

lt_operation-WORK_CNTR = 'PMELE1'.

lt_operation-CONTROL_KEY = 'PM01'.

APPEND lt_operation TO it_operation.

Regards

Mart

[Former Member]

CLEAR lt_methods.

lt_methods-refnumber = '1'.

lt_methods-objecttype = 'OPERATION'.

lt_methods-method = 'CREATE'.

wa_methods-objectkey = '%00000000001<b>0010</b>'.

APPEND lt_methods TO it_methods.

lt_operation-activity = '10'.

• lt_operation-SUB_ACTIVITY =

lt_operation-WORK_CNTR = 'PMELE1'.

lt_operation-CONTROL_KEY = 'PM01'.

APPEND lt_operation TO it_operation.

Can you try it like this, I am not too sure about this, but worth a try, or you can also check by leaving the objkey blank.

Message was edited by:

Srihari Hebbar

[Former Member]

Hi Srihari,

Thanks for the reply, tried it as you said with the activity on the end and blank but unfortunately i am still getting the same error 'You must enter an order number to change an order'

Regards

Martin

[Former Member]

Hi,

Change the sequence of teh methods you are using. Last method will be teh save method. Just before that put the method for operation as said above. it will work.

Thanks.

[Former Member]

i know this is old, but this function module is for maintaining orders, not creating them.