Adobe Experience Manager Connection Properties
| Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| properties | Yes | - | No | Configuration object | |
| server | Yes | - | No | The AEM repository URL. | "http://localhost:4502" |
| fetchACL | No | false | No | Set to true to fetch document ACLs for Pages' Closed User Groups. | true / false |
| useSlash | Yes | false | Yes | Set to true to use a "/" at the end of each node path for the .json requests. | true / false |
| excludeProperties | No | [ ] | Yes | List of properties to be excluded. | [ { "name": "propertyNameForExclude", "value": "expectedValueForExclude", "regex": false }, { "name": "propertyValueForExcludeWithRegex", "value": "expectedValueForExcludeWithRegex", "regex": true } ] |
| includeProperties | No | [ ] | Yes | List of properties to be included. | [ { "name": "propertyNameForInclude1", "value": "expectedValueForInclude1", "regex": false }, { "name": "propertyValueForIncludeWithRegex", "value": "expectedValueForIncludeWithRegex", "regex": true } ] |
| stopOnScanError | No | true | If set to true, the crawl will stop if there are errors during the scanning phase. | true / false | |
| scanExcludedItems | No | false | No | If set to true, scans excluded container items so documents inside them can be processed. | true / false |
| includes | No | [] | Yes | List of regular expressions to match documents to be included in the crawl. | [".*sales.*", ".*finance.*"] |
| excludes | No | [] | Yes | List of regular expressions to match documents to be excluded from the crawl. | [".*food.*", ".*drinks.*"] |
| idleConnectionTimeout | No | 3600000 | No | Maximum time in millisecond to keep a connection open. | 3600000 |
| maxConnections | No | 100 | No | Maximum number of connections to be opened. | 100 |
| maxConnectionsPerRoute | No | 10 | No | Maximum number of connections opened for the same target. | 10 |
| connectionTimeout | No | 15000 | No | Maximum time in milliseconds to wait for the connection. | 15000 |
| socketTimeout | No | 15000 | No | Maximum time in milliseconds to wait for a socket response. | 15000 |
| useThrottling | No | false | No | If set to true, enables connection throttling. | true / false |
| throttlingRate | No | 5000 | No | Time period in milliseconds to throttle the connection. | 5000 |
| throttlingConnectionRate | No | 500 | No | Maximum number of connections to be used during a throttling period. | 500 |
| maxRetries | No | 3 | No | Maximum number of retries for a failed document. | 3 |
| retryWaitTime | No | 5000 | No | Time in millisecond to wait before a retry. | 5000 |
| useProxy | No | false | No | Set to true to setup a proxy. | true / false |
| proxyHost | No | - | No | Required if useProxy is set to true. | "localhost" |
| proxyPort | No | - | No | Required if useProxy is set to true. | "8080" |
| proxySchema | No | - | No | Required if useProxy is set to true. | "http" |
| proxyUsername | No | - | No | Required if useProxy is set to true. | "myProxyUser" |
| proxyPassword | No | - | No | Required if useProxy is set to true. | "encrypted:AEB19E2B31D97E308BF9B3B35EE17ECEF94848249E1BD859D818DB89A6DABEFD" |
Create example
POST /aspire/_api/connections
{
"type": "adobe-experience",
"description": "AEM Test Connection",
"credential": "bb4f37ed-1a34-4715-a608-697b2a2c3601",
"properties": {
"server": "http://localhost:4502",
"fetchACL": false,
"useSlash": false,
"excludeProperties": [],
"includeProperties": [],
"stopOnScanError": true,
"scanExcludedItems": false,
"includes": [],
"excludes": [],
"idleConnectionTimeout": 3600000,
"maxConnections": 100,
"maxConnectionsPerRoute": 10,
"connectionTimeout": 15000,
"socketTimeout": 15000,
"useThrottling": false,
"maxRetries": 3,
"retryWaitTime": 5000,
"useProxy": false
}
}
Overview
Content Tools
Copyright © 2024 Accenture
