|
|
|
|
|
PieceOfEquipment
The business object Piece of equipment is an individual,
physical object that is to be maintained as an autonomous unit.
Structure
A piece of equipment can be installed at a functional location or in a
superior piece of equipment for a certain period of time. In the course
of its useful life, it can be used at different installation locations.
Pieces of equipment can be structured hierarchically, enabling the structure of complex pieces of equipment to be represented.
Pieces of equipment can be linked to one another. In this way, the
global network structure of a technical system and the depedencies between the pieces of equipment can be represented.
|
|
|
|
11-Dec-2005
|
|
|
|
|
Available Methods
- Change : Change Equipment Master Record [ BAPI_EQUI_CHANGE ]
- Create : Create Equipment Master Record [ BAPI_EQUI_CREATE ]
- CreateByReference : Create Equipment Master Record with Reference Equipment [ BAPI_EQUI_CREATE_BY_REFERENCE ]
- CreateFromData : Create Equipment [ BAPI_EQMT_CREATE ] (Obsolete in 46C)
- Dismantle : Dismantle Equipment (Functional Location, Superior Equi) [ BAPI_EQUI_DISMANTLE ]
- DismantleAtFuncloc : Dismantle Equipment at Functional Location [ BAPI_EQMT_DISMANTLEFL ] (Obsolete in 46C)
- DismantleFromHierarchy : Dismantle Equipment from Equipment Hierarchy [ BAPI_EQMT_DISMANTLEHR ] (Obsolete in 46C)
- GetCatalogProfile : Determine Catalog Profile for Equipment [ BAPI_EQMT_GETCATALOGPROFIL ]
- GetDetail : Read Equipment Details [ BAPI_EQMT_DETAIL ] (Obsolete in 46C)
- GetDetail1 : Read Equipment Master Record [ BAPI_EQUI_GETDETAIL ]
- GetList : Selection of Equipment List [ BAPI_EQUI_GETLIST ]
- GetListForCustomer : Select Customer Equipment [ BAPI_EQMT_GETLISTFORCUSTOMER ]
- Install : Install Equipment (Functional Location, Superior Equi) [ BAPI_EQUI_INSTALL ]
- InstallAtFuncloc : Install Equipment at Functional Location [ BAPI_EQMT_INSTALLFL ] (Obsolete in 46C)
- InstallInHierarchy : Install Equipment in Equipment Hierarchy [ BAPI_EQMT_INSTALLHR ] (Obsolete in 46C)
- Update : Change Equipment [ BAPI_EQMT_MODIFY ] (Obsolete in 46C)
|
|
|
|
11-Dec-2005
|
|
|
|
|
Change
This module is used for changing an existing piece of equipment. NotesGeneral notes in BAPIs for processing individual technical objects: A BAPI for creating or changing master data receives these notes usingthe parameter DATA_GENERAL (structure: BAPI_ITOB). Object-specific data is processed using the parameter DATA_SPECIFIC:
Functional locations: DATA_SPECIFIC (structure: BAPI_ITOB_FL_ONLY) Equipment: DATA_SPECIFIC (structure: BAPI_ITOB_EQ_ONLY) Each BAPI returns the processed data to the caller in the parameter
DATA_GENERAL_EXP (structure: BAPI_ITOB) independently of the activityto be performed (Create/Change/Read). Object-specific data is returned to the caller using the parameter DATA_SPECIFIC_EXP:Functional locations: DATA_SPECIFIC_EXP (structure: BAPI_ITOB_FL_ONLY)
Equipment: DATA_SPECIFIC_EXP (structure: BAPI_ITOB_EQ_ONLY) The system returns any error messages in the parameter RETURN.In Customizing (field selection) for master data dialogs, entries defined as mandatory are generally not checked by the BAPIs.
Special notes on the module BAPI_EQUI_CHANGE: If the changed piece of equipment has sub-equipment, the module supports the standard transfer of inheritance-relevant data.
|
|
|
|
11-Dec-2005
|
|
|
|
|
Create
This module is used for creating a new piece of equipment. NotesGeneral notes in BAPIs for processing individual technical objects: A BAPI for creating or changing master data receives these notes usingthe parameter DATA_GENERAL (structure: BAPI_ITOB). Object-specific data is processed using the parameter DATA_SPECIFIC:
Functional locations: DATA_SPECIFIC (structure: BAPI_ITOB_FL_ONLY) Equipment: DATA_SPECIFIC (structure: BAPI_ITOB_EQ_ONLY) Each BAPI returns the processed data to the caller in the parameter
DATA_GENERAL_EXP (structure: BAPI_ITOB) independently of the activityto be performed (Create/Change/Read). Object-specific data is returned to the caller using the parameter DATA_SPECIFIC_EXP:Functional locations: DATA_SPECIFIC_EXP (structure: BAPI_ITOB_FL_ONLY)
Equipment: DATA_SPECIFIC_EXP (structure: BAPI_ITOB_EQ_ONLY) The system returns any error messages in the parameter RETURN.In Customizing (field selection) for master data dialogs, entries defined as mandatory are generally not checked by the BAPIs.
Special notes on the module BAPI_EQUI_CREATE: You can define external number assignment by setting the parameter EXTERNAL_NUMBER.The valid-from date for the piece of equipment to be created can be determined using the parameter VALID_DATE.
The parameter DATA_INSTALL can be used to install the piece ofequipment to be created in a functional location or a superior piece of equipment.
|
|
|
|
11-Dec-2005
|
|
|
|
|
CreateByReference
This module is used for creating a new piece of equipment with reference to an existing reference equipment. NotesGeneral notes in BAPIs for processing individual technical objects: A BAPI for creating or changing master data receives these notes using
the parameter DATA_GENERAL (structure: BAPI_ITOB). Object-specific data is processed using the parameter DATA_SPECIFIC:Functional locations: DATA_SPECIFIC (structure: BAPI_ITOB_FL_ONLY) Equipment: DATA_SPECIFIC (structure: BAPI_ITOB_EQ_ONLY)
Each BAPI returns the processed data to the caller in the parameterDATA_GENERAL_EXP (structure: BAPI_ITOB) independently of the activityto be performed (Create/Change/Read). Object-specific data is returned to the caller using the parameter DATA_SPECIFIC_EXP:
Functional locations: DATA_SPECIFIC_EXP (structure: BAPI_ITOB_FL_ONLY) Equipment: DATA_SPECIFIC_EXP (structure: BAPI_ITOB_EQ_ONLY) The system returns any error messages in the parameter RETURN.
In Customizing (field selection) for master data dialogs, entries defined as mandatory are generally not checked by the BAPIs.Special notes on the module BAPI_EQUI_CREATE_BY_REFERENCE: You can define external number assignment by setting the parameter EXTERNAL_NUMBER.
You can specify the reference equipment using the parameter REFERENCE_NUMBER.You can use the parameter VALID_DATE to determine the valid-from date for the piece of equipment to be created.You can use the parameter COPY_FLAGS to determine which dependent data should be copied from the reference equipment.
|
|
|
|
11-Dec-2005
|
|
|
|
|
CreateFromData
With this method, you create a piece of equipment. All data for thepiece of equipment to be created can be found in the following structures: EQUIMASTER
Structure containing the master data (EQUI) of the piece of equipmentEQUITIME
Structure containing the usage periods (EQUZ) of the piece of equipment
EQUITEXT
Structure containing the short texts (EQKT) of the piece of equipmentEQUILOCATION
Structure containing the location data (ILOA) of the piece of equipmentEQUISALES
Structure containing the sales data (ILOA) of the piece of equipment
If the field EQUIPMENT in the structure EQUIMASTER is blank, theequipment number is assigned internally, otherwise the equipment number specified in the field is assigned. NotesNotifications are returned in the parameter RETURN.
|
|
|
|
11-Dec-2005
|
|
|
|
|
Dismantle
This module is used to install a piece of equipment at a functional location or a superior equipment. NotesGeneral notes in BAPIs for processing individual technical objects: A BAPI for creating or changing master data receives these notes using
the parameter DATA_GENERAL (structure: BAPI_ITOB). Object-specific data is processed using the parameter DATA_SPECIFIC:Functional locations: DATA_SPECIFIC (structure: BAPI_ITOB_FL_ONLY) Equipment: DATA_SPECIFIC (structure: BAPI_ITOB_EQ_ONLY)
Each BAPI returns the processed data to the caller in the parameterDATA_GENERAL_EXP (structure: BAPI_ITOB) independently of the activityto be performed (Create/Change/Read). Object-specific data is returned to the caller using the parameter DATA_SPECIFIC_EXP:
Functional locations: DATA_SPECIFIC_EXP (structure: BAPI_ITOB_FL_ONLY) Equipment: DATA_SPECIFIC_EXP (structure: BAPI_ITOB_EQ_ONLY) The system returns any error messages in the parameter RETURN.
In Customizing (field selection) for master data dialogs, entries defined as mandatory are generally not checked by the BAPIs.Special notes for the module BAPI_EQUI_DISMANTLE: The parameters FUNCLOC and SUPEQUI are used for the optionalspecification of the installation location; if these parameters are
specified, the equipment is only dismantled if it is actually installed at the corresponding installation location.The parameters DISM_DATE and DISM_TIME are used to specify the time at which the dismantling should take place.
|
|
|
|
11-Dec-2005
|
|
|
|
|
DismantleAtFuncloc
You use this method to dismantle a piece of equipment at a functionallocation at a specified time. If the dismantling is performed successfully, the method returns the updated equipment data: EQUIMASTER
Structure with the master data (EQUI) of the equipment
EQUITIME
Structure with the usage periods (EQUZ) of the equipmentEQUITEXT
Structure with the short texts (EQKT) of the equipmentEQUILOCATION
Structure with the location data (ILOA) of the equipmentEQUISALES
Structure with the sales data (ILOA) of the equipment
EQUIHIERARCHY
Structure with the hierarchy data (EQUZ,ILOA) of the equipmentNotesNotifications are returned in the parameter RETURN.
|
|
|
|
11-Dec-2005
|
|
|
|
|
DismantleFromHierarchy
You use this method to dismantle a piece of equipment from an equipmenthierarchy at a specified time. If the dismantling is performed successfully, the method returns the updated equipment data: EQUIMASTER
Structure with the master data (EQUI) of the equipment
EQUITIME
Structure with the usage periods (EQUZ) of the equipmentEQUITEXT
Structure with the short texts (EQKT) of the equipmentEQUILOCATION
Structure with the location data (ILOA) of the equipmentEQUISALES
Structure with the sales data (ILOA) of the equipment
EQUIHIERARCHY
Structure with the hierarchy data (EQUZ,ILOA) of the equipmentNotesNotifications are returned in the parameter RETURN.
|
|
|
|
11-Dec-2005
|
|
|
|
|
GetCatalogProfile
With this method, you determine the catalog profil for the current date for a piece of equipment. If the method can not determine a catalog profile for the piece of equipment itself,for its construction type,for the functional location at which the piece of equipment is installed
or for its construction type,the catalog profile that is assigned to the notification type is used. NotesNotifications are returned in the parameter RETURN.
|
|
|
|
11-Dec-2005
|
|
|
|
|
GetDetail
This method reads details of a piece of equipment. The piece ofequipment can be identified either by the equipment number (EQUIPMENT)or by a combination of material number and serial number (MATERIAL and SERIALNO). If the piece of equipment specified exists and you have authorization
to display the data, the method delivers the details that have been read in the following structures: EQUIMASTER
Structure containing the master data (EQUI) of the piece of equipmentEQUITIME
Structure containing the usage periods (EQUZ) of the piece of equipment
EQUITEXT
Structure containing the short texts (EQKT) of the piece of equipmentEQUILOCATION
Structure containing the location data (ILOA) of the piece of equipmentEQUISALES
Structure containing the sales data (ILOA) of the piece of equipment
EQUIHIERARCHY
Structure containing the hierarchy data (ILOA, EQUZ) of the piece of
equipmentNotesNotifications are returned in the parameter RETURN. Technical noteIf you do not want to transfer an equipment number (the piece of equipment is identified by a combination of material and serial
number), you must transfer a blank (' ') for the (obligatory) parameter EQUIPMENT.
|
|
|
|
11-Dec-2005
|
|
|
|
|
GetDetail1
This module is used for reading an existing piece of equipment. NotesGeneral notes in BAPIs for processing individual technical objects: A BAPI for creating or changing master data receives these notes usingthe parameter DATA_GENERAL (structure: BAPI_ITOB). Object-specific data is processed using the parameter DATA_SPECIFIC:
Functional locations: DATA_SPECIFIC (structure: BAPI_ITOB_FL_ONLY) Equipment: DATA_SPECIFIC (structure: BAPI_ITOB_EQ_ONLY) Each BAPI returns the processed data to the caller in the parameter
DATA_GENERAL_EXP (structure: BAPI_ITOB) independently of the activityto be performed (Create/Change/Read). Object-specific data is returned to the caller using the parameter DATA_SPECIFIC_EXP:Functional locations: DATA_SPECIFIC_EXP (structure: BAPI_ITOB_FL_ONLY)
Equipment: DATA_SPECIFIC_EXP (structure: BAPI_ITOB_EQ_ONLY) The system returns any error messages in the parameter RETURN.In Customizing (field selection) for master data dialogs, entries defined as mandatory are generally not checked by the BAPIs.
|
|
|
|
11-Dec-2005
|
|
|
|
|
GetList
The module is used for selecting a list of equipments according to the specified selection criteria. NotesThe selection conditions must be specified in the respective range tables.The selection results are returned in the table EQUIPMENT_LIST.
|
|
|
|
11-Dec-2005
|
|
|
|
|
GetListForCustomer
This method returns a list of all pieces of equipment for a customer. Only the pieces of equipment that have the transferred customer number(CUSTOMERNO) maintained in their master data are considered. The Parameter INT_CUSTMODE controls which of the customer fields are
compared. You also have the option of limiting the selection by the equipmenttype (EQUITYPE), as well as by the material number and serial number (MATERIALFROM, MATERIALTO, SERIALNOFROM, SERIALNOTO). In the table EQUIPMENT, only the selected pieces of equipments for which you have display authorization are returned.
NotesNotifications are returned in the parameter RETURN.
|
|
|
|
11-Dec-2005
|
|
|
|
|
Install
This module is used for installing a piece of equipment at a functional location or a superior equipment. NotesGeneral notes in BAPIs for processing individual technical objects: A BAPI for creating or changing master data receives these notes using
the parameter DATA_GENERAL (structure: BAPI_ITOB). Object-specific data is processed using the parameter DATA_SPECIFIC:Functional locations: DATA_SPECIFIC (structure: BAPI_ITOB_FL_ONLY) Equipment: DATA_SPECIFIC (structure: BAPI_ITOB_EQ_ONLY)
Each BAPI returns the processed data to the caller in the parameterDATA_GENERAL_EXP (structure: BAPI_ITOB) independently of the activityto be performed (Create/Change/Read). Object-specific data is returned to the caller using the parameter DATA_SPECIFIC_EXP:
Functional locations: DATA_SPECIFIC_EXP (structure: BAPI_ITOB_FL_ONLY) Equipment: DATA_SPECIFIC_EXP (structure: BAPI_ITOB_EQ_ONLY) The system returns any error messages in the parameter RETURN.
In Customizing (field selection) for master data dialogs, entries defined as mandatory are generally not checked by the BAPIs.Special notes for the module BAPI_EQUI_INSTALL: The structure DATA_INSTALL is used to specify the installation location
as well as the time at which installation should take place.
|
|
|
|
11-Dec-2005
|
|
|
|
|
InstallAtFuncloc
You can use this method to install a piece of equipment at a functionallocation at a specified time. If the installation is performed successfully, the method returns the updated equipment data. EQUIMASTER
Structure with the master data (EQUI) of the piece of equipment
EQUITIME
Structure with the usage periods (EQUZ) of the piece of equipmentEQUITEXT
Structure with the short texts (EQKT) of the piece of equipmentEQUILOCATION
Structure with the location data (ILOA) of the piece of equipment
EQUISALES
Structure with the sales data (ILOA) of the piece of equipmentEQUIHIERARCHY
Structure with the hierarchy data (EQUZ,ILOA) of the piece of equipmentNotesNotifications are returned in the parameter RETURN.
|
|
|
|
11-Dec-2005
|
|
|
|
|
InstallInHierarchy
You can use this method to install a piece of equipment in an equipmenthierarchy at a specified time. If the equipment has been successfully installed, the method returns the updated equipment data. EQUIMASTER
Structure with the master data (EQUI) of the piece of equipment
EQUITIME
Structure with the usage periods (EQUZ) of the piece of equipmentEQUITEXT
Structure with the short texts (EQKT) of the piece of equipmentEQUILOCATION
Structure with the location data (ILOA) of the piece of equipment
EQUISALES
Structure with the sales data (ILOA) of the piece of equipmentEQUIHIERARCHY
Structure with the hierarchy data (EQUZ,ILOA) of the piece of equipmentNotesNotifications are returned in the parameter RETURN.
|
|
|
|
11-Dec-2005
|
|
|
|
|
Update
You can use this method to change a piece of equipment. All data forthe piece of equipment to be changed can be found in the following structures: EQUIMASTER
Structure with the master data (EQUI) of the piece of equipmentEQUITIME
Structure with the usage periods (EQUZ) of the piece of equipment
EQUITEXT
Structure with the short texts (EQKT) of the piece of equipmentEQUILOCATION
Structure with the location data (ILOA) of the piece of equipmentEQUISALES
Structure with the sales data (ILOA) of the piece of equipment
The indicator INT_ALL_X shows whether all data fields should beconsidered for the updates (INT_ALL_X = 'X') or just those in thecorresponding flag structures that are indicated as being relevant for updating (INT_ALL_X = ' '). ExampleSituation:
In the structure EQUIMASTER the data fields EQUICATGRY, EQUITYPE and
INVENTORY are assigned values and all other fields are blank.
IN the corresponding flag structure EQUIMASTER_X the flags QUICATGRY,EQUITYPE and MANFACTURE are set to 'X' and all other flags are blank
(' '). Case distinction: If the indicator INT_ALL_X is transferred blank, the data fields
EQUICATGRY and EQUITYPE are copied (INVENTORY remains unchanged!) the previous content of MANUFACTURE deleted.
from the structure EQUIMASTER. If the indicator INT_ALL_X is set to 'X', all data fields are considered and the flag structures are therefore ignored. For the
structure EQUIMASTER, this means that the data fieldsEQUICATGRY, EQUITYPE and INVENTORY are copied and all other fields of the structure are deleted. NotesMessages are returned in the parameter RETURN.
|
|
|
|
11-Dec-2005
|
|
|
|
|