Extension schema editor

About custom metadata and pdfaPilot's XMP Extension Schema editor

If a user wants to add custom metadata to a PDF/A file, an extension schema is required that covers this custom property.

callas pdfaPilot comes with its own XMP Extension schema editor, which can be accessed via the action "Extension schema editor" in the "Metadata" section in the Switchboard. Here you can have a look at predefined schemas, data fields and value types or create your own to be embedded during conversion to PDF/A. You can also capture properties which are present in the document metadata.

Create and Manage PDF/A compatible XMP extension schemas

Open the Extension Schema Editor in callas pdfaPIlot.

A new window opens with a long list of Extension Schema Properties:

Switch to the list of Extension Schemas:

A Schema is a container for an arbitrary number of properties. First you will have to create your own schema that will later take your properties. Click on the left of the three icons on top of the list in order to switch to the list of Extension Schemas. Then click on the green [+] icon at the bottom of the window.

Define your Schema

A new window opens that lets you define your schema. 

Give the schema a name that describes its area of application and a unique namespace URI:

The namespace URI is intended to be a unique string so that the schema can be identified. Therefore it is common practice to use a domain name that belongs to the organisation which is defining the Extension Schema. That reduces the propability does another organisation would use the same namespace. Note that it is neither required nor recommended that the namespace URI is in fact a website.

Define a prefix for the Extension Schema that will work as an abbreviation within the XMP metadata stream and enter a description for the Extension Schema. Mark the Extension Schema as ready to use, otherwise pdfaPilot would not use it. Save the Extension Schema:

The new schema will now show up in the Extension Shema list:

Extension Schema Property View

Switch to the Extension Schemas Properties view:

Click on the middle icon above the list of Extension Schemas in order to switch to the list of properties. Click at the green [+] icon in order to create a new property.

A new window opens that lets you define a property. Select the Extension Schema that you have just created:

The Namespace URI and the Prefix are listed accordingly. Enter name, display name and category for the new property:

Note: The category defines whether it is user data (External) or rather technical internal information (Internal).

The value type is either a simple value type, an open or closed choice or a structured type. For a simple value type leave the first pop up empty:

callas pdfaPilot lets you even define your own structured value types, .e.g in order to save machine data or an address (consisting of a name, a street, a city etc.). In order to define your own types you will have to use the right icon above the list of properties. Any type you will define there can be selected here. This is, however, not described in this document.

The last pop up is the actual type. In most cases "Text" is correct:

You can use any word of the Extension Schema or the property in order to filter the properties in the list:

You can now use the Metadata fields in a PDF file and pdfaPilot will automatically embed the Extension Schema for all entries that show up in a PDF file when it is converted to PDF/A.

But you can even define your own data types or structures in XMP, read below how you can do that with pdfaPilot.

Defining data types or structures in XMP

Select the value type list in the Extension Schema editor and click on + in order to create a new value type:

A new window opens that lets you define the value type properties:

Fill out the first rows with proper values. Lets create a value type for the address of the presenter. The address should consist of three properties. Click on the + in order to add field to the address type. You may also use the Pop-Up in order to add an existing field.

Enter the values for a street name. Use the + again in order to add more fields, for example, postal code and city:

Now go back to the properties view and add a new property by clicking on +:

You may now use the new value type for a new property in the existing namespace:

You may even use a structure e.g. if a presenter could have more than just one address, in this case you should use bag:

Finding Extension Schemas

Created extension schemas are stored in your pdfaPilot user folder within "PDFAExtSchema/Custom.pdfaschema". These can be used in the CLI/Server version by copying the file to the appropriate folder (e.g. "/.callas software gmbh/callas pdfaPilot <version>/PDFAExtSchema" on Unix).

0 Comments

Send Your Comment

E-Mail me when someone replies to this comment