Versions Compared

Key

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


REST API Connectors' configuration guidelines can be found here.

REST API Connectors' endpoints can be found here.


Azure Identity Connectors' "type" must always be specified as "azure-identity".

You must also specify the "artifact" parameter that describes the coordinates for the connector which by default are "com.accenture.aspire:aspire-azure-identity-source".

Azure Identity Connectors' property "addHierarchy" .must always be set to false if specified, since Azure Identity Connectors do not support hierarchy.

Azure Identity Connectors' property "retriesEnabled" must always be set to false if specified, since Azure Identity Connectors do not support failed documents reprocessingProperties specific to the Azure Identity Connector are described below.


Panel
titleOn this page

Table of Contents

Usage example


Saga_json
TitlePOST /aspire/_api/credentials
{
	"type": "azure-identity",
	"description": "Azure Identity Connector Test",
	"artifact": "com.accenture.aspire:aspire-azure-identity-source",
	"properties": {
		"debug": true,
		"wDebug": false,
		"enableStatistics": false,
		"infoCacheSize": 100,
		"mapCacheSize": 100,
		"setCacheSize": 100,
		"identityCacheSize": 100,
		"enableFetcher": true,
		"enableTextExtract": true,
		"extractTextConfiguration": true,
		"extractTextMaxSize": "20971520",
		"extractTimeout": 180000,
		"xmlMaxDepth": 100,
		"structuredText": false,
		"tikaConfig": "",
		"pdfParserProperties": true,
		"enableAutoSpace": true,
		"suppressDuplicateOverlappingText": false,
		"extractAnnotationText": true,
		"sortByPosition": false,
		"extractAcroFormContent": true,
		"extractInlineImages": false,
		"extractUniqueInlineImagesOnly": true,
		"enable-non-text-filter": true,
		"enableFetchForNonText": true,
		"non-text-document": true,
		"nonTextDocumentsExtensions": "jpg,jpeg,gif,png,tif,mp3,mp4,mpg,mpeg,avi,mkv,wav,bmp,swf,war,rar,tgz,dll,exe,class",
		"metadataMap": [
			{
				"from": "fieldA",
				"to": "destA"
			},
			{
				"from": "fieldB",
				"to": "destB"
			}
		],
		"addHierarchy": false,
		"hierarchyCacheSize": 5000,
		"scanThreads": 10,
		"scanQueue": 50,
		"processThreads": 20,
		"processQueue": 200,
		"deleteCompleteQueueEntries": false,
		"flushSyncTime": "15s",
		"deleteCheckAfterErrors": "ALWAYS",
		"maxIdentitiesTimestamp": 3,
		"workflowErrorTolerant": true,
		"retriesEnabled": false
	

Azure Identity Credentials Properties

FieldRequiredDefaultMultipleNotesExamplepropertiesYes-NoConfiguration objectdebugNofalseNoThe Client Id to be used to connect to Azure."dd1bc268-8b54-4ea3-b43d-a15b665d04de"wDebugNofalseNoThe Client Secret corresponding to the specified Client Id."PZhbltkGdXEAYJl3fn9een1R1bTlrHClNSm8U3QtEet="enableStatisticsNofalseNoinfoCacheSizeNoNomapCacheSizeNoNosetCacheSizeNoNoidentityCacheSizeNoNoenableTextExtractNoNoextractTextConfigurationNoNoextractTextMaxSizeNoNoextractTimeoutNoNoxmlMaxDepthNoNostructuredTextNoNotikaConfigNoNopdfParserPropertiesNoNoenableAutoSpaceNoNosuppressDuplicateOverlappingTextNoNoextractAnnotationTextNoNosortByPositionNoNoextractAcroFormContentNoNoextractInlineImagesNoNoextractUniqueInlineImagesOnlyNoNoenable-non-text-filterNoNonon-text document filteringenableFetchForNonTextNoNoopen data stream for ...non-text-documentNoNoidentify by, true =extensions, false=listnonTextDocumentsExtensionsNoNononTextDocumentsNoNoNoNoNoNoNoNoNoNo

Usage example

Saga_json
TitlePOST /aspire/_api/credentials
{
  "type": "azure-identity",
  "description": "Azure Identity Credentials Test",
   "properties": { 
       "clientId": "dd1bc268-8b54-4ea3-b43d-a15b665d04de",
        "clientSecret": "PZhbltkGdXEAYJl3fn9een1R1bTlrHClNSm8U3QtEet="
   }
}