IFilterShop XMP IFilter Server Edition Release 3.1 README

CONTENT OF README FILE


General Information

XMP IFilter is a plug-in that allows Microsoft Search products and services to index XMP metadata in digital images, enabling customers to search and organize their content. XMP IFilter extracts metadata from Adobe XMP compatible files such as GIF, JPEG, PNG, EPS, PSD, AI and SVG. XMP IFilter supports Dublin Core, XMP Basic, Adobe Photoshop and custom XMP schemas. XMP IFilter is easily extensible and can support other XMP core schemas such as Rights Management or Media Management. If your metadata needs are not covered by the core schemas, you may add custom schemas as extensions. Please refer to "Support for custom XMP schemas" section for more information. For better integration with Microsoft applications XMP IFilter also outputs common office document properties such as 'DocAuthor', 'DocKeywords' and others. See "Office Document Properties" sections below for more information.

XMP IFilter supports Indexing Service, SharePoint Portal Server, SQL Server Full-Text Search, Window Search Service and all other products based on Microsoft Search technology.


System Requirements

XMP IFilter supports the following Microsoft server operating systems:

XMP IFilter supports the following Microsoft desktop operating systems:

XMP IFilter supports the following Microsoft Search products


Information Retrieval

Dublin Core Schema support

The Dublin Core Schema provides a set of commonly used properties.

Support for Dublin Core Schema is optional and enabled by default. To disable Dublin Core Schema support: Please note. When Dublin Core Schema support is disabled, XMP IFilter does not output certain office document properties. See
"Office Document Properties" section below for more information.

XMP IFilter extracts the following XMP Dublin Core metadata:

XMP Dublin Core MetadataProperty NameProperty TypeDescription
dc:contributorcontributorVT_LPWSTRContributors to the resource (other than the authors)
dc:coveragecoverageVT_LPWSTRThe extent or scope of the resource
dc:creatorcreatorVT_LPWSTRThe authors of the resource (listed in order of precedence, if significant)
dc:datedateVT_FILETIMEDate(s) that something interesting happened to the resource
dc:descriptiondescriptionVT_LPWSTRA textual description of the content of the resource
dc:formatformatVT_LPWSTRThe file format used when saving the resource
dc:identifieridentifierVT_LPWSTRUnique identifier of the resource
dc:languagelanguageVT_LPWSTRLanguage of the document
dc:publisherpublisherVT_LPWSTRPublishers
dc:relationrelationVT_LPWSTRHow the content relates to other resources
dc:rightsrightsVT_LPWSTRInformal rights statement
dc:sourcesourceVT_LPWSTRUnique identifier of the work from which this resource was derived
dc:subjectsubjectVT_LPWSTRAn unordered array of descriptive phrases or keywords that specify the topic of the content of the resource
dc:titletitleVT_LPWSTRThe title of the document, or the name given to the resource
dc:typetypeVT_LPWSTRA document type; for example, novel, poem, or working paper

In accordance with Microsoft IFilter specification, XMP IFilter defines each metadata as combination of Property Set and Property Name. All XMP Dublin Core metadata belong to {DC099694-64F5-4371-9AA9-868846A5657E} Property Set GUID.


XMP Basic Schema support

The XMP Basic Schema contains properties that provide basic descriptive information.

Support for XMP Basic Schema is optional and enabled by default. To disable XMP Basic Schema support: Please note. When XMP Basic Schema support is disabled, XMP IFilter does not output certain office document properties. See "Office Document Properties" section below for more information.

XMP IFilter extracts the following XMP Basic metadata:

XMP Basic MetadataProperty NameProperty TypeDescription
xap:AdvisoryAdvisoryVT_LPWSTRAn unordered array specifying properties that were edited outside the authoring application
xap:BaseURLBaseURLVT_LPWSTRThe base URL for relative URLs in the document content
xap:CreateDateCreateDateVT_FILETIMEThe date and time the resource was originally created
xap:CreatorToolCreatorToolVT_LPWSTRThe name of the first known tool used to create the resource
xap:IdentifierIdentifierVT_LPWSTRAn unordered array of text strings that unambiguously identify the resource within a given context
xap:MetadataDateMetadataDateVT_FILETIMEThe date and time that any metadata for this resource was last changed. It should be the same as or more recent than xap:ModifyDate
xap:ModifyDateModifyDateVT_FILETIMEThe date and time the resource was last modified
xap:NicknameNicknameVT_LPWSTRA short informal name for the resource

All XMP Basic metadata belong to {BA64F93D-FBA6-4b75-8F7F-37FC8B493176} Property Set GUID.


Adobe Photoshop Schema support

Adobe Photoshop Schema specifies properties used by Adobe Photoshop.

Support for Adobe Photoshop Schema is optional and enabled by default. To disable Adobe Photoshop Schema support:

XMP IFilter extracts the following XMP Adobe Photoshop metadata:

XMP Adobe Photoshop MetadataProperty NameProperty TypeDescription
photoshop:AuthorsPositionAuthorsPositionVT_LPWSTRBy-line title
photoshop:CaptionWriterCaptionWriterVT_LPWSTRWriter/editor
photoshop:CategoryCategoryVT_LPWSTRPhotoshop Category
photoshop:CityCityVT_LPWSTRCity location that the original image was created
photoshop:CountryCountryVT_LPWSTRCountry where the original image was created
photoshop:CreditCreditVT_LPWSTRInformation needed in the credit line for a copyrighted image
photoshop:DateCreatedDateCreatedVT_FILETIMEThe date the intellectual content of the document was created
photoshop:HeadlineHeadlineVT_LPWSTRHeadline
photoshop:InstructionsInstructionsVT_LPWSTRSpecial instructions
photoshop:SourceSourceVT_LPWSTRSource
photoshop:StateStateVT_LPWSTRState or province location where the original image was created
photoshop:SupplementalCategoriesSupplementalCategoriesVT_LPWSTRPhotoshop Supplemental Categories
photoshop:TransmissionReferenceTransmissionReferenceVT_LPWSTRInformation on the original transmission location of the image
photoshop:UrgencyUrgencyVT_INTEditorial urgency of the image

All XMP Adobe Photoshop metadata belong to {2FA65D5A-CB17-4A14-80AC-6A3EFCBCF413} Property Set GUID.


Support for custom XMP schemas

XMP IFilter is easily configurable for additional XMP core schemas and custom XMP schemas. To make your custom XMP schema searchable:

  1. Open registry key "HKEY_LOCAL_MACHINE\SOFTWARE\IFilterShop\XmpFilter\CustomSchemas"
  2. Create a new key with custom XMP schema name. For example, for XMP EXIF Schema the new entry can be:
    "HKEY_LOCAL_MACHINE\SOFTWARE\IFilterShop\XmpFilter\CustomSchemas\EXIF Schema"
  3. Under the registry key created add the following String values:
    Registry valueDescriptionExample for XMP EXIF Schema
    NameSpaceURI for custom XMP schemahttp://ns.adobe.com/exif/1.0/
    GUIDProperty Set GUID that will be used by Indexing Service *{2C443B1E-F1E2-404F-974D-E21FEF8E72AA}
    FileNameFull path to the text file with custom XMP schema properties mapping **C:\IFilterShop\XmpFilter\ExifSchema.txt

    * GUID shall be a newly generated GUID

    ** FileName value is optional. If this value is missing then all properties within the schema will be indexed

    Each line in the text file referred by FileName value shall have the following structure:
    <XMP Metadata>;<Property Name>;<Property Type>, where

    For example, XMP EXIF Schema property setup file can be defined as:
    MakerNote;Exif_MakerNote
    UserComment;UserComment
    WhiteBalance;WhiteBalance;VT_INT
    DateTimeOriginal;DateTimeCreated;VT_FILETIME
    DateTimeDigitized;Exif_DateTimeDigitized;VT_FILETIME
    

  4. Close registry editor and restart all appropriate Search services


Indexing of XMP sidecar files

A sidecar file is an alternative to storing the metadata directly in the image file itself by instead storing the data in a separate .xmp file with the same base name as the image file. Sidecars are typically used in cases where the file format of the image file does not directly support embedding metadata or in cases when the image file should not be edited directly.

XMP IFilter supports indexing of XMP sidecar files. When loaded for a digital image file, XMP IFilter will at first try to locate .xmp file with the same base name and the same location as the original image file. If .xmp file is found, XMP IFilter will extract XMP metadata from that file. If .xmp file is not available, XMP IFilter will extract XMP metadata from the image file itself.


Office Document Properties

XMP IFilter outputs the following standard Indexing Service properties as duplicates of certain XMP Dublin Core and XMP Basic properties when support for Dublin Core Schema and XMP Basic Schema are enabled.

Property Friendly NameProperty Set GUIDProperty NameDescriptionXMP Metadata
DocAuthor{F29F85E0-4FF9-1068-AB91-08002B27B3D9}4Author of the documentdc:creator
DocCreatedTm{F29F85E0-4FF9-1068-AB91-08002B27B3D9}12Time document was createdxap:CreateDate
DocKeywords{F29F85E0-4FF9-1068-AB91-08002B27B3D9}5Keywords for the documentdc:subject
DocLastSavedTm{F29F85E0-4FF9-1068-AB91-08002B27B3D9}13 Time document was last savedxap:ModifyDate
DocSubject{F29F85E0-4FF9-1068-AB91-08002B27B3D9}3Subject of the documentdc:description
DocTitle{F29F85E0-4FF9-1068-AB91-08002B27B3D9}2Title of the documentdc:title


Installation Instructions

Setup file is a self-extracting archive that must be downloaded and opened on the machine where you wish to use XMP IFilter.

  1. Stop all appropriate Search services.
  2. Uninstall any previous version of XMP IFilter.
  3. Start setup file and follow the on-screen instructions.
  4. Start all appropriate Search services.
  5. Re-index catalogs containing ".jpg", ".gif" and other XMP compatible files.


Multiple Properties Output

By default XMP IFilter outputs multiple instances of the property as multiple properties. In products such as SharePoint Portal Server 2003 only one instance of the same value property can be indexed. XMP IFilter can be configured to output multiple instances of the property as a single value property. To enable this:

  1. Stop all appropriate Search services.
  2. Open registry key "HKEY_LOCAL_MACHINE\SOFTWARE\IFilterShop\XmpFilter"
  3. Change the value of "MultipleInstancesMode" registry key to "1". If this value is set to "0" or missing, XMP IFilter will output multiple instances of the property as multiple properties.
  4. Start all appropriate Search services.
  5. Re-index catalogs containing ".jpg", ".gif" and other XMP compatible files.


Additional Setup Steps

Some Microsoft Search products require additional setup steps as described below:

SharePoint Portal Server 2003:

  1. Open "Site Settings" web page
  2. In the "Search Settings and Indexed Content" section click on "Configure search and indexing"
  3. Click on "Include file types"
  4. Make sure that ".jpg", ".gif" and all other XMP compatible file types you are planning to index are included

Office SharePoint Server 2007:

  1. Open Shared Services Provider Admin Site
  2. In the "Search" section click on "Search settings"
  3. Click on "File type inclusions"
  4. Make sure that ".jpg", ".gif" and all other XMP compatible file types you are planning to index are included

Windows SharePoint Services 3.0:

  1. Open registry key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Shared Tools\Web Server Extensions\12.0\Search\Applications\<WSS Server Name>\Gather\Search\Extensions\ExtensionList"
  2. Add ".jpg", ".gif" and all other XMP compatible file types you are planning to index to the list of indexable file types
  3. Restart Windows SharePoint Services Search

SharePoint Server 2010:

  1. In SharePoint Central Administration go to "General Application Settings" page
  2. In the "Search" section click on "Farm-Wide Search Administration"
  3. Click on " Search Service Application" link
  4. On the left side menu select "File Types"
  5. Make sure that ".jpg", ".gif" and all other XMP compatible file types you are planning to index are included

Windows Desktop Search:

When integrated with Windows Desktop Search XMP IFilter uses temporary directory to process digital image files. By default it uses system temporary directory. For Window Desktop Search versions 3.x and higher XMP IFilter must be set to work with user specified temporary directory. To change temporary directory setting:

  1. Stop Windows Search service.
  2. Open registry key "HKEY_LOCAL_MACHINE\SOFTWARE\IFilterShop\XmpFilter"
  3. Add new String value named "TempPath" and enter the full path to the new temporary directory. If this value is missing, empty or the path is not pointing to a valid directory, system temporary directory will be used. Please make sure that "Users" or "Authenticated Users" Group has "Full Control" permissions to the custom temporary directory.
  4. Start Windows Search service.
When using custom temporary directory, we recommend that you set it as "not indexable" in all your indexing products. Otherwise temporary files may be indexed. This will pollute the index and also can prevent temporary files from proper removal by XMP IFilter.

Vista Search, Windows 7 Search:

Configure custom temporary directory as described in "Additional Setup Steps" for Windows Desktop Search section above.


How to Uninstall

If you ever have to uninstall XMP IFilter application you can easily do this using any of the following methods:


Known Issues

XMP metadata stored in sidecar files are not searchable in Windows Vista, Windows 7 or Windows Desktop Search

Make sure that "Users" or "Authenticated Users" Group has "Read" permission for the directory that contains digital images and corresponding XMP sidecar files.


XMP metadata embedded into XMP compatible digital image files are not searchable in Windows Vista, Windows 7 or Windows Desktop Search

Custom temporary directory has to be configured as described in "Additional Setup Steps" for Windows Desktop Search section above.


XMP IFilter indexes XMP metadata in some but not all digital image files with the same extension

XMP IFilter indexes content of XMP metadata packages. Existence of XMP metadata is becoming increasingly important but it is not mandatory. Some files may not have XMP metadata embedded. In this case XMP IFilter can not index them. You can check if XMP packet is embedded by opening image file in a text editor and searching for <?xpacket string.


Indexing Tagged Image File Format (TIFF) files with SharePoint Portal Server

TIFF files may be indexed with either Microsoft TIFF IFilter or XMP IFilter. Microsoft TIFF IFilter which comes with Windows 2008 and Windows 7 lets you index text of TIFF files such as faxed or scanned documents. It does this by processing the files with optical character recognition (OCR) engine. XMP IFilter allows you to search XMP metadata of image files in TIFF format (pictures, graphics, photographs, etc.). Which IFilter you use depends solely on your needs and objectives.

PLEASE NOTE. When both IFilters are installed SharePoint server uses Microsoft TIFF Filter by default. In order to use XMP IFilter for TIFF files indexing you have to register XMP IFilter for TIFF files in SharePoint Registry settings:

If you would like Microsoft TIFF Filter to take over indexing TIFF files again you will need to unregister XMP IFilter for TIFF files in SharePoint Registry settings:


Additional Information

What is Adobe XMP?

Adobe eXtensible Metadata Platform enables various types of content with open standards metadata. It works by embedding metadata packets into binary data file. XMP metadata can currently be embedded into various image files (GIF, PNG, JPEG, TIFF) and document files such as PDF, PostScript, Adobe Illustrator, Adobe FrameMaker. Metadata packets are specifically designed to preserve consistency of the file, so that other applications would not be affected. XMP metadata is extremely rich in nature and suits a large variety of tasks. More information about Adobe XMP can be found at http://www.adobe.com/products/xmp.

What is Dublin Core?

Dublin Core is an initiative to create digital library metadata for the Web. Dublin Core is made up of 15 metadata (data that describes data) elements that offer expanded cataloging information and improved document indexing for search engine programs. Two forms of Dublin Core exist: Simple Dublin Core and Qualified Dublin Core. Simple Dublin Core expresses elements as attribute-value pairs using just the 15 metadata elements from the Dublin Core Metadata Element Set. Qualified Dublin Core increases the specificity of metadata by adding information about encoding schemes, enumerated lists of values, or other processing clues. While enabling searches to be more specific, qualifiers are also more complex and can pose challenges to interoperability. More information about Dublin Core may be found at http://www.dublincore.org.

PLEASE NOTE. Adobe XMP and XMP IFilter use Dublin Core version 1.1. Lately Dublin Core Metadata Initiative board extended the set with more elements thus making the previous specification obsolete. This should not affect the performance of Adobe XMP and XMP IFilter. Current specification is fully backwards compatible with version 1.1.


What's new in this version

Version 3.1

Version 3.0

Version 2.2

Version 2.1


Contact Information

WWW:
http://www.ifiltershop.com
E-mail:
support@ifiltershop.com