Skip to main content

Credentials

AWSConnectionProvider - AWS S3 user credentials

With an access key id and the secret access key, you have the option to connect to an AWS S3 instance by specifying the region concerned. However, to perform this king of connection, Fast2 required the permission : AmazonS3FullAccess

Mandatory settings
KeyTypeDescription
Access key IdStringThis field is mandatory unless 'Use Instance Profile' is set
Secret access keyStringThis field is mandatory unless 'Use Instance Profile' is set
AWS RegionString
Optional settings
KeyTypeDescriptionDefault value
AWS URL endpointStringService endpoint & signing region
Use settings for SnowballBooleanSnowball S3 endpoint requires specific S3Client settingsfalse
Use Instance Profile instead of Access Key & SecretBooleanFrom your local variable, Fast2 will retrieve your connection informationfalse
Role ARN nameString
sessionNameString
AWS extra Client ConfigurationClientConfigurationUse this AWS class to fine-tune connection details to S3, such as timeouts, connection pool size, ...

AlfrescoCMISConnectionProvider - CMIS connection provider

From a URI and giving a username with password, this class allow you to access any Alfresco instance

Mandatory settings
KeyTypeDescription
PasswordString
UsernameString
URI for connection settingsString

AlfrescoRESTConnectionProvider -

Mandatory settings
KeyTypeDescription
PasswordString
URL to connect to AlfrescoString
UsernameString

CMConnectionProvider - Connection provider for Content Manager solution

The CM connection provider will help you to manage a pool of connections. For performance reasons, it is sometimes desirable to limit the number of connections created by the pool.The connection pool will allow you to specify the maximum number of connections that should exist at one time, whether in use or in the pool.Once this maximum value is reached, an error may be thrown or you may optionally wait for an existing connection to be freed

Mandatory settings
KeyTypeDescriptionDefault value
PasswordStringPassword of the aforementioned username
UsernameStringLogin with scope to access the docbase with proper rightsicmadmin
Optional settings
KeyTypeDescriptionDefault value
Data source typeStringICM
Connection pool sizeIntegerMaximum number of connections to be created64
Server nameStringName of the server involved in the migrationICMNLSDB
Connection free pool sizeIntegerMaximum number of connections that may be held in the free pool5
Internal connectionIntegerMaximum number of connections for internal side64
Connection durationLongLength of time to kill a free connection in milliseconds100000

CMODConnectionProvider - CMOD connection provider

With a username / password and an IP address, this class allow you to connect at your CMOD instance.To optimize connections between Fast2 and CMOD you can use a single connection

Mandatory settings
KeyTypeDescriptionDefault value
Server IP addressString192.168.0.189
PasswordString
UsernameStringadmin
Optional settings
KeyTypeDescriptionDefault value
Port numberInteger1445
Singleton connectionBooleanOptimization of the connection in case of regular callsfalse

DctmConnectionProvider - Documentum connection provider

Module used by Fast2 to establish to communication with the destination Documentum instance.

Mandatory settings
KeyTypeDescription
Docbase nameStringName of the docbase involved in the migration.
PasswordStringPassword of the aforementioned username.
UsernameStringLogin with scope to access the docbase with proper rights.

DctmSshClient - Documentum SSH client"

Module used by Fast2 to establish the connection with the destination Documentum server.

warning

Using this feature may significantly degrade performance. To use this option, the Client must be set on all Documentum tasks.

Mandatory settings
KeyTypeDescription
UsernameStringDocumentum machine username
PasswordStringDocumentum machine password
IPStringDocumentum machine IP

EmbeddedDbConnectionProvider - OpenSearch connection provider

Module used by Fast2 to connect to its own database.

Mandatory settings
KeyTypeDescriptionDefault value
Database endPointStringThe endpoint of the Fast2 database"http://localhost:1790

FileNet35ConnectionProvider - Connection provider for FileNet 3.5 solution

This task is used to provide connection information to connect specifically to the FileNet P8 3.5 ECM.

Mandatory settings
KeyTypeDescription
PasswordStringPassword of the aforementioned username
UsernameStringLogin with scope to access the docbase with proper rights
Optional settings
KeyTypeDescription
WCM Config resourceString
Object store nameStringName of the docbase involved in the migration
URL settingsWcmApiConfigSettingsClass used for setting multiple URLs (download, upload...)

FileNetConnectionProvider - Connection provider for FileNet P8 solution

Using this class allows you to provide connection information to specifically connect to your FileNet P8 5.x ECM

Mandatory settings
KeyTypeDescription
PasswordStringPassword of the aforementioned username
URI addressStringURI to determine which FileNet instance to connect to

Ex/ http://<ip>:<port>/wsi/FNCEWS40MTOM/

UsernameStringLogin with scope to access the docbase with proper rights
Optional settings
KeyTypeDescriptionDefault value
JAAS coonfiguration stanza property nameStringProperty containing JAAS coonfiguration. If null, the default JAAS stanza name is set to FileNetP8
Singleton connectionBooleanReuse the same connection to optimize callsfalse
Initial naming factoryString

FlowerDocsConnectionProvider - Connection module for FlowerDocs ECM

Module responsible for authentication of Fast2 for FlowerDocs

Mandatory settings
KeyTypeDescription
URL endpointStringWeb services target URL. For example : https://www.demo.flowerdocs.cloud/flower-docs-ws/services
PasswordStringPassword of the service account used for authentication
ScopeStringScope of the service account used for authentication
UsernameStringUsername of the service account used for authentication
Optional settings
KeyTypeDescriptionDefault value
Overrides authenticated userBooleanAllows connections to multiple endpointsfalse

GenericRestClient - Generic REST client connection

Allows Fast2 to connect to any REST API.

Mandatory settings
KeyTypeDescription
EndpointPatternComplete URI address of the endpoint
MethodStringHTTP method to use

Ex/ GET, POST, PUT, DELETE

Optional settings
KeyTypeDescriptionExampleDefault value
HeaderString/Pattern mapParameters of the header
Query parametersString/Pattern map
Body content type in requestStringapplication/json
Proxy hostString
Proxy portInteger
Proxy usernameString
Proxy passwordString
Socket timeoutIntegerTimeout to receive data (in ms)60000
Request timeoutIntegerTimeout until a connection with the server is established (in ms)30000
Total number of connectionsIntegerSet the maximum number of total open connections2048
Max connections per routeIntegerSet the maximum number of concurrent connections per route2048
Form field bodyString/Pattern mapField used to send structured data in Key/Value pairs. Required for content types: multipart/form-data, and application/x-www-form-urlencoded. FILE UPLOADS (Multipart) : To include files within a form, enter the absolute or relative file path as the value and add '_file' at the end of the corresponding key.
Raw bodyPatternField used when the request body is a single content. Required for: text/plain, application/xml, and all single binary file uploads (e.g., image/*, application/pdf). FILE UPLOADS : Enter the file path and check the file path option. Otherwise, enter the literal content (text or XML string).
File PathBooleanIndicates if the raw body contains a file pathfalse

MailBoxProvider - Mail box connection

This class is used to access any mailbox from some connection information.

Mandatory settings
KeyTypeDescription
ProtocolStringProtocol used to establish the connection

Ex/ imap

PasswordStringPassword of the aforementioned username
Host addressStringExact address of the mail server where to retrieve the mails

Ex/ imap.gmail.com

Root folder nameStringName of the root folder to extract mails
UsernameStringLogin with scope to access the docbase with proper rights
Optional settings
KeyTypeDescriptionDefault value
Session debuggingBooleanKeep logs written for the connection into stdoutfalse
Number of retriesIntegerMaximum number of times to retry the connection in case of failure0
Read and write permissionsBooleanOpen mail session with read and write permissions. If false, the session is only readablefalse
Extended properties mapString/String mapList of additional properties to apply

Ex/ myValue.toAdd = true

Time between two connectionsIntegerTime in milliseconds between each connection attempt1000

MailSenderProvider - Email connection provider

This module will grant Fast2 access to send emails on behalf of a given user

Mandatory settings
KeyTypeDescription
PasswordStringThe password of the aforementioned user
PropertiesString/String mapIt is expected that the client supplies values for the properties listed in Appendix A of the JavaMail spec. Please provide
-mail.store.protocol,
-mail.transport.protocol,
-mail.host,
-mail.user, and
-mail.from as the defaults are unlikely to work in all cases
UsernameStringThe username with proper rights to access the email client server
Optional settings
KeyTypeDescription
DebugBooleanSet the debug setting for this Session. Since the debug setting can be turned on only after the Session has been created, to turn on debugging in the Session constructor, set the property mail.debug in the Properties object passed in to the constructor to true

MFilesConnectionProvider - Connection settings for MFiles

Credentials to connect to M-Files remote system via its REST API.

Mandatory settings
KeyTypeDescriptionDefault value
M-Files REST endpointStringhttp://ip.address/REST
LoginString
PasswordString
Vault GUIDStringex : {15c876e7-8462-4a35-83d6-c8c21694eed6}

MobiusConnectionProvider - Mobius connection provider

⚠️ Deleted: The MobiusConnectionProvider module is deleted and no longer available in Fast2 from v2025.0.0.

This Mobius connection module is required for Fast2 to successfully establish the connection with your Mobius instance in order to properly migrate metadata and contents.

Mandatory settings
KeyTypeDescription
Repository IDStringThe Universally unique identifier (UUID) of the destination repository
Mobius Server URLString
Optional settings
KeyTypeDescription
Authentication REST HeaderStringThe value of the 'Authorization' header of the REST request

NuxeoConnectionProvider - Connection settings for Nuxeo

Mandatory settings
KeyTypeDescriptionDefault valueExample
URL endpointStringhttp://hostname:port/nuxeohttp://localhost:8080/nuxeo
PasswordString
UserNameString
Optional settings
KeyTypeDescriptionDefault valueExample
Accessible schemasStringList of document schemas accessible with this connexion*

OpenTextCredentials - OpenText user credentials

Mandatory settings
KeyTypeDescription
PasswordString
UsernameString

SQLQueryGenericCaller - Generic query caller

This modules is responsible of establishing the connection between Fast2 and the designated database

Mandatory settings
KeyTypeDescription
Connection definitionStringUse a standard jdbc:// syntax. If a driver is needed, the JAR file has to be added to the worker-libs/ folder. Make sure to pick up a version compatible with the JDK used by Fast2. If clear credentials is a problem, please use below fields username and password

Ex/
jdbc:sqlite:C:/sqlite/mydatabase.db;
jdbc:sqlserver://localhost:<port>;user=...;password=...;
jdbc:mysql://<ip-address>:3306/<db-name>?user=...&password=...

Optional settings
KeyTypeDescription
PasswordStringPassword used by connectionString and fully encrypted for security reasons
Driver classStringOptional driver class to load before connection. Leave empty to load none
Throw error if no resultBooleanThrow exception when SQLQueryColumnCaller finds no result.
Skip exceptionsBooleanFast2 will either throw an error if the statement has not properly been executed, or fail silently
UserStringUsername used by connectionString