Convoke/Citi - Bulk Document Exporter

01/17/2018 - Updated screenshot to show new Viewing Module icons.

NOTE: Convoke/Citi is a custom exporter. Please contact Collection-Master Client Services if you require this exporter.

This exporter requires that a field named FWFILENO exists in the vMedia database, populated with the Collection-Master Forwarder File Number (full credit card account number without delimiters). The CM Data Extractor 1.08 or later can be used to update this field in vMedia for existing documents once the field is created in vMedia.

  1. To access this exporter, click on the [View] icon.

  1. Ensure that a field named FWFILENO exists in the vMedia database populated with the Collection-Master forwarder file's file number (full credit card account number without delimiters).

  2. Perform an appropriate query (Database Search or External Query File) and then tag the desired documents from the Search Results list.

NOTE: If no documents are tagged, an Export Error message will appear.

3.  Click on the [Export] button to access the list of Class 1 Exporters.

4.  Click on the [Convoke/Citi] button.

NOTE: If the IMASTER.INI file is missing the [EXPCONVOKE-CITI] section, the following error will appear.

NOTE: If the above error occurs, edit the vMedia IMASTER.INI fileand add the [EXPCONVOKE-CITI] section.

  • The Export dialog box opens.

Select Output ZIP File Location and Name: Click to change the output folder which will contain a ZIP compressed archive of the exported media (Default name is Convoke-Citi_yyyymmdd-serial.ZIP created in the EXPORT folder inside the vMedia network folder).

Select Description Match File: Click to change the name of the Description Match Delimited Text File. A description match file must be created for each match field being used that translates the vMedia indexing information into Convoke/Citi document names.

Description Match File Layout: Tab-delimited text file contains two fields per record.

Field 1: Convoke/Citi Document Type Code - Character 40 characters max.

Field 2: vMedia Field Data To Match - Bounded same as in vMedia.

Description Match Field: Select the field from the vMedia Database that will be used to cross reference each document to the appropriate Convoke/Citi Document Code in the Document Match File.
Select the field from the vMedia Database that will be used to cross reference each document to the appropriate Convoke/Citi Document Code in the Document Match File.

Processing Log File: Click to change the location and/or name of the export processing log file.

Output: Tagged documents are each exported to individual PDF files named by the Convoke/Citi Legal September 2013 Document Export Standard. The individual PDF files are assembled into a ZIP archive.

Each document within the ZIP file is created with the following naming convention:

fwfileno_Convoke/Citidoctype_yyyymmd(tiebreaker).PDF

Where:

fwfileno is as from the vMedia FWFILENO field

Convoke/Citidoctype is replaced by the value from the lookup performed for each document in the Document Match File Field #1.

yyyymmdd is the year, month, day from the vMedia DDATE field

(Tiebreaker) is an optional numeric file-name conflict resolver suffix [formatted as (nnn)

ex. (1), (2), etc.]. Omitted if not needed as per the spec.

Note: If a corresponding match value can not be located in the Description Match File, the document will be skipped and an entry will be made in the processing log file.

Data and File Validation Logic. Export processing logging.

A processing log text file is created or appended for each export session that is run. The log file contains the date, time, and user running the export, as well as a line for each tagged document that fails to export for one of the following reasons:

1. Generated File Name is Invalid (fwfileno, doctype, or date fields contain impermissible characters)

2. Page Count is Invalid (zero page document)

3. Generated File Name Conflicts with Another Document after 1000 tiebreakers have been tried

4. Exported File Verification Failure (There was a problem verifying the document was successfully created in the output folder)

Saving Convoke/Citi Exporter Settings

Specific settings for any of the Convoke/Citi Exporter fields can be saved and used during subsequent exports.

IMASTER.INI Setup

1. Open the IMASTER.INI file in Notepad for editing (Start, Programs, vMedia, vMedia Config File from the Start Menu).

2. Navigate to the bottom of the comment section of the file and insert the following:

First Line: [EXPConvoke-Citi]

Second and subsequent Lines: One each of the following can be specified:

OutputFolder= full path to the desired ZIP and XLS file output folder (default is in the network IMASTER\EXPORT\ folder)

MatchField= name of vMedia field to use (default is first field in the vMedia Database)*

MatchFile= full path and filename of match file to use for document type matching (default is Convoke-CitiXREF.TXT in the network IMASTER folder)

LogFile= full path and filename of processing log file (default is Convoke-CitiEXPORT.LOG located in the network IMASTER\EXPORT\ folder)

Omit the line entirely to have it start at the specified default value. Including a setting as blank after the equals sign will explicitly set the value to blank.

Defaults marked with an asterisk (*) are placeholder values, and these settings will most likely need to be explicitly specified in order for the exporter to produce useful results.

Example, for a typical Vertica vMedia database, these are the values that would be used: (items not listed assume the default values as specified above) [EXPConvoke-Citi] MatchField=CMT

Related Topic

vMedia Bulk Document Exporter Introduction