Creating a Federation Services Event Job - Alfresco Federation Services - 3.2 - 3.2 - Ready - Alfresco - external - Alfresco/Alfresco-Federation-Services/3.2/Alfresco-Federation-Services/Using/Integrations/Job-Setup-and-Configurations/Event-Job-Configurations/Creating-and-Event-Job/Creating-a-Federation-Services-Event-Job - 2025-03-04

Alfresco Federation Services
Platform
Alfresco
Product
Alfresco Federation Services
Release
3.2
License
  1. Create a File System Connection:
    1. Log into the Federation Services Admin tool (http://(your server)/Federation-Services-admin).
    2. On the left-hand side expand Connections and choose Integration.
    3. At the top left corner of the screen, click the button Create Integration Connection. Fill out the popup screen and click Save. This creates a connection to the File System that you can use as both a source and a target connection.

    After you click Save, another screen shows the connection, click Save again.

    You will need a connection to your source and target repositories. Because our source and target repositories are the same, we only need to create one connection.

  2. Create an Event Job:

    A Federation Services Job is the process of moving or syncing content (including versions, ACL’s, metadata) from one CMS (content management system) to another. Since Federation Services 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.

    In the Federation Services Admin tool:

    1. Expand Integration on the left-hand menu and choose List Jobs.
    2. On the right-hand side, click the button Create New Job.
    3. Enter the data into the popup screen and click Save. The Repository Connection is the source system and the Output Connection is the target system.
    4. For Job Type, select Event
    5. Click Save on the popup, and you are presented with the edit screen for your job.
    6. The source file path should be set to include the location of the files you want to push. In our case we will set it to C:\SourceDocuments. Any files in SourceDocuments or its subfolders will be able to be pushed.
      Note: It is possible to set the File Path to a root drive such as C:\\. We do not recommend doing this as it would allow any file on that drive to be pushed.
    7. Next we need to enter the target folder. Click on FileSystem Connection-Output tab and enter the target folder where the file(s) will be copied (migrated) to: C:\TargetFolder.
    8. We will leave the default values for everything else and click Save.

      This saves our event job, and we are ready to execute it.

  3. Execute the Event Job (Using an API call):

    We have to tell the event job which document we want to process. This requires making an API call and passing two parameters, jobId and documentId.

    1. Find the job ID: To get the jobId, open the job and on the Details page look for the ID field. Edit or view the job we just created to see the job id.
    2. Find the document ID: To get the documentId, use the full path of the document, i.e. C:/SourceDocuments/sampledoc.pdf. In the SourceDocuments folder we will be copying sampledoc.pdf. Therefore, the documentId will be the full path: C:/SourceDocuments/sampledoc.pdf. Note the forward slashes.
    3. Construct an API url and call it.

    Construct the API URL:

    We will now call the API to push the document into the queue for processing.

    URL format:

    http://{HOST}:{PORT}/3sixty-admin/api/event/service/pushevent?jobId=1631569493226&documentId=C:/SourceDocuments/sampledoc.pdf

    Example curl command:

    curl -u username:password "http://localhost:8080/3sixty-admin/api/event/service/pushevent?jobId=1631569493226&documentId=C:/SourceDocuments/sampledoc.pdf"

    Once the API is called, the document will be placed in a queue and the event job we created above will be started.

    The Source file will be copied to the destination folder TargetFolder. (note the full path of the source document is copied to the target folder.)

    You can continue to call the API with different document IDs, and they will be processed as soon as they are inserted into the queue.

    Also, note that the event job will continue running until you kill the job.

    To kill a job, on the left-hand menu under Admin, select Active Jobs - Select the trash can icon to kill the job.