Configure AI Suite for AI Suite Portal

This section lists the main steps in configuring the AI Suite components to use AI Suite Portal.

The main steps to configure AI Suite for AI Suite Portal are:

  1. Set up the interaction flows.
  2. Import Sample queries and inject Period data files for Datastore. For details, see Prepare Datastore

Set up the interaction flows

The key element in setting up the interaction flows is Event Processor. For more information, see Configure automatic flows

To set up the interaction flows:

  1. Generate and transform the Composer configuration for Designer and deploy it.
  2. Load the business configuration (Get Started with Accounting Integration) and the Event Processor configuration (Flow Management for Accounting Integration) in Designer and deploy them.
  3. The Flow Management for Accounting Integration configuration includes the ArchiveFiles operation specific rule, which purpose is to allow data storage management, independent from the physical storage system, making the customer configuration portable from one cloud to another. See ArchiveFile operation for details.
  4. Configure listeners in Administration.

For more information, see Set up the Interaction flows.

ArchiveFile operation

You can use the archiveFiles operation to copy the input files of a dataflow and output files resulted from a dataflow execution into the storage defined in application.yml of AI Suite Portal. It replaces the copyFiles and copyFilesToS3 operations which are now deprecated.

The archiveFiles operation is suitable for any storage type.

You can found the operation in the Flow management for AccountingIntegration sample: LibCommonInteract collection > Functions > archiveFiles

ArchiveFile arguments:

  • event: file event that provides the path for the files.
  • customer file type: to differentiate input, output, log, temporary files and other file types.

AI Suite storage details

Storage settings (type, name and prefix) are defined in just one place for the entire AI Suite solution, namely in the application.yml of AI Suite Portal. AI Suite Portal injects the storage settings from the application.yml into Repository when the server starts. AI Suite Portal needs to be started before Rule Engine Server in order to inject dynamic settings to the repository(ies) of the environment(s) set in application.yml.

The storage settings defined in application.yml can be visualized (but not edited) in Portal UI > Administration > Environments > General tab.

If users need to change the storage type, they must restart Rule Engine Server so that the changes are taken into account. If users need to change name or prefix, the changes are automatically updated.

To identify the storage prefix, the operation looks initially in the environment variables, then in the Repository's general settings and, if nothing is defined in any of these places, no storage prefix is set. If the user decides to set the storage prefix as an environment variable, the name of the variable must be: AIS_STORAGE_PREFIX.

To identify the other storage settings (name and type), the operation looks into general settings from Repository, where all these are saved. AI Suite components read these settings from the Repository. The user can check them in the registry, under the general settings section (these do not appear in Administration as the other general settings.

To call the archiveFiles configuration, the user needs to add two new rules in Designer: ArchiveInput and ArchiveOutput.

Related Links