Configuration of AI Suite Studio

Prerequisites

Before starting to configure AI Suite Studio, ensure the following conditions are met:

  1. Axway Composer is installed
  2. Axway Rule Engine is installed
  3. Axway AI Suite Studio is installed over an AI Suite installation with PassPort. For more information about installing AI Suite Studio, see the AI Suite Studio Installation guide.
    Recommendation: install AI Suite Studio over an installation of AccountingIntegrator with Accounting Infrastructure. AccountingIntegrator comes with Rule Engine and Rule Engine Server, while Accounting Infrastructure is composed of Repository, Designer, and Administration.
  4. Users for AI Suite Studio are configured in PassPort
  5. A Composer configuration is available, for the business flow you want to work on.

Step 1 - Create event in Composer

Limitation: For each output format used in the transformation rules, you must create an Input Event in Composer with:

  • Output option checked
  • One segment having the same name as the output business document.

Also, an audit rule must be created for each output targeted to be imported in AI Suite Studio.

Step 2 - Create application in Repository console

It is advised to create a new application from the Repository console, and use it to deploy the configuration for the AI Suite Studio formats. An application defines a consistent set of configuration objects that will be used by one or several components. See more about Repository in the AccountingIntegrator Enabler Users guide.

Step 3 - Export from Composer to Designer

  1. Export the configuration from Composer towards Designer, using the Export Finance feature. For more information, refer to the Composer Users guide.
  2. Transform the configuration using the ant command, and import it into Designer. For more information on Designer scripts, read the AccountingIntegrator User guide.
  3. In Designer, load the configuration named Base for Accounting Integration. This will give you the AUDIT_COLLECTION collection important for the injection of the audit trails. For more information, read the AccountingIntegrator Users guide.
  4. Set up the sampled data and sampled keys in the imported configuration.
    For each output format you must define the sampled keys and sampled data properties and for each input format you must define the sampled data properties.
    The sampler program uses audit trails from Rule Engine to extract relevant data to be displayed as samples in AI Suite Studio. Each property of a format, either object type or element type, can be marked as Sampled key or Sampled data.
    • If a property is marked as Sampled key, it will be part of the key used by the sampler program to extract meaningful data from the Rule Engine output traces.
    • If a property is marked as Sampled data, it will not take part of the key, but it will still be displayed in AI Suite Studio. All the sampled keys are automatically set as sampled data, thus they will be displayed in AI Suite Studio objects (parameters, methods, events, products). For more information on AI Suite Studio objects, read the AI Suite Studio Users guide.
  5. For each property marked as Sampled data, set the options in the Audit tab in Designer, and ensure it is present in the audit rule defined with Composer on the same format.
  6. After setting all Sampled keys and Sampled data properties, deploy the configuration on the newly created application.

Step 4 - Deploy from Composer to Rule Engine

  1. Use the Send to server feature to send the configuration from Composer to a server of the type AccountingIntegrator-file or AccountingIntegrator-Repository. For more information on how to do this, refer to the Composer Users guide.
  2. Deploy the configuration on the Rule Engine using the rdjdep command. This will create the mvt.xml file, from the mvt.mvt and ctx.mvt files.
Note   If the configuration is already deployed, then you can use the ai-config-ext command to generate the mvt.xml file. The mvt.xml file is an export of all the Rule Engine configuration and it serves as an input for AI Suite Studio configuration.

Step 5 - Start storage in AI Suite Studio

Ensure the Storage is started.

In Windows environment:

[install directory]\AISuiteStudio\startStorage.bat

Or

Start menu > Axway Software > [Axway installation name] > AI Suite Studio > Start Storage

In Unix environments:

[install directory]\AISuiteStudio\startStorage.sh

Step 6 - Import rule engine configuration

Use aitools tool (importMvt ) to import configuration files from the Rule Engine, then generate or import sample files.

Note   If the analyst decides to modify the configuration later using Composer, then you can repeat steps 3 to 6 any number of times, as importing with importMVT on an existing domain performs a merge of the new data with the existing data, according to rules detailed below.
Caution   When merging Accounting methods, AI Suite Studio checks what kind of changes exist between the two objects. For the following changes, AI Suite Studio deletes the samples for that Accounting method:
  • Accounting method criteria expression
  • at least one output criteria expression is changed
  • the number of generated outputs
  • Mapping expressions
  • Type of parameter
  • Business Event link

Rules determining the merge operation

AI Suite Studio performs the merge according to the following rules:

  1.  Search for the object

    AI Suite Studio searches for the object (accounting method, business event or parameter) from the new configuration in the existing one, using its identifier. The identifier is a field or a group of fields of the object depending on its type:

    • A Business Event is identified by its name + version
    • An Accounting method is identified by the rule name + the start date of the validity period + the line number in the Financial Case
    • A Parameter is identified by its name

  2. Merge or create
    • If an object is found then the new object and the existing one are merged (see below).
    • If the object is not found, then it is created.
    • Any objects present in the existing configuration but no longer found in the new configuration, are declared to be not currently used and are given a distinct color in the UI.

Merging 2 objects means:

  • The content becomes the content from the new object
  • The annotations (label, description, tags, links, attachment) of the existing object are preserved

Step 7 - Check the AI Suite Studio configuration

  1. Open AI Suite Studio application.
    • For Windows environment:
      Start menu > Axway Software > [Axway installation name] > AI Suite Studio > Start AI Suite Studio
    • Or directly access the web server landing page and navigate to the AI Suite Studio from there.
      Example: https://<host>:8443 if the installation was made to use the internal web server delivered with AIS (Accounting Infrastructure Services) .
  2. Check that objects are created

    Log in with the proper rights and verify that the following parts of the UI contain the information from Composer:

    • Business events
    • Accounting methods
    • Parameters

    See in the AI Suite Studio Users Guide for the correspondence between Composer and AI Suite Studio objects.

Step 8 - Create user roles and privileges

Define user privileges via PassPort

To give users access to AI Suite Studio using Axway PassPort, you must:

Create a privilege

To create a new privilege in PassPort:

  1. In the PassPort User interface, select Access > Privileges.
  2. Click New privilege.
  3. Enter the following fields:
    • Name: ProductViewAll
    • Description: View all the products
      (for example)
    • Status: Active
    • Static: Accept the default selection
  4. Click Next.
  5. Select the:
    • Interplay product from the drop-down list: AISuiteStudio
    • Resource from the drop-down list, to associate it with the privilege: businessDefinition
    • Actions for the resource: EXECUTE
  1. Click Next.
  2. In the Privilege Condition Editor, set the conditions that must be verified to grant the privilege to the user.
    Conditions are expressed as <operator> <property> <value>. Enter the following values:
    • AND
      • <ACTION> is 'VIEW'
      • <TYPE> is 'Product'

      The appearance of the interface may have changed:

  3. Click Finish.

The privilege is now created.

Create a role

To assign the privilege to a role:

  1. In the PassPort User interface, select Access > Roles.
  2. Click New role.
  3. Enter the following fields:
    • Name: Product_Viewer
    • Description: Allows the user to view all the products
      (for example)
    • Status: Active
  4. Click Next
  5. Add the following privileges:
    • componentUseAll: to login to AI Suite Studio
    • workspaceViewAll: to access all the workspaces. It is not mandatory to add this privilege, but users need rights to at least one workspace before they can access AI Suite Studio.
    • productViewAll: to view all the products
  6. Click Finish

For more information, refer to the PassPort AM documentation.

Related Links