Sign in
Event Handling Framework
Event Handling Framework   SaaS Installation Guide   Installing Event Handling Framework in a SaaS Environment

Installation

May 11, 2026 09:32 AM
2 min read

  1. Open the main folder of the Aras Event Handling Framework 39 CD Image:

    1. Copy the folder Innovator into the CodeTree folder in the repository.
    2. Navigate to .\imports\com\aras\innovator\ and copy the folder EHF into the AML-packages folder of the repository.
  2. Navigate to the imports folder in the Aras Event Handling Framework 39 CD Image and copy the content of the file imports.mf to the buffer.
  3. In the repository, edit the file AML-packages\imports.mf and paste the lines from step 2
  4. Save and close the file
  5. In the repository, navigate to the folder TransformationsOfConfigFiles and create the folders Innovator and Innovator\Server

  6. Navigate to the folder Innovator\Server and create a new file method-config.xml and copy/paste the following lines:

    <MethodConfig xmlns:xdt="http://schemas.microsoft.com/XML-Document-Transform">

    <ReferencedAssemblies>

    <name xdt:Transform="Insert">/app/Plugins/store/x64/net6.0/aras.eventhandlingframework.plugin/1.0.0/lib/net6.0/Aras.EventHandlingFramework.dll</name>

    <name xdt:Transform="Insert">/app/Plugins/store/x64/net6.0/aras.eventhandlingframework.plugin/1.0.0/lib/net6.0/Aras.EventHandlingFramework.BackgroundService.dll</name>

    <name xdt:Transform="Insert">/app/Plugins/store/x64/net6.0/aras.eventhandlingframework.plugin/1.0.0/lib/net6.0/Aras.EventHandlingFramework.Plugin.dll</name>

    <name xdt:Transform="Insert">/app/Plugins/store/x64/net6.0/aras.eventhandlingframework.plugin/1.0.0/lib/net6.0/Aras.Plugins.Infrastructure.dll</name>

    <name xdt:Transform="Insert">/app/Plugins/store/x64/net8.0/aras.eventhandlingframework.plugin/1.0.0/lib/net6.0/Aras.EventHandlingFramework.dll</name>

    <name xdt:Transform="Insert">/app/Plugins/store/x64/net8.0/aras.eventhandlingframework.plugin/1.0.0/lib/net6.0/Aras.EventHandlingFramework.BackgroundService.dll</name>

    <name xdt:Transform="Insert">/app/Plugins/store/x64/net8.0/aras.eventhandlingframework.plugin/1.0.0/lib/net6.0/Aras.EventHandlingFramework.Plugin.dll</name>

    <name xdt:Transform="Insert">/app/Plugins/store/x64/net8.0/aras.eventhandlingframework.plugin/1.0.0/lib/net6.0/Aras.Plugins.Infrastructure.dll</name>

    </ReferencedAssemblies>

    </MethodConfig>

  7. In the same folder Innovator\Server, create a new file InnovatorServer.Plugins.json and copy/paste the following lines:

    {

    "@jdt.merge": {

    "@jdt.path": "$.*",

    "@jdt.value": [

    {

    “Name": “Aras.EventHandlingFramework.Plugin”,

    “Enabled": true,

    “Options": {

    “EventsHandlingBackgroundServiceSettings": {

    “CycleDelayInSeconds": 5,

    “EventsProcessingSettings": {

    “EventsHandlingThreadsCount": 10,

    “EventsPullBatchSize": 100

    }

    }

    }

    }

    ]

    }

    }

    Note that parameter values can be customized as needed.

  8. Run the build process on a local environment and test that the application is installed.
  9. Create a pull request to commit the changes to the central repository. Users may need to request a code review before merging the changes, depending on the organization’s policies.
  10. Run the Continuous Integration pipeline to build images with the changes related to Event Handling Framework
  11. Once the Continuous Integration pipeline has completed, run Deploy pipeline on packages built in previous step.
Previous Topic
Prerequisites
Next Topic
Confirming the Installation