Alfresco Kafka

Connect Alfresco and Kafka to Aiimi Insight Engine to make the most of your data.

Kafka

Kafka Servers: Enter the Kafka server URLs you want to connect to.
- You can include ports if needed.
- Use commas to separate multiple values.
Application ID: Enter a unique ID for this source connector.
- Kafka uses this to manage the messages consumed by the connector. This stops repeat messages being replayed and ensures only new messages are consumed.

Changing this once the connector is running will have unintended side effects.

Topic Name: Enter the Kafka queue name you want to watch for messages.
Site ID: If you only need to crawl one site, enter the hyphenated site ID.
- For example: alfresco-site.
Process Records From: Enter a date to only process messages after that date. Anything before this date will be ignored.
Process Queue Limit: Enter the maximum number of batches that can be processed at one time.
- This can be adjusted to tune the performance of a deployed environment.
Queue Batch Size: Enter the maximum number of messages that will be processed together from a queue.
- If that number isn't reached within 60 seconds a partial batch will be processed.
Message Logging Enabled: If checked, the result of every Kafaka message will be logged. It identifies if an item is added to the queue for processing and if it isn't then the reason why is logged.

Alfresco

Instance Name: Enter the instance name to ensure it connects to the correct version.
- This is important when you have multiple versions of Alfresco running and logging messages to Kafka.
Select Credential: Select the Alfresco API Username and Password from the dropdown.
- This will need suitable service account privileges to access everywhere document are stored.
Root Domain: Enter the root domain for the instance you are connecting to.
- The root domain contains the multiple endpoints that need to be hit.
Domain Prefix: Enter the AD domain to prefix Groups and Users with when permissions are applied.
- The separating \ is automatically applied.
Parallel API Calls: Enter the maximum number of concurrent API calls that can be made to Alfresco.
- This can be adjusted to tune performance depending on the environment.
Result Path Prefix: Enter the string value that should be removed the Path displayed in the Result detail page.
1. This defaults to "/Company Home/Sites".
Security Markings Enabled: Check this to match any Alfresco security markings to configured security descriptors in Aiimi Insight Engine.
- This will apply permissions to items within Aiimi Insight Engine.
Lowercase Permissions: Check this to allow the permissions to be stored in Elastic with optional lowercasing.
Use Alfresco Groups: Check this if Alfresco does not use AD groups to control permissions. It ensures queries are made to get the specific Users attached to an Alfresco Group.

PreviousSource - Source NextAzure Blob Storage

Kafka

Kafka Servers: Enter the Kafka server URLs you want to connect to.

You can include ports if needed.
Use commas to separate multiple values.

Application ID: Enter a unique ID for this source connector.

Kafka uses this to manage the messages consumed by the connector. This stops repeat messages being replayed and ensures only new messages are consumed.

Changing this once the connector is running will have unintended side effects.

Topic Name: Enter the Kafka queue name you want to watch for messages.

Site ID: If you only need to crawl one site, enter the hyphenated site ID.

For example: alfresco-site.

Process Records From: Enter a date to only process messages after that date. Anything before this date will be ignored.

Process Queue Limit: Enter the maximum number of batches that can be processed at one time.

This can be adjusted to tune the performance of a deployed environment.

Queue Batch Size: Enter the maximum number of messages that will be processed together from a queue.

If that number isn't reached within 60 seconds a partial batch will be processed.

Message Logging Enabled: If checked, the result of every Kafaka message will be logged. It identifies if an item is added to the queue for processing and if it isn't then the reason why is logged.

Alfresco

Instance Name: Enter the instance name to ensure it connects to the correct version.

This is important when you have multiple versions of Alfresco running and logging messages to Kafka.

Select Credential: Select the Alfresco API Username and Password from the dropdown.

This will need suitable service account privileges to access everywhere document are stored.
For support setting up credentials use

Root Domain: Enter the root domain for the instance you are connecting to.

The root domain contains the multiple endpoints that need to be hit.

Domain Prefix: Enter the AD domain to prefix Groups and Users with when permissions are applied.

The separating \ is automatically applied.

Parallel API Calls: Enter the maximum number of concurrent API calls that can be made to Alfresco.

This can be adjusted to tune performance depending on the environment.

Result Path Prefix: Enter the string value that should be removed the Path displayed in the Result detail page.

This defaults to "/Company Home/Sites".

Security Markings Enabled: Check this to match any Alfresco security markings to configured security descriptors in Aiimi Insight Engine.

This will apply permissions to items within Aiimi Insight Engine.

Lowercase Permissions: Check this to allow the permissions to be stored in Elastic with optional lowercasing.

Use Alfresco Groups: Check this if Alfresco does not use AD groups to control permissions. It ensures queries are made to get the specific Users attached to an Alfresco Group.