Command Line module

 

Running batch validation with the Command Line

You can use the Command Line module to revalidate multiple subjects which consists of running any question validation and 'collect if' conditions, and calculating any derived values..

 

Subjects are revalidated in order of study/site/subject ID.

 

You cannot select subjects by Subject Label or run batch validation for a single eForm via the Command Line. If you want to use these features, you must use the Batch Validation module.

 

We do not recommend running two or more instances of Batch Validation from the Command Line simultaneously on the same study, because this may result in study lock conflicts. There are no known issues when running two or more instances of Batch Validation simultaneously if each instance is accessing subjects from different studies.

 

 

Run revalidation

This routine enables you to revalidate subjects.

Parameters

Ensure you follow the required conventions when specifying user credentials, subject parameters and visit/eForm parameters.

 

Parameter

Description

Functionality identifier

"BV"

User credentials

User name/Password/Database/Userrole

Logfile

Full path of log file

Study

Name of study

Site

Site code. If 'All Sites', revalidation will be for all sites to which the current user has access with the given role

From

Subject Id of first subject to be revalidated. If '0' or missing, start at first available subject

To

Subject Id of last subject to be revalidated. If '0' or missing, finish at last available subject, otherwise To must be greater than or equal to From

Verbose

True for 'verbose' output. Any other value is for log changes only

SaveChanges

True to save changes. Any other value is to log changes without saving

CSVOutput

True to save an additional CSV output file; any other value is to exclude the CSV output

AutoUnlock

True to automatically unlock any locked data before batch validation is run

AutoRelock

True to automatically relock any auto-unlocked data after batch validation is run

AutoUnfreeze

True to automatically unfreeze any frozen data before batch validation is run

AutoRefreeze

True to automatically refreeze any auto-unfrozen data after batch validation is run

Freeze/Lock behaviour

Click here for more information on the behaviour of automatic unfreezing/unlocking.

Using batch files

Batch files (with extension .bat) can be created containing one or more of these lines. Each line can specify a different range of subjects, and large sets of subjects can therefore be revalidated by executing a single batch file.

 

For example, if the following lines of text are saved to a batch file and executed, subjects 1 to 150 for Demostudy30 will be revalidated in three batches of 50 subjects each, unfreezing/unlocking and refreezing/relocking all data.

 

InferMed.M40.MACRO_BV.exe /BV/rde/macrotm/TEST_DB/MACROUser/C:\BVLogFiles\BVLogDemo030613_1_50.txt/Demostudy30/All

Sites/1/50/False/True/True/True/True/True/True

 

InferMed.M40.MACRO_BV.exe /BV/rde/macrotm/TEST_DB/MACROUser/C:\BVLogFiles\BVLogDemo030613_51_100.txt/Demostudy30/All

Sites/51/100/False/True/True/True/True/True/True

 

InferMed.M40.MACRO_BV.exe /BV/rde/macrotm/TEST_DB/MACROUser/C:\BVLogFiles\BVLogDemo030613_101_150.txt/Demostudy30/All

Sites/101/150/False/True/True/True/True/True/True

 

Warning: When creating a batch file for multiple calls to Batch Validation, ensure that a different log file is specified for each call, otherwise the log files for earlier runs will be overwritten by later ones.

Command Line and result format

Creating a DCR:

/BV/Username/Password/Database/Role/Logfile/Study/Site/From/To/Verbose/SaveChanges/CSVOutput/AutoUnlock/AutoRelock/AutoUnfreeze/AutoRefreeze

 

Results are written to a log file in the location specified in the Logfile parameter. The log file name will be of the form BVCLyyyymmddhhmmss.log where yyyymmddhhmmss represents the timestamp of the error. If more than one error log is written within a second, the file names will have additional numeric suffixes. Any errors arising from invalid Command Line parameters (e.g. missing parameter, invalid username or database, or non-existent study) are included.

Example

To run Batch Validation as user ‘rde’ on the TEST_DB database, revalidating Demostudy30 subjects from all sites with subject IDs of 50 or greater, logging changes only (Verbose = False), saving changes, producing an additional CSV output file and unfreezing and unlocking any frozen or locked data before revalidation, then refreezing and relocking it afterwards:

nferMed.M40.MACRO_BV.exe/BV/rde/macrotm/TEST_DB/MACROUser/C:\BVLogFiles\BVLogDemo3June13.txt/Demostudy30/All Sites/50/0/False/True/True/True/True/True/True

 

Return to top

 

Related Topics

About Batch Validation