Install AI Module 2


Prerequisites:
  • CMS 10.6.342+ must be installed. See CMS Statistics to check the site version.
  • System administrators must have access to the CMS site instance file system.
  • If your organization is not using the Ingeniux AI system default access for the ChatGPT connection, administrators must have their OpenAI ChatGPT API key.

    See OpenAI: Where do I find my OpenAI API key? for details to obtain a private ChatGPT API key.


Integrate Ingeniux AI Generation version 2 by setting up the external module through CMS 10.6 custom applications. Review the installation and setup process.

This process includes:

  1. Install AI Taxonomy Classifier and Configure Module
  2. Add Custom Tab
  3. Configure Application
Note
Remember to update the Ingeniux AI module when new updates become available.

Install AI Taxonomy Classifier and Configure Module

Install the AI Taxonomy Classifier DLL and configure ExternalModules.json on the CMS server before setting up the external module in the CMS.

To install and configure the AI Taxonomy Classifier DLL on the CMS server:

  1. Download the AI Taxonomy Classifier .zip package for your CMS version (filter by "Ingeniux AI Module").
  2. Extract the contents of the .zip file into the App_Data\xml\Custom folder in your CMS instance installation. Ensure that the unpacked .zip maintains the packaged folder structure to the DLL.

    For example:

    [Drive:]\[path-to-cms-site-instance]\App_Data\xml\Custom\AI Taxonomy Classifier\bin\GetAllTaxonomy.dll

  3. 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://ai2.ingeniuxondemand.com/scripts/cmsaimodule/hookup/cms-ai-hookup.js",
          "Styles": [
            "https://ai2.ingeniuxondemand.com/scripts/cmsaimodule/styles.css"
          ]
        }
      ]

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

      ObjectValueDescription
      NameAIModuleName of the Ingeniux AI System external module.
      URL https://ai2.ingeniuxondemand.com/scripts/cmsaimodule/hookup/cms-ai-hookup.jsURL to the AI system external module's loading script.
      Styles https://ai2.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.
  4. 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 recycling process runs. Consider completing this action during a maintenance period.
    1. Open Internet Information Services Manager (IIS), then navigate to the CMS instance application pool.
    2. Right-click the application pool then select Recycle.

      The CMS instance application pool recycles.

Add Custom Tab

CMS administrators add an AI custom tab to the CMS as part of the Ingeniux AI System setup process. The custom tab defines the CMS administration endpoint for the external module and defines the application scope within the CMS. After adding the custom tab, administrators can modify the AI application in the Apps area.

To add the Ingeniux AI System custom tab in the CMS:
  1. Navigate to Administration > System Options > CMS > Custom Tabs > Management.
  2. Select Add.

    Add Custom Tab

    The New Custom Tab dialog displays.
  3. Enter AI in the custom tab name field, then select Confirm.
    The new AI custom tab entry displays as expanded in the list.
  4. Enter the following value in the URL field:
    Ingeniux AI System URL
    https://ai2.ingeniuxondemand.com/cmsadmin

    Enter AI URL in URL Field

  5. Select only the Global App checkbox in the Scope section.
  6. Optional: Choose a CMS System graphic from the Pick Icon drop-down list.

    This graphic serves as the icon for the AI system custom application in the Apps area.

    Note
    You can choose an alternative icon Location instead of CMS System. See Adding Custom Tabs for details about alternative icon options.

    Pick Icon Graphic

  7. Click the Save button Save Button in the top left-hand corner of the Custom Tabs Management Configuration screen to register the new custom tab and save your changes.

Configure Application

Prerequisites: If your organization is not using the Ingeniux AI System default access for the ChatGPT connection, administrators must have their OpenAI ChatGPT API key.

See the Account setup section within the OpenAI: Developer quickstart documentation for details to obtain the private ChatGPT API key.


Configure the AI application in the CMS as part of the Ingeniux AI System setup process. The application interface provides settings to activate the AI system connection, activate ChatGPT access, and choose permissions for user groups.

To configure the Ingeniux AI System application:
  1. Navigate to Apps via the main navigation menu.
  2. Select the AI application in the Apps list.

    Apps Navigation List

    The Ingeniux AI System application settings display in the Setup. If the AI system is not set up, the Status field displays the text Provisioning.
  3. Select Activate Connection in the 1. Connection Activation section.

    Activate Connection in "1. Connection Activation"

    The connection between the AI system and the CMS instance activates, as indicated by the AI Connection Status field.
  4. Choose your ChatGPT access point preference in the 2. ChatGPT Activation section by selecting one of the following options.
    • Select the Use default Ingeniux provided ChatGPT access option.

      Choose this option to use the AI system with Ingeniux default access. This option does not require you to enter an API key and provides your organization with up to 100,000 AI tokens per month. This restriction applies to your organization as a whole, rather than on a "per user" basis.

      If your organization exceeds the token limit, your Ingeniux account manager will contact you.

    • Select the Access ChatGPT with your own API key option.

      Choose this option to provide your own ChatGPT API key. By providing your own private key, you can connect your ChatGPT profile with the Ingeniux AI system.

      See the prerequisite for details to obtain your API key.

  5. Click the Activate button.

    Choose ChatGPT API Key in "2. ChatGPT Activation"

    The AI system activates with the access point you provided, as indicated by the ChatGPT Status field.
    Important
    To validate your API key after you complete AI installation, app configuration, and usage requirements, use the Ingeniux AI Generation module to generate content for content item text fields. Note this validation test will require you to use some AI tokens.
  6. Determine which user groups will have permission to access the AI system tool by completing the following steps in the 3. Permissions section.
    1. Select Choose Groups.

      Choose Groups in "3. Permissions"

      The Choose User Groups... dialog displays.
    2. Select groups in the All Groups (left) column.
      Tip
      • You can select the Search button Search Button in the All Groups column, then enter keywords in the field that displays to search for available groups.
      • You can select the checkbox next to All Groups to select all available groups.

      The selected groups display in the Groups Chosen (right) column. The system will provide AI system tool permissions for groups within this column.

      CMS 10.6 Choose User Groups... Dialog

    3. Select Choose Groups.

      The selected groups display in the user groups with AI system permissions list.

      Tip
      You can create new user groups directly AI system app settings by selecting Create New Group in the 3. Permissions section. Enter a Group Name in the Create New User Group dialog that displays, and select Create Group. The AI system automatically provides AI system permissions to the new group.

      Refresh the AI system app settings interface to see the new group in the permissions list. See Creating Groups for details to further modify the group's settings and to add user members.

    The Ingeniux AI System becomes activated for the CMS site. The app settings interface displays the Status field value as Enabled. This indicates you completed each part of the setup, including Connection Activation, ChatGPT Activation, and Permissions.

    You may need to refresh the app settings interface to see the Status switch to Enabled.

    Tip
    You can disable or enable the Ingeniux AI System application at any time by turning the toggle switch Enable or Disable AI Toggleoff (disabled) or on (enabled). The toggle switch resides directly under the Setup tab heading in the top right corner of the app settings. When disabled, the Ingeniux AI System tool becomes inaccessible to users.

    CMS 10.6 Create New Group in "3. Permissions"

Update AI Taxonomy Classifier

Prerequisites: System administrators must have access to the CMS server and must have access to the latest AI Taxonomy Classifier DLL package.

There may be need to update the AI Taxonomy Classifier DLL to access feature updates, enhancements, and fixes to the AI module as they become available.

To update the AI Taxonomy Classifier DLL to the latest version:
  1. Stop the CMS instance application pool by completing the following steps:
    1. Open Internet Information Services Manager (IIS), and navigate to the CMS instance application pool.
    2. Right-click the application pool, and click Stop.
      The CMS instance stops running.
  2. Navigate to [Drive:]\[path-to-cms-site-instance]\App_Data\xml\Custom, then delete the entire AI Taxonomy Classifier folder.
  3. Extract the new AI Taxonomy Classifier DLL .zip file to App_Data\xml\Custom.
  4. Start the CMS instance application pool by completing the following steps.
    1. Open Internet Information Services Manager (IIS), and navigate to the CMS instance's application pool.
    2. Right-click the application pool, and click Start.
      The CMS instance starts running.

Next Steps: Review AI usage requirements to ensure the external module is functioning properly.