Reading Control Recipe Lists (SAP Library - PP - PI-PCS Interface: Linking of Process Control)

Reading Control Recipe Lists

To read the header data of the control recipes that are ready to be sent in the R/3 System, you use the GetList (Read control recipe list) method of the ControlRecipe SAP business object.

This graphic is explained in the accompanying text

Required Authorizations

Authorization object	Field	Value
C_CREX_WRK	Destination address	RFC destination of the control recipe destination
	Activity	03 (Display control recipe)
	Plant	Plant of the control recipe

Selection Criteria

You can use the following parameters as selection criteria for control recipes:

Import parameter	Format	Length	Req	Description
Plant	CHAR	04	X	Plant of the control recipes
DestAddress	CHAR	32		Address of the control recipe destination, i.e. the RFC destination of the API
DestType	CHAR	01		Type of control recipe destination: Default value 3 (Download initiated by the control system, i.e. can be downloaded using BAPI)
ProcessOrder	CHAR	12		Process order number
Material	CHAR	18		Header material of the process order
TestCntlRec	CHAR	01		Indicator: Read test control recipes
ProdCntlRec	CHAR	01		Indicator: Read productive control recipes Default value: X (Read productive control recipes)
CntlRecStatus	CHAR	05		Control recipe status: 0001 (Created, can be downloaded)
DateFrom	DATS	08		Earliest creation date of control recipes Default value: 00000000 (no restriction)
DateTo	DATS	08		Latest creation date of control recipes Default value: Current local date
SchedDateFrom	DATS	08		Scheduled start date of earliest phase Default value: 00000000 (no restriction)
SchedDateTo	DATS	08		Scheduled finish data of latest phase Default value: Current local date

Returning Control Recipe Data

The R/3 System returns the header data of the control recipes it has selected in the following parameter:

Table parameter	Description	Number of Entries
CntlRecHeader	Export: Header data of the control recipes	1/control recipe

Table CntlRecHeader

Field	Format	Length	Description
CNTL_REC_ID	NUMC	18	Control recipe number
PLANT	CHAR	04	Plant of the control recipe
PROC_ORDER	CHAR	12	Process order to which the control recipe belongs
DEST	CHAR	02	Control recipe destination
DEST_ADDRESS	CHAR	32	Address of the control recipe destination, i.e. the RFC destination of the API
DEST_TYPE	CHAR	01	Type of control recipe destination: 1 (Transfer to R/3 PI sheet, i.e. cannot be downloaded) 2 (Download initiated by R/3 process management, i.e. can only be downloaded with RFC function module) 3 (Download initiated by control system, i.e. can be downloaded with RFC function module or BAPI)
CNTL_REC_STATUS	CHAR	05	Status of the control recipe: Can be downloaded if 00001 (Created): Cannot be downloaded if: 00003 (Sent) 00004 (Processing terminated) 00005 (Processed) 00007 (Discarded)
TEST_FLAG	CHAR	01	Ind.: Control recipe for test purposes, i.e. you may only create process messages with a test indicator
RECIPE_TEXT	CHAR	40	Short text of the order used in the master recipe
MATERIAL	CHAR	18	Header material of the process order
MATERIAL_TEXT	CHAR	40	Material description
INSPLOT	NUMC	12	Inspection lot number for the order
MATERIAL_EXTERNAL	CHAR	40	Long material number (future development) for MATERIAL field
MATERIAL_GUID	CHAR	32	External GUID (future development) for MATERIAL field
MATERIAL_VERSION	CHAR	10	Version number (future development) for MATERIAL field
BATCH	CHAR	10	Batch number of material to be produced
SCHEDULED_START_DATE	DATS	8	Earliest scheduled start date of control recipe (date)
SCHEDULED_START_TIME	TIMS	6	Earliest scheduled start date of control recipe (time)

System Messages

The R/3 System returns system messages that may appear during the method call in the Return parameter.

Export Parameter	Reference Structure	Description
Return	BAPIRET2	System messages on the method call

The following system messages may appear:

Type	ID	Number	System message
E	CB1	403	No control recipes found

Parameter Return / Structure BAPIRET2

Field	Format	Length	Description
TYPE	CHAR	01	System message type: S (Success) E (Error) W (Warning) I (Information)
ID	CHAR	20	Message class
NUMBER	NUMC	03	Number of system message
MESSAGE	CHAR	220	Message text
LOG_NO	CHAR	20	Application log: Log number
LOG_MSG_NO	NUMC	06	Application log: Serial message number
MESSAGE_V1	CHAR	50	Variable of system message
MESSAGE_V2	CHAR	50	Variable of system message
MESSAGE_V3	CHAR	50	Variable of system message
MESSAGE_V4	CHAR	50	Variable of system message
PARAMETER	CHAR	32	Parameter name
ROW	INT4	10	Line in the parameter
FIELD	CHAR	30	Field in the parameter
SYSTEM	CHAR	10	System (logical system) from which the message comes