veraPDF

https://docs.verapdf.org/
Admin
veraPDF is an open source conformance checker for validating PDF documents against PDF/A and PDF/UA...
Tokens:16,757
Snippets:194
Trust Score:9.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### Automated Installation Output Example

Source: https://docs.verapdf.org/install

This is a sample of the output you can expect when running the automated installation process for veraPDF.

```text
Command line arguments: auto-install.xml 
[ Starting automated installation ]
====================
Installation started
Framework: 5.1.3-84aaf (IzPack)
Platform: linux,version=6.1.27-gentoo-r1-x86_64,arch=x64,symbolicName=null,javaVersion=17.0.8.1
[ Starting to unpack ]
[ Processing package: veraPDF GUI (1/3) ]
Cleaning up the target folder ...
[ Processing package: veraPDF Mac and *nix Scripts (2/3) ]
Cleaning up the target folder ...
[ Processing package: veraPDF Documentation (3/3) ]
Cleaning up the target folder ...
[ Unpacking finished ]
Installation finished
[ Writing the uninstaller data ... ]
[ Automated installation done ]

```

--------------------------------

### Command Line for Automated Installation

Source: https://docs.verapdf.org/install

Use this command to invoke the veraPDF installer with an XML configuration file. Windows users should use 'vera-install.bat'.

```bash
./verapdf-install ./auto-install.xml

```

--------------------------------

### Batch Summary Example

Source: https://docs.verapdf.org/cli/validation

An example of a batch summary output, indicating the total number of jobs processed, failures, and the total duration of the validation process.

```xml
<batchSummary totalJobs="1526" failedToParse="0" encrypted="0" outOfMemory="0" veraExceptions="0">
  <validationReports compliant="636" nonCompliant="890" failedJobs="0">1526</validationReports>
  <featureReports failedJobs="0">0</featureReports>
  <repairReports failedJobs="0">0</repairReports>
  <duration start="1485171727902" finish="1485171827790">00:01:39:888</duration>
</batchSummary>
```

--------------------------------

### veraPDF Automated Installation Configuration

Source: https://docs.verapdf.org/install

This XML file configures the automated installation of veraPDF, specifying installation directory and selected components.

```xml
<AutomatedInstallation langpack="eng">
    <com.izforge.izpack.panels.htmlhello.HTMLHelloPanel id="welcome"/>
    <com.izforge.izpack.panels.target.TargetPanel id="install_dir">
        <installpath>/tmp/verapdf-test</installpath>
    </com.izforge.izpack.panels.target.TargetPanel>
    <com.izforge.izpack.panels.packs.PacksPanel id="sdk_pack_select">
        <pack index="0" name="veraPDF GUI" selected="true"/>
        <pack index="1" name="veraPDF Mac and *nix Scripts" selected="true"/>
        <pack index="2" name="veraPDF Validation model" selected="false"/>
        <pack index="3" name="veraPDF Documentation" selected="true"/>
        <pack index="4" name="veraPDF Sample Plugins" selected="false"/>
    </com.izforge.izpack.panels.packs.PacksPanel>
    <com.izforge.izpack.panels.install.InstallPanel id="install"/>
    <com.izforge.izpack.panels.finish.FinishPanel id="finish"/>
</AutomatedInstallation>

```

--------------------------------

### Single Plugin Configuration in plugins.xml

Source: https://docs.verapdf.org/cli/config

An example of `plugins.xml` with a single plugin enabled. This configuration specifies the plugin's name, version, description, JAR path, and custom attributes.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<pluginsConfig>
    <plugin enabled="true">
        <name>Plugin Name</name>
        <version>1.0.1</version>
        <description>Some plugin description</description>
        <pluginJar>pluginPath/plugin.jar</pluginJar>
        <attributes>
            <attribute key="attrKey" value="attrValue"/>
            <attribute key="attr2Key" value="attr2Value"/>
        </attributes>
    </plugin>
</pluginsConfig>

```

--------------------------------

### Check veraPDF version on Linux

Source: https://docs.verapdf.org/cli/terminal

Verify the installed version of veraPDF on Linux.

```bash
cfw@dm-wrkstn:~/verapdf$ ./verapdf --version
veraPDF 1.28.2
Built: Fri Jan 13 11:30:00 GMT 2023
Developed and released by the veraPDF Consortium.
Funded by the PREFORMA project.
Released under the GNU General Public License v3
and the Mozilla Public License v2 or later.
```

--------------------------------

### Integrate veraPDF Processor API

Source: https://docs.verapdf.org/develop/processor

This example demonstrates initializing the veraPDF foundry, configuring the validator, feature extractor, plugins, and metadata fixer, and then processing a list of files. It includes error handling for processing and closing streams.

```java
public static void main(String[] args) {
	// Foundry initialising. Can be changed into PDFBox based one
	VeraGreenfieldFoundryProvider.initialise();
	// Default validator config
	ValidatorConfig validatorConfig = ValidatorFactory.defaultConfig();
	// or it is possible to specify required parameters using ValidatorConfigBuilder. For example, to specify a validation flavour explicitly:
	// ValidatorConfig validatorConfig = new ValidatorConfigBuilder().flavour(PDFAFlavour.PDFA_4).build();
	// Default features config
	FeatureExtractorConfig featureConfig = FeatureFactory.defaultConfig();
	// Default plugins config
	PluginsCollectionConfig pluginsConfig = PluginsCollectionConfig.defaultConfig();
	// Default fixer config
	MetadataFixerConfig fixerConfig = FixerFactory.defaultConfig();
	// Tasks configuring
	EnumSet<TaskType> tasks = EnumSet.noneOf(TaskType.class);
	tasks.add(TaskType.VALIDATE);
	tasks.add(TaskType.EXTRACT_FEATURES);
	tasks.add(TaskType.FIX_METADATA);
	// Creating processor config
	ProcessorConfig processorConfig = ProcessorFactory.fromValues(validatorConfig, featureConfig, pluginsConfig, fixerConfig, tasks);
	// Creating processor and output stream. In this example output stream is System.out
	try (BatchProcessor processor = ProcessorFactory.fileBatchProcessor(processorConfig);
		 OutputStream reportStream = System.out) {
		// Generating list of files for processing
		List<File> files = new ArrayList<>();
		files.add(new File("location/file.pdf"));
		// starting the processor
		processor.process(files, ProcessorFactory.getHandler(FormatOption.MRR, true, reportStream,
																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																									The veraPDF Processor API is the main entry point for integrating the veraPDF project into another one. This example shows how to initialize the necessary components and process a list of PDF files for validation, feature extraction, and metadata fixing. It covers the configuration of various aspects of the processor, including validator settings, feature extraction, plugins, and metadata fixing, as well as the selection of tasks to perform. The example also demonstrates how to create a batch processor and handle potential exceptions during the processing and stream closing operations. The primary language used is Java.
```

--------------------------------

### Navigate to the veraPDF directory on Windows

Source: https://docs.verapdf.org/cli/terminal

Change the current working directory to the default veraPDF installation folder.

```bash
C:\Users\cfw>cd verapdf
C:\Users\cfw\verapdf>
```

--------------------------------

### Check veraPDF version on Windows

Source: https://docs.verapdf.org/cli/terminal

Verify the installed version of veraPDF using the batch script.

```bash
C:\Users\cfw\verapdf>verapdf.bat --version
veraPDF 1.28.2
Built: Fri Jan 13 11:30:00 GMT 2023
Developed and released by the veraPDF Consortium.
Funded by the PREFORMA project.
Released under the GNU General Public License v3
and the Mozilla Public License v2 or later.
```

--------------------------------

### Font Feature Report Output

Source: https://docs.verapdf.org/cli/feature-extraction

Example of the XML report generated after running the extraction command.

```xml
<?xml version="1.0" encoding="utf-8"?>
  <report>
    <buildInformation>
      <releaseDetails id="core" version="1.28.2" buildDate="2023-01-10T02:34:00Z"></releaseDetails>
      <releaseDetails id="gui" version="1.28.2" buildDate="2023-01-13T11:30:00Z"></releaseDetails>
      <releaseDetails id="validation-model" version="1.28.2" buildDate="2023-01-10T02:39:00Z"></releaseDetails>
    </buildInformation>
    <jobs>
      <job>
        <item size="29813">
          <name>/home/cfw/verapdf/dev/corpus/veraPDF-corpus-staging/PDF_A-1b/6.3 Fonts/6.3.6 Font metrics/veraPDF test suite 6-3-6-t01-pass-a.pdf</name>
        </item>
        <featuresReport>
          <documentResources>
            <fonts>
              <font id="fntIndir11">
                <type>TrueType</type>
                <baseFont>SVIUCJ+TimesNewRomanPSMT</baseFont>
                <firstChar>32</firstChar>
                <lastChar>121</lastChar>
                <widths>...</widths>
                <encoding>WinAnsiEncoding</encoding>
                <fontDescriptor>
                  <fontName>SVIUCJ+TimesNewRomanPSMT</fontName>
                  <fontFamily>Times New Roman</fontFamily>
                  <fontStretch>Normal</fontStretch>
                  <fontWeight>400.0</fontWeight>
                  <fixedPitch>false</fixedPitch>
                  <serif>true</serif>
                  <symbolic>false</symbolic>
                  <script>false</script>
                  <nonsymbolic>true</nonsymbolic>
                  <italic>false</italic>
                  <allCap>false</allCap>
                  <smallCap>false</smallCap>
                  <forceBold>false</forceBold>
                  <fontBBox lly="-307.0" llx="-568.0" urx="2000.0" ury="1007.0"></fontBBox>
                  <italicAngle>0.0</italicAngle>
                  <ascent>1007.0</ascent>
                  <descent>-307.0</descent>
                  <leading>0.0</leading>
                  <capHeight>662.0</capHeight>
                  <xHeight>448.0</xHeight>
                  <stemV>80.0</stemV>
                  <stemH>0.0</stemH>
                  <averageWidth>0.0</averageWidth>
                  <maxWidth>0.0</maxWidth>
                  <missingWidth>0.0</missingWidth>
                  <embedded>true</embedded>
                </fontDescriptor>
              </font>
            </fonts>
          </documentResources>
        </featuresReport>
        <duration start="1485203090990" finish="1485203091403">00:00:00:413</duration>
      </job>
    </jobs>
  <batchSummary totalJobs="1" failedToParse="0" encrypted="0" outOfMemory="0" veraExceptions="0">
    <validationReports compliant="0" nonCompliant="0" failedJobs="0">0</validationReports>
    <featureReports failedJobs="0">1</featureReports>
    <repairReports failedJobs="0">0</repairReports>      
    <duration start="1485203090960" finish="1485203091479">00:00:00:519</duration>
  </batchSummary>
</report>
```

--------------------------------

### Navigate to the veraPDF directory on Linux

Source: https://docs.verapdf.org/cli/terminal

Change the current working directory to the default veraPDF installation folder on Linux.

```bash
cfw@dm-wrkstn:~$ cd verapdf
cfw@dm-wrkstn:~/verapdf$
```

--------------------------------

### Information Dictionary XML Structure

Source: https://docs.verapdf.org/policy

Example of the XML structure for Information Dictionary metadata entries.

```xml
<informationDict>
  <entry key="Title">Test title</entry>
  <entry key="Author">veraPDF Consortium</entry>
  <entry key="Subject">Test description</entry>
  <entry key="Keywords">TEST KEYWORDS</entry>
  <entry key="Creator">veraPDF Test Builder</entry>
  <entry key="Producer">veraPDF Test Builder 1.0 </entry>
  <entry key="CreationDate">2015-03-10T17:19:21.000+01:00</entry>
  <entry key="ModDate">2015-03-10T17:19:21.000+01:00</entry>
</informationDict>
```

--------------------------------

### Check veraPDF version on Mac OS

Source: https://docs.verapdf.org/cli/terminal

Verify the installed version of veraPDF on macOS.

```bash
dm-macmini:verapdf cfw$ ./verapdf --version
veraPDF 1.28.2
Built: Fri Jan 13 11:30:00 GMT 2023
Developed and released by the veraPDF Consortium.
Funded by the PREFORMA project.
Released under the GNU General Public License v3
and the Mozilla Public License v2 or later.
```

--------------------------------

### Validate PDF with Specific Profile

Source: https://docs.verapdf.org/cli/validation

Specify a validation profile using the `-f` or `--flavour` option followed by the profile code. This example validates a PDF/A-1b file.

```bash
verapdf -f 1b corpus/veraPDF-corpus-staging/PDF_A-1b/6.6\ Actions/6.6.1\ General/veraPDF\ test\ suite\ 6-6-1-t02-pass-a.pdf
```

--------------------------------

### Example feature extraction output

Source: https://docs.verapdf.org/cli/feature-extraction

Sample XML output generated by the veraPDF feature extractor.

```xml
<?xml version="1.0" encoding="utf-8"?>
<report>
  <buildInformation>
    <releaseDetails id="core" version="1.28.2" buildDate="2023-01-10T02:34:00Z"></releaseDetails>
    <releaseDetails id="gui" version="1.28.2" buildDate="2023-01-13T11:30:00Z"></releaseDetails>
    <releaseDetails id="validation-model" version="1.28.2" buildDate="2023-01-10T02:39:00Z"></releaseDetails>
  </buildInformation>
  <jobs>
    <job>
      <item size="1373256">
        <name>/home/cfw/verapdf/dev/adobe_supplement_iso32000.pdf</name>
      </item>
      <featuresReport>
        <informationDict>
          <entry key="Title">Acrobat Supplement to the ISO 32000</entry>
          <entry key="Author">Adobe Developer Support</entry>
          <entry key="Subject">Adobe Acrobat 9.0 SDK</entry>
          <entry key="Creator">FrameMaker 7.2</entry>
          <entry key="Producer">Acrobat Distiller 9.0.0 (Windows)</entry>
          <entry key="CreationDate">2008-05-22T15:17:22.000Z</entry>
          <entry key="ModDate">2008-05-29T17:07:38.000-07:00</entry>
        </informationDict>
      </featuresReport>
      <duration start="1485202393855" finish="1485202394208">00:00:00:053</duration>
    </job>
  </jobs>
  <batchSummary totalJobs="1" failedToParse="0" encrypted="0" outOfMemory="0" veraExceptions="0">
    <featureReports failedJobs="0">0</featureReports>
    <duration start="1485202393805" finish="1485202394254">00:00:00:449</duration>
  </batchSummary>
</report>
```

--------------------------------

### veraPDF Validation Report Example

Source: https://docs.verapdf.org/cli/validation

An example of the XML report generated by veraPDF after validating a PDF file. The `isCompliant` attribute in the `<validationReport>` tag indicates the validation result.

```xml
<?xml version="1.0" encoding="utf-8"?>
  <report>
    <buildInformation>
      <releaseDetails id="core" version="1.28.2" buildDate="2023-01-10T02:34:00Z"></releaseDetails>
      <releaseDetails id="gui" version="1.28.2" buildDate="2023-01-13T11:30:00Z"></releaseDetails>
      <releaseDetails id="validation-model" version="1.28.2" buildDate="2023-01-10T02:39:00Z"></releaseDetails>
    </buildInformation>
    <jobs>
      <job>
        <item size="10230">
          <name>/home/cfw/verapdf/dev/corpus/veraPDF-corpus-staging/PDF_A-1b/6.6 Actions/6.6.1 General/veraPDF test suite 6-6-1-t02-pass-a.pdf</name>
        </item>
        <validationReport profileName="PDF/A-1b validation profile" statement="PDF file is compliant with Validation Profile requirements." isCompliant="true">
            <details passedRules="102" failedRules="0" passedChecks="504" failedChecks="0"></details>
        </validationReport>
        <duration start="1485134290404" finish="1485134290797">00:00:00:393</duration>
      </job>
    </jobs>
    <batchSummary totalJobs="1" failedToParse="0" encrypted="0" outOfMemory="0" veraExceptions="0">
      <validationReports compliant="1" nonCompliant="0" failedJobs="0">1</validationReports>
      <featureReports failedJobs="0">0</featureReports>
      <repairReports failedJobs="0">0</repairReports>
      <duration start="1485134290384" finish="1485134290846">00:00:00:462</duration>
  </batchSummary>
</report>
```

--------------------------------

### Policy report output for passed checks

Source: https://docs.verapdf.org/policy

Example of a machine-readable policy report indicating successful font checks.

```xml
<policyReport passedChecks="2" failedChecks="0" xmlns:vera="http://www.verapdf.org/MachineReadableReport">
  <passedChecks>
    <check status="passed" test="contains(fontName,'AdobeGothicStd-Bold')" location="/report/jobs/job/featuresReport/documentResources/fonts/font[1]/fontDescriptor">
      <message>Adobe Gothic should be present.</message>
    </check>
    <check status="passed" test="contains(fontName,'AdobeGothicStd-Bold')" location="/report/jobs/job/featuresReport/documentResources/fonts/font[2]/fontDescriptor">
      <message>Adobe Gothic should be present.</message>
    </check>
  </passedChecks>
  <failedChecks/>
</policyReport>
```

--------------------------------

### Navigate to the veraPDF directory on Mac OS

Source: https://docs.verapdf.org/cli/terminal

Change the current working directory to the default veraPDF installation folder on macOS.

```bash
dm-macmini:~ cfw$ cd verapdf
dm-macmini:verapdf cfw$
```

--------------------------------

### Policy report output for failed checks

Source: https://docs.verapdf.org/policy

Example of a machine-readable policy report indicating failed font checks.

```xml
<policyReport passedChecks="0" failedChecks="2" xmlns:vera="http://www.verapdf.org/MachineReadableReport">
  <passedChecks/>
  <failedChecks>
    <check status="failed" test="not(contains(fontName,'AdobeGothicStd-Bold'))" location="/report/jobs/job/featuresReport/documentResources/fonts/font[1]/fontDescriptor">
      <message>Adobe Gothic Bold fonts are not allowed.</message>
    </check>
    <check status="failed" test="not(contains(fontName,'AdobeGothicStd-Bold'))" location="/report/jobs/job/featuresReport/documentResources/fonts/font[2]/fontDescriptor">
      <message>Adobe Gothic Bold fonts are not allowed.</message>
    </check>
  </failedChecks>
</policyReport>
```

--------------------------------

### Example XML validation report

Source: https://docs.verapdf.org/cli/validation

The output format generated by veraPDF when validating a document, showing build information, job details, and specific rule failures.

```xml
<?xml version="1.0" encoding="utf-8"?>
  <report>
    <buildInformation>
      <releaseDetails id="core" version="1.28.2" buildDate="2023-01-10T02:34:00Z"></releaseDetails>
      <releaseDetails id="gui" version="1.28.2" buildDate="2023-01-13T11:30:00Z"></releaseDetails>
      <releaseDetails id="validation-model" version="1.28.2" buildDate="2023-01-10T02:39:00Z"></releaseDetails>
    </buildInformation>
    <jobs>
      <job>
        <item size="6213">
          <name>/home/cfw/verapdf/dev/corpus/veraPDF-corpus-staging/PDF_A-1b/6.6 Actions/6.6.1 General/veraPDF test suite 6-6-1-t01-fail-a.pdf</name>
        </item>
        <validationReport profileName="PDF/A-1b validation profile" statement="PDF file is not compliant with Validation Profile requirements." isCompliant="false">
          <details passedRules="101" failedRules="1" passedChecks="358" failedChecks="1">
            <rule specification="ISO 19005-1:2005" clause="6.6.1" testNumber="1" status="failed" passedChecks="0" failedChecks="1">
              <description>The Launch, Sound, Movie, ResetForm, ImportData and JavaScript actions shall not be permitted.
                Additionally, the deprecated set-state and no-op actions shall not be permitted. The Hide action shall not be permitted (Corrigendum 2)</description>
              <object>PDAction</object>
              <test>S == "GoTo" || S == "GoToR" || S == "Thread" || S == "URI" || S == "Named" || S == "SubmitForm"</test>
              <check status="failed">
                <context>root/document[0]/OpenAction[0](5 0 obj PDAction)</context>
              </check>
            </rule>
          </details>
        </validationReport>
        <duration start="1485163106779" finish="1485163107279">00:00:00:500</duration>
      </job>
    </jobs>
    <batchSummary totalJobs="1" failedToParse="0" encrypted="0" outOfMemory="0" veraExceptions="0">
      <validationReports compliant="0" nonCompliant="1" failedJobs="0">1</validationReports>
      <featureReports failedJobs="0">0</featureReports>
      <repairReports failedJobs="0">0</repairReports>
      <duration start="1485163106741" finish="1485163107379">00:00:00:638</duration>
  </batchSummary>
</report>
```

--------------------------------

### List configuration files on Windows

Source: https://docs.verapdf.org/cli/config

Displays the contents of the veraPDF configuration directory on a Windows system.

```bash
C:\Users\cfw\verapdf>dir config
 Volume in drive C has no label.
 Volume Serial Number is 1C45-2074

 Directory of C:\Users\cfw\verapdf\config

22/01/2023  12:44    <DIR>          .
22/01/2023  12:44    <DIR>          ..
22/01/2023  12:44               411 app.xml
22/01/2023  12:44               186 features.xml
22/01/2023  12:44               109 fixer.xml
22/01/2023  12:44               131 validator.xml
               4 File(s)            837 bytes
               2 Dir(s)   3,695,038,464 bytes free
```

--------------------------------

### Clone and Build Greenfield Project

Source: https://docs.verapdf.org/develop

Clone the veraPDF consortium's greenfield implementation from GitHub and build it using git and Maven.

```bash
git clone https://github.com/veraPDF/veraPDF-validation.git
cd veraPDF-validation
mvn clean install
```

--------------------------------

### Clone and Build PDFBox Project

Source: https://docs.verapdf.org/develop

Clone the PDFBox implementation of veraPDF from GitHub and build it using git and Maven.

```bash
git clone https://github.com/veraPDF/veraPDF-pdfbox-validation.git
cd veraPDF-pdfbox-validation
mvn clean install
```

--------------------------------

### Empty plugins.xml Configuration

Source: https://docs.verapdf.org/cli/config

The default `config/plugins.xml` file contains an empty entry, serving as a base for adding plugin configurations.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<pluginsConfig/>

```

--------------------------------

### Initialize Greenfield Foundry

Source: https://docs.verapdf.org/develop

Initialize the veraPDF library's Greenfield foundry before first use. Ensure necessary imports are included.

```java
import org.verapdf.core.EncryptedPdfException;
import org.verapdf.core.ModelParsingException;
import org.verapdf.core.ValidationException;
import org.verapdf.gf.foundry.VeraGreenfieldFoundryProvider;
import org.verapdf.pdfa.Foundries;
import org.verapdf.pdfa.PDFAParser;
import org.verapdf.pdfa.results.ValidationResult;
import org.verapdf.pdfa.PDFAValidator;
import org.verapdf.pdfa.flavours.PDFAFlavour;

VeraGreenfieldFoundryProvider.initialise();
```

--------------------------------

### Initialize PDFBox Foundry

Source: https://docs.verapdf.org/develop

Initialize the veraPDF library's PDFBox foundry before first use. Ensure necessary imports are included.

```java
import org.verapdf.core.EncryptedPdfException;
import org.verapdf.core.ModelParsingException;
import org.verapdf.core.ValidationException;
import org.verapdf.pdfbox.foundry.PdfBoxFoundryProvider;
import org.verapdf.pdfa.Foundries;
import org.verapdf.pdfa.PDFAParser;
import org.verapdf.pdfa.results.ValidationResult;
import org.verapdf.pdfa.PDFAValidator;
import org.verapdf.pdfa.flavours.PDFAFlavour;

PdfBoxFoundryProvider.initialise();
```

--------------------------------

### Execute veraPDF policy check

Source: https://docs.verapdf.org/policy

Command line execution of a Schematron policy file against a target PDF file.

```bash
verapdf --policyfile font-disallowed.sch corpus/veraPDF-corpus-staging/PDF_A-1b/6.3\ Fonts/6.3.3.1\ General/veraPDF\ test\ suite\ 6-3-3-1-t01-pass-a.pdf
```

```bash
verapdf --policyfile single-font.sch corpus/veraPDF-corpus-staging/PDF_A-1b/6.3\ Fonts/6.3.3.1\ General/veraPDF\ test\ suite\ 6-3-3-1-t01-pass-a.pdf
```

--------------------------------

### Locate configuration files

Source: https://docs.verapdf.org/cli/config

Command to identify the file system path where veraPDF configuration files are stored.

```bash
verapdf --config
```

```text
CONFIG: Config location: C:\Users\<User name>\AppData\Roaming\verapdf\config
```

--------------------------------

### Specify Wiki Path

Source: https://docs.verapdf.org/cli/validation

Point to a local version of the veraPDF validation rule wiki. This is typically used if you are hosting your own wiki.

```bash
verapdf --wikiPath /path/to/local/wiki ...
```

--------------------------------

### Configure Image Feature Extraction

Source: https://docs.verapdf.org/cli/feature-extraction

Enable the IMAGE_XOBJECT feature by updating the features.xml configuration file.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<featuresConfig>
    <enabledFeatures>
        <feature>IMAGE_XOBJECT</feature>
    </enabledFeatures>
</featuresConfig>
```

--------------------------------

### Default application configuration

Source: https://docs.verapdf.org/cli/config

The standard XML structure for the veraPDF application configuration file.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<appConfig type="VALIDATE" format="XML" isVerbose="false">
    <fixerFolder></fixerFolder>
    <wikiPath>https://github.com/veraPDF/veraPDF-validation-profiles/wiki/</wikiPath>
    <policyFile></policyFile>
</appConfig>
```

--------------------------------

### Set default validation flavour

Source: https://docs.verapdf.org/cli/validation

Use the --defaultflavour or -df option to specify a fallback profile when XMP metadata is missing or invalid.

```bash
verapdf --defaultflavour 2b test.pdf
```

--------------------------------

### Extract XMP Metadata with VeraPDF

Source: https://docs.verapdf.org/cli/feature-extraction

Execute the verapdf command with the --extract option to process a PDF and output its XMP metadata.

```bash
verapdf --off --extract adobe_supplement_iso32000.pdf
```

--------------------------------

### List veraPDF Validation Profiles

Source: https://docs.verapdf.org/cli/validation

Use the `-l` or `--list` command to display all supported PDF/A and PDF/UA validation profiles. This command is available on all platforms.

```bash
verapdf -l
```

```bash
verapdf.bat --list
```

--------------------------------

### List available feature extraction options

Source: https://docs.verapdf.org/cli/feature-extraction

The complete set of features available for the --extract CLI option.

```text
actions, annotations, colorSpace, ds, embeddedFile, exGSt, font, formXobject, iccProfile, imageXobject, informationDict, interactiveFormField, lowLevelInfo, metadata, outlines, outputIntent, page, pattern, postscriptXobject, properties, shading, signature
```

--------------------------------

### Configure features.xml for Information Dictionary

Source: https://docs.verapdf.org/cli/feature-extraction

Edit the features.xml file to enable only the INFORMATION_DICTIONARY feature for extraction.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<featuresConfig>
    <enabledFeatures>
        <feature>INFORMATION_DICTIONARY</feature>
    </enabledFeatures>
</featuresConfig>
```

--------------------------------

### Enable All Feature Extraction

Source: https://docs.verapdf.org/cli/config

Configure the `features.xml` file to enable the extraction of all available PDF features. Add each desired feature as a separate `<feature>` sub-element.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<featuresConfig>
    <enabledFeatures>
        <feature>ACTION</feature>
        <feature>ANNOTATION</feature>
        <feature>COLORSPACE</feature>
        <feature>DOCUMENT_SECURITY</feature>
        <feature>EMBEDDED_FILE</feature>
        <feature>EXT_G_STATE</feature>
        <feature>FONT</feature>
        <feature>FORM_XOBJECT</feature>
        <feature>ICCPROFILE</feature>
        <feature>IMAGE_XOBJECT</feature>
        <feature>INFORMATION_DICTIONARY</feature>
        <feature>INTERACTIVE_FORM_FIELDS</feature>
        <feature>LOW_LEVEL_INFO</feature>
        <feature>METADATA</feature>
        <feature>OUTLINES</feature>
        <feature>OUTPUTINTENT</feature>
        <feature>PAGE</feature>
        <feature>PATTERN</feature>
        <feature>POSTSCRIPT_XOBJECT</feature>
        <feature>PROPERTIES</feature>
        <feature>SHADING</feature>
        <feature>SIGNATURE</feature>
    </enabledFeatures>
</featuresConfig>

```

--------------------------------

### Validate against a custom profile

Source: https://docs.verapdf.org/cli/validation

Use the --profile or -p option to validate a PDF file against a specific custom XML profile.

```bash
verapdf --profile profile.xml test.pdf
```

--------------------------------

### Configure Font Feature Extraction

Source: https://docs.verapdf.org/cli/feature-extraction

Update the features.xml file to enable the FONT feature.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<featuresConfig>
    <enabledFeatures>
        <feature>FONT</feature>
    </enabledFeatures>
</featuresConfig>
```

--------------------------------

### Validate encrypted PDF with password

Source: https://docs.verapdf.org/cli/validation

Provide a password for encrypted PDF files using the --password flag.

```bash
verapdf --password "12345" encrypted.pdf
```

--------------------------------

### Enable Information Dictionary Feature Extraction

Source: https://docs.verapdf.org/cli/config

Configure the `features.xml` file to enable the extraction of PDF document metadata from the information dictionary. This is the default setting.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<featuresConfig>
    <enabledFeatures>
        <feature>INFORMATION_DICTIONARY</feature>
    </enabledFeatures>
</featuresConfig>

```

--------------------------------

### Add veraPDF to Windows PATH

Source: https://docs.verapdf.org/cli/terminal

Update the PATH environment variable to allow running veraPDF from any directory.

```bash
C:\Users\cfw>set PATH=%PATH%;C:\Users\cfw\verapdf

C:\Users\cfw>
```

--------------------------------

### VeraPDF XMP Metadata Extraction Output

Source: https://docs.verapdf.org/cli/feature-extraction

The output shows the extracted XMP metadata in XML format, including build information and job details.

```xml
<?xml version="1.0" encoding="utf-8"?>
<report>
  <buildInformation>
    <releaseDetails id="core" version="1.28.2" buildDate="2023-01-10T02:34:00Z"></releaseDetails>
    <releaseDetails id="gui" version="1.28.2" buildDate="2023-01-13T11:30:00Z"></releaseDetails>
    <releaseDetails id="validation-model" version="1.28.2" buildDate="2023-01-10T02:39:00Z"></releaseDetails>
  </buildInformation>
  <jobs>
    <job>
      <item size="1373256">
        <name>/home/cfw/verapdf/dev/adobe_supplement_iso32000.pdf</name>
      </item>
      <featuresReport>
        <metadata>
          <xmpPackage>
            <x:xmpmeta x:xmptk="Adobe XMP Core 4.2.1-c041 52.332438, 2008/03/16-20:10:24        " xmlns:x="adobe:ns:meta/">
              <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
                <rdf:Description xmlns:xmp="http://ns.adobe.com/xap/1.0/" rdf:about="">
                  <xmp:CreatorTool>FrameMaker 7.2</xmp:CreatorTool>
                  <xmp:ModifyDate>2008-05-29T17:07:38-07:00</xmp:ModifyDate>
                  <xmp:CreateDate>2008-05-22T15:17:22Z</xmp:CreateDate>
                  <xmp:MetadataDate>2008-05-29T17:07:38-07:00</xmp:MetadataDate>
                </rdf:Description>
                <rdf:Description rdf:about="" xmlns:dc="http://purl.org/dc/elements/1.1/">
                  <dc:format>application/pdf</dc:format>
                  <dc:title>
                    <rdf:Alt>
                      <rdf:li xml:lang="x-default">Acrobat Supplement to the ISO 32000</rdf:li>
                    </rdf:Alt>
                  </dc:title>
                  <dc:creator>
                    <rdf:Seq>
                      <rdf:li>Adobe Developer Support</rdf:li>
                    </rdf:Seq>
                  </dc:creator>
                  <dc:description>
                    <rdf:Alt>
                      <rdf:li xml:lang="x-default">Adobe Acrobat 9.0 SDK</rdf:li>
                    </rdf:Alt>
                  </dc:description>
                </rdf:Description>
                <rdf:Description xmlns:pdf="http://ns.adobe.com/pdf/1.3/" rdf:about="">
                  <pdf:Producer>Acrobat Distiller 9.0.0 (Windows)</pdf:Producer>
                </rdf:Description>
                <rdf:Description xmlns:xmpMM="http://ns.adobe.com/xap/1.0/mm/" rdf:about="">
                  <xmpMM:DocumentID>uuid:d5b217b3-93ee-471c-8fa0-e427ef138e39</xmpMM:DocumentID>
                  <xmpMM:InstanceID>uuid:4642285f-19a7-4222-985a-a056fd98cd1d</xmpMM:InstanceID>
                </rdf:Description>
              </rdf:RDF>
            </x:xmpmeta>
          </xmpPackage>
        </metadata>
      </featuresReport>
        <duration start="1485202088037" finish="1485202088009">00:00:00:038</duration>
    </job>
  </jobs>
  <batchSummary totalJobs="1" failedToParse="0" encrypted="0" outOfMemory="0" veraExceptions="0">
    <validationReports compliant="0" nonCompliant="0" failedJobs="0">0</validationReports>
    <featureReports failedJobs="0">1</featureReports>
    <repairReports failedJobs="0">0</repairReports>  
    <duration start="1485202087637" finish="1485202088042">00:00:00:405</duration>
  </batchSummary>
</report>

```

--------------------------------

### Execute veraPDF Extraction Command

Source: https://docs.verapdf.org/cli/feature-extraction

Run the veraPDF command-line tool to extract features from a specific PDF file.

```bash
verapdf --off --extract corpus/veraPDF-corpus-staging/PDF_A-1b/6.2\ Graphics/6.2.4\ Images/veraPDF\ test\ suite\ 6-2-4-t03-pass-a.pdf
```

--------------------------------

### Execute veraPDF Extraction Command

Source: https://docs.verapdf.org/cli/feature-extraction

Run the veraPDF command-line tool to extract features from a specific PDF file.

```bash
verapdf --off --extract corpus/veraPDF-corpus-staging/PDF_A-1b/6.3 Fonts/6.3.6 Font metrics/veraPDF test suite 6-3-6-t01-pass-a.pdf
```

--------------------------------

### Validate with automatic flavour detection

Source: https://docs.verapdf.org/cli/validation

Use the -f 0 or --flavour 0 option to allow veraPDF to automatically select the appropriate profile based on document metadata.

```bash
verapdf -f 0 corpus/veraPDF-corpus-staging/PDF_A-1b/6.6\ Actions/6.6.1\ General/veraPDF\ test\ suite\ 6-6-1-t0 veraPDF test suite 6-6-1-t01-fail-a.pdf veraPDF test suite 6-6-1-t02-pass-a.pdf
```

```bash
verapdf corpus/veraPDF-corpus-staging/PDF_A-1b/6.6\ Actions/6.6.1\ General/veraPDF\ test\ suite\ 6-6-1-t0 veraPDF test suite 6-6-1-t01-fail-a.pdf
```

--------------------------------

### Add Greenfield Jakarta Dependency

Source: https://docs.verapdf.org/develop

Use this Maven dependency for the Greenfield implementation if your project uses Jakarta instead of javax.

```xml
<dependency>
  <groupId>org.verapdf</groupId>
  <artifactId>validation-model-jakarta</artifactId>
  <version>1.28.1</version>
</dependency>
```

--------------------------------

### Enable METADATA Feature in VeraPDF

Source: https://docs.verapdf.org/cli/feature-extraction

Modify the features.xml configuration file to enable the METADATA feature before running VeraPDF.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<featuresConfig>
    <enabledFeatures>
        <feature>METADATA</feature>
    </enabledFeatures>
</featuresConfig>

```

--------------------------------

### Add PDFBox Jakarta Dependency

Source: https://docs.verapdf.org/develop

Use this Maven dependency for the PDFBox implementation if your project uses Jakarta instead of javax.

```xml
<dependency>
  <groupId>org.verapdf</groupId>
  <artifactId>pdfbox-validation-model-jakarta</artifactId>
  <version>1.28.1</version>
</dependency>
```

--------------------------------

### Specify Report Format

Source: https://docs.verapdf.org/cli/validation

Control the output format of the validation report. Available formats include 'text', 'raw', 'html', and 'json'.

```bash
verapdf --format text ...
verapdf --format raw ...
verapdf --format html ...
verapdf --format json ...
```

--------------------------------

### Validate Files with Non-PDF Extensions

Source: https://docs.verapdf.org/cli/validation

Process files that may have a non-standard extension but are actually PDF documents. Use this option when dealing with files that do not have a '.pdf' extension.

```bash
verapdf somefile --nonpdfext
```

--------------------------------

### Schematron Schema for Compression Check

Source: https://docs.verapdf.org/policy

This Schematron schema defines rules to check for specific compression types used in a PDF document's report. It includes both assertions for required compressions and reports for allowed ones.

```xml
<sch:schema xmlns:sch="http://purl.oclc.org/dsdl/schematron" queryBinding="xslt">
  <sch:pattern name="Check compressions used in the document">
    <sch:rule context="/report/jobs/job/featuresReport">
      <sch:report test="lowLevelInfo/filters/filter/@name = 'CCITTDecode'">CCITT compression is OK</sch:report>
      <sch:assert test="lowLevelInfo/filters/filter/@name = 'DCTDecode'">JPEG compression is not OK</sch:assert>
    </sch:rule>
  </sch:pattern>
</sch:schema>
```

--------------------------------

### Validate PDF against multiple detected flavours

Source: https://docs.verapdf.org/develop

Extracts all conformance declarations from a PDF and validates against specific families like PDF/A and PDF/UA.

```java
VeraGreenfieldFoundryProvider.initialise();
try (PDFAParser parser = Foundries.defaultInstance().createParser(new FileInputStream("mydoc.pdf"))) {
	List<PDFAFlavour> detectedFlavours = parser.getFlavours();
	List<PDFAFlavour> flavours = new LinkedList<>();
	for (PDFAFlavour flavour : detectedFlavours) {
		// iterate through all detected flavours and pick up PDF/A and PDF/UA ones for validation
		if (PDFFlavours.isFlavourFamily(flavour, PDFAFlavour.SpecificationFamily.PDF_A) || 
				PDFFlavours.isFlavourFamily(flavour, PDFAFlavour.SpecificationFamily.PDF_UA)) {
			flavours.add(flavour);
		}
	}
	PDFAValidator validator = Foundries.defaultInstance().createValidator(flavours);
	List<ValidationResult> results = validator.validateAll(parser);
	for (ValidationResult result : results) {
		if (result.isCompliant()) {
			// File complies to flavour
		} else {
			// File doesn't comply to flavour
		}
	}
} catch (IOException | ValidationException | ModelParsingException | EncryptedPdfException exception) {
	// Exception during validation
}
```

--------------------------------

### Show Processed File Names

Source: https://docs.verapdf.org/cli/validation

Display the names of all processed files during batch operations. This is useful for tracking progress and identifying specific files in large batches.

```bash
verapdf -d ...
```

--------------------------------

### Include Logs in Report

Source: https://docs.verapdf.org/cli/validation

Include log messages directly within the generated report. The level of detail for logs can be controlled using the `--loglevel` option.

```bash
verapdf --addlogs --loglevel 4 ...
```

--------------------------------

### Default validation configuration

Source: https://docs.verapdf.org/cli/config

The standard XML structure for the veraPDF validator configuration file.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<validatorConfig flavour="NO_FLAVOUR" defaultFlavour="PDFA_1_B" recordPasses="false" maxFails="-1" debug="false" showErrorMessages="true" isLogsEnabled="true" loggingLevel="WARNING" maxNumberOfDisplayedFailedChecks="100" showProgress="false"/>
```

--------------------------------

### Add Greenfield Parser Dependency

Source: https://docs.verapdf.org/develop

Include veraPDF's greenfield parser and validation model in your Maven project. Adjust the version as needed.

```xml
<dependency>
  <groupId>org.verapdf</groupId>
  <artifactId>validation-model</artifactId>
  <version>1.28.1</version>
</dependency>
```

--------------------------------

### Add PDFBox Parser Dependency

Source: https://docs.verapdf.org/develop

Include the PDFBox-based validation model in your Maven project. Adjust the version as needed.

```xml
<dependency>
  <groupId>org.verapdf</groupId>
  <artifactId>pdfbox-validation-model</artifactId>
  <version>1.28.1</version>
</dependency>
```

--------------------------------

### Metadata Fixer Configuration

Source: https://docs.verapdf.org/cli/config

Configuration for the metadata fixer, specifying a fix ID and a prefix for fixes.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<fixerConfig fixId="true" fixesPrefix="veraFixMd_"/>

```
Tokens:
Raw