Page History
Create Credential
Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| type | Yes | - | No | The value must be "dbconnectordb-server". | "dbconnectordb-server" |
| description | Yes | - | No | Name of the credential object. | "Database ServerCredentialDBConnector" |
| properties | Yes | - | No | Configuration object | |
| "credentialType" | yes | - | No | It can be basic or kerberos | "basic" |
| "user" | yes | - | No | The authorized user | "username" |
| "password" | yes | - | No | User password | "encrypted:8DBA..." |
Example
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"type": "<Connector Type>db-server",
"description": "<Connectordb-server Name> Credential",
"properties": {
"credentialType": "basic",
"user": "username",
"password": "encrypted:8DBA..."
}
} |
Update Credential
Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| id | Yes | - | No | ID of the credential to update. | "2f2876692a5ca234-d163e328-4e354d40-ad17bb2a-6bbfe9df37782df3e550b065" |
| description | Yes | - | No | Name of the credential object. | "Database ServerCredentialDBConnector Credential" |
| properties | Yes | - | No | Configuration object | |
| "credentialType" | Yes | - | No | It can be basic or kerberos. | "kerberos" |
| "kerberosUser" | Yes | - | No | Kerberos username. | "username" |
| "keytabFile" | Yes | - | No | Path to the Keytab file. | "C:\\keytabFilePath" |
| "externalClasspath" | No | - | No | The path of the folder where other needed files are located. | "C:\\externamClasspath" |
| "hadoopResourceFiles" | No | - | No | The path to hadoop files | [ ] |
Example
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"id": "2a5ca234-e328-4d40-bb2a-2df3e550b065",
"type": "db-server",
"description": "<Connector Name>DBConnector Credential",
"throttlePolicy": null,
"properties": {
"credentialType": "kerberos",
"kerberosUser": "username",
"keytabFile": "C:\\keytabFilePath",
"externalClasspath": "C:\\externamClasspath",
"hadoopResourceFiles": []
}
} |
Create Connection
Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| type | Yes | - | No | The value must be dbconnector | dbconnector |
| description | Yes | - | No | Name of the connection object. | "MyDatabase ServerConnection" |
| throttlePolicy | No | - | No | ID of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
| routingPolicies | No | [ ] | Yes | The IDs of the routing policies that this connection will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
| properties | Yes | - | No | Configuration object | |
Example
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"type": "<Connector Type>",
"description": "<Connector Name> Test Connector",
"properties": {
}
} |
Update Connection
Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| id | Yes | - | No | Id of the connection to update | "89d6632a-a296-426c-adb0-d442adcab4b0", |
| description | No | - | No | Name of the connection object. | "My |
| throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
| routingPolicies | No | [ ] | Yes | The ids of the routing policies that this connection will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
| properties | Yes | - | No | Configuration object | |
Example
| Code Block | ||
|---|---|---|
| ||
{
"id": "89d6632a-a296-426c-adb0-d442adcab4b0",
"description": "<Connector Name> Test Connector",
"properties": {
}
} |
Create Connector Instance
For the creation of the Connector object using the Rest API check this page
Create Seed
Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| seed | Yes | - | No | <seed description> | |
| type | Yes | - | No | The value must be dbconnector. | dbconnector |
| description | Yes | - | No | Name of the seed object. | "My Database Server Seed" |
| connector | Yes | - | No | The ID of the connector to be used with this seed. The connector type must match the seed type. | "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31" |
| connection | Yes | - | No | The ID of the connection to be used with this seed. The connection type must match the seed type. | "602d3700-28dd-4a6a-8b51-e4a663fe9ee6" |
| workflows | No | [ ] | Yes | The IDs of the workflows that will be executed for the documents crawled. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
| throttlePolicy | No | - | No | ID of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
| routingPolicies | No | [ ] | Yes | The IDs of the routing policies that this seed will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
| tags | No | [ ] | Yes | The tags of the seed. These can be used to filter the seed | ["tag1", "tag2"] |
| properties | Yes | - | No | Configuration object | |
Example
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"type": "<Connector Type>",
"seed": "directory",
"connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
"description": "<connector>_Test_Seed",
"throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
"routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
"connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
"workflows": ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
"tags": ["tag1", "tag2"],
"properties": {
}
} |
Update Seed
Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| ID | Yes | - | No | ID of the seed to update. | "2f287669-d163-4e35-ad17-6bbfe9df3778" |
| seed | No | - | No | <seed description> | |
| description | No | - | No | Name of the seed object. | "MyDatabase ServerSeed" |
| connector | No | - | No | The ID of the connector to be used with this seed. The connector type must match the seed type. | "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31" |
| connection | No | - | No | The ID of the connection to be used with this seed. The connection type must match the seed type. | "602d3700-28dd-4a6a-8b51-e4a663fe9ee6" |
| workflows | No | [ ] | Yes | The IDs of the workflows that will be executed for the documents crawled. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
| workflows.add | No | [ ] | Yes | The IDs of the workflows to add. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
| workflows.remove | No | [ ] | Yes | The IDs of the workflows to remove. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
| throttlePolicy | No | - | No | ID of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
| routingPolicies | No | [ ] | Yes | The IDs of the routing policies that this seed will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
| routingPolicies.add | No | [ ] | Yes | The IDs of the routingPolicies to add. | ["b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
| routingPolicies.remove | No | [ ] | Yes | The IDs of the routingPolicies to remove. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7"] |
| tags | No | [ ] | Yes | The tags of the seed. These can be used to filter the seed | ["tag1", "tag3"] |
| tags.add | No | [ ] | Yes | The tags to add | ["tag4"] |
| tags.remove | No | [ ] | Yes | The tags to remove | ["tag2"] |
| properties | Yes | - | No | Configuration object | |
Example
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"id": "2f287669-d163-4e35-ad17-6bbfe9df3778",
"seed": "<seed example>",
"connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
"description": "<connector>_Test_Seed",
"throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
"routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
"connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
"workflows": ["b255e950-1dac-46dc-8f86-1238b2fbdf27", "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
"tags": ["tag", "tag2"],
"properties": {
}
} |
Overview
Content Tools