alfresco.platform.cic_connector role – Install the Content Intelligence Connector

Note

This role is part of the alfresco.platform collection (version 0.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install alfresco.platform.

To use it in a playbook, specify: alfresco.platform.cic_connector.

Entry point main – Install the Content Intelligence Connector

Synopsis

  • This role installs the Content Intelligence Connector live-ingester and nucleus-sync services (started and enabled). The bulk-ingester service is installed only when cic_connector_alfresco_db_url is set, and is not started automatically.

Parameters

Parameter

Comments

cic_connector_activemq_redelivery_back_off_multiplier

float

Multiplier applied when broker-side exponential backoff is enabled

Default: 5.0

cic_connector_activemq_redelivery_initial_redelivery_delay_ms

integer

Broker-side initial redelivery delay in milliseconds

Default: 1000

cic_connector_activemq_redelivery_maximum_redeliveries

integer

Broker-side maximum redeliveries applied to every JMS consumer

Default: 6

cic_connector_activemq_redelivery_use_exponential_back_off

boolean

Whether broker-side redelivery uses exponential backoff

Choices:

  • false ← (default)

  • true

cic_connector_alfresco_activemq_password

string

Password for the ActiveMQ server

Default: "None"

cic_connector_alfresco_activemq_url

string / required

URL of the ActiveMQ server

cic_connector_alfresco_activemq_username

string

Username for the ActiveMQ server

Default: "None"

cic_connector_alfresco_auth_type

string

Authentication type the Live Ingester uses against the Alfresco server. Use “basic” (username/password) or a non-basic value (e.g. “oauth2”) to authenticate with a client id/secret. Only applies to the Live Ingester; Nucleus Sync always uses basic auth.

Default: "basic"

cic_connector_alfresco_base_url

string / required

Base URL of the Alfresco server (required for Nucleus Sync)

cic_connector_alfresco_client_id

string

Client ID for the Alfresco server (required when cic_connector_alfresco_auth_type is not basic)

cic_connector_alfresco_client_secret

string

Client secret for the Alfresco server (required when cic_connector_alfresco_auth_type is not basic)

cic_connector_alfresco_db_password

string

Password for the database for the Alfresco server (required for the Bulk Ingester)

Default: "None"

cic_connector_alfresco_db_url

string

URL of the database for the Alfresco server (required for the Bulk Ingester)

Default: "None"

cic_connector_alfresco_db_username

string

Username for the database for the Alfresco server (required for the Bulk Ingester)

Default: "None"

cic_connector_alfresco_grant_type

string

OAuth grant type used when authenticating to the Alfresco server with a client id/secret

Default: "client_credentials"

cic_connector_alfresco_password

string / required

Password for the Alfresco server (required for Nucleus Sync)

cic_connector_alfresco_sfs_url

string / required

URL of the Shared File Store for the Alfresco server

cic_connector_alfresco_token_url

string

OAuth token endpoint for the Alfresco server (required when cic_connector_alfresco_auth_type is not basic)

cic_connector_alfresco_username

string / required

Username for the Alfresco server (required for Nucleus Sync)

cic_connector_alfresco_version_override

string

Alfresco server version to override Discovery API detection (otherwise the Alfresco Discovery API is queried at Live Ingester startup)

cic_connector_application_sourceid

string / required

ID of the source Application as defined in the Content Intelligence service

cic_connector_artifact_default_version

string

Default version for all Content Intelligence Connector artifacts unless specified otherwise

cic_connector_artifact_password

string

Password for the artifact repository

cic_connector_artifact_repository_url

string

Base URL of the Nexus repository to download the Content Intelligence Connector artifacts from

cic_connector_artifact_username

string

Username for the artifact repository

cic_connector_bulk_events_dead_letter_enabled

boolean

Whether bulk-ingester events that fail processing on the Live Ingester are routed to a dead-letter queue

Choices:

  • false ← (default)

  • true

cic_connector_bulk_events_dead_letter_uri

string

Dead-letter destination URI for bulk-ingester events

Default: "activemq:queue:ActiveMQ.DLQ"

cic_connector_bulk_events_maximum_redeliveries

integer

Maximum redelivery attempts for bulk-ingester events before dead-lettering

Default: 6

cic_connector_bulk_events_redelivery_delay_ms

integer

Delay in milliseconds between bulk-ingester event redelivery attempts

Default: 1000

cic_connector_bulk_ingester_artifact_version

string

Version of the Content Intelligence Connector Bulk Ingester artifact

cic_connector_bulk_ingester_node_from_id

integer

Starting node ID, inclusive, for the Bulk Ingester

Default: 0

cic_connector_bulk_ingester_node_to_id

integer

Ending node ID, inclusive, for the Bulk Ingester

Default: 20000000000

cic_connector_bulk_ingester_publisher_endpoint

string

ActiveMQ queue the Bulk Ingester publishes ingestion events to (must match the Live Ingester’s endpoint)

Default: "activemq:queue:bulk-ingester-events"

cic_connector_events_subscription_durable

boolean

Whether the Live Ingester subscribes to repo events as a durable topic consumer

Choices:

  • false

  • true ← (default)

cic_connector_events_subscription_name

string

Durable subscription name and JMS clientId; must remain stable across restarts

Default: "LiveIngesterSubscription"

cic_connector_java_bin_path

string

Path to the Java binary

Default: "/opt/java/bin/java"

cic_connector_java_home_path

string

Path to the Java home directory

Default: "/opt/java"

cic_connector_jms_transacted

boolean

Whether the Live Ingester’s JMS consumer session is transactional

Choices:

  • false

  • true ← (default)

cic_connector_jms_transaction_manager

string

Spring bean reference used as the Live Ingester’s JMS transaction manager

Default: "#jmsTransactionManager"

cic_connector_live_ingester_artifact_version

string

Version of the Content Intelligence Connector Live Ingester artifact

cic_connector_live_ingester_port

integer

Port for the Content Intelligence Connector Live Ingester service

Default: 8080

cic_connector_nucleus_base_url

string / required

Base URL of the Nucleus service

cic_connector_nucleus_idp_base_url

string / required

Base URL of the Nucleus IDP service

cic_connector_nucleus_sync_artifact_version

string

Version of the Content Intelligence Connector Nucleus Sync artifact

cic_connector_nucleus_sync_auth_alfresco_type

string

Alfresco authentication type for Nucleus Sync

Default: "basic"

cic_connector_nucleus_sync_auth_hx_type

string

Hyland Experience authentication type for Nucleus Sync

Default: "oauth2"

cic_connector_nucleus_sync_cron_expression

string

Cron expression controlling how often Nucleus Sync runs

Default: "0 0 0 * * *"

cic_connector_nucleus_sync_enabled_sync

boolean

Whether the Nucleus Sync service’s scheduled sync job is enabled

Choices:

  • false

  • true ← (default)

cic_connector_nucleus_sync_port

integer

Port for the Content Intelligence Connector Nucleus Sync service

Default: 8081

cic_connector_nucleus_system_id

string / required

System ID of this Alfresco instance as registered in Nucleus

cic_connector_remote_client_id

string / required

Client ID for the remote Content Intelligence service

cic_connector_remote_client_secret

string / required

Client secret for the remote Content Intelligence service

cic_connector_remote_environment_key

string / required

Environment key for the remote Content Intelligence service

cic_connector_remote_grant_type

string

Grant type for the remote Content Intelligence service

Default: "client_credentials"

cic_connector_remote_ingestion_url

string / required

Base URL of the remote Content Intelligence ingestion service

cic_connector_remote_token_url

string / required

URL of the token API for the remote Content Intelligence service

cic_connector_repo_events_dead_letter_enabled

boolean

Whether repo events that fail processing are routed to a dead-letter queue

Choices:

  • false

  • true ← (default)

cic_connector_repo_events_dead_letter_uri

string

Dead-letter destination URI for repo events

Default: "activemq:queue:ActiveMQ.DLQ"

cic_connector_repo_events_maximum_redeliveries

integer

Maximum redelivery attempts for repo events before dead-lettering

Default: 6

cic_connector_repo_events_redelivery_delay_ms

integer

Delay in milliseconds between repo event redelivery attempts

Default: 1000

cic_connector_repo_events_use_exponential_back_off

boolean

Whether repo event redelivery uses exponential backoff

Choices:

  • false ← (default)

  • true

cic_connector_service_user

string / required

User to run the Content Intelligence Connector services

cic_connector_transform_response_dead_letter_enabled

boolean

Whether transform responses that fail processing are routed to a dead-letter queue

Choices:

  • false

  • true ← (default)

cic_connector_transform_response_dead_letter_uri

string

Dead-letter destination URI for transform responses

Default: "activemq:queue:ActiveMQ.DLQ"

cic_connector_transform_response_maximum_redeliveries

integer

Maximum redelivery attempts for transform responses before dead-lettering

Default: 6

cic_connector_transform_response_queue_name

string

Queue name for receiving transform responses

Default: "org.alfresco.cic-connector.transform.response"

cic_connector_transform_response_redelivery_delay_ms

integer

Delay in milliseconds between transform response redelivery attempts

Default: 1000

cic_connector_transform_response_use_exponential_back_off

boolean

Whether transform response redelivery uses exponential backoff

Choices:

  • false ← (default)

  • true