Back Forward Extract rules
Completing the File Specification tab
  1. About 
  2. New 
  3. Definition 
  4. Filter Criteria 
  5. File Specification 
  6. Execution History 
  1. History 
  2. More... 

Complete this tab to control where extract output is written. Which fields appear depends on the Output Format you selected in the Definition tab.

Output Format

Fields
XML
  • XML Schema Directory — Identify a directory to receive the XML schema file.
  • XML Schema File Name — Enter a name for the XML schema file.
  • XML File Output Directory — Identify a directory to receive the XML output files.
  • XML Output File Name — Enter a name for the XML output files. The system automatically adds the.xml and .xsd extensions to the file name.
    You can use these wild card strings in the output file name to reference their corresponding substitution strings:
    • %i - (RunIdentifier) The unique run identifier that is written in the extract file. The identifier can be passed in as a command-line parameter to the command-line extract process using the -k option. If no identifier is passed in, the system uses the pzInsKey of the extract rule as the identifer.
    • %s - The automatically-generated sequence number.
    • %c - (ClassName) The Applies To class of the extract rule.
    • %r - The name of the extract rule.
    • %d - (ExtractRunDate) The date of the extract run.
    • %t - (ExtractRunDateTime) The date and time of the extract run.

These substitutions are also automatically applied to the BIX schema file for XML (XSD file) which is automatically generated for each run of an extract rule that outputs data in XML output.
CSV
  • CSV Output Directory — Identify a directory to receive the CSV files.
Database
  • Select the name of the database (an instance of Data-Admin-DB-Name) to receive extracted data.

cautionBecause the Pega RULES database is the source of the data, do not select PegaRULES as the target in this field.

After you complete this tab, save the rule form. Then click Test Connectivity to verify that you have a valid path to the database or directories specified in this tab. PRPC reports results of the test in a pop-up window.

Manifest

Check the Include manifest check box to create a manifest, or summary statement, of the records extracted. See a description of the manifest contents below. You can create the manifest in a manifest file format of your choice, independent of the output format you selected for the actual extract. Depending on your choice, further fields appear:

Output Format

Fields
XML
  • Manifest XML file output directory — Identify a directory to receive the XML output files.
  • Manifest XML output file name — Enter a name for the XML output files. The system automatically adds the.xml and .xsd extensions to the file name.
    You can use these wild card strings in the output file name to reference their corresponding substitution strings:
    • %i - (RunIdentifier) The unique run identifier that is written in the extract file. The identifier can be passed in as a command-line parameter to the command-line extract process using the -k option. If no identifier is passed in, the system uses the pzInsKey of the extract rule as the identifer.
    • %s - The automatically-generated sequence number.
    • %c - (ClassName) The Applies To class of the extract rule.
    • %r - The name of the extract rule.
    • %d - (ExtractRunDate) The date of the extract run.
    • %t - (ExtractRunDateTime) The date and time of the extract run.

These substitutions are also automatically applied to the BIX schema file for XML (XSD file) which is automatically generated for each run of an extract rule that outputs data in XML output.
Comma Separated File (CSV)

Manifest CSV file output directory — Identify a directory to receive the CSV files.
Database Schema

Manifest output database name -- Select the name of the database to which to write the manifest.

Note: if you want to output the manifest to a database, you must prepare the database by adding two tables, pr_extract_summary and pr_extract_details. When you run the extract for the first time (or after editing the rule), in the form where you enter run parameters check the Generate manifest schema DDL check box to create the schema DDL with which to create the tables. In the next field provide the location on your computer where the schema is to be created. Give the created schema to your database administrator, who can update the database so it can receive the manifest.

Click Test Connectivity to verify that you have a valid path to the database or directory you specified. PRPC reports results of the test in a pop-up window.

In the Include check total property field you can select an extract property to use as a "checksum" for the extract.

Contents of the manifest

The manifest you generate includes a summary of the extract run, including:

If you save the manifest to csv or to a database, the manifest also includes, for each destination csv file or table :

The extract writes the manifest records as a single commit at the end of the extract. If there is an error during this commit, the extract writes the manifest information to the log file.

Up About Extract rules