CIUSPCFL Stored Procedure

You can delete the command flow data from the CICS® IA command flow Db2® tables using the CIUSPCFL stored procedure.

The CIUSPCFL stored procedure works with the following Db2® tables:

  • CIU_CMDFLOW_DATA
  • CIU_CMDFLOW_INDEX

What is the CIUSPCFL Stored Procedure?

The CIUSPCFL stored procedure deletes command flow data stored in the CICS® IA command flow Db2® tables.

Syntax

You can call the stored procedure CIUSPCFL procedure with the following SQL call statement

EXEC SQL 
CALL CIUSPCFL (calltype, collection id, index count, detail count, rc, errmsg)

Procedure parameters

The CIUSPCFL stored procedure includes several input and output parameters that control its execution and provide information about the process status or errors.

The following table lists all the CIUSPCFL parameters.

Table 1. CIUSPCFL parameters
Parameter name input/output Type Description
calltype INPUT CHAR(01) Call type
collection id INPUT CHAR(16) CICS® IA collection identifier(command_flow_id)
index count OUTPUT INTEGER

Count of records to be deleted from CIU_CMDFLOW_INDEX table

detail count OUTPUT INTEGER

Count of records to be deleted from CIU_CMDFLOW_DATA table

rc OUTPUT INTEGER Return code
errmsg OUTPUT VARCHAR(300) Error message text

CIUSPCFL INPUT parameters (calltype, collection id)

Table 2. Input parameters
Parameter Description
Calltype

Mandatory Parameter.

The parameter defines the type of collected data intended to be deleted.

Values: C- For Command flow related data

collection id

Mandatory parameter.

The collection ID parameter specifies the command flow ID under which the data was collected.

CIUSPCFL OUTPUT parameters (index count, detail count, rc, errmsg)

The index count parameter contains the count of records to be deleted from the CIU_CMDFLOW_INDEX table for the mentioned command flow ID.

The detail count parameter contains the count of records to be deleted from the CIU_CMDFLOW_DATA table for the command flow ID mentioned.

The rc parameter contains the value of the CIUSPCFL return code. Possible rc values are listed in the following table.

Table 3. rc values
Return code Description
0 CIUSPCFL procedure completed successfully.
4 CIUSPCFL procedure completed successfully, but one or more SQL warning conditions were received or there are no records in the tables for the command flow id provided.
8 CIUSPCFL procedure failed either because of the invalid call type specified or no command flow id has been provided.
12 CIUSPCFL has failed because of the SQL Exception conditions during SQL statement execution.
The errmsg contains message text that describes the error or warning:
  • For RC = 4, it contains the SQL message of the last SQL statement that caused the warning condition or contains that no records are present for the provided collection id.
  • For RC = 8, it provides the invalid parameter value that caused the error.
  • For RC = 12, it provides the SQL error message for the failed SQL statement.