SetRdci

Assigns the values of the parameter rdci_keys_rec, which is the parameter for the keys within the RDCI record, to the API RDCI record. It also returns the contents of the updated API RDCI record in the output parameter rdci_rec, which is the parameter for the entire RDCI record.

The component items of an API RDCI record which are not component items of rdci_keys_rec, such as all the numeric ID items, are implicitly assigned by this function. For example, patient ID is not a key field, but because it is part of the RDCI record, it is populated implicitly once the external patient identifier is supplied and validated.

Syntax

short int SetRdci(RdciKeysRecord *rdci_keys_rec,

    RdciRecord *rdci_rec);

Parameters

rdci_keys_rec (in): The RdciKeysRecord definition containing the value that you want to assign to the API RDCI record.

rdci_rec (out): The RdciRecord definition containing the contents of the updated API RDCI record.

Return Value

SUCCESS or FAILURE or WARNING.

Comments

This function fails if:

the API RDCI buffer is empty.
the API RDCI record exists in the database and has not been locked, or its locked but the user does not have the privilege required for SetPageStatus. To learn about locking the API RDCI record see FetchRdci, WriteRdciRdcm, WriteResponses and FlushResponses. To learn about privileges, see the "Functional State Mapping Information" and the "Functional State Transition Diagram".

Only the items of rdci_keys_rec that have a value different from that of the corresponding item in the API RDCI record will be considered. These items will be validated first. All of them have to pass validation in order for the update to take place; otherwise no update will take place and the function will return FAILURE. The type of validation taking place here is individual item validation whereas cross-item validation will happen as part of the validation of the API RDCI record as a unit which takes place in ProcessRdci.

If this function fails, rdci_rec will be empty; if it succeeds rdci_rec will contain the current contents of the updated API RDCI record.

To populate an empty API RDCI buffer, see CreateRdci and FetchRdci.

Error Messages

Table 7-34 Error Messages for SetRdci

Number	Severity	Message
284900	ERR	User does not have the privilege to call function in the current mode.
285000	ERR	Function called out of sequence.
285900	ERR	No current OCL database connection open. Use ConnectOCL to connect to OCL database.
286600	ERR	Audit reason required and not provided.
289800	ERR	This document already exists in the database.
290500	ERR	This site/investigator pair is invalid for study.
290600	ERR	Invalid investigator.
290700	ERR	Invalid site.
290800	ERR	Patient position is frozen.
290900	ERR	Patient not enrolled for this study.
291000	ERR	Patient position is invalid.
291200	ERR	DCI is inactive or invalid.
291300	ERR	[error message returned by OCL_CLIENT_PACK. Validate document.]
291400	ERR	Clinical planned event is invalid for the current study.
294600	ERR	Document found in different study. Change study to access.
294900	WRN	Site is currently inactive.
295000	WRN	Investigator is currently inactive.
297000	ERR	Null or invalid input pointers provided.
299700	WRN	The data entered for this received DCI will be deleted.
299800	ERR	Date cannot exceed today's date.
300900	ERR	No update allowed to the RDCI buffer.
304600	ERR	Function does not exist.
304700	ERR	Privilege does not exist.
305600	ERR	Invalid DCI date.
305700	ERR	Invalid DCI time.
306800	ERR	Invalid audit reason.
307000	ERR	Cannot call this function if you have not locked the record.
308700	ERR	Cannot set RDCI time until RDCI short name is set.
308900	ERR	DCI short name is not updateable.
309000	ERR	Document number is not updateable.
309300	ERR	Patient is not updateable.
309500	ERR	Date is not updateable.
309700	ERR	Time is not updateable.
309900	ERR	Visit name is not updateable.
310100	ERR	Subevent number is not updateable.
310300	ERR	Site is not updateable.
310500	ERR	Investigator is not updateable.
310700	ERR	Blank flag is not updateable.
310900	ERR	Comment is not updateable.
311600	ERR	DCI comment number can not be updated to null.
311700	ERR	Document number must not have lower case.
314800	ERR	Received DCI is accessible; please use Key Changes to change Blank Flag.
315000	ERR	Some received DCMs are accessible; please use Key Changes to change Blank Flag.
315100	WRN	Responses exist for this RDCI. Changing the Blank Flag to 'Y' will cause them to be irrevocably deleted.
659700	ERR	No default audit reason.
659800	ERR	More than one default audit reason found.
660000	ERR	Cannot use system-generated audit reason.

Related Functions

GetRdci, ProcessRdci, CreateRdci, FetchRdci, WriteRdciRdcm

Parent topic: Data Capture API Functions