Login
Home CMS Documentation Home CMS 10 Custom Plug-in Applications CMS 10.6 External Modules Ingeniux AI System AI System Configuration Configuring AI External Module

Configuring AI System External Module

Prerequisites:
  • CMS 10.6 must be installed. See CMS Statistics to check the site version.
  • System administrators must have access to the CMS site instance file system.

The Ingeniux AI System external module requires system administrators to configure ExternalModules.json before setting up the external module in the CMS.

To configure AI system external module server files:

  1. Configure ExternalModules.json by completing the following steps:
    1. Navigate to [Drive]:[path-to-CMS-root-folder]\site\App_Data.
    2. If ExternalModules.json doesn't exist, download the following ExternalModules.json, and copy and paste the file within the App_Data folder.
      Warning
      Only deploy this file once. If the existing ExternalModules.json has configurations for other modules, re-deploying this file will overwrite them.
    3. If ExternalModules.json already exists, then open the file in a text editor, copy the following code snippet, and paste the code into the open file.
      Important
      Ensure the code snippet nests directly within the outermost square brackets in the JSON file. Do not paste the snippet within another external module's code.
      AI module configuration
      [
  {
    "Name": "AIModule",
    "Url": "https://ai.ingeniuxondemand.com/scripts/cmsaimodule/hookup/cms-ai-hookup.js",
    "Styles": [
      "https://ai.ingeniuxondemand.com/scripts/cmsaimodule/styles.css"
    ]
  }
]

      You can leave the copied AIModule code as is in ExternalModules.json. However, keep the following values in mind:

      ObjectValueDescription
      NameAIModuleName of the Ingeniux AI System external module.
      URL https://ai.ingeniuxondemand.com/scripts/cmsaimodule/hookup/cms-ai-hookup.jsURL to the AI system external module's hookup script.
      Styles https://ai.ingeniuxondemand.com/scripts/cmsaimodule/styles.css

      URL to additional styles for the AI system external module. The styles provided in the URL will load into the CMS.

      This file contains Ingeniux default styles. However, you can apply your own where needed.

      Caution

      We strongly recommend applying as minimal additional styling as possible.

      If module styles conflict with CMS styles, they may interfere with CMS functionality and user experience.

    4. Save and close ExternalModules.json.
  2. Recycle the CMS instance application pool by completing the following steps:
    Important
    We strongly recommend coordinating with your organization before recycling the application pool, as the CMS instance will not be accessible while the recycle process runs. Consider completing this action during a maintenance period.
    1. Open Internet Information Services Manager (IIS), and navigate to the CMS instance application pool.
    2. Right-click the application pool, and select Recycle.

      The CMS instance application pool recycles.

Next Steps: Manage the custom tab for the Ingeniux AI System external module.