XMP IFilter Server Edition Release 6.0 README

CONTENT OF README FILE

• General Information

• System Requirements

• Information Retrieval

• Support for custom XMP schemas

• Indexing of XMP sidecar files

• Office Document Properties

• Installation Instructions

• Basic Installation Steps

• Multiple Properties Output

• Additional Setup Steps

• How to Uninstall

• Known Issues

• Additional Information

• What's new in this version

• Contact Information

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 SharePoint Server, SQL Server Full-Text Search, Window Search and all other products based on Microsoft Search technology.

System Requirements

XMP IFilter supports the following Microsoft server operating systems:

• Windows Server 2012
• Windows Server 2016
• Windows Server 2019
• Windows Server 2022

XMP IFilter supports the following Microsoft desktop operating systems:

• Windows 10
• Windows 11

XMP IFilter supports the following Microsoft Search products

• SharePoint Server 2013
• SharePoint Server 2016
• SharePoint Server 2019
• SQL Server 2014
• SQL Server 2016
• SQL Server 2017
• SQL Server 2019
• Windows Search

Information Retrieval

Dublin Core Schema support

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

• The schema namespace URI is http://purl.org/dc/elements/1.1/
• The preferred schema namespace prefix is dc

Support for Dublin Core Schema is optional and enabled by default. To disable Dublin Core Schema support:

• Open registry key "HKEY_LOCAL_MACHINE\SOFTWARE\IFilterShop\XmpFilter\DefaultSchemas"
• Change "DC" DWORD registry value from 1 to 0

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:

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.

• The schema namespace URI is http://ns.adobe.com/xap/1.0/
• The preferred schema namespace prefix is xap

Support for XMP Basic Schema is optional and enabled by default. To disable XMP Basic Schema support:

• Open registry key "HKEY_LOCAL_MACHINE\SOFTWARE\IFilterShop\XmpFilter\DefaultSchemas"
• Change "XAP" DWORD registry value from 1 to 0

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:

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.

• The schema namespace URI is http://ns.adobe.com/photoshop/1.0/
• The preferred schema namespace prefix is photoshop

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

• Open registry key "HKEY_LOCAL_MACHINE\SOFTWARE\IFilterShop\XmpFilter\DefaultSchemas"
• Change "PHOTOSHOP" DWORD registry value from 1 to 0

XMP IFilter extracts the following XMP Adobe Photoshop metadata:

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 value	Description	Example for XMP EXIF Schema
   NameSpace	URI for custom XMP schema	http://ns.adobe.com/exif/1.0/
   GUID	Property Set GUID that will be used by Indexing Service *	{2C443B1E-F1E2-404F-974D-E21FEF8E72AA}
   FileName	Full 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

   • <XMP Metadata> is a name of property (or path in general case) in custom XMP schema to be extracted by XMP IFilter. <XMP Metadata> shall not include namespace prefix.
   • <Property Name> defines property name for Search service
   • <Property Type> defines Property Type for Search service. This parameter is optional; all properties have VT_LPWSTR type by default. Other currently supported Property Types are VT_FILETIME and VT_INT

   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 Name	Property Set GUID	Property Name	Description	XMP Metadata
DocAuthor	{F29F85E0-4FF9-1068-AB91-08002B27B3D9}	4	Author of the document	dc:creator
DocCreatedTm	{F29F85E0-4FF9-1068-AB91-08002B27B3D9}	12	Time document was created	xap:CreateDate
DocKeywords	{F29F85E0-4FF9-1068-AB91-08002B27B3D9}	5	Keywords for the document	dc:subject
DocLastSavedTm	{F29F85E0-4FF9-1068-AB91-08002B27B3D9}	13	Time document was last saved	xap:ModifyDate
DocSubject	{F29F85E0-4FF9-1068-AB91-08002B27B3D9}	3	Subject of the document	dc:description
DocTitle	{F29F85E0-4FF9-1068-AB91-08002B27B3D9}	2	Title of the document	dc: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 Server:

1. In SharePoint Central Administration go to "General Application Settings" page
2. In the "Search" section click on "Farm 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
6. Restart SharePoint Search Host Controller service

Microsoft SQL Server:

1. Restart SQL Server service
2. Perform a Full Population

Windows Search:

When integrated with Windows Search, XMP IFilter uses a temporary directory to process digital image files. Due to Windows Search security restrictions, IFilters are not able to utilize the default system temporary directory. Therefore, XMP IFilter must be set to work with a user specified temporary directory. To change the XMP IFilter temporary directory's settings:

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.

How to Uninstall

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

• Through "Add/Remove Program". Open Control Panel ->Add/Remove Program. Select "IFilterShop XMP IFilter" in currently installed list. Press "Remove" button.
• Through XMP IFilter Uninstall program. Go to the directory where XMP IFilter was installed (C:\Program Files\IFilterShop\XmpFilter by default). Run uninstall.exe program.

Known Issues

XMP metadata stored in sidecar files are not searchable with Windows 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 with Windows Desktop Search

Custom temporary directory has to be configured as described in Additional Setup Steps for Windows 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 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:

• Stop all appropriate Search services.
• Call TIFF registration function from XmpFilter.dll (there is no output in case of success):

  rundll32 <%FULL_PATH_TO_XMP_IFILTER_INSTALL_DIR%>\XmpFilter.dll,SpsTiffRegister
  

• Start all appropriate Search services.

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:

• Stop all appropriate Search services.
• Call TIFF unregistration function from XmpFilter.dll (there is no output in case of success):

  rundll32 <%FULL_PATH_TO_XMP_IFILTER_INSTALL_DIR%>\XmpFilter.dll,SpsTiffUnregister
  

• Start all appropriate Search services.

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 6.0

• Support for SQL Server 2019

Version 5.0

• Support for SharePoint Server 2019

Version 4.0

• Support for SharePoint Server 2013 and 2016
• Support for SQL Server 2012 - 2017

Version 3.1

• Support for FAST Search Server 2010
• Improved integration with Indexing Service on Windows Server 2008 platform

Version 3.0

• Support for XMP sidecar files indexing
• Support for Microsoft Live Photo Gallery tags
• Support for Microsoft SharePoint Server 2010
• Improved integration with Microsoft SQL Server 2008

Version 2.2

• Support for Windows x64 platform

Version 2.1

• Support for custom XMP schemas
• Entire custom schema is indexed when property setup file is omitted
• Properties of VT_FILETIME and VT_INT types are supported in both custom and core XMP schemas
• XMP Basic schema is indexed by default
• Property Mappings list extended to include DocCreatedTm and DocLastSavedTm office document properties

Contact Information

WWW: https://www.ifiltershop.com

E-mail: support@ifiltershop.com