ZipSync Validation

The ZipSync process automatically validates all CSV files to ensure that:

  • All required files are present
  • Files have all required columns
  • All files have the header row
  • Phone numbers are in the required format
  • Email addresses are in the required format
  • All referential relationships between the ZipSync files are consistent (e.g., between Users & Sites)
  • Valid values for CSV content exist on the client side (where possible to confirm); for example, DS_GROUPS.csv / TIMEZONE, DS, DS_USERS.csv / LANGUAGE_OVERRIDE, DS_TEXT_PHONE_DEVICES.csv / COUNTRY_CODE

If no validation errors occur, the files are uploaded; if there are validation errors, they are logged to the CSV file indicated in the console output.

Runtime Modes & Command Line Flags

There are three runtime modes for validation:

  • Validate and upload only if no validation errors found (default)
  • Validate only (do not upload)
  • Validate and force upload even if validation errors found

You can control these modes using the following command line flags:

Flag Description
(No flag) Validates the ZIP file and uploads only if no validation errors occur

-v

--validate

 Validates the ZIP file without uploading

-f

--force

 Forces upload of the ZIP file regardless of validation result
Examples

epic file <filename>.zip

epic file <filename>.zip --validate

epic file <filename>.zip -f

EPIC Return Codes

The EPIC process will return one of the following codes:

Return Code Description

0

 Success: no validation errors occurred and ZIP file upload succeeded

2

 Validation failure: validation errors occurred (independent of upload requirement)
255

Program error: possible causes include bad command line parameters, inability to reach the server, or some other problem that prevented the program from completing.

Note: while this value is typically 255, it may also be any non-zero value except 2.

When the EPIC client validates the ZIP file and then uploads it to the server, any errors (e.g., due to network issues, etc.) that occur after validation will be reported; in this case, validation results are not reported. Note that this applies by default and when -f is specified. However, if the -f option is used and the upload was successful, validation errors will be reported.