Solution Designer

Intellicus Solution Designer enables you to create an end-to-end analytics flow by combining multiple operations into a single, streamlined page. This helps optimize your reporting process, reduce complexity, and deliver faster insights.

Administrators can configure business solution flows, while users can interact with associated entities—such as reports, file uploads, schedules, and queries—based on their assigned roles and access rights.

Prerequisites

Before you configure the solution designer:

Ensure that your organization, users, roles, and required entities (queries, reports, dashboards, schedules, and upload templates) are already created.
Ensure that Solution Designer is enabled in your license file.

Step 1: Locate or Create the Configuration File

Place the SolutionDesignerConfiguration.json file in the organization folder.
- Portal path:
  Navigate > Administration > Configure > Config Files > Component (Web Portal) > Solution Designer Configuration files
- File system path:
  Jakarta\webapps\intellicus\client\config\organization\<OrganizationName>\
Note
The default organization folder is named Intellica. A new organization folder is created when a user from that organization logs in for the first time. If the folder does not exist, create it manually.

Step 2: Define Operations in the Configuration File

Edit the SolutionDesignerConfiguration.json file to define the operations and their associated entities.

Key Structure

{
  "Operations": ["Run Report", "Upload File"],
  "SeparatorOperations": ["Upload File"],
  "SolutionInformation": {
    "TabName": "My Solution",
    "Roles": ["SalesUser", "Admin"],
    "EntityInformation": {
      "Run Report": {
        "Description": "Sales Performance Report",
        "EntityType": "REPORT",
        "EntityId": "RPT_SALES_PERF_001",
        "EntityName": "Sales Performance",
        "Roles": ["SalesUser"],
        "Operation": "Run",
        "RunReportCaption": "Run Report"
      },
      "Upload File": {
        "Description": "Upload Monthly Sales",
        "EntityType": "FILE UPLOAD",
        "EntityId": "UploadTemplate1,UploadTemplate2",
        "EntityName": "Monthly Uploads",
        "Roles": ["Admin"]
      }
    }
  }
}

Tip
You can customize captions using RunReportCaption, RunQueryOption, BuildCubeCaption, and RunJobCaption based on entity type.

Step 3: Add Entry in ReportClientConfiguration.xml

Add an entry for the organization in the ReportClientConfiguration.xml file.

Portal path:
Navigate > Administration > Configure > Config Files > Component (Web Portal) > Report Client Configuration files

Note
You must add a new entry each time you configure a solution for a new organization.

Key components to write SolutionDesignerConfiguration.json file

SolutionDesignerConfiguration.json file will look as shown in the following figures.

Below figure displays how to mention Operations and SeparatorOperations.

Below figure displays how to write EntityInformation (File Upload Operation & Query Object Execution)

Operations (an array) stores the name of the supported operations.
SeparatorOperations stores the name of operations for which a separator (border) needs to be shown.
SolutionInformation is an object, and it will store the following attributes –

TabName – Name of the tab.
Roles – Role name for which this page should be visible. It will store the role names according to which access to the landing page and various operations will be controlled. Prerequisite for this solution to work is that these roles need to be created in Intellicus.
EntityInformation– It is a JSON Object, and it will store the mappings of operation to their associated entities. It will contain an object for each of the operations specified in the Operations array. Structure of that object is –
- Description – This field will store the operation description
- DependentOperations – This will store the names of dependent operations and last run status of those operations will be displayed on UI.
- EntityType– REPORT/JOB/ANALYTICAL/DASHBOARD/FILE UPLOAD/QUERY
- EntityId – stores the entity id. In case of a File Upload type operation user can specify multiple template names (Comma separated).
- EntityName – Name of the entity.
- Roles – Role name for which this particular operation should be enabled.
- Operation – This property will be available only when entity type is REPORT and it will store type of operation that needs to be performed (Run/Publish/Export/Upload).
- RunReportCaption/RunQueryOption/BuildCubeCaption/RunJobCaption-Captions to be displayed on button for entity Types Report/Query/Cube/Scheduled job respectively.

Note

Once you make the necessary entries in different files, you need to save the file and refresh solution designer tab on the portal to enable the changes.
Solution designer tab name is configurable.
You can name the operations and define a sequence as per your requirements.

Configure File Upload (Optional)

To add file upload operations:

Place the FileUploadTemplate.json in the same organization folder.
- Portal path:
  Navigate > Administration > Configure > Config Files > Component (Web Portal) > File Upload Template
- File system path:
  Jakarta\webapps\intellicus\client\config\organization\<OrganizationName>\
Add an entry for file upload in ReportClientConfiguration.xml.

Enable Compliance Features (Optional)

To capture the last run status for entities, enable audit logging:

Portal path:
Navigate > Administration > Configure > Server > Compliance

To capture report statistics:

Portal path:
Navigate > Configure > My Server > Compliance > Statistics

Enable Kyvos Dialog (Optional)

To enable the Kyvos Dialog button for report entities, add the "ShowKyvosDialogs": true attribute under the respective operation in SolutionDesignerConfiguration.json.

Note
This feature is license-governed and is disabled by default.

Accessing the Solution on Portal

To access the configured solution:

Go to Navigate > Analytics > <Solution Tab Name>.

Users can view and interact with the entities defined for them based on role-level access.

Tip
To enable direct access from the homepage, add an entry for the solution in the homepage.xml file located at:
Jakarta\webapps\intellicus\client\config\

Read more on using Kyvos Dialogs:

Using Kyvos Dialogs