Show Menu
TOPICS×

About the Metadata menu

Use the Metadata menu to customize Search definitions and index injections.

About Definitions

You can use Definitions to customize the content and relevance of the HTML and metadata fields that are considered when a customer submits a search query.
You can edit the fields that are already pre-defined. Or, you can also create new user-defined fields based on metadata tag content. Each definition is displayed on a single line on the Staged Definitions page.

Adding a new meta tag field

You can define and add your own metadata tag fields.
Before the effects of the new meta tag definition is visible to customers, you must rebuild your site index.
To add a new meta tag field
  1. On the product menu, click Settings > Metadata > Definitions .
  2. On the Definitions page, click Add New Field .
  3. On the Add Field page, set the options that you want.
    Option
    Description
    Field Name
    Specifies a name that is used to reference the field.
    The field name must adhere to the following rules:
    • The name must contain only alphanumeric characters.
    • Dashes are allowed in the name, but no spaces.
    • You can enter a name up to 20 characters long.
    • The name is not case-sensitive, but is displayed and stored exactly as you type it.
    • You cannot use the names that exist in the pre-defined fields as seen in the table on the Staged Definitions page.
    • You cannot use the word "any" as the value of a user-defined field name.
    • You cannot edit the names of pre-defined fields.
    Field name examples:
    • author
    • PublishDate
    • something-wild
    Meta Tag Name(s)
    Determines the content that is associated with the defined field.
    The list of names can be up to 255 characters long. And, name can contain any characters that are allowed in the name attribute of an HTML meta tag.
    You can specify multiple meta tags in a single field definition.
    Multiple values must be comma-separated, and the leftmost meta tag name found on any given web page takes precedence.
    For example, suppose that you have defined a field named "auth". The field name has the associated meta tags "author, dc.author". In this case, the content from the "author" meta tag is indexed and searched over that of the "dc.author" if both meta tags appear on a web page.
    User-defined fields must have at least one meta tag name in their definition. Pre-defined fields do not need to have an associated meta tag. However, if one or more meta tags are specified, the content of the meta tags override the current data source for each tag.
    For example, if the meta tag "dc.title" is associated with the pre-defined "title" field, the content from the "dc.title" meta tag is indexed over that of the <title> tag for any particular document.
    Examples include the following:
    • dc.date
    • description
    • proprietarytag
    Data Type
    Every field has an associated data type such as text, number, date, version, rank, or location. This data type determines how the field's content is indexed, searched and optionally, sorted.
    You cannot change the data type after you create the field definition.
    Use the following information to help you select the data type that is relevant to the information that the field contains.
    • Text data type fields are treated as character strings.
    • Number data type fields are treated as integer or floating-point numeric values.
    • Date data type fields are treated as date/time specifiers. You can customize the allowed date/time formats when you add or edit the new field.
    • Version data type fields are treated as free-form numeric data. For example, 1.2.3 sorts before 1.2.2.
    • Rank data type fields are treated the same as "Number" type fields, except that they additionally influence the ranking / relevance calculations in the search results.
    • Location data type fields are treated as a physical location anywhere in the world. The allowed location formats include the following:
      • 5- or 9-digit ZIP codes in the form of DDDDD or DDDDD-DDDD, where each "D" is a 0-9 digit.
      • Three-digit area-codes in the form of DDD.
      • Latitude/longitude pairs in the form ±DD.DDDD±DDD.DDDD, where the first number specifies the latitude and the second number specifies the longitude.
    Allow Lists
    Available only if the data type Text , or Number is selected.
    Separately index delimited values in the metadata content of this field.
    For example, the content "Red, Yellow, Green, Blue" is treated as four separate values instead of one when "Allow Lists" is selected. This treatment is most useful with range searching (using sp_q_min , sp_q_max , or sp_q_exact ) and with the <search-field-value-list> , <search-field-values> , and <search-display-field-values> .
    Not available if Version data type is selected.
    Dynamic Facet
    Note: This feature is not enabled by default. Contact Technical Support to activate it for your use. After it is activated, it appears in the user interface.
    Sets the identified facet to be dynamic.
    Facets are built on top of meta tag fields. A meta tag field is a low-level, core search layer of Adobe Search&Promote. Facets, on the other hand are part of GS (Guided Search)-the high-level, presentation layer of Adobe Search&Promote. Facets own meta tag fields, however, meta tag fields know nothing about facets.
    Allow Dedupe
    Check this option to enable deduplication for this field. That is, allow this field to be specified at search-time by way of the sp_dedupe_field Search CGI parameter.
    Table Name
    Permanently associates the given field with the given table name.
    Any time such a field is mentioned within a core search CGI parameter or a template tag, the table name is provided automatically. This feature allows the selection of dynamic facets through table matches, but you can also use it for non-dynamic facet fields, if desired.
    List Delimiters
    Available only if Allow Lists is selected.
    Specifies which characters separate individual list values. You can specify multiple characters, each of which are treated as a value separator.
    Search By Default
    When selected, the field content is searched even when the field is not explicitly specified in a given search query. If you deselect this option, the field is only searched when requested.
    Vertical Update Field
    Note: This feature is not enabled by default. Contact Technical Support to activate it for your use. After it is activated, it appears in the user interface.
    Sets the identified field to be a Vertical Update field.
    Vertical Update fields are candidates to be updated by way of the Vertical Update process ( Index > Vertical Update .) Due to the way that Vertical Updates are made, content from these fields cannot be searched in free-text searches. Checking this option results in this field's content not being added to the "word" index during any kind of index operation. It also enables the update of this field during a Vertical Update operation.
    To learn more about Vertical Updates, see About Vertical Update .
    Relevance
    You can edit the relevance of pre-defined and user-defined fields.
    Relevance is specified on a scale 1-10. A setting of 1 means that it is the least relevant and 10 being the most relevant. These values are taken into account when the software considers the query matches in each field.
    Sorting
    Specifies when results are sorted by the named field, by way of the sp_s Search CGI parameter.
    Language
    Available only if the data type Rank , Number , or Date is selected.
    Controls the language and locale conventions that are applied when indexing the date, number, and rank values for this field.
    You can choose to apply the account language (Linguistics > Words & Languages). Or, you can apply the language that is associated with the document that contains each number or date value, or a specific language.
    Date Format(s)
    Available only if the data type Date is selected.
    Controls the date formats that are recognized when indexing date values for this field.
    A default list of date format strings is provided for each date field. You can add to the list or edit the list to suit your own site's needs.
    Test Date Formats
    Available only if the data type Date is selected as the Data Type.
    Lets you preview the date formats that you have specified to ensure that they are formatted correctly.
    Time Zone
    Available only if the data type Date is selected as the Data Type.
    Controls the assumed time zone that is applied when indexing date values for this field that do not specify a time zone.
    For example, if your account time zone is set to "America/Los Angeles" and you select Use Account Time Zone , the following meta date value, which does not have a specified time zone, is treated as if it were Pacific Time, accounting for daylight savings:
    <meta name="dc.date" content="Mon, 05 Sep 201213:12:00">
    Least Important Rank Value
    Available only if the data type Rank is selected as the Data Type.
    Controls the rank value that represents the minimum rank of any document.
    If your document rankings range from 0 for the lowest rank to 10 for the highest rank, then you set this value to 0.
    If your document rankings range from 1 for the highest rank to 10 for the lowest rank, then you set this value to 10.
    Default Rank Value
    Available only if the data type Rank is selected as the Data Type.
    Controls the rank value that is used if a document does not contain any of the meta tags that are defined for this rank field.
    Most Important Rank Value
    Available only if the data type Rank is selected as the Data Type.
    Controls the rank value that represents the maximum rank of any document.
    If your document rankings range from 0 for the lowest rank to 10 for the highest rank, then you set this value to 10.
    If your document rankings range from 1 for the highest rank to 10 for the lowest rank, then you set this value to 1.
    Default Units
    Available only if the data type Location is selected as the Data Type.
    Controls the treatment of distance values for proximity searches.
    If you set the default units to Miles , then any proximity search minimum/maximum distance criteria that is applied to this field (by way of the sp_q_min[_#] or the sp_q_max[_#] Search CGI parameters) is treated as miles, otherwise as kilometers.
    This option also controls the default distance units that are applied to the output of the <Search-Display-Field> search results template tag when applied to a proximity search output field.
    Create Range Description?
    Available only if Number is selected as the Data Type.
    Controls the automatic creation of Field Range descriptions, for use with Design > Navigation > Facets .
    Note: If this field has Vertical Update Field checked, the generated Field Range description field is updated during a Vertical Update. However, it is recommended that the field identified in Range Field also have Vertical Update Field checked.
    Range Field
    Available only if Create Range Description is checked.
    The Text field to be updated with range descriptions for the current field. This list contains all Text fields that are not already being used with other fields for Field Range generation.
    Range Values
    Available only if Create Range Description is checked and a Range Field item is selected.
    A blank-delimited list of data points to use when creating the Field Range descriptions. For example:
    10&nbsp;20&nbsp;50&nbsp;100&nbsp;1000
    You can enter these values in any order. The values are sorted and duplicates removed before it is saved. You can also specify negative and non-integer values.
    For each of this field's values:
    • if the value is less than (<) the smallest value in Range Values , the "Less Than" Format is used
    • if the value is greater than or equal to (>=) the largest value in Range Values , the "Greater Than" Format is used.
    • otherwise, a "range" is found where the field value falls between two consecutive Range Values (greater than (>) the smaller value and less than or equal to (<=) the larger value), and the Intermediate Format is used.
    For example, the above example set of values will define a set of descriptions for values:
    • less than 10
    • greater than or equal to 10 and less than 20
    • greater than or equal to 20 and less than 50
    • greater than or equal to 50 and less than 100
    • greater than or equal to 100 and less than 10000
    • greater than or equal to 10000
    See Test using Greater Than? to change how these tests are performed.
    "Less Than" Format
    Available only if Create Range Description is checked and a Range Field item is selected.
    This is the template used to specify the range description for values less than the smallest value found in Range Values . The smallest value will be represented using the numeric placeholder token ~N~ . For example:
    Less&nbsp;than&nbsp;~N~
    or:
    ~N~&nbsp;and&nbsp;below
    Normally, the value will be formatted "as-is" - i.e. for a Range Values definition of "5 10 20" and a supplied value of 1, the generated range description would simply be something like "Less than 5". If you'd instead like to have it be "4.99 and below", set Precision to 2 and use this format:
    ~n~&nbsp;and&nbsp;below
    In "Less Than" Format , the lower-case ~n~ will cause the value to be rounded down according to the Precision setting.
    Note: to include any numeric placeholder in the range description, as is, specify with a backslash (\) prefix - e.g. \~N~ or \~n~ . To include a backslash character, specify it with another backslash - e.g. \\ .
    Intermediate Format
    Available only if Create Range Description is checked and a Range Field item is selected.
    This is the template used to specify the range description for values that fall somewhere between the smallest and largest values found in Range Values . For the given range, the lower range value will be represented using the numeric placeholder token ~L~ , and the higher range value will be represented using the token ~H~ . For example:
    ~L~&nbsp;to&nbsp;~H~
    or:
    Between&nbsp;~L~&nbsp;and&nbsp;~H~
    or:
    Less&nbsp;than&nbsp;~H~&nbsp;and&nbsp;greater&nbsp;than&nbsp;~L~
    Normally, the values will be formatted "as-is" - i.e. for a Range Values definition of "5 10 20" and a supplied value of 8, the generated range description would simply be something like "Between 5 and 10". If you'd instead like to have it be "Between 5 and 9.99", with the higher value adjusted downwards , set Precision to 2 and use this format:
    Between&nbsp;~L~&nbsp;and&nbsp;~h~
    Similarly, ~L~ can be replaced with ~l~ to have the lower value adjusted upwards , also according to the Precision setting. This means that a definition like:
    Between&nbsp;~l~&nbsp;and&nbsp;~H~
    with a Precision value of 2 would create "Between 5.01 and 10".
    The lower-case ~l~ will cause the lower value to be rounded up according to the Precision setting, and the lower-case ~h~ will cause the higher value to be rounded down .
    Note: to include any numeric placeholder in the range description, as is, specify with a backslash (\) prefix - e.g. \~L~ or \~h~ . To include a backslash character, specify it with another backslash - e.g. \\ .
    "Greater Than" Format
    Available only if Create Range Description is checked and a Range Field item is selected.
    This is the template used to specify the range description for values greater than the largest value found in Range Values . The largest value will be represented using the numeric placeholder token ~N~ . For example:
    Greater&nbsp;than&nbsp;~N~
    or:
    ~N~&nbsp;and&nbsp;above
    Normally, the value will be formatted "as-is" - i.e. for a Range Values definition of "5 10 20" and a supplied value of 30, the generated range description would simply be something like "Greater than 20". If you'd instead like to have it be "20.01 and above", set Precision to 2 and use this format:
    ~n~&nbsp;and&nbsp;above
    In "Greater Than" Format , the lower-case ~n~ will cause the value to be rounded up according to the Precision setting.
    Note: to include any numeric placeholder in the range description, as is, specify with a backslash (\) prefix - e.g. \~N~ or \~n~ . To include a backslash character, specify it with another backslash - e.g. \\ .
    Precision
    Available only if Create Range Description is checked and a Range Field item is selected.
    An integer value specifying the number of digits to the right of a decimal point. This also controls rounding operations.
    Strip leading zeros?
    Available only if Create Range Description is checked, a Range Field item is selected and a non-zero Precision value has been set.
    Should we display "0.50" as ".50"?
    Strip trailing zeros?
    Available only if Create Range Description is checked, a Range Field item is selected and a non-zero Precision value has been set.
    Should we display "10.00" as "10"?
    Show thousands separators?
    Available only if Create Range Description is checked and a Range Field item is selected.
    Should we display "10000" as "10,000"? Locale-specific values will be used.
    Adjust zero values?
    Available only if Create Range Description is checked and a Range Field item is selected.
    When rounded zero values are displayed, should they be rounded up or down according to the Precision setting? i.e. display "0.01"?
    Test using Greater Than?
    Available only if Create Range Description is checked and a Range Field item is selected.
    As each value is compared against the values in Range Values , processed in descending order, it is compared, by default, using the Greater Than or Equal (>=) operator, stopping once this test succeeds. This means that with a set of Range Values like "10 20 50 100 1000" the value 100 will fall in the range 100 to 1000, as 100 is indeed >= 100. If you'd rather have it fall in the range 50 to 100, check this option, which will cause the comparisons to use the Greater Than (>) operator, instead.
    For example, for each of this field's values, when this option is checked:
    • if the value is less than or equal to (<=) the smallest value in Range Values , the "Less Than" Format will be used
    • if the value is greater than (>) the largest value in Range Values , the "Greater Than" Format will be used
    • otherwise, a range will be found where the field value falls between two consecutive Range Values (greater than or equal to (>=) the smaller value and less than (<) the larger value), and the Intermediate Format will be used
    and, when unchecked:
    • if the value is less than (<) the smallest value in Range Values , the "Less Than" Format will be used
    • if the value is greater than or equal to (>=) the largest value in Range Values , the "Greater Than" Format will be used
    • otherwise, a range will be found where the field value falls between two consecutive Range Values (greater than (>) the smaller value and less than or equal to (<=) the larger value), and the Intermediate Format will be used
    Test
    Available only if Create Range Description is checked and a Range Field item is selected.
    Supply a sample numeric value and press the Test button to see how the Range Field is created. The generated Range description will be displayed in the window.
  4. Click Add .
  5. (Optional) Rebuild your staged site index if you want to preview the results.
  6. (Optional) On the Definitions page, do any of the following:

Editing pre-defined or user-defined meta tag fields

You can edit only certain fields in pre-defined meta tags, or edit all the fields in meta tags that are user-defined.
Before the effects of your meta tag changes are visible to customers, you must rebuild your site index.
To edit pre-defined or user-defined meta tag fields
  1. On the product menu, click Settings > Metadata > Definitions .
  2. On the Definitions page, in the Actions column of the table, click Edit in the row of the meta tag field name that you want to change.
  3. On the Pinned Keyword Results Manager page, in the table, click Edit in the row of the keyword that you want to change.
  4. On the Edit Field page, set the options that you want.
    If you chose to make changes to a pre-defined meta tag field, be aware that not all fields are editable.
    See the table of options under Adding a new meta tag field .
  5. Click Save Changes .
  6. (Optional) Rebuild your staged site index if you want to preview the results.
  7. (Optional) On the Definitions page, do any of the following:

Deleting a user-defined meta tag field

You can delete a user-defined meta tag field that you no longer need or use.
You cannot delete pre-defined meta tag fields. However, you can edit certain fields.
Before the effects of your delete meta tag are visible to customers, you must rebuild your site index.
To delete a user-defined meta tag field
  1. On the product menu, click Settings > Metadata > Definitions .
  2. On the Definitions page, in the User-defined fields section of table, click Delete in the row of the meta tag field name that you want to remove.
  3. In the Confirmation dialog box, click OK .
  4. (Optional) Rebuild your staged site index if you want to preview the results.
  5. (Optional) On the Definitions page, do any of the following:

About Injections

You can use Injections to insert content into your web pages without the need to edit the pages themselves.
You can append content to specific indexed fields like "target" or "body", or replace indexed content with new values. For example, if you inserted new content into the "target" meta tag field, This information is treated just as it would hard-coded page content. You can edit the content of any pre-defined meta tag field regardless of whether your site pages have corresponding content. For example, you can edit the content of the following pre-defined meta tag field names:
  • alt
  • body
  • charset
  • date
  • desc
  • keys
  • language
  • target
  • title
  • url

Working with Test Field Injections

You can optionally use Test on the Staged Injections page. You enter a test field name (for example, "title" or "body"), the original field value (for example, "Home Page"), and a test URL from your website. The resulting value is displayed for your reference. The current values are not altered during the test.

Working with Field Injection Definitions

Injection definitions have the following form:
append|replace field [regexp] URL value

The append|replace , field , URL . and value items are mandatory. You enter one injection definition per line. The following example contains six different injection definitions.
replace title  https://www.yoursite.com/company/contactus.html Adobe: Contact Us 
append body https://www.yoursite.com/products/* On Sale Now! 
append target https://www.yoursite.com/news/bob_white/ Regular Weekly Feature 
append target regexp https://www.yoursite.com/travel/mr_travel/.*\column.html$ Regular Weekly Feature 
replace charset https://www.yoursite.com/japanese/intro.txt shift-jis 
replace language https://www.yoursite.com/japanese/intro.txt ja_JP

Injection definition
Description
append|replace
Choose "append" to add the value of the injection definition ("Adobe: Contact Us" or "On Sale Now!" in the above examples) to the content of existing fields. Choose "replace" to overwrite existing field content with the defined value. If a field does not currently have content, the defined value is added automatically, regardless of which option (append or replace) is used.
field
A field name is required. The following are ten pre-defined field names that you can use:
  • alt
  • body
  • charset
  • date
  • desc
  • keys
  • language
  • target
  • title
  • url
Each field name corresponds to elements on your site pages. If you specify the field name desc for example, you can add the injection definition value to the field that corresponds to the description Meta tags on your site pages.
If no description Meta tag exists on your pages, the defined content creates the tag for you. The content specified in a desc injection displays on your results page just as hard-coded Meta-description content would.
You can also create multiple definitions with the same field name. For example, supposed you have the following injections:
replace  title  https://www.mysite.com/ Welcome to My Site
replace  title  https://www.mysite.com/company/*.html My Site: Contact
All site pages in the above example receive an injected title "Welcome to My Site". Pages in the "/company/" folder are injected with a new title "My Site: Contact Us" that replaces the previous one.
Notice that injections are applied in the order in which they appear in the Field Injection Definitions text box. If the same field ("title" in this example) is defined more than once for pages at the same location, the later definition takes precedence.
[regexp] - optional. If you choose to use the regexp option, the defined URL is treated as a regular expression.
In the following definition:
replace target  regexp&nbsp;^.*/products/.*\.html$  Important information
"Important information" is injected into the "target" field on all pages that match the regular expression ^.*/products/.*\.html$ .
Therefore, you have the following:
https://www.mydomain.com/products/page1.html     (Will receive "target" content)
https://www.mydomain.com/product/oldstuff.html     (Will not receive "target" content)
In the following example:
append&nbsp;title&nbsp;regexp&nbsp;^.*\.pdf$&nbsp;Millennium&nbsp;Science
The injection appends "Millennium Science" to the "title" content of all pages that end with a ".pdf" filename extension.
URL
A URL is required and specifies which documents are injected.
The URL is any one of the following:
  • A full path, as in https://www.mydomain.com/products.html
  • A partial path, as in https://www.mydomain.com/products
  • A URL that uses wild cards, as in https://www.mydomain.com/*.html
The URL value must not have any space characters in it. If the regexp option is used, the URL is treated like a regular expression.
value
A value is required and is used to either replace or add to existing field content. You can specify multiple values for the same field name. For example:
append keys https://www.mysite.com/travel/ summer , beach , sand
append keys https://www.mysite.com/travel/fare/*.html cheap tickets
In the above example, the words "summer, beach, sand" is appended to the "keys" field on all pages in the "/travel/" directory. The words "cheap tickets" is also appended to the "keys" field on all pages in the "/travel/fare/" directory.

Adding field injection definitions

You can use Injections to insert content into your web pages without the need to edit the pages themselves.
You can optionally use Test on the Injections page. You enter a test field name (for example, "title" or "body"), the original field value (for example, "Home Page"), and a test URL from your website. The resulting value is displayed for your reference. The current values are not altered during the test.
To add field injection definitions
  1. On the product menu, click Settings > Metadata > Injections .
  2. (Optional) On the Injections page, in the Test Field Injections area, enter the test field, the test original value, and test URL, and then click Test .
  3. In the Field Injection Definitions field, enter one injection definition per line.
  4. Click Save Changes .
  5. (Optional) Do any of the following:

About Attribute Loader

Use Attribute Loader to define additional input sources to augment data crawled from a website.
To use Attribute Loader, you may need to have it enabled in your account by your Adobe account representative or by Adobe Support.
You can use a data feed input source to access content that is stored in a form that is different from what is typically discovered on a website. You do this using one of the available crawl methods. Data from these sources can then be injected into data from crawled content.
After you add an Attribute Loader definition to the Staged Attribute Loader Definitions page, you can change any configuration setting except the Name values and Type values
The Attribute Loader page shows you the following information:
  • The name of defined Attribute Loader configuration that you have configured and added.
  • One of the following data source types for each connector that you have added:
    • Text - Simple "flat" files, comma-delimited, tab-delimited, or other consistently delimited formats.
    • Feed - XML feeds.
  • Whether the configuration is enabled or not for the next crawl and indexing.
  • The address of the data source.

How the attribute injection process works for Text and Feed configurations in Attribute Loader

Step
Process
Description
1
Download the data source.
For Text and Feed configurations, it is a simple file download.
2
Break down the downloaded data source into individual pseudo-documents.
For Text , each newline-delimited line of text corresponds to an individual document, and is parsed using the specified delimiter, such as a comma or tab.
For Feed , each document's data is extracted using a regular expression pattern in the following form:
<${Itemtag}>(.*?)</${Itemtag}>
Using Map on the Attribute Loader Add page, create a cached copy of the data and then create a list of links for the crawler. The data is stored in a local cache and is populated with the configured fields.
The parsed data is written to the local cache.
This cache is read later to create the simple HTML documents needed by the crawler. For example,
<html><head> <title>{title}</title> <meta name="{field}" content="{data}" /> ... </head><body> {body} </body></html>
The <title> element is only generated when a mapping exists to the Title metadata field. Similarly, the <body> element is only generated when a mapping exists to the Body metadata field.
Important : The assignment of values to the pre-defined URL meta tag is not supported.
For all other mappings, <meta> tags are generated for each field that has data found in the original document.
The fields for each document are added to the cache. For each document that is written to the cache, a link is also generated as in the following examples:
<a href="index:Adobe?key=<primary key field>\" /> <a href="index:Adobe?key=<primary key field>\" /> ....
The configuration's mapping must have one field identified as the Primary Key. This mapping forms the key that is used when data is fetched from the cache.
The crawler recognizes the URL index: scheme prefix, which can then access the locally cached data.
3
Crawl the cached document set.
The index: links are added to the crawler's pending list, and are processed in the normal crawl sequence.
4
Process each document.
Each link’s key value corresponds to an entry in the cache, so crawling each link results in that document’s data being fetched from the cache. It is then “assembled” into an HTML image that is processed and added to the index.

About configuring multiple Attribute Loaders

You can define multiple Attribute Loader configurations for any account.
When you add an Attribute Loader, you can optionally use the feature Setup Maps to download a sample of your data source. The data is examined for suitability.
Attribute Loader type
Description
Text
Determines the delimiter value by trying tabs first, then vertical-bars ( | ), and finally commas ( , ). If you already specified a delimiter value before you clicked Setup Maps , that value is used instead.
The best-fit scheme results in the Map fields being filled out with guesses at the appropriate Tag and Field values. Additionally, a sampling of the parsed data is displayed. Be sure to select Headers in First Row if you know that the file includes a header row. The setup function uses this information to better identify the resulting map entries.
Feed
Downloads the data source and performs simple XML parsing.
The resulting XPath identifiers are displayed in the Tag rows of the Map table, and similar values in Fields. These rows only identify the available data, and do not generate the more complicated XPath definitions. However, it is still helpful because it describes the XML data and identifies Itemtag.
Note: The Setup Maps function downloads the entire XML source to perform its analysis. If the file is large, this operation could time out.
When successful, this function identifies all possible XPath items, many of which are not desirable to use. Be sure that you examine the resulting Map definitions and remove the ones that you do not need or want.
The Setup Maps feature may not work for large XML data sets because its file parser attempts to read the entire file into memory. As a result, you could experience an out-of-memory condition. However, when the same document is processed at the time of indexing, it is not read into memory. Instead, large documents are processed “on the go,” and are not read entirely into memory first.

About the use of Preview when you add an Attribute Loader

Attribute Loader data is loaded prior to an Index operation.
At the time you add an Attribute Loader, you can optionally use the feature Preview to validate the data, as though you were saving it. It runs a test against the configuration, but without saving the configuration to the account. The test accesses the configured data source. However, it writes the download cache to a temporary location; it does not conflict with the main cache folder that the indexing crawler uses.
Preview only processes a default of five documents as controlled by Acct:IndexConnector-Preview-Max-Documents . The previewed documents are displayed in source form, as they are presented to the indexing crawler. The display is similar to a “View Source" feature in a Web browser. You can navigate the documents in the preview set using standard navigation links.
Preview does not support XML configurations because such documents are processed directly and not downloaded to the cache.

Adding an Attribute Loader definition

Each Attribute Loader configuration defines a data source and mappings to relate the data items defined for that source to metadata fields in the index.
To use Attribute Loader, you may need to have it enabled in your account by your Adobe account representative or by Adobe Support.
Before the effects of the new and enabled definition are visible to customers, rebuild your site index.
To add an Attribute Loader definition
  1. On the product menu, click Settings > Metadata > Attribute Loader .
  2. On the Stage Attribute Loader Definitions page, click Add New Attribute Loader .
  3. On the Attribute Loader Add page, set the configuration options that you want. The options that are available depend on the Type that you selected.
    Option
    Description
    Name
    The unique name of the Attribute Loader configuration. You can use alphanumeric characters. The characters "_" and "-" are also allowed.
    Type
    The source of your data. The data source type that you select affects the resulting options that are available on the Attribute Loader Add page. You can choose from the following:
    • Text
      Simple flat text files, comma-delimited, tab-delimited, or other consistently delimited formats. Each newline-delimited line of text corresponds to an individual document, and is parsed using the specified delimiter.
      You can map each value, or column, to a metadata field, referenced by the column number, starting at 1 (one).
    • Feed
      Downloads a master XML document that contains multiple "rows" of information.
    Data source type: Text
    Enabled
    Turns the configuration "on" for use. Or, you can turn "off" the configuration to prevent if from being used.
    Note : Disabled Attribute Loader configurations are ignored.
    Host Address
    Specifies the address of the server host where your data is located.
    If desired, you can specify a full URI (Uniform Resource Identifier) path to the data source document as in the following examples:
    https://www.somewhere.com/some_path/some_file.tsv
    or
    ftp://user:password@ftpserver.somewhere.com/some_path/some_file.csv
    The URI is broken down into the appropriate entries for the Host Address, File Path, Protocol, and, optionally, Username, and Password fields
    File Path
    Specifies the path to the simple flat text file, comma-delimited, tab-delimited, or other consistently delimited format file.
    The path is relative to the root of the host address.
    Protocol
    Specifies the protocol that is used to access the file. You can choose from the following:
    • HTTP
      If necessary, you may enter proper authentication credentials to access the HTTP server.
    • HTTPS
      If necessary, you may enter proper authentication credentials to access the HTTPS server.
    • FTP
      You must enter proper authentication credentials to access the FTP server.
    • SFTP
      You must enter proper authentication credentials to access the SFTP server.
    • File
    Timeout
    Specifies the timeout, in seconds, for FTP, SFTP, HTTP or HTTPS connections. This value must be between 30 and 300.
    Retries
    Specifies the maximum number of retries for failed FTP, SFTP, HTTP or HTTPS connections. This value must be between 0 and 10.
    A value of zero (0) will prevent retry attempts.
    Encoding
    Specifies the character encoding system that is used in the specified data source file.
    Delimiter
    Specifies the character that you want to use to delineate each field in the specified data source file.
    The comma character ( , ) is an example of a delimiter. The comma acts as a field delimiter that helps to separate data fields in your specified data source file.
    Select Tab? to use the horizontal-tab character as the delimiter.
    Headers in First Row
    Indicates that the first row in the data source file contains header information only, not data.
    Stale Days
    Sets the minimum interval between downloads of Attribute Loader data. Index-triggered downloads that occur within the download refresh frequency interval are ignored. When you set this value to the default of 1, Attribute Loader data does not download more than once within a 24 hour period. All Search indexes that occur within the download refresh frequency interval use the last data set that was downloaded.
    Map
    Specifies column-to-metadata mappings, using column numbers.
    • Column
      Specifies a column number, with the first column being 1 (one). To add new map rows for each column, under Action , click + .
      You do not need to reference each column in the data source. Instead, you can choose to skip values.
    • Field
      Defines the name attribute value that is used for each generated <meta> tag.
    • Metadata?
      Causes Field to become a drop-down list from which you can select defined metadata fields for the current account.
      The Field value can be an undefined metadata field, if desired. An undefined metadata field is sometimes useful to create content used by a Filtering Script .
    • Primary Key?
      Only one field is identified as the primary key. This field will be used as the "foreign key" to match the Attribute Loader data with the corresponding document in the index.
    • Strip HTML?
      When this option is checked, any HTML tags found in this field's data is removed.
    • Action
      Lets you add rows to the map or remove rows from the map. The order of the rows is not important.
    Data source type: Feed
    Enabled
    Turns the configuration "on" for use. Or, you can turn "off" the configuration to prevent if from being used.
    Note : Disabled Attribute Loader configurations are ignored.
    Host Address
    Specifies the address of the server host where your data is located.
    If desired, you can specify a full URI (Uniform Resource Identifier) path to the data source document as in the following examples:
    https://www.somewhere.com/some_path/some_file.tsv
    or
    ftp://user:password@ftpserver.somewhere.com/some_path/some_file.csv
    The URI is broken down into the appropriate entries for the Host Address, File Path, Protocol, and, optionally, Username, and Password fields.
    File Path
    Specifies the path to the master XML document that contains multiple "rows" of information.
    The path is relative to the root of the host address.
    Protocol
    Specifies the protocol that is used to access the file. You can choose from the following:
    • HTTP
      If necessary, you may enter proper authentication credentials to access the HTTP server.
    • HTTPS
      If necessary, you may enter proper authentication credentials to access the HTTPS server.
    • FTP
      You must enter proper authentication credentials to access the FTP server.
    • SFTP
      You must enter proper authentication credentials to access the SFTP server.
    • File
    Itemtag
    Identifies the XML element that you can use to identify individual XML lines in the data source file that you specified.
    For example, in the following Feed fragment of an Adobe XML document, the Itemtag value is record :
    <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE gsafeed PUBLIC "-//Google//DTD GSA Feeds//EN" ""> <gsafeed>      <header>           <datasource>marketplace</datasource>           <feedtype>incremental</feedtype>      </header>      <group action="add"> <record url=https://www.adobe.com/cfusion/marketplace_gsa/ index.cfm?event=marketplace.home&amp;marketplaceid=1 action="add" mimetype="text/html"displayurl="https://www.adobe.com/cfusion/marketplace/index.cfm?event=marketplace.home&amp;marketplaceid=1"> <metadata> <meta name="mp_mkt" content="1"/> <meta name="mp_logo" content="/images/marketplace/ dbreferenced/marketplaceicons/icn_air.png"/> <meta name="title" content="Adobe AIR Marketplace"/> <meta name="description" content="Discover new applications ..."/> </metadata> <content><![CDATA[<html><head><title>Adobe AIR Marketplace</title></head><body>Discover new applications ...</body></html>]]></cntent> </record> <record url=https://www.adobe.com/cfusion/marketplace_gsa/ index.cfm?event=marketplace.home&amp;marketplaceid=2 action="add" mimetype="text/html" displayurl="https://www.adobe.com/cfusion/ marketplace/index.cfm?event=marketplace.home&amp;marketplaceid=2"> <metadata> <meta name="mp_mkt" content="2"/> <meta name="mp_logo" content="/images/marketplace/ dbreferenced/marketplaceicons/icn_photoshop.png"/> <meta name="title" content="Adobe Photoshop Marketplace"/> <meta name="description" content="Extend your creative possibilities ..."/> </metadata> <content><![CDATA[<html><head><title>Adobe Photoshop Marketplace</title></head><body>Extend your creative possibilities ...</body></html>]]>/content> </record> ... <record> ... </record>      </group> </gsafeed>
    Cross-Reference Field Name
    Specifies a metadata field whose values are used as look-up "keys" into the Attribute Loader configuration's data. If no value is selected ( --None-- ), this configuration's data is not available for use in Ranking calculations ( Rules > Ranking Rules > Edit Rules ). When you select a value, this field's values are used to cross-reference site search/merchandising documents with this configuration's data.
    Stale Days
    Sets the minimum interval between downloads of Attribute Loader data. Index-triggered downloads that occur within the download refresh frequency interval are ignored. When you set this value to the default of 1, Attribute Loader data does not download more than once within a 24 hour period. All Search indexes that occur within the download refresh frequency interval use the last data set that was downloaded.
    Map
    Lets you specify XML-element-to-metadata mappings, using XPath expressions.
    • Tag
      Specifies an XPath representation of the parsed XML data. Using the example Adobe XML document above, under the option Itemtag, it could be mapped using the following syntax:
      /record/@displayurl -> page-url /record/metadata/meta[@name='title']/@content -> title /record/metadata/meta[@name='description']/@content -> desc /record/metadata/meta[@name='description']/@content -> body
      The above syntax translates as the following:
      • /record/@displayurl&nbsp;->&nbsp;page-url
        The displayurl attribute of the record element maps to the metadata field page-url .
      • /record/metadata/meta[@name='title']/@content&nbsp;->&nbsp;title
        The content attribute of any meta element that is contained inside a metadata element, that is contained inside a record element, whose name attribute is title , maps to the metadata field title .
      • /record/metadata/meta[@name='description']/@content&nbsp;->&nbsp;desc
        The content attribute of any meta element that is contained inside a metadata element, that is contained inside the record element, whose name attribute is description , maps to the metadata field desc .
      • /record/metadata/meta[@name='description']/@content&nbsp;->&nbsp;body
        The content attribute of any meta element that is contained within a metadata element, that is contained within the record element, whose name attribute is description , maps to the metadata field body .
      XPath is a relatively complicated notation. More information is available at the following location:
    • Field
      Defines the name attribute value that is used for each generated <meta> tag.
    • Metadata?
      Causes Field to become a drop-down list from which you can select defined metadata fields for the current account.
      The Field value can be an undefined metadata field, if desired. An undefined metadata field is sometimes useful to create content used by Filtering Script .
      When Attribute Loader processes XML documents with multiple hits on any map field, the multiple values are concatenated into a single value in the resulting cached document. By default, these values are combined using a comma delimiter. However, suppose that the corresponding Field value is a defined metadata field. In addition, that field has the Allow Lists attribute set. In this case, the field's List Delimiters value, which is the first delimiter defined, is used in the concatenation.
    • Primary Key?
      Only one field is identified as the primary key. This field will be used as the "foreign key" to match the Attribute Loader data with the corresponding document in the index.
    • Strip HTML?
      When this option is checked, any HTML tags found in this field's data is removed.
    • Action
      Lets you add rows to the map or remove rows from the map. The order of the rows is not important.
  4. (Optional) Click Setup Maps to download a sample of your data source. The data is examined for suitability.
  5. Click Add to add the configuration to the Attribute Loader Definitions page.
  6. On the Attribute Loader Definitions page, click rebuild your staged site index .
  7. (Optional) On the Attribute Loader Definitions page, do any of the following:

Editing an Attribute Loader definition

You can edit an existing Attribute Loader that you have defined.
To use Attribute Loader, you may need to have it enabled in your account by your Adobe account representative or by Adobe Support.
Not all Attribute Loader options are available for you to change, such as the Attribute Loader Name or Type from the Type drop-down list.
To edit an Attribute Loader definition
  1. On the product menu, click Settings > Metadata > Attribute Loader .
  2. On the Attribute Loader page, under the Actions column heading, click Edit for an Attribute Loader definition name whose settings you want to change.
  3. On the Attribute Loader Edit page, set the options you want.
    See the table of options under Adding an Attribute Loader definition .
  4. Click Save Changes .
  5. (Optional) On the Attribute Loader Definitions page, click rebuild your staged site index .
  6. (Optional) On the Attribute Loader Definitions page, do any of the following:

Copying an Attribute Loader definition

You can copy an existing Attribute Loader definition to use as the basis for a new Attribute Loader that you want to create.
To use Attribute Loader, you may need to have it enabled in your account by your Adobe account representative or by Adobe Support.
When copying an Attribute Loader definition, the copied definition is disabled by default. To enable or "turn on" the definition, you must edit it from the Attribute Loader Edit page, and select Enable .
To copy an Attribute Loader definition
  1. On the product menu, click Settings > Metadata > Attribute Loader .
  2. On the Attribute Loader page, under the Actions column heading, click Copy for an Attribute Loader definition name whose settings you want to duplicate.
  3. On the Attribute Loader Copy page, enter the new name of the definition.
  4. Click Copy .
  5. (Optional) On the Attribute Loader Definitions page, do any of the following:

Renaming an Attribute Loader definition

You can change the name of an existing Attribute Loader definition.
To use Attribute Loader, you may need to have it enabled in your account by your Adobe account representative or by Adobe Support.
To rename an Attribute Loader definition
  1. On the product menu, click Settings > Metadata > Attribute Loader .
  2. On the Attribute Loader page, under the Actions column heading, click Rename for Attribute Loader definition name that you want to change.
  3. On the Attribute Loader Rename page, enter the new name of the definition in the Name field.
  4. Click Rename .
  5. (Optional) On the Attribute Loader Definitions page, do any of the following:

Loading Attribute Loader data

You can download the configured Attribute Loader data into site search/merchandising.
The Data Load page shows the following information about the status of your last Attribute Loader Data Load operation:
Status field
Description
Status
Indicates the success or failure of the last data load attempt. Or, it displays the status of a data load operation that is already in progress.
Start Time
Displays the date and time that the last data load operation started.
Stop Time
Displays the completion date and time of the last data load operation. Or, it indicates the current data load operation is still in progress.
To load Attribute Loader data
  1. On the product menu, click Settings > Metadata > Attribute Loader .
  2. On the Attribute Loader Definitions page, click Load Attribute Loader Data .
  3. On the Attribute Loader Data Load page, do one of the following:
    • Click Start Load to start the load operation.
      During a data load operation, the Progress row provides information on its progress.
    • Click Stop Load to stop the load operation.
  4. Click Close to return to the Attribute Loader Definitions page.

Previewing Attribute Loader data

You can use Preview to view your most recently loaded Attribute Loader data.
The Row column in the table shows the number for each row of data, indicating the original order that the Attribute Loader values were loaded.
The remaining columns show the values that are associated with each entry.
If the table is empty, it means that you have not loaded any Attribute Loader data yet. You can close the Attribute Loader Data Preview page, and then load Attribute Loader data.
To preview Attribute Loader data
  1. On the product menu, click Settings > Metadata > Attribute Loader .
  2. On the Attribute Loader Definitions page, under the Actions column, click Preview for the configuration whose downloaded data you want to view.
  3. On the Attribute Loader Data Preview page, use the navigation and viewing options at the top and bottom of the page to view the data.
    Click any column heading in the table to sort the data in ascending or descending order.
  4. Do any of the following:
    • Click Download to Desktop to download and save the table as a .xlt file.
    • Close the page when you are finish previewing the Attribute Loader data and return to the previously viewed page.

Viewing the settings of an Attribute Loader definition

You can review the configuration settings of an existing Attribute Loader definition.
After an Attribute Loader definition is added to the Attribute Loader Definitions page, you cannot change its Type setting. Instead, you must delete the definition and then add a new one.
To use Attribute Loader, you may need to have it enabled in your account by your Adobe account representative or by Adobe Support.
To view the settings of an Attribute Loader definition
  1. On the product menu, click Settings > Metadata > Attribute Loader .
  2. On the Attribute Loader page, under the Actions column heading, click Edit for an Attribute Loader definition name whose settings you want to review or edit.

Viewing the log from the most recent Attribute Loader data load

You can use View Log to examine the Attribute Loader data log file of the most recent download process. You can also use the log view to monitor a running download.
To view the log from the most recent Attribute Loader data load
  1. On the product menu, click Settings > Metadata > Attribute Loader .
  2. On the Attribute Loader Definitions page, click View Log . Log page,
  3. On the Attribute Loader Data Log page, use the navigation and viewing options at the top and bottom of the page to view the log information.
  4. When you are finished, close the page to return to the Attribute Loader Definitions page.

Deleting an Attribute Loader definition

You can delete an existing Attribute Loader definition that you no longer need or use.
To use Attribute Loader, you may need to have it enabled in your account by your Adobe account representative or by Adobe Support.
To delete an Attribute Loader definition
  1. On the product menu, click Settings > Metadata > Attribute Loader .
  2. On the Attribute Loader Definitions page, under the Actions column heading, click Delete for the Attribute Loader definition name you want to remove.
  3. On the Attribute Loader Delete page, click Delete .