InterSystems Reports Server with InterSystems IRIS

Copy link to this sectionServer Installation

Two of the entities mentioned previously are involved in installation of the InterSystems Reports Server, `the InterSystems IRIS instance where report configuration information is stored, and the InterSystems Reports server, supplied by Logi Analytics.

Use the following steps to install the InterSystems Reports Server.

1. Make sure the machine where you are installing the Server meets the Logi Analytics minimum System Requirements.

2. Select (or install) an InterSystems IRIS instance to store Logi configuration tables. You need to note the following information for future use:

   1. The machine hostname or IP address

   2. The InterSystems IRIS superserver port number

   3. The InterSystems IRIS system user and password. This user should have %All access. It is used only during installation. Due to a current limitation, passwords cannot contain exclamation marks (!).

3. Logi stores internal system tables in a designated namespace in the InterSystems IRIS instance. You provide a name for this namespace, and the install script creates the namespace for you.

4. For InterSystems IRIS 2020.4 and above, you need to supply a name for this Logi Server Configuration. This is the name that identifies this report server instance in the Management Portal.

5. Make sure a supported JDK is somewhere on Logi Server machine. See Supported Java Technologies for information on JDK supported by InterSystems IRIS. Make note of path and filename where JDK is installed for future use.

6. Download install folder from the, WRC Distributions page. Click Components, then search for “InterSystems Reports Server”, version 17.1. Unzip the downloaded file somewhere on your Logi Server machine. Due to a current limitation, make sure there are no spaces in the file path.

7. If the InterSystems IRIS instance you are using to store configuration information is not version 2020.4 or above, modify bin/PrepareReportInstall.java in the install folder you downloaded from the WRC. The required change is described in Version Dependencies.

You are now ready to run the installation script. The Installation script for the InterSystems Reports Server is part of the InterSystems Reports installation kit you received from InterSystems, available on the WRC Download site. The script is named InterSystemsReportSetup.bat or InterSystemsReportSetup.sh, depending on your platform. The install script prompts you to input the following values:

The installation script performs the following actions:

• Does the necessary InterSystems IRIS setup:

  • creates the report namespace and user if necessary

  • sets up the InterSystems IRIS instance to store report configuration information

  • gives privileges on the report namespace to the report user

• Installs the Logi Report Server

• Sets up Linked User Accounts on the Logi Report Server

• Sets up a connection between the Logi report server and the InterSystems IRIS database

Copy link to this sectionDocker Container Installation

Copy link to this sectionVersion Dependencies

If you are connecting to an instance of InterSystems IRIS at a version less than 2020.4, remove the following from PrepareReportInstall.java as %Report.ServerDefinition does not exist in earlier versions.

// create report server
IRISObject reportServer = (IRISObject)
iris.classMethodObject("%Report.ServerDefinition", "%New");
reportServer.set("Name", usrProp.getProperty("LOGI.ServerName")); 
reportServer.set("Host", usrProp.getProperty("LOGI.Host")); 
reportServer.set("Port", usrProp.getProperty("LOGI.Port")); 
if (usrProp.getProperty("LOGI.SSOEnabled").equalsIgnoreCase("true")){
 reportServer.set("SSOEnabled", true); 
}else{ 
 reportServer.set("SSOEnabled", false);
} 
reportServer.invoke("%Save"); 
System.out.printf("Created report server %s.\n", usrProp.getProperty("LOGI.ServerName"));

Copy code to clipboard

Copy link to this sectionUsing the Management Portal

You can use the Management Portal to create, view, and edit InterSystems IRIS Reports server configurations. The installation process creates a report server, which is listed on the InterSystems Reports page on the Management Portal. To find this page, select System Administration > Configuration > InterSystems Reports. The following screen shot shows the page with the initial report server. The server name listed here is the one you supplied to the install script as Logi Report Server Name.

Selecting a server in the list and using the Edit button opens the same form initialized with values from the selected server. You can modify the server configuration, or use the Delete button to remove it entirely. Selecting the SSO Enabled check box enables the Linked User Accounts feature, see Enabling Linked User Accounts.

If Linked User Accounts has been enabled, you can access the Logi report server from the Management Portal. Select System Administration > Configuration > InterSystems Reports to navigate to the InterSystems Reports page, which lists existing reports servers. Select Configure.

This action opens the InterSystems Report Configuration page:

Clicking on Select opens Logi Report, logged in as TestUser.

Copy link to this sectionEnabling Linked User Accounts

Linked user accounts is a feature that enables you to access Logi Report directly from the InterSystems IRIS Management Portal without entering an additional Logi user name and password. This functionality is achieved by linking a user account on the InterSystems IRIS server with a Logi user account. This linkage is made by assigning a role to the InterSystems IRIS user. The name of this role must follow a specific naming convention.

• The first part of the name is the name you supplied as the Logi Report Server Name during server installation.

• The second half of the name is the name of a Logi user.

• The two halves of the name are separated by an underscore character (_).

For example, if the Logi Report Server Name is IRISP284 and there is a Logi user named TestUser, a role having the following name can link an InterSystems IRIS user to TestUser on Logi Report:

IRISP284_TestUser

Logi users named admin and guest exist on Logi Report systems by default. When you enable linked user accounts on an InterSystems IRIS report server, that action creates roles to link InterSystems IRIS users to these Logi accounts. These roles are:

• LogiServerConfigName_admin

• LogiServerConfigName_guest

When the linked user accounts feature is disabled, these roles are not edited or deleted, but do not appear in the configure page. You can create additional roles for linking user accounts as you would create any other InterSystems IRIS roles, being careful to follow the naming convention.

Given a Logi server configuration name IRISP284, the following screen shot shows the default roles create by the installation script, and an additional role for Logi user TestUser created through the Management Portal.

The ability of users to configure report servers is influenced by the privileges assigned to them. Users with %Admin_Secure have access to report server operations that indirectly manipulate roles, while users without that privilege do not. When creating a new report server, users without %Admin_Secure are unable to toggle linked user accounts. The form is presented to such users with the SSO Enabled check box disabled. If a new report server is created with SSO Enabled selected, the default roles are created automatically.

If these roles already exist, they are not overwritten or updated upon creation of the report server. The admin and guest roles, whether generated manually or automatically, and other roles of the form "<ReportServer.Name>_role" are updated automatically when you change the name of the report server. These roles are also deleted upon deletion of the report server.