Class ReportingServer

Inheritance

System.Object

ReportingServer

Namespace: BoldReports.ServerProcessor

Assembly: BoldReports.Web.dll

Syntax

public abstract class ReportingServer : Object

Constructors

ReportingServer()

Declaration

protected ReportingServer()

Properties

DataSetMappingInfo

Gets or sets the mapping information for datasets in the report processor. This dictionary contains key-value pairs where the key is the dataset name and the value is the corresponding mapping information.

Declaration

public Dictionary<string, string> DataSetMappingInfo { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.String>	A dictionary of type System.Collections.Generic.Dictionary<, > where each string key represents the dataset name and each string value provides the associated mapping information for that dataset.

DataSourceMappingInfo

Provides mapping information for data sources.

Declaration

public Dictionary<string, string> DataSourceMappingInfo { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.String>	A dictionary where the key is the data source name and the value is the mapping information.

EmbedCredentials

Gets or sets a value indicating whether the credentials should be embedded.

Declaration

public bool EmbedCredentials { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value where true indicates that the credentials are embedded, and false means they are not.

IsFavoriteReport

Gets or sets a value indicating whether the report is marked as a favorite by the user.

Declaration

public bool IsFavoriteReport { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value where true indicates the report is a favorite, and false indicates it is not.

ReportPartMappingInfo

Gets or sets the list of report part mapping information. This property contains information regarding the mapping of different parts of the report.

Declaration

public List<string> ReportPartMappingInfo { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>	A list of strings where each string represents a mapping detail for a particular report part.

ReportPath

Gets or sets the path of the report.

Declaration

public string ReportPath { get; set; }

Property Value

Type	Description
System.String	The file system path where the report is located.

ReportServerCredential

Gets or sets the credentials used to authenticate with the report server.

Declaration

public ICredentials ReportServerCredential { get; set; }

Property Value

Type	Description
System.Net.ICredentials	An instance of ICredentials that represents the credentials for accessing the report server.

ReportServerUrl

Declaration

public string ReportServerUrl { get; set; }

Property Value

Type	Description
System.String

Methods

CreateCategory(String, String, out String)

Creates a category.

Declaration

public virtual object CreateCategory(string categoryName, string description, out string exception)

Parameters

Type	Name	Description
System.String	categoryName	Name of the category.
System.String	description	Description of the category.
System.String	exception	Output parameter to store any exception message.

Returns

Type	Description
System.Object	Returns null by default.

CreateDraftReport(String, Byte[], out String)

Creates a draft report.

Declaration

public virtual bool CreateDraftReport(string reportname, byte[] reportdata, out string exception)

Parameters

Type	Name	Description
System.String	reportname	Name of the draft report.
System.Byte[]	reportdata	Data of the draft report.
System.String	exception	Output parameter to store any exception message.

Returns

Type	Description
System.Boolean	Returns false by default.

CreateItem(ItemTypeEnum, String, String, Boolean, Byte[], out String)

Creates an item in the specified folder.

Declaration

public virtual bool CreateItem(ItemTypeEnum itemType, string itemName, string folderName, bool Overwrite, byte[] itemData, out string exception)

Parameters

Type	Name	Description
BoldReports.ServerProcessor.ItemTypeEnum	itemType	Type of the item to create.
System.String	itemName	Name of the item.
System.String	folderName	Name of the folder to contain the item.
System.Boolean	Overwrite	Whether to overwrite an existing item.
System.Byte[]	itemData	Data of the item to create.
System.String	exception	Output parameter to store any exception message.

Returns

Type	Description
System.Boolean	Returns false by default.

CreateReport(String, String, Byte[], out String)

Creates a report.

Declaration

public virtual bool CreateReport(string reportname, string folderName, byte[] reportdata, out string exception)

Parameters

Type	Name	Description
System.String	reportname	Name of the report.
System.String	folderName	Name of the folder to contain the report.
System.Byte[]	reportdata	Data of the report to create.
System.String	exception	Output parameter to store any exception message.

Returns

Type	Description
System.Boolean	Returns false by default.

CreateReportPart(String, String, String, Byte[], out String)

Creates a report part with specified details.

Declaration

public virtual bool CreateReportPart(string reportPartName, string reportPartType, string partDescription, byte[] reportPartData, out string exception)

Parameters

Type	Name	Description
System.String	reportPartName	Name of the report part.
System.String	reportPartType	Type of the report part.
System.String	partDescription	Description of the report part.
System.Byte[]	reportPartData	Data of the report part to create.
System.String	exception	Output parameter to store any exception message.

Returns

Type	Description
System.Boolean	Returns false by default.

DecryptString(String, ItemTypeEnum)

Decrypts the given encrypted string based on the specified item type.

Declaration

public virtual string DecryptString(string input, ItemTypeEnum itemType)

Parameters

Type	Name	Description
System.String	input	The encrypted string to decrypt.
BoldReports.ServerProcessor.ItemTypeEnum	itemType	The type of item specifying decryption details.

Returns

Type	Description
System.String	The decrypted string.

EditReport(Byte[])

Edits an existing report.

Declaration

public virtual bool EditReport(byte[] reportdata)

Parameters

Type	Name	Description
System.Byte[]	reportdata	Data to update the report.

Returns

Type	Description
System.Boolean	Returns false by default.

EditReportPart(String, Guid, String, String, Byte[], out String)

Edits an existing report part.

Declaration

public virtual bool EditReportPart(string reportPartName, Guid reportPartId, string reportPartType, string partDescription, byte[] reportPartData, out string exception)

Parameters

Type	Name	Description
System.String	reportPartName	Name of the report part.
System.Guid	reportPartId	Unique ID of the report part.
System.String	reportPartType	Type of the report part.
System.String	partDescription	Description of the report part.
System.Byte[]	reportPartData	Data to update the report part.
System.String	exception	Output parameter to store any exception message.

Returns

Type	Description
System.Boolean	Returns false by default.

EncryptString(String, ItemTypeEnum)

Encrypts the given string based on the specified item type.

Declaration

public virtual string EncryptString(string input, ItemTypeEnum itemType)

Parameters

Type	Name	Description
System.String	input	The string to encrypt.
BoldReports.ServerProcessor.ItemTypeEnum	itemType	The type of item specifying encryption details.

Returns

Type	Description
System.String	The encrypted string.

GetAttributeValues(List<String>, out String, Boolean)

Retrieves custom attribute values with an option to ignore cache.

Declaration

public virtual Dictionary<string, string> GetAttributeValues(List<string> customAttributes, out string errorMessage, bool isIgnoreCache)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	customAttributes	A list of custom attribute names.
System.String	errorMessage	Output parameter to hold any error messages.
System.Boolean	isIgnoreCache	True to ignore cache, false otherwise.

Returns

Type	Description
System.Collections.Generic.Dictionary<System.String, System.String>	A dictionary of attribute names and their values.

GetDataSourceDefinition(String)

Retrieves the data source definition for the given data source.

Declaration

public virtual DataSourceDefinition GetDataSourceDefinition(string dataSource)

Parameters

Type	Name	Description
System.String	dataSource	The name of the data source.

Returns

Type	Description
BoldReports.ServerProcessor.DataSourceDefinition	The data source definition.

GetDraftReport(String, out String)

Retrieves a draft report as a stream.

Declaration

public virtual Stream GetDraftReport(string reportName, out string exception)

Parameters

Type	Name	Description
System.String	reportName	Name of the draft report.
System.String	exception	Output parameter to store any exception message.

Returns

Type	Description
System.IO.Stream	Returns null stream by default.

GetItemDefinition(String)

Gets the definition of an item.

Declaration

public virtual ItemDefinition GetItemDefinition(string itemName)

Parameters

Type	Name	Description
System.String	itemName	The name of the item (or) item id.

Returns

Type	Description
ItemDefinition	The item definition.

GetItems(String, ItemTypeEnum, String)

Retrieves a list of catalog items from the specified folder based on type and permission.

Declaration

public virtual List<CatalogItem> GetItems(string folderName, ItemTypeEnum type, string permissionType)

Parameters

Type	Name	Description
System.String	folderName	The name of the folder.
BoldReports.ServerProcessor.ItemTypeEnum	type	The type of items to retrieve.
System.String	permissionType	The required permission type for items.

Returns

Type	Description
System.Collections.Generic.List<BoldReports.ServerProcessor.CatalogItem>	A list of catalog items.

GetReport()

Gets the report stream.

Declaration

public virtual Stream GetReport()

Returns

Type	Description
System.IO.Stream	A Stream containing the report data. Returns null if no report is available.

GetReportModifiedTime(String)

Retrieves the report as a stream. This method can be overridden in derived classes to provide a specific implementation of report retrieval.

Declaration

public virtual string GetReportModifiedTime(string reportId)

Parameters

Type	Name	Description
System.String	reportId

Returns

Type	Description
System.String	A System.IO.Stream object representing the report stream. If not overridden, this method returns null.

GetReportPart(String, Guid, out String)

Retrieves a report part as a stream.

Declaration

public virtual Stream GetReportPart(string reportPartName, Guid reportPartId, out string exception)

Parameters

Type	Name	Description
System.String	reportPartName	Name of the report part.
System.Guid	reportPartId	Unique ID of the report part.
System.String	exception	Output parameter to store any exception message.

Returns

Type	Description
System.IO.Stream	Returns null stream by default.

GetReportPartCatalog(out String)

Gets the catalog of report parts.

Declaration

public virtual List<CatalogItem> GetReportPartCatalog(out string exception)

Parameters

Type	Name	Description
System.String	exception	Output parameter to store any exception message.

Returns

Type	Description
System.Collections.Generic.List<BoldReports.ServerProcessor.CatalogItem>	Returns null by default.

GetSharedDataDefinition(String)

Gets the shared data definition.

Declaration

public virtual SharedDatasetinfo GetSharedDataDefinition(string path)

Parameters

Type	Name	Description
System.String	path	Path to the shared data.

Returns

Type	Description
BoldReports.ServerProcessor.SharedDatasetinfo	Returns null by default.

HasDraftReport(out String)

Checks for the existence of a draft report.

Declaration

public virtual bool HasDraftReport(out string exception)

Parameters

Type	Name	Description
System.String	exception	Output parameter to store any exception message.

Returns

Type	Description
System.Boolean	Returns false by default.

HasReportPart(String, Guid, out String)

Checks if a report part exists.

Declaration

public virtual bool HasReportPart(string reportPartName, Guid reportPartId, out string exception)

Parameters

Type	Name	Description
System.String	reportPartName	Name of the report part.
System.Guid	reportPartId	Unique ID of the report part.
System.String	exception	Output parameter to store any exception message.

Returns

Type	Description
System.Boolean	Returns false by default.