Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The File System connector The Group Expansion connector will crawl content and expand identities from the file system location. Identity Cache

Easy Heading Free
navigationTitle

Paneltitle

On this

pagetoc

Page
navigationExpandOptionexpand-all-by-default

Introduction


The File System Group Expansion connector can scan and fetch the directories and documents of a file system.crawl and expand identities from the Identity Cache. The Identity Cache is part of the Aspire crawl state database. Typically, Elasticsearch is used as a repository for crawl state database and the Identity Cache is stored in the index aspire-identitycache. The Identity Cache works for connectors as a storage for their identities, like groups and users. For example, we can find in the Identity Cache: LDAP users and groups, Confluence users and groups etc. The purpose of the Group Expansion Connector is to crawl identities for required seeds, do group expansion and publish the expanded identities. The connector also supports custom mapping configuration for selected seeds.

What is group expansion

Let us use this example: if User1 is part of the group Grp1 and the group Grp1 is part of the group Grp0, then the result of the group expansion is updated information for User1. Instead of just having the group Grp1 in the user information, we will have now the list of 2 groups there: Grp1 and Grp0. This is what expanding groups means.

What is custom mapping

Some seeds require custom mapping for key attribute names. For example, we may need to map a username coming from Confluence connector to the standard AD name. We support two kinds of mapping:

  • local: we can define which attribute name from the current identity should be used as an identity key.
  • external: we can define the seed and mapping attributes to fetch identities for the purpose of mapping from. This would be typically LDAP/AD seeds.

Environment and Access Requirements


Repository Support

The Group Expansion connector crawls identities from the identity cache. The Identity Cache is part of the Aspire crawl state database. Typically, Elasticsearch is used as a repository for crawl state database and the Identity Cache is stored in the index aspire-identitycache.

Account Privileges

Not relevant here

Environment Requirements

No special requirements here

Environment and Access Requirements

Repository Support

The File System supports crawling the following the repositories

RepositoryVersionConnector VersionWindowsAll5.0LinuxAll5.0
Info

This component has been officially tested on local Windows and Linux.

Account Privileges

For the File System connector to be able to crawl the Aspire Worker nodes must be run with an account with read access to the directory to crawl.

Environment Requirements

The Aspire Worker nodes must be running in the same machine where the file system repository is located or at least have access in the case of a file share. 

Framework and Connector Features


Framework Features

NameSupported
Content Crawlingyes
Identity Crawlingno
Snapshot-based IncrementalsIncremental syes
Non-snapshot-based IncrementalsIncremental sno
Document Hierarchyyesno

Connector Features

The File System Group Expansion connector has the following features:

  • Document Seeds filtering using include and exclude regex patterns.lists.
  • Custom mapping configuration for selected seedsStatic acls can be added the documents crawled

Content Crawled


The File System connector is able to Group Expansion connector can crawl the following objects:

NameType Relevant MetadataContent Fetch & ExtractionDescription
FolderSeedcontainerLast Modified Date
NAThe directories of the file system. Each directory will be scanned to retrieve more directories or files
Filedocument
  • Last Modified Date
  • Data size
yesThe files contained by the directories in the crawled file system.

Limitations

The File System Connector has the following limitations:

The connector does not retrieve the acls of the crawled documents.
identities are grouped by seeds, and we crawl identities belonging to seeds
Identity
  • key
  • source
  • groups
NAThe identities with expanded groups

Limitations


No limitations defined