Create Connection
| Field | Optional | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| type | No | - | No | The value must be "filesystem". | "filesystem" |
| description | No | - | No | Name of the connection object. | "MyFileSystemConnection" |
| throttlePolicy | Yes | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
| properties | No | - | No | Configuration object | |
| url | No | - | No | Path of the base directory to crawl. All the seeds will be prefixed with this value to form the full path. All the seeds will be prefixed with this value to form the full path | "C:\\Directory" |
| ignoreSymLinks | Yes | false | No | If enabled symbolic links will not be processed and links in the root items will cause an error. | true / false |
| stopOnScanError | Yes | true | No | If enabled, the crawl will stop if there is an error on the scan phase. | true / false |
| indexContainers | Yes | false | No | Enable to index the directories. | true / false |
| scanRecursively | Yes | true | No | Enable to scan discovered items recursively. | true / false |
| staticAcl | Yes | [ ] | Yes | Static ACL configuration object | |
| name | No | - | No | Name of the static ACL. | "group1" |
| domain | Yes | "" | No | Domain of the static ACL. | "testDomain" |
| entity | Yes | "user" | No | Entity (user / group) represented by the static ACL. | "user" / "group" |
| access | Yes | "allow" | No | Access (allow / deny) granted by the ACL. | "allow" / "deny" |
Example
$action.getHelper().renderConfluenceMacro("$codeS$body$codeE")
Update connection
| Field | Optional | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| id | No | - | No | Id of the connection to update | "89d6632a-a296-426c-adb0-d442adcab4b0", |
| type | No | - | No | The value must be "filesystem". | "filesystem" |
| description | No | - | No | Name of the connection object. | "MyFileSystemConnection" |
| throttlePolicy | Yes | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
| properties | No | - | No | Configuration object | |
| url | No | - | No | Path of the base directory to crawl. All the seeds will be prefixed with this value to form the full path. All the seeds will be prefixed with this value to form the full path | "C:\\Directory" |
| ignoreSymLinks | Yes | false | No | If enabled symbolic links will not be processed and links in the root items will cause an error. | true / false |
| stopOnScanError | Yes | true | No | If enabled, the crawl will stop if there is an error on the scan phase. | true / false |
| indexContainers | Yes | false | No | Enable to index the directories. | true / false |
| scanRecursively | Yes | true | No | Enable to scan discovered items recursively. | true / false |
| staticAcl | Yes | [ ] | Yes | Static ACL configuration object | |
| name | No | - | No | Name of the static ACL. | "group1" |
| domain | Yes | "" | No | Domain of the static ACL. | "testDomain" |
| entity | Yes | "user" | No | Entity (user / group) represented by the static ACL. | "user" / "group" |
| access | Yes | "allow" | No | Access (allow / deny) granted by the ACL. | "allow" / "deny" |
Example
$action.getHelper().renderConfluenceMacro("$codeS$body$codeE")
Overview
Content Tools
Copyright © 2024 Accenture
