Open topic with navigation

# Identifiers

The `identifiers` fetch action retrieves a list of documents that are present in the repository and generates an identifier for each document. This action might be used by front end applications for providing an interface to browse a repository.

The action returns identifiers for only those documents that meet the requirements defined in the task configuration. For example, if you use configuration parameters to exclude certain Web pages, the connector does not return identifiers for those Web pages.

TIP:

The `identifiers` fetch action does not expand container files, and does not provide identifiers for sub-files.

Type: Asynchronous

Parameter Name | Description | Required
--- | --- | ---
`Config` | A base-64 encoded configuration. The configuration parameters that are set override the same parameters in the connector's configuration file. | No
`ConfigSection` | The name of the configuration file section that contains the task settings. | Yes
`ContainersOnly` | A Boolean value (default false) that specifies whether to return only those items that represent containers. | No
`FilterTypes` | A comma-separated list of the types of items to return identifiers for. If you omit this parameter, the action returns items of all types. | No
`Identifiers` | A comma-separated list of identifiers. The action returns identifiers (and status information if supported) for these items and their ancestors, but does not return descendant items (to do this, set the `ParentIdentifiers` parameter instead). | Set this parameter or `ParentIdentifiers`
`IdentifiersAction` | The name of an action to perform on the returned identifiers. Only the `collect` fetch action is available. If the action you specify would require additional parameters, specify them as parameters to this action. | No
`MaxDepth` | The maximum depth that the connector crawls in the repository (from `ParentIdentifiers`). The default maximum depth is 1. To specify no limit, set this parameter to `0` (zero). Be aware that if you increase the maximum depth or specify an unlimited maximum depth, the action could take a long time to complete. | No
`ParentIdentifiers` | A comma-separated list of identifiers. The action returns identifiers (and status information if supported) for these items, and for ancestors and descendants of these items. To specify the root of the repository, set this parameter to `ROOT`. | Set this parameter or `Identifiers`
`ShowAncestors` | A Boolean value (default true) that specifies whether to return the identifiers of ancestors for items specified by `ParentIdentifiers` or `Identifiers`. The action returns parent items up to the root of the repository. | No
`ShowAttributes` | A Boolean value (default true) that specifies whether to show attributes in the response. | No
`ShowDocStatus` | A Boolean value (default false) that specifies whether to show status information. This can include the ingestion status for each document and the modification history for items in the repository. | No
`ShowNames` | A Boolean value (default true) that specifies whether the response shows a display name for each item (if one is available). | No
`ShowTypes` | A Boolean value (default true) that specifies whether the response shows the type of item that each identifier represents. | No
`Override_Config_Parameters` | Any other action parameters that you set override settings in the connector's configuration file. For example:
    /action=fetch&fetchaction=...
                 &[Section]Parameter=Value
where `[Section]` (optional) is the name of a configuration file section, `Parameter` is the name of a configuration parameter, and `Value` is the parameter value. | No

## Example

The following example sends the `identifiers` fetch action to the connector. The connector returns the items that it finds by crawling the site from the URL specified in the task configuration:

    http://localhost:1234/action=Fetch&FetchAction=Identifiers
                                      &ConfigSection=MyTask
                                      &ParentIdentifiers=ROOT

## Response

The `fetch` action is asynchronous, so it returns a token. You can use the token with the `QueueInfo` action to retrieve the response.

    <autnresponse>
       <action>FETCH</action>
       <response>SUCCESS</response>
       <responsedata>
          <documentcounts>
             <documentcount errors="0" seen="4" task="MYTASK"/>
          </documentcounts>
          <fetchaction>IDENTIFIERS</fetchaction>
          <identifiers parent_identifier="ROOT">
             <identifier attributes="container,document" name="https://www.mydomain.com/" type="Page">[ROOT_IDENTIFIER]</identifier>
          </identifiers>
          <identifiers parent_identifier="[ROOT_IDENTIFIER]">
             <identifier attributes="container,document" name="https://www.mydomain.com/page1" type="Page">[PAGE1_IDENTIFIER]</identifier>
             <identifier attributes="container,document" name="https://www.mydomain.com/page2" type="Page">[PAGE2_IDENTIFIER]</identifier>
             <identifier attributes="container" name="https://www.mydomain.com/page3" type="Canonical Link">[PAGE3_IDENTIFIER]</identifier>
          </identifiers>
       </responsedata>
    </autnresponse>

The response contains an `<identifiers parent_identifier="...">` element for each of the identifiers passed to the action in the `ParentIdentifiers` or `Identifiers` action parameter. If you use the `ParentIdentifiers` action parameter and set the `MaxDepth` action parameter to a value greater than `1`, the response also contains an `<identifiers parent_identifier="...">` element for descendant items that have child identifiers, down to the requested depth. The `parent_identifier` attribute specifies the identifier of the item. These elements can also include the following attributes:

- `self="true"` indicates that this is one of the identifiers you passed to the action in the `ParentIdentifiers` or `Identifiers` parameter.
- `ancestor="true"` indicates that this item is an ancestor of one of the identifiers you passed to the action in the `ParentIdentifiers` or `Identifiers` parameter. You can hide these elements by setting the action parameter `ShowAncestors=False`.
- `descendant="true"` indicates that this item is a descendant of one of the identifiers you passed to the action in the `ParentIdentifiers` parameter. You can limit the number of descendants that are returned by setting the action parameter `MaxDepth`.

Each `<identifiers parent_identifier="...">` element contains `<identifier ...>` elements for items that are direct descendants of the parent item. An `<identifier ...>` element provides the following attributes:

- `name` - a display name for the item (if one is available).

- `attributes` - contains a comma-separated list of attributes for the item.

  - If an item has the `container` attribute it is an item that can contain other items. To retrieve the identifiers of the child items, increase the value of `MaxDepth` or run the action again, using the identifier of the container as the value of the `ParentIdentifiers` action parameter.
  - If an item has the `document` attribute it is a file or has metadata that can be ingested.

- `type` - the type of item that the identifier represents.

The `identifiers` action for the Web Connector can return the following types:

Type | Possible Attributes | Description | Display Name | Child Identifier Types
--- | --- | --- | --- | ---
`Page` | `container`, `document` | A page represents a web resource. Pages that have the `container` attribute are crawled by the (synchronize) fetch action for links to other pages. Pages that have the `document` attribute are ingested by the (synchronize) fetch action. | URL | Page, Canonical Link
`Canonical Link` | `container` | The item is a page but it has a canonical link to another page, either in the HTTP headers that are returned or the `<head>` section of the page. If a page has a canonical link to another page (and IgnoreCanonicalLinks is set to `False`), the connector only follows the canonical link and does not crawl other links that exist on the page or ingest the page. | URL | Page, Canonical Link

© 2018 EntIT Software LLC, a Micro Focus company | Send documentation feedback to Micro Focus Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm