ActiveReports 9 Server User Guide
Features and Benefits
What's New
Breaking Changes
Migration from Previous Versions
License Types
Installation
System Requirements
AppPool Permissions (SQL Server)
Installed Files
Logging On to the Administrator Site
Backup and Recovery
Configuring ActiveReports 9 Server on SSL and HTTPS Web Sites
Concepts
Logical Data Models
Ad Hoc Entities
Relation Cardinality
Reports
Report Loading
Styles and Themes
Security: Users and Roles
Agents and Scalability
Single Sign-On with LDAP or Active Directory
Web Services
Configuration Section Handlers
URL Access to Reports and Designer
Managing Models
Model List Overview
Creating a New Model
Cloning a Model
Working with Model Versions
Deleting a Model
Uploading and Downloading Models
Model Editor Overview
Changing the Connection String
Modifying an Entity
Adding a New Logical Table (Entity)
Modifying an Attribute
Adding a New Logical Column (Attribute)
Modifying a Relation
Adding a New Logical Relation
Deleting an Item
Saving a Modified Model
Entering Modification Comments
Managing Model Breaking Changes
Report Categories
Managing System Categories
Managing Reports
Using Code Based Section Reports
Using RPX Reports
Using Data Dynamics Reports
Uploading Drill-Through Reports
Managing Schedules
Managing Themes and Styles
Working with Themes
Working with Styles
Managing Security
Managing Users
Managing Roles
Managing Permissions: Reports, Models, Schedules
Using LDAP and Active Directory for Single Sign-On
Managing Configuration
Managing Agents
Managing Licenses
Managing Single Sign-On Security Providers
Configuring Email
Site Settings
Managing Audit Settings
Audit Model
Audit Reports
Server Diagnostics
Privacy
How To
Create Users and Roles
Activate a License
Add Row-Level Security
Use the Designer Web Control
Hide Log In and Log Out Buttons
Open the Designer without Selecting a Model
Create a Custom Security Provider
Debug a Security Provider
View Reports Using the HTML5 Viewer
Work with the HTML5 Viewer using Javascript
Get a Security Token
Samples and Walkthroughs
Samples
Security Provider Sample
Walkthroughs
Accessing the Web Service
Using the ReportList Web Control
Uploading a Code-Based Section Report
Troubleshooting
Support Options
Class Library
ActiveReports.Server.ReportControls Namespace
Overview
Classes
Designer
Overview
Members
Designer Constructor
Methods
OnInit Method
OnLoad Method
OnPreRender Method
Render Method
Properties
AdminPath Property
DesignerHelpPath Property
DesignerServicePath Property
DiagnosticPagePath Property
FlashNotInstalledTemplate Property
Height Property
HiddenElements Property
ModelName Property
ReportAction Property
ReportId Property
ReportName Property
RequestStatusCheckInterval Property
ResourcePath Property
SecurityToken Property
SiteRootPath Property
Width Property
WindowMode Property
LocalizedDescriptionAttribute
Overview
Members
LocalizedDescriptionAttribute Constructor
ReportList
Overview
Members
ReportList Constructor
Methods
AddAttributesToRender Method
CreateChildControls Method
GetScriptDescriptors Method
GetScriptReferences Method
OnInit Method
Properties
ActionTemplate Property
AlternateItemTemplate Property
ARRenderExtensions Property
BuiltInTheme Property
ClientDataBound Property
ClientError Property
ClientRender Property
ClientRenderComplete Property
CompleteTemplate Property
DateTimeFormat Property
DDRRenderExtensions Property
ErrorTemplate Property
Filter Property
FirstItemTemplate Property
FooterTemplate Property
HeaderTemplate Property
Height Property
ItemTemplate Property
LastItemTemplate Property
ListTemplate Property
NoReportsTemplate Property
ProgressTemplate Property
ReportServicePath Property
ResourceHandler Property
SeparatorTemplate Property
ServerEndpointRootPath Property
Sorting Property
TagKey Property
Timeout Property
Width Property
Enumerations
DesignerElements
ReportAction
ReportList.Theme
WindowMode
ActiveReports.Server.ReportControls.Servicing Namespace
Overview
Classes
RemoteEndpoint
Overview
Members
RemoteEndpoint Constructor
Properties
Address Property
SecurityToken Property
ServiceChannelFactory<TServiceChannel>
Overview
Members
Methods
Create Method
Create() Method
Create(String) Method
Create(Binding,EndpointAddress) Method
ServiceProxyBase
Overview
Members
Methods
ResolveSecurityToken Method
RetrieveRemoteEndpoint Method
Events
ResolveRemoteEndpoint Event
ActiveReports.Server.ReportServices.Contracts Namespace
Overview
Classes
DataArrayResult
Overview
Members
DataArrayResult Constructor
Properties
Data Property
DataResult
Overview
Members
DataResult Constructor
Properties
Data Property
DescriptionFilter
Overview
Members
DescriptionFilter Constructor
ExportOptions
Overview
Members
ExportOptions Constructor
Properties
DocumentId Property
Extension Property
ExtensionSettings Property
ToggleHistory Property
ItemDescriptionsResult
Overview
Members
ItemDescriptionsResult Constructor
Properties
ItemDescriptions Property
LookupData
Overview
Members
LookupData Constructor
Properties
Fields Property
RecordCount Property
LookupField
Overview
Members
LookupField Constructor
Properties
Name Property
Values Property
LookupFieldValues
Overview
Members
LookupFieldValues Constructor
LookupResult
Overview
Members
LookupResult Constructor
Properties
Data Property
PermissionRecord
Overview
Members
PermissionRecord Constructor
Properties
IsMember Property
IsReadOnly Property
Permission Property
Role Property
Query
Overview
Members
Query Constructor
Properties
FilterBy Property
OrderBy Property
RelayoutOptions
Overview
Members
RelayoutOptions Constructor
Properties
DocumentId Property
ToggleHistory Property
RenderOptions
Overview
Members
RenderOptions Constructor
Properties
Extension Property
ExtensionSettings Property
Name Property
ReportId Property
ReportParameters Property
ReportType Property
ReportParameter
Overview
Members
ReportParameter Constructor
Properties
Domain Property
Name Property
Values Property
ReportParametersResult
Overview
Members
ReportParametersResult Constructor
Properties
Parameters Property
ReportVersionFilter
Overview
Members
ReportVersionFilter Constructor
Properties
ReportId Property
RequestInfo
Overview
Members
RequestInfo Constructor
Properties
ErrorCode Property
ErrorData Property
Exception Property
PrimaryUrl Property
RequestId Property
State Property
RequestResult
Overview
Members
RequestResult Constructor
Properties
Info Property
ResourcePermissionsResult
Overview
Members
ResourcePermissionsResult Constructor
Properties
IsOwner Property
Permissions Property
Result
Overview
Members
Result Constructor
Properties
Error Property
IsAuthenticated Property
StyleDescription
Overview
Members
StyleDescription Constructor
ThemeDescription
Overview
Members
ThemeDescription Constructor
Methods
ToString Method
Properties
Accent1 Property
Accent2 Property
Accent3 Property
Accent4 Property
Accent5 Property
Accent6 Property
Dark1 Property
Dark2 Property
IsDefault Property
Light1 Property
Light2 Property
MajorFontFamily Property
MajorFontSize Property
MajorFontStyle Property
MajorFontWeight Property
MinorFontFamily Property
MinorFontSize Property
MinorFontStyle Property
MinorFontWeight Property
ThemeUri Property
UploadOptions
Overview
Members
UploadOptions Constructor
Properties
ConnectionString Property
Overwrite Property
OverwriteBehavior Property
SkipResourceValidation Property
UserCapabilities
Overview
Members
UserCapabilities Constructor
Properties
Email Property
HasAdminPrivileges Property
IsDesignPermitted Property
IsEvaluationVersion Property
IsSchedulePermitted Property
UserCapabilitiesResult
Overview
Members
UserCapabilitiesResult Constructor
Properties
Capabilities Property
Enumerations
DescriptionType
OverwriteBehavior
ReportParameterDomain
RequestState
StorageType
ActiveReports.Server.ReportServices.Contracts.Descriptions Namespace
Overview
Classes
AssemblyDescription
Overview
Members
AssemblyDescription Constructor
DescriptionExt
Overview
Members
Methods
GetStorageType Method
ItemDescription
Overview
Members
ItemDescription Constructor
Methods
GetStorageType Method
ToString Method
Properties
CreatedBy Property
CreationDate Property
Id Property
ModifiedBy Property
ModifiedDate Property
Name Property
Permissions Property
ReportDescription
Overview
Members
ReportDescription Constructor
Methods
ToString Method
Properties
AssemblyResourceId Property
ClassName Property
Description Property
IsBroken Property
IsParametrized Property
LastChangeComment Property
MasterReportIds Property
ModelId Property
ModelName Property
ModelPermissions Property
ModelVersion Property
ReportType Property
SubreportIds Property
ThemeId Property
Version Property
ReportParameterDescription
Overview
Members
ReportParameterDescription Constructor
Properties
AllowBlank Property
DataType Property
DefaultValues Property
Hidden Property
MultiValue Property
Name Property
Nullable Property
Prompt Property
ReportVersionDescription
Overview
Members
ReportVersionDescription Constructor
Properties
AssemblyResourceId Property
Comment Property
IsParametrized Property
MasterReportIds Property
ModelId Property
ModelVersion Property
ReportId Property
ReportType Property
SubreportIds Property
ThemeId Property
Version Property
ResourceDescription
Overview
Members
ResourceDescription Constructor
Properties
MIMEType Property
SemanticModelDescription
Overview
Members
SemanticModelDescription Constructor
Properties
CurrentComment Property
Description Property
ReportCount Property
Version Property
SemanticModelDraftDescription
Overview
Members
SemanticModelDraftDescription Constructor
Properties
User Property
SemanticModelVersionDescription
Overview
Members
SemanticModelVersionDescription Constructor
Properties
Comment Property
Version Property
SharedPolicyTemplateDescription
Overview
Members
SharedPolicyTemplateDescription Constructor
Properties
DescriptionText Property
ScheduleCount Property
TemporaryItemDescription
Overview
Members
TemporaryItemDescription Constructor
Properties
ExpirationDate Property
MIMEType Property
PrimaryId Property
User Property
ActiveReports.Server.ReportServices.Contracts.Errors Namespace
Overview
Classes
Error
Overview
Members
Error Constructor
Properties
Description Property
Name Property
NonCritical Property
ExceptionDetail
Overview
Members
ExceptionDetail Constructor
ExceptionDetail Constructor(ExceptionDetail)
ExceptionDetail Constructor(Exception)
Properties
HelpLink Property
InnerException Property
Message Property
StackTrace Property
Type Property
ExceptionError
Overview
Members
ExceptionError Constructor
Properties
Exception Property
NoticeType
Overview
Members
NoticeType Constructor
ValidationError
Overview
Members
ValidationError Constructor
Properties
Errors Property
Warnings Property
ActiveReports.Server.ReportServices.Contracts.Feedback Namespace
Overview
Classes
BugReport
Overview
Members
BugReport Constructor
Properties
Data Property
ErrorId Property
ModelState Property
StackTrace Property
FeedbackReport
Overview
Members
FeedbackReport Constructor
Properties
Title Property
UserDescription Property
UserEmail Property
ActiveReports.Server.ReportServices.Contracts.Policy Namespace
Overview
Classes
JournalEntry
Overview
Members
JournalEntry Constructor
Properties
AccessionCode Property
Details Property
EntryPriority Property
EntryStatus Property
Id Property
Job Property
ScheduledTime Property
JournalEntryDetails
Overview
Members
JournalEntryDetails Constructor
Properties
ExceptionDetails Property
PrimaryUrl Property
ReportParameters Property
JournalEntryTemplate
Overview
Members
JournalEntryTemplate Constructor
Properties
EntryPriority Property
Job Property
Policy
Overview
Members
Policy Constructor
Properties
CachePolicy Property
CreatedBy Property
CreationDate Property
Distribution Property
Id Property
JournalEntry Property
ModifiedBy Property
ModifiedDate Property
Name Property
PolicyType Property
Schedule Property
SharedPolicyTemplateId Property
TargetId Property
PolicyHistoryEntry
Overview
Members
PolicyHistoryEntry Constructor
Properties
IsExpired Property
JournalEntry Property
PolicyId Property
PolicyName Property
TargetId Property
PolicyHistoryResult
Overview
Members
PolicyHistoryResult Constructor
Properties
History Property
PolicyResult
Overview
Members
PolicyResult Constructor
Properties
Policies Property
ActiveReports.Server.ReportServices.Servicing Namespace
Overview
Interfaces
IDesignerService
Overview
Members
Methods
CancelRequest Method
CreatePolicy Method
DeletePolicy Method
DeleteReport Method
DoLookup Method
DownloadItem Method
ExportDocument Method
GetList Method
GetParameterList Method
GetPolicies Method
GetResourcePermissions Method
GetUserCapabilities Method
IsLoggedIn Method
Login Method
Logout Method
RelayoutDocument Method
RenderReport Method
ResolveParameters Method
RetrieveHistory Method
SavePolicy Method
SetDescription Method
SetResourcePermissions Method
SubmitReport Method
UploadItem Method
IReportService
Overview
Members
Methods
CancelRequest Method
Delete Method
DeleteResource Method
Download Method
DownloadResource Method
ExportDocument Method
GetRequestStatus Method
GetResourcePermissions Method
GetUserCapabilities Method
IsLoggedIn Method
Login Method
Logout Method
RenderReport Method
ResolveParameters Method
Select Method
SelectDescriptions Method
SelectModels Method
SelectReports Method
SendReportEmail Method
SetDefaultTheme Method
SetReportDescription Method
SetResourcePermissions Method
Upload Method
UploadResource Method
ActiveReports.Server.Scheduling Namespace
Overview
Classes
DistributionChain
Overview
Members
DistributionChain Constructor
Properties
Items Property
DistributionMethod
Overview
Members
DistributionMethod Constructor
EMailDistribution
Overview
Members
EMailDistribution Constructor
Properties
AsAttachment Property
AsLink Property
AttachmentTemplate Property
BaseUri Property
MessageBody Property
Subject Property
To Property
FileShareDistribution
Overview
Members
FileShareDistribution Constructor
Properties
ExistingBehavior Property
ExtensionBehavior Property
FileName Property
Password Property
Path Property
User Property
PolicyHistoryEntry
Overview
Members
PolicyHistoryEntry Constructor
Properties
IsExpired Property
JournalEntry Property
PolicyId Property
PolicyName Property
TargetId Property
RecurrenceRule
Overview
Members
RecurrenceRule Constructor
Methods
Equals Method
Equals(RecurrenceRule) Method
Equals(Object) Method
GetHashCode Method
Properties
ByDayList Property
ByHourList Property
ByMinuteList Property
ByMonthDayList Property
ByMonthList Property
ByOccurrenceList Property
BySecondList Property
ByWeekList Property
ByYearDayList Property
Frequency Property
Interval Property
StartDayOfWeek Property
Termination Property
Operators
Equality Operator
Inequality Operator
RecurrenceSet
Overview
Members
RecurrenceSet Constructor
Properties
ExceptionDates Property
ExceptionRules Property
RecurrenceDates Property
RecurrenceRules Property
StartDate Property
Schedule
Overview
Members
Schedule Constructor
Properties
Enabled Property
RecurrenceSet Property
Termination
Overview
Members
TerminationByCount
Overview
Members
TerminationByCount Constructor
Methods
Equals Method
Equals(TerminationByCount) Method
Equals(Object) Method
GetHashCode Method
Properties
Value Property
Operators
Equality Operator
Inequality Operator
TerminationByEndDate
Overview
Members
TerminationByEndDate Constructor
Methods
Equals Method
Equals(TerminationByEndDate) Method
Equals(Object) Method
GetHashCode Method
Properties
Value Property
Operators
Equality Operator
Inequality Operator
Enumerations
ExistingFileBehavior
FileExtensionBehavior
Frequency
PolicyType
Structures
Day
Overview
Members
Methods
Equals Method
Equals(Day) Method
Equals(Object) Method
GetHashCode Method
Fields
DayOfWeek Field
Ordinal Field
Operators
Equality Operator
Inequality Operator
Interfaces
ICachePolicy
Overview
Members
Properties
Expiration Property
Priority Property
IDistribution
Overview
Members
Properties
Methods Property
IExpirationRule
Overview
Members
Methods
CreateExpiration Method
IJobEntryTemplate
Overview
Members
Properties
AccessionCode Property
Job Property
Priority Property
Version Property
IPolicy
Overview
Members
Methods
Save Method
Properties
CachePolicy Property
CreatedBy Property
CreationDate Property
Distribution Property
Id Property
JobEntry Property
ModifiedBy Property
ModifiedDate Property
Name Property
PolicyType Property
Schedule Property
SharedPolicyTemplateId Property
TargetId Property
ISchedule
Overview
Members
Properties
Enabled Property
RecurrenceSet Property
IScheduler
Overview
Members
Methods
Create Method
Destroy Method
Select<TResult> Method
ActiveReports.Server.Security Namespace
Overview
Classes
PermissionsEnumExtensions
Overview
Members
Methods
ToOperations Method
ToPermissions Method
Setting
Overview
Members
Setting Constructor
Properties
Description Property
DisplayName Property
IsPassword Property
Name Property
Type Property
Value Property
UserContext
Overview
Members
Methods
GetValue Method
GetValues Method
Properties
Item Property
Keys Property
Enumerations
Permissions
Structures
UserDescription
Overview
Members
Properties
Email Property
FriendlyUserName Property
Interfaces
IExtensibleMembershipProvider
Overview
Members
Methods
FindUserDataByKey Method
FindUserDataByName Method
GetUserData Method
UpdateUserData Method
IRole
Overview
Members
Properties
Name Property
ISecurityProvider
Overview
Members
Methods
CreateToken Method
DisposeToken Method
FilterRoles Method
GetAdminContext Method
GetCacheKeySalt Method
GetUserContext Method
GetUserContextKeys Method
GetUserDescription Method
ValidateToken Method
ISecurityProviderFactory
Overview
Members
Methods
Create Method
GetSupportedSettings Method
ISecurityProvidersRegistry
Overview
Members
Methods
CreateCustomProvider Method
CreateProvider Method
GetProviderList Method
GetRegisteredProviderFactories Method
ReadSettings Method
SaveSetting Method
Properties
CurrentProviderKey Property
Web Service Library
ReportService
CancelRequest Method
Delete Method
Download Method
GetRequestStatus Method
GetUserCapabilities Method
IsLoggedIn Method
Login Method
Logout Method
RenderReport Method
ResolveParameters Method
Select Method
SendReportEmail Method
Upload Method
UploadResource Method
DataResult Object
EMailDistribution Object
ExceptionDetail Object
ItemDescription Object
ItemDescriptionsResult Object
Query Object
RenderOptions Object
ReportDescription Object
ReportParameter Object
RequestInfo Object
RequestResult Object
Result Object
UploadOptions Object
UserCapabilities Object
UserCapabilitiesResult Object
ModelPermission Enumeration
ReportParameterDomain Enumeration
ReportType Enumeration
RequestState Enumeration
Section 508 Compliance
Glossary