Alfresco Connector

Alfresco is used in highly regulated environments, for managing governmental information or personnel records, or where information might be audited. The Alfresco connector can only be used as an Output connector. For read operations from Alfresco, use the CMIS connector. 3Sixty Discovery is available to help with mapping when setting up an integration job.

Tip:  BATCH API REQUIRED
This connector was built to work in tandem with the 3Sixty Batch API to offer a more performant migration.
If you're planning to use the Transparent Content Services for Manage In Place, this API is already included in that module. However, it can be installed separately for standard migrations.

Connector Compatibility

Repo: No

Output: Yes

Content Service: No

Content Search: No

Manage In Place: No

More info on connection types

Authentication Connection

This connector require an Authentication Connection to function. Authentication connectors are used to authenticate repository/output connections that need certain authentication fields like access tokens or refresh tokens.

  1. Select Authentication from the navigation menu or the dashboard.

  2. Click the New Authentication button

  3. Enter a unique name for the connection and give it a description

  4. Select the connection type from the drop-down and click save.

  5. Fill in the configuration settings on the edit connection page and click save.

Authentication Connections Overview

Alfresco Webscript Auth Connector Configuration

This connector uses basic authentication to retrieve a ticket from Alfresco. That ticket will be used to perform operations. The authenticating user will need the rights to access the folder you're attempting to write to.

Field

Description

Name

The name of the authentication connection

Username

Name of the authenticating user

Password

Password of the authenticating user

Service URL

URL to contact Alfresco. Takes the form:

(Alfresco)/alfresco/service

Discovery Connection

Discovery makes mapping to and from your sources easier for data migration and ensures the data gets connected to the right fields. Discovery requires an Authentication Connection

  1. Select Schema Instance from the Navigation Menu or the Dashboard under Discovery

  2. Select the new connection button

  3. Enter a name for your Discovery Connection

  4. Select your connection type from the drop down

  5. Click save on the Create Connection form

  6. In the edit connection page fill out any addition fields and click save

Guide to Discovery Connections

Field

Description

Name

Unique Name for the Discovery Connection to identify it in the UI.

Authentication Connection

The authentication connection you want to search for

Ignore Types (comma delimited list)

Comma delimited list of types to ignore. Note that you can have regex as well. So to ignore all types with "workflow" in the name, you will enter(.)workflow(.) into the ignore types text box.

Alfresco Ticket Key

The ticket key is used to generate credentials.

Integration Connection

Every job requires an integration connection for both the source repository connection and the output connection. Also known as input an output connections. Their job is to query or crawl remote systems for files, folders, metadata, versions, and renditions. In repo mode, it will retrieve list items and all of their relevant metadata from a list or library on the specified site. In output mode, the connection will write content and assign the mapped content type (from type mappings), or simply leave the new list item as a Document. Click here for more information on setting up an integration connection.

  1. Select integration and click on the new connection button.

  2. Enter the name and description of your connection.

  3. Select the connection type from the drop down list.

  4. Click Save on the Create Connection form.

  5. Click Save on the Edit Connection page.

There are no fields to configure in an integration connection.

Guide to Integration connections

Job Configuration

A 3Sixty Job is the process of moving or syncing content (including versions, ACL's, metadata) from one CMS (content management system) to another. Add tasks to your job to have better control over how your data gets migrated. Click here for details on how to set up an integration job.

Guide to Integration jobs

  1. Select List Jobs under Jobs on the navigation menu or the dashboard

  2. Click the create job button

  3. In the New Job form

    1. Name the job

    2. Select Simple Migration from the job type drop down

    3. Select the Repository Connection

    4. Select the Output connection

    5. Select your Content Service Connection

      (Only required if you will be using Federation)

    6. Click Save to open the Edit Job page

    7. Fill in the configurations for the Repo and Output Configuration tabs

  4. Click save to save your new integration job

  1. Select Run and Monitor Jobs under Integration in the navigation menu

  2. Click the play button next to the job you want to run

  3. Click the refresh button to view your completed job status

    (Larger jobs will take longer to run)

Tip:  Batching
The Alfresco Connector requires batching, meaning it will batch up documents before attempting to upload them. Batch size is set under the Advanced Options under the Details job tab. When using a connector that requires batching, the value will be automatically set to 50.

When batching is on, batch ids will be generated based on the job run id, which is the job id plus the timestamp of the current run. The batch number will then be added to that. Batch IDs will be prepended to parent folders of each document in a batch leading to the following:

/1612814334091_1624028461422_1/parentFolder/myfile.txt

Output Specifications

When using this connector as a file destination, filling out the following fields will tell 3Sixty where you want the files integrated to.

Configuration

Field

Description

Alfresco Path

The output folder path in your alfresco repository.

Binary Output Path

Binary Output Path for Azure or S3. If populated and no Secondary Auth Connection is present, will output to the filesystem.

Create Content URL Always

Only used for Manage In Place (MIP). 3Sixty will generate an Alfresco Content Url based on a number of configuration:

Be aware that these are checked in order

  • If the content service connector is set in the Details tab the content url will be
    connectorId://documentId

  • If the document has the metadata field simflofy.contenturl. It will be checked for validity and used.

  • If the secondary auth connection is for Amazon S3 the content url will be
    s3v2://documentId

  • If the secondary auth connection is for Azure Blob the content url will be
    azb://documentId

  • If none of these are true, the content url will be
    store://documentId

Advanced Settings

Field

Description

Included Un-Mapped properties

Add all properties from the source to the target metadata. If unchecked, only mapped properties will be added

Do not convert metadata keys to lowercase

3Sixty converts all type and field values to lowercase by default. If this is checked all fields will keep their original case

Debug mode

Each document's metadata will be output as json file to a specified location

Debug Path

Appears when debug mode is active. A path on the filesystem where the debug JSONs will go.

Alternative Thread Count

If using a secondary auth connections, this will control the number of worker threads. Should never be set to 0, or the job will fail

Multi-Value Separator

Multi-value fields will be combined into a list using this separator

Replace Existing Content

If a document already exists at the output location, it will be overwritten

Use File Hash

If checked, the file keys for documents will be an SHA Hash of their parent path + file name + modified date plus the extension '.sim'

Process ACLS

Requires the use of the ACL Mapper or ACL Conversion Task.

  • Will transform the product of these tasks into Alfresco's format for processing

Inherit ACLS

If processing ACLs, the parent folder's permissions will be merged into the list of acls.

Include Aspects with no Field Mappings

Mapped aspects will be applied even if none of the aspect's fields are present

Aspect Remove Field Mapping

Takes a JSON string. Remove aspects if the listed fields are not present. The example of the UI:

{"myaspect:two":["field1","field2"],"myaspect:one":["field1","field2"]}

Meaning that if field 1 or field 2 is not present, do not add the aspects.

Date Format

Date field mappings will be formatted this way.

Date Time Format

Date/Time field mappings will be formatted this way.

Content Output

Select a secondary authentication type for your Alfresco Output. There are three options. None, Azure Blob, Amazon S3

Field

Description

None

When using this option you will enter the content output path. 3Sixty will only write to the file system if Include File Content is checked

Azure Blob

Select the Azure Blob Authentication connection you want to use for the output. Check the Include Batch ID box to add it to the output path

Amazon S3 Connector

Fill in the following to use this as an option.

  • Select an S3 Authentication Connection from the drop down

  • Enter the Amazon S3 bucket name

  • Add the max number of connection you want to allow during integration

  • Check the Stage Binary to Filesystem box if there are frequent disconnects when uploading to S3

  • Check the Encrypt Objective Server Side box to add encryption

  • Add any object metadata fields you wish to include in the transfer

  • Check the use Transfer Manager box if you want to use the Transfer manager

Mapping

3Sixty Mapping gives you the ability to map your content types and metadata from one system to another.

There are two places in 3Sixty where you can set up mappings:

  • At the top of the mapping tab you can select from saved mappings

  • Creating a unique mapping based on your connectors.

Guide to 3Sixty Mapping

Tasks

Job tasks also known as processors provide a processing pipeline for documents and metadata. Post processors can also be added as a task to run after the files are processed.

Click here for a list of all the tasks you can add to your integration job.

  1. Click on the task tab in your integration job.

  2. Find the task you want to create in the drop down. Tasks are grouped by type. You can also search for the task by name.

  3. Select the create task button

  4. Fill out the configuration fields. Some tasks do not require configuration.

  5. Click Done to save the task to your job.

Alfresco Tutorials

API Keys

Alfresco Connector: Read=false: Write=true: MIP=true

Output (Write) Specs

Key

Description

Data Type
alfresco_path Alfresco Path String

alfresco_create_content_url_always

Create Content Url Always

Boolean

includedUnMapped

Include Un-Mapped Properties

Boolean

alfMetaNoLowercase

Do not convert metadata keys to lowercase

Boolean

alfresco_is_debug

Debug mode. Each document's metadata will be output as json file to a specified location

Boolean

alfresco_debug_path

Debug Path

String

alfresco_extra_worker_count

Alternative Thread Count

Integer

multivalueseparator

Multi-value field separator

String

alfresco_is_replace

Replace Existing Content

Boolean

use_file_hash

Use File Hash

Boolean

alfresco_process_acls

Process ACLs. Requires the use of the ACL Mapper or ACL Conversion Task

Boolean

alfresco_inherit_acls

Inherit ACLs. If processing ACLS The parent's ACL list will be merged into the child's.

Boolean

includeanfm

Include Aspects with no Field Mappings

Boolean

arfm

Aspect Remove Field Mapping

String

alfdateformat

Date Format

String

alfdatetimeformat

Date Time Format

String

alfSecondaryAuthType

Select a secondary authentication type. This is where 3Sixty will send document content. Select None" to write to the filesystem."

 

alfS3AuthConn

Select an S3 Authentication Connection

String

defaultbucket

Bucket Name

String

s3maxconnections

Max Connections

Long

s3StageToFilesystem

Stage Binary to Filesystem

Boolean

aws_encryption

Encrypt Object Server Side?

Boolean

objectmetadatafields

Object Metadata Fields

String

usetm

Use Transfer Manager

Boolean

alfAzureAuthConn

Select an Azure Blob Authentication Connection

String

includebatchid

Include Batch Id in output path

Boolean

outputfolderpath

Content Output Path. Will only write to the filesystem if Include File Content is checked.

String

Need help integrating Alfresco? We can help.