#WebServiceRequestProcessor

##Properties

None.

##Methods

###AddAndDeleteFieldsContent() Gets a JSON serialized System.String representing the columns available to the current Izenda.AdHoc.ReportSet with calculated columns included.

Returns:

The JSON serialized System.String containing the columns in the Izenda.AdHoc.ReportSet among all joined tables and calculated columns.

###AddPartToCurrentDashboard(System.Collections.Generic.List) Adds a new report part to the current Izenda.AdHoc.ReportSet provided the reportset is a dashboard reportset.

Parameters:

Returns:

A JSON formatted response message denoting success or an error message if an error occurred.

###AddReportPartToCrs(System.Collections.Generic.List<System.String>) Adds a new report part to the current reportset that is a dashboard reportset.

Parameters:

  • System.Collections.Generic.List<System.String> wsArgs - 0 - The name of the report part to add to the current reportset 1 - The X (vertical) position of the report part in the reportset 2 - The Y (horizontal) position of the report part in the reportset

Returns:

The name of the new report that was added to the reportset or a message describing the error that occurred.

###ApplyTopForCrs(System.Collections.Generic.List) Sets the number of records returned by the current Izenda.AdHoc.ReportSet for all reports contained with in the set.

Parameters:

Returns:

The JSON serialized response containing the status of the result.

###CheckIfReportExists(System.Collections.Generic.List<System.String>) Gets a JSON serialized response to determine whether a report specified in the parameters exists.

Parameters:

Returns:

The System.String JSON response containing the result of the check or an error message if an error was encountered.

###CheckReportPartExist(System.Collections.Generic.List) Gets a JSON System.String representation of a System.Boolean of whether a report exists.

Parameters:

Returns:

A JSON serialized System.String of the boolean representation of whether the report exists.

###CheckReportSetExists(System.Collections.Generic.List) Gets a System.String to determine whether the report specified in the arguments exists.

Parameters:

Returns:

A System.String response indicating whether the operation was successful.

###DeleteReportSet(System.Collections.Generic.List<System.String>) Deletes the report with the name specified by the parameters.

Parameters:

Returns:

A JSON formatted System.String containing a message if there were problems deleting the report.

###DeserializeFilters(System.Object)

Parameters:

###DeserializeFromJson(System.String) Constructs a System.Object from the input JSON formatted string.

Parameters:

Returns:

The System.Object that was built from the JSON formatted string.

###Equals(System.Object) Determines whether the specified System.Object is equal to the current System.Object.

Parameters:

Returns:

true if the specified System.Object is equal to the current System.Object; otherwise, false.

###GenerateReportSet(System.Collections.Generic.List<System.String>) Generate a new report set using the input JSON parameters. 0 - report set json descriptor (see 'CollectReportData' in js)</param>

Parameters:

###GenerateThumbnail(System.Collections.Generic.List) Produces a thumbnail image of the HTML output for the Izenda.AdHoc.ReportSet specified by the parameters provided.

Parameters:

###GetAllFiltersData() Gets a list of filters and all data inside the filters in a JSON format that belong to the current reportset.

Returns:

The System.String representation of the dashboard filters found on the current reportset.

###GetAutoRefreshIntervals() Gets the JSON formatted serialized value representing the time period in seconds the report viewer will wait before auto-refreshing its results.

Returns:

The time in seconds the report viewer will wait before refreshing its results.

###GetConstraintsData() Get constraints defined in AdHocContext.Driver.DatabaseSchema.Constraints as a JSON formatted string.

###GetCrsCategories() Gets a JSON formatted System.String containing all the categories found among all the reports currently available to the logged in user.

Returns:

A JSON formatted System.String containing the status of the request and the category data found among all reports available to the logged in user.

###GetCrsDashboardCategories() Gets a list of all the categories containing dashboards serialized to a JSON object.

Returns:

The list of categories that contain dashboards in JSON format.

###GetCrsDashboardConfig() Gets the dashboard configuration for the current dashboard reportset.

Returns:

The JSON serialized System.String containing the dashboard configuration data.

###GetCrsDatasources() Gets a JSON serialized representation of all the datasources found on the current Izenda.AdHoc.ReportSet.

Returns:

The JSON serialized System.String representation of all the datasources for the current Izenda.AdHoc.ReportSet.

###GetCrsReportPartPreview(System.Collections.Generic.List<System.String>) Gets the HTML generated by the specified report part on the current reportset using the specified arguments.

Parameters:

  • System.Collections.Generic.List<System.String> wsArgs - 0 - The name of the report part to render
    1 - The name of the report part to overwrite (not used for this command)
    2 - The number of report part cells in the current dashboard row
    3 - The number of results to pull for the report part being rendered
    4 - The width of the chart in the report part being rendered
    5 - The height of the chart in the report part being rendered
    6 - true or false whether the report part being rendered is being generated for an export

Returns:

The System.String representation of the HTML used to render the report part.

###GetCrsReportParts() Gets the list of report part names of the current Izenda.AdHoc.ReportSet.

###GetCrsSchedule(System.Collections.Generic.List) Gets a JSON formatted System.String containing the schedule information for the current Izenda.AdHoc.ReportSet.

Parameters:

Returns:

The JSON formatted Izenda.AdHoc.Webservices.ScheduleData that was found on the current Izenda.AdHoc.ReportSet, taking the offset into account.

###GetCrsShare() Gets a JSON formatted System.String containing the sharing information for the current Izenda.AdHoc.ReportSet.

Returns:

The JSON formatted list of sharing data found on the current Izenda.AdHoc.ReportSet.

###GetCrsTables() Gets a JSON formatted string with the table information for the current Izenda.AdHoc.ReportSet.

###GetDashboardFiltersData() Gets a System.String JSON formatted representation of the filters found on the current dashboard reportset.

Returns:

The System.String representation of the dashboard filters found on the current dashboard reportset.

###GetDashboardViewerConfig() Gets the JSON serialized representation of the Izenda.AdHoc.Webservices.DashboardViewerConfig settings.

Returns:

The JSON serialized representation of the Izenda.AdHoc.Webservices.DashboardViewerConfig settings.

###GetFieldFormats(System.Collections.Generic.List<System.String>) Get available field formats for the specified field as a JSON formatted string.

Parameters:

###GetFieldFormatsAndOperators(System.Collections.Generic.List<System.String>) Gets the available field formats and operators in a single list for the specified field as a JSON formatted string.

Parameters:

Returns:

The JSON formatted System.String object containing the operators and formats for the field.

###GetFieldFormatsWithDefault(System.Collections.Generic.List<System.String>) Get available field formats for the specified field as a JSON formatted string.

Parameters:

###GetFieldPreview(System.Collections.Generic.List<System.String>) Gets the HTML preview for a single report field provided by the input parameters.

Parameters:

Returns:

The System.String HTML generated by a report using only the field specified.

###GetFiltersData() Gets a System.String JSON formatted representation of the data for the filters found on the current reportset.

Returns:

The JSON formatted System.String containing the filter data for the current reportset.

###GetFiltersForDashboard(System.Collections.Generic.List) Gets a System.String JSON formatted representation of the filters found on the dashboard reportset obtained from the specified arguments.

Parameters:

Returns:

A System.String JSON formatted representation of the filters found on the reportset.

###GetHashCode() Serves as a hash function for a particular type.

Returns:

A hash code for the current System.Object.

###GetInstantReportConfig() Gets the JSON serialized representation of the Izenda.AdHoc.Webservices.InstantReportConfig settings.

Returns:

The JSON serialized representation of the Izenda.AdHoc.Webservices.InstantReportConfig settings.

###GetPivotGuiData() Get pivot GUI data

###GetPrintModeSetting() Gets a System.String JSON representation of the print mode used by the application for exporting to HTML or PDF.

Returns:

The System.String print mode for HTML and PDF exports.

###GetRenderedReportPartAlone(System.Collections.Generic.List) Gets the HTML output for a single report part inside the Izenda.AdHoc.ReportSet specified in the parameters.

Parameters:

Returns:

The System.String representation of the HTML results for the report part

###GetRenderedReportSet(System.Collections.Generic.List) Gets the System.String representation of the rendered HTML results of the specified report.

Parameters:

###GetReportDashboardConfig(System.Collections.Generic.List<System.String>) Gets the dashboard configuration for the given dashboard reportset.

Parameters:

Returns:

The JSON serialized System.String containing the dashboard configuration data.

###GetReportData(System.Collections.Generic.List<System.String>) Gets a JSON serialized representation of the report part data for a specified reportset.

Parameters:

Returns:

The JSON serialized representation of the report part data for the specified reportset.

###GetReportHtml(System.Collections.Generic.List<System.String>) Gets the rendered HTML for the reportset specified by the parameters.

Parameters:

Returns:

The System.String representation of the literal HTML output results generated from the reportset.

###GetReportListConfig(System.Collections.Generic.List) Gets the JSON serialized representation of the Izenda.AdHoc.Webservices.ReportListConfig settings.

Parameters:

Returns:

The JSON serialized representation of the Izenda.AdHoc.Webservices.ReportListConfig settings.

###GetReportListData(System.Collections.Generic.List<System.String>) Gets the JSON serialized representation of the data used on the report viewer page to build the dynamic content.

Parameters:

Returns:

The JSON serialized representation of the data used on the report viewer page to build the dynamic content.

###GetReportListDataLite(System.Collections.Generic.List<System.String>) Gets the JSON serialized lightweight representation of the information that is used for building the report list data.

Parameters:

  • System.Collections.Generic.List<System.String> wsArgs - 0 - The category that should be used to filter the results
    1 - The report name keyword that will be used to filter the results
    2 - Whether to split report subcategories according to their nesting level

Returns:

The JSON serialized lightweight representation of the information that is used for building the report list data.

###GetReportPartHtml(System.Collections.Generic.List<System.String>) Gets the HTML output for a single report part on the specified report using the provided parameters so that a single report part may be prepared for a print operation.

Parameters:

Returns:

The System.String representation of the HTML results for the report part

###GetReportPartHtmlForPrint(Izenda.AdHoc.ReportSet,System.Collections.Generic.List<System.String>) Gets the HTML output for a single report part on the specified report using the provided parameters so that a single report part may be prepared for a print operation.

Parameters:

Returns:

The System.String representation of the HTML results for the report part

###GetReportPartPreview(Izenda.AdHoc.ReportSet,System.String,System.Int32,System.Boolean,System.Int32,System.Boolean,System.Int32,System.Boolean,System.Int32,System.Boolean) Returns the HTML generated by the specified AdHoc.Repor with the specified information.

Parameters:

  • Izenda.AdHoc.ReportSet reportSet - The name of the reportset containing the report part to update.
  • System.String reportPartName - The name of the report part to update the reportset with.
  • System.Int32 cellsInRow - The name of the report part to overwrite.
  • System.Boolean topSet - Whether or not the number of records returned on the report part needs to be changed for the rendering process.
  • System.Int32 top - The number of results to pull for the report part being updated.
  • System.Boolean widthSet - Whether the report part being rendered needs to update the width of the chart for the rendering process.
  • System.Int32 width - The width of the chart in the report part being updated.
  • System.Boolean heightSet - Whether the report part being rendered needs to update the height of the chart for the rendering process.
  • System.Int32 height - The height of the chart in the report part being updated.
  • System.Boolean forPrinting - Whether the report part being updated is being generated for an export.

Returns:

The System.String representation of the HTML used to render the report part.

###GetReportPartPreview(System.Collections.Generic.List<System.String>) Gets the HTML generated by the specified report part using the specified arguments.

Parameters:

  • System.Collections.Generic.List<System.String> wsArgs - 0 - The name of the reportset containing the report part to render
    1 - The name of the report part to render
    2 - The name of the report part to overwrite (not used for this command)
    3 - The number of report part cells in the current dashboard row
    4 - The number of results to pull for the report part being rendered
    5 - The width of the chart in the report part being rendered
    6 - The height of the chart in the report part being rendered
    7 - true or false whether the report part being rendered is being generated for an export

Returns:

The System.String representation of the HTML used to render the report part.

###GetReportPreview(System.Collections.Generic.List<System.String>) Get report preview (using RenderHtml())

Parameters:

Returns:

The System.String HTML report output generated by the report.

###GetReportViewerConfig(System.Collections.Generic.List<System.String>)

Parameters:

###GetReportVisualizationProperties(System.Collections.Generic.List) Gets the list of visualization properties for the specified report part on the current Izenda.AdHoc.ReportSet.

Parameters:

Returns:

The JSON formatted visualization properties for the specified report part within the current Izenda.AdHoc.ReportSet.

###GetSchema() Get and serialize AdHocContext.Driver.GetSchemaInfo() as a JSON formatted string.

###GetTopForCrs(System.Collections.Generic.List) Gets the JSON serialized System.String representation of the number of records returned for the last Izenda.AdHoc.Report in the current Izenda.AdHoc.ReportSet.

Parameters:

Returns:

The System.String JSON serialized representation of the number of records for the last report in the current set.

###GetType() Gets the System.Type of the current instance.

Returns:

The System.Type instance that represents the exact runtime type of the current instance.

###GetTypedDbsSchema() Gets a JSON serialized System.String representation of the data used for containing autocomplete information and associating fields for a datasource with the datasource.

Returns:

The JSON serialized System.String with the autocomplete data obtained from the database schema.

###GetUsedTypes(System.Collections.Generic.List<System.String>) Gets a report template that is serializable to JSON and contains the relevant information for constructing a basic report structure that is used on the instant reports page.

Parameters:

Returns:

The serialized JSON template for the reportset to be returned to the instant reports page.

###LaunchReport(System.Collections.Generic.List) Generates a reportset and updates the current Izenda.AdHoc.ReportSet with the information in the list of column assignations.

Parameters:

  • System.Collections.Generic.List<System.String> wsArgs - 0 - The JSON serialized data containing the report name and the list of column Izenda.AdHoc.WebServices.Assignations that will populate the current Izenda.AdHoc.ReportSet

Returns:

A System.String JSON response representing whether the operation was successful or encountered an error.

###NewCurrentReportSetDashboard(System.Collections.Generic.List) Constructs a new Izenda.AdHoc.ReportSet for the current reportset and initializes its properties to expect to be treated as a dashboard.

Parameters:

Returns:

A JSON formatted System.String response denoting success.

###Ping() Gets the amount of time, in minutes, allowed between requests before the session-state provider terminates the session.

Returns:

A System.String JSON formatted representation of the time allowed between requests before the session is terminated.

###RemoveReportPartFromCrs(System.Collections.Generic.List<System.String>) Removes the report with the specified name from the current dashboard reportset.

Parameters:

Returns:

A System.String denoting whether the operation was successful or encountered an error.

###SaveCurrentReportSet(System.Collections.Generic.List) Saves the specified report with the information in the current Izenda.AdHoc.ReportSet object.

Parameters:

Returns:

A System.String JSON response containing a success message or an error message if errors were encountered while saving.

###SaveCurrentReportSetDashboard(System.Collections.Generic.List<System.String>)

Parameters:

###SendReportViaEmail(System.Collections.Generic.List<System.String>)

Parameters:

###SerializeToJson(System.Object) Gets the System.String representation of the input object in JSON format.

Parameters:

###SetCrsSchedule(System.Collections.Generic.List) Sets the schedule data for the current Izenda.AdHoc.ReportSet using the specified JSON formatted parameters.

Parameters:

Returns:

A System.String JSON formatted response denoting the operation was successful or an error if errors were encountered.

###SetCrsShare(System.Collections.Generic.List) Sets the sharing rights for the current Izenda.AdHoc.ReportSet using the provided parameters.

Parameters:

Returns:

A JSON formatted response message denoting whether the operation was successful.

###SetCurrentReportSet(System.Collections.Generic.List<System.String>) Sets the current reportset to the specified value using the name of the reportset.

Parameters:

Returns:

A System.String denoting whether the operation was successful or encountered an error.

###SetDashboardToCrs(System.Collections.Generic.List<System.String>) Loads the reportset with the name specified by the argument and sets it as the current reportset.

Parameters:

Returns:

A System.String response indicating whether the operation was successful.

###SetFiltersData(System.Collections.Generic.List<System.String>,System.Boolean) Sets the filters on the current reportset using the current dashboard reportset and the input parameters.

Parameters:

Returns:

The JSON System.String response that can consist of a simple response message or the contents of all filters sorted by report.

###SetFiltersData2(Izenda.AdHoc.ReportSet,System.String,System.Boolean) Sets the filters on a dashboard reportset using the specified parameters.

Parameters:

Returns:

The JSON System.String response that can consist of a simple response message or the contents of all filters sorted by report.

###SetFiltersData2(System.Collections.Generic.List<System.String>,System.Boolean) Sets the filters on a dashboard reportset using the current dashboard reportset and the input parameters.

Parameters:

Returns:

The JSON System.String response that can consist of a simple response message or the contents of all filters sorted by report.

###SetPivotCount(System.Collections.Generic.List) Sets the number of pivot columns for the current Izenda.AdHoc.ReportSet that will be displayed per page on exports.

Parameters:

Returns:

A System.String response message denoting whether the operation succeeded.

###SetPivotField(System.Collections.Generic.List) Sets the pivot field on the current Izenda.AdHoc.ReportSet using the input parameters.

Parameters:

Returns:

A System.String response message denoting whether the operation succeeded.

###SetPivotFunction(System.Collections.Generic.List) Sets the aggregation function used on the pivot field on the current Izenda.AdHoc.ReportSet using the input parameters.

Parameters:

Returns:

A System.String response message denoting whether the operation succeeded.

###SetReportVisualizationProperties(System.Collections.Generic.List) Sets the list of visualization properties that persist with a report using the current Izenda.AdHoc.ReportSet and the specified parameters.

Parameters:

Returns:

The JSON formatted visualization properties for the specified report part within the current Izenda.AdHoc.ReportSet.

###SetTopRecords(System.Collections.Generic.List) Sets the number of records returned for all report parts contained on the current Izenda.AdHoc.ReportSet.

Parameters:

Returns:

The JSON formatted response message denoting success or an error message if an error occurred.

###SetTopToReportPartInCrs(System.Collections.Generic.List<System.String>) Sets the number of records obtained by the report specified that belongs to the current reportset to the amount specified.

Parameters:

Returns:

A System.String response indicating whether the operation was successful.

###SyncCurrentReportSetDashboard(System.Collections.Generic.List<System.String>) Sync dashboard

Parameters:

###TaskExists(System.Collections.Generic.List<System.String>) Checks whether a response server task exists based on the key the task was assigned at creation.

Parameters:

Returns:

A JSON serialized boolean for whether the task exists or not.

###ToString() Returns a System.String that represents the current System.Object.

Returns:

A System.String that represents the current System.Object.

###UpdateAndGetCrsReportPartPreview(System.Collections.Generic.List<System.String>) Updates information relevant to the report part stored on the current dashboard reportset and returns the HTML generated by the updated report part.

Parameters:

  • System.Collections.Generic.List<System.String> wsArgs - 0 - The name of the report part to update the reportset with
    1 - The name of the report part to overwrite
    2 - The number of report part cells in the current dashboard row
    3 - The number of results to pull for the report part being updated
    4 - The width of the chart in the report part being updated
    5 - The height of the chart in the report part being updated
    6 - true or false whether the report part being updated is being generated for an export

Returns:

The System.String representation of the HTML used to render the report part.

###UpdateAndGetReportPartPreview(System.Collections.Generic.List<System.String>) Updates information relevant to the report part stored on a dashboard report set and returns the HTML generated by the updated report part.

Parameters:

  • System.Collections.Generic.List<System.String> wsArgs - 0 - The name of the reportset containing the report part to update
    1 - The name of the report part to update the reportset with
    2 - The name of the report part to overwrite
    3 - The number of report part cells in the current dashboard row
    4 - The number of results to pull for the report part being updated
    5 - The width of the chart in the report part being updated
    6 - The height of the chart in the report part being updated
    7 - true or false whether the report part being updated is being generated for an export

Returns:

The System.String representation of the HTML used to render the report part.

###UpdateCrsFields(System.Collections.Generic.List) Updates the list of fields on the current Izenda.AdHoc.ReportSet with the JSON formatted field data provided.

Parameters:

Returns:

A JSON formatted System.String response denoting success.

Izenda Logo