alfresco.platform.hxi_connector role – Install a Hx Insight Connector

Note

This role is part of the alfresco.platform collection (version 0.1.0-alpha.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.hxi_connector.

Entry point main – Install a Hx Insight Connector

Synopsis

• This role installs a Hx Insight Connector and starts it.

Parameters

Parameter	Comments
hxi_connector_alfresco_activemq_password string	Password for the ActiveMQ server Default: "None"
hxi_connector_alfresco_activemq_url string / required	URL of the ActiveMQ server
hxi_connector_alfresco_activemq_username string	Username for the ActiveMQ server Default: "None"
hxi_connector_alfresco_base_url string / required	Base URL of the Alfresco server
hxi_connector_alfresco_db_password string	Password for the database for the Alfresco server - required for the Bulk Ingester Default: "None"
hxi_connector_alfresco_db_url string	URL of the database for the Alfresco server - required for the Bulk Ingester Default: "None"
hxi_connector_alfresco_db_username string	Username for the database for the Alfresco server - required for the Bulk Ingester Default: "None"
hxi_connector_alfresco_password string / required	Password for the Alfresco server
hxi_connector_alfresco_sfs_url string / required	URL of the Shared File Store for the Alfresco server
hxi_connector_alfresco_username string / required	Username for the Alfresco server
hxi_connector_alfresco_version_override string	Version override for the Alfresco repository
hxi_connector_application_sourceid string / required	ID of the source Application as defined in the Hx Insight service
hxi_connector_artifact_default_version string	Default version for all Hx Insight Connector artifacts unless specified otherwise
hxi_connector_artifact_password string	Password for the artifact repository
hxi_connector_artifact_username string	Username for the artifact repository
hxi_connector_java_bin_path string	Path to the Java binary Default: "/opt/java/bin/java"
hxi_connector_java_home_path string	Path to the Java home directory Default: "/opt/java"
hxi_connector_live_ingester_artifact_version string	Version of the Hx Insight Connector Live Ingester artifact
hxi_connector_live_ingester_port integer	Port for the Hx Insight Connector Live Ingester service Default: 8080
hxi_connector_prediction_applier_artifact_version string	Version of the Hx Insight Connector Prediction Applier artifact
hxi_connector_prediction_applier_port integer	Port for the Hx Insight Connector Prediction Applier service Default: 8081
hxi_connector_remote_client_id string / required	Client ID for the remote Hx Insight service
hxi_connector_remote_client_secret string / required	Client secret for the remote Hx Insight service
hxi_connector_remote_environment_key string / required	Environment key for the remote Hx Insight service
hxi_connector_remote_grant_type string	Grant type for the remote Hx Insight service Default: "urn:hyland:params:oauth:grant-type:api-credentials"
hxi_connector_remote_ingestion_url string / required	Base URL of the remote Hx Insight Ingestion service
hxi_connector_remote_prediction_url string / required	URL of the prediction API for the remote Hx Insight Prediction service
hxi_connector_remote_token_url string / required	URL of the token API for the remote Hx Insight Token service
hxi_connector_service_user string / required	User to run the Hx Insight Connector services

Entry point repository-extension – Install a Hx Insight Connector Repository Extension

Synopsis

• This role installs a Hx Insight Connector Repository Extension in an Alfresco install.

Parameters

Parameter	Comments
hxi_connector_alfresco_service_name string	Name of the Alfresco service to be restarted after extension installation Default: "alfresco-content-monitored-startup"
hxi_connector_application_sourceid string	ID of the source Application as defined in the Hx Insight service
hxi_connector_artifact_password string	Password for the artifact repository
hxi_connector_artifact_username string	Username for the artifact repository
hxi_connector_remote_client_id string	Client ID for the remote Hx Insight service
hxi_connector_remote_client_secret string	Client secret for the remote Hx Insight service
hxi_connector_remote_discovery_url string	Base URL of the remote Hx Insight Discovery service
hxi_connector_remote_environment_key string	Environment key for the remote Hx Insight service
hxi_connector_remote_grant_type string	Grant type for the remote Hx Insight service Default: "urn:hyland:params:oauth:grant-type:api-credentials"
hxi_connector_remote_prediction_url string	URL of the prediction API for the remote Hx Insight Prediction service
hxi_connector_remote_token_url string	URL of the token API for the remote Hx Insight Token service
hxi_connector_repository_extension_acs_version string	Version of the Alfresco Content Services repository where to install the extension
hxi_connector_repository_extension_artifact_path string	Path where the Hx Insight Connector Repository Extension artifact will be downloaded
hxi_connector_repository_extension_artifact_url string	URL of the Hx Insight Connector Repository Extension artifact
hxi_connector_repository_extension_artifact_version string	Version of the Hx Insight Connector Repository Extension artifact
hxi_connector_repository_extension_group string	Group of the Hx Insight Connector Repository Extension artifact and its properties file Default: "alfresco"
hxi_connector_repository_extension_modules_path string	Path to the platform modules directory of the Alfresco server Default: "/opt/alfresco/content-services-{{ hxi_connector_repository_extension_acs_version }}/modules"
hxi_connector_repository_extension_owner string	Owner of the Hx Insight Connector Repository Extension artifact and its properties file Default: "alfresco"
hxi_connector_repository_extension_properties_snippet_path string	Path to the properties file for the Hx Insight Connector Repository Extension

Collection links

• Issue Tracker
• Repository (Sources)