Exago Logo
Search
Generic filters
Exact matches only

Report and Folder Storage/Management

This document covers several versions of the application. Use the Viewing content for dropdown to see only the content relevant to a specific application version.

Important

All legacy content storage mechanisms and the contents of this article were deperecated in Exago v2020.1+. For more information, review the Storage Management: Introduction article.

By default, Exago stores the reports in a file system folder. The location of this folder is specified in the ‘Report Path’ property set in the Administration Console. Alternatively, report, template and folder storage, and retrieval can be handled by building a .NET Assembly. This would allow for reports, folders and templates to be stored in a database. To do this, specify the .NET Assembly in the Report Path of Main Settings. The .NET Assembly should contain all of the methods specified in List of Methods.

List of Methods

The following methods will use the parameters ‘companyId’, and ‘userId’ which should be set through the Api as users enter Exago from the host application.

The folder management code can use alternative method signatures to be passed Exago’s SessionInfo object for additional flexibility. See Accessing SessionInfo in Folder Management for more information.

Important

The following methods are not supported in the REST Web Service API.

string GetReportListXml(string companyId, string userId) pre-v2017.1

DescriptionReturns a string listing folders and report names in XML format (see example below).
Remarks

For reports set the flag <leaf_flag> to True. For folders set this flag to False.

If an error occurs return null and a generic error will be displayed to the user.

Note: As of v2017.1, this method is obsolete. Use GetReportList instead.

Caution

The Report Tree should contain no more than 1,000 items in it for best user experience.

Example
<entity>
   <name>Travis' Reports</name>
   <leaf_flag>false</leaf_flag>
   <readonly_flag>false</readonly_flag>
   <entity>
      <type>advanced</type>
      <name>Sales Report</name>
      <description>Contains sales information</description>
      <leaf_flag>true</leaf_flag>
      <readonly_flag>false</readonly_flag>
   </entity>
   <entity>
      <type>expressview</type>
      <name>Employee Reports</name>
      <description>Contains employee information</description>
      <leaf_flag>false</leaf_flag>
      <readonly_flag>false</readonly_flag>
      <entity>
         <type>dashboard</type>
         <name>Employee Benefits Report</name>
         <description>HR and Employee info</description>
         <leaf_flag>true</leaf_flag>
         <readonly_flag>false</readonly_flag>
      </entity>
   </entity>
</entity>

string GetReportList(string companyId, string userId)

DescriptionReturns a string listing folders and report names in XML format (see example below).
Remarks

For reports set the flag <leaf_flag> to True. For folders set this flag to False.

If an error occurs return null and a generic error will be displayed to the user.

Caution

The Report Tree should contain no more than 1,000 items in it for best user experience.

Example
<entity>
   <name>Travis' Reports</name>
   <leaf_flag>false</leaf_flag>
   <readonly_flag>false</readonly_flag>
   <entity>
      <type>advanced</type>
      <name>Sales Report</name>
      <description>Contains sales information</description>
      <leaf_flag>true</leaf_flag>
      <readonly_flag>false</readonly_flag>
   </entity>
   <entity>
      <type>expressview</type>
      <name>Employee Reports</name>
      <description>Contains employee information</description>
      <leaf_flag>false</leaf_flag>
      <readonly_flag>false</readonly_flag>
      <entity>
         <type>dashboard</type>
         <name>Employee Benefits Report</name>
         <description>HR and Employee info</description>
         <leaf_flag>true</leaf_flag>
         <readonly_flag>false</readonly_flag>
      </entity>
   </entity>
</entity>

string GetReportXml(string companyId, string userId, string reportName) pre-v2017.1

DescriptionReturns a string containing the report in XML format.
Remarks

If an error occurs return null and a generic error will be displayed to the user.

Note: As of v2017.1 this method is obsolete. Use GetReport instead.

string GetReport(string companyId, string userId, string reportName)

DescriptionReturns a string containing the report in xml format.
RemarkIf an error occurs return null and a generic error will be displayed to the user.

wrReportType? GetReportType(string companyId, string userId, string reportName)

Description

Returns the type of report as a wrReportType enum, or as an int describing the report type:

  • 0 = Advanced
  • 1 = Express
  • 2 = Dashboard
  • 3 = Chained
  • 4 = Visualization
  • 5 = ExpressView
RemarkReturns null if reportName does not exist. Any invalid type returns null. This will cause any report management methods to fail.

string SaveReport(string companyId, string userId, string reportName, string

reportXml)

DescriptionSaves a report (reportName is fully qualified)
Remark

Returns an error message if one occurs, else return null.

Note: To support multi-language functionality, if the returned string matches the id of any element in the language files then the string of that language element will be displayed to the user instead of the returned value. For more information see Multi-Language Support.

string DeleteReport(string companyId, string userId, string reportName)

DescriptionDeletes a report (reportName is fully qualified)
Remark

Returns an error message if one occurs, else return null.

Note: To support multi-language functionality, if the returned string matches an id of any element in the language files then the string of that language element will be displayed to the user instead of the returned value. For more information see Multi-Language Support.

string RenameReport(string companyId, string userId, string reportName, string

newReportName)

DescriptionRenames a report (reportName & newReportName are fully qualified). If this method is not provided, DeleteReport and SaveReport will be called.
Remark

Returns an error message if one occurs, else return null.

Note: To support multi-language functionality, if the returned string matches an id of any element in the language files then the string of that language element will be displayed to the user instead of the returned value. For more information see Multi-Language Support.

string AddFolder(string companyId, string userId, string folderName)

DescriptionAdds a report folder (folderName is fully qualified).  Folder should not be named to one that already exists.
Remark

Returns an error message if one occurs, else return null.

Note: To support multi-language functionality, if the returned string matches an id of any element in the language files then the string of that language element will be displayed to the user instead of the returned value. For more information see Multi-Language Support.

string DeleteFolder(string companyId, string userId, string folderName)

DescriptionDeletes a report folder (folderName is fully qualified).
Remark

Exago’ default report template management will not allow a folder to be deleted that contains any reports.

Returns an error message if one occurs, else return null.

Note: To support multi-language functionality, if the returned string matches an id of any element in the language files then the string of that language element will be displayed to the user instead of the returned value. For more information see Multi-Language Support.

string RenameFolder(string companyId, string userId, string oldName, string

newName)

DescriptionRenames a report folder (folder names are fully qualified). Folder should not be moved to a location where a Folder with a matching name already exists.
Remark

Returns an error message if one occurs, else return null.

Note: To support multi-language functionality, if the returned string matches an id of any element in the language files then the string of that language element will be displayed to the user instead of the returned value. For more information see Multi-Language Support.

string MoveFolder(string companyId, string userId, string oldName, string

newName)

DescriptionMoves a report folder (folder names are fully qualified).  Folder should not be renamed to one that already exists.
Remark

Returns an error message if one occurs, else return null.

Note: To support multi-language functionality, if the returned string matches an id of any element in the language files then the string of that language element will be displayed to the user instead of the returned value. For more information see Multi-Language Support.

bool ExistFolder(string companyId, string userId, string folderName)

DescriptionDetermines if a folder exists.
RemarkReturns true or false.

List<string> GetTemplateList(string companyId,  string userId)

DescriptionReturns a list of strings or a string array containing the available templates.
RemarkIf an error occurs return null and a generic error will be displayed to the user.

byte[] GetTemplate(string companyId, string userId, string templateName)

DescriptionReturns a byte array containing the template.
RemarkIf an error occurs return null and a generic error will be displayed to the user.

string SaveTemplate(string companyId, string userId, string templateName,

byte[] templateData)

DescriptionSaves a template
Remark

Returns an error message if one occurs, else return null.

Note: To support multi-language functionality, if the returned string matches an id of any element in the language files then the string of that language element will be displayed to the user instead of the returned value. For more information see Multi-Language Support.

List<string> GetThemeList(string companyId,  string userId, string

themeType)

DescriptionReturns a list of strings or a string array containing the available themes.
Remark

Valid values of themeType: “CrossTab”, “Express”, “Chart”, “Map”, “Gauge”, “ExpressView”

If an error occurs return null and a generic error will be displayed to the user.

bool ExistTheme(string companyId, string userId, string themeType, string

themeName)

DescriptionDetermines if a theme exists.
Remark

Valid values of themeType: “CrossTab”, “Express”, “Chart”, “Map”, “Gauge”, “ExpressView”

Returns true or false.

string GetThemeXml(string companyId, string userId, string themeType,

string themeXml) pre-2017.1

Description

Returns a string representing the theme in xml format.

Note: As of version 2017.1, this method is obsolete. Use GetTheme instead.

Remark

Valid values of themeType: “CrossTab”, “Express”, “Chart”, “Map”, “Gauge”, “ExpressView”

If an error occurs return null and a generic error will be displayed to the user.

string GetTheme(string companyId, string userId, string themeType, string

themeName)

DescriptionReturns a string representing the theme.
Remark

Valid values of themeType: “CrossTab”, “Express”, “Chart”, “Map”, “Gauge”, “ExpressView”

If an error occurs return null and a generic error will be displayed to the user.

string SaveTheme(string companyId, string userId, string themeType, string

themeName, string themeData)

DescriptionSaves a theme.
Remark

Valid values of themeType: “CrossTab”, “Express”, “Chart”, “Map”, “Gauge”, “ExpressView”

Returns an error message if one occurs, else return null.

Note: As of version 2017.1, we recommend renaming the themeXml parameter to themeData, to reflect the fact that the newer themes are no longer Xml.

Note: To support multi-language functionality, if the returned string matches an id of any element in the language files then the string of that language element will be displayed to the user instead of the returned value. For more information see Multi-Language Support.

Accessing SessionInfo in Folder Management

This section only applies to Folder Management using a .NET Assembly.

After adding a reference to WebReportsApi.dll you may gain additional flexibility by replacing companyId and userId with Exago’ sessionInfo object in the methods listed above. The sessionInfo object grants access to all of the parameters, configuration, and report information of the Exago session. See Exago SessionInfo for more information.

To utilize the sessionInfoObject, replace the companyId and userId parameters in the method signatures above with sessionInfo sessionInfo (see example below).

Note

To use the sessionInfoObject all of the methods must be static.

Utilizing the sessionInfo object will allow the folder management code to access much more information about the user and/or Exago. For example the capability to access the sessionInfo object could be used to pass additional parameters to your folder management code such as the preferred language of the user or from which part of the host application they entered Exago.

Note

Passing the sessionInfo object will lock the folder management Assembly. In order to unlock the assembly, either IIS will need to be restarted, or the application pool running Exago will need to be recycled.

The following is an example of the method signature for GetReportXml to utilize the sessionInfo object:

string GetReportXml(SessionInfo sessionInfo, string reportName)

DescriptionReturns a string containing the report in xml format.
Remark

If an error occurs return null and a generic error will be displayed to the user.

companyId and userId can still be retrived using the calls sessionInfo.SetupData.Parameters.GetValue(‘comapnyId’) and sessionInfo.SetupData.Parameters.GetValue(‘userId’) respectively.

The sessionInfo object must be the first parameter in the method.

Was this article helpful?
0 out of 5 stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.
Table of Contents