Skip to main content

Injectors

AlfrescoBulkImporter - Perform a bulk import on Alfresco

Load documents and metadata into Alfresco without changing the current tree structure of those same documents. The good performances of such injection are restrained with the complexity of the tree-view setup

Mandatory settings
KeyTypeDescription
Source directoryStringPath to the folder to migrate into Alfresco
Target pathStringPath where the folder will be stored into Alfresco
Alfresco connection providerAlfrescoConnectionProviderThis modules is responsible of the two-way communication between Fast2 and the designated Alfresco instance.
Target NodeRefStringNodeRef of the parent where the folder will be stored into Alfresco
Optional settings
KeyTypeDescriptionDefault value
Clean destinationBooleanReplace all existing content or metadata present in the destination folder before injectionfalse
Disable rulesBooleanDisable rules for injection to prevent Alfresco to run checks on each documentfalse
Add metadataBooleanLoad document content and its metadata. All metadata might not me compatible with Alfresco standardsfalse
Number of threadsIntegerNumber of threads to allocate for the bulk import1
TimeoutIntegerTime to wait before closing the session. Of not set, the value will be set to 300'000
Copy filesBooleanLeave all documents in the source folderfalse
Batch sizeIntegerSize of the batch to build for upload0

AlfrescoInjector - Injection into Alfresco ECM using CMIS protocol

This task can be used to inject documents into Alfresco, using the CMIS protocol on top of HTTP. We rely on v1.0 of the opencmis module made available by Alfresco.

Mandatory settings
KeyTypeDescription
Alfresco connection providerAlfrescoCMISConnectionProviderThis modules is responsible of the two-way communication between Fast2 and the designated Alfresco instance
Optional settings
KeyTypeDescriptionDefault value
Alfresco ID keyStringDocument metadata key with the Alfresco ID of the injected document.alfDocumentId
Property HelperPropertyHelper
Properties regexStringRegex pattern to filter the properties to inject with the document.(cmis:.*)
Hash content column nameStringHash content column name to version a document only when the content is different (but same index)
Destination folderStringFolder where the documents will be loaded into
SQL update queryStringCMIS SQL update query to select the document to update.
Overwrite 'can create'BooleanAsk Fast2 to create destination folder(s) if they do not already existtrue
Hash index column nameStringHash index column name to version a document only when the content is different (but same index)
Force updateBooleanThrow an error if the document did not exist prior to the loading call
Prevent duplicateBooleanFast2 will throw an error if the document has already been injected

AlfrescoRestInjector - Alfresco injector using Alfresco REST protocol

This task relies on the Alfresco public REST API (with v1.0.4 of the Alfresco REST client) to load documents and metadata into a given Alfresco instance.

To force the type of resource to create in the destination system, use the nodeType data into the document dataset. Default value is cm:content.

Mandatory settings
KeyTypeDescription
Alfresco connection providerAlfrescoRESTConnectionProvider
Optional settings
KeyTypeDescriptionDefault value
Root folder name to inject in a specific repositoryString'-my-', '-shared-', '-root-' are equivalent-my-
Alfresco destination pathStringThe path of the folder where the documents will be saved in Alfresco. This field supports patterns (based on punnet, document and campaign metadata).
If this path starts with Alfresco nodeRef prefix 'workspace://SpacesStore/', the document will be injected into the corresponding folder. However, such folder needs to be created beforehand.
Regex pattern filter for document propertiesString(cm:.*)
Safe updateBooleanIf the document does not already exist, the first version will create the document. Later versions will be incremented on top of the existing version based on the data 'cm:versionLabel' property.
Auto rename featureBooleanTriggers the Alfresco auto-rename feature, to prevent Alfresco to throw a 'duplicate document' error.false
Pivot metadata for multiversionPatternIf all documents of the punnet have the same value for this metadata, they will be considered as being the different versions of a same document in Alfresco.
Overwrite documents when they already existBooleanTriggers the Alfresco overwrite feature, where the incoming document will replace an existing document having the same key.false
Alfresco ID for updateStringSpecify here the Alfresco UUID of the document to update. The value will be resolved by Fast2, syntax ${...} is supported. This value can start with 'workspace://SpacesStore/'

Ex/ ${property('alfcmis:nodeRef')}

AwsInjector - Injector into AWS S3 buckets

Fast2 proposes this task to load your documents, metadata and more within designated S3 buckets. Both client- and server-side encryption are supported (v1.6 of AWS encyption SDK). This loader relies on v1.11.848 of AWS Java SDK. The uploaded file will be title according to the name metadata of the processed document.

Mandatory settings
KeyTypeDescriptionDefault value
Destination bucketStringThe name of the bucket where the documents will be migrated to.fast2-default
AWS credentialsAWSConnectionProviderMust have granted AmazonS3FullAccess permission
Optional settings
KeyTypeDescriptionDefault value
Encryption keyStringKey used for server-side encryption.

Ex/ 01234567-abcd-efgh-ijkl-0123456789ab

Destination folderStringThe parent folder of the documents to inject. This field supports pattern (using punnet, document or campaign metadata). Leave empty for storing at the root of the bucket.
Dry runBooleanSimulates an injection, performs document integrity controls, but does not load the document into AWS S3false
Destination file nameStringMetadata for the file name once injected into the S3 bucket. Pattern syntax is supported.${name}
Encryption contextStringContext used for server-side encryption. This context is a JSON map.

Ex/ {\"testKey\":\"testValue\"}

ARN keyStringKey used for client-side encryption, before loading the document into S3.

Ex/ arn:aws:kms::111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Update onlyBooleanOnly changing metadata, content is left as isfalse

CSVWriter - CSV file writer

Use this task to write punnet and document related data into a CSV. You can specify the name of such file as well as the path where your want Fast2 to create and populate it.

Mandatory settings
KeyTypeDescription
Path for (local) output CSV filesStringUsing a pattern for this field will trigger a resolution by Fast2 at runtime
Optional settings
KeyTypeDescriptionDefault value
Close output file at each lineBooleanClose CSV file after each punnet processed. This option can come useful to prevent too many files opened errors when each punnet created a dedicated CSV file.
New column headersString listThe new column names to use for the document metadata. If no set, the column headers will be populated from the names of the document metadata. By default, the data 'punnetId' and 'documentId' will be appended to the existing data.
Upload punnet dataBooleanFor each document add the punnet data to wich it was attached totrue
CSV separatorStringThe separator used between columns in the resulting CSV file.,
Write all in the same CSV fileBooleanMerge metadata of all punnets in a single output CSV file. The missing columns headers will be added on the fly, although it is wiser to list them all in the 'New column headers' field. If set to false, any existing CSV file with the same name will be overwritten.true
Protect with double quoteBooleanThis option will surround every value with double quotes. Such use will be mostly relevant when dealing with multivalued metadata.true
Add Folder MetadataBooleanFor each document add its folder metadata on the same CSV line. Only the first level of folders will be stored into the CSV file. If a document is attached to more than one folder, its line will be cloned in the CSV file, to display one folder per line.false
note

CSVWriter folders behavior and limitations (v2025.5.0):

  • Single level of depth: only the direct parent folders of documents are considered.
  • Single combination per CSV line: one row per unique document/folder combination; documents without a folder appear with blank folder columns.

DctmInjector - Injection into Documentum

Use this task to inject into Documentum ECM system. Fast2 embeds v6.7 of Documentum modules to take the most out of of this injection phase.

Mandatory settings
KeyTypeDescription
CredentialsDctmConnectionProviderConnection module establishing the communication with a given Documentum instance.
Optional settings
KeyTypeDescription
Documentum configurationDctmConfigurationCustomize here the Documentum details related to the instance you are planning to inject documents into. For more, refer to the appropriate section.
SSH clientDctmSshClientSSH client used to establish the connection with the Documentum server

FileNet35Injector - Injector for FileNet P8 3.5

Use this task to inject documents and data into a FileNet P8 3.5

Mandatory settings
KeyTypeDescription
The FileNet connection providerFileNet35ConnectionProviderModule to establish the connection with the destination FileNet infrastructure
ObjectStore nameStringName of the destination object-store where the documents and metadata will be injected
Optional settings
KeyTypeDescriptionDefault value
Try using 'DocumentTitle' propertyBooleanWhen filing a document in a folder, try to use the FileNet DocumentTitle property for the RelationShip name
Process multi-pages content as multi-contentBooleanTreat the content of multi-pages document as multi-content document in FileNet.
Dry runBooleanNeeds to set 'UpdatingBatch on documents' to true
WHERE clause for folder caseStringwhere clause to define for case research
Restrain search results to documentsBooleanForce Document search to limit to the class name provided on the document
Only process 1st contentBooleanRelevant for multi-content documents
Restrain search results to foldersBooleanForce folder search to limit to the class name provided on the folder
Skip content injectionBooleanSkip document content injection, only load the metadata and/or annotations of the processed document
Skip document unfilingBooleanForce to skip Document unfiling to existing folders before linking it to the provided folders ; new linkages will be added to the existing ones
Clear in-place annotationsBooleanIf source document contains annotations, cleanup existing ones in P8
Restrain search results to caseBooleanForce case search to limit to the class name provided on the case
Synchronous folder creationBooleanEnforce synchronous folder creation, to make them more thread-safetrue
Metadata carrying document UUIDStringLeave empty to disable updatingfileNetDocumentId
Variable name of annotation IDStringVariable name of annotation id used to replace it by generated FileNet annotation id${annotationId}
Force deletionBooleanIf no matching document can be found, an error is thrown
WHERE clause for folder researchStringFast2 will update all folders matching the following WHERE statement
Associate annotation FileNet ID to its contentBooleanUpdate annotation content with its generated FileNet id according to annotation id variable
Delete in-place versionBooleanDelete the last document version after checkin a new one
Update system propertiesBooleanIt can only be used for either document creation or update (when a new version is created)
Default MimeTypeStringMime-type to set when none has been found
Fields to updateStringDefault query to select fields to update*
Post-commit deltaIntegerAdd a post-commit time, may be usefull to let FileNet perform asynchronous handling of document injection0
Limit CE connection life-timeLongLimit CE Session life-time : at end of TTL, the Session will be replaced by a brand new oneLong.MAX_VALUE
Force to perform updateBooleanIn case the document did not exist, an error is thrown
WHERE clause for updateStringFast2 will update all documents matching the following WHERE statement

Ex/ [Id]=${myFileNetDocumentId})

FileNetInjector - Injector for FileNet

Use this task to inject documents and data into a FileNet. If all documents have the same UUID for the VersionSeries data provided in the task configuration, then the FileNet versionable object will be created based on the 'MajorVersionNumber' and 'MinorVersionNumber' properties. 'Custom objects' and 'Referential Containment Relationship' are supported. If a document is injected with a folder having a FileNet compatible ID, then the folder will be created with this UUID, if not existing already.

Mandatory settings
KeyTypeDescription
The FileNet connection providerFileNetConnectionProviderThe module establishing the connection to the remote FileNet instance. For more configuration about this object, refer to appropriate section.
ObjectStore nameStringName of the destination object-store where the documents and metadata will be injected
Optional settings
KeyTypeDescriptionDefault value
Property HelperPropertyHelper
Try using 'DocumentTitle' propertyBooleanWhen filing a document into a folder, try to use the FileNet 'DocumentTitle' for the RelationShip name
Process multi-pages content as multi-contentBooleanTreat the content of multi-pages document as multi-content document in FileNet
Keep original VersionSeries IDBooleanIf true, Fast2 will create the multiversion documents with the VersionSeries ID specified in the 'VersionSeries metadata' configuration field.
Dry runBooleanDo not perform anything, just prepare UpdatingBatch and drop when finished. It implies to activate 'Use UpdatingBatch on documents'.
Restrain search results to documentsBooleanForce Document search to limit to the class name provided on the document
Metadata carrying parent folder UUIDStringName of the metadata where Fast2 will store the UUID of the parent folder of the document injected into FileNet P8. Leave empty to disable updating
Only process 1st contentBooleanWhen a document has multiple contents, its forces to process the first one only. The others are then skipped
Inject FileNet securityBooleanDocument dataset must have data 'security'. Syntax must be an array of concatenated Strings as so : gType=<String>/gName=<String>/mask=<Integer>/depth=<Integer>/aType=<String> where <Integer> and <String> values are replaced by the corresponding business values.
Accept unset propertiesBooleanAllow registration of blank metadata in FileNet
Skip content injectionBooleanSkip document content injection, only load the metadata and/or annotations of the processed document
Name of ID propertyStringName of the document property, found in the document dataset, which will be used to force Id at document creation. Leave blank to disable this feature
Throw exception if document already existsBooleanAn exception is thrown in case an older document has been found. To properly use this options, 'Prevent document overwriting' requires to be true
Skip document unfilingBooleanForce to skip Document unfiling to existing folders before linking it to the provided folders. New linkages will be added to the existing ones
Auto-classiify at checkingBooleanEnable the FileNet Auto-Classify feature when the document is at checking stage
Clear in-place annotationsBooleanIf source document contains annotations, clean up existing ones in P8
Synchronous folder creationBooleanEnforce synchronous folder creation, to make them more thread-safetrue
Safe update of documentBooleanTry updating a document. If no older version of the document can be found, create it
Metadata carrying document UUIDStringName of the metadata where Fast2 will store the UUID of the document injected into FileNet P8. Leave empty to disable updatingfileNetDocumentId
Use UpdatingBatch of foldersBooleanUse FileNet UpdatingBatch also for folders creation, which may not be thread-safe
Variable name of annotation IDStringVariable name of annotation id used to replace it by generated FileNet annotation id${annotationId}
Force deletionBooleanForce document delete action. If no matching document can be found, an error is thrown
Associate annotation FileNet ID to its contentBooleanUpdate annotation content with its generated FileNet id according to annotation id variable
Delete in-place versionBooleanDelete the last document version after checkin a new one
Update system propertiesBooleanIt can only be used for either document creation or update (when a new version is created)
Use UpdatingBatch on documentsBooleanRun the 'UpdatingBatch' feature of FileNet, at each punnet being processed.
Default MimeTypeStringThe mime-type to set when no MimeType has been provided neither in document nor its content
Limit CE connection life-timeLongAt end of TTL, the connection will be replaced by a brand new one. Default value is Long.MAX_VALUE9223372036854775807
Fields to updateStringDefault query to select fields to update*
VersionSeries metadataStringName of the VersionSeries property common to all documents in punnet. If all documents have the same value, they will be considered as one same multiversioned document in FileNet.VersionSeries
Post-commit deltaIntegerTime to wait after a commit instruction, may be useful to let FileNet perform asynchronous handling of document injection0
Force folder creationBooleanOverwrite folder canCreate property : create folders when they do not exist
Prevent document overwritingBooleanCheck if the document already exists before creating it using WHERE clause. You can throw an exception in case an older document can be found (see Throw exception if document already exists). If false, create all documents without control
Force to perform updateBooleanForce document Update action. In case the document did not exist, an error is thrown
WHERE clause for updateStringThe criteria which the documents to update will have to match

Ex/ [Id]=${myFileNetDocumentId}

FlowerDocsIndexPlainText - Push input for plain-text search indexing in FlowerDocs

Mandatory settings
KeyTypeDescription
FlowerDocs REST endpointString
UsernameString
PasswordString
ScopeString
Text for indexingPattern
Optional settings
KeyTypeDescription
FlowerDocs document IDPattern

FlowerInjector - Fast2 injector module for FlowerDocs

Allows to load a component (document, task, folder or virtual folder) into Flower. Can load facts, document content and annotations

Mandatory settings
KeyTypeDescription
FlowerDocs connection providerFlowerDocsConnectionProvider
Component categoryStringFlowerDocs component category can be DOCUMENT, TASK, FOLDER or VIRTUAL_FOLDER
Optional settings
KeyTypeDescriptionDefault value
Component
Load document annotationsBooleanfalse
Load document file contentBooleanfalse
Load component factsBooleanfalse
Mode updateBooleanDoes not update contentfalse

MailSender - Email sender task

This task will send custom built emails to specific people or mailing list of your choice.

Mandatory settings
KeyTypeDescription
Email providerMailSenderProviderThe Fast2 module establishing the connection to the email server, from the account of a given user. For more about the configuration of the object, please refer to the appropriate section
Optional settings
KeyTypeDescription
Email subjectStringThe subject/object of the email to send.
Sender addressStringThe value of this field can be resolved by Fast2 (ie you can use dynamic values)
Recipient address(es)String listThe value of this field can be resolved by Fast2 (ie you can use dynamic values)
Multi-line contentString listThe content of the email. It can be composed with different paragraphs, please note Fast2 is not responsible for the text formatting though.

MFilesInjector - Module to inject into M-Files via its public REST API. Java 11 is required for this module.

Module to inject into M-Files via its public REST API. Java 11 is required for this module.

Mandatory settings
KeyTypeDescription
M-Files connection providerMFilesConnectionProviderCredentials to connect to M-Files remote system via its REST API.

MobiusInjector - Inject documents into your ASG Mobius system

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

This task will upload documents and metadata onto Mobius, from version 8 up to version 11. Based on the className and section properties, specify exactly where you'd like your documents to be stored.

Mandatory settings
KeyTypeDescription
Mobius connection providerMobiusConnectionProviderThe Fast2 module required to establish the communication with the destination Mobius instance
Optional settings
KeyTypeDescription
Properties to inject into MobiusString listList of names of the properties which will be added to the topic of the document. These properties have to be attached to the document

MultiUpdateSQLQueryTask - Update a database with several document data

Mandatory settings
KeyTypeDescription
WHERE clauseStringAll matching rows will be updated. This field will be resolved by Fast2 before the task is executed
Query callerSQLQueryGenericCallerThis modules is responsible of establishing the connection between Fast2 and the designated database
Table nameStringThe table of the row to update
Optional settings
KeyTypeDescriptionDefault value
Skip exceptionBooleanFast2 will either throw an error if no update action has been executed, or proceed to next documenttrue
Data to updateString listThe list of all key-values pairs to update the given rows with

Ex/ targetColumnName/documentData

NuxeoInjector - Nuxeo injector using Nuxeo REST API

This task load documents and metadata into a given Nuxeo instance using the Nuxeo REST API. If the document does not have any folder property, he will be injected in the workspace root folder. The documents have to be in the correct version order before entering the Nuxeo task. For Nuxeo to identify the versions as different, either the 'name' or the 'dc:description' data needs to be different.

Mandatory settings
KeyTypeDescription
Nuxeo connection providerNuxeoConnectionProvider
Optional settings
KeyTypeDescriptionDefault value
Attach punnet dataBooleanCheck this option to map the punnet data to Nuxeo propertiestrue
BlacklistString listList of metadata (either on punnet or document) not to map to the Nuxeo documents.
Attach document dataBooleanCheck this option to map the document data to Nuxeo propertiestrue
Injection pathStringDefault path to inject your documents/
Attach foldersBooleanCheck this option to upload the documents into a specified folder architecture based on the details embedded in the documenttrue
Delete annotations when they already existBooleantrue
Replace document if already presentBooleanCheck this option to replace all versions of a document in Nuxeo, based on the data documentId. This feature acts like a replacement. If the document did not already exist, then it will be created from scratch.
Attach contentBooleantrue

OpenTextInjector - OpenText Content Server injector based on custom Rest API

Mandatory settings
KeyTypeDescription
Attribute file pathStringOpenText category must be associated with their ids within the file. Fast2 will automatically translate the data name to the correct id specified by the file

Ex/ ../config/attributes.properties

OpenText credentialsOpenTextCredentials
Expected folder architectureString list
OpenText clientOpenTextRestClient
Optional settings
KeyTypeDescriptionDefault value
List of properties not to injectString listThese properties will be excluded
NodeId of the webReport parameter to useStringOpentext webReports allow users to build search request with specific parameters
List of properties to injectString listIf empty the whole dataSet will be injected
Version document if data existsStringFast2 will check if the data filled in this field for carrying the version and the 'nodeId' data are available at document level. If so, the document will be injected within OpenText and its version increased by one. A new data 'createdVersion' will be added to the document
Ticket periodIntegerTime in seconds between two ticket creation60

SQLQueryTask - Add data to documents in database

Simple task to query a SQL database and fill each Document data with results

Mandatory settings
KeyTypeDescription
Key of target dataStringThe name of the data where the value must be added
Query callerSQLQueryColumnCallerThis modules is responsible of establishing the connection between Fast2 and the designated database
Key of source dataStringThe name of the data to update the documents with. If the data is not retrieved from the document, Fast2 will skip this document
Optional settings
KeyTypeDescriptionDefault value
Reset target dataBooleanClean content when target already existstrue

SQLStatementTask - Insert or updated database

With this task, you will be able to perform any SQL instruction (such as insertions and updates) on any given table of the specified database

Mandatory settings
KeyTypeDescription
SQL statementStringThe statement you want Fast2 to run on the database. The syntax needs to match SQL standards. Use a ? to reference your annotation

Ex/ INSERT INTO table_name (doc_id, annotation) VALUES ('${documentId}', ?);

Query callerSQLQueryGenericCallerThis modules is responsible of establishing the connection between Fast2 and the designated database
Optional settings
KeyTypeDescription
Inject annotationsBooleanFast2 will either throw an error if the statement has not properly been executed, or fail silently
Skip exceptionsBoolean

UpdateSQLQueryTask - Update SQL database

This task will perform update instructions base on document data onto a given SQL database

Mandatory settings
KeyTypeDescription
SQL connection providerSQLQueryGenericCallerThe module establishing the communication between Fast2 and the designated database
Name of the new columnStringThe name of the column which will be added to the row with the value to update
Table nameStringThe name of the SQL table on which all update statements will be performed
Optional settings
KeyTypeDescriptionDefault value
WHERE clauseStringAll matching rows will be updated. This field will be resolved by Fast2. Leave empty to target all rows.
Ignore when no row updatedBooleanSkip exception when no database row has been updatedtrue
Value to updateStringName (= key) of the document metadata whose value will be inserted into the row. If none is found in the document, this latter is skipped