Sunteți pe pagina 1din 124

Hitachi Content Platform

Searching Namespaces

FASTFIND LINKS Document Organization Product Version Getting Help Table of Contents

MK-96ARC003-11

Copyright 20072011 Hitachi Data Systems Corporation, ALL RIGHTS RESERVED No part of this publication may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, or stored in a database or retrieval system for any purpose without the express written permission of Hitachi Data Systems Corporation (hereinafter referred to as Hitachi Data Systems). Hitachi Data Systems reserves the right to make changes to this document at any time without notice and assumes no responsibility for its use. This document contains the most current information available at the time of publication. When new and/or revised information becomes available, this entire document will be updated and distributed to all registered users. Some of the features described in this document may not be currently available. Refer to the most recent product announcement or contact your local Hitachi Data Systems sales office for information about feature and product availability. Notice: Hitachi Data Systems products and services can be ordered only under the terms and conditions of the applicable Hitachi Data Systems agreement(s). The use of Hitachi Data Systems products is governed by the terms of your agreement(s) with Hitachi Data Systems. By using this software, you agree that you are responsible for: a) Acquiring the relevant consents as may be required under local privacy laws or otherwise from employees and other individuals to access relevant data; and b) Ensuring that data continues to be held, retrieved, deleted, or otherwise processed in accordance with relevant laws. Hitachi is a registered trademark of Hitachi, Ltd. in the United States and other countries. Hitachi Data Systems is a registered trademark and service mark of Hitachi, Ltd. in the United States and other countries. All other trademarks, service marks, and company names are properties of their respective owners.

Contents
Preface........................................................................................................vii
Intended audience . . . . Product version . . . . . . Document organization . Syntax notation . . . . . . Related documents. . . . Getting help. . . . . . . . . Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ... ... ... ... ... ... ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .... .... .... .... .... .... .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii . vii . viii . viii . .ix . xii . xii

Introduction to searching in HCP........................................................1-1


About Hitachi Content Platform . . . . . . . . . . . . Objects . . . . . . . . . . . . . . . . . . . . . . . . . . Namespaces and tenants . . . . . . . . . . . . . Object metadata. . . . . . . . . . . . . . . . . . . . Retention settings . . . . . . . . . . . . . . . . . . Retention mode . . . . . . . . . . . . . . . . . . . . About searching namespaces. . . . . . . . . . . . . . Search Console . . . . . . . . . . . . . . . . . . . . Search facilities . . . . . . . . . . . . . . . . . . . . Search index . . . . . . . . . . . . . . . . . . . . . . Searchable namespaces . . . . . . . . . . . . . . Using the Search Console . . . . . . . . . . . . . Search Console URL . . . . . . . . . . . . . . . Search Console sessions . . . . . . . . . . . . Search Console pages and navigation . . . Viewing search documentation. . . . . . . . Changing your password . . . . . . . . . . . . Setting HDDS credentials. . . . . . . . . . . . .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... . . . . . . . . . . . . . . . . . . .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 . 1-2 . 1-2 . 1-3 . 1-3 . 1-4 . 1-4 . 1-5 . 1-5 . 1-5 . 1-6 . 1-7 . 1-7 . 1-8 .1-10 .1-10 .1-11 .1-12

Contents Searching Namespaces

iii

Working with simple searches ............................................................2-1


About simple searches . . . . . . . . . . . . . Search terms . . . . . . . . . . . . . . . . . Directory paths and object names Multiple exact phrases. . . . . . . . . Wildcards. . . . . . . . . . . . . . . . . . Boolean criteria . . . . . . . . . . . . . Did you mean? . . . . . . . . . . . . . . Performing a simple search . . . . . . . . . . Examples of simple searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ... ... ... ... ... ... ... ... ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 2-2 2-3 2-4 2-4 2-5 2-7 2-7 2-8

Working with search results................................................................3-1


About search results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Initial search results for individual objects. . . . . . . . . . . . . . Initial results with the HDDS search facility enabled . . . . . Initial results with the HCP search facility enabled . . . . . . Returned text for text-based searches (HCP search facility Viewing returned objects. . . . . . . . . . . . . . . . . . . . . . . . . . Showing result details . . . . . . . . . . . . . . . . . . . . . . . . . . . . Understanding returned metadata . . . . . . . . . . . . . . . . . . . Paging through search results . . . . . . . . . . . . . . . . . . . . . . Sorting search results . . . . . . . . . . . . . . . . . . . . . . . . . . . . Showing or hiding the query . . . . . . . . . . . . . . . . . . . . . . . Filtering search results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Filtering by key terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . Filtering by document format. . . . . . . . . . . . . . . . . . . . . . . Filtering by retention setting (HCP search facility only) . . . . . Filtering by retention class (HCP search facility only) . . . . . . Filtering by hold status (HCP search facility only). . . . . . . . . Filtering by namespace . . . . . . . . . . . . . . . . . . . . . . . . . . . Holding, releasing, deleting, and purging returned objects . . . . . Exporting search results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..... ..... ..... ..... only) . ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 . 3-3 . 3-3 . 3-3 . 3-4 . 3-5 . 3-5 . 3-5 . 3-9 .3-10 .3-11 .3-11 .3-12 .3-13 .3-13 .3-14 .3-14 .3-15 .3-15 .3-18

Working with structured searches ......................................................4-1


About structured searches. . . . . . Properties for structured searches Specifying dates . . . . . . . . . . . . . Performing a structured search . . Examples of structured searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .... .... .... .... .... . . . . . .. .. .. .. .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2 4-3 4-7 4-8 4-9

iv

Contents Searching Namespaces

Working with advanced searches.......................................................5-1


About advanced searches . . . . . . Basic criteria . . . . . . . . . . . . Complex criteria . . . . . . . . . . Properties for advanced searches. Performing an advanced search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .... .... .... .... .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 5-2 5-3 5-4 5-9

Working with saved queries................................................................6-1


Saving a query . . . . . . . . . . . . . . . Viewing saved queries . . . . . . . . . Running a saved query . . . . . . . . . Editing a saved query . . . . . . . . . . Publishing a feed for a saved query Deleting a saved query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .... .... .... .... .... .... ... ... ... ... ... ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2 6-3 6-3 6-3 6-4 6-4

Specifying XML and custom metadata searches ...............................7-1


About XML and custom metadata searches . . . . . . . . . . . . . . . . . . Element hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Attribute inclusion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Value expressions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Element data types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Including data types in XML and custom metadata searches . Omitting the data type . . . . . . . . . . . . . . . . . . . . . . . . . . . Element hierarchy for values with numeric data types . . . . . Wildcards in XML and custom metadata searches . . . . . . . . . . Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Element or attribute existence . . . . . . . . . . . . . . . . . . . . . . . . Reserved words . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Special characters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2 . 7-4 . 7-5 . 7-5 . 7-6 . 7-6 . 7-7 . 7-7 . 7-8 . 7-8 . 7-9 .7-10 .7-10

8 A

Usage considerations .........................................................................8-1 HCP document format support .......................................................... A-1


Word processing formats . . . . . Presentation formats . . . . . . . . Spreadsheet formats. . . . . . . . . Graphics formats . . . . . . . . . . . Compressed formats. . . . . . . . . Database formats . . . . . . . . . . . Other formats . . . . . . . . . . . . . Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ........ ........ ........ ........ ........ ........ ........ ........ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. .. .. .. .. .. .. .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2 A-3 A-4 A-4 A-6 A-6 A-7 A-7

Contents Searching Namespaces

HCP MIME type support.................................................................... B-1

Glossary Index

vi

Contents Searching Namespaces

Preface
This book describes the search functionality available with Hitachi Content Platform (HCP). It explains how to search HCP namespaces for objects that satisfy criteria you specify. It also explains how to manage and manipulate both search specifications and search results. This book contains many examples, which you can use as models for your own searches. Note: Throughout this book, the word Unix is used to represent all UNIXlike operating systems (such as UNIX itself or Linux).

Intended audience
This book is intended for anyone who needs to search for objects in HCP namespaces. You can use the results of a search to manipulate groups of objects, to collect documents to satisfy search and discovery requirements, and to analyze namespace contents. This book assumes you are familiar with your client operating system and the browser you use for web applications.

Product version
This book applies to release 4.1 of HCP.

Preface Searching Namespaces

vii

Document organization

Document organization
This book contains eight chapters and two appendixes.
Chapter/Appendix
Chapter 1, Introduction to searching in HCP Chapter 2, Working with simple searches Chapter 3, Working with search results Chapter 4, Working with structured searches Chapter 5, Working with advanced searches Chapter 6, Working with saved queries Chapter 7, Specifying XML and custom metadata searches Chapter 8, Usage considerations Appendix A, HCP document format support Appendix B, HCP MIME type support

Description
Contains an overview of Hitachi Content Platform and the search facilities and explains how to use the Search Console Explains how to perform simple text-based searches and shows several examples of criteria for this type of search Describes the format of search results and explains how to view, modify, manipulate, and export them Explains how to perform structured metadata-based searches and shows several examples of the criteria for this type of search Explains how to use the search query language, describes the information on which you can base your queries, and shows several examples of criteria for this type of search Explains how to manage the definitions of the searches you create Presents the syntax for forming queries that search for XML documents or for objects based on their custom metadata Contains considerations that apply to the search index and search terms Lists the object document formats that HCP recognizes for search operations Lists the MIME types that HCP recognizes for search operations

Syntax notation
The table below describes the conventions used for the syntax of commands, expressions, URLs, and object names in this book.
Notation boldface Meaning
Type exactly as it appears in the syntax (if the context is case insensitive, you can vary the case of the letters you type) This book shows: xml You enter: xml

Example

viii

Preface Searching Namespaces

Related documents
(Continued)

Notation italics |

Meaning
Replace with a value of the indicated type Vertical bar Choose one of the elements on either side of the bar, but not both Square brackets Include none, one, or more of the elements between the brackets Parentheses Include exactly one of the elements between the parentheses Ellipsis Optionally, repeat the preceding parameter as many times as needed

Example
This book shows: element-name You enter: department This book shows: and|or You enter: and or: or This book shows: [xml|custommetadata] You enter: xml or: custommetadata or nothing This book shows:

[ ]

( )

(word|"phrase"|numeric-value)
You enter: Marketing or: "Lee Green" or: 180 This book shows: (xml-element-name:)... You enter: company:division:department:

...

Related documents
The following documents contain additional information about Hitachi Content Platform and searching namespaces when HCP is the active search system:

Administering HCP This book explains how to use an HCP system to


monitor and manage a digital object repository. It discusses the capabilities of the system, as well as its hardware and software components. The book presents both the concepts and instructions you need to configure the system, including creating the tenants that administer access to the repository. It also covers the processes that maintain the integrity and security of the repository contents.

Managing a Tenant and Its Namespaces This book contains complete


information for managing the HCP tenants and namespaces created in an HCP system. It provides instructions for setting up both administrative user accounts and data access accounts, configuring the HTTP protocol, which allows access to namespaces, managing search, and downloading installation files for HCP Data Migrator and the HCP client tools. It also explains how to work with retention classes and the privileged delete functionality.

Preface Searching Namespaces

ix

Related documents

Managing the Default Tenant and Namespace This book contains


complete information for managing the default tenant and namespace in an HCP system. It provides instructions for changing tenant and namespace settings, configuring the protocols that allow access to the namespace, managing search, and downloading installation files for HCP Data Migrator and the HCP client tools. It also explains how to work with retention classes and the privileged delete functionality.

Replicating Tenants and Namespaces This book covers all aspects of


tenant and namespace replication. Replication is the process of copying tenants and namespaces from one HCP system to another to ensure data availability and enable disaster recovery. The book describes how replication works, contains instructions for working with replication links, and explains how to monitor the replication process.

HCP Management API Reference This book contains the information


you need to use the HCP management API. This REST API enables you to create and manage tenants and namespaces programmatically. The book explains how to use the API to access an HCP system, specify resources, and update and retrieve resource properties.

Using a Namespace This book describes the properties of objects in


HCP namespaces. It provides instructions for accessing namespaces by using the HTTP protocol for the purpose of storing, retrieving, and deleting objects, as well as changing object metadata such as retention and shred settings. It also explains how to manage namespace content and view namespace information in a web browser.

Using the Default Namespace This book describes the file system
HCP uses to present the contents of the default namespace. It provides instructions for accessing the namespace by using the HCP-supported protocols for the purpose of storing, retrieving, and deleting objects, as well as changing object metadata such as retention and permissions.

Using HCP Data Migrator This book contains the information you
need to install and use the HCP Data Migrator (HCP-DM) utility distributed with HCP. This utility enables you to copy data between local file systems, HCP namespaces, and earlier HCAP archives. It also supports bulk delete operations. The book describes both the interactive window-based interface and the set of command-line tools included in HCP-DM.

Preface Searching Namespaces

Related documents

Using the HCP Client Tools This book contains the information you
need to install and use the legacy set of client command-line tools distributed with HCP. These tools enable you to find files and to copy and move files to and from namespaces. The book contains many examples that show command-line details and the overall workflow. Note: For most purposes, the HCP client tools have been superseded by HCP Data Migrator. However, they have some features, such as finding files, that are not available in HCP-DM.

Installing an HCP System This book provides the information you


need to install the software for a new HCP system. It explains what you need to know to successfully configure the system and contains step-by-step instructions for the installation procedure.

Third-Party Licenses and Copyrights This book contains copyright


and license information for third-party software distributed with or embedded in HCP.

HCP-DM Third-Party Licenses and Copyrights This book contains


copyright and license information for third-party software distributed with or embedded in HCP Data Migrator.

Installing an HCP 500 System Final On-site Setup This book


contains instructions for deploying an assembled and configured HCP 500 system at a customer site. It explains how to make the necessary physical connections and reconfigure the system for the customer computing environment.

Installing an HCP 300 System Final On-site Setup This book


contains instructions for deploying an assembled and configured HCP 300 system at a customer site. It explains how to make the necessary physical connections and reconfigure the system for the customer computing environment.

Query Language and Parameters Guide This book details the


construction of queries while HCP is the active search system.

Preface Searching Namespaces

xi

Getting help

Getting help
The Hitachi Data Systems customer support staff is available 24 hours a day, seven days a week. If you need technical support, please call:

United States: (800) 446-0744 Outside the United States: (858) 547-4526
Note: If you purchased HCP from a third party, please contact your authorized service provider.

Comments
Please send us your comments on this document: hcp.documentation.feedback@hds.com Include the document title, number, and revision, and refer to specific sections and paragraphs whenever possible. Thank you! (All comments become the property of Hitachi Data Systems.)

xii

Preface Searching Namespaces

1
Introduction to searching in HCP
Hitachi Content Platform (HCP) is a distributed storage system designed to support large amounts of data. It provides access to the stored data through a variety of industry-standard protocols, as well as through an integrated Search Console. The Search Console enables you to search for objects stored in HCP using either of two search facilities, the HDDS search facility or the HCP search facility. This chapter provides an introduction to HCP and searching namespaces, including how to use the Search Console, the types of queries you can construct, and what search results look like.

Introduction to searching in HCP Searching Namespaces

11

About Hitachi Content Platform

About Hitachi Content Platform


Hitachi Content Platform is the distributed, fixed-content, data storage system from Hitachi Data Systems. It provides a cost-effective, scalable, easy-to-use repository that can accommodate all types of data, from simple text files to medical image files to multigigabyte database images. A fixed-content storage system is one in which the data cannot be modified. HCP uses write-once, read-many (WORM) storage technology, and a variety of policies and services to ensure the integrity of the stored data.

Objects
HCP stores objects in a repository. Each object permanently associates data HCP receives (for example, a file, an image, or a database) with information about that data. This information is called metadata.

Namespaces and tenants


An HCP repository is partitioned into namespaces. A namespace is a logical grouping of objects such that the objects in one namespace are not visible in any other namespace. Namespaces provide a mechanism for separating the data stored for different applications. For example, one namespace could store accountsreceivable data while another stores accounts-payable data. Namespaces are owned and managed by administrative entities called tenants. A tenant typically corresponds to an organization, such as a company or a division or department within a company. A tenant can also correspond to an individual person. A tenant can own multiple namespaces. However, one special tenant, named default, owns only one namespace, named default. This namespace has some different properties from other namespaces. These differences are pointed out, where applicable, in this book. Note: This book refers to all tenants except the default tenant as HCP tenants. The namespaces owned by HCP tenants are called HCP namespaces.

12

Introduction to searching in HCP Searching Namespaces

About Hitachi Content Platform

Object metadata
HCP automatically generates metadata for each object. Some of this metadata is specific to HCP. Examples of this type of metadata are the retention setting, object creation date, and cryptographic hash value. Objects in the default namespace also have POSIX metadata. POSIX is a set of standards that defines an application programming interface (API) for software designed to run under heterogeneous operating systems. These standards include specific types of metadata, such as permissions and ownership. Note: Users and applications can override the defaults for some automatically generated metadata when they add an object to a namespace. They can also change certain metadata values for existing objects. Users can create their own custom metadata to associate additional descriptive information with an object. Custom metadata enables the creation of self-describing objects. Future users and applications can use this metadata to understand and repurpose object content. When added to a namespace, custom metadata becomes part of the target object. Custom metadata is typically but not necessarily formatted as XML. For more information on metadata, see Understanding returned metadata on page 3-5, Showing result details on page 3-5, Using a Namespace, and Using the Default Namespace.

Retention settings
Each object has a retention setting that specifies how long the object must remain in its namespace before it can be deleted; this duration is called the retention period. While an object cannot be deleted due to its retention setting, it is said to be under retention. The retention setting for an object can be:

A specific date and time This is the time before which the object
cannot be deleted.

One of these special values:

Deletion Prohibited The object can never be deleted.

Introduction to searching in HCP Searching Namespaces

13

About searching namespaces

Initial Unspecified The object does not yet have a specific retention setting and cannot be deleted until it has a setting that allows deletion. Expired The retention period for the object has ended, or the object was never under retention (Deletion Allowed). The object can be deleted at any time.

A retention class This is a named retention setting. It can be a


duration (such as seven years) or one of these special values: Deletion Allowed, Deletion Prohibited, or Initial Unspecified. Retention classes are namespace specific. That is, an object in one namespace cannot be assigned a retention class thats defined in a different namespace.

Retention mode
Retention mode is a property of a namespace that affects which operations are allowed on objects under retention. A namespace can be in either of two retention modes:

In compliance mode, objects that are under retention cannot be


deleted through any mechanism. Additionally, the duration of a retention class cannot be shortened, and retention classes cannot be deleted.

In enterprise mode, users and applications can delete objects under


retention if they have specific permission to do so. This is called privileged delete. Also in enterprise mode, the duration of a retention class can be shortened, and retention classes can be deleted.

About searching namespaces


HCP lets you search namespaces for objects that meet specified criteria. This capability supports search and discovery to satisfy government requirements and provides support for audits and litigation. You can use the results of a search to analyze namespace contents and manipulate groups of objects.

14

Introduction to searching in HCP Searching Namespaces

About searching namespaces

Search Console
HCP provides an interactive interface for searching namespaces. This interface, called the Search Console, is a tenant-specific web application that offers a structured environment for creating and executing queries. You can also use the Search Console to hold, release, delete, and purge groups of objects, including performing privileged deletes and purges. A query is a collection of criteria that each object in the search results must satisfy. The response to a query is metadata about the objects that meet the query criteria. You can use this metadata to retrieve objects of interest. Additionally, from the Search Console, you can export the metadata for use as input to other applications.

Search facilities
The Search Console works with either: The HDDS search facility This facility interacts with Hitachi Data Discovery Suite (HDDS), which performs searches and returns results to the HCP Search Console. HDDS is a separate product from HCP. This book covers aspects of HDDS that are specific to HCP. For more information on HDDS, see the HDDS documentation.

The HCP search facility This facility is integrated with HCP.


Only one of the search facilities can be enabled at any given time. This facility is enabled at the HCP system level. If neither facility is enabled, the HCP system does not support searching namespaces. The system associated with the enabled search facility is called the active search system.

Search index
To facilitate searches, the active search system (that is, HDDS or HCP) maintains an index of objects. The index is based on object data and metadata. While HDDS is the active search system, the search index resides in HDDS. While HCP is the active search system, the search index resides in HCP. The exact data and metadata indexed differs between the two systems. Indexing is enabled on a per-namespace basis. If a namespace is not indexed, you cannot search for objects in it.

Introduction to searching in HCP Searching Namespaces

15

About searching namespaces

HCP namespaces can be configured to store multiple versions of objects. The search index, however, includes only the most current version of an object. Each object has an index setting that indicates whether the object is eligible to be indexed. While the HCP search facility is enabled, HCP uses this setting to determine whether to include the object in the search index. As a result, the index for a namespace may not include all the objects in that namespace. If an object is not indexed, you cannot find it using a search. In addition to object data and metadata, HDDS and HCP index extracted metadata. Extracted metadata is metadata thats specific to a document format. Examples of this type of metadata are the author and title of a stored document. For a list of the document formats recognized by HCP for search operations, see Appendix A, HCP document format support. The active search system periodically checks each indexable namespace for new objects and objects with metadata that has changed since the last time the system checked. When it finds new or changed information, it updates the index. The time the search system takes to update the index depends on the amount of information to be indexed. Note: If an index update includes a large amount of information, new objects or objects with changed metadata may be unavailable to searches until the update is complete.

Searchable namespaces
For a namespace to be searchable:

With the HDDS search facility enabled, the namespace must be indexed
in HDDS.

With the HCP search facility enabled, the namespace must be indexed
in HCP.

The namespace must be configured to allow searches. This property of


a namespace is separate from whether or not the namespace is indexed.

16

Introduction to searching in HCP Searching Namespaces

About searching namespaces

Using the Search Console


To use the Search Console, you need a data access account (HCP namespaces) or a user account (default namespace). The account defines your username and password for logging in. To get a data access or user account for the Search Console, see your HCP tenant administrator. Additionally, to perform searches with the HDDS search facility enabled, you need an HDDS username and password. After logging into the Search Console, you need to set your HDDS username and password in the Console. To get an HDDS username and password, see your HCP tenant administrator. You log into the Search Console for a specific tenant. When you log into the Console for an HCP tenant, you can search only searchable namespaces owned by that tenant. Your data access account specifies which of those namespaces you have permission to search. If you dont have permission to search a given namespace, search results dont include any objects from that namespace. When you log into the Search Console for the default tenant, you may be able to search the searchable namespaces belonging to one or more HCP tenants. This depends on the configuration of those tenants.

Search Console URL


The URL for the Search Console for the default tenant differs from the URL for HCP tenants. In either case, access to the Console requires the use of SSL security with HTTP (HTTPS). Note: If you inadvertently use http instead of https in the URL, the browser prompts you to open or save a file. Cancel out of the prompt and try again, this time using https. Search Console URL for HCP tenants The URL for the Search Console for HCP tenants has this format:
https://tenant-url-name.hcp-name.domain-name:8888

For example, for access to the Search Console for the tenant named Finance in the HCP system named hcp.example.com, you would use this URL:
https://finance.hcp.example.com:8888

Introduction to searching in HCP Searching Namespaces

17

About searching namespaces

Typically, HCP relies on DNS for hostname resolution. If this is not the case, you need to provide a mapping of the tenant hostname to an IP address for the HCP system. You specify this mapping in the c:\windows\ system32\drivers\etc\hosts file (Windows), the /etc/hosts file (Unix), or the /private/ etc/hosts file (Mac OS X) on the client. Each line in a hosts file is a mapping of a hostname to an IP address. So, for example, if one of the IP addresses for the HCP system is 192.168.210.16, you would add this line to the hosts file on the client to enable access to the Search Console for the Finance tenant:
192.168.210.16 finance.hcp.example.com

For the IP addresses for the HCP system, see your HCP tenant administrator. Search Console URL for the default tenant The URL for the Search Console for the default tenant has this format:
https://search.hcp-name.domain-name:8888

For example, for access to the Search Console for the default tenant in the HCP system named hcp.example.com, you would use this URL:
https://search.hcp.example.com:8888

You can also use an IP address for the HCP system to specify the Search Console for the default tenant, as shown in this URL:
https://192.168.130.13:8888/

For the IP addresses for the HCP system, see your HCP tenant administrator.

Search Console sessions


Logging in A Search Console session begins when you log in with your username and ends when you log out. During a session, if you dont take any action for a certain amount of time, the Console automatically logs you out. The exact amount of idle time allowed is determined by the tenant configuration. To log into the Search Console: 1. Open a web browser window.

18

Introduction to searching in HCP Searching Namespaces

About searching namespaces

2. In the address field, enter the URL for the Search Console. The Search Console login page appears. 3. In the Username field, type the username for your HCP data access or user account. 4. In the Password field, type your case-sensitive password. Important: You should change your password as soon as possible the first time you log into the Search Console. 5. Click on the Log In button. The Search Console displays the Simple Search page (shown below) or, if youre required to change your password, the Account Management page. You also set your HDDS credentials on the Account Management page if the HDDS search facility is enabled.

For information on using the Simple Search page, see Chapter 2, Working with simple searches. For information on changing your password, see Changing your password on page 1-11. For information on setting up your HDDS credentials, see Setting HDDS credentials on page 1-12. Logging out To log out of the Search Console: 1. Click on Log out as in the top right corner of the page. The Console returns to the login page. To continue using the Search Console, you need to log in again. 2. Close the browser window to ensure that other users cannot go back into the Search Console using your login.

Introduction to searching in HCP Searching Namespaces

19

About searching namespaces

Search Console pages and navigation


Each page in the Search Console lets you perform a specific activity. To navigate among the pages, you can use the tabs at the top of the page. You can also use shortcut keys for navigation. Each link that has a shortcut key has one letter underlined. To use the shortcut key, follow the convention for the browser youre using. With the HCP search facility enabled, on each page, the Search Console indicates how current the search index is by showing the date and time before which eligible objects are guaranteed to be indexed. That is, any eligible object that was added to a namespace or that had a metadata change before the indicated date and time is guaranteed to be indexed. Objects that were added or had metadata changes after that date and time may or may not be indexed. Note: With the HCP search facility enabled, any exceptions to the indexing guarantee are reported in the HCP tenant log. Such objects will be indexed at a future time. If your search results do not include an expected object, check with your tenant administrator as to whether the object was indexed. Search Console pages do not automatically refresh themselves while they remain open. To see the latest results for the current search, use your browser refresh button. When you switch from one page to another, the Console does not retain the search on the original page (neither the query nor the search results). To see that search again, you can either recreate it or use the browser back button to return to it. Alternatively, you can save it before you switch pages. For information on saving a search, see Chapter 6, Working with saved queries.

Viewing search documentation


HCP documentation is available online in PDF format. To view a document from the Search Console, do either of these:

In the top right corner of the Search Console window, place the cursor
on the Documentation link. Then, in the dropdown menu, click on the document you want.

110

Introduction to searching in HCP Searching Namespaces

About searching namespaces

In the top right corner of the Search Console window, click on the
Documentation link. Then, on the Documentation page, click on the

document you want. Tip: While the HCP search facility is enabled, you can view Query Language and Parameters Guide from the Advanced Search page as well as from the Documentation page.

Changing your password


To change the password associated with the username you specified when you logged into the Search Console: 1. Click on the Account Management tab. 2. On the Account Management page, in the Change Password for User section:

In the Existing Password field, type your current password. In the New Password field, type your new password. Passwords can be up to 64 characters long, are case sensitive, and can contain any valid UTF-8 characters, including white space. To be valid, a password must include at least one character from two of these three groups: alphabetic, numeric, and other. The minimum length for passwords is site specific. Typically, its six or eight characters.

In the Confirm New Password field, type the new password again.

3. Click on the Submit button. Note: If you have access to HCP namespaces through HTTP with your data access account, changing your password in the Search Console changes it for HTTP access as well. If you have access to the HCP System and default Tenant Management Consoles with your user account, changing your password in the Search Console changes it for the those consoles as well.

Introduction to searching in HCP Searching Namespaces

111

About searching namespaces

Setting HDDS credentials


To set your HDDS credentials while the HDDS search facility is enabled: 1. In the HCP Search Console, click on the Account Management tab. 2. On the Account Management page, in the Set HDDS Credentials section, enter your case-sensitive HDDS username and password. 3. Click on the Test button to ensure that your username and password are valid. If the test fails, contact your HCP tenant administrator. HDDS may be unavailable, or your credentials may be invalid. 4. Click on the Save button. Note: If the test fails, you can still set your HDDS credentials by clicking on the Save button. However, your queries will not return any results until you provide valid HDDS credentials.

112

Introduction to searching in HCP Searching Namespaces

2
Working with simple searches
Simple searches are one of the three types of searches you can perform from the HCP Search Console. A simple search is based solely on word matching. You can specify multiple words or phrases to search for, and you can use wildcards to find more matches. Simple searches do not support the use of metadata as search criteria. This chapter provides instructions for performing simple searches. It explains the rules for specifying the search criteria and the options that determine whether objects are included in the search results. It also includes several examples. Once you have the results of a simple search, you can filter and export them. For information on these activities, see Chapter 3, Working with search results. You can also save the search criteria as a reusable query. For information on saving search criteria, see Chapter 6, Working with saved queries.

Working with simple searches Searching Namespaces

21

About simple searches

About simple searches


Simple searches work by comparing text you specify to the content and names of objects. They also compare the specified text to document titles and email subject lines where those are present in the extracted metadata. To perform a simple search, you use the Simple Search page of the Search Console. On this page, you can type one or more separate words or phrases (called search terms) and select one of three kinds of comparison:

Any of these words returns objects that contain at least one of the
specified search terms.

All these words returns objects that contain every one of the specified
search terms.

This exact phrase returns objects whose content or name includes a


single word or phrase exactly as specified, including any white space embedded in it. You can use wildcard characters to generate more matches for your search terms, as described in Wildcards on page 2-4. With any and all, you can also create Boolean criteria for more complex text-based searches, as described in Boolean criteria on page 2-5.

Note: Simple searches do not compare text to custom metadata.

Search terms
For any and all searches, you can specify any number of search terms separated by spaces. For exact searches, all the text you enter is taken as one term, including any embedded spaces. Additionally, for exact searches, any number of consecutive embedded spaces in the term equals any number of consecutive spaces in the matching text. Note: When comparing search terms to object content, the active search system treats each portion of a word split by a line break, with or without a hyphen, as a separate word.

22

Working with simple searches Searching Namespaces

About simple searches

For all kinds of searches for matching text, the active search system treats special characters, except the asterisk (*), question mark (?), and backslash (\), as spaces both in search terms and in text being searched. The active search system ignores leading and trailing spaces and special characters. Search terms are not case sensitive. Heres a sample term for a simple search:
executive officer

Heres what a search with this term returns:

For an any search, all objects that contain a least one occurrence of the
word executive or the word officer

For an all search, all objects that contain at least one occurrence of the
word executive and at least one occurrence of the word officer

For an exact search, all objects that contain at least one occurrence of
the phrase executive officer You can perform a simple search without specifying any search terms. Such a search returns all the indexed objects in each searchable namespace.

Directory paths and object names


A search term can be any part or all of a directory path after rest (HCP namespaces) or fcfs_data (default namespace) with or without an object name. For example, these search terms will all return the coporate/HR/ benefits_2 object:
corporate/HR HR HR/benefits_2 benefits_2

This search term, however, will not return the coporate/HR/benefits_2 object because it includes the rest directory:
rest/corporate/HR/benefits_2

Working with simple searches Searching Namespaces

23

About simple searches

Likewise, this search term will not return the coporate/HR/benefits_2 object because it includes the fcfs_data directory:
fcfs_data/corporate/HR/benefits_2

Multiple exact phrases


To search for any or all of two or more exact phrases, you use quoted terms in an any or all search; for example:
"executive officer" "wetland permit"

Heres what a search like this returns:

For an any search, all objects that contain a least one occurrence of the
phrase executive officer or the phrase wetland permit

For an all search, all objects that contain at least one occurrence of the
phrase executive officer and at least one occurrence of the phrase wetland permit Quotation marks are not meaningful in exact searches.

Wildcards
You can use the asterisk (*) as a wildcard character in a search term to represent any number of consecutive printable characters, including none. The wildcard character is valid only at the end of a term. That is, you can search for words that begin with the text you specify but not those that end with that text. For example, the search term on the left below is valid; the one on the right is not. Valid: princ* Invalid: *cipal

Here are some words that match the valid term above:
principal princ. (abbreviation) principles principalement (French) princess

24

Working with simple searches Searching Namespaces

About simple searches

You can use the wildcard character at the end of any or all of the terms in an any or all search. For an exact search, you can use a wildcard only if the term doesnt include any embedded spaces. For example, the term below on the left is valid for an exact search; the one on the right is not. Valid: principal* Invalid: principal exec*

You cannot use wildcards anywhere in quoted terms. Also, you cannot use a wildcard with a text string that has an underscore (_) anywhere in it.

Boolean criteria
You can create any and all searches that are more complex by using Boolean operations in the search criteria. To specify these operations, you use the plus and minus signs:

A plus sign (+) prefixed to a search term means returned objects must
contain that term.

A minus sign (-) prefixed to a search term means returned objects


cannot contain that term. You can use plus signs and minus signs on multiple terms, with or without wildcards, and in any order. When used with a quoted term, the symbol comes before the opening quotation mark. Note: Search terms containing Boolean operators are valid only in simple searches. Boolean criteria in any searches The table below describes how Boolean criteria work in any searches.
Symbol
Plus sign (+)

Description
Works like a logical AND. All returned objects must include the term with the plus sign.

Examples
Search terms: +chief +executive Search results: Objects that contain both chief AND executive This is equivalent to an all search using the same terms without plus signs. Search terms: +chief +executive officer Search results: Objects that contain both chief AND executive, regardless of whether they contain officer. Returned objects that contain officer will have a higher relevance.

Working with simple searches Searching Namespaces

25

About simple searches


(Continued)

Symbol

Description

Examples
Search terms: -officer Search results: Objects that do NOT contain officer Search terms: +chief +executive -officer Search results: Objects that contain both chief AND executive and do NOT contain officer Search terms: chief executive -officer Search results: Objects that contain chief or executive and do NOT contain officer

Minus sign (-) Works like a logical NOT. Returned objects cannot include the term with the minus sign.

Boolean criteria in all searches The table below describes how Boolean criteria work in all searches.
Symbol
Plus sign (+)

Description
Works like a logical AND. Returned objects must include the term with the plus sign.

Examples
Search terms: +chief +executive Search results: Objects that contain both chief AND executive This is equivalent to an all search with the same terms without plus signs. Search terms: +chief +executive officer Search results: Objects that contain chief AND executive AND officer Returned objects that contain officer have a higher relevance in the result set than those that do not.

Minus sign (-) Works like a logical NOT. Returned objects cannot include the term with the minus sign.

Search terms: -officer Search results: Objects that do NOT contain officer Search terms: +chief +executive -officer Search results: Objects that contain both chief AND executive and do NOT contain officer Search terms: chief executive -officer Search results: Objects that contain both chief AND executive and do NOT contain officer

26

Working with simple searches Searching Namespaces

Performing a simple search

Did you mean?


If you specify a search term thats similar to other words or phrases in the returned objects, the Search Console may suggest a different search by asking, Did you mean suggested-term? This question appears below your search specification. In it, suggested-term is a hyperlink you can click on to reexecute the search with that term. For example, if you enter criteri as the term for your search, the Console may display:

The term HCP suggests may differ from search term you specified in a variety of ways, including spelling and, for multiple words, phrasing.

Performing a simple search


To perform a simple search: 1. In the Search Console, click on the Simple Search tab. 2. In the dropdown list on the Simple Search page, select the kind of results you want: Any of these words, All of these words, or This exact phrase. For an explanation of these options, see About simple searches on page 2-2. 3. In the text entry field, type the terms you want to search for. For information on valid terms, see Search terms on page 2-2. 4. Click on the Search button. The Console displays the Search Results page. For more information on this page, see Chapter 3, Working with search results. Note: To search with the HDDS search facility enabled, you need valid HDDS credentials. If your credentials are invalid, the Search Console displays a user authentication error when you try to perform a search. For information on specifying HDDS credentials, see Setting HDDS credentials on page 1-12.

Working with simple searches Searching Namespaces

27

Examples of simple searches

Examples of simple searches


This section shows examples of simple searches. Example 1: Search for any of four terms To search for objects that contain any of the terms namespace, search, index, or results, select Any of these words as the comparison type and enter this in the text field:
namespace search index results

Example 2: Search for any of two wildcarded terms To search for objects that contain any terms beginning with name or index, select Any of these words as the comparison type and enter this in the text field:
name* index*

Each term is wildcarded in order to find objects in which it occurs either as a whole word or as the beginning of a word. Example 3: Search for all of three terms one wildcarded, two not To search for objects that contain both of the terms retention and expired and also terms beginning with shred, select All of these words as the comparison type and enter this in the text field:
retention shred* expired

The second term is wildcarded in order to find objects in which it occurs either as a whole word or as the beginning of a word, such as in shredding. Example 4: Search for an exact multiword term To search for objects that contain the exact term automatic deletion, select This exact phrase as the comparison type and enter this in the text field:
automatic deletion

Example 5: Search for all of two terms one included, one excluded To search for objects that contain deletion but not automatic deletion, select All of these words as the comparison type and enter this in the text field:
+deletion -''automatic deletion''

28

Working with simple searches Searching Namespaces

Examples of simple searches

Example 6: Search for an exact object name To search for the object named UsingANamespace.pdf, select This exact phrase as the comparison type and enter this in the text field:
UsingANamespace.pdf

Working with simple searches Searching Namespaces

29

Examples of simple searches

210

Working with simple searches Searching Namespaces

3
Working with search results
The Search Results page shows the list of objects returned for a query. For each object, this page shows specific metadata. Using options on this page, you can:

Show additional object metadata Open the object to see its content Change the sort order of the listed objects Use filters to narrow down the list Hold objects Release objects Delete objects Purge objects Export the search results
This chapter describes the Search Results page and explains how to perform each of the activities listed above.

Working with search results Searching Namespaces

31

About search results

About search results


The HCP Search Console uses the Search Results page to list the objects that satisfy the criteria you specify for a search. This page has four areas of information:

The criteria you specified for the query. Options for working with the search results. Filters for refining the search results. The list of returned objects. The objects are numbered for ease of
reference.

Query Work Options

Filters Returned objects

Note: Under certain circumstances, the results of a search may be incomplete. To indicate this, the Search Results page shows this message:
Partial results.

If this message persists, see your HCP tenant administrator.

32

Working with search results Searching Namespaces

About search results

Initial search results for individual objects


The information initially returned for each object differs depending on the enabled search facility. You can view additional information for any object in the search results. For more instructions on viewing additional information, see Showing result details on page 3-5. For more information on metadata displayed in both the initial and expanded views, see Understanding returned metadata on page 3-5.

Initial results with the HDDS search facility enabled


While the HDDS search facility is enabled, the Search Results page initially returns the following information for each object in the search results:

Title (if available) or object name URL Size Change time


Heres an example of the information initially returned while the HDDS search facility is enabled:

Note: HDDS can return a maximum of 10,000 objects in response to a single query. If your search returns 10,000 objects, you should run a query with more precise search criteria to ensure that you get all the objects you want.

Initial results with the HCP search facility enabled


While the HCP search facility is enabled, the Search Results page initially returns the following information for each object in the search results:

Object name Title (if available)

Working with search results Searching Namespaces

33

About search results

Text-snippets (for text-based searches); for more information, see


Returned text for text-based searches (HCP search facility only) on page 3-4

Retention setting Size


Heres an example of the information initially returned while the HCP search facility is enabled:

Returned text for text-based searches (HCP search facility only)


The Search Results page for a text-based search shows up to four snippets of text, separated by ellipses (...), for each returned object, when possible. In these snippets, any words that match the search terms you specified are highlighted. Each snippet includes at least one highlighted word, as shown in the following examples:

Here are the snippets from an object returned in response to an any


search for the term engineer:
...to contract with an environmental or engineering consultant for assistance. These are...the facility plan drawings and other engineering drawings of the facility, if that person...Designer Information (i.e., consultant or engineer, if applicable): Name of Designer: Address...

Here are the snippets from an object returned in response to an all


search for the terms principal and executive:
...doesn't think like an old-line energy executive, nor does this company act like an old-line...different company," says chairman and Chief Executive John Doe. "Underlying everything we...hedge their energy costs. This company is a principal in every trade, taking full responsibility...

Here are the snippets from an object returned in response to an exact


search for the term principal executive:
...signed by: 1. In the case of a corporation, by a principal executive officer of at least the level of vice-president...state, federal, or other government premise, by the principal executive officer, the ranking elected official, or another...

34

Working with search results Searching Namespaces

About search results

The text snippets for an object are taken only from the first megabyte of the object content. If the matching text does not occur in the first megabyte, no text snippets are shown for that object. Also, for objects with XML content, no text snippets are shown at all if the object is larger than one megabyte.

Viewing returned objects


You can view the content of any object in the search results by clicking on the object name or URL. With the HCP search facility enabled, you need to expand the search result details to view the object URL. For information, see Showing result details below. With the HDDS search facility enabled, you can also view the content of an object by clicking on the object title (if available). Depending on the browser youre using and the object type, you may be asked whether you want to open the object or save it to disk. When you view the object, it opens in the default application for that object type.

Showing result details


The Search Results page includes a Show details link for each returned object.

When you click on this link for an object, the Search Results page shows additional metadata. For information on this metadata, see Understanding returned metadata on page 3-5. To hide additional metadata after displaying it, click on the Hide details link.

Understanding returned metadata


The Search Results page shows metadata for each listed object. You can see some metadata initially. You can view the remaining metadata by showing result details.

Working with search results Searching Namespaces

35

About search results

The metadata shown varies depending on namespace type and object type. The Search Results page shows as much of this metadata as is available:

For all objects:



Size The object size, in bytes. Ingested The date and time the object was created (that is, when the data was added to the namespace). Retention The retention setting for the object, shown as one of these:

A specific date and time in the future. Deletion Prohibited. Initial Unspecified. A retention class. Expired This includes objects whose retention setting is either a specific date and time in the past or Deletion Allowed.

For more information on retention settings, see Retention settings on page 1-3. Note: HCP cannot represent dates later than February 18, 2038, at 22:14:07. Later dates appear as 2/18/2038 22:14:07 (overflow).

Hold Indication that the object is on hold. While an object is on hold, it cannot be deleted under any circumstances until it is explicitly released. With the HDDS search facility enabled, this setting is shown as either Held or Not Held. With the HCP search facility enabled, the name of an object thats on hold is followed by a lock icon ( ), and the retention setting is followed by | HOLD.

Object URL The absolute path to the object. The location is the HCP system, and the root directory is rest for HCP namespaces or fcfs_data for the default namespace. You can click on the URL to access the object.

36

Working with search results Searching Namespaces

About search results

Custom metadata URL (HCP search facility only) If the object has custom metadata, the URL for that custom metadata. You can click on this URL to open the custom metadata file. For HCP namespaces, the custom metadata URL consists of the object path followed by a type=custom-metadata query parameter, as in this example:
https://finance.europe.hcp.example.com/rest/operations/ HCP_HTTPAPI.ppt?type=custom-metadata

For the default namespace, the custom metadata URL identifies a file named custom-metadata.xml. For example, this URL specifies the custom metadata for an object named FileSys.html:
http://www.hcp.example.com/fcfs_metadata/status/FileSys.html/ custom-metadata.xml

Access time For the default namespace only, the POSIX atime for the object. Users and applications can change this metadata. Modify time For the default namespace only, the POSIX mtime for the object. Users and applications can change this metadata. Change time For the default namespace only, the POSIX ctime for the object. This is the last time the object metadata changed. Hash value The cryptographic hash value for the object. The label for this value is the name of the hash algorithm used to calculate it. DPL Total number of copies (including the original) of the object HCP must maintain to ensure that the object content is always protected and available. DPL stands for data protection level. Shredding The shred setting for the object, which indicates whether the object will be shredded when its deleted. Shredding is the process of deleting an object and overwriting the place where it was stored in such a way that none of its data can be reconstructed. This process also shreds the object metadata. MIME type The MIME type of the object content. For a list of the MIME types that HCP recognizes for search operations, see Appendix B, HCP MIME type support.

Working with search results Searching Namespaces

37

About search results

Format The format of the object content. For a list of the content formats that HCP recognizes for search operations, see Appendix A, HCP document format support. Language The language of the object content. User ID For the default namespace only, the user ID of the object owner. Group ID For the default namespace only, the ID of the owning group. Permissions For the default namespace only, the object permissions in POSIX format and as an octal value. For information on permission values, see POSIX permissions and Octal permission values below.

For many document formats, such as Word documents and PDFs:



Author The author of the object content Title The title of the object content Subject The subject of the object content Category The category of the object content

For email objects:



The text in the email subject field The message ID From The email address of the sender To The email addresses of the recipients Attachments ( ) The names of any files attached to the email

CC The exposed email addresses of additional recipients BCC The unexposed email addresses of additional recipients Send date The date and time the email was sent

38

Working with search results Searching Namespaces

About search results

POSIX permissions POSIX permissions are represented by three 3-character strings one for the object owner, one for the owning group, and one for other users who are not the owner and are not in the owning group. From left to write, the positions in each string represent read (r), write (w), and execute (x). Each position has either the character that identifies the applicable permission, meaning the permission is allowed, or a hyphen (-), meaning the permission is denied. For example, the string below means that the owner has all permissions for the object, the owning group has read and execute permissions, and others have only read permission:
-rwxr-xr--

The initial hyphen (-) indicates that the object is a data object. Octal permission values Permissions are also represented by octal values. Each object has an octal permission value thats the sum of the octal permission values specified for the object owner, the owning group, and all other users not in that group. The table below shows the value that corresponds to each permission.
Read
Owner Group Other 400 040 004 200 020 002

Write
100 010 001

Execute

For example, given the permissions below, the octal value is 755:
Owner has read, write, and execute permissions (700). Group has read and execute permissions (050). Other has read and execute permissions (005).

Paging through search results


The Search Results page shows both the number of objects in the search results and the number of pages required to list them, as well as how long the search took, in seconds. The number of pages depends on both the number of objects returned and the number of objects listed on each page. By default, the Search Console displays ten objects per page. You can use the results/page option on the Search Results page to select a different number. The choices are 10, 20, 50, 75, 100, and 200.

Working with search results Searching Namespaces

39

About search results

When you select a number of objects, the Search Results page immediately changes the number of objects it lists on each page. To page through the search results, you can do either of these:

To go backward or forward one page at a time, click on the back or next


arrow on either side of the page number information.

To go to a specific page:
1. In the go to page field, type the number of the page you want. 2. Click on the Go button.

Sorting search results


By default, the Search Results page lists the returned objects in order by their relevance to the search. Relevance is determined by factors such as the creation date of the object and the distance between occurrences of search terms in the object. You can change the order in which the objects are listed by selecting a different sort order. You can sort in ascending or descending order by:

Object size Ingest time Retention setting For email only, the time the email was sent
To change the sort order on the Search Results page, select the order you want in the Sort results field. When you select a sort option, the Search Results page immediately reorders the list of objects.

310

Working with search results Searching Namespaces

Filtering search results

Showing or hiding the query


When you perform a search, the criteria you used to form the query remain displayed on the Search Results page. You can hide or redisplay these criteria at any time:

To hide the query criteria, click on Hide Query in the upper right portion
of the page.

To redisplay the query after hiding it, click on Show Query.

Filtering search results


The Search Results page includes several types of filters that you can use to refine the results of a search:

Key terms Document format (that is, the format of the object content) Retention setting (HCP search facility only) Hold status (HCP search facility only) Retention class (HCP search facility only) Namespace
When you select a filter, the Search Results page immediately redisplays the search results with only the objects that match that filter.

Working with search results Searching Namespaces

311

Filtering search results

You can apply multiple filters to the same list of objects to remove the objects that arent of interest. For example, you could first refine the list by filtering for objects whose content is in PDF format, thereby excluding objects in all other formats. Then you could further refine the same list by filtering for objects currently on hold, thereby excluding objects that are not on hold. The resulting list would include only PDF objects that are on hold. Note: HCP forms a URL with the filters you apply to a search. If you specify a large number of filters, the URL may become too long for the browser to handle. If this happens, the browser displays an error message. The Search Results page shows the filters currently in effect as checkbox options in the Active result filters area below the search criteria.

When you apply filters, they remain in effect until you clear the search results either by moving to a different page or, for structured searches only, by clicking on the Clear button. If you change the query criteria without first clearing the current search results, any filters currently in effect are applied to the results of the new search. To remove a filter, deselect it in the Active result filters area. Again, the Search Results page immediately redisplays the search results, this time including the objects previously removed by that filter. Note: Filtering does not change the order of the objects in the search results.

Filtering by key terms


When HCP adds an object to the search index, it includes not only metadata but also key terms. Key terms are words or phrases that are significant in the object content. They are based on a variety of factors, such as frequency, case, and placement. When you perform a search, HCP lists the key terms from all the returned objects on the Search Results page. The terms are listed in descending order of relevance. You can select any number of key terms to use as filters for any given search.

312

Working with search results Searching Namespaces

Filtering search results

When you select a key term, the Search Results page redisplays the search results, including only objects that contain the selected term, and updates the list of key terms from those search results. The term itself appears in the Active result filters area.

Filtering by document format


While the HCP search facility is enabled, the Search Results page lists the document formats of the objects in the search results, along with the number of returned objects in each format. The document format of an object is the format of its data content before that data was added to the namespace. Examples of document formats are PDF, JPEG, and XML. The document formats on the Search Results page are listed in descending order of frequency. You can select only one document format to use as a filter in any given search. When you select a document format, the Search Results page redisplays the search results, including only objects whose content is in the selected format. The name of the format appears in the Active result filters area. Objects with an unrecognized format are listed as Unknown format. With the HDDS search facility enabled, objects whose content is larger than ten MB or whose compressed content expands to more than ten MB are listed this way. With the HCP search facility enabled, objects whose content is larger than 50 MB or whose compressed content expands to more than 50 MB are listed this way. Plain text objects that use EBCDIC encoding are also listed this way. For information on the document formats recognized by HDDS for search operations, see the applicable HDDS documentation. For a list of the formats recognized by HCP for search operations, see Appendix A, HCP document format support.

Filtering by retention setting (HCP search facility only)


While the HCP search facility is enabled, the Search Results page lists the possible object retention settings, along with the number of returned objects with each setting. The possible retention settings are Initial Unspecified, Deletion Prohibited, Expired, and Not Expired. Expired means the retention setting is either a specific date and time in the past or Deletion Allowed. Not Expired means the retention setting is a specific date and time in the future.

Working with search results Searching Namespaces

313

Filtering search results

When an object is assigned to a retention class, the HCP indexes it by that class but does not remove the preexisting retention setting from the index. Therefore, if an object is assigned to a retention class after it was stored, it is still included in the count for the retention setting that it initially had. Note: The Expired object count includes objects that have any of these retention values: an a specific date and time in the past, Deletion Allowed, or a retention class. All objects that are assigned to a retention class are included in this count, even if their retention periods have not expired. You can select only one retention setting to use as a filter in any given search. When you select a retention setting, the Search Results page redisplays the search results, including only objects with the selected setting. The setting itself appears in the Active result filters area. For more information on retention settings, see Retention settings on page 1-3.

Filtering by retention class (HCP search facility only)


While the HCP search facility is enabled, the Search Results page lists retention classes to which objects in the search results belong, along with the number of returned objects in each class. The list includes only the 100 classes that occur most frequently among the returned objects. Tip: You can use a structured search to find objects that belong to any class, not just the 100 most frequent classes. The retention classes on the Search Results page are listed in descending order of frequency. You can select only one retention class to use as a filter in any given search. When you select a retention class, the Search Results page redisplays the search results, including only objects in the selected class. The name of the retention class appears in the Active result filters area.

Filtering by hold status (HCP search facility only)


Holding an object means preventing it from being deleted, regardless of its retention setting, until its explicitly released. While an object is on hold, its retention setting cannot be changed.

314

Working with search results Searching Namespaces

Holding, releasing, deleting, and purging returned objects

While the HCP search facility is enabled, the Search Results page lists the possible hold statuses, Held or Not Held, along with the number of returned objects to which each setting applies. When you select Held or Not Held, the Search Results page redisplays the search results, including only objects with the selected hold status. The setting itself appears in the Active result filters area.

Filtering by namespace
The objects returned by a search can come from multiple namespaces. The Search Results page lists those namespaces in descending order of frequency. The name of the tenant that owns the namespace follows the namespace name, in parentheses. You can select only one namespace to use as a filter in any given search. When you select a namespace, the Search Results page redisplays the search results, including only objects in the selected namespace. The name of the namespace appears in the Active result filters area.

Holding, releasing, deleting, and purging returned objects


You can use the Search Console to hold, release, delete, or purge the objects returned by a search. This enables you to perform these operations on large numbers of objects at a time. Purge applies only to HCP namespaces, which can store multiple versions of objects. Purging an object deletes all versions of that object, including the current version. Deleting an object with multiple versions deletes only the current version. The Search Console also supports privileged delete and privileged purge operations. These operations work on objects that are under retention as well as on those that are not. When you perform a privileged operation, youre required to specify a reason for it. For any of the operations mentioned above to work on the objects in any given namespace:

The namespace must be configured to allow the operation. Your data access account or user account must allow you perform the
operation in the namespace.

Working with search results Searching Namespaces

315

Holding, releasing, deleting, and purging returned objects

A requested operation works only on the objects in namespaces that support it and for which you have permission to perform it. Other objects in the search results are not affected. You select the operation you want to perform from the Control operations field. In some cases, this field may show operations that are not allowed for some or all of the listed objects. If you try to perform an invalid operation on an object, the operation fails for that object. While the HDDS search facility is enabled, changes caused by performing these operations are reflected in the next update of the search index. While the HCP search facility is enabled, holding, releasing, deleting, or purging objects causes the HCP to update the search index. Even though these actions happen immediately, they may not be reflected in search results until the index update is complete. For more information on the HCP search index, see Search index on page 1-5. Important: Before performing a hold, release, delete, or purge operation, ensure that the search results include only the objects you want to affect. To narrow down the results of a search, you can use one or more filters, as well as specify additional search criteria. For information on filters, see Filtering search results on page 3-11. To hold, release, delete, or purge the objects in the current search results: 1. In the Control operations field, do one of these:

To place a hold on all the objects in the current search results, select Place results on hold. To release all held objects in the current search results, select Release hold on results. To delete all the objects in the current search results except those that are under retention or on hold, select Delete results. To delete all the objects in the current search results, including those that are under retention or on hold, select Privileged Delete
results.

To purge versions of all the objects in the current search results except those that are under retention, select Purge results.

316

Working with search results Searching Namespaces

Holding, releasing, deleting, and purging returned objects

To purge all versions of all the objects in the current search results, including those that are under retention, select Privileged Purge results.

HCP displays a confirming message. Important: HCP can delete or purge up to 2,000 objects in a single operation. If the search results include more than that, only the first 2,000 are deleted or purged. 2. If you are performing a privileged operation, type a reason for the delete or purge event in the text field in the message window. The reason text must be from one through 1,024 characters long and can contain any UTF-8 characters, including white space. 3. Click on the Continue button. HCP immediately begins the requested operation and opens a new window in which it shows its progress. As it proceeds, it shows whether the operation succeeded or failed for each object. The sample window below shows objects that have successfully been placed on hold.

Working with search results Searching Namespaces

317

Exporting search results

Exporting search results


You can export the results of a search as a comma-separated-values (CSV) or XML file for use with other applications. For example, you could use a CSV or XML file containing exported search results to generate a list of selected objects for a regulatory body. Or, you could use an export file as input to an application that analyzes namespace content. An export file contains a specific subset of the metadata for each object in the search results. It does not include the object content. However, the metadata includes the URL for the object, so you can retrieve the object content in a separate operation. The full set of exported metadata is, in order:

Object URL Object size, in bytes Content format Cryptographic hash algorithm used to calculate the cryptographic hash
value of the object

Cryptographic hash value of the object


Note: If HCP has not yet calculated the cryptographic hash value for an object, the value in the export file is an empty string. The same metadata is exported for each object, regardless of whether its details are showing on the Search Results page. To export the current search results, select the format you want in the Export results field.

XML format CSV format


Depending on the browser youre using and the object type youve selected, you may be asked whether you want to open or save the object.

318

Working with search results Searching Namespaces

Exporting search results

Export files are named results.selected-type, where selected-type is either CSV or XML. To prevent a subsequent export operation from overwriting an exported file, you should give the file a new name that identifies its contents (for example, held_objects_03082011.xml).

Working with search results Searching Namespaces

319

Exporting search results

320

Working with search results Searching Namespaces

4
Working with structured searches
Structured searches are one of the three types of searches you can perform from the HCP Search Console. A structured search can be based on metadata values as well as on text matching. You can specify multiple criteria for structured searches and indicate whether objects need to satisfy any or all of them. This chapter provides instructions for performing structured searches. It explains the rules for specifying the search criteria and the options that determine whether objects are included in the search results. It also includes several examples. Once you have the results of a structured search, you can filter and export them. For information on these activities, see Chapter 3, Working with search results. You can also save the search criteria as a reusable query. For information on saving search criteria, see Chapter 6, Working with saved queries.

Working with structured searches Searching Namespaces

41

About structured searches

About structured searches


Structured searches work by comparing criteria you specify to various properties of objects. These criteria can be based on object metadata as well as on object content. You can also specify whether objects need to meet any or all of the specified criteria. To perform a structured search, you use the Structured Search page of the Search Console.

Within a single structured search, you can specify multiple criteria. With the exception of key/value, each criterion has the form:

property operator value


On the Structured Search page, you select both properties and operators from dropdown lists. Depending on the property, you either select or type the value.

Property

Operator

Value

Examples of criteria for structured searches are:


Object Type Object Size Namespace Title Shredding Ingest Time is less than is contains is not before Email 2049 finance (europe) budget proposal Shred on Delete 2009-11-30T14:55:55-0500

For a complete list of the properties, operators, and values for structured searches, see Properties for structured searches below.

42

Working with structured searches Searching Namespaces

Properties for structured searches

After creating a structured search, you can change it to an advanced search by clicking on the Show as advanced link. The Advanced Search page opens and shows the specified search criteria translated into the search query language. For more information on advanced searches, see Chapter 5, Working with advanced searches. Note: After displaying a structured search as an advanced search, you cannot change it back to a structured search. You can, however, use your browser back button to return to the page showing the structured search.

Properties for structured searches


The table below presents the properties you can use for structured searches. For each property, the table shows the available operators and the values you can select or type. For descriptions of the properties in this table, see Understanding returned metadata on page 3-5.
Property
General
Object Type is is not contains does not contain Any Document Email Image Multimedia XML Unknown One or more search terms1 This property is the equivalent of a simple search.

Operators

Values

Object Content

contains all of contains any of contains exactly does not contain all of does not contain any of does not contain exactly contains does not contain contains does not contain is is not

Object Path

Part or all of an object path or name, not including rest (HCP namespaces) or fcfs_data (default namespace) File name extension of a recognized document format2 Name of a namespace searchable by the user Each namespace name is followed by the name of the owning tenant in parentheses.

Object Format Namespace

Working with structured searches Searching Namespaces

43

Properties for structured searches


(Continued)

Property
Security
UID3

Operators

Values

is is not greater than less than is is not greater than less than is is not greater than less than

Integer greater than or equal to 0 (zero) This is the user ID of the object owner. Integer greater than or equal to 0 (zero) This is the ID of the owning group for the object. Octal number greater than or equal to 0 (zero)4

GID3

Permissions3

Dates5
Retention6 is value is not value is date is not date before date after date is is not contains does not contain is is not before after is is not before after is is not before after is is not before after Initial Unspecified (HCP search facility only) Deletion Prohibited Expired Not Expired Specified date5 Selected date Part or all of a retention class name

Retention Class

Ingest Time

Specified date5 Selected date $now Specified date5 Selected date $now Specified date5 Selected date $now Specified date5 Selected date $now

Change Time3

Modification Time3

Access Time3

44

Working with structured searches Searching Namespaces

Properties for structured searches


(Continued)

Property
Miscellaneous
Size

Operators

Values

is is not greater than less than is is not is is not is is not is is not contains does not contain

Object size, in bytes This is the exact size of the object content. For example, to search for a two KB object, you need to specify 2048, not 2000. Held Shred on Delete Cryptographic hash value for an object Selected language Part or all of the name of the character set or encoding used in the document or unknown Use unknown for documents for which HCP cannot determine the character set.

Retention Hold Shredding Hash Language Character Set

Email
Email To Email From Email CC Email BCC Email Subject Email Sent Date contains does not contain contains does not contain contains does not contain contains does not contain contains does not contain is is not before after contains does not contain contains does not contain Part or all of an email recipient name Part or all of an email sender name Part or all of an email cc name Part or all of an email bcc name Part or all of an email subject Specified date5 Selected date $now Part or all of an email message ID Part or all of the name of a file attached to an email.

Email Message ID Email Attachment Name

Working with structured searches Searching Namespaces

45

Properties for structured searches


(Continued)

Property
Documents
Author Subject Title Category

Operators

Values

contains does not contain contains does not contain contains does not contain contains does not contain

Part or all of a document authors name Part or all of a document subject Part or all of a document title Part or all of a document category name

XML Search (HCP search facility only)


XML Document Custom metadata is is not is is not XML expression7 Custom metadata expression7 This property returns the objects associated with the matching custom metadata.

Key/Value (HCP search facility only)


Key == Value Extracted metadata property8 Part or all of an extracted metadata property value This search criterion returns objects that have the specified metadata property value. Key != Value Extracted metadata property8 Part or all of an extracted metadata property value This search criterion returns objects that do not have the specified metadata property value.
1 Search terms in structured searches cannot include Boolean operators. For more information on specifying search terms, see Search terms on page 2-2. 2 For information on document formats, see Appendix A, HCP document format support. 3 This property applies only to objects in the default namespace. 4 For information on octal values for permissions, see Octal permission values on page 3-9. 5 For valid date formats, see Specifying dates below. For information on the different metadata time properties, see Understanding returned metadata on page 3-5. 6 For information on retention settings, see Retention settings on page 1-3. 7 For information on specifying the expression for an XML or custom metadata search, see Chapter 7, Specifying XML and custom metadata searches. 8 For information on extracted metadata, see Search index on page 1-5.

46

Working with structured searches Searching Namespaces

Specifying dates

Specifying dates
When a metadata property requires a date value, you can either select it from a calendar, select the current date and time, or type a value. The first two options appear when you select the metadata property. Selecting a calendar date To select a date from a calendar: 1. Click on the calendar icon ( ) next to the value field.

2. In the calendar window that appears, either click on the date you want or click on Today. To display the next or previous month, click on the forward or back pointer, respectively, in the area showing the month and year. The selected date appears in the value field in this format:

YYYY-MM-DD
In this format, YYYY is the four-digit year, MM is the two-digit month, and DD is the two-digit day. For example, if you select the day shown on the calendar above, the value field shows:
2009-11-05

Typing a date You can use these three formats to specify the date and, optionally, time for a metadata property:
YYYY-MM-DD YYYY-MM-DDThh:mm:ss YYYY-MM-DDThh:mm:ssZ

In these formats:

YYYY is the four-digit year, MM is the two-digit month, and DD is the twodigit day.

hh is hours on a 24-hour clock, mm is minutes, and ss is seconds. Z means the time is in UTC.
The first two of these formats are assumed to be in the same time zone as the HCP time setting. The third one is in UTC.

Working with structured searches Searching Namespaces

47

Performing a structured search

Heres an example of a date and time in the second format shown above:
2012-11-04T14:00:00

Selecting the current date and time To select the current date and time, click on the icon ( the calendar icon. The value field shows:
$now

) to the right of

Each time you run a saved query that uses the $now variable, the variable is replaced by the current date and time.

Performing a structured search


To perform a structured search: 1. In the Search Console, click on the Structured Search tab. 2. In the Find objects that match field on the Structured Search page:

Select any to return objects that satisfy at least one of the criteria you specify. Select all to return objects that satisfy every one of the criteria you specify.

3. Specify the first search criterion:


a. From the property dropdown list, select the property for the

criterion.
b. From the operator dropdown list, select the operator for the

criterion.
c. In the value field, either select or type the value for the criterion.

4. For each additional criterion, if any:


a. Click on the add button (

) to the right of the criterion after which you want to insert the new criterion.

b. Repeat the actions in step 3 above.

5. Click on the Search button.

48

Working with structured searches Searching Namespaces

Examples of structured searches

To remove a criterion from a structured search, click on the remove button ( ) to the right of that criterion. To see the new results, click on the Search button.

Examples of structured searches


This section shows examples of criteria for structured searches. Example 1: Search for expired objects of a particular type This example shows an all search for image objects that have expired. On the Structured Search page, the search criteria look like this:

Example 2: Search for any of three of the same property This example shows an any search for objects authored by Smith, Wong, or Caplan. On the Structured Search page, the search criteria look like this:

Example 3: Search for all four, including a time span This example shows an all search for email that was sent to Juarez during January 2009 and is set to expire before January 1, 2015. On the Structured Search page, the search criteria look like this:

Working with structured searches Searching Namespaces

49

Examples of structured searches

Example 4: Search for objects in a namespace This example shows an all search for objects in the finance namespace owned by the europe tenant that belong to the SEC-17a retention class and are on hold. On the Structured Search page, the search criteria look like this:

Example 5: Search for objects with a specified custom metadata value (HCP search facility only) This example shows an all search for objects that have the custom metadata property location with a value of Massachusetts. On the Structured Search page, the search criterion looks like this:

For information on using the Custom Metadata property, see Chapter 7, Specifying XML and custom metadata searches. Example 6: Search for an extracted metadata property (HCP search facility only) This example shows an all search for objects that have an extracted metadata property named Security set to classified and contain either environmental impact or impact statement. On the Structured Search page, the search criteria look like this:

410

Working with structured searches Searching Namespaces

Examples of structured searches

Example 7: Search for XML documents (HCP search facility only) This example shows an all search for classified XML objects that are not set to be shredded when theyre deleted. On the Structured Search page, the search criteria look like this:

For information on using the XML Search property, see Chapter 7, Specifying XML and custom metadata searches.

Working with structured searches Searching Namespaces

411

Examples of structured searches

412

Working with structured searches Searching Namespaces

5
Working with advanced searches
Advanced searches are one of the three types of searches you can perform from the HCP Search Console. For an advanced search, you can specify queries equivalent to those for simple and structured searches. However, in an advanced query, you can combine criteria with various operators to refine your searches in more ways. This chapter provides instructions for performing advanced searches. It provides an introduction to specifying advanced queries and contains many examples. For more information on queries for advanced searches:

For HDDS, see the applicable HDDS documentation. For HCP, see Query Language and Parameters Guide. You can
download this document from the Search Console. Once you have the results of an advanced search, you can filter and export them. For information on these activities, see Chapter 3, Working with search results. You can also save the search criteria as a reusable query. For information on saving search criteria, see Chapter 6, Working with saved queries.

Working with advanced searches Searching Namespaces

51

About advanced searches

About advanced searches


Advanced searches provide more flexibility than both simple and structured searches. They enable you not only to search for text and metadata with multiple search criteria but also to nest and combine those criteria by using parentheses and Boolean and other operators. To perform an advanced search, you use the Advanced Search page of the Search Console. On this page, you write your own query (called an advanced query) using the search query language. Tip: You can generate advanced search queries from the Structured Search page. To do this, construct the query on the Structured Search page and then click on the Show as advanced search link. The Advanced Search page opens and shows the specified search criteria translated into the search query language.

Basic criteria
The basic formats for criteria for advanced searches are:
property:value property:(int32|float|double|datetime|string|phrase|starts-with| ends-with)(value[(, option)...]) property:(and|or|not|andnot|any|range|rank|near|onear)(value [(, value)...][(, option)...]) xml-search

You can also precede any of these formats with the not operator followed by the rest of the criterion in parentheses. The xml-search format is available only while the HCP search facility is enabled. The rules for this format are the same as for the XML Search property for structured searches. For more information on these rules, see Chapter 7, Specifying XML and custom metadata searches. Here are some examples of basic criteria:

This criterion returns objects for which the user ID of the owner is 54:
uid:54

52

Working with advanced searches Searching Namespaces

About advanced searches

This criterion returns all email objects:


contenttype:string("message/rfc822")

This criterion returns all objects whose size is greater than or equal to
25,000 bytes:
size:range(25000, max, from="GE")

This criterion returns objects that are not email from


rsilver@example.com or pcornflower@example.com:
not(emailfrom:or(rsilver@example.com, pcornflower@example.com))

This criterion returns XML objects that include the value 112296 within
the indicated element hierarchy (HCP search facility only):
xml:department:project:budget:"112296"

Most of the properties for advanced searches correspond to those for structured searches, but the property names differ, and in some cases, the values are expressed differently. Additionally, some of the properties for advanced searches differ between HCP and HDDS. For a list of advanced search properties that correspond to those for structured searches, see Properties for advanced searches on page 5-4. For a list of the properties for structured searches, see Properties for structured searches on page 4-3.

Complex criteria
For complex criteria, you can use these formats:
criterion [(and|or|andnot|any|rank|near|onear) criterion]... criterion [(and|or|andnot|any|rank|near|onear)(criterion)]...

In these formats, criterion is any basic or complex criterion. As with basic criteria, you can precede these formats with the not operator followed by the rest of the complex criterion in parentheses.

Working with advanced searches Searching Namespaces

53

Properties for advanced searches

Here are some examples of complex criteria:

These criteria return only email objects that are not from
rsilver@example.com or pcornflower@example.com:
contenttype:string("message/rfc822") and not(emailfrom:(rsilver@example.com or pcornflower@example.com))

These criteria return objects that expire before February 1, 2015, and
for which either the owner ID is less than or equal to 56 or the owner ID is greater than 56 and the group ID is not less than 30:
expirationtime:range(1970-01-01T00:00:10, 2015-02-01T00:00:00) and or(uid:range(min, 56, to="LE"), andnot(uid:range(56, max), gid:range(min,30, to="LT")))

Properties for advanced searches


The table below presents the properties you can use in advanced queries. For each property, the table shows the case-sensitive property name, the data type, a description, an example, and the equivalent structured search property, if any. Values for properties with a data type of string follow the rules for search terms in simple searches. For information on these rules, see Search terms on page 2-2. For information on specifying datetime values, see Typing a date on page 4-7.

Note: You cannot use $now for datetime values in advanced queries.

Advanced search property


contenttype body

Data type
string composite MIME type.1

Description

Example
contenttype:string ("application/zip") content:"medic*"

Structured search equivalent


Object Type Object Content Object Path Content Format Namespace

Data content, name, title, and email subject of the object. This property is the equivalent of a simple search.2 All or part of a path and object name, starting after fcfs_data or rest. Format of the object content. This is typically the name of the application used to create the content.3 UUID of the namespace that contains the object.4

filename format

string string

filename:"french/news_f/ pres03_f/mou_16feb03_f.doc" format:"Adobe Photoshop"

namespace uuid

UUID

(HCP search facility only)

namespaceuuid:string("f424bfd8762d-406b-9201-ccf2ecf585e0")"

54

Working with advanced searches Searching Namespaces

Properties for advanced searches


(Continued) Advanced search property
uid gid permissions

Data type
int32 int32 int32

Description
User ID of the object owner. ID of the owning group for the object. Decimal equivalent of the octal value of the POSIX permissions for the object.5 Retention setting. Valid values: Objects that can never be deleted: 1970-01-01T00:00:03Z Objects that can be deleted at any time: range(current-datetime, max) Objects that expire at a specific date and time: range(datetime, datetime, from="GE", to="LE") In this criterion, the two variables specify the same date and time. Objects that expire on a specific date: range(dateT00:00:00Z, date-plus-oneT00:00:00Z, from="GE", to="LT") In this criterion, the second date is one day later than the first. Objects that do not yet have a retention setting: 1970-01-01T00:00:02Z Objects that have expired: range(1970-01-01T00:00:10Z, current-datetime) Note: Any of these values can return objects for which the retention setting is a retention class. This happens for objects that had a retention setting before being assigned to a class. uid:72 gid:24

Example

Structured search equivalent


UID GID Permissions

permissions:420 This is equal to octal 644. expirationtime:range (2015-01-13T00:00:00Z, 2015-01-14T00:00:00Z, from="GE", to="LT")

expiration time

datetime

Retention

retention class archivedtime

string datetime

Retention class specified as the retention setting for the object. Date and time the object was created in the namespace (that is, when the data was added to the namespace).

retentionclass:"HlthReg-107a"

Retention Class

archivedtime:range:(min, Ingest 2009-11-01T05:00:00Z, to="LT") Time

Working with advanced searches Searching Namespaces

55

Properties for advanced searches


(Continued) Advanced search property
changetime

Data type
datetime

Description
POSIX change time (ctime). This is the last time the object metadata changed. POSIX modify time (mtime). Users and applications can change this metadata. POSIX access time (atime). Users and applications can change this metadata. Object size, in bytes. This is the exact size of the object content. For example, to search for a two KB object, you need to specify 2048, not 2000. Indication of whether the object is currently on hold. Valid values are: 1 The object is on hold. 0 The object is not on hold.

Example
changetime:range (2009-11-01T04:00:00Z, max, from="GE") modtime:not(range (2009-11-04T04:00:00Z, 2009-11-10T04:00:00Z, from="GE", to="LE")) accesstime:range (2009-11-12T05:00:00Z, max, from="GE") size:range(min, 5000, to="LT")

Structured search equivalent


Change Time

modtime

datetime

Modification Time

accesstime

datetime

Access Time

size

float

Size

hold

int32

hold:"1"

Retention Hold

shred

int32

Indication of whether the object will be shredded when its deleted. Valid values are: 1 The object will be shredded. 0 The object will not be shredded.

shred:"0"

Shredding

hash language

string string

Cryptographic hash value of the object. Language in which the document is written. Valid values are the twocharacter ISO 639-1 language codes. The character set or encoding used in the document. Use unknown for documents for which HCP cannot determine the character set. Email address of one email recipient. Email address of email sender. Email address of one copied email recipient. Email address of one blind-copied email recipient. Text in the email subject line.

hash:"9B6D8A603659B447DA4..." language:en

Hash Language

charset

string

charset:string("utf-8")

Character Set

emailto emailfrom emailcc emailbcc emailsubject

string string string string string

emailto:rsilver@example.com emailfrom:"lgreen@example.com" emailcc:rsilver@example.com emailbcc:or ("pcornflower@example.com") emailsubject:"Weekly Sales Department Meeting, Minutes -- 6/2/09"

Email To Email From Email CC Email BCC Email Subject

56

Working with advanced searches Searching Namespaces

Properties for advanced searches


(Continued) Advanced search property
emaildate

Data type
datetime

Description
Date the email was sent.

Example
emaildate:range (2009-11-14T04:00:00Z, 2009-11-15T04:00:00Z, from="GE", to="LT") emailmessageid:"73495 B59-04A3-59FC-573D8380897A78BB@example. com-mbox.eml" attachment:"Sales Quotas 2009"

Structured search equivalent


Email Sent Date

email messageid

string

ID of the email in the namespace.

Email Message ID

attachment

string

Name of a file attached to the email.

Email Attachment Name Author

author

string

Value of the Author metadata property that occurs in many Microsoft Office and Adobe PDF documents. Value of the Subject metadata property that occurs in many Microsoft Office and Adobe PDF documents. Value of Title metadata property that occurs in many Microsoft Office and Adobe PDF documents. Value of Category metadata property that occurs in many Microsoft Office and Adobe PDF documents. XML search in this format:6 xml:[(xml-element-name:)... [@xml-attribute-name:]] value-expression

author:"lgreen"

subject

string

subject:quotas

Subject

title

string

title:"Monthly Sales Statistics -February 2009" category:"Sales Minutes"

Title

category

string

Category

(HCP search facility only)

xml

scope

xml:division:department:"Sales"

XML Search

(HCP search facility only)

custom metadata

scope

Custom metadata search in this format:6 custommetadata: [(xml-element-name:)... [@xml-attribute-name:]] value-expression This property returns the objects associated with the specified custom metadata.

custommetadata:duration:"180"

Custom Metadata

(HCP search facility only)

xml:vs:v:and (@k:"key", "value")

scope

Metadata key and a value for it. A key is a metadata property that is extracted from the content of an object and is not listed in this table.7

xml:vs:v:and(@k:"location", "San Francisco")

Key == Value Key != Value

Working with advanced searches Searching Namespaces

57

Properties for advanced searches


(Continued) Advanced search property
dataindexed

Data type
int32

Description
Indicator of whether the object content and/or custom metadata is indexed and whether the object name is valid UTF-8 encoding. Valid values are the sum of any combination of these: 0 1 2 Object name is percent encoded, if necessary. Content is indexed. Content is not indexed because HCP could not determine the MIME type. HDDS: Content is not indexed because it exceeds ten MB. HCP: Content is not indexed because it exceeds 50 MB.

Example
dataindexed:range(100,190, from="GE",to="LT")

Structured search equivalent


N/A

10 Custom metadata is indexed. 20 Custom metadata is not indexed due to invalid XML. 30 HDDS: Content is not indexed because it exceeds ten MB. HCP: Content is not indexed because it exceeds 50 MB. 90 Object has no custom metadata. 100 Object name is valid UTF-8 encoding. 1 For information on the MIME types that HDDS recognizes for search operations, see the applicable HDDS documentation. For a list of the MIME types that HCP recognizes for search operations, see Appendix B, HCP MIME type support. 2 For information on simple searches, see Chapter 2, Working with simple searches. 3 For information on the document formats that HDDS recognizes for search operations, see the applicable HDDS documentation. For a list of the document formats that HCP recognizes for search operations, see Appendix A, HCP document format support. 4 To get the namespace UUID, select the namespace in a structured search. Then click on the Show as advanced search link. 5 For information on octal values for permissions, see Octal permission values on page 3-9. 6 For information on XML searches, see Chapter 7, Specifying XML and custom metadata searches. 7 For information on extracted metadata, see Object metadata on page 1-3.

58

Working with advanced searches Searching Namespaces

Performing an advanced search

Performing an advanced search


To perform an advanced search: 1. In the Search Console, click on the Advanced Search tab. 2. In the entry field on the Advanced Search page, type the query for your search. 3. Click on the Search button. While youre working on a query specification, you can click on the Reset button to return to the most recently submitted query.

Working with advanced searches Searching Namespaces

59

Performing an advanced search

510

Working with advanced searches Searching Namespaces

6
Working with saved queries
The HCP Search Console lets you save the queries you create so you can run them again at any time. Saving a query saves the criteria only, not the search results. Each time you run a saved query, you get a new set of returned objects. You can publish a feed for a saved query. The feed makes regularly updated query results available to users of the web site where its published. This chapter provides instructions for saving queries and then viewing, running, editing, deleting, and publishing feeds for them.

Working with saved queries Searching Namespaces

61

Saving a query

Saving a query
You can save all three types of queries: simple, structured, and advanced. Saved queries are specific to the active search system. That is, queries you save while one facility is enabled are not available while the other facility is enabled. To save a query: 1. On the Simple Search, Structured Search, or Advanced Search page, specify the query criteria. 2. Click on the Search button. 3. Optionally, select filters to apply to the query results. The filters you apply to the search results are saved along with the query. For information on filters, see Filtering search results on page 3-11. 4. In the save as field, type a name for the query. Note: If a query doesnt return any objects, a field labeled Save this query as appears below the search criteria on the Search Results page. 5. Click on the Save button.

62

Working with saved queries Searching Namespaces

Viewing saved queries

Viewing saved queries


When you save a query, the Search Console lists it on the Saved Queries page. From this page, you can run, edit, or delete the query, as well as publish it as a feed.

Running a saved query


To run a saved query: 1. Click on the Saved Queries tab. 2. On the Saved Queries page, click on the run control ( you want to run. ) for the query

The Search Results page for a saved query shows the name of the query. Note: When you run a saved query, the save as field on the Search Results page shows the name of that query. If you edit the query and then click on the Save button without changing the query name, the modified query overwrites the previous version.

Editing a saved query


To edit a saved query: 1. Click on the Saved Queries tab. 2. On the Saved Queries page, click on the edit control ( you want to edit. ) for the query

Working with saved queries Searching Namespaces

63

Publishing a feed for a saved query

The Console displays the page on which the query was created. For example, if you created a query for a simple search, the Console displays the Simple Search page. 3. Change the query criteria as needed. Note: When you deselect a filter, the query runs automatically. For information on filters, see Filtering search results on page 3-11. 4. To display the save as field, click on the Search button. 5. In the save as field, type a name for the edited query. 6. Click on the Save button.

Publishing a feed for a saved query


You can publish both RSS and Atom feeds for saved queries. To publish a feed: 1. Click on the Saved Queries tab. 2. On the Saved Queries page, click on the RSS ( ) or Atom ( for the query for which you want to create the feed. ) control

The window displays a browser-specific page for publishing a feed. 3. Use the browser-specific procedure to publish the feed for the query.

Deleting a saved query


To delete a saved query: 1. Click on the Saved Queries tab. 2. On the Saved Queries page, click on the delete control ( query you want to delete. ) for the

3. In response to the confirming message, click on the OK button.

64

Working with saved queries Searching Namespaces

7
Specifying XML and custom metadata searches
An XML or custom metadata search uses a query based on XML elements and attributes and their values. An XML search returns XML files. A custom metadata search returns objects associated with custom metadata that matches the search criteria. XML and custom metadata searches are available only while the HCP search facility is enabled. Both structured and advanced searches support XML and custom metadata queries. This chapter provides an overview of XML and custom metadata searches. For more details on these searches, see Query Language and Parameters Guide. For information on structured searches, see Chapter 4, Working with structured searches. For information on advanced searches, see Chapter 5, Working with advanced searches.

Specifying XML and custom metadata searches Searching Namespaces

71

About XML and custom metadata searches

About XML and custom metadata searches


When searching for XML documents or objects with specific custom metadata, you use XML elements, attributes, and element or attribute values as criteria. The format for this is:
[xml|custommetadata]:[(xml-element-name:)...[@xml-attribute-name:]] value-expression

Note: You need to use the xml or custommetadata keyword in advanced searches. For a structured search, you can optionally include xml, but do not include custommetadata. The following sections provide a general explanation of how to specify an XML or custom metadata search. Because custom metadata can contain any valid XML, the rules are the same for both types of searches. For more detailed information on this subject, see Query Language and Parameters Guide. Sample XML file for examples The XML examples in the following sections are based on an XML file containing:
<?xml version="1.0" ?> <company> <company-name>Example Corporation</company-name> <division employee-count="22"> <division-name>Sales and Marketing</division-name> <division-head>Lee Green</division-head> <department employee-count="13"> <department-name>Sales</department-name> <department-head>Robin Silver</department-head> <project> <id>03.14.0063</id> <codename>bluefish</codename> <headcount>12</headcount> <budget esp-internal-type="float">35237.82</budget> </project> <project> <id>03.14.0074</id> <codename>salmon</codename> <headcount>3</headcount> <budget esp-internal-type="float">4500.00</budget> </project> </department>

72

Specifying XML and custom metadata searches Searching Namespaces

About XML and custom metadata searches <department employee-count="8"> <department-name>Marketing</department-name> <department-head>Paris Cornflower</department-head> <project> <id>03.15.0132</id> <codename>hake</codename> <headcount>7</headcount> <budget esp-internal-type="float">5835.76</budget> </project> <project> <id>03.14.0074</id> <codename>lamprey</codename> <headcount>8</headcount> <budget esp-internal-type="float">112296.17</budget> </project> </department> </division> </company>

Note: An XML search can return non-XML objects. This happens when the name of an extracted metadata property matches the name of an element in the specified XML search path and the value of that property matches the search value. For information on extracted metadata properties, see Object metadata on page 1-3. Sample custom metadata for examples The custom metadata examples in the following sections are based on the custom metadata associated with an object named wind.jpg. This metadata is:
<?xml version="1.0" ?> <weather> <location>Massachusetts</location> <date>20091130</date> <duration_secs>180</duration_secs> <temp_F> <temp_high>31</temp_high> <temp_low>31</temp_low> </temp_F> <velocity_mph> <velocity_high>22</velocity_high> <velocity_low>17</velocity_low> </velocity_mph> </weather>

Specifying XML and custom metadata searches Searching Namespaces

73

About XML and custom metadata searches

Element hierarchy
The first part of an XML or custom metadata search [xml|custommetadata]: [(xml-element-name:)... in the format on page 7-2 represents a hierarchy of XML elements, starting with xml or custommetadata, when needed. It limits the scope of the search to the hierarchy at or below the last named element. For example, the hierarchy below limits the XML search to attributes of the
department element, values assigned to the department element, and any elements, attributes, or values below department in the element hierarchy: xml:company:division:department

Each element name in an XML or custom metadata search is followed by a colon (:). XML element names are case sensitive. You can omit elements from a hierarchy, as long as you end with the lowest-level element to which you want to restrict the scope of the search. These are all valid element hierarchies that limit an XML search for hake to the department level or below:
xml:company:division:department:"hake" xml:company:department:"hake" xml:division:department:"hake" xml:department:"hake"

The searches above return the sample XML file. These searches for hake also return that file:
xml:company:division:"hake" xml:company:"hake" xml:division:"hake" xml:"hake"

In contrast, the following search does not return the sample XML file:
xml:company:division:department:"Lee"

Lee occurs at the division level, which is above the department level. This custom metadata search returns the wind.jpg object:
custommetadata:velocity_high:"22"

74

Specifying XML and custom metadata searches Searching Namespaces

Value expressions

This custom metadata search also returns the wind.jpg object because 22 is within the scope of the velocity_mph element:
custommetadata:velocity_mph:"22"

Attribute inclusion
You can limit the scope of a search to an XML attribute by appending the attribute name [@xml-attribute-name:]] in the format on page 7-2 to the end of the sequence of XML element names. You need to use the at sign (@) with the attribute name to distinguish it from the elements. Like element names, attribute names are case sensitive, and each is followed by a colon (:). Attribute values are always text, never numeric. The following XML searches are for departments with 13 employees. They all return the sample XML file:
xml:company:division:department:@employee-count:"13" xml:company:division:@employee-count:"13" xml:company:@employee-count:"13" xml:@employee-count:"13"

This search for an employee count of 13 doesnt return the sample XML file:
xml:company:division:department:department-head:@employee-count:"13"

The employee-count attribute is not within the scope of the departmenthead element.

Value expressions
The simplest value expression value-expression in the format on page 7-2 is a word, phrase, or number. Phrases and numbers without explicit numeric data types must be enclosed in double quotation marks. For clarity, consider enclosing single words in quotation marks as well. These XML searches have value expressions that return the sample XML file:
xml:company:division:department:"Marketing" xml:company:division:"Lee Green" xml:department:project:"12"

Specifying XML and custom metadata searches Searching Namespaces

75

Value expressions

The value expression in this search doesnt return the sample XML file:
xml:project:headcount:12

This is because the number 12 is not enclosed in quotation marks. Similarly, this custom metadata search doesnt return the wind.jpg object because the number 180 is not enclosed in quotation marks:
custommetadata:duration_secs:180

Element data types


An XML element can have an esp-internal-type attribute that specifies its data type. Valid values for this attribute are int32, float, double, datetime, and string. For example, the budget element in the sample XML file has a data type of float. Note: The esp-internal-type attribute is specific to HCP. Its based on the configurable type attribute in the search query language. For information on the type attribute, see Query Language and Parameters Guide.

Including data types in XML and custom metadata searches


You can include the data type of a text or numeric value in a value expression. The format for this is:
esp-internal-type(word|"phrase"|numeric-value)

The data type you specify for an element in an XML or custom metadata search must be the correct one for that element. For example, this XML search returns the sample XML file because the budget element in that file has an esp-internal-type attribute that specifies float:
xml:project:budget:float(35237.82)

This XML search doesnt return the sample XML file because it specifies the wrong data type for the budget element:
xml:project:budget:int32(35237.82)

76

Specifying XML and custom metadata searches Searching Namespaces

Value expressions

Omitting the data type


If an element has an esp-internal-type attribute, the value you specify for that element in an XML or custom metadata search is assumed to be of that type, even if you dont explicitly include the type in the search. Values of elements without an esp-internal-type attribute are assumed to be plain text (internal type string). In this XML search, 35237.82 is assumed to be a floating point number because the budget element has an esp-internal-type attribute that specifies float. As a result, the search returns the sample XML file:
xml:project:budget:35237.82

In this XML search, the quotation marks indicate that 35237.82 is a string:
xml:project:budget:"35237.82"

As a result, the above search doesnt return the sample XML file.

Element hierarchy for values with numeric data types


If the target of an XML or custom metadata search is a value with an explicit numeric data type, the element hierarchy must include the level at which that value occurs. This applies whether or not you specify the internal type in the XML or custom metadata search. These are all valid XML searches for a project with a budget of 5835.76:
xml:company:division:department:project:budget:float(5835.76) xml:company:division:department:project:budget:5835.76 xml:department:budget:5835.76 xml:project:budget:float(5835.76)

These are not valid XML searches because they dont include the budget element:
xml:company:division:project:5835.76 xml:company:division:float(5835.76) xml:division:5835.76

Specifying XML and custom metadata searches Searching Namespaces

77

Value expressions

Wildcards in XML and custom metadata searches


You can use the asterisk (*) as a wildcard character in XML or custom metadata searches the way you can in simple searches, as in these examples:
xml:company:division:"Lee Gre*" xml:company:division:"L* Green" xml:company:division:"L* G*" custommetadata:location:"Ma*"

For more information on using wildcards, see Wildcards on page 2-4.

Operators
You can use and and or in value expressions to copy the behavior of all and any simple searches, respectively. The format for a value expression that uses the and or or operator is:
and|or(search-term, search-term[(, search-term)...])

With the and operator, the search terms must occur within the same instance of the final element. For example, this XML search returns the sample XML file:
xml:company:department:and(bluefish,salmon)

This one does not:


xml:company:department:and(bluefish,hake)

Bluefish and hake are projects in different departments. With the or operator, the search terms can occur anywhere within the element hierarchy. For example, these searches both return the sample XML file:
xml:company:department:or(Sales,salmon) xml:company:department:or(Marketing,salmon)

This custom metadata search returns the wind.jpg object:


custommetadata:or(Massachusetts,Maine)

78

Specifying XML and custom metadata searches Searching Namespaces

Value expressions

HCP supports additional search operators, such as andnot and range (valid only for numeric data types). For example, this XML search returns the sample XML file:
xml:company:division:andnot(hake, tuna)

This one does not:


xml:company:division:andnot(hake, salmon)

For more information on these and other operators, see Query Language and Parameters Guide.

Element or attribute existence


You can use an XML search to return XML objects that include a particular element or attribute. Similarly, you can use a custom metadata search to return objects whose custom metadata includes a particular element or attribute. The format for a value expression that does this is:
scope(xml-element-name|@xml-attribute-name)

If you specify an element, it must be lower in the hierarchy than the final element in the search path. If you specify an attribute, it can be associated with the final element in the search path or any element below that. These XML searches return the sample XML file:
xml:company:department:scope(project) xml:company:department:scope(codename) xml:company:scope(@employee-count)

This search does not:


xml:company:department:scope(division)

This is because division is above department in the element hierarchy. This custom metadata search returns the wind.jpg object:
custommetadata:velocity_mph:scope(velocity_high)

This search does not:


custommetadata:velocity_mph:scope(temp_high)

Specifying XML and custom metadata searches Searching Namespaces

79

Value expressions

This is because temp_high is not below velocity_mph in the element hierarchy.

Reserved words
HCP has some reserved words that require double quotation marks when used as element or attribute names or values in XML and custom metadata searches. These are: and, or, any, not, andnot, string, int, float, double, datetime, max, min, range, starts-with, ends-with, exact, ge, gt, le, lt, phrase, filter, rank, near, and onear. Heres an example in which the word max is the name of an element in the XML search:
xml:company:department:budget:"max":10000

Heres an example in which the word float is used as a search term:


xml:company:and("float", loan)

Special characters
In an XML or custom metadata search, you need to escape special characters that occur in value expressions. The escape character is the backslash (\). For example, you need to escape the quotation marks in the following:
"Our product is the best"

The XML search looks like this:


xml:company:press:"\"Our product is the best\""

You need to use double quotation marks around any element or attribute name that includes special characters. For example, the underscore (_) is a special character. In the example below, each element name containing an underscore is quoted:
xml:company:press:"press_releases":"benchmarks_06-13-06":"\"Our product is the best\""

Tip: If youre not sure whether an element or attribute name requires quotation marks, use them anyway. HCP ignores unnecessary quotation marks.

710

Specifying XML and custom metadata searches Searching Namespaces

8
Usage considerations
This chapter contains considerations that apply to the searching namespaces and the active search system.

Usage considerations Searching Namespaces

81

Limitations on content indexing HDDS indexes the metadata but not the content of objects larger than ten MB or compressed objects that expand to more than ten MB. HCP indexes the metadata but not the content of:

Objects larger than 50 MB or compressed objects that expand to more


than 50 MB

Japanese plain-text objects for which the system cannot determine the
encoding

Plain text objects that use EBCDIC encoding XML objects that are one MB or larger
Indexing of plain-text objects with UTF-16 encoding HCP sometimes incorrectly indexes the extracted metadata, MIME type, character set, and/or content of plain-text objects with UTF-16 encoding and no byte-order mark. As a result, searches for such objects may not return all the expected objects. Indexing of PostScript Level II objects created by dvips HCP generally recognizes the PostScript Level II document format for indexing purposes. However, it does not recognize documents in this format that are created by dvips. Searching with languages without word boundaries With the HCP search facility enabled, when constructing a search term in languages written without word boundaries, such as Japanese, Chinese, and Korean, if the character sequence used is not meaningful, the search may not return all the expected objects. Searching for in email subjects With the HCP search facility enabled, a simple search for text that includes the character does not find email objects for which this character occurs in the subject line. Such a search, however, does return email objects for which this character occurs elsewhere in the object content. To work around this issue, use a structured search with the Object Content or Email Subject property to search for email objects with the character in the subject line.

82

Usage considerations Searching Namespaces

Searching for emails based on sent date A structured search for the Email Sent Date property or an advanced search for the emaildate property does not return email objects that have a sent date later than the year 2038. Differences in information returned by the search systems Results returned by HDDS can differ from those returned by HCP for the same query. For more information on search results with the HDDS search facility enabled, see the applicable HDDS documentation.

Usage considerations Searching Namespaces

83

84

Usage considerations Searching Namespaces

A
HCP document format support
The Search Results page of the Search Console lists the formats of the returned objects. If the active search system doesnt recognize the format of one or more returned objects, the list of formats also includes Unknown format. You can use the listed formats to filter the search results. You can also use document formats as criteria in advanced queries. For more information on this, see Properties for advanced searches on page 5-4. This appendix lists the document formats recognized by HCP when it is the active search system. For information on the document formats recognized by HDDS, see the applicable HDDS documentation. The formats listed in this appendix are broken out into these categories:

Word processing formats Presentation formats Spreadsheet formats Graphics formats Compressed formats Database formats Other formats
This appendix ends with a list of exceptions that apply to the recognized formats.

HCP document format support Searching Namespaces

A1

Word processing formats

Word processing formats


Generic text
ANSI Text 7 and 8 bit ASCII Text 7 and 8 bit HTML Versions through 3.0 (some limitations) IBM FFT All versions IBM Revisable Form Text All versions MHTML No specific version Microsoft Rich Text Format (RTF) All versions Unicode Text All versions UTF-8 All versions WML Version 5.2 XML No specific version

DOS word processors


DEC WPS Plus (DX) Versions through 3.1 DEC WPS Plus (WPL) Versions through 4.1 DisplayWrite 2 and 3 (TXT) All versions DisplayWrite 4 and 5 Versions through 2.0 Enable 3.0, 4.0, and 4.5 First Choice Versions through 3.0 Framework Version 3.0 IBM Writing Assistant Version 1.01 Lotus Manuscript Version 2.0 MASS11 Versions through 8.0 Microsoft Word Versions through 6.0 Microsoft Works Versions through 2.0 MultiMate Versions through 4.0 Navy DIF All versions Nota Bene Version 3.0 Novell/Corel WordPerfect Versions through 6.1 Office Writer Versions 4.0 through 6.0 PC-File Letter Versions through 5.0 PC-File+ Letter Versions through 3.0 PFS:Write Versions A, B, and C Professional Write Versions through 2.1 Q&A Version 2.0 Samna Word Versions through Samna Word IV+ SmartWare II Version 1.02 Signature Version 1.0 Sprint Versions through 1.0 Total Word Version 1.2 Volkswriter 3 and 4 Versions through 1.0 Wang PC (IWP) Versions through 2.6 WordMARC Versions through Composer Plus WordStar Versions through 7.0 WordStar 2000 Versions through 3.0 XyWrite Versions through III Plus

A2

HCP document format support Searching Namespaces

Presentation formats

Windows word processors


Adobe FrameMaker (MIF) Versions 3.0, 4.0, 5.0, 5.5, and 6.0; Japanese versions 3.0, 4.0, 5.0, and 6.0 (text only) Hangul Version 97, 2002, and 2005 JustSystem Ichitaro Versions 4.x through 6.x, 8.x through 13.x, and 2004 JustWrite Versions through 3.0 Legacy Versions through 1.1 Lotus AMI/AMI Professional Versions through 3.1 Lotus Word Pro Versions SmartSuite 96, 97, Millennium, and Millennium 9.6 Microsoft Windows Write Versions through 3.0 Microsoft Word Versions through 2007 Microsoft WordPad All versions Microsoft Works Versions through 4.0 Novell Perfect Works Version 2.0 Novell/Corel WordPerfect Versions through 12.0 OpenOffice Writer (Windows and Unix) Versions 1.1 and 2.0 Professional Write Plus Version 1.0 Q&A Write Version 3.0 StarOffice Writer Versions 5.2 (text only) and 6.x through 8.x WordStar Version 1.0

OS/2 word processor


Lotus Word Pro Versions SmartSuite 97, Millennium, and Millennium 9.6 (text only)

Macintosh word processors


MacWrite II Version 1.1 Microsoft Word Versions 4.0, 98 through 2004 Microsoft Works (Mac) Versions through 2.0 Novell/Corel WordPerfect Versions 1.02 through 3.0

Presentation formats
Harvard Graphics for DOS Versions 2.x and 3.x Harvard Graphics (Windows) Windows versions Freelance (Windows) Versions through Millennium 9.6 Freelance for OS/2 Versions through 2.0 Microsoft PowerPoint (Windows) Versions 3.0 through 2007 Microsoft PowerPoint (Mac) Versions 4.0 through v.X Novell/Corel Presentations Versions through 12.0 OpenOffice Impress (Windows and Unix) Versions 1.1 and 2.0 (text only) StarOffice Impress 5.2 (text only) and 6.x through 8.x

HCP document format support Searching Namespaces

A3

Spreadsheet formats

Spreadsheet formats
Enable Versions 3.0, 4.0, and 4.5 First Choice Versions through 3.0 Framework Version 3.0 Lotus 1-2-3 (DOS and Windows) Versions through 5.0 Lotus 1-2-3 (OS/2) Versions through 2.0 Lotus 1-2-3 Charts (DOS and Windows) Versions through 5.0 Lotus 1-2-3 for SmartSuite Versions 97 through Millennium 9.6 Lotus Symphony Versions 1.0, 1.1, and 2.0 MacWorks Version 2.0 Microsoft Excel Charts Versions 2.x through 7.0 Microsoft Excel (Mac) Versions 3.0 through 4.0, 98, 2001,2002, 2004, and v.X Microsoft Excel (Windows) Versions 2.2 through 2007 Microsoft Multiplan Version 4.0 Microsoft Works (Windows) Versions through 4.0 Microsoft Works (DOS) Versions through 2.0 Microsoft Works (Mac) Versions through 2.0 Mosaic Twin Version 2.5 Novell Perfect Works Version 2.0 OpenOffice Calc Versions 1.1 and 2.0 (text only) PFS: Professional Plan Version 1.0 Quattro Pro (DOS) Versions through 5.0 Quattro Pro (Windows) Versions through 12.0 and X3 SmartWare II Version 1.02 StarOffice Calc Versions 5.2, 6.x, 7.x, and 8.0 (text only) SuperCalc 5 Version 4.0 VP Planner 3D Version 1.0

Graphics formats
Adobe Photoshop (PSD) Version 4.0 Adobe Illustrator Versions 7.0 and 9.0 Adobe FrameMaker graphics (FMV) Vector/raster through 5.0 Adobe PDF Versions 1.2 through 1.7 Adobe Reader Versions 2.1 through 8.0, Japanese Ami Draw (SDW) Ami Draw AutoCAD Drawing Versions 2004, 2005, and 2006 (text only) AutoCAD Interchange and Native Drawing formats (DXF and DWG) AutoCAD Drawing versions 2.5 through 2.6, 9.0 through 14.0, 2000i, and 2002 AutoShade Rendering (RND) Version 2.0 Binary Group 3 Fax All versions Bitmap (BMP, RLE, ICO, CUR, OS/2 DIB, and WARP) All versions CALS Raster (GP4) Type I and Type II Corel Clipart format (CMX) Versions 5 through 6

A4

HCP document format support Searching Namespaces

Graphics formats

Corel Draw (CDR) Versions 3.x through 8.x Corel Draw (CDR with TIFF header) Versions 2.x through 9.x Computer Graphics Metafile (CGM) ANSI and CALS NIST version 3.0 Encapsulated PostScript (EPS) TIFF header only GEM Paint (IMG) All versions Graphics Environment Mgr (GEM) Bitmap and vector Graphics Interchange Format (GIF) All versions Hewlett Packard Graphics Language (HPGL) Version 2 IBM Graphics Data Format (GDF) Version 1.0 IBM Picture Interchange Format (PIF) Version 1.0 Initial Graphics Exchange Spec (IGES) Version 5.1 JBIG2 Graphic embeddings in PDF files JFIF (JPEG not in TIFF format) All versions JPEG (including EXIF) All versions JPEG 2000 No specific version (Windows only) Kodak Flash Pix (FPX) All versions Kodak Photo CD (PCD) Version 1.0 Lotus PIC All versions Lotus Snapshot All versions Macintosh PICT1 and PICT2 Bitmap only MacPaint (PNTG) All versions Micrografx Draw (DRW) Versions through 4.0 Micrografx Designer (DRW) Versions through 3.1 Micrografx Designer (DSF) Windows 95 and version 6.0 Microsoft XML Paper Specification (XPS) Version 1.0

Novell PerfectWorks (Draw) Version 2.0 OpenOffice Draw Versions 1.1 and 2.0 OS/2 PM Metafile (MET) Version 3.0 Paint Shop Pro 6 (PSP) (Windows) Versions 5.0 through 6.0 PC Paintbrush (PCX and DCX) All versions Portable Bitmap (PBM) All versions Portable Graymap (PGM) No specific version Portable Network Graphics (PNG) Version 1.0 Portable Pixmap (PPM) No specific version Postscript (PS) Level II Progressive JPEG No specific version StarOffice Draw 5.2 (text only) through 8.x Sun Raster (SRS) No specific version TIFF Versions through 6 TIFF CCITT Group 3 and 4 Versions through 6 Truevision TGA (TARGA) Version 2 Visio (preview) Version 4 Visio Versions 5, 2000, 2002, and 2003 WBMP No specific version Windows Enhanced Metafile (EMF) No specific version Windows Metafile (WMF) No specific version WordPerfect Graphics (WPG and WPG2) Versions through 2.0, 7, and 10 X-Windows Bitmap (XBM) x10 compatible X-Windows Dump (XWD) x10 compatible X-Windows Pixmap (XPM) x10 compatible

HCP document format support Searching Namespaces

A5

Compressed formats

Compressed formats
GZIP All versions LZA Self Extracting Compress All versions LZH Compress All versions Microsoft Binder Versions 7.0 through 97 (conversion of Binder is supported only on Windows) RAR Version 2.9 (not available on Solaris x86) Self-extracting RAR Version 2.9 (not available on Solaris x86) UUEncode All versions UNIX Compress All versions UNIX TAR All versions ZIP PKWARE versions through 2.04g

Database formats
Access Versions through 2.0 dBASE Versions through 5.0 DataEase Version 4.x dBXL Version 1.3 Enable Versions 3.0, 4.0, and 4.5 First Choice Versions through 3.0 FoxBase Version 2.1 Framework Version 3.0 Microsoft Works (Windows) Versions through 4.0 Microsoft Works (DOS) Versions through 2.0 Microsoft Works (Mac) Versions through 2.0 Paradox (DOS) Versions through 4.0 Paradox (Windows) Versions through 1.0 Personal R:BASE Version 1.0 R:BASE 5000 Versions through 3.1 R:BASE System V Version 1.0 Reflex Version 2.0 Q&A Versions through 2.0 SmartWare II Version 1.02

A6

HCP document format support Searching Namespaces

Other formats

Other formats
EML All versions Executable (EXE, DLL) No specific version Adobe Flash Versions 6.x, 7.x Adobe Flash Lite (text only) Microsoft Office Open XML Version 2007 Microsoft Outlook Folder (PST) and Microsoft Outlook Offline Folder Versions 97, 98, 2000, 2002, 2003, and 2007 Microsoft Outlook Form Template Versions 97, 98, 2000, 2002, 2003, and 2007 Microsoft Project Versions 98 through 2002 (text only) MIME Text Mail All versions MP3 (ID3 information) TNEF No specific version vCard and vCalendar Version 2.1 Windows Executable No specific version Yahoo! Instant Messenger Versions 6.x, 7.x, and 8.x

Exceptions
HCP does not recognize:

Password-protected Microsoft Office 2007 documents Embedded fonts in Microsoft Office 2007 documents Footnotes, endnotes, and reference numbers in Microsoft Word 2007
documents

Protected Microsoft Excel 2007 workbooks (these are partially


supported for earlier versions of Excel)

Email saved as Outlook Message Format - Unicode (*.msg)

HCP document format support Searching Namespaces

A7

Exceptions

A8

HCP document format support Searching Namespaces

B
HCP MIME type support
The MIME type is part of the details displayed for objects on the Search Results page. If HCP doesnt recognize the MIME type of an object, it assumes the type is application/octet-stream. You can use MIME types as values for the contenttype property in advanced queries. For information on advanced queries, see Chapter 5, Working with advanced searches This appendix lists the MIME types recognized by HCP when it is the active search system. For information on the MIME types recognized by HDDS, see the applicable HDDS documentation.

HCP MIME type support Searching Namespaces

B1

Application types
application/macwriteii application/ms-tnef application/msaccess application/msword application/octet-stream application/pdf application/postscript application/vnd.framemaker application/vnd.lotus-1-2-3 application/vnd.lotus-wordpro application/vnd.ms-excel application/vnd.ms-outlook application/vnd.ms-powerpoint application/vnd.ms-project application/vnd.ms-works application/vnd.sun.xml.writer application/vnd.visio application/vnd.wap.wbxml application/wordperfect5.1 application/x-compress application/x-director application/x-gzip application/x-shockwave-flash application/x-stuffit application/x-tar application/zip

Message types
message/rfc822 multipart/related

Text types
text/css text/html text/javascript text/plain text/rtf text/vnd.wap.wml text/x-hdml text/x-vcalendar text/x-vcard text/xml

Video types
video/avi video/quicktime

Audio types
audio/midi audio/mpeg audio/wav

Image types
image/bmp image/g3fax image/gif image/jpeg image/png image/tiff image/vnd.wap.wbmp image/x-icon image/x-portable-bitmap image/x-portable-graymap image/x-portable-pixmap image/x-xbitmap image/x-xpixmap image/x-xwindowdump

B2

HCP MIME type support Searching Namespaces

Glossary
A
active search system
The system that works with the enabled search facility to perform searches and return results to the HCP Search Console. The active search system also maintains an index of objects in searchable namespaces, which it uses for fast retrieval of search results.

advanced search
A type of search available in the HCP Search Console. An advanced search lets you specify multiple text- and or metadata-based criteria and also combine those criteria by using parentheses and boolean and other operators.

atime
POSIX metadata that initially specifies the date and time at which an object was ingested into a namespace. Users and applications can change this metadata, thereby causing it to no longer reflect the actual storage time. Additionally, HCP can be configured to synchronize atime values with retention settings. Note: This is not the normal POSIX usage for atime.

C
compliance mode
The retention mode in which objects under retention cannot be deleted through any mechanism. This is the more restrictive retention mode.

Glossary1
Searching Namespaces

cryptographic hash value

cryptographic hash value


A system-generated metadata value calculated by a cryptographic hash algorithm from object data. This value is used to verify that the content of an object has not changed.

ctime
POSIX metadata that specifies the date and time of the last change to the metadata for an object. For a directory, this is the time of the last change to the metadata for any object in it.

custom metadata
One or more user-defined properties that provide descriptive information about an object. Custom metadata, which is normally specified as XML, enables future users and applications to understand and repurpose object content.

custom metadata search


A search that returns objects based on the XML elements, attributes, and/or values in their custom metadata.

D
data access account
A set of credentials that give a user or application access to one or more HCP namespaces. For each namespace, the account specifies which operations the user or application can perform.

data protection level (DPL)


The number of copies of an object HCP must maintain in the repository. Each namespace has its own DPL setting that applies to all objects in that namespace.

default namespace
A namespace that supports the HTTP, WebDAV, CIFS, NFS, SMTP, and NDMP protocols and does not require user authentication for data access. An HCP system can have at most one default namespace.

DPL
See data protection level (DPL).

Glossary2
Searching Namespaces

hash value

E
enterprise mode
The retention mode in which these operations are allowed:

Privileged delete Changing the retention class of an object to one with a shorter duration Reducing retention class duration Deleting retention classes

expired object
An object that is no longer under retention.

extracted metadata
Non-HCP, non-POSIX metadata thats specific to a file format.

F
filter
A criterion used to refine the results of a search. Also, to apply a filter.

fixed-content data
A digital asset ingested into HCP and preserved in its original form as the core part of an object. Once stored, fixed-content data cannot be modified.

G
GID
Group identifier.

H
hash value
See cryptographic hash value.

Glossary3
Searching Namespaces

HCP

HCP
See Hitachi Content Platform (HCP).

HCP namespace
A namespace that requires user authentication for data access. An HCP system can have multiple HCP namespaces.

HCP search facility


The search facility that interacts with HCP.

HDDS
See Hitachi Data Discovery Suite (HDDS).

HDDS search facility


The search facility that interacts with Hitachi Data Discovery Suite.

Hitachi Content Platform (HCP)


A distributed object-based storage system designed to support large, growing repositories of fixed-content data. HCP provides a single scalable environment that can be used for archiving, business continuity, content depots, disaster recovery, e-discovery, and other services. With its support for multitenancy, HCP securely segregates data among various constituents in a shared infrastructure. Clients can use a variety of industry-standard protocols and various HCP-specific interfaces to access and manipulate objects in an HCP repository.

Hitachi Data Discovery Suite (HDDS)


A Hitachi product that enables federated searches across multiple HCP systems and other supported systems.

hold
A condition that prevents an object from being deleted by any means and from having its metadata modified, regardless of its retention setting, until it is explicitly released.

HTTP
Hypertext Transfer Protocol. The HCP Search Console uses HTTP to communicate with Console clients.

HTTPS
HTTP with SSL security. See HTTP and SSL.

Glossary4
Searching Namespaces

object

I
index
See search index.

K
key term
Words or phrases that are significant in object content. Key terms are based on a variety of factors, such as frequency, case, and placement.

M
metadata
System-generated and user-supplied information about an object. Metadata is stored as an integral part of the object it describes, thereby making the object self-describing.

mtime
POSIX metadata that specifies the date and time of the last change to the object data. Because you cannot change the content of an object, mtime is, by default, the date and time at which the object was added to a namespace. Users and applications can change this metadata, thereby causing it to no longer reflect the actual storage time.

N
namespace
A logical partition of the objects stored in an HCP system. A namespace consists of a grouping of objects such that the objects in one namespace are not visible in any other namespace. Namespaces are configured independently of each other and, therefore, can have different properties.

O
object
For a data object, an exact digital representation of data as it existed before it was ingested into HCP, together with the system and custom metadata that describes that data. A data object is handled as a single unit by all transactions and internal processes, including shredding, indexing, versioning, and replication.

Glossary5
Searching Namespaces

permission

For a directory or symbolic link in the default namespace, the digital representation of its metadata.

P
permission
In POSIX permissions, the ability granted to the owner, the members of a group, or other users to access an object, directory, or symbolic link in the default namespace. A POSIX permission can be read, write, or execute.

POSIX
Portable Operating System Interface for UNIX. A set of standards that define an application programming interface (API) for software designed to run under heterogeneous operating systems. For the default namespace, HCP-FS is a POSIX-compliant file system, with minor variations.

privileged delete
A delete operation that works on objects regardless of their retention settings, except for objects on hold. This operation is available only to users and applications with explicit permission to perform it. Privileged delete operations work only in namespaces in enterprise mode.

privileged purge
The operation that deletes all versions of an object regardless of whether the object is under retention, except if the object is on hold. This operation is available only to users and applications with explicit permission to perform it. Privileged purge operations work only in namespaces in enterprise mode.

purge
The operation that deletes all versions of an object.

Q
query
A request submitted to HCP to return objects that satisfy a specified set of criteria. Also, to submit such a request.

Glossary6
Searching Namespaces

search facility

R
repository
The aggregate of the namespaces defined for an HCP system.

retention class
A named retention setting. The value of a retention class can be a duration, Deletion Allowed, Deletion Prohibited, or Initial Unspecified.

retention hold
See hold.

retention mode
A namespace property that affects which operations are allowed on objects under retention. A namespace can be in either of two retention modes: compliance or enterprise.

retention period
The period of time during which an object cannot be deleted (except by means of a privileged delete).

retention setting
The property that determines the retention period for an object.

S
search
The process of submitting a query and receiving the objects that satisfy the criteria it specifies.

Search Console
The web application that provides interactive access to the search functionality of the active search system.

search facility
An interface between the search functionality provided by a system such as HDDS or HCP and the HCP Search Console. Only one search facility can be enabled at any given time.

Glossary7
Searching Namespaces

search index

search index
An index of the metadata and key terms in namespace objects. The active search system builds, maintains, and stores this index.

search results
A list of the objects that the active search system returns in response to a query. Search results show metadata for the listed objects.

shred setting
The property that determines whether a data object will be shredded or simply removed when its deleted from HCP.

shredding
The process of deleting a data object and overwriting the locations where its bytes were stored in such a way that none of its data or metadata can be reconstructed. Also called secure deletion.

simple search
A type of search available in the HCP Search Console. A simple search lets you specify only text-based search criteria.

SSL
Secure Sockets Layer. A key-based Internet protocol for transmitting documents through an encrypted link.

structured search
A type of search available in the HCP Search Console. A structured search lets you specify multiple text- and/or metadata-based criteria.

T
tenant
An administrative entity created for the purpose of owning and managing namespaces and data access accounts. Tenants typically correspond to customers, business units, or individuals.

U
UID
User ID.

Glossary8
Searching Namespaces

XML search

user account
A set of credentials that gives an HCP system administrator access to the Search Console.

V
versioning
A feature that allows the creation and management of multiple versions of an object.

W
WORM
Write once, read many. A data storage property that protects the stored data from being modified or overwritten.

X
XML
Extensible Markup Language. A standard for describing data content using structural tags called elements.

XML search
A search that uses a query based on XML elements and attributes and their values.

Glossary9
Searching Namespaces

XML search

Glossary10
Searching Namespaces

Index
Symbols
$now 4-8 * in search terms 2-3, 2-42-5 in text 2-3 + in search criteria 2-52-6 - in search criteria 2-52-6 ? 2-3 \ 2-3 any (search option) with Boolean criteria 2-52-6 examples 2-8, 4-9 with multiple exact phrases 2-4 with simple searches 2-22-3 with structured searches 4-2, 4-8 with wildcard characters 2-5 Any of these words See any (search option) application MIME types, recognized B-2 applying filters 3-113-12 archived time See ingest time asterisks in search terms 2-3, 2-42-5 in text 2-3 atime See POSIX Atom feeds for saved queries 6-4 attachments See email attributes in custom metadata searches 7-5 custom metadata searches based on existence of 7-9 in XML searches 7-5 XML searches based on existence of 7-9 audio MIME types, recognized B-2 author in search results 3-8 searching by 4-6, 5-7

A
access time in search results 3-7 searching by 4-4, 5-6 specifying 4-74-8 Account Management page 1-11 active result filters 3-12 active search system 1-5 adding criteria to structured searches 4-8 advanced queries See advanced searches Advanced Search page 4-3, 5-2, 5-9, 6-2 advanced searches See also queries; search criteria; searching about 5-15-2 basic criteria 5-25-3 complex criteria 5-35-4 performing 5-9 properties for 5-45-8 from structured searches 4-3, 5-2 all (search option) with Boolean criteria 2-6 examples 2-8, 2-8, 4-94-10 with multiple exact phrases 2-4 with simple searches 2-22-3 with structured searches 4-2, 4-8 with wildcard characters 2-5 All of these words See all (search option)

B
backslashes 2-3 basic criteria for advanced searches 5-25-3 Boolean operators in custom metadata searches 7-87-9 example 2-8 in search terms 2-52-6 in XML searches 7-87-9

Index1
Searching Namespaces

calendar, selecting datetime from

C
calendar, selecting datetime from 4-7 category in search results 3-8 searching by 4-6, 5-7 change time in search results 3-7 searching by 4-4, 5-6 specifying 4-74-8 changing hold status 3-153-16 number of objects on Search Results page 3-93-10 passwords 1-11 sort order 3-10 structured searches to advanced searches 4-3, 5-2 character set, searching by 4-5, 5-6 Chinese search considerations 8-2 Clear button 3-12 comparison options for simple searches 2-22-3 for structured searches 4-2 complex criteria for advanced searches 5-35-4 compliance mode 1-4 compressed formats, recognized A-6 Console pages See also Search Console Account Management page 1-11 Advanced Search 4-3, 5-2, 5-9, 6-2 Saved Queries 6-36-4 Search Results 3-13-2 Simple Search 1-9, 2-7, 6-2 Structured Search 4-2, 4-84-9, 6-2 content formats See document formats content indexing, searching by 5-8 Control operations field 3-163-17 credentials, setting HDDS 1-12 criteria See search criteria cryptographic hash algorithm in export files 3-18 in search results 3-7 cryptographic hash value in export files 3-18 searching by 4-5, 5-6 CSV files, exporting search results as 3-183-19 ctime See POSIX currency of search index 1-10 current datetime 4-8

custom metadata See also custom metadata searches about 1-3 sample file 7-3 in search results 3-7 searching by 4-6, 5-7 custom metadata searches See also custom metadata about 7-17-3 advanced 5-7 attributes in 7-5 based on element or attribute existence 7-9 element hierarchy 7-4 element types in 7-6 esp-internal-type in 7-7 example in structured search 4-10 numeric values in 7-7 operators in 7-87-9 quotation marks in 7-5, 7-10 reserved words in 7-10 special characters in 7-10 structured 4-6 text values in 7-47-5 value expressions 7-57-6 wildcard characters in 7-8

D
data protection level in search results 3-7 database formats, recognized A-6 datetime values formats 4-74-8 selecting current 4-8 selecting from calendar 4-7 typing 4-74-8 default namespace 1-2 default sort order 3-10 default tenant 1-2 deleting objects 3-153-16 saved queries 6-4 Deletion Prohibited (retention) 1-3 details, showing/hiding 3-5 Did you mean 2-7 directory paths, searching by 2-32-4 document formats filtering search results by 3-13 recognized A-1A-7 in search results 3-8 searching by 4-3, 5-4 documentation, viewing 1-101-11 documents See objects

Index2
Searching Namespaces

HCP tenants
DPL in search results 3-7 extracted metadata about 1-6 searching by 4-6, 5-7 structured search example 4-10

E
EBCDIC objects 3-13, 8-2 editing saved queries 6-36-4 elements 7-7 in custom metadata searches 7-4 custom metadata searches based on existence of 7-9 esp-internal-type 7-7 types in custom metadata and XML searches 7-6 in XML searches 7-4 XML searches based on existence of 7-9 email See also objects attachment name, searching by 4-5, 5-7 attachments in search results 3-8 bcc in search results 3-8 bcc, searching by 4-5, 5-6 cc in search results 3-8 cc, searching by 4-5, 5-6 date in search results 3-8 date, searching by 4-5, 5-7 date, sorting search results by 3-10 from in search results 3-8 from, searching by 4-5, 5-6 message ID in search results 3-8 message ID, searching by 4-5, 5-7 subject in search results 3-8 subject, searching by 4-5, 5-6 to in search results 3-8 to, searching by 4-5, 5-6 enterprise mode 1-4 exact (search option) examples 2-82-9 with multiple phrases 2-4 with simple searches 2-22-3 with wildcard characters 2-5 examples basic criteria for advanced searches 5-25-3 complex criteria for advanced searches 5-4 custom metadata file for 7-3 custom metadata in structured search 4-10 extracted metadata in structured search 4-10 namespace in structured search 4-10 simple searches 2-82-9 structured searches 4-2, 4-94-10 XML file for 7-27-3 Expired (retention) 1-4 export files 3-183-19 Export results field 3-18 exporting search results 3-183-19

F
feeds, publishing for saved queries 6-4 file formats See document formats files See also objects CSV for search results 3-183-19 custom metadata sample 7-3 export 3-183-19 XML for search results 3-183-19 XML sample 7-27-3 filtering search results about 3-113-12 by document format 3-13 by hold status 3-143-15 by key terms 3-123-13 by namespace 3-15 by retention 3-133-14 by retention class 3-14 saved queries 6-2 filters See filtering search results fixed-content storage system 1-2 formats See also document formats basic for advanced searches 5-2 complex for advanced searches 5-3 for custom metadata searches 7-2 datetime 4-74-8 in export files 3-18 for XML searches 7-2

G
GID in search results 3-8 searching by 4-4, 5-5 go to page field 3-10 graphics formats, recognized A-4A-5

H
hash See cryptographic hash algorithm; cryptographic hash value HCP namespaces 1-2 HCP search facility about 1-5 initial search results 3-33-4 HCP tenants 1-2

Index3
Searching Namespaces

HDDS search facility


HDDS search facility about 1-5 initial search results 3-3 search result limitation 3-3 setting credentials 1-12 Held (retention hold status) 3-15 Hide details link 3-5 Hide Query option 3-11 hiding details in search results 3-5 queries on Search Results page 3-11 hold status changing 3-153-16 filtering search results by 3-143-15 in search results 3-6 searching by 4-5, 5-6 holding objects 3-153-16 hostname mappings 1-8 hosts file 1-8 hot keys 1-10 Logout button 1-9

M
message MIME types, recognized B-2 metadata See also search criteria about 1-3 advanced searches 5-45-8 custom 1-3 for email 3-8 extracted 1-6 POSIX 1-3 retention 3-6 in search index 1-51-6 in search results 3-53-9 for structured searches 4-34-6 MIME types recognized B-1B-2 in search results 3-7 searching by 5-4 minus signs in search criteria 2-52-6 modify time in search results 3-7 searching by 4-4, 5-6 specifying 4-74-8 mtime See POSIX multiple exact phrases 2-4

I
image MIME types, recognized B-2 index See search index ingest time searching by 4-4, 5-5 sorting search results by 3-10 ingested time in search results 3-6 Initial Unspecified (retention) 1-4 IP addresses in search console URL 1-8 mapping hostnames to 1-8

N
namespaces about 1-2 default namespace 1-2 filtering search results by 3-15 HCP namespaces 1-2 searchable 1-7 searching by 4-3 structured search example 4-10 UUID 5-4 Not Expired (retention) 3-13 Not Held (retention hold status) 3-15 number of objects on search results page 3-9 number of objects returned by HDDS search facility 3-3 numeric values in custom metadata and XML searches 7-7

J
Japanese search considerations 8-2

K
key terms, filtering search results by 3-123-13 key/value, searching by 4-6, 5-7 Korean search considerations 8-2

L
language in search results 3-8 searching by 4-5, 5-6 large objects document format 3-13 indexing 8-2 line breaks in object content 2-2 logging into Search Console 1-81-9 out of Search Console 1-9

O
objects about 1-2 content, line breaks in 2-2 deleting 3-153-16 holding 3-153-16

Index4
Searching Namespaces

saved queries
indexing of versions 1-6 large 3-13, 8-2 metadata 1-3 metadata in search results 3-53-9 order in search results 3-10 privileged operations 3-15 purging 3-153-16 releasing 3-153-16 viewing from search results 3-53-11 octal values for permissions 3-9 opening objects from search results 3-53-11 operators in custom metadata and XML searches 7-87-9 order of objects in search results 3-10 other formats, recognized A-7 overwriting saved queries 6-3 publishing feeds for saved queries 6-4 purging objects 3-153-16

Q
queries See also saved queries; advanced searches; simple searches; structured searches; about 5-2 hiding 3-11 saving 6-2 showing 3-11 question marks 2-3 quotation marks in custom metadata searches 7-5, 7-10 in search terms 2-4, 2-5 in XML searches 7-5, 7-10

P
paging through search results 3-10 password, changing 1-11 performing advanced searches 5-9 simple searches 2-7 structured searches 4-84-9 permissions in search results 3-8 octal values for 3-9 POSIX 3-9 searching by 4-4, 5-5 phrases See exact (search option) plain-text objects, indexing 8-2 plus signs in search criteria 2-52-6 POSIX about 1-3 atime in search results 3-7 atime, searching by 4-4, 5-6 ctime in search results 3-7 ctime, searching by 4-4, 5-6 metadata 1-3 mtime in search results 3-7 mtime, searching by 4-4, 5-6 permissions in search results 3-8 permissions, about 3-9 permissions, searching by 4-4 PostScript Level II objects, indexing 8-2 presentation formats, recognized A-3 privileged delete 1-4, 3-15 privileged purge 3-15 properties See also search criteria for advanced searches 5-45-8 for structured searches 4-34-6

R
recognized document formats A-1A-7 MIME types B-1B-2 refining search results 3-113-12 releasing objects 3-153-16 removing criteria from structured searches 4-9 filters 3-12 reserved words in custom metadata and XML searches 7-10 results/page field on Search Results page 3-9 retention filtering search results by 3-133-14 hold 3-6 mode 1-4 period 1-3 in search results 3-6 searching by 4-4, 5-5 settings 1-31-4 sorting search results by 3-10 retention classes about 1-4 filtering search results by 3-14 searching by 4-4, 5-5 RSS feeds for saved queries 6-4 running saved queries 6-3

S
save as field 6-2 saved queries See also queries about 6-1 deleting 6-4 editing 6-36-4

Index5
Searching Namespaces

saved queries, overwriting


overwriting 6-3 publishing feeds for 6-4 running 6-3 viewing 6-3 Saved Queries page 6-36-4 saving queries 6-2 Search Console See also Console pages about 1-5 logging in 1-81-9 logging out 1-9 URL 1-71-8 using 1-10 search criteria See also advanced searches; search terms; simple searches; structured searches access time 4-4, 5-6 adding to structured searches 4-8 author 4-6, 5-7 basic for advanced searches 5-25-3 category 4-6, 5-7 change time 4-4, 5-6 character set 4-5, 5-6 complex for advanced searches 5-35-4 content indexing 5-8 cryptographic hash value 4-5, 5-6 custom metadata 4-6, 5-7 datetime specification 4-74-8 directory path 2-32-4, 4-3, 5-4 document format 4-3, 5-4 email attachment name 4-5, 5-7 email bcc 4-5, 5-6 email cc 4-5, 5-6 email date 4-5, 5-7 email from 4-5, 5-6 email ID 4-5, 5-7 email subject 4-5, 5-6 email to 4-5, 5-6 extracted metadata 4-6, 5-7 GID 4-4, 5-5 hold status 4-5, 5-6 ingest time 4-4, 5-5 key/value 4-6, 5-7 language 4-5, 5-6 MIME type 5-4 modify time 4-4, 5-6 namespace 4-3 namespace UUID 5-4 object content 4-3, 5-4 object name 2-32-4, 5-4 object type 4-3 permissions 4-4, 5-5 removing from structured searches 4-9 retention 4-4, 5-5 retention class 4-4, 5-5 shred setting 4-5, 5-6 simple searches 2-2 size 4-5, 5-6 structured searches 4-2 subject 4-6, 5-7 title 4-6, 5-7 UID 4-4, 5-5 UTF-8 encoding 5-8 XML 4-6, 5-7 search facilities 1-5 See also HCP search facility; HDDS search facility search index about 1-51-6 considerations 8-2 currency indicator 1-10 key terms 3-123-13 location 1-5 updates 1-6, 3-16 search query language 5-2 search results See also Search Results page exporting 3-183-19 filtering, about 3-113-12 filtering by document format 3-13 filtering by hold status 3-143-15 filtering by key terms 3-123-13 filtering by namespace 3-15 filtering by retention 3-133-14 filtering by retention class 3-14 with HCP search facility 3-33-4 with HDDS search facility 3-3 limitation in HDDS 3-3 metadata in 3-53-9 number of objects in 3-9 paging through 3-10 sorting 3-10 suggested terms 2-7 text snippets 3-43-5 Search Results page See also search results about 3-13-2 active filters 3-12 hiding queries 3-11 number of objects shown 3-93-10 Saved Queries 6-3 showing queries 3-11 search terms See also search criteria; simple searches in advanced searches 5-4 comparison options 2-22-3

Index6
Searching Namespaces

types
considerations 8-2 directory paths 2-32-4 email attachment name 4-5 email bcc 4-5, 5-6 email cc 4-5, 5-6 email date 4-5, 5-7 email from 4-5, 5-6 email ID 4-5, 5-7 email subject 4-5, 5-6 email to 4-5, 5-6 examples 2-82-9, 4-2 multiple exact phrases 2-4 object names 2-32-4, 2-9 quotation marks 2-4 in structured searches 4-3 wildcard characters 2-42-5 searchable namespaces 1-7 searching See also advanced searches; simple searches; structured searches for objects by name 2-9 performing advanced searches 5-9 performing simple searches 2-7 performing structured searches 4-84-9 selecting current date and time 4-8 datetime from calendar 4-7 setting HDDS credentials 1-12 shortcut keys 1-10 Show details link 3-5 Show Query option 3-11 showing details in search results 3-5 queries on Search Results page 3-11 shred settings in search results 3-7 searching by 4-5, 5-6 Simple Search page 1-9, 2-7, 6-2 simple searches See also queries; search terms; searching about 2-12-2 Boolean criteria 2-52-6, 2-8 criteria for 2-2 examples 2-82-9 by object name 2-9 performing 2-7 size in export files 3-18 in search results 3-6 searching by 4-5, 5-6 sorting search results by 3-10 snippets of text in search results 3-43-5 Sort results field 3-10 sorting search results about 3-10 default sort order 3-10 special characters in custom metadata and XML searches 7-10 in search terms 2-3 in searched text 2-3 specifying datetime values in search criteria 4-7 4-8 spreadsheet formats, recognized A-4 Structured Search page 4-2, 4-84-9, 6-2 structured searches See also queries; search criteria; searching about 4-14-3 adding criteria 4-8 comparison options 4-2 converting to advanced searches 4-3, 5-2 criteria for 4-2 examples 4-2, 4-94-10 performing 4-84-9 properties for 4-34-6 removing criteria 4-9 subject in search results 3-8 searching by 4-6, 5-7 suggested terms 2-7 syntax for basic advanced searches 5-2 for Boolean operators in custom metadata and XML searches 7-8 for complex advanced searches 5-3 for custom metadata searches 7-2 for scope in custom metadata and XML searches 7-9 for XML searches 7-2

T
tenants 1-2 text MIME types, recognized B-2 snippets in search results 3-43-5 values in custom metadata and XML searches 7-47-5 text-based searches 2-2 This exact phrase See exact (search option) title in search results 3-8 searching by 4-6, 5-7 types of comparisons 2-22-3 of filters 3-11 of objects 4-3

Index7
Searching Namespaces

typing datetime values


typing datetime values 4-74-8 XML searches about 7-17-3 advanced 5-7 attributes in 7-5 based on element or attribute existence 7-9 element hierarchy 7-4 esp-internal-type in 7-7 numeric values in 7-7 operators in 7-87-9 quotation marks in 7-5, 7-10 reserved words in 7-10 special characters in 7-10 text values in 7-47-5 wildcard characters in 7-8

U
UID in search results 3-8 searching by 4-4, 5-5 understanding search results 3-53-9 updates to search index 1-6, 3-16 URLs custom metadata in search results 3-7 in export files 3-18 object in search results 3-6 Search Console 1-71-8 usage considerations 8-2 user accounts 1-7 using Search Console 1-10 UTF-16-encoded objects, indexing 8-2 UTF-8 encoding, searching by 5-8 UUID, namespace 5-4

V
value expressions in custom metadata and XML searches 7-57-6 versions indexing 1-6 purging 3-153-16 video MIME types, recognized B-2 viewing objects from search results 3-53-11 saved queries 6-3 search documentation 1-101-11

W
wildcard characters in custom metadata searches 7-8 in search terms 2-42-5 in simple search examples 2-8 in XML searches 7-8 word-processing formats, recognized A-2A-3 WORM 1-2

X
XML files See also XML searches exporting search results as 3-183-19 sample for XML search examples 7-27-3 XML objects indexing 8-2 searching for 4-6, 5-7

Index8
Searching Namespaces

Searching Namespaces

Hitachi Data Systems Corporate Headquarters 750 Central Expressway Santa Clara, California 95050-2627 U.S.A. Phone: 1 408 970 1000 www.hds.com info@hds.com Asia Pacific and Americas 750 Central Expressway Santa Clara, California 95050-2627 U.S.A. Phone: 1 408 970 1000 info@hds.com Europe Headquarters Sefton Park Stoke Poges Buckinghamshire SL2 4HD United Kingdom Phone: + 44 (0)1753 618000 info.eu@hds.com

MK-96ARC003-11

S-ar putea să vă placă și