There are various settings and customization related to Helical Insight which one can do by making changes in the settings.xml present in the back-end directory. Thus, the brief about various settings present in the setting.xml file is documented below:
Location of settings.xml file:
“..\hi\hi-repository\System\Admin”
Note: The above path might change based on where you have installed it.
List of configuration in Settings.xml file
- Location of the Hi-repository: By default Helical Insight is installed on C:\Users\helical\hi\hi-repository.
In order to change the location of the Hi-repository instead of by default location. Change the path between the tag <efwSolution> & </efwSolution>
e.g : <efwSolution>C:\Program Files\Helical Insight\hi\hi-repository</efwSolution>.
- List of file types: The information related to different file types which are supported by helical insight (HI) is present inside the tag.
- Recursive loading: This setting allows to turn on and off the feature to load the data all at once or in fragments.If this is set as true recursive loading will be enabled. This is mainly visible on tabular reports wherein data gets loaded in pages and thus helps with better performance.
e.g <recursiveLoading>true</recursiveLoading>
- Enable/disable the default functions in ad-hoc: Inside ad-hoc interface whenever we drag any column default function gets applied. The default function on dimension is “group by” and “Sum” on a measure. By default, this is set as true. If required one can set this as “false” if the default grouping and sum is not needed.
e.g <enableAdhocDefaultFunctions>true</enableAdhocDefaultFunctions>
- Query cancellation time(seconds): Here user can set the default time in which the query should get executed. If the time is taken to execute crosses this threshold then we get query timeout error. The value is in milliseconds.
<jdbcQueryCancellationTime>3000</jdbcQueryCancellationTime>
- Enable Saved Result: Set to false or true this setting to save the report export (pdf/excel/csv etc) result in the default location of browser or save in specific location in machine respectively.
<enableSavedResult>false</enableSavedResult>
- Create Backup File: Set this setting as true if there is a need to take backup of each version of the file after doing any changes else mark it as false. While updating the template file with the ad-hoc changes made by the user in the dashboard (EFW Files), the createNewBackupFile options sets whether to create the backup file or not. It works for endpoints /updateEFWTemplate only.
Thus, creates a new file with updated version number and updated data. when backup option is set true. i.e,
<createNewBackupFile>true</createNewBackupFile>.
- Listing of external contents: List of different contents which can be added as an external resource in the report is listed here.
- Listing of different permission levels: List of different permissions and the associated ID for same is present here in the tag <permissions> as shown in the image below:
- Default permission level: User can set default permission level for different files and folders present in the helical insight repository. Default permission will get assigned to the newly created file or folder when no permissions are provided to it explicitly.
<defaultPermissions mandatory="true"> <publicResourceAccessLevel>2</publicResourceAccessLevel> </defaultPermissions>
- Default Role List: List of default roles which will come with HI can be configured as shown:
- Security Definition: This feature is useful while implementing row level or column level security in the metadata created in Helical Insight.
- In this tag the definition and template which Helical Insight follows while applying security is coded.
For example, in the tag,<conditionTemplate>${user}.name eq 'hiadmin'</conditionTemplate>
User name is being compared with ‘hiadmin’. Similarly, you can provide the corresponding username like hiuser, hitest, John ………… etc based on the security conditions required for different users.
- In,
<filterTemplate>TableName.ColumnName = Filter Condition</filterTemplate>
the template for filter condition is defined i.e on the which column we want the security to be applied based on the user.
g,<filterTemplate>SampleTravel.Location = Filter Condition</filterTemplate>
Here, for user: ‘hiadmin’, security will be applied on column: location of table name: SampleTravel.
- Export Timeout: Here we can set the timeout limit while taking report export.
e.g <export mandatory="false"> <phantomTimeout>300000</phantomTimeout> </export>
The timeout = 300000 millisecond
- Support for older resources of type efw :
Support for older resources of type efw. True enables the application to work with old efw resources(resources created for use by HDI version 1.2 or earlier).
e.g <supportOldVersions>true</supportOldVersions>
After making any changes in the above listed settings, reload the application from the option available in the screenshot shown below: