Versions Compared

Old Version 1

changes.mady.by.user Ricardo Fonseca

Saved on

compared with

New Version Current

changes.mady.by.user Ricardo Fonseca

Saved on

Key

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


REST API Seeds configuration guidelines can be found here.

Amazon S3 Adobe Experience Manager Connector Seeds "type" must always be specified as "s3".Amazon S3 Connector Seeds "seed" will be the path to be crawled. It can be a bucket, folder or fileadobe-experience".

Properties specific to the Amazon S3 Adobe Experience Manager Connector Seeds are described below.


Easy Heading Free
navigationTitleOn this Page
navigationExpandOptionexpand-all-by-default

Amazon S3

Adobe Experience Manager Seed Properties

FieldRequiredDefaultMultipleNotesExample
propertiesNo-NoConfiguration object
seedYes-NoThe path to be crawled. It can be a bucket, folder or file."/myBucket/myFolder"
processSplitFilesNofalseNoIf set to true, files that are split are treated as a single document instead of multiple documents.
true / false
splitPatternsNo[]YesList of regular expressions to match folders that contain split files.[".*splitted.*",".*split.*"]
Placeholder value for seeds. Normally set as  "aem_seed"
"aem_seed"
docTypeYes-NoDocument type can be either "page" or "asset".
"page" / "asset"
crawlPageNo-NoRequired if docType is "page". Set to true if docType is "page".true
pagePathNo-NoPath to recursively crawl pages. Leave empty to crawl from the server root. Required if docType is "page"."/content/we-retail"
processPageRootNo-NoSet to true to enable processing of roots. Required if docType is "page".true / false
fetchPageNo-NoSet to true to enable fetching pages' content. Required if docType is "page".true / false
crawlPageDetailsNo-NoSet to true to enable retrieving a JSON selector to get additional metadata during the scanning phase. Required if docType is "page".true / false
crawlAssetNo-NoRequired if docType is "asset". Set to true if docType is "asset".
true
assetPathNo-NoPath to recursively crawl assets. Leave empty to crawl from the server root. Required if docType is "asset"."/content/dam/we-retail"
processAssetRootNo-NoSet to true to enable processing of roots. Required if docType is "asset".true / false
fetchAssetNo-NoSet to true to enable fetching pages' content. Required if docType is "asset".true / false
crawlAssetDetailsNo-NoSet to true to enable retrieving a JSON selector to get additional metadata during the scanning phase. Required if docType is "asset".true / false

Usage example (Pages)

Usage example

Code Block
themeRDark
titlePOST /aspire/_api/seeds
{
	"seed": "aem_seed",
	"type": "adobe-experience",
	"description": "AEM Test Seed Pages",
	"connector": "b70cea79-c5b7-4d30-9c44-73ad17e58dab",
	"connection": "e7937e58-d412-450a-b611-e40e2ae5bb27",
	"workflows": [],
	"tags": [],
	"properties": {
		"seed": "aem_seed",
		"docType": "page",
		"crawlPage": true,
		"pagePath": "/content/we-retail",
		"processPageRoot": false,
		"fetchPage": false,
		"crawlPageDetails": false
	}
}

Usage example (Assets)

Code Block
themeRDark
titlePOST /aspire/_api/seeds
{
 	"seed": "aem_seed/myBucket/myFolder",
	"type": "s3adobe-experience",
	"description": "AmazonAEM S3Test Seed TestAssets",
	"connector": "187ae173b70cea79-32c2c5b7-48fe4d30-b4fe9c44-1b6eea02f16673ad17e58dab",
	"connection": "8f3233a9e7937e58-4c8dd412-4520450a-b335b611-ea1d9433720ee40e2ae5bb27",
	"workflows": [],
	"tags": [], 
	"properties": {
		"seed": "aem_seed",
		"docType": "asset",
		"crawlAsset": true,
		"assetPath": "/content/myBucket/myFolder"dam/we-retail",
		"processAssetRoot": false,
		"processSplitFilesfetchAsset": truefalse,
		"splitPatternscrawlAssetDetails": []false
	}
}