Skip to main content

Integration Job Configuration

A Simflofy Job is the process of moving or syncing content(including versions, ACL's, metadata) from one CMS (content management system) to another. Since Simflofy Jobs are specifically engineered for content management systems,moving content and metadata is just point and click. There are many Job types as well as Job Tasks that can handle anything from data validation and cleansing to duplication detection.

Job Types

There are several Job Types available depending on the use case.

  • Simple Migration: Unlike Sync Jobs, deletions are not processed and content state is not recorded locally other than normal Job Auditing. Simple Migration uses manually entered timestamps whereas Incremental Migration will increment timestamps for each job run.
  • Incremental Migration: Same as Simple Migration except at the start of each job run the query timestamps will be incremental automatically from the end of the last job run to the beginning of the current job run.
  • Polling: A simple migration that runs continuously, the job processes at a specified interval and then sleeps until the next processing time. While it sleeps, the status of this job will be Waiting.
  • Event: This type of job acts as a listeners for certain Content Service events, in order to run individual documents through a job, without starting and stopping the job. They can be triggered through a push event or by an event configuration. While not running, these jobs will show the status Ready.
  • Legacy Sync: Sync content between content management systems. Simflofy keeps the contents state (version) recorded locally for doing deltas on subsequent job runs. Legacy Sync is for older systems where you cannot query for deletes. In this case, Simflofy will check each record under control for existence and versioning. An example of a legacy CMS is the filesystem on your computer. Only content that has been updated or deleted since the last job run will be processed.
  • Sync: Same as Legacy Sync, except for newer systems where deletes can be queried,thereby eliminating the need to check each record for existence. This decreases the job execution time. Each piece of content synced is still recorded locally for reference, but is not used for deltas as newer systems can rely on querying by timestamps.

Job Configuration Fields

Standard Options

  • ID: (read only) The unique identity of this Job. If running jobs using the RESTful interface or command line, this is the Job ID to enter.
  • Name: Descriptive Name of the Job that will be displayed throughout the UI.
  • Content Service Connector: If using a Content Service Connector, set it here, and it will be appended to every record processed. This field is required for Federation Integration jobs.
  • Repository Connection: (read only) The Repository Connection used for this Job. Note that this field is not editable after job creation.
  • Output Connection: (read only) The Output Connection used for this Job. Note that this field is not editable after Job creation.
  • Type: The Type of Simflofy Job.
  • Job Tags: Another option for separating jobs into groups. If any jobs have tags, they will appear as a filtering option when listing jobs.
  • Include documents modified after this date and time: Referred to as "Start Time", this time will be used to check the last modified date of files before processing them.
  • Include documents modified before this date and time: Referred to as "End Time", this time will be used to check the last modified date of files before processing them.
Start and End Time

These values are only set by users for Simple Migrations. For Incremental Migrations, they are calculated based on when the job was last run. Event and Polling jobs don't use them at all

Notifications

Notifications will only function is email is enabled. This allows the user to set conditions in which the listed email addresses will receive confirm status reports when a job completes.

Auditing

  • Audit: Where to write audit data too. Note that Job Restart and Document Search will only work if Mongo is selected.
    • Mongo: Audit to the Mongo Database or SQL Database if running in SQL mode.
    • Log4j: Audit to the simflofy-admin.log
    • None: Auditing is turned off.
  • Record Audit When: The audit level or what to audit.
    • All (Read, Written, Skipped, Deleted and Failed): Full Auditing
    • Failures Only: Audit only those records that fail during a job run.
    • Failed and Deleted: Audit a record that failed during the job run or was deleted from a Sync Job.
    • Failed and Skipped: Audit a record that failed during the job run or was skipped.
    • Failed, Deleted and Written: Audit a record that failed during the Job run or was deleted from a Sync Job or written by the Output Connection.

More detail on Auditing in Simflofy

Advanced Options

  • Max Queue Size: Limits the number of documents that can be queued at once, making repository workers wait. This can slow down output speeds, which may be useful if your output repository can be throttled.
  • Max Errors Allowed: Maximum errors before the job stops. Leave 0 for unlimited errors.
  • Repository Connection Thread Count: The number of individual workers which will process and queue documents. Implementation may vary in certain systems.
  • Output Connection Thread Count: The number of individual workers which will process and post documents. Implementation may vary in certain systems.
  • Batch Size: If greater than 0, Documents will be assigned a batch ID and tracked in the Batch History. Batch Ids are a combination of the job id and the job run id (the timestamp of when the job was started), plus the batch number. The batchId will also be set as the highest parent folder for the document. (Ex. /home/simflofy will become {batchId}/home/simflofy). Some connectors have their own batch configuration, which is compatible with this field.
  • Repository and Output Time Zone: These values will be used to adjust date fields (Created, Modified, and Mapped) to the appropriate timezone for their destination.
  • Chain Job: What job to run after this one completes.
  • Chain Job Wait Interval: Amount of time to wait after job completes before starting next job in format: 5s 5m 5h 5d
  • History Retention: How long to keep the Job Run History for this job before the Job History Cleanup Service clears the content.

Related Articles:
Simflofy Integrations
Simflofy Job Tasks List
Frequently Asked Questions

Last updated on by rjosefsberg