Post-deployment Configurations

You must apply some configurations that are available on the Unica Platform, via Unica Platform UI, so that the MaxAI services (config service) can access and use these configurations for MaxAI components, which results in pods and services coming up smoothly.

1: MaxAI navigation Configuration

Procedure

  1. Navigate to Settings > Configuration.
  2. Expand MaxAI and select navigation.
  3. Select Edit settings.
  4. Provide values for the following fields:
    welcomePageURI
    The welcomePageURI property is used internally by other applications. It specifies the Uniform Resource Identifier of MaxAI index page.
    seedName
    The seedName property is used internally by other applications. You must not change this value. The default value is AION.
    type
    The type property is used internally by other applications. You must not change this value. The default value is AION.
    httpPort
    This property specifies the port used by MaxAI. If your deployment of MaxAI uses a port that is different from the default port, you must edit the value of this property. The default value is 80.
    httpsPort
    If SSL is configured, this property specifies the port used by MaxAI for secure connections. If your deployment of MaxAI uses a secure port that is different from the default port, you must edit the value of this property. The default value is 443.
    serverURL
    Must have the same value as the Platform URL. Example value is with https://<domain-name>/aion.
    logoutURL
    The logoutURL property is used internally to call the logout handler of the application, if the user clicks the logout link. Do not change this value. The default value is /platform/logout/.
    serverURLInternal
    Must have the same value as the Platform URL. Example value is with https://<domain-name>/aion.
    chatBotServerURL
    Must have the same domain as the Platform URL. Example value is with https://<domain-name>.
    displayName
    The display name of the app. Default value is MaxAI.
    offerTextGenAIServiceURL
    Must have the same domain as the Platform URL. Example value is with https://<domain-name>/maxai.
    maxAiAgenticApiURL
    Must have the same domain as the Platform URL. Example value is with https://<domain-name>.
    cdpBaseURL
    The setup URL configured for CDP segmentation.
    Example: https://<cdp-domain>/api/segment

2: MaxAI proxy Configuration

Procedure

  1. Navigate to Settings > Configuration.
  2. Expand MaxAI and select Proxy.
  3. Select Edit settings.
  4. Provide values for the following fields:
    Proxy host name
    The hostname or the domain name of the proxy server.
    Proxy port number
    The port number of the proxy server.
    Proxy type
    The web server type. HTTP / HTTPS.
    Data source for credentials
    Specify the data source name that contains the proxy server username and password details.
    Unica user with data source for proxy credentials
    Specify the name of the Unica user that has the specified data source in the Data source for credentials property.

3: MaxAI Assistant Database Configuration

About this task

Note: Currently, MaxAI only supports MariaDB as its system database.

Procedure

  1. Navigate to Settings > Configuration.
  2. Expand MaxAI and select Assistant database.
  3. Select Edit settings.
  4. Provide values for the following fields:
    Parameter name Description / Value
    Database type MariaDB
    Database host In case of internal DB, running as pod, it should have the servicename. In case of external DB, it should be the IP of the DB instance.

    genai-hcl-genai-suite-database
    Database port 3306
    Unica user for database credentials asm_admin
    Data source for database credentials You can use any value, however that same value needs to be used while further modifications are done under above user datasource configuration.

    MAXAI_ASSISTANT_DATASOURCE
    Database/service name ce_metering_db
    Important: In addition to the configuration in Platform settings, the integration between MaxAI and the CDP is dependent on database schema definition and MaxAI prompts. This schema is stored in the MaxAI GenAI Assistant database and is used by the MaxAI services to understand your customer data structure.
    CDP database schema registration and prompt updates are handled by the DevOps team. However, please confirm with the DevOps team that:
    • The CDP schema has been correctly registered.
    • The prompt configurations have been updated and MaxAI services restarted.

    This coordination ensures your MaxAI segmentation setup functions correctly. If you need to modify the data schema later, please contact your administrator.

4: MaxAI Session Cookie Configuration

Procedure

  1. Navigate to Settings > Configuration.
  2. Expand MaxAI and select Session Cookie.
  3. Select Edit settings.
  4. Provide values for the following fields:
    Parameter name Description / Value
    Cookie Name Can be any name of your choice.

    MAXAISESSIONAID
    Session Timeout 900
    Domain Must be the same as the agentic MaxAI Agentic domain.

    <domain-name>
    Cookie Path /maxai
    Same Site Strict

5: MaxAI CORS Configuration

Procedure

  1. Navigate to Settings > Configuration.
  2. Expand MaxAI and select CORS Configuration.
  3. Select Edit settings.
  4. Provide values for the following fields:
    Enable CORS
    Enable or Disable CORS.
    Allowed Origins (comma-separated)
    Add domains or hostnames separated by a comma.
    Allowed Methods
    Add the allowed API methods: GET,POST,PUT,DELETE,OPTIONS.
    Allowed Headers
    Add the allowed API headers: access-control-allow-origin, Content-Type, Authorization, m_tokenId, sso_destapp, api-auth-mode, cache-control, m_user_name, cache-control, pragma, xsrf_token, Origin, Access-Control-Request-Method
    Allow Credentials
    Enable or Disable credentials for API.

6: MaxAI Partition Configuration

Procedure

  1. Navigate to Settings > Configuration.
  2. Expand MaxAI > Partitions.
  3. Select (partitionTemplate).
  4. For the field New category name, provide the value partition<n>.
  5. Click Save changes.

7: MaxAI partition<n> Configuration

Procedure

  1. Navigate to Settings > Configuration.
  2. Expand MaxAI > Partitions > partition<n> > Data Sources > System.
  3. Select (Database details template).
  4. Provide values for the following fields:
    Parameter name Description / Value
    Unica Product Campaign
    Database type Must be the same as Unica deployment.

    For example, MariaDB.

    MaxAI supports MariaDB, IBM DB2, Oracle, and Microsoft SQL Server as the system database of the respective products for analytical queries. In the list, you will see Actian database, but it is not supported currently.
    Database host Unica Database Host (Internal - servicename or external - host IP).

    hcl-unica-suite-database
    Database port 3306
    Unica user for database credentials asm_admin
    Data source for database credentials You can use any value, however that same value needs to be used while further modifications are done under above user datasource configuration.

    MAXAI_CAMPAIGN_DS
    Database/service name Unica campaign database name. You can fetch the values from the values.yaml file of Unica deployment.

    campaigndb
  5. Perform Step 3 and Step 4 to configure another data source with the following values:
    Note: Proceed with the following configurations only if your Unica Journey installation has a single partition setup. If your Journey installation has a multi-partition setup, do not proceed with the following configurations. Currently, MaxAI does not support multi-partition setup for Unica Journey.
    Parameter name Description / Value
    Unica Product Journey
    Database type Must be the same as Unica deployment.

    For example, MariaDB.

    MaxAI supports MariaDB, IBM DB2, Oracle, and Microsoft SQL Server as the system database of the respective products for analytical queries. In the list, you will see Actian database, but it is not supported currently.
    Database host Unica Database Host (Internal - servicename or external - host IP).

    hcl-unica-suite-database
    Database port 3306
    Unica user for database credentials asm_admin
    Data source for database credentials You can use any value, however that same value needs to be used while further modifications are done under above user datasource configuration.

    MAXAI_JOURNEY_DS
    Database/service name Unica campaign database name. You can fetch the values from the values.yaml file of Unica deployment.

    journeydb
    Note:
    • Ensure that the user has only read-only permissions for the respective database schema.
    • Create a separate user accounts with only read-only access dedictaed for each schema. Ensure that user does not have access to any other schema. Example: If a user John Doe has access to Campaign and Journey data source, create separate user IDs for John Doe, one for Campaign and one for Journey, and use these two IDs for configuration in MaxAI.

7.1: User Data Source Creation

Procedure

  1. Navigate to Settings > Users.
  2. Select the user that you used for all previous configurations. For example, asm_admin.
  3. Select Edit data sources.
  4. Select Add new.
  5. Configure four data sources one after the other by selecting Add new after completing the configuration of a data source. Use the following tables as values for each datasource:
    Parameter name Description / Value
    Data source This must be the same datasource configured during 3: MaxAI Assistant Database Configuration.

    MAXAI_ASSISTANT_DATASOURCE
    Data source login Provide the MaxAI Assistant database username.
    Data source password Provide the MaxAI Assistant database password.
    Confirm password Retype the MaxAI Assistant database password.
    Parameter name Description / Value
    Data source This must be the same datasource configured during 7: MaxAI partition<n> Configuration.

    MAXAI_CAMPAIGN_DS
    Data source login Provide the username for Campaign system database.
    Data source password Provide the Unica Campaign system database password.
    Confirm password Retype the Unica Campaign system database password.
    Parameter name Description / Value
    Data source This must be the same datasource configured during 7: MaxAI partition<n> Configuration.

    MAXAI_JOURNEY_DS
    Data source login Provide the username for Journey system database.
    Data source password Provide the Unica Journey system database password.
    Confirm password Retype the Unica Journey system database password.

8: MaxAI partition<n> Features Configuration

Procedure

  1. Navigate to Settings > Configuration.
  2. Expand MaxAI > Partitions > partition<n>.
  3. Select Features.
  4. Select Edit settings.
  5. Set the value Enabled for all the fields:
    • MaxAI Assistant
    • Document Search
    • Email Text Generation
    • Subject Line Analysis
    • Analytics (Campaign)
    • Analytics (CDP)
    • Analytics (Deliver)
    • Analytics (Journey)
    • Analytics (RTP)
    • Insights (Reports)
    • Insights (Journey)
    • Insights (Email and Scoring)
    • Plan Approval
    • Segmentation (CDP)
    • Offer Text Generation
    Note: Even if you enable all the features, you must still assign permissions to user roles for the feature. For more information, see 13: Assigning Permissions to the Roles.

9: MaxAI partition<n> CDP Configuration

Procedure

  1. Navigate to Settings > Configuration.
  2. Expand MaxAI > Partitions > partition<n>.
  3. Select CDP.
  4. Select Edit settings.
  5. Provide values for the following field:
    CDP Tenant ID
    The ID of the CDP Tenant.

10: MaxAI partition<n> LLM Configuration

Procedure

  1. Navigate to Settings > Configuration.
  2. Expand MaxAI > Partitions > partition<n>.
  3. Select LLM.
  4. Select Edit settings.
  5. Provide values for the following fields:
    Parameter name Description / Value
    Max Token Per User For unlimited tokens, provide the value 0.
    Note: There is a daily limit and once the limit is exhausted, the system resets the limit on the next day.

11: MaxAI partition<n> LLM OpenAI Configuration

Procedure

  1. Navigate to Settings > Configuration.
  2. Expand MaxAI > Partitions > partition<n> > LLM.
  3. Select OpenAI.
  4. Select Edit settings.
  5. Provide values for the following fields:
    Parameter name Description / Value
    Display Name OPENAI.
    Unica user for model access key asm_admin
    Data source for model access key You can use any value, however it is recommended that you use the same value used when configuring datasource configuration.

    MAXAI_OPENAI_DATASOURCE

11.1: User Data Source Creation

Procedure

  1. Navigate to Settings > Users.
  2. Select the user that you used for all previous configurations. For example, asm_admin.
  3. Select Edit data sources.
  4. Select Add new.
  5. Configure four data sources one after the other by selecting Add new after completing the configuration of a data source. Use the following tables as values for each datasource:
    Parameter name Description / Value
    Data source MAXAI_OPENAI_DATASOURCE
    Data source login dummy
    Data source password Provide the OpenAI key.
    Confirm password Retype the OpenAI key.

12: Assigning Roles to Users for Accessing MaxAI

Procedure

  1. Navigate to Settings > Users.
  2. Select the user that you used for all previous configurations. For example, asm_admin.
  3. Select Edit roles.
  4. From the Available roles list, select MaxAI Admin (Unica MaxAI) and click the >> button to add the role to the Selected roles list.
  5. Click Save changes.
    Note: For the changes to apply, log out and log back in to Unica.

13: Assigning Permissions to the Roles

Procedure

  1. Navigate to Settings > User roles and permissions.
    The User roles and permissions page opens.
  2. In the Products and their roles panel, expand Unica MaxAI and select partition<n>.
  3. Select Add roles and assign permissions. The available permissions for roles are as follows:
    • Assistant
      • Query Analytics - User can ask queries from MaxAI assistant.
      • Generate Content - User can generate content for Deliver as Subject Line Analysis and Offer Text Generation.
      • View Insights - User can view Journey and Deliver Insights.
      • Create Segment - User can create segments in CDP.
    • Reports
      • View Insights - User can generate insights for product's dashboard report.
    • Workbench
      • Access MaxAI Workbench - User can access MaxAI Workbench.
  4. Click Save and edit permissions.
    Note:
    • Users do not need permissions for performing documentation search queries.
    • In 8: MaxAI partition<n> Features Configuration, if you have enabled a feature, you still need to assign the respective permission to the role or else the feature will be disabled for the user role.
  5. Expand Assistant and Reports and provide the permissions for the role. If you have subscribed to MaxAI Workbench, expand Workbench and provide the necessary permissions for the parameter(s).