General description

On entry, review the values stored in the updt->Function or ArsCSXitUpdtExit-Function fields to determine the type of call to make:

Names call

ARCCSXIT_PROCESS_NAMES (C)
arccsxit-processnames (COBOL)

Parameters call

ARCCSXIT_PROCESS_PARMS (C)
arccsxit-processparms (COBOL)

Input parameters for Names call

The following list shows the input parameters valid for the Names call. Do not attempt to use parameters that are not specified as being valid for a given call.

updt->pFileName
ArsCSXitUpdtExit-pFileName: Address of the null delimited file name. If the JES information pointer is null and the file name begins with the characters DD:, the remainder of the string contains the DD name of the MVS™ data set name used as input.
updt->ApplGrpName
ArsCSXitUpdtExit-ApplGrpName: Null delimited application group name. This is the application group name that ARSLOAD will attempt to use if no action is performed by the Names call.
updt->ApplName
ArsCSXitUpdtExit-ApplName: Null delimited application name. This is the application name that ARSLOAD will attempt to use if no action is performed by the Names call.
updt->ObjServer
ArsCSXitUpdtExit-ObjServer: Null delimited application name. This is the object server that ARSLOAD will attempt to use if no action is performed by the Names call. If no object server is explicitly specified, ARSLOAD will use the object server specified by the storage node that is designated for loading in the storage set assigned to the application group.
updt->StorageNode
ArsCSXitUpdtExit-Node: Null delimited storage node name. This is the storage node that ARSLOAD will attempt to use if no action is performed by the Names call. If no node is explicitly specified, ARSLOAD will use the primary storage node specified by the storage node that is designated for loading in the storage set assigned to the application group.
updt->ArsCSXitUpdtExit-pJES
ArsCSXitUpdtExit-pJES: Pointer to the JES information: ArsCSXitUpdtExit_JES (C) or ArsCSXitUpdtExit-JES (COBOL). If this pointer is not null, the object being loaded is being read from the JES SPOOL. The JES information contains a DD name that is currently allocated to the SPOOL file and a pointer to the JES SSS2 SSOB extension. If null, the file being processed is either an MVS data set or an HFS file.

Input parameters for Parameters call

The following list shows the input parameters valid for the Parameters call. Do not attempt to use parameters that are not specified as being valid for a given call.

updt->pFileName
ArsCSXitUpdtExit-pFileName: Address of the null delimited file name. If the JES information pointer is null and the file name begins with the characters DD:, the remainder of the string contains the DD name of the MVS data set name used as input.
updt->ApplGrpName
ArsCSXitUpdtExit-ApplGrpName: Null delimited application group name. This is the application group name the document will be stored under.
updt->ApplName
ArsCSXitUpdtExit-ApplName: Null delimited application name. This is the application name the document will be stored under.
updt->ObjServer
ArsCSXitUpdtExit-ObjServer: Null delimited application name. This is the object server that will be stored in. If the object server is X'00', ARSLOAD will use the object server specified by the storage node that is designated for loading in the storage set assigned to the application group.
updt->StorageNode
ArsCSXitUpdtExit-Node: Null delimited storage node name. This is the storage node that ARSLOAD will be stored in. If the node is X'00', ARSLOAD will use the primary storage node that is specified by the storage node that is designated for loading in the storage set that is assigned to the application group.
updt->ArsCSXitUpdtExit-pJES
ArsCSXitUpdtExit-pJES: Pointer to the JES information: ArsCSXitUpdtExit_JES (C) or ArsCSXitUpdtExit-JES (COBOL). If this pointer is not null, the object being loaded is being read from the JES SPOOL. The JES information contains a DDNAME that is currently allocated to the SPOOL file and a pointer to the JES SSS2 SSOB extension. If null, the file being processed is either an MVS data set or an HFS file.
updt->IndexerParms
ArsCSXitUpdtExit-Indexer: The indexer parameter that will be passed to the indexer. The indexer parameters are a series of records separated by newline characters (X'15'). If altered by the exit, this parameter is passed to the indexer. If updt->update_appl or ArsCSXitUpdtExit-update-appl are non-zero, the indexer parameter is stored back into the indexer parameters that are associated with the application.
updt->CCType
ArcCSXitUpdtExit-cc-type: Carriage control type. If altered by the exit, this value will be stored in the view information that is associated with the application. Changing this value after reports have been loaded may cause previously loaded documents to display incorrectly.
updt->LRECL
ArsCSXitUpdtExit-lrecl: For fixed record format the length of each line. This has no meaning for variable format. If altered by the exit, this value will be stored in the view information that is associated with the application. Changing this value after reports have been loaded may cause previously loaded documents to display incorrectly.
updt->RECFM
ArsCSXitUpdtExit-recfm: The record format the document is stored in Content Manager OnDemand. If altered by the exit, this value will be stored in the view information that is associated with the application. Changing this value after reports have been loaded may cause previously loaded documents to display incorrectly.
updt->update_appl
ArsCSXitUpdtExit-update-appl: Indicates that the application is to be updated. If zero, any changes made by the exit will not be reflected in the application definitions. If non-zero, the application will be updated with the new values.
updt->Delim
ArcCSXitUpdtExit-delim: For documents stored as stream, this is the NULL terminated string that contains the string that is used to determine record boundaries. For example, records that use EBCDIC newline characters as record delimiters would specify X'1500'.

Valid values for record format

Valid values for record format are described in Table 1.

Table 1. Record formats
Format	C	COBOL
Fixed	ARCCSXIT_DOC_FORMAT_FIXED	ArcCSXitUpdtExit-fixed
Variable	ARCCSXIT_DOC_FORMAT_VARIABLE	ArcCSXitUpdtExit-variable
Stream	ARCCSXIT_DOC_FORMAT_STREAM	ArcCSXitUpdtExit-stream

Valid values for carriage control

Valid values for carriage control are described in Table 2.

Table 2. Carriage control
Format	C	COBOL
ANSI	ARCCSXIT_CC_ANSI	ArcCSXitUpdtExit-cc-ansi
Machine	ARCCSXIT_CC_MACHINE	ArcCSXitUpdtExit-cc-machine
None	ARCCSXIT_CC_NONE	ArcCSXitUpdtExit-cc-none

Note:

Carriage control, lrecl, recfm, and record delimiter are only valid for documents stored as Line data.
Documents stored as variable in Content Manager OnDemand are stored with a two-byte length prefix followed by the data for the record. The length does not include the two-byte prefix.