Versions Compared

Key

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

Each Seed entity requires a reference to a Connector in order to be created. This page details how to create Connector using the Rest API

Panel
titleOn this page

Table of Contents

Create Connector


FieldOptionalDefaultMultipleNotesExample
typeNo-NoThe value must be the same as the type of the seed that will use this connector."filesystem"
descriptionNo-NoName of the connector object."MyFileSystemConnector"
artifactNo-NoThe mvn coordinates of the connector."com.accenture.aspire:aspire-filesystem-source"
propertiesNo-NoConfiguration object
debugYesfalseNoEnables the debug messagestrue / false
wDebugYesfalseNoEnables job logging.true / false
enableStatisticsYesfalseNoEnable to gather pipeline job statistics in the debug consoletrue / false
infoCacheSizeNo100NoThe size of the Source Info cache used by the connector200
mapCacheSizeNo100NoThe number of Storage maps kept in memory per seed200
setCacheSizeNo100NoThe number of Sets kept in memory per seed200
identityCacheSizeNo100NoThe number of identities kept in memory per seed.200
enableFetcherNotrueNoEnables document fetching for the seeds that use this connector.true / false
enableTextExtractNotrueNoEnables text extraction. By default, connectors use Apache Tika to extract text from downloaded documents. To apply special text processing to a downloaded document in the workflow, disable text extraction. The downloaded document is then available as a content stream.true / false
staticAclYes

[ ]

YesStatic ACL configuration object
nameNo-NoName of the static ACL."group1"
domainYes""NoDomain of the static ACL."testDomain"
entityYes"user"NoEntity (user / group) represented by the static ACL."user" / "group"
accessYes"allow"NoAccess (allow / deny) granted by the ACL."allow" / "deny"

Example

Saga_json
TitlePOST aspire/_api/connections
{
    "type": "filesystem",
    "description": "FileSystem Test Connector",
    "properties": {
        "url": "C:\\Directory",
        "ignoreSymLinks": true,
        "stopOnScanError": true,
        "indexContainers": true,
        "scanExcludedItems": true,
        "ignoreSymLinks": true,
        "includes": ".*\\.txt",
        "excludes": ".*\\.png",
        "staticAcl": [{
                "name": "test-user",
                "domain": "test-domain",
                "entity": "user",
                "access": "allow"
            }, {
                "name": "test-group",
                "domain": "",
                "entity": "group",
                "access": "deny"
            }
        ]
    }
}