Skip to content

Commit

Permalink
[DOCS-7529] Initial UA review
Browse files Browse the repository at this point in the history
  • Loading branch information
anxumalo committed Sep 6, 2024
1 parent 512d2d7 commit b79bce8
Show file tree
Hide file tree
Showing 4 changed files with 153 additions and 129 deletions.
30 changes: 15 additions & 15 deletions federation-services/latest/config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ Content Service Connections offer public REST endpoints that allow for integrati

#### Commonly Supported Operations

> **Note**: The capabilities of each Content Service Connector is limited to operations allowed by the repository. Additionally, not all methods are available for all connectors. View individual connector pages for a list of capabilities.
> **Note:** The capabilities of each Content Service Connector is limited to operations allowed by the repository. Additionally, not all methods are available for all connectors. View individual connector pages for a list of capabilities.
* Creating content

Expand Down Expand Up @@ -388,13 +388,13 @@ A logical, intuitive UX. Informative dashboards. Powerful business process capab

##### Authentication Connections

> **Note**: Passthrough authentication currently only works for ECM content service:
> **Note:** Passthrough authentication currently only works for ECM content service:
Objective Basic Authentication Connector: passthrough username and password
Objective OAuth Connector: only passthrough username

**Objective Basic Authentication**

> **Note**: Objective Basic auth connector does not work for ECM Nexus
> **Note:** Objective Basic auth connector does not work for ECM Nexus
* **Connection Name**: Unique Name for the Auth Connection to identify it in the UI.
* **Username**: The username to authenticate with the repository if applicable.
Expand All @@ -403,7 +403,7 @@ Objective OAuth Connector: only passthrough username

**Objective OAuth Connection**

> **Note**: Minimum required version of ECM/Nexus is 11.2 for OAuth connections
> **Note:** Minimum required version of ECM/Nexus is 11.2 for OAuth connections
* **Name**: Connector Name
* **Server URL**: Server URL, for example `https://myserver.objective.com`
Expand Down Expand Up @@ -437,21 +437,21 @@ Also known as input an output connections. Their job is to query or crawl remote

* **Output Folder Path**: Folder ID to start output. Note that the path from the source will be duplicated in the output and subsequent folders will be created as needed.

> **Note**: The Objective connector uses the job's Repository Time Zone field for time zone conversion. The output Time Zone field is ignored, since Federation Services always sends ECM a UTC DateTime.
> **Note:** The Objective connector uses the job's Repository Time Zone field for time zone conversion. The output Time Zone field is ignored, since Federation Services always sends ECM a UTC DateTime.
**Duplication Check Task**

Given the ECM connector is the source repository, when there are two of the same documents in the source repository with different paths; and if documents are pptx, docx, xlsx files, the ECM seems to change these documents and their MD5 code are different. Therefore, when the job for ECM to ECM has a duplication check task with a field to compare as file content hash, it will create a new version for these types of documents.

When the duplication check task field to Compare is set as File content hash, and there are two emails with the same content and the same subject, the MD5 codes will still be different for these two emails. Because of this, Federation Services cannot use duplication check task to skip one of them.

> **Note**: Only new files greater than 100MB are up chunked and uploaded.
> **Note:** Only new files greater than 100MB are up chunked and uploaded.
Chunked uploads do not take place if the file already exists in the Objective folder specified.
Linked documents and version updates are not currently supported by this feature.

##### Mapping

> **Note**: When adding job mapping, the type mapping and aspect mapping should be added first and then add the calculate mapping and field mapping.
> **Note:** When adding job mapping, the type mapping and aspect mapping should be added first and then add the calculate mapping and field mapping.
When "Field Mapping" from ECM connector, make sure fields do not have "document." prefix. For example, "document.dateUpdated" must be written as "dateUpdated" Remove the "document." prefix added by schema instance.

Expand Down Expand Up @@ -486,7 +486,7 @@ Elasticsearch is a search engine based on the Lucene library. It provides a dist
* **Version Support**: Federation Services currently only supports version 7.15 of Elasticsearch and does not support version 8
* **AWS Compatibility**: As of September 2021 this connector will not work with AWS instances of ElasticSearch. AWS has its own version, now called OpenSearch, which is incompatible with current Elasticsearch libraries.

> **Note**: To configure Elasticsearch to handle larger file sizes:
> **Note:** To configure Elasticsearch to handle larger file sizes:
In installed `elasticsearch/config/elasticsearch.yml`, set `http.max_content_length` to a value greater than 100MB. See [here](https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-network.html){:target="_blank"} for more options.

##### Authentication Connection
Expand Down Expand Up @@ -581,7 +581,7 @@ Only one of these options may be selected at a time

##### Indexing Content into Elasticsearch for Federation

> **Note**: PREREQUISITES AND THE FEDERATION WIZARD
> **Note:** PREREQUISITES AND THE FEDERATION WIZARD
These steps can be performed automatically by using the Federation Wizard, but will still require job configuration. If you use the wizard, skip steps 1 and 2.

For indexing content you will need:
Expand Down Expand Up @@ -635,7 +635,7 @@ Can be used as a content search connector for Manage in Place

MongoDB is a source-available cross-platform document-oriented database program. Classified as a NoSQL database program, MongoDB uses JSON-like documents with optional schemas.

> **Note**: This page is only meant to cover using MongoDB without [GridFS](#mongodb-gridfs). The common use case for MongoDB without GridFS is to act as an indexing engine, like [Elasticsearch](#elasticsearch)
> **Note:** This page is only meant to cover using MongoDB without [GridFS](#mongodb-gridfs). The common use case for MongoDB without GridFS is to act as an indexing engine, like [Elasticsearch](#elasticsearch)
##### Authentication Connection

Expand Down Expand Up @@ -738,7 +738,7 @@ rd.setDenyAcl(deny);

Can be used as a content search connector for Manage in Place

> **Note**: In Federation Services, the GridFS is just a mode of the MongoDB connector.
> **Note:** In Federation Services, the GridFS is just a mode of the MongoDB connector.
GridFS is the MongoDB specification for storing and retrieving large files such as images, audio files, video files, etc. It is kind of a file system to store files but its data is stored within MongoDB collections. GridFS has the capability to store files even greater than its document size limit of 16MB.

Expand Down Expand Up @@ -1675,7 +1675,7 @@ or
> **Important**: In order to retrieve private chat messages, a payment model is required after a certain number of messages. See [this link](https://learn.microsoft.com/en-us/graph/teams-licenses#evaluation-mode-default-requirements){:target="_blank"}. Federation Services uses the Get messages across all chats for user method.
> **Note**: Microsoft Teams file storage for a team is actually just a SharePoint site, with each channel being a folder in the `Documents` library. You can view your teams files in SharePoint by going to `https://[tenant].sharepoint.com/sites/[teamName]`.
> **Note:** Microsoft Teams file storage for a team is actually just a SharePoint site, with each channel being a folder in the `Documents` library. You can view your teams files in SharePoint by going to `https://[tenant].sharepoint.com/sites/[teamName]`.
##### Authentication Connection

Expand Down Expand Up @@ -1746,7 +1746,7 @@ The second mode allows you to pull the private chats for a user.
* Preferred licensing and payment requirement model. The API used to retrieve private messages has limited usage. Usage beyond certain amounts require payment. For testing, stick to the default, but note that you will run out after 500 messages.
* Retrieve attachments attached to chat logs: Will attach documents as additional binaries for each message.

> **Note**: If you wish to process a message via push event, there are some restrictions.
> **Note:** If you wish to process a message via push event, there are some restrictions.
* Private Chats are not available. Attempting to execute the push event against private chats will cause an error.
* The output for an event chat will always be in html format.
Expand Down Expand Up @@ -1808,9 +1808,9 @@ Documents retrieved from OneDrive will have the same metadata as those read from

##### Integration Connection

> **Caution**:As of the 3.1.1 release, MSGraph connectors cannot rerun errored documents. We are aware of the issue, and it will be addressed in the next release.
> **Caution:** As of the 3.1.1 release, MSGraph connectors cannot rerun errored documents. We are aware of the issue, and it will be addressed in the next release.
> **Important**: The Microsoft Graph APIs throttle connections that make what it considers excessive api calls. They have not shared these metrics, and they are determined dynamically based on previous usage and presumably account type. [See this link for more details](https://docs.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online#why-cant-you-just-tell-me-the-exact-throttling-limits){:target="_blank"}
> **Important:** The Microsoft Graph APIs throttle connections that make what it considers excessive api calls. They have not shared these metrics, and they are determined dynamically based on previous usage and presumably account type. [See this link for more details](https://docs.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online#why-cant-you-just-tell-me-the-exact-throttling-limits){:target="_blank"}
##### Job Configuration

Expand Down
27 changes: 16 additions & 11 deletions federation-services/latest/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The Federation Services capability for Alfresco Content Services is delivered in

Check the [supported platforms]({% link federation-services/latest/support/index.md %}) for information on what you require before you start the installation.

> **Note**: A compatible version of Alfresco Governance Services (if you plan to use the Manage in Place capabilities) is required, for example: if using Alfresco Content Services 23.1, make sure that you install Alfresco Governance Services 23.1.
> **Note:** A compatible version of Alfresco Governance Services (if you plan to use the Manage in Place capabilities) is required, for example: if using Alfresco Content Services 23.1, make sure that you install Alfresco Governance Services 23.1.
You can download the Federation Services software from [Hyland Community](https://community.hyland.com/){:target="_blank"}.

Expand All @@ -19,12 +19,13 @@ You can download the Federation Services software from [Hyland Community](https:
* Memory pool: 4GB required, 8GB recommended. This can be updated in the Java tab of your Apache Tomcat Properties window.

> **Note:** We recommend using a separate instance, where possible, instead of using the same one used by Alfresco Content Services.
> **Note:** Federation Services runs on the Spring platform, which does not support Tomcat versions beyond 9.
* MongoDB 6.x
* Linux or Windows

**Client Access**
#### Client Access

The client uses a web browser to access Federation Services. The following browsers are supported:

Expand All @@ -36,9 +37,11 @@ The client uses a web browser to access Federation Services. The following brows

Create the Federation Services database and user in MongoDB by executing the following commands in the mongo shell:

`use simflofy`
`db.createUser({"user":"simflofy", "pwd":"password",`
`"roles":["clusterMonitor", "dbOwner"]});`
```text
use simflofy
db.createUser({"user":"simflofy", "pwd":"password",
"roles":["clusterMonitor", "dbOwner"]});
```

### Hardware requirements

Expand All @@ -56,7 +59,7 @@ Finally, Federation Services will be integrating 2 or more products. Performance
## Install steps

These steps describe how to install Federation Services to an instance of Alfresco Content Services.
All files necessary for install are available from [Hyland Community](https://community.hyland.com/){:target="_blank"}. Sign in, select **Product downloads**, and search for the product you require.
All files necessary for install are available from [Hyland Community](https://community.hyland.com/){:target="_blank"}. Sign in, select **Support > Alfresco Downloads**, and search for the product you require.

1. Download the files provided for the Federation Services release.

Expand All @@ -65,23 +68,25 @@ All files necessary for install are available from [Hyland Community](https://co
* `AFS-federation.war`
* `AFS-admin.war`

2. Copy the Federation Services Admin and discovery war files or expanded zip to **Tomcat Installation** `Directory/webapps` directory.
2. Copy the Federation Services Admin and discovery WAR files or expanded zip to **Tomcat Installation** `Directory/webapps` directory.
3. Start Tomcat.
4. Navigate to the `mongo-db.properties` file `Tomcat/Webapps/3Sixty/Admin/WEB-INF/classes/mongo-db.properties`.
5. Set the credentials for the user and the database connection details.
6. Depending on what database you created the admin user in, you may have to append the database name to the end of the uri. This is the authenticating database. The following example config assumes you followed the previous steps exactly.

```text
mongo.db.username=simflofy`
mongo.db.username=simflofy
mongo.db.password=#whatever password you set during mongo user creation
mongo.db.uri=mongodb://[[USER]]:[[PASS]]@localhost:27017/simflofy
```
7. In the same folder, open `simflofy-global.properties` and check if all of the 'initialize' properties are set to true. If not, set them to true and save. See the section on properties for more information.
8. If you have a shared loader enabled in Tomcat, move the global properties files to the shared/classes folder. Now the properties files will persist after redeploying the war.
7. In the same folder, open `simflofy-global.properties` and check if all of the 'initialize' properties are set to true. If not, set them to `true` and save. See the section on properties for more information.
8. If you have a shared loader enabled in Tomcat, move the global properties files to the `shared/classes` folder. Now the properties files will persist after redeploying the WAR.
9. Restart Tomcat.
10. In `simflofy-global.properties` set initialize properties to false.
11. Copy and paste the following into your browser: `http://(servername):(port)/3sixty-admin`. The default Federation Services Username/Password is admin/admin.
12. Access the Admin app through your preferred browser to [configure]({% link federation-services/latest/config/index.md %}) your installation.
## Configure Tomcat for SSL
In order to finish the installation of Federation Services, you need to generate or install a certificate and enable SSL and and Port 8443 or port 443 in `tomcat/conf/server.xml`. Go to [Tomcat SSL documentation](https://tomcat.apache.org/tomcat-9.0-doc/ssl-howto.html){:target="_blank"} for more information.
In order to finish the installation of Federation Services, you need to generate or install a certificate and enable SSL and and Port 8443 or port 443 in `tomcat/conf/server.xml`. Go to [Tomcat SSL documentation](https://tomcat.apache.org/tomcat-9.0-doc/ssl-howto.html){:target="_blank"} for more information.
5 changes: 3 additions & 2 deletions federation-services/latest/support/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@
title: Supported platforms
---

The following are the supported platforms for Alfresco Federation Services 3.1:
The following are the supported platforms for Alfresco Federation Services:

| Version | Notes |
| ------- | ----- |
| Content Services 23.1 | |
| Content Services 23.x | |
| Content Services 7.4 | |
| | |
| **Java** | |
| Java JRE 17 or later | |
Expand Down
Loading

0 comments on commit b79bce8

Please sign in to comment.