Exago .NET API Documentation
General Class Members
Properties 

WebReports.Api.Roles Namespace : General Class

The following tables list the members exposed by General.

Public Properties
 NameDescription
Public Property

When True, users are allowed to make changes to an ExpressView when the in Live Data (Run) mode. When False, users must click the Stop button on the toolbar before changes may be made.

The default value is false for pre-v2021.1.1 or true for v2021.1.1+

 
Public PropertyAllow end-users to write Custom SQL Data Objects at the report level.  
Public PropertyControls what visibility permissions users can assign to Execution Caches. Available levels utilize the parameters companyId and userId. There are three possible values from the wrCacheVisibility Enumeration.

 

 
Public PropertyDefault geopolitical location of the client as determined by the IANA time zone database (e.g., America/New_York). Utilized by Exago to properly combat scheduling issues centering around DST and other non-linear time zone conflicts.  
Public PropertySymbol prepended to numeric values to represent currency. The default is the US currency symbol ($).  
Public PropertyThe format of date values. May be any .NET standard (e.g., MM/dd/yyyy).  
Public PropertyThe format of time values. May be any .NET standard (e.g., h:mm:ss tt).The format of DateTime values. May be any .NET standard (e.g. M/d/yy h:mm tt).  
Public Property

Maximum number of seconds for a single data source query to run. This value is passed on to the data source driver as the CommandTimeout property when the report is executed. Each data source driver, data source or individual database may interpret this setting slightly differently. Consult the official product documentation associated with your data source implementation for complete details how this setting will impact your environment.

This setting will also control the maximum number of seconds that a Web Service API method can run. If set to 0 the Web Service API time out will be infinite.e your Note Box content here.
 
Public PropertySymbol used for numeric decimal values. The default is a period (.).  
Public PropertyList of the XML files that specify language strings. See Modifying Select Language Elements for more details.  
Public PropertyEnable/Disables filter dropdowns to read possible values from the Data Objects. Set to False only if retrieving values for the dropdown will take more than a couple of seconds.  
Public Property

The parent folder for all reports. The Report Path may be:

  • Virtual Path
  • Absolute Path — used to provide increased security (ex. C:\Reports)
  • Web Service URL or .NET Assembly — using a Web Service or .NET Assembly allows reports and folders to be managed in a database. For more information see Report Folder Storage & Management.
 
Public PropertyControls what information the user can see in the  Schedule Manager. These levels refer to the Parameters companyId and userId.

 

 
Public PropertySymbol used to separate 3 digit groups (ex. thousandths) in numeric values. The default is a comma (,).  
Public Property

For versions pre-v2019.1, a decimal value used to convert server to client time. This offset is not applied to data coming from Data Sources. It is utilized by Exago features like the Scheduler Service. Leave blank to use server time.

For versions v2019.1+, this value is only used to set an initial client time zone name if one is not set but is otherwise not used. Use Client Time Zone Name for all time zone changes.

 

 
Public PropertyDisplays/Hides the Report Designer.  
Public PropertyEnables/Disables the Chained Report wizard.  
Public PropertySet to True to allow CrossTab widgets to be added to Advanced Reports in the Designer, or False not to.  
Public PropertyEnables/disables the creation of new CrossTab reports from the main menu.  
Public PropertyDisplay/Hide the Visualization item in the New Tile Menu and Tile Properties Pane of the Dashboard Designer.Display/Hide the Visualization item in the New Tile Menu and Tile Properties Pane of the Dashboard Designer.  
Public Property

Enables/Disables the Dashboard Designer.

Both this setting and General > Main Settings > Allow Execution in Viewer (AllowHtmlOutput Property) must be True to enable the Dashboard Designer.
 
Public Property

Enables/Disables the Express Report wizard.

Express Reports are a legacy version of Advanced Reports, and are not the same as ExpressViews.
 
Public PropertyEnables/Disables the formula editor button in the Layout tab of the legacy Express Report wizard.  
Public PropertyEnables/Disables the grouping tools in the Layout tab of the Express Report wizard.  
Public PropertyEnables/Disables the styling tools in the Layout tab of the Express Report wizard.  
Public PropertyEnables/Disables the Theme dropdown in the Layout tab of the Express Report wizard.  
Public PropertyEnables/Disables the ExpressView Designer.  
Public PropertySets the default output to show grid lines or not in the Report Viewer. This can be overridden on a per-report basis.  
Public PropertyDisplays/Hides the  Schedule Report item on the report's context menu in the Report Tree.  
Public PropertyDisplays/Hides the  E-Mail Report icon on the report's context menu in the Report Tree.  
Public PropertyShow/Hide the  Scheduler Manager icon on the Main Menu. Set to False to disable users from seeing the Schedule Manager and editing existing schedules.  
Public PropertyThe format of time values. May be any .NET standard (e.g., h:mm:ss tt).  
Top
See Also

Reference

General Class
WebReports.Api.Roles Namespace