Intellicus Enterprise Reporting and Business Insights 18.1

Configuring Intellicus

0 views June 28, 2020 0

When Intellicus is installed and run for the first time, it uses default configuration. This document discusses properties related to configuration of Report Server and Client (portal) as well as how to configure email templates and how to customize configuration files.

Configuring Report Server

Report server’s configuration is achieved by setting properties associated with it. This is done on Server page of the portal.  You need to have Super Administrator privileges to be able to configure properties in Intellicus. To open Server page, click Navigate > Administration > Configure > Server.

The information captured on this page is stored in “ReportEngine.properties” file under path Intellicus\ReportEngine\Config. As an alternate option to this page, system administrator can edit the properties in the file directly. Report Server will require a re-start to assume new values, in case the properties are changed in the file directly.

server configuration page
Figure 1: The Server configuration page

The page as shown in Figure 1 lists all the properties for server configuration.

Accessing this page when Security= false

If Intellicus is running under security disabled, specify following URL in the browser’s address bar to get this page.

http://localhost/intellicus/conf and then click Server tab.

The Property Details

Important: Properties listed on this page appear here because they (as well as the possible values) are available in ReportServerProperties.xml file at path: <Intellicus installation path>\Intellicus\ReportEngine\Config.

If you don’t find a property here, make sure it is rightly defined in ReportServerProperties.xml file.

If you don’t want a property to appear on this page, you may comment it in the file.

The properties are listed under related sections:

GENERAL
Security

This property is used to enable or disable security features of Intellicus.

If it is set to enable, users will have to provide their login using their username and password to work with Intellicus.  They will be allowed to use only those features for which they have been provided the access rights.

If it is set to disable, all the features of Intellicus will be available to everyone.

New value set for this property comes into effect after server re-start.

Default: enable

Example: SECURITY_FEATURES=enable

Note: When security is disabled, all the user dependent features like data masking will not be available.

Warning: When Report Server is running in Non-Secured Mode, any user can access any report.

Log Level

This property is to set the level of criticality to be considered for logging. Valid values are DEBUG, INFO, WARN, ERROR, FATAL.  FATAL, ERROR and WARN are the levels recommended for production use. INFO and DEBUG are recommended only during trouble shooting.

Default: ERROR

Example: LOG_LEVEL = ERROR

Click Log Files to view the server log files.  You can choose to download or purge any / all log files appearing in the list for analysis. You can also view the server bootup log files.

Note: When log file size reaches 10 MB server renames it and starts logging in a new file.

Deployment Type

This property configures whether the report server is running as standalone or as part of a cluster. This enables load balancer communications and avoids multiple execution of scheduled reports in a clustered environment. This is a license specific property.

Default: STANDALONE

Example: DEPLOYMNET_TYPE = STANDALONE

FOLDERS AND PATHS
XML Data Source Folder

This property is to set directory for XML data source reports.  If the specified directory is not found, report server will not be able to run the report that uses data coming from XML file.

Default: ../xmldata

Example: XML_DATA_SOURCE_DIRECTORY=../xmldata
 

Temporary Folder

This property is to set folder where temporary files will be stored. If the specified folder is not found, the server will create the folder  In case server is not able to create the folder, all the features that need to create temporary files will not work.

Default: ../temp

Example: TEMP=../temp
 

Log Folder

This property is to set folder where report server log files will be stored. The log file name is ReportEngine.log. If the specified folder is not found, the server will create folder with that name.  In case server is not able to create the folder, then command prompt will be used as the logger.

Default: ../logs

Example: LOG=../logs
 

Font Folder

Specify the folder where font files are stored. Intellicus supports TTF format of fonts.  In case of invalid value (font not found in the folder), Arial fonts included in report server will be used.

Default: C:\WINDOWS\Fonts

Example: FONT_DIRECTORY=C:\WINDOWS\Fonts
 

Report Cache path

This property is to set the report cache directory. The rendered reports are cached temporarily for export etc. and permanently when a report is published. Specific cache file will be deleted when a published report expires or is deleted.

Default: ../rpg

Example: CACHE_PATH=../rpg
 

Secondary RPG Locations

Locations (relative path/absolute path/network path) where administrator can move RPG files when size of the folder specified in Report cache path increases to a level that memory and disk and space management becomes a problem. Use semi colon as a separator to specify multiple locations.  When a published report is not found at Report Cache Path, Intellicus will search for it in the paths specified here.

Default: blank

Example=../sec_rpg
 

File Data Source Path

This property is to set the path for the data source files (CSV,XLS) that can be used as data source for reporting. This path should be accessible from report server process.

Default: ../filesource

Example: FILE_DATA_SOURCE_PATH=../filesource
 

Archive Directory

This is the folder where report server will automatically archive report snapshot files. Automatic archiving occurs when ARCHIVE FREQUENCY is set.

Default: ../archives

Example:ARCHIVE_DIRECTORY= ../archives
 

Data Science Model Directory

This is to configure the path of model directory that can be used to store trained models of all data science activities.

Default: ../DataScienceModels

Example: DATA_SCIENCE_MODEL_DIRECTORY=../DataScienceModels

NETWORK SETTINGS
Listener IP Address

Specify an IP address for this property to make Report Server listen to the requests coming from the specified IP only.  Keeping it blank will make Report Server listen to requests coming from any IP.

Default: blank

Example: LISTENER_IPADDRESS=127.0.0.1
 

Listener Port

This is the port to be used for communication between Intellicus report server and client (portal and Desktop Studio).  Valid value for the port is any integer greater than zero.

New value set for this property will come into effect after server re-start.

Default: 45450

Example: LISTENER_PORT=45450

Note: The report server will not boot up in case the port number specified is in use by any other application.

 

Host URL

This is the host URL (URL to be specified to run Intellicus application) which will be prefixed to the published report links generated for emailing.

Syntax: HOST_URL=[Host URL](String)

Default: http://localhost/intellicus

Example: HOST_URL=http://localhost/Intellicus
 

Hyperlink Relative path

Configure the relative web path with respect to the integrated host application. This value is prefixed in hyperlinks to form an appropriate URL for linked reports and related web pages.

Intellicus uses this file to create hyperlink in a report that will open a child report when clicked.  Default value for this property will work fine when Intellicus is deployed as a stand-alone application.

Syntax: HYPERLINK_RELATIVE_PATH=[hyperlink relative path](string)

Default: ../../../InteraController.jsp

Example: HYPERLINK_RELATIVE_PATH=../../../InteraController.jsp
 

Compress Network Data

This property is to enable or disable compression of network data.  Client (portal) as well as report server can communicate with each other in compressed mode resulting in performance improvement.  To compress network data, set this property to enable.  Set this property to disable to continue the communication in uncompressed mode.

Default: Disable

Example: COMPRESS_NETWORK_DATA=Enable
 

Drilldown Max URL Length

This property defines the method to be used for HTTP request submission.  If the length of drilldown URL is more than the property value, POST method will be used. In other case, GET method will be used.

Default: 2000

Example: DRILLDOWN_MAX_URL_LENGTH=2000
 

Priority Thread Pool Size

To specify the pool size of priority threads.

Syntax: PRIORITY_THREAD_POOL_SIZE=[5] (int)

Default: 5

Example: PRIORITY_THREAD_POOL_SIZE=5
 

Secure Connection Ports (specified as a range of ports)

To specify the range of port numbers for communicating with secured connections.

Syntax: SECURE_CONNECTION_PORTS=[50100-50200] (String)

Default: 50100-50200

Example: SECURE_CONNECTION_PORTS=50100-50200
 

SSH Public Key Path

To specify the path to SSH (Secure Shell) public key.

Syntax: SSH_PUBLIC_KEY_PATH=[] (String)

Default: blank

Example: SSH_PUBLIC_KEY_PATH=blank
 

SSH Private Key Path

To specify the path to SSH (Secure Shell) private key.

Syntax: SSH_PRIVATE_KEY_PATH=[] (String)

Default: blank

Example: SSH_PRIVATE_KEY_PATH=blank

CONCURRENCY MANAGEMENT
Exec Threads

These threads handles report execution requests.  Specify number of report execution requests that should be served simultaneously. This is a license specific property.

Default: 5

Example: EXEC_THREADS=5
 

Service Threads

This thread handles all the requests (except report execution).  Specify number of service requests that should be served simultaneously. This is a license specific property.

Default: 5

Example: SERVICE_THREADS=5
 

Cancel Threads

This thread handles report-cancelling task (stopping execution of a report).  Specify number of cancel request that should be served simultaneously. This is a license specific property.

Default: 5

Example: CANCEL_THREADS=5

Note: Report Server will limit the number of threads to the licensed number of users even if a higher number of threads are set in property file. Report server will not give any error in such case.

 

Scheduler Job Dispatch Threads

This property is to set the maximum number of schedules that can be executed concurrently.

New value set for this property will come into effect after server re-start.

Default: 10

Example: SCHD_JOB_DISPATCH_THREADS=10

Important: Effective threads will be governed by license.

 

Dashboard Threads

This property is to set the number of threads for dashboard reports.  Intellicus maintains separate thread-pool for reports running via dashboards.  Number of threads allocated for dashboard will be the minimum value of this property and DashboardThreads property under the License tab.

Default: 2

Example: DB_EXEC_THREADS=2

Important: Effective threads will be governed by license.

 

Helper Exec Threads

Helper Exec Threads property specifies the number of report exec requests that can be handled.  When all the report exec threads are busy and one more report exec request is received; while the report exec thread is waiting for say database operation to get completed, the new report exec request is passed on to Helper Exec threads. Specify number of helper requests that should be served simultaneously. For example, when this property is set to 3, three of such report exec requests can be handled this way.

This is a license specific property.

Syntax: HELPER_EXEC_THREADS= [no. of Threads](int)

Default: 5

Example: HELPER_EXEC_THREADS=5
 

OLAP Exec Threads

This property sets the maximum number of OLAP reports that can be executed concurrently (parallel to one another).  Specify a positive integer.

This is a license specific property.

Syntax: OLAP_EXEC_THREADS= [5] (int)

Default: 5

Example: OLAP_EXEC_THREADS=5
 

PermaLink Threads

Permalinks can be generated for a published report to be shared with external users. This property sets the maximum number of Permalinks that can be executed concurrently (parallel to one another).  Specify a positive integer.

This is a license specific property.

Syntax: PERMALINK_THREADS= [5] (int)

Default: 5

Example: PERMALINK_THREADS=5
 

DEFA Threads

Intellicus’ Data Extraction and Forwarding Agent (or DEFA) collects identified data at predefined intervals from a data source and forwards it to a data collector component (Intellicus Report Server) which can transform and load this data. DEFA threads specify the number of DEFA requests that should be served simultaneously.

This is a license specific property.

Default: 5

Example: DEFA_THREADS=5

DATA CACHE

 

Cache Files Compression

This property presently controls database meta-data caching.  Compression of meta-data files makes data unreadable and improves performance.  Meta-data in uncompressed form is readable.

Default: enable

Example: CACHE_FILES_COMPRESSION=Enable
 

Data Cache Purge Time (minutes)

This property decides the time in minutes after which cached data should be automatically deleted.  Specify zero (no purging) or a positive integer.

Default: 30

Example: CACHE_PURGE_TIME=30
 

Data Cache Purge Frequency (minutes)

This is the time in minutes after which data cache purge thread will execute to check for cache data files that are expired and purge those.  Specify zero (purge thread not to execute) or a positive number.

Default: 30

Example: CACHE_PURGE_FREQUENCY=30

MEMORY MANAGEMENT
Request Queue Size

Report server places all requests in queue before executing them.  This property is to set maximum number of requests that can be queued.   After the queue is filled, server ignores all client requests, until number of requests in queue is reduced to a number less than the property value.

Specify an integer value that is greater than zero.

New value set for this property will come into effect after server re-start.

Default: 1000

Example: QUEUE_SIZE=1000
 

Data Source Fetch Size (rows per fetch)

This is the number of records to be fetched from the data source at a time (in one read).  Specify a positive integer.

Default: 50

Example: DATA_SOURCE_FETCH_SIZE=50

Note: Value set in this property will not remain effective for MySQL database.

 

Sort Area Size Per Exec (rows)

This property is to set the number of records that can reside in memory for all sort threads of a report.  Property can be given a value more than 0.

Default: 600

Example: SORT_AREA_SIZE_PER_EXEC=600

Note: Sort Area Size Per Exec property will work in coordination with Sort Threads Per Exec property explained later on the page.

 

Scheduler Job Dispatch Queue Size

This property is to set the maximum number of jobs that can be spawned at a time.  A valid value is zero or any positive integer.

New value set for this property will come into effect after server re-start.

Default: 50

Example: SCHD_JOB_DISPATCH_QUEUE_SIZE=50
 

Chunks in Memory

Number of report pages chunks that can reside in memory. Report server will stream each chunk to the viewer as soon as it is rendered. Specify a value that is more than 2.

Default: 4

Example: CHUNKS_IN_MEMORY=4
 

Output Buffer Size (nKB or nMB)

The maximum size of MEMORY to be used to store report output chunks. Specify in terms of MB or KB.

Default: 2.5 MB

Example: OUTPUT_BUFFER_SIZE=2.5MB
 

Clone User System Params

This property is defined to enable/disable the cloning of User & System Parameters across the detail sections. The cloning is required only if this installation is upgraded from version 3. Configure Disable for newer installations for memory efficiency.

Default: Enable

Example: CLONE_USER_SYSTEM_PARAMS=Enable
 

Repeat Report Exec Request

This property defines what to do if the server receives request of a report that is being presently served.  If the property is set to Allow All then it will allow all the report execution requests.  If it is Deny New, then server will not accept the newly received request.  If it is Prompt Cancel portal will prompt the user to cancel new request or request that is presently being served.

Default: prompt_cancel

Example: REPEAT_REPORT_EXEC_REQUEST=prompt_cancel
 

IRL Cache Size

This is the maximum memory that can be used for IRL (report layout) cache.  This can be specified in terms of number of IRLs, or memory size (KB, MB).

Default: 10

Example: IRL_CACHE_SIZE=10
 

Sort Threads Per Exec

This is the number of threads to be created (per report request) at runtime to perform sorting of records. This property is hot deployed.

Default: 4

Example: SORT_THREADS_PER_EXEC=4
 

Utility Thread Pool Initial Size

Utility threads are used to carryout internal processes by Intellicus Report Server.  This property defines initial size of utility threads.

Default: 5

Example: UTILITY_THREAD_POOL_INITIAL_SIZE=5

Note: If all the threads are busy, new threads will be automatically created.

 

Utility Thread Pool Purge Time (seconds)

This property defines the waiting time for an extended thread (created on demand post-initialization) from the pool after which it will be purged.  Specify value in seconds.

Default: 50

Example: UTILITY_THREAD_POOL_PURGE_TIME=50
 

Field Lookup Max Values

Count of Maximum Lookup values fetched from database for a Query Object column is configurable.  This will reduce the loading time of a query object in Ad hoc wizard/Run and of lookup Values.

Default Value=2000

Example: FIELD_LOOKUP_MAX_VALUES=2000

COMPLIANCE
Audit Log

Audit logging records report run event with report name, user name, time stamp and a snapshot of report for different users.  From drop-down, select enable to activate audit log feature.  Select disable if audit logging is not required.

Default: Disable

Example: AUDIT_LOG=Disable
 

Audit Log Purge Time (days)

To set the number of days after which all audit information (log details as well as RPG files) will be purged (deleted).  Valid values are positive integers.

Default: 30

Example: AUDITLOG_PURGE_TIME=30
 

Audit RPG Purge Time (days)

To set the number of days after which reports’ RPG files will be deleted.  Valid values are zero and positive integers.  Specify 0 if you don’t want to retain RPG files for audit.

Default: 7

Example: AUDITRPG_PURGE_TIME=7

Note: If Audit Log Purge Time is less than Audit RPG Purge Time, then all audit information will be deleted as per Audit Log Purge time.

 

Statistics

This property lets you view the report execution statistics like report run duration, row/column/page count etc. for a chosen output format. With the help of such statistics, you can decide which report to run directly, run in background or run using the schedule option.

When enabled, this property displays average report execution time, report execution time and report run history.  You can view the average report execution time in explorer (add the average report execution column by right clicking the top of the page). This gets updated within 15 minutes of running a report. This gives you an average of execution time of any report, run any number of times in a specific format till the time displayed there.  You can view average execution time details of the report while running it or while scheduling it. If you want to see execution time of every report, individually, go to Navigate > Reports > My Reports.

Default: Disable

Example: STATISTICS=Disable
 

Withhold Purge Till Archive

When enabled, this property postpones purge process until next archive process is completed. This way it makes sure that the published reports are not purged before archiving.

Default: Disable

Example: WITHHOLD_PURGE_TILL_ARCHIVE=Disable
 

Archive Frequency (days)

This is interval in number of days at the end of which report server will auto-archive published reports.  Set a value that is positive integer.

Default: 30

Example: ARCHIVE_FREQUENCY=30
 

Published Report Approval Required

This to enable or disable work flow process.  When approval process is activated, each published report needs to be approved by super administrator or user having required rights before it can be made available for users to view.  Value set to enable will activate the process.

Default: Enable

Example: PUBLISHED_REPORT_APPROVAL_REQUIRED=Enable
 

Published Reports Visibility

To decide who should be able to view published reports.  Set Global to make the published report visible to all users.  Set Organization to make the published report visible only to the organization to which the user (the one who publishes the report) belongs.

Default: Global

Example: PUBLISHED_REPORTS_VISIBILITY=Global
 

Login Mode

This property sets the login mode. At the time of login, users are expected to specify user name, password and organization name. Set login mode to 1 to get dropdown box having organizations to choose from. Set 2 to get a text box to type in the organization name. If you set 3, user will not be asked for organization name. It will be determined based on user id.

Default: 1

Example: LOGIN_MODE=1
 

Extended Input Validation

Extended input validation prevents “SQL Injection” as well as expands scope of user input validation. Enabling this property will make sure that if a user enters invalid character sequences, input is rejected and an error message is prompted.

Default: Disable

Example: EXTENDED_INPUT_VALIDATION=Disable
 

Folder Listing Access Check Level

Configure the level to which partial access rights should be checked. This property enables user to access the folders/sub-folders for which user has rights (in case this is set to 1). Else the user can access all folders/sub-folders (in case this is set to 0).

Default: 0

Example: FOLDER_LISTING_ACCESS_CHECK_LEVEL=0
 

Sign Document

This is to enable/disable the use of digital signatures with Intellicus documents (report outputs). Under Manage Certificates, the super administrator can browse and upload signature files and enter the Public/Private Key passwords that were provided along with the digital signatures. This can be done at global, organization or user level. When ‘Sign Document’ property is enabled, then these signatures would be applied to the documents.

Default: Disable

Example: SIGN_DOCUMENT=Disable
 

Sign Document Formats

Intellicus’ Digital Signatures can be applied to the specified document formats separated by a comma.

Default: PDF

Example: SIGN_DOCUMENT_FORMATS=PDF

Note: Intellicus 18.1 supports ‘PDF’ document format.

 

Sign Document Operations

Intellicus’ Digital Signatures can be applied to documents while ‘View’, ‘Email’, ‘Publish’, ‘Upload’ or ‘Print’ operations are performed. Operations can be specified as a comma separated list.

Default: ALL

Example: SIGN_DOCUMENT_OPERATIONS=ALL

Sign Document On Page

This specifies whether the signature would appear on the first or last page of the signed document.

Default: LAST

Example: SIGN_DOCUMENT_ON_PAGE=LAST
 

Sign Document Location Corner

This specifies the location where the signature would appear on the signed document. The location can be “Right Top”, “Right Bottom”, “Left Top” or “Left Bottom”.

Default: left Bottom

Example: SIGN_DOCUMENT_LOCATION_CORNER=left Bottom
 

Data Encryption

This property helps you to encrypt the files created in temporary folders of Intellicus to safeguard your data. You need to enable this and provide a 16-digit key from ’Manage Keys’ (you may need this key in case you restore a backup from this system on another instance of Intellicus to see older reports).

Default: Disable

Example: DATA_ENCRYPTION=Disable

FAULT TOLERANCE
Exit On Error

This property is used to auto-restart the report server.  Set it to enable if report server should auto-restart on a critical error like out of memory error.  If the property is set to disable, report server will not be able to recover in case of critical error.

Default: Disable

Example: EXIT_ON_ERROR=Disable
 

Memory Trigger Notification

This is to enable/disable notifications when memory Usage of Report Server exceeds the MEMORY TRIGGER LEVEL.

Default: Enable

Example: MEMORY_TRIGGER_NOTIFICATION=Enable
 

Exec Rejection on Memory Trigger

This is to enable/disable execution rejection on Memory Trigger feature i.e. Report Server will reject the execution request and block all the scheduled jobs launched when USED MEMORY + DEFAULT MEMORY USAGE PER EXEC is more than MEMORY TRIGGER LEVEL.

Default: Enable

Example: EXEC_REJECTION_ON_MEMORY_TRIGGER=Enable
 

Memory Trigger Level (percentage)

This property governs the behavior of the system in high memory situations. The Trigger Level is the %age of total memory used out of allotted memory.  After this level is reached, report server will invoke an event & set the ReTrigger Level, so next event will be invoked when ReTrigger Level is exceeded.  The Trigger Level should not exceed 100 & should not be less than 50.

Default: 90

Example: MEMORY_TRIGGER_LEVEL=90
 

Memory ReTrigger Level (percentage)

This property governs the behavior of the system in low memory situations. The ReTrigger Level is the %age of total memory used out of allotted memory.  After this level is reached, which Report server will invoke an event & set the Trigger Level.  The ReTrigger Level should not exceed 100 & should not be less than 40.

Default: 70 or 10 less than MEMORY TRIGGER LEVEL

Example: MEMORY_RETRIGGER_LEVEL=70
 

Default Memory Usage Per Exec (MB)

Value set as average resource utilization per execution.

Default: 50

Example: DEFAULT_MEMORY_USAGE_PER_EXEC=50
 

Time Diff for Trigger Notification (minutes)

This is minimum time diff after which Memory Trigger Notification will be sent.

Default: 30

Example: TIME_DIFF_FOR_TRIGGER_NOTIFICATION=30

RENDERING
Page ChunkSize  

This property is to set the number of report pages that will be sent to the client (portal) at a time (in one batch).

Default: 10

Example: PAGE_CHUNKSIZE=10
 

Left Margin Offset (points)

This property is to set left margin compensating factor for printing. This is set in terms of points.  (1 point = 1/72 inch).  A valid value is zero or any integer.

Default: 0

Example: LEFT_MARGIN_OFFSET=0
 

Top Margin Offset (points)

This property is to set top margin compensating factor for printing. This is set in terms of points.  (1 point = 1/72 inch).  A valid value is zero or any integer.

Default: 0

Example: TOP_MARGIN_OFFSET=0
 

Scale Offset

This property is to set scaling compensating factor for printing.  A valid value is any real number between –1.0 and 1.0.

Default: 0.0

Example: SCALE_OFFSET=0.0
 

RTF Field Control Map

This property is to set the map of plain text character to RTF equivalent control. It is used in embedded field values to apply RTF formatting on plain text.

Syntax: RTF_FIELD_CONTROL_MAP=plainText1:RTFControl1;plainText2:RTFControl2; (String)

Default: \n:\\par ;

Example: RTF_FIELD_CONTROL_MAP=\n:\\par ;
 

Standard Colors

This property is to set color patterns (presently used in charts).  Specify color values (hexadecimal / integer) separated by semicolon.

Default:

0x99bcff;0xfbb275;0x96be6f;0xf9e989;0xe3b8cf;0x91deea;0xbbc49a;0xe6dfee;0xcd9790;0x9dc5c5;0xffefcc;0xafd9b3

Example: STANDARD_COLORS=0x00CCFF;0xCC99FF;0XFF9999;0xCCFF66;0xF3DFC3;0xFFFF66;0xFFB200;0x0099CC;0x99CC33;0x999900;0xFFFF99;0XC7C3F3
 

Chart Single Series Color

You can vary the colors of single-series data markers in a chart. Enable this property to configure whether chart series should be drawn with single color or multicolor.

Default: Single

Example: CHART_SINGLE_SERIES_COLOR=Single

Note: This is applicable only for bar and column charts having single series.

 

Cached Output Formats

This property defines the output format for which report output needs to be cached.

Default: blank

Example: CACHED_OUTPUT_FORMATS=PDF, XML
 

Default Browser

When portal requests report output in HTML format, it is also expected to send Browser type.  Value set in this property will be applied if browser type is not received from portal.  Set IE to use MS Internet Explorer as browser type.  For any other browsers, set OTHERS.

Default: IE

Example: DEFAULT_BROWSER=IE
 

Export to MS-Office

You can export reports to either MS Office v2007 and above or MS Office v97-2003.

Default: MS-Office

Example: EXPORT_TO_MSOFFICE=MS-Office
 

Text Output Encoding

This can be used to set application’s file encoding like that of system file encoding.  Doing so enables Intellicus to generate any text based output (TEXT / CSV / RAWTEXT) in specified file encoding.  The file encoding must be a valid canonical name for java.lang API.  Default value is blank i.e. Report Server will use system’s default file encoding.

Default: blank

Example: TEXT_OUTPUT_ENCODING=blank
 

Text Output Font Factor

In case of text output, this property determines horizontal spacing between text controls. If in text output, characters are getting truncated (due to overlapping) increase this number.

Default: 6

Example: TEXT_OUTPUT_FONT_FACTOR=6
 

Report Preview Record Count

This property sets the maximum number of records that should be made available when a report is previewed. Specify any positive integer.

Default: 200

Example: REPORT_PREVIEW_RECORD_COUNT=200
 

Default Page Splitting

Report page can be split when report data is more than what can be accommodated on the report page.  In this property, select default behavior:

Select Horizontal breaks to split the report pages horizontally.

Select Multiple Page to split the report page horizontally (if the data need more horizontal space that the page height), as well as vertically (if the data need more vertical space than page width).

Default: horizontal_breaks

Example: DEFAULT_PAGE_SPLITTING=horizontal_breaks
 

Archive Format

This property governs the archive format for report output except HTML in all the operations like view, post view, ftp, upload and email.

For HTML, the archive will always be zip as gzip does not support archiving multiple files.

Syntax: ARCHIVE_FORMAT=[zip/gzip](String)

Default: zip

Example: ARCHIVE_FORMAT=zip
 

Single Page Height Limit

Configure the height of the page (integer) after which single page report will split into multi-pages.

Default: 2147483647

Example: SINGLE_PAGE_HEIGHT_LIMIT=2147483647
 

Single Page Width Limit

Configure the width of the page (integer) after which single page report will split into multi-pages.

Default: 2147483647

Example: SINGLE_PAGE_WIDTH_LIMIT=2147483647

SCHEDULER AND MAILS
EMail From Address

This property is to set the email address which will be displayed as the from (sender’s) address in the mails.

Default: Intellicus Automated Reporting System <reportsdepartment@company.com>

Example: EMAIL_FROM_ADDRESS=Intellicus Automated Reporting System <reportsdepartment@company.com>
 

Job Success Mail To

When a scheduled job is successfully completed, Intellicus can notify users about successful completion. Specify email IDs where mails should be sent in case a schedule is successfully implemented.  Make use of comma or semi colon to separate two email IDs.

Syntax: JOB_SUCCESS_MAIL_TO=[email addresses separated by comma or semi colon](string)

Example: JOB_SUCCESS_MAIL_TO=admin@softwrimpl.com,smith@compadmin.com
 

Job Success Mail Subject

When a scheduled job is successfully completed, Intellicus can notify users about successful completion.  Specify here subject that the mail should carry.

Syntax: JOB_SUCCESS_MAIL_SUBJECT=[Subject](string)

Default: JOB_SUCCESS_MAIL_SUBJECT=Scheduled Job ‘<%JOB_NAME%>’ notification – Success

Example: JOB_SUCCESS_MAIL_SUBJECT=Scheduled Job implemented successfully
 

Job Error Mail To

When a scheduled job fails, Intellicus can notify users about the failure.  Specify email IDs where mails should be sent in case a schedule fails.  Make use of comma or semi colon to separate two email IDs.

Syntax: JOB_ERROR_MAIL_TO=[email addresses separated by comma or semi colon](string)

Example: JOB_ERROR_MAIL_TO=admin@softwrimpl.com,smith@compadmin.com
 

Job Error Mail Subject

When a scheduled job fails, Intellicus can notify users about the failure.  Specify here subject that the mail should carry.

Syntax: JOB_ERROR_MAIL_SUBJECT=[Subject](string)

Default: JOB_ERROR_MAIL_SUBJECT=Schedule job ‘<%JOB_NAME%>’ notification – Failure

Example: JOB_ERROR_MAIL_SUBJECT=Scheduled job failed
 

SMTP Server

This property is to set Server IP address or domain name (as IP or URL) that should be used to mail the scheduled reports.  All email communications such as notifications and report delivery is done by Intellicus using this mail server.

Default: 127.0.0.1

Example: SMTP_SERVER=127.0.0.1
 

SMTP Server Authentication Mode

To secure the exchange of emails, Intellicus supports TLS authentication that is both credential-based or certificate-based. Select either DEFAULT or STARTTLS as the value of this property.

Default: (Default)

Example: SMTP_SERVER_AUTH_MODE=STARTTLS
 

SMTP Authentication

Set this property to Enable if the server used to send mails from Intellicus needs user authentication to send the mail.  Set it to Disable if it doesn’t.

Default: Disable

Example: SMTP_AUTHENTICATION=Disable
 

SMTP Server User

This property is to set the User ID for the SMTP Server.  User needs to set a valid user if your SMTP server authenticates before sending mails.

Default: blank

Example: SMTP_SERVER_USER= blank
 

SMTP Server Password

This property is to set the password to be used for SMTP Server.

Default: blank

Example: ENCR_SMTP_SERVER_PASSWORD= blank
 

SMTP Server Certificate File Name

You may specify the path where TLS certificate is stored under SMTP Server Certificate File Name property along with credentials if the SMTP Server Authentication Mode is set to “STARTTLS”. This certificate is used for verifying the identity at the time of sending emails.

Default: blank

Example: SMTP_SERVER_CERT_FILE_NAME= D://tlscert.cer
 

Secondary SMTP Server

Intellicus supports a secondary SMTP server that could act as a backup in case primary SMTP server is unavailable or email delivery fails for some reason. This property is to set Server IP address or domain name (as IP or URL) that should be used to mail the scheduled reports.

Default: blank

Example: SECONDARY_SMTP_SERVER=127.0.0.1
 

Secondary SMTP Server Authentication Mode

You need to specify the secondary SMTP server authentication mode as either “DEFAULT” or “STARTTLS”.

Default: (Default)

Example: SECONDARY_SMTP_SERVER_AUTH_MODE=STARTTLS
 

Secondary SMTP Authentication

Set this property to Enable if the secondary server used to send mails from Intellicus needs user authentication to send the mail.  Set it to Disable if it doesn’t.

Default: Disable

Example: SECONDARY_SMTP_AUTHENTICATION=Disable
 

Secondary SMTP Server User

You may specify the user name for the secondary server in case Secondary SMTP Authentication is enabled.

Default: blank

Example: SECONDARY_SMTP_SERVER_USER=administrator
 

Secondary SMTP Server Password

You may specify the password for the secondary server in case Secondary SMTP Authentication is enabled.

Default: blank

Example: SECONDARY_SMTP_SERVER_PASSWORD=intelli@123
 

Secondary SMTP Server Certificate File Name

You may specify the path where TLS certificate is stored under Secondary SMTP Server Certificate File Name property along with credentials if the Secondary SMTP Server Authentication Mode is set to “STARTTLS”. This certificate is used for verifying the identity at the time of sending emails.

Default: blank

Example: SMTP_SERVER_CERT_FILE_NAME= D://tlscert.cer
 

Scheduler Job History Purge Time (days)

This is the schedule job history purge time specified in days.  Specify 0 to disable history purging.

Default: 7

Example: SCHD_JOB_HISTORY_PURGE_TIME=7
 

Scheduler Pending Job Queue Size

This property sets the maximum number of scheduler jobs that can be queued.  Specify a positive integer.

Default: 500

Example: SCHD_PENDING_JOB_QUEUE_SIZE=500
 

Scheduler Enabled

This is to enable/disable scheduler feature.

Default: Enable

Example: SCHEDULER_ENABLED=Enable

TIMEOUTS
Database Connection Timeout (seconds)

This is the time in seconds after which the database connection will be closed, if not used for that many seconds.  Valid value for this timeout is any integer greater than zero.

Default: 600

Example: If DATABASE_CONNECTION_TIMEOUT is set to 600, report server will close the connection with a database if there is no communication between report server and database server for 600 seconds.
 

Client Session Timeout (seconds)

This is the time in seconds for which report server will wait to receive a response from the client (portal).  If the client does not respond within time specified here, server will close the session with that client request.  Specify 0 (infinite timeout) or a positive integer.

Default: 600

Example: CLIENT_SESSION_TIMEOUT=600
 

Remote Session Timeout (seconds)

This property is to set time in seconds after which the remote session will be closed. This is when the server acts as a client.  Specify 0 (Intellicus server should never close the connection) or a positive integer.

Default: 50

Example: REMOTE_SESSION_TIMEOUT=50
 

Authentication Cache Validity (minutes)

This property is to set the time out in minutes for authentication cache.  Specify –1 to disable caching and 0 for Infinite validity.  Valid value is any positive integer.

Default: 15

Example: CSA_TIMEOUT=15
 

Cache Purge Time (minutes)

This property is to set the time in minutes after which cache should be purged.  Specify a positive integer.

Default: 30

Example: For CACHE_PURGE_TIME=30, report server will purge reports that are cached for more than 30 minutes.
 

Cache Purge Frequency (minutes)

This is the interval in minutes after which a thread will be executed to purge audited reports / published reports / cached reports (which have exceeded CACHE PURGE TIME.

Default: 30

Example: CACHE_PURGE_FREQUENCY=10
 

Published Report Expiry Time (days)

This property is set to specify the maximum duration for which the published reports are retained. A non-zero value specified here will override the duration set by user while publishing reports.

Default: 0

Example: PUBLISHED_ REPORT_EXPIRY_TIME=10
 

Authorization Cache Timeout (minutes)

This property is to set the timeout for caching of authorization information.  This time is specified in minutes.  When this property is turned on, authorization information will be cached at the end of the timeout interval.  Specify 0 to turn this feature off.  A valid value for this feature is any positive integer.

Default=15

Example: For AUTHORIZATION_CACHE_TIMEOUT=15, server will run thread to cache authorization information every 15 minutes.
 

Repository Cache Timeout (minutes)

This property is to set the time out in minutes for caching of category and report layouts information.  When this property is turned on, repository information (categories and report layouts) will be cached at the end of timeout interval or as soon as the user makes any changes, whichever occurs earlier.

Default=15

Example: For REPOSITORY_CACHE_TIMEOUT=15, report server will cache reports and repository information as and when a change occurs, or at the end of every 15 minutes (whichever occurs earlier).
 

Permalink Key Timeout (minutes)

This property is to set the time out in minutes for viewing the report output using a permalink.

Default=15

Example: For PERMALINK_KEY_TIMEOUT=15, the report output will not be available after the permalink timeout of 15 minutes.

OTHERS
Default Locale

This property sets the application default locale to be used by the application for performing all locale sensitive operations like date formatting, text processing, resource bundler application etc.  Default: en_US (English of United States of America).

Default: (Default)

Example: DEFAULT_LOCALE= en_US

Note: Locale set here will be applied if user has not specified locale at the time of login, user has not specified his/her default locale as well as default locale is not set on Organizations page.
 

Default Time Zone

This property is applicable when different users access Intellicus functionalities from different geographical locations.  Select the time zone of the geographical region where this report server is installed and running.  To continue using time zone of the Operating System, select (Default).

Default: (Default)

Example: DEFAULT_TIMEZONE= Asia/Calcutta

Default
SQL Aggregation

This property when enabled helps you to run SQL queries at Database server end to get aggregated data while creating chart, matrix or using group by in summarized grid view. This helps to achieve faster response time to render the aggregated data in Intellicus.

Default: Enable

Example: SQL_AGGREGATION=Enable

Additional Properties\Manual Configurations

Additional properties that can be manually configured under ReportEngine.properties file are:

Output Directory

This is the location where the output report file will be generated

Syntax: OUTPUT_DIRECTORY=[Output Directory Path] (String)

Default:../reports

Example: OUTPUT_DIRECTORY=../reports
 

User Threads

To specify the number of user requests that can be served simultaneously.

Syntax: USER_THREADS= [5] (int)

Default: 5

Example: USER_THREADS=5
 

Data Caching

This property is to enable/disable data caching.  When a SQL is fired, report server caches result-set.  This increases turnaround time for the report generation for the 1st time.  The cached data is used for further generation requests for the same report (for example, re-running an ad hoc report using different filters). This is effective for all the reports using same SQL and same data connection.

Default: Disable

Example: DATA_CACHING=Disable
 

Data Cache Total Size

This property defines maximum size of the data cache.  It can be set per user, per organization or as total cache size for all the organizations (including their users).  Specify zero (no limit on cache size) or a positive integer and postfix it with M (MB) or K (KB)/ORG (organization) or USER (user) as the case may be. To specify it as total cache size (considering all org), omit ORG and USER.

Default=50M

Example: DATA_CACHE_TOTAL_SIZE=50M
 

Organization Level Capacity Control

This property is defined to enable/disable the SAAS based sub licensing

Syntax: SAAS_SUB_LICENSING= [enable/disable](String)

Default: Disable

Example: SAAS_SUB_LICENSING=Disable
 

Get Printer Listing

This is to enable/disable printer listing.

Syntax: GET_PRINTER_LIST= [enable,disable] (string)

Default: Enable

Example: GET_PRINTER_LIST=Enable

Default values

In any of the following cases report server will consider default properties:

  • Port Engine properties is not found at the right location.
  • A property being checked by report server is not set at all.
Working with Server Logs

Actions taken by server are logged in log files.  Actions that are logged will depend on value set in Log Level property on Server page.  When the log file size reaches 10 MB, server automatically renames the log file and opens another one.

Click the Log Files link under the General tab. This page lists all the log files that the server has created but not yet purged.  Latest log file, ReportEngine.log is used by server.

Server Log Files dialog
Figure 2: Server Log Files dialog

To download log files
  1. Select files by checking respective check-boxes. To download all the log files, check the checkbox available in the header row.
  2. Click Download Log Logs will be archived as a zip file and downloaded to the specified location.

As you go on selecting the files from the list, following information is displayed just below the table.

  • Number of selected files
  • Total file size
  • Approximate zip file size
To purge one or more log files
  1. Select files by checking respective check-boxes. To purge all the log files, check the checkbox available in the header row.
  2. Click Purge Log

Note: ReportEngine.log file would not be purged.

Configuring Client (Web Portal)

As a part of report client configuration, communication details and logging preferences are stored.

This process is carried on portal configuration page.  Click Navigate > Administration > Configure > Web Portal.

Configuring Client (Web Portal)
Figure 3: Client Configuration using Web Interface

If Intellicus is running with security = false, then specify following URL in the browser’s address bar to get this page.

http://<localhost>/intellicus/pattern/conf and then click Client tab.

Web Component

Report Server IP: This is the report server for client to connect.  The default IP is 127.0.0.1 (if report server and web portal are on the same machine).

Default: 127.0.0.1

Example: REPORT_ENGINE_IP=127.0.0.1
 
Report Server Port: This is the port number at which report server listens to client (portal).  This should be the same as the one configured in report server.  Default: 45450

Default: 45450

Example: REPORT_ENGINE_PORT=45450

Tip: After providing values for Report Server IP and Report Server Port, click Test Connection button to check if Intellicus Report Server is up and running at specified IP and Port.  When you click Test Connection button, portal responds with respective message.

 
Report Server Time Out (seconds): This is the maximum time in seconds for the server to respond.  If the server does not respond within specified time, client (portal) will display error message Server not responding to user.  Default: 600

Default: 600

Example: SERVER_TIME_OUT=600
 
HTML Viewer Time Out (seconds): This is the time in seconds for which client will wait before closing the communication thread between report server and client (portal) while running HTML reports. This generally happens when user switches over to some other page leaving the current process before completion. Default: 30

Example: HTML_VIEWER_TIMEOUT=30

Report Server Chunk Time Out (seconds): This is the time in seconds for which client will wait to receive 1st chunk of report output from report server.  Default: 600

Default: 600

Example: SERVER_TIME_OUT_CHUNK=600

Logging

Logging Enabled: To log activities performed by client (portal), click Yes.  Set it to No to disable logging.

Default: Yes

Example: LOGGING_ENABLED=Yes
 
Log Level: This property sets the level of criticality to be considered for logging.  Options available in the drop down list are: Debug, Info, Warn, Error and Fatal.  Default: Error

Example: LOG_LEVEL=Error

Additional Properties\Manual Configurations

Additional properties that can be manually configured under ReportClient.properties file are:

INTERA HOME

This is fully qualified path to “root” folder in Report Application.
This path signifies the folder in which application logs are to be created.
This path is used while initializing the application in the integration scenario.
Default value is blank.

Example: INTERA_HOME=..\webapps\intellicus\client
 

Output Mode

This value should be same as Report Engine’s REPORT_OUTPUT value. Output mode decides from where to read the report files to display and to save reports.

filemode: shared folder mode: files are created in REPORT_PATH folder by Report Engine.

streammode: Stream Mode: Files are created by Report Engine Interface into REPORT_PATH folder after reading report files from Report Engine through socket.

Default:streammode

Example: OUTPUT_MODE=streammode
 

Report Path

This is the folder where Report Engine puts the generated report files and from where Report Engine Interface reads the report files.

Default: reports

Example: REPORT_PATH=reports
 

Temp Path

Report Client uses this temp folder for its temporary operations.

Default: temp

Example: TEMP_PATH=temp
 

Relative Path

This is the relative path for Application integration purposes.

Default: “”

Example: RELATIVE_PATH= “”
 

Mapping Business Parameters to User Info

This property is used to map the business parameters that are used to filter data to User Info attributes like security descriptor, customer id, location etc.

Default: “”

Example: PARAMS_TO_USERINFO_MAP= “”
 

User Credentials

These user credentials will be used while accessing the Report Client Configuration Page when web client is unable to communicate with Report Server. Intellicus stores user password in encrypted form only, the USER_PASSWORD property will be replaced with ENCR_USER_PASSWORD with the encrypted value set into it. If Administrator wants to change the password manually, he/she would require to add USER_PASSWORD property and set plain text password in this property.

Default values are:

USER_NAME=Admin

USER_PASSWORD=Admin

USER_ORG=Intellicus

Example:

USER_NAME=Admin

ENCR_PASSWORD=Y80ucY+JdRY=

USER_ORG=Intellicus
 

Task Scheduler Report Clean up Time

Specifies the time interval (in milliseconds) a report would be deleted from REPORT_PATH

Default: 4*60*60*1000 (4 hrs)

Example: REPORT_CLEAN_UP_INTERVAL=14400000
 

Task Scheduler Report Clean up Interval

Specifies the time interval (in milliseconds) for a ‘Report Cleaner’ to check if any report has crossed its clean up time.

Default: 60*60*1000 (1 hr)

Example: REPORT_CLEAN_UP_TIME=3600000
 

Load Balancer Registry Status

This flag specifies usage of Load Balancer Registry.

Default: FALSE

Example: REGISTRY_ENABLED=FALSE
 

List of Load Balancing Registries

Default: 127.0.0.1:60000

Example: REGISTRIES=127.0.0.1:60000
 

HTML Folder Capacity

This is the folder capacity for HTML reports.

Default: 5000

Example: HTML_FOLDER_CAPACITY=5000
 

Applying Custom Login Page

This is the login page URL which can be specified if user wants to use some other page as a login page.

Default: LOGIN_PAGE_URL=blank

Example: LOGIN_PAGE_URL= http://192.168.33.11:5000/intellicus/
 

Escaping XSS characters

List of all javascript characters which need to be escaped.

Every property (left side of assignment) contains key, value pair.

First value after assignment is ASCII value of that javascript char.

[JAVASCRIPT_ESCAPE_CHAR]

DOUBLE_QUOTES=34,\”

BACKSLASH=92,\\

SINGLE_FORWARDSLASH=47,\/

TAB=9,\t

NEW_LINE=10,\n

CARRIAGE_RETURN=13,\r

FORM_FEED=12,\f

SINGLE_QUOTE=39,\’
 

Escaping XML characters

List of all html characters which need to be escaped.

Every property (left side of assignment) contains key, value pair.

First value after assignment is ASCII value of that html char.

[HTML_ESCAPE_CHAR]

GREATER_THAN=62,&gt;

LESSER_THAN=60,&lt;

QUOTE_BACKSLASH=34,&quot;

AMPERSAND=38,&amp;

SINGLE_QUOTE=39,&#39;

Actions

Change property values as required for Web Portal.  Click Save button on top-left corner to save the changes.

Action Buttons
  • Test Connection: To check if Intellicus Report Server is up and running at specified IP and Port.
  • Download Log (under Log Files): Downloads and opens the current log.
  • Purge Log (under Log Files): Deletes all old log files. It does not delete current log file.
  • Save: Saves changes made in client configuration.
  • Cancel: Abandons the changes.

Configuring Mail template files

Intellicus can be configured to send a mail message to recipients when:

  • A report is executed in asynchronous mode (notifying success or failure)
  • Report is sent as an email (attachment or link)
  • Report execution request is rejected
  • A Job is executed (notifying success or failure)
  • Memory Exceeding a set level
  • As part of Report Approval Process, a comment is added, report’s status is changed or report gets published

Content of these messages come from corresponding template files.  These files are located on Report Server at path:

<Install folder>\Intellicus\ReportEngine\Config\messages\mails

These files are:

  • AsynchronousFailureMessage.txt
  • AsynchronousSuccessMessage.txt
  • attachemailmessage.txt
  • ExecutionRejectionMessage.txt
  • JobErrorMessage.txt
  • JobSuccessMessage.txt
  • linkemailmessage.txt
  • MemoryExceededMessage.txt
  • ReportApprovalProcessCommentAddMessage.txt
  • ReportApprovalProcessReportPublishMessage.txt
  • ReportApprovalProcessStatusUpdationMessage.txt
  • orgexpirymessage.txt
Content of Mail Message template files

The first line of the file contains the subject.  Subject has to be one-liner and line must start with case insensitive keyword ‘Subject:’.  Specify message in second line onwards, which must start with case insensitive keyword ‘Message:’.

If these keywords are not found in the file, Intellicus assumes content of the file as message and takes default value for the subject.

Subject: Scheduled job ‘<%JOB_NAME%>’ notification – Success

Message: Hello,

This is an auto-generated notification by Report Server.

The scheduled reports are delivered successfully.

Details of delivered reports are as follows:

<%JOB_DETAILS%>

<%LINK%>

Regards

System Administrator

In the above example, words enclosed by <% and %> are system parameters.  At run time these parameters will be replaced by actual values.  All the system parameters that are available for a mail message are already used in pre-configured mail messages.

Locale-specific messages

If the mail messages are specific to the locale of the user, they are recommended to be kept inside a locale specific folder inside mails folder. For example: ReportServer\dist\config\messages\mails\en_us.

Note: Locale-specific messages are not available for Memory Exceeded mail message and Execution Rejection mail message.

Email Recipients

AsynchronousFailureMessage.txt: To the user, who executed the report, sent on the mail ID specified on user’s My Preferences page.

AsynchronousSuccessMessage.txt: To the user, who executed the report, sent on the mail ID specified on user’s My Preferences page.

Attachemailmessage.txt: To the users who’s Ids are specified on Email dialog.

ExecutionRejectionMessage.txt: To the super administrator, sent on super administrator’s My Preference page.

JobErrorMessage.txt: To ID specified on Job details page.

JobSuccessMessage.txt: To ID specified on Job details page.

linkemailmessage.txt: To the users who’s Ids are specified on Email dialog.

MemoryExceededMessage.txt: To the super administrator, sent on super administrator’s My Preference page.

ReportApprovalProcessCommentAddMessage.txt: To all the users who are a part of report approval process.  These are the users who are authorized to comment, approve or reject a report.  Mail will be sent to the Ids set by these users on their My Preferences page.

ReportApprovalProcessReportPublishMessage.txt: To all the users who are a part of report approval process.  These are the users who are authorized to comment, approve or reject a report.  Mail will be sent to the Ids set by these users on their My Preferences page.

ReportApprovalProcessStatusUpdationMessage.txt: To all the users who are a part of report approval process.  These are the users who are authorized to comment, approve or reject a report.  Mail will be sent to the Ids set by these users on their My Preferences page.

orgexpirymessage.txt: To the Administrator user in case of SAAS enabled product license only.

Customizing Configuration files

Intellicus stores several application configurations as files on report server and web portal.

Many of the configuration changes like server properties and Ad hoc Wizard customizations can be made through corresponding portal pages.  For changes in other files like mail messages and templates, you need to navigate to Config Files page where you can select a file, make changes and save it.

To edit text-based files, you can use the text editor provided on the page.  The files that need specialized software, you can download the files, edit and upload them back to the server.

To open Config Files page, click Navigate > Administration > Configure > Config Files.

Config Files
Figure 4: Config Files page

From this screen, you can also select one or multiple files and download it on a local machine, as well as upload file(s) back to the server.

To work with the files at Report Server, make sure Report Server link is selected.  To work with files at Web Portal, click Web Portal link.

Options in File Type dropdown will display file types available at selected location (Report Server or Web Portal).  If you see a file node grayed, it means that the file does not exist at the location and so, can’t be downloaded.

To select a folder or a file, you need to expand the parent folder and navigate in its hierarchy by clicking + sign on the left side of the folder.  Filename will be displayed as a leaf node.  To collapse the folder hierarchy, click – sign on left of the folder name.

When you select a file type from the dropdown, the folder in which files of that type are located will be displayed as checkbox.  Description of the selected file type will be displayed on the right of the dropdown.

Edit

Small changes are easy to be made on application UI itself.  Click the name of the file you want to edit.  File name will be highlighted and Edit button will be enabled.  Click Edit button to open the selected file in the editor.

Edit 
ReportEngine.properties
Figure 5: ReportEngine.properties file being edited on portal

Editor has functionalities like Undo, Redo, Search and Go to line number, which you can access from the toolbar.  You can also maximize or minimize the editor.

Click Save button to save the changes.

Download

You can download one file or multiple files at a time.

Check the checkbox on the left of the file name to select that file for download.  To select all the files within a folder for download, check the checkbox on the left of the folder in which files are present.  Number of selected files is displayed on the left side of Zipped checkbox.

Downloading files
Figure 6: Downloading files

When you download one file, you can download it in its original format or in zipped format.  To download the file in its original format, uncheck Zipped checkbox.  When you download multiple files, they will be downloaded as a zip file only.

To start the download process, click Download link.  When you download-

  • Single file in its original format, it will download as it is.
  • Single file in zipped format, the file name will be <filename>_<yyyy_MM_dd_HH_mm_ss>.zip.
  • Multiple files, they are downloaded in zipped format only. Name of file will be <File type name>_<yyyy_MM_dd_HH_mm_ss>.zip.

yyyy_MM_dd_HH_mm_ss is the date and time when download has started.

Upload

Use the upload functionality on this screen to upload one or multiple files (as a zipped file) to Report Server or Web Portal.  While uploading, if you have-

  • Not selected any folder in the tree, then the default upload location is /ReportEngine for Report Server and /intellicus for Web Portal. This is displayed in Upload to: when you open this page.
  • Upon selecting a folder in the tree, the selected folder will be the upload path.
  • Upon selecting a file, the parent folder of that file will be the upload path.
  • The folder structure inside the zipped file will be uploaded as it is in the upload path that you have selected. An unzipped file will be uploaded as it is (with its name) in the upload path.

Uploading
Figure 7: Uploading a file to Report Server

Before uploading a file, make sure you have selected the File Type and folder where the file should be uploaded.  Selected path will be displayed in Upload to:  Click Browse button to navigate to the folder where the file is placed and select the file.  If the file(s) being uploaded already exist at the location, they will not be overwritten.  To overwrite existing files, check Overwrite checkbox.

To start the upload process, click Upload link.  After successful upload, success message will be displayed on the top left of the screen.

Using Script files as script function libraries

Designer can now re-use the java scripts created by them. If the designers have some common JavaScript methods which they plan to reuse in other queries, then this version will allow them to do so. Designer needs to keep the entire Java script code (Methods) in a file with extension ‘.js’ and then upload that file into Intellicus as shown in the figure below:

Script files
Figure 8: Using Script files as script function libraries

The code in the .js file can look something like this:

function TestParam(value)
{
    if (value=="abc")
        {
            if (params("ParamTest") != null)
                {
                    return "where JOB in (<%ParamTest%>)"; 
                }
            else
                {
                    return "where JOB not in (<%ParamTest%>)";
                }
        }
    else
        {
            return "where JOB in (<%ParamTest%>)";
        }
}

 
Now after uploading the ‘.js’ file, if designer wants to use that script in the query object then designer needs to write a code like the one shown below to use the methods.

select   empno,empname from Employee
<@%
#include TestParam.js;
%@>
 
<@%
return TestParam("abc");
%@>