Extract Processes

Extract processes extract information that is interfaced out of the system. Processes of this type typically extract records marked with a given run number. If the requester of the process does not supply a specific run number, the system assumes that the latest run number should be extracted. If you need to re - extract an historical batch, you can - simply supply the respective run number when you request the batch process.

The following table lists the various background processes that are used to extract information from ORMB:
Batch Control ID Program Name Description Multiple Threads Extra Parameters Records Between Commits / Minutes Between Cursor Re-Initiation
APAYACH CIPPXAPB

The automatic payment ACH (automated clearing house) download extraction process creates the flat file that is interfaced to the ACH. This process downloads all auto pay download staging records associated with its batch control ID that are marked with a supplied run number. If a run number is not supplied, the process extracts all automatic payment download records marked with the current run number.

Note: the ACTVTAPY process updates auto pay download records on their extract date so that they will be downloaded by this process.

Refer to Downloading Automatic Payments for more information.

Yes

FILE-PATH= directory path into which output should be placed

FILE-NAME= name of file into which output should be placed

MAX-ERRORS = Used to override the maximum number of errors after which the batch must be terminated.

NA
C1-APACH CIPPXA2B

The automatic payment ACH (automated clearing house) download extraction process creates the flat file that is interfaced to the ACH. This process downloads all auto pay download staging records associated with its batch control ID that are marked with a supplied run number. If a run number is not supplied, the process extracts all automatic payment download records marked with the current run number.

The NBR-DAYS parameter is added to the scheduled extract date to determine the draft date when the payment amount should be withdrawn from the customer's account. If specified, the value must be a non-negative numeric value.

The BUS-OR-CAL-DAYS parameter is required when the NBR-DAYS parameter is specified, otherwise it's not allowed. This parameter is used when adding the NBR-DAYS parameter to the scheduled extract date. Valid values are:

B - Business days

C - Calendar days

Note: the ACTVTAPY process updates auto pay download records on their extract date so that they will be downloaded by this process.

No

FILE-PATH= directory path into which output should be placed

FILE-NAME= name of file into which output should be placed

NBR-DAYS= number of days until withdrawal.

BUS-OR-CAL-DAYS= business or calendar days.

MAX-ERRORS = Used to override the maximum number of errors after which the batch must be terminated.

NA

Refer to Downloading Automatic Payments for more information.

APDL CIPADAPB

The A/P download process creates the flat file that is interfaced to your accounts payable software (to cut checks).

The process that is delivered has skeletal logic and must be customized by your organization to satisfy the needs of your accounts payable software.

In order to adapt the base package program to your specific needs, please following the standard steps:

Copy the base package program to your own program. Your own program should be prefixed with the letters CM (which stands for "customer modification"). This is important as it prevents the upgrade process from overwriting your new logic.

Introduce logic to format the downloaded records into your specific format.

If you need assistance, please contact the implementation support group.

Yes

FILE-PATH= directory path into which output should be placed

FILE-NAME= name of file into which output should be placed

MAX-ERRORS = Used to override the maximum number of errors after which the batch must be terminated.

NA

This process uses all adjustment extract records associated with its batch control that are marked with a supplied run number. If a run number is not supplied, the process uses all A/P request extract records marked with the current run number.

Refer to The A/P Interface for more information.

DWLDCOLL CIPLXCRB

The collection agency referral download extraction process creates the flat file that contains referrals to be interfaced to your collection agencies. This process extracts all collection agency referral history records associated with its batch control that are marked with a supplied run number. If a run number is not supplied, the process extracts all referral history records marked with the current run number.

The program that is delivered contains skeletal logic that should be used as the basis for your specific processing. The skeletal logic does NOT extract information to a flat file; you must introduce the logic to support your specific flat file format.

No

FILE-PATH= directory path into which output should be placed

FILE-NAME= name of file into which output should be placed

MAX-ERRORS = Used to override the maximum number of errors after which the batch must be terminated.

NA

In order to adapt the base package program to your specific needs, please following the standard steps:

Copy the base package program to your own program. Your own program should be prefixed with the letters CM (which stands for "customer modification"). This is important as it prevents the upgrade process from overwriting your new logic.

Introduce logic to format the downloaded records into your specific format.

Note: records are written to the referral history table when a collection agency oriented write-off events are activated. Referral history records may also be added manually by an operator.

Refer to How Do Collection Agency Referrals Work? for more information.

GLDL CIPFXGLB

The general ledger download process creates the flat file that is interfaced to your general ledger software.

This process uses all FT / Batch Process records associated with its batch control that are marked with a supplied run number. If a run number is not supplied, the process uses all FT / Process records marked with the current run number.

In order to adapt the base package program to your specific needs, please following the standard steps:

Copy the base package program to your own program. Your own program should be prefixed with the letters CM (which stands for "customer modification"). This is important as it prevents the upgrade process from overwriting your new logic.

Introduce logic to format the downloaded records into your specific format.

Refer to The GL Interface for more information.

No

FILE-PATH= directory path into which output should be placed

FILE-NAME= name of file into which output should be placed

MAX-ERRORS = Used to override the maximum number of errors after which the batch must be terminated.

NA
LTRPRT CIPCLTPB

The customer contact letter download process creates the flat file(s) that are interfaced to your letter print software to print letters associated with letter-oriented customer contacts.

This process extracts all customer contact records associated with its batch control ID that are marked with a supplied run number. If a run number is not supplied, the process uses all customer contact records associated with its batch control ID that are marked with the current run number.

Each downloaded letter's output is written to a filename that is a concatenation of the letter's Letter Template Code and the process's Thread Number. This means that this process can write to multiple files as multiple Letter Template Codes may be downloaded by this process.

The information that is extracted and placed on the flat file for each letter is controlled by each customer contact's letter template's extract algorithm. Refer to Letter Templates Control The Information Merged Onto Letters for information about how a letter's flat file records are constructed.

The FILE-PATH parameter controls where the output files are placed.

Yes

FILE-PATH= directory path into which output should be placed

FIELD-DELIM-SW=Y or N

CNTL-REC-SW=Y or N

MAX-ERRORS = Used to override the maximum number of errors after which the batch must be terminated.

NA

The format of the information on the flat file can be either tilde delimited or in a fixed position (based on the FIELD-DELIM-SW parameter). Tilde delimited output is used if you merge the information into a Word template. Fixed position output is used if you merge the information into a Doc 1 template.

You can use the CNTL-REC-SW parameter to cause the extract to produce a control record that contains batch code, run number, number of letters to print, etc.

Refer to Printing Letters for more information.

NDSXTR CIPWXNDB

The notification download extraction process creates the flat file that is interfaced to your notification routing. This process uses all notification download staging records associated with its batch control that are marked with a supplied run number. If a run number is not supplied, the process uses all records marked with the current run number.

The program that is delivered should be used as a sample as your record formats will differ. In order to adapt the base package program to your specific needs, please following the standard steps:

Yes

FILE-PATH= directory path into which output should be placed

FILE-NAME= name of file into which output should be placed

MAX-ERRORS = Used to override the maximum number of errors after which the batch must be terminated.

NA

Copy the base package program to your own program. Your own program should be prefixed with the letters CM (which stands for "customer modification"). This is important as it prevents the upgrade process from overwriting your new logic.

Introduce logic to format the downloaded records into your specific format.

Refer to Downloading Notifications for more information.

POSTROUT CIPBXBLB

The bill print process creates the flat file that is interfaced to your bill print software. This process uses all bill routing extract records associated with its batch control that are marked with a supplied run number. If a run number is not supplied, the process extracts all bill routing extract records marked with the current run number.

The information that is extracted and placed on the flat file for each bill is controlled by each bill route type's extract algorithm. Refer to Bill Route Controls The Information Merged Onto Bills for information about how a bill's flat file records are constructed.

Yes

FILE-PATH= directory path into which output should be placed

FILE-NAME= name of file into which output should be placed

MAX-ERRORS = Used to override the maximum number of errors after which the batch must be terminated.

NA

The FILE-PATH parameter controls where the output files are placed.

Refer to Printing Bills for more information.

QUOTROUT CIPCQTXB

The quote-print process creates the flat file that is interfaced to your quote-print software. This process uses all quote-routing extract records associated with its batch control that are marked with a supplied run number. If a run number is not supplied, the process extracts all quote routing extract records marked with the current run number.

The information that is extracted and placed on the flat file for each letter is controlled by each quote route type's extract algorithm. Refer to Quote Route Type Controls The Information Merged Onto Quotes for information about how a quote's flat file records are constructed.

The FILE-PATH parameter controls where the output files are placed.

Refer to Printing Quotes for more information.

Yes

FILE-PATH= directory path into which output should be placed

FILE-NAME= name of file into which output should be placed

MAX-ERRORS = Used to override the maximum number of errors after which the batch must be terminated.

NA
RTTYPOST CIPBRTBB

The bill route type bill print production process invokes the bill extract algorithm defined in the bill route type associated to the batch control. The extract algorithm will determine the bill print software to use and the report or bill template to use to produce all the bill routing records associated with the batch control and run number for a range of bills specified.

This process is similar to the Bill Print Production Process (POSTROUT). The differences are:

POSTROUT calls the extract algorithm defined in the Bill Route Type for each bill associated to the Bill Route Type; while RTTYPOST only calls the distinct extract algorithm associated with the batch control.

POSTROUT produces a flat file that is interfaced to a bill print software, while RTTYPOST calls the bill print software for every distinct extract algorithm found and produce the bills (i.e. the report containing the bills).

Refer to Printing Bills for more information

Yes

MAX-ERRORS = Used to override the maximum number of errors after which the batch must be terminated.

NA
STMDWLD CIPBSTXB

The statement download extraction process creates the flat file that contains statement information. This file will be interfaced to your bill print software, or whatever mechanism you will use for sending statements to the appropriate persons.

This process extracts all Statement records associated with its batch control that are marked with a supplied run number. If a run number is not supplied, the process extracts all Statement records marked with the current run number.

The information that is extracted and placed on the flat file for each statement is controlled by each statement's construct's route type's extract algorithm. Refer to Statement Route Types Control The Information Merged Onto Statements for information about how a statement's flat file records are constructed.

Refer to Printing Statements for more information.

Yes

FILE-PATH= directory path into which output should be placed

FILE-NAME= name of file into which output should be placed

MAX-ERRORS = Used to override the maximum number of errors after which the batch must be terminated.

200/15

Please refer to Column Descriptions for more information on the columns used in the table above.