Microsoft CRM 2015 Guide

PDF

Documento

Anuncio

Report writing with CRM 2015 for online and on-premises

Version 7.1.1

This document is provided "as-is". Information and views expressed in this document, including

URL and other Internet Web site references, may change without notice.

Some examples depicted herein are provided for illustration only and are fictitious. No real association or connection is intended or should be inferred.

This document does not provide you with any legal rights to any intellectual property in any

Microsoft product. You may copy and use this document for your internal, reference purposes.

The videos and eBooks might be in English only. Also, if you click the links, you may be redirected to a U.S. website whose content is in English.

Microsoft, Active Directory, Azure, Bing, Excel, Internet Explorer, Microsoft Dynamics, Outlook,

SharePoint, SQL Server, Windows, and Windows Server are trademarks of the Microsoft group of companies. All other trademarks are property of their respective owners.

Report writing with CRM 2015 for online and on-premises ............................................................. 4

Get started writing reports ............................................................................................................ 4

Report writing environment using SQL Server Data Tools ....................................................... 6

Create a new report using SQL Server Data Tools .................................................................. 8

Working with Microsoft Dynamics CRM reports ......................................................................... 11

Format report content ............................................................................................................. 12

Add report navigation .............................................................................................................. 14

Categorize and display reports in different languages ........................................................... 15

Use parameters in reports ...................................................................................................... 16

Working with SQL-based reports (CRM on-premises only) ....................................................... 21

Modify an existing SQL-based report using SQL Server Data Tools ..................................... 22

Use SQL and filtered views to retrieve data for reports .......................................................... 23

Filtered views in Microsoft Dynamics CRM ......................................................................... 26

Test and troubleshoot reports .................................................................................................... 44

Publish reports ........................................................................................................................... 46

Report considerations and best practices .................................................................................. 47

Best practices for reports ........................................................................................................ 48

Improve performance of reports ............................................................................................. 50

Improve report performance by using filters ........................................................................... 50

Microsoft Dynamics CRM Online reporting considerations .................................................... 56

RDL sandboxing for Microsoft Dynamics CRM Online ........................................................... 59

Sample reports ........................................................................................................................... 68

Sample: Limit the number of items displayed in a chart ......................................................... 68

Sample: Display the top X values ........................................................................................... 70

Sample: Make a report context-sensitive ............................................................................... 71

Copy reports between Microsoft Dynamics CRM on-premises deployments ............................ 72

Send us your comments about this document ........................................................................... 75

Report writing with CRM 2015 for online and on-premises

Microsoft Dynamics CRM includes reports that provide useful business information to the user.

Microsoft Dynamics CRM also includes a Report Wizard that can be used to easily create reports in just a few steps without using XML or SQL-based queries. For more information about the

Report Wizard, see CRM Help & Training: Create, edit, or copy a report using the Report Wizard .

However, to create more complex reports, you can either create your own custom reports from scratch, or use an existing Microsoft Dynamics CRM report as a template. The topics in this guide show you how to create new reports or change existing reports using Microsoft Visual Studio as the report writing tool.

In This Section

Get started writing reports

Working with Microsoft Dynamics CRM reports

Working with SQL-based reports (CRM on-premises only)

Test and troubleshoot reports

Publish reports

Report considerations and best practices

Sample reports

Copy reports between Microsoft Dynamics CRM on-premises deployments

Related Sections

Planning Guide for Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online

Installing Guide for Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online

Administration Guide for Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM

Online

Operating Guide for Microsoft Dynamics CRM 2013 (on-premises)

Get started writing reports

Microsoft Dynamics CRM uses Microsoft SQL Server Reporting Services report definition language (RDL) reports to query CRM data to return refined results back to the report user. For more information about RDL, see TechNet: Report Definition Language (SSRS) .

To create or modify existing RDL reports that can be used with Microsoft Dynamics CRM, you use either T-SQL or FetchXML, which is then converted to RDL by using report authoring tools.

The following table lists the differences between SQL-based and Fetch-based reports in Microsoft

Dynamics CRM.

Area

Supported

Microsoft

Dynamics

CRM

Versions

Report

Query

Language

SQL-based Report

Microsoft Dynamics CRM (onpremises)

Fetch-based report

Microsoft Dynamics CRM Online and

Microsoft Dynamics CRM (on-premises)

Uses Transact-SQL (T-SQL), a set of programming extensions that provide comprehensive transaction control by using the

Structured Query Language

(SQL). More information: TechNet:

Transact-SQL Reference

(Database Engine)

Uses FetchXML, an extensible markup language (XML) designed specifically for

Microsoft Dynamics CRM queries. More information: MSDN: FetchXML schema

Requires

Report

Authoring

Extension?

.RDL file

Data

Provider

Yes

The

element value in the .rdl file is set to SQL. For example:

The

element value in the .rdl file is set to MSCRMFETCH. For example:

<DataProvider>MSCRMFETCH</DataProvider>

.RDL file

Report

Query

The query specified for retrieving data is in the

subelement under the

<Query> element in the report definition

(.rdl file) is a SQL query. For example, the query for retrieving all account names for a SQLbased report will be:

<CommandText>SELECT name FROM

FilteredAccount;</CommandText>

The query specified for retrieving data is in the

sub-element under the

<Query> element in the report definition (.rdl file) is a

FetchXML query. For example, the query for retrieving all account names for a Fetch-based report will be:

</entity></fetch></CommandText>

If you want, you can use a third-party tool, SQL2FetchXML, to convert your SQL scripts to

FetchXML, and then use the FetchXML query in your Fetch-based reports. More information:

SQL2FetchXML Help

In This Section

This section covers what you need to create a new Microsoft Dynamics CRM report.

Report writing environment using SQL Server Data Tools

Create a new report using SQL Server Data Tools

Related Sections

Report writing with CRM 2015 for online and on-premises

Working with SQL-based reports (CRM on-premises only)

Publish reports

Report writing environment using SQL Server Data Tools

This topic describes what’s needed to author Microsoft Dynamics CRM reports. For Microsoft

Dynamics CRM (on-premises), this topic assumes you already have a functioning deployment of

Microsoft Dynamics CRM Server. For information about Microsoft Dynamics CRM (on-premises) requirements for reporting, see Microsoft Dynamics CRM 2015 Reporting requirements.

You must have the required development tools and appropriate privileges in Microsoft Dynamics

CRM to write and publish a report. Also, you should have familiarity with:

 Microsoft Visual Studio.

 Creating Microsoft SQL Server Reporting Services reports using SQL Server Data Tools

(SSDT).

 To write Fetch-based reports, the Microsoft Dynamics CRM FetchXML language.

 To write SQL-based reports, the Transact-SQL language for Microsoft SQL Server.

Required tools

The following are required to write a custom report for Microsoft Dynamics CRM:

 Microsoft SQL Server Reporting Services. Microsoft Dynamics CRM uses Microsoft SQL

Server Reporting Services as the report engine.

 Microsoft Visual Studio 2012 or Microsoft Visual Studio 2010.

 SQL Server Data Tools. This is a report authoring environment that is used as a plug-in

Microsoft Visual Studio.

 For Microsoft Visual Studio 2012: You must download and install

Download: Microsoft

SQL Server Data Tools - Business Intelligence for Visual Studio 2012 .

 For Microsoft Visual Studio 2010: You must select and install the SQL Server Data Tools

(SSDT) feature that is included with Microsoft SQL Server 2012 or Microsoft SQL Server

2012 Express on the computer that is running Microsoft Visual Studio 2010. Download:

Microsoft SQL Server 2012 Express

 Microsoft Dynamics CRM Report Authoring Extension. This is required if you are writing custom Fetch-based reports. Notice that Microsoft Dynamics CRM Online only supports

Fetch-based reports. Microsoft Dynamics CRM Report Authoring Extension must be installed on the computer where Microsoft Visual Studio and SQL Server Data Tools are installed.

Download: CRM 2015 Report Authoring Extension . For installation instructions, see Install

Microsoft Dynamics CRM Report Authoring Extension .

Note

Microsoft Dynamics CRM Report Authoring Extension is available only in a 32-bit version.

Required privileges

To deploy custom reports to Microsoft Dynamics CRM, you must have a Microsoft Dynamics

CRM account and a security role assigned to you that includes the PublishReport privilege. By default, the System Customizer and System Administrator security roles include these privileges.

Report development process

The following lists the steps for developing custom Microsoft Dynamics CRM reports. You may have to repeat some steps while you develop a report:

1. Develop a report concept or specification based on what business information is to be displayed.

2. Decide on the type of report you want to create: Fetch-based or SQL-based. Microsoft

Dynamics CRM Online users can only create custom Fetch-based reports. More information:

Report writing with CRM 2015 for online and on-premises

3. Create a custom report or use an existing report to modify using SQL Server Data Tools in

Microsoft Visual Studio.

 Create a new (custom) report. More information:

Create a new report using SQL Server

Data Tools

 Download an existing Microsoft Dynamics CRM report definition language (.rdl) file. You

can do this in the Microsoft Dynamics CRM web application. More information: Modify a report (RDL) file

Alternatively, for Microsoft Dynamics CRM (on-premises), reports are located in the

C:\Program Files\Microsoft Dynamics CRM Reporting

Extensions\LangPacks\<lcid>\Reports\MSCRM\ folder where Microsoft Dynamics CRM

Reporting Extensions is installed. More information: Modify an existing SQL-based report using SQL Server Data Tools

4. Create basic report parameters. More information: Use parameters in reports

5. Specify datasets and filtering criteria for retrieving data:

 For SQL-based reports, create datasets that contain Microsoft Dynamics CRM data

obtained from the filtered views. More information: Filtered views in Microsoft Dynamics

CRM

 Enable pre-filtering on the primary entities. More information:

Improve report performance by using filters

6. Define the basic layout of the report, including headers and footers.

7. Add report items as required based on the report specification. More information: Add report navigation

8. Preview the report in Microsoft Visual Studio, and resolve any errors. More information: Test and troubleshoot reports

9. Deploy the report to the reporting server by using Microsoft Dynamics CRM. More

information: Publish reports

10. Run the deployed report to verify.

Create a new report using SQL Server Data Tools

SQL Server Data Tools in Microsoft Visual Studio is the primary tool that is used to create or modify reports. SQL Server Data Tools is a report authoring environment that lets you create

Microsoft SQL Server Reporting Services reports in Microsoft Visual Studio. The end result is an

.rdl file containing the report definition that you can publish in Microsoft Dynamics CRM to view reports.

Alternatively, you can author reports by using a common text editor. To reduce the effort to create a custom report, use an existing report definition file (.rdl) that provides most of the desired functionality and modify it. For more information about the format of the XML elements in an .rdl file, see Report Definition Language Reference . The modified report XML can be verified by using the specified XML schema. Reporting Services will also verify the report definition and reject a report if the definition is invalid when you try to upload the report in Microsoft Dynamics CRM.

Note

If the .rdl file contains a FetchXML query, the FetchXML query in the RDL is validated by

Microsoft Dynamics CRM Report Authoring Extension, which internally validates it against the FetchXML schema. For more information, see the Fetch XML Schema topic in the Microsoft Dynamics CRM SDK.

In This Topic

Create a custom Fetch-based report (CRM Online and CRM on-premises)

Create a custom SQL-based report (Microsoft Dynamics CRM on-premises only)

Create a custom Fetch-based report (CRM Online and CRM on-premises)

To create a custom Fetch-based report:

1. Make sure that you have a supported version of Microsoft Visual Studio, SQL Server Data

Tools, Microsoft Dynamics CRM Report Authoring Extension and the necessary privileges.

More information: Report writing environment using SQL Server Data Tools

2. Open Microsoft Visual Studio, and create a report server project.

3. In Solution Explorer, right-click the Reports folder, and then choose Add New Report.

4. Choose Next.

5. On the Select the Data Source page, choose New Data Source, and specify the following details:

 Name: Type a name for the data source.

 Type: Select Microsoft Dynamics CRM Fetch.

 Connection String: Specify the connection string. The connection string must be specified in the following format:

ServerURL;OrganizationName;HomeRealmURL

In this connection string, only ServerURL is mandatory. If OrganizationName is not specified, the first organization that the user running this query belongs to is used.

HomeRealmURL is the Home Realm URL of the Identity Provider used by your organization and is needed when your organization uses Federation for identity management. Contact your network administrator to determine the Home Realm URL.

Choose Credentials to specify the credentials to connect to Microsoft Dynamics CRM or

Microsoft Dynamics CRM Online, and choose Next.

6. On the Design the Query page, type the FetchXML query in the Query box. To get your

FetchXML query, you can do one of the following:

Tip

The easiest method to create the FetchXML for a report is to create an Advanced

Find query that provides the results that you want and then save the query as

FetchXML as described here.

 Get the FetchXML from an Advanced Find query. To do this, open Microsoft Dynamics

CRM, choose Advanced Find, create the query that you want, and then on the

Advanced Find tab choose Download Fetch XML. Copy the FetchXML into the Query

box of the Dataset Properties in Microsoft Visual Studio.

 Manually enter the FetchXML query, such as the following example, which creates a report that displays all accounts with 5000 or more employees.

</filter>

</entity>

</fetch>

More information: MSDN: Build queries with FetchXML in the Microsoft

Dynamics CRM SDK.

Click Next.

7. Verify the fields that will be included in the report. Choose Next.

8. Select a style to apply to the report, and then choose Next.

9. Verify the fields that will be included in the report, and enter a name for the report, such as

Accounts With More Than 5000 Employees. Choose Finish.

Tip

Choose the Preview tab to display how the report will appear when run.

This will generate an .rdl file with the specified report name. You can use the .rdl file to publish your custom report in Microsoft Dynamics CRM Online using the Report Wizard. More

information: Publish reports .

Create a custom SQL-based report (Microsoft Dynamics CRM on-premises only)

To create a custom SQL-based report using SQL Server Data Tools:

1. Make sure that you have a supported version of Microsoft Visual Studio and SQL Server

Data Tools and the necessary privileges. More information: Report writing environment using

SQL Server Data Tools

2. Open Microsoft Visual Studio, and create a report server project.

3. In Solution Explorer, right-click the Reports folder, and then choose Add New Report.

4. Choose Next.

5. On the Select the Data Source page, choose New data source, and specify the following details:

 Name: Type a name for the data source.

 Type: Select Microsoft SQL Server.

 Connection String: Specify the connection string to connect to the instance of the

Microsoft SQL Server database. To build the connection string, and choose Edit to type the SQL Server name and organizationName_MSCRM database. To supply credentials, select Credentials. Choose Next.

6. On the Design the Query page, type the SQL query to use for the report, and choose Next.

For example, to create a report that displays all accounts with 5000 or more employees, where OrgName_MSCRM is the name of the organization database, use this SQL query.

Use OrgName_MSCRM Select Name, AccountNumber, NumberofEmployees from AccountBase where NumberofEmployees > 5000 order by

NumberofEmployees desc

Alternatively, you can design a query by choosing Query Builder.

7. On the Select the Report Type page, select a Tabular report or a Matrix report, and choose

Next.

8. Verify the fields that will be included in the report. Choose Next.

9. Select a style to apply to the report, and then choose Next.

10. Verify the fields that will be included in the report, and enter a name for the report, such as

Accounts With More Than 5000 Employees. Choose Finish.

Tip

Choose the Preview tab to display how the report will appear when run.

This will generate an .rdl file with the specified report name. You can use the .rdl file to publish

your custom report in Microsoft Dynamics CRM. More information: Publish reports .

For more information about how to create a report by using the Report Designer, see Create a

Basic Table Report (SSRS Tutorial) .

Working with Microsoft Dynamics CRM reports

This section describes the different features that are available to determine how reports display in

Microsoft Dynamics CRM.

In This Section

Format report content

Add report navigation

Categorize and display reports in different languages

Use parameters in reports

Format report content

You can obtain the Microsoft Dynamics CRM organization formatting values for date, time, number, and currency by using the fn_GetFormatStrings SQL function that is available in the

Microsoft Dynamics CRM database. This function returns a single row data table that contains the formatting values. To view the contents of the returned table, execute the following SQL query on the database server.

USE <organization>_MSCRM

SELECT * FROM dbo.fn_GetFormatStrings()

Use formatting values in reports

1. Create a dataset to contain the formatting data. For information about how to create a dataset, see TechNet: Create a Shared Dataset or Embedded Dataset (Report Builder and SSRS) . a. Name the dataset DSNumandCurrency or use another name. DSNumandCurrency is the dataset name that is used in reports that are included with Microsoft Dynamics

CRM. b. Use the SQL SELECT statement described above to fill the dataset.

2. Reference the format field, such as date and time, number, or currency (described below) from the dataset in the Format property of the report item that you want to format.

Note

 For date, time, and currency formatting, set the Language property of the report item or the report to

"=First(Fields! NumberLanguageCode.Value, "DSNumandCurrency")"

Date and time values

For date and time, you also set the Calendar property of the report item to

"=First(Fields!CalendarType.Value, "DSNumandCurrency")"

Formatting string

Date

Report item Format property value

=First(Fields!DateFormat.Value,

Formatting string

Time

Report item Format property value

"DSNumandCurrency")

=First(Fields!TimeFormat.Value,

"DSNumandCurrency")

Number values

The fn_GetFormatStrings function returns the number of format strings with precision values between 0 and 5. You can specify a precision by putting a decimal value between the underscore characters in the field name.

Formatting string

Integer

Report item Format property value

Decimal with 2-decimal points precision

=First(Fields!NumberFormat_0_Precision.Value,

"DSNumandCurrency")

=First(Fields!NumberFormat_2_Precision.Value,

"DSNumandCurrency")

Base currency value

The fn_GetFormatStrings function returns base currency format strings with precision values between 0 and 5. You can specify a precision by putting a decimal value between the underscore characters in the field name.

Report item Format property value Formatting string

Base currency with 2-decimal points precision

=First(Fields!CurrencyFormat_2_Precision.Value,

"DSNumandCurrency")

Transaction currency

When you create a report on an entity with the transaction currency information, you can retrieve the transaction currency format string from the crm_moneyformatstring column of the filtered view for an entity. After a column has been added to the dataset, you can reference the column on the

Format property of the report. For information about how to add columns to a dataset, see

How to: Add, Edit, or Delete a Field in the Report Data Pane . For example, to retrieve a price unit and the transaction currency formatting information from the quote detail filtered view, use the following SELECT statement:

SELECT priceperunit, crm_moneyformatstring FROM FilteredQuoteDetail

You can reference a new column on the Format property of the report item as follows:

=Fields.crm_moneyformatstring.Value

Note

For more information about report navigation, see Drillthrough, Drilldown, Subreports, and Nested Data Regions (Report Builder and SSRS)rts in the Microsoft SQL Server documentation. This topic describes report navigation that is specific to Microsoft

Dynamics CRM reports.

Dynamic drill through to Microsoft Dynamics CRM

You can drill through a report to navigate to a Microsoft Dynamics CRM web form. A drill-through report is implemented in the following steps:

1. An image or value item (such as a text box) is added to a report. The Value property of this item contains code that builds a URL by using the base address of Microsoft Dynamics CRM plus parameters that refer to a specific record.

2. When the user selects the report item, a new browser window is opened by using the constructed URL passed as the target web address.

3. Microsoft Dynamics CRM loads the information for the specified entity into a web form that is displayed in the browser window.

To set up a drill-through report in Microsoft Dynamics CRM

1. Create a hidden parameter of type string in the report that has the name CRM_URL. For

more information about adding parameters, see Use parameters in reports . When the

report is run, this parameter is automatically set to the web address of Microsoft

Dynamics CRM.

2. Add a report item, such as a Textbox.

3. Right-click the drill-through report item and select Properties from the shortcut menu.

4. Select Advanced.

5. In the Navigation tab, select Jump to URL and enter an expression in the following format:

= Parameters!CRM_URL.Value & "?ID={"& GUID

&"}&LogicalName=entity logical name"

The entity GUID and entity logical name have to be added to the URL to be able to drill through. For example:

= Parameters!CRM_URL.Value &

"?ID={"&Fields!Opportunityid.Value.ToString()&"}&LogicalName= opportunity"

6. Choose OK.

In this example code, the value of a dataset field that contains the GUID of an Opportunity object is converted to a string and used as an ID parameter in the URL. A parameter that contains the LogicalName value for an opportunity entity is also appended.

The GUID of a record can be obtained from the appropriate filtered view, for example,

FilteredOpportunity.

Note

The Language element inside the report definition language (RDL) file does not determine where the report is shown in Microsoft Dynamics CRM. It contains an expression that evaluates to a language code as defined in the Internet Engineering Task

Force (IETF) RFC1766 specification. The language code is used mainly for formatting numbers, dates, and times for a specified language. More information: Language

Element (Report) (RDL) .

Note

The maximum length of the parameter values that is passed in from Microsoft Dynamics

CRM is 2,000 characters. For example, if you run a report and create a data filter through the Advanced Find user interface, the resulting filter expression that is passed to a filter parameter cannot exceed 2,000 characters. There is no maximum limit on the number of parameters that you can specify. However, you might have to limit the length of the string on the URL line and number of parameters to meet the requirements of a particular browser.

In this topic

Adding parameters

Hidden parameters

Adding parameters

You can add parameters to a report to define a report’s individual parameters, pass information through a query, or provide access to user settings, such as CRM_CurrencySymbol and

CRM_CurrencyPositivePattern parameters.

The <ReportParameter> is an element in the report definition (RDL) file that is used to describe an individual parameter in the report. The <QueryParameter> contains information about an

individual parameter that is passed to the data source as part of a query. The following XML code taken from the Account Summary report's RDL file demonstrates how to use the

ReportParameter and QueryParameter parameters.

<DataType>String</DataType>

<Value>select * from FilteredAccount</Value>

</Values>

</DefaultValue>

<Prompt>CRM_FilteredAccount</Prompt>

</ReportParameter>

<Query>

<rd:UseGenericDesigner>true</rd:UseGenericDesigner>

<CommandText>declare @sql as nVarchar(max)

set @sql = '

SELECT top 10 CAST(accountid as nvarchar(100)) as AccountID,

name, '''' as None

FROM (' + @FilteredAccount + ') as fa'

exec(@sql)

</CommandText>

<Value>=Parameters!FilteredAccount.Value</Value>

</QueryParameter>

</QueryParameters>

</Query>

The following examples show how to use the QueryParameter and ReportParameter parameters in a Fetch based report:

<DataType>String</DataType>

<Prompt>Filtered Account</Prompt>

<Value>

<all-attributes/>

</entity>

</fetch>

</Value>

</Values>

</DefaultValue>

</ReportParameter>

<Query>

<DataSourceName>DataSource1</DataSourceName>

<fetch>

</entity>

</fetch>

</CommandText>

<Value>=Parameters!FilteredAccount.Value</Value>

</QueryParameter>

</QueryParameters>

<rd:UseGenericDesigner>true</rd:UseGenericDesigner>

</Query>

Hidden parameters

The Report Designer in Microsoft Visual Studio has built-in support for hidden parameters. In addition, you can hide parameters by adding a CRM_ prefix to the parameter name in a Microsoft

Dynamics CRM report. By default, the parameters with a CRM_ prefix are hidden when the report is published through Microsoft Dynamics CRM. When you run the report, you are not prompted to enter parameter values for the hidden parameters.

Special parameters

The following table shows the special hidden parameters that you can use in your reports.

Parameter

CRM_FilterText

CRM_URL

Description

Contains the value of the filter text that a report user interactively creates in the Report Viewer when the user runs a report. The parameter is in a filter summary text box that is located in the report header. The initial value is set to the default filter.

Set to the URL of the Microsoft Dynamics CRM

Web application. Use this parameter when drilling through to Microsoft Dynamics CRM.

CRM_FilteredEntity

Use in a query expression to enable data prefiltering (through Advanced Find).

You must create all parameters in a report before you can refer to them. The values of these special parameters are filled in by Microsoft Dynamics CRM when you run the report.

Additional format parameters

The following table contains additional parameters that you can use in the reports. Among them are parameters that provide access to the user Number settings information. You can use these values to format and display the numeric values. These parameters are similar to values specified in the NumberFormatInfo Class . Use these parameters in custom reports to format the data according to the user settings.

Parameter

CRM_FullName

CRM_UserTimeZone

CRM_UILanguageId

Description

The full name of the user on whose behalf the report is running.

User’s time zone name, for example, Pacific

Standard Time.

Current locale (LCID) of the user.

Parameter

CRM_YearStartWeekCode

CRM_WeekStartDayCode

CRM_FiscalCalendarStart

CRM_FiscalPeriodType

CRM_FiscalYearDisplayCode

CRM_FiscalYearPeriodConnect

CRM_FiscalYearFormat

CRM_FiscalPeriodFormat

CRM_FiscalYearPrefixFormat

CRM_FiscalYearSuffixFormat

CRM_CurrencyDecimalPrecision

CRM_CurrencySymbol

CRM_CurrencyPositivePattern

CRM_CurrencyNegativePattern

CRM_NumberDecimalDigits

CRM_NumberDecimalSeperator

CRM_NumberNegativePattern

CRM_NumberGroupSizes

Description

The first week of the year that is used in

Microsoft Dynamics CRM 2013.

The first day of the week that is used in CRM

2013.

The start date for the fiscal year that is used in

CRM 2013.

Specifies how the fiscal year is divided,

Quarterly, Monthly, Annually and so on.

Specifies whether the fiscal year name is displayed based on when the fiscal year starts or when it ends.

Specifies how the fiscal year and fiscal period are connected when displayed together.

Specifies how the name of the fiscal year will be displayed.

Specifies how the fiscal period will be displayed.

Specifies whether a prefix is attached to the fiscal year when it is displayed.

Specifies whether a suffix is attached to the fiscal year when it is displayed.

The currency decimal precision.

The organization’s currency symbol.

The format pattern for positive currency values.

The format pattern for negative currency values.

The number of decimal places to use in numeric values.

The string that is used as a decimal separator in numeric values.

The format pattern for negative numeric values.

The number of digits in each group to the left of the decimal in numeric values.

Parameter

CRM_NumberGroupSeperator

CRM_DateSeperator

CRM_TimeSeperator

CRM_AMDesignator

CRM_PMDesignator

CRM_ShortDatePattern

CRM_LongDatePattern

CRM_ShortTimePattern

CRM_MonthDayPattern

Description

The string that separates groups of digits to the left of the decimal in numeric values.

The string that separates the components of a date, such as year, month, and day.

The string that separates the components of time, such as hour, minutes, and seconds.

The string that separates the components of time, such as hour, minutes, and seconds

The designator for hours that are "post meridiem" (PM).

The format pattern for a short date value that is associated with the "d" format pattern.

The format pattern for a long date value that is associated with the "D" format pattern.

The format pattern for a short time value that is associated with the "t" format pattern.

The format pattern for month and day values that are associated with the "m" and "M" format patterns.

Working with SQL-based reports (CRM onpremises only)

This section describes how to modify reports that use T-SQL.

In This Section

Modify an existing SQL-based report using SQL Server Data Tools

Use SQL and filtered views to retrieve data for reports

Format report content

Add report navigation

Modify an existing SQL-based report using SQL Server Data

Tools

This topic provides information about modifying your existing Report Definition Language (RDL) file using SQL Server Data Tools. However, make sure that your modified RDL file conforms to the RDL schema and specifications. More information: MSDN: Report Definition XML Elements

In this topic

Work with complex SQL queries

Modify a report (RDL) file

Add elements by using the Report Designer

Test the report

Work with complex SQL queries

While creating or modifying a SQL-based report by using the Report Wizard in SQL Server Data

Tools, some complex SQL queries must be typed into the Generic Query Designer because of

SQL query limitations in Query Builder. Use Query Builder to generate an initial simple SQL query, and then switch to Generic Query Designer to add more complex query logic.

Note

New or existing SQL queries are limited to 260 table joins. In a SQL query, the table join limitation includes your own table joins plus any table joins that are executed within the filtered views that are referred to.

When you add many string concatenations to an SQL query by using Query Designer or Builder,

SQL Server Data Tools takes more time to refresh report items bound to the query's dataset. This results in reduced user productivity when you edit a report. For improved report writing productivity, you can bypass the report item refresh by manually editing the code for the SQL query in the Report Definition Language (RDL) file.

Modify a report (RDL) file

1. Download a report that you want to change. To do this, start the Microsoft Dynamics

CRM web application, go to Sales > Reports and then select the report that you want.

Choose Edit on the command bar, and on the Actions menu, select Download Report.

2. Open SQL Server Data Tools, and create a report server project.

3. In Solution Explorer, right-click the Reports folder, select Add, and then choose Existing

Item. In the file dialog box, select the RDL file you downloaded in the previous step.

4. To view the XML code of the RDL file, in the Solution Explorer pane, right-click the RDL file, and then choose View Code. Make the required changes, and save the file.

Add elements by using the Report Designer

1. Perform steps 1 through 3 as specified in Modify a report (RDL) file .

2. Right-click the RDL file, and then choose View Designer. The report element is displayed on the Design tab.

3. Use the Report Data pane to add datasets, select table fields, define queries, and add parameters to a report.

4. Save the changes. This will add the required XML code for these report elements in the

RDL file.

Test the report

After you finish editing the RDL file, save the changes, and switch back to the report Preview tab in SQL Server Data Tools to test the report. Any XML schema errors or SQL errors will be reported in SQL Server Data Tools.

When the report is ready, Publish reports .

Use SQL and filtered views to retrieve data for reports

Microsoft Dynamics CRM data and metadata are stored in a Microsoft SQL Server database named <organization_name>_MSCRM on the server that is running Microsoft SQL Server in the

Microsoft Dynamics CRM (on-premises) deployment. SQL-based reports in Microsoft Dynamics

CRM use the filtered views provided for each entity to retrieve data for the reports. Filtered views are fully compliant with the Microsoft Dynamics CRM security model. When you run a report that obtains data from filtered views, the Microsoft Dynamics CRM security role determines what data

you can view in the report. Data in filtered views is restricted at these levels: the organization, the business unit, the owner, and at the field level.

Filtered views exist for all Microsoft Dynamics CRM entities, including custom entities. Your custom SQL-based reports cannot read data directly from the Microsoft Dynamics CRM database tables. Instead, you must use the filtered views to retrieve data for your custom SQL-based reports.

The following SQL query returns all columns from the filtered view for the Account entity:

SELECT * FROM dbo.FilteredAccount

Filtered views also provide a way to pull Microsoft Dynamics CRM report data into Microsoft

Office applications, such as Microsoft Office Excel and Microsoft Access. For a complete listing of

all the standard filtered views organized by product area, see Filtered views in Microsoft

Dynamics CRM .

In this topic

Custom and customized entities

Entity schemas for creating custom SQL-based reports

Naming conventions in the Microsoft Dynamics CRM database

Custom and customized entities

When you create a new custom entity in the Microsoft Dynamics CRM database, a new filtered view for the entity is automatically created. Further, if you add or change an attribute in a custom entity or customizable system entity, the change is automatically included in the associated filtered view.

Entity schemas for creating custom SQL-based reports

To find schema information about any filtered view, entity, or attribute in the Microsoft Dynamics

CRM database, use one of the following methods:

 In Microsoft Visual Studio, use SQL Server Object Explorer to connect to the SQL Server where the Microsoft Dynamics CRM organization database is located. Expand the

Databases node and then expand the <organization_name>_MSCRM database. The filtered

views, such as FilteredContact, can be accessed under the Views node. Right-clicking the filtered view displays a shortcut menu that enables you to explore the design of the filtered view and the data it returns.

 Log on to Microsoft Dynamics CRM Web application by using an account that has the

System Administrator security role. In Microsoft Dynamics CRM, choose Settings, and then select Customizations. Next, choose Customize the System, expand Entities, and doubleclick an entity name to view its fields (attributes) and relationships.

 Choose Fields to show all the attributes that include the display name and a description for each attribute. To see the dependencies for the attributes, select an attribute, choose

More Actions, and then select Show Dependencies.

 Choose 1:N Relationships, N:1 Relationships, and N:N Relationships to show the entities that have a relationship with the current entity, and the attributes that are used to define the relationships.

 Use Microsoft SQL Server Management Studio to view the database contents directly.

All the methods that are listed here let you access schema information for custom or customized entities and attributes.

Naming conventions in the Microsoft Dynamics CRM database

The following are the attribute naming conventions in the Microsoft Dynamics CRM database.

Attributes obtained through filtered views

Although field names in Microsoft Dynamics CRM are case-sensitive and in mixed case, the attribute names obtained through filtered views are in lowercase.

Drop-down list attributes

All drop-down lists (option sets) have two associated fields for every string in the list. For each string, there is a value (code) field and a label (name) field, such as, leadsource and

leadsourcename. For example, the filtered view for Leads returns two fields related to the

LeadSource attribute of type Picklist: LeadSource = 1 and LeadSourceName =“Advertisement”.

Reports display the label field and use the value field for numeric comparisons.

DateTime attributes

The DateTime attributes are represented by two fields in the filtered view: DateTime and UTC

DateTime. The first field contains the date and time value for the appropriate time zone and the second field contains the date and time value in Coordinated Universal Time (UTC).

Entity field

For an entity table in the database, the primary key field is in the name format

EntityId

, for example,

AccountId

. Each

EntityId

field has an associated field that contains the value that should be displayed in reports. For example, for the account entity, it is the

Name

field that contains the name of the account.

In this section

Filtered views in Microsoft Dynamics CRM

Improve report performance by using filters

Filtered views in Microsoft Dynamics CRM

This topic lists many of the filtered views available in on-premises Microsoft Dynamics CRM. You can use these filtered views to securely retrieve data for your custom SQL-based reports, and display the reports to a user based on their security role in Microsoft Dynamics CRM.

Entity schema name Ent ity typ e co de

Report view name

1 FilteredAccount

Description

Account Business that represents a customer or potential customer. The company that is billed in business transactions.

AccountLeads

ActivityMimeAttachment

16 FilteredAccountLeads

FilteredActivityMimeAttachmen t

Represents the intersect table for the accountleads_associationrelat ionship.

Multipurpose Internet Mail

Extensions (MIME) attachment for an email activity.

ActivityParty 13

FilteredActivityParty

ActivityPointer 42

FilteredActivityPointer

Person or group associated with an activity. An activity can have multiple activity parties.

Task performed, or to be performed, by a user. An activity is any action for which an entry can be made on a calendar.

This view rolls up all the different activities into one view.

Annotation

AnnualFiscalCalendar

5 FilteredAnnotation Annotation (note) that is attached to one or more objects, including other notes.

20 FilteredAnnualFiscalCalendar Year long fiscal calendar of an

Entity schema name Ent ity typ e co de

Report view name Description

organization. A span of time during which the financial activities of an organization are calculated.

For internal use only. ApplicationFile

Appointment

AsyncOperation

FilteredApplicationFile

FilteredAppointment

FilteredAsyncOperation

Commitment representing a time interval with start/end times and duration.

Process whose execution can proceed independently or in the background.

For internal use only. Attachment

BulkDeleteOperation

BulkOperation

BulkOperationLog

BusinessUnit

FilteredAttachment

FilteredBulkDeleteOperation

FilteredBulkOperation

FilteredBulkOperationLog

10 FilteredBusinessUnit

BusinessUnitNewsArticle 13

Calendar 40

FilteredBusinessUnitNewsArtic le

FilteredCalendar

User-submitted bulk deletion job.

System operation used to perform lengthy and asynchronous operations on large data sets, such as distributing a campaign activity or quick campaign.

Log used to track bulk operation execution, successes, and failures.

Business, division, or department in the Microsoft

Dynamics CRM database.

Announcement associated with an organization.

Calendar used by the scheduling system to define

Entity schema name

CalendarRule

Campaign

CampaignActivity

CampaignActivityItem

CampaignItem

Ent ity typ e co de

Report view name Description

when an appointment or activity is to occur.

For internal use only. 40

FilteredCalendarRule

FilteredCampaign

FilteredCampaignActivity

Container for campaign activities and responses, sales literature, products, and lists to create, plan, execute, and track the results of a specific marketing campaign through its life.

Task performed, or to be performed, by a user for planning or running a campaign.

FilteredCampaignActivityItem Represents the intersect table for the following relationships:



 campaignactivitysalesl iterature_association



 campaignactivitylist_a ssociation

FilteredCampaignItem Represents the intersect table for the following relationships:



 campaignproduct_ass ociation



 campaigncampaign_a ssociation



 campaignsalesliteratu re_association

Entity schema name Ent ity typ e co de

Report view name Description

CampaignResponse

Competitor

FilteredCampaignResponse

FilteredCompetitor

Connection

ConnectionRole

ConnectionRoleAssociatio n

FilteredConnection

FilteredConnectionRole

FilteredConnectionRoleAssoci ation

 campaignlist_association

Response from an existing or a potential new customer for a campaign.

Business competing for the sale represented by a lead or opportunity.

For internal use only. CompetitorAddress

CompetitorProduct

FilteredCompetitorAddress

FilteredCompetitorProduct

CompetitorSalesLiterature 26 FilteredCompetitorSalesLiterat

ConstraintBasedGroup

Contact ure

Represents the intersect table for the competitorproduct_association relationship.

Represents the intersect table for the competitorsalesliterature_asso ciationrelationship.

Relationship between two entities.

Role describing a relationship between a two records.

Represents the intersect table for the connectionroleassociation_as sociation relationship.

FilteredConstraintBasedGroup Group or collection of people, equipment, and/or facilities that can be scheduled.

2 FilteredContact Person with whom a business unit has a relationship, such as customer, supplier, or colleague.

Entity schema name

ContactInvoices

ContactLeads

ContactOrders

ContactQuotes

Contract

ContractDetail

ContractTemplate

CustomerAddress

Ent ity typ e co de

Report view name

17 FilteredContactInvoices

22 FilteredContactLeads

19 FilteredContactOrders

18 FilteredContactQuotes

FilteredContract

FilteredContractDetail

FilteredContractTemplate

FilteredCustomerAddress

CustomerOpportunityRole 45

FilteredCustomerOpportunityR ole

Description

Represents the intersect table for the contactinvoices_association relationship.

Represents the intersect table for the contactleads_associationrelati onship.

Represents the intersect table for the contactorders_associationrelat ionship.

Represents the intersect table for the contactquotes_associationrela tionship.

Agreement to provide customer service during a specified amount of time or number of cases.

Line item in a contract that specifies the type of service a customer is entitled to.

Template for a contract containing the standard attributes of a contract.

Address and shipping information. Used to store additional addresses for an account or contact.

Deprecated. Relationship

between an account or

Entity schema name

CustomerRelationship

Discount

DiscountType

DuplicateRule

Equipment

Fax

FieldSecurityProfile

FixedMonthlyFiscalCalen dar

Goal

Ent ity typ e co de

Report view name

Description

contact and an opportunity.

FilteredCustomerRelationship

Deprecated. Relationship

between a customer and a partner in which either can be an account or contact.

FilteredDiscount Price reduction made from the list price of a product or service based on the quantity purchased.

FilteredDiscountType

FilteredDuplicateRule

Type of discount specified as either a percentage or an amount.

Rule used to identify potential duplicates.

FilteredEmail

FilteredEquipment

FilteredFax

FilteredFieldSecurityProfile

FilteredFixedMonthlyFiscalCal endar

FilteredGoal

Activity that is delivered by using email protocols.

Resource that can be scheduled.

Activity that tracks call outcome and number of pages for a fax and optionally stores an electronic copy of the document.

Profile which defines access level for secured attributes

Fixed monthly fiscal calendar of an organization. A span of time during which the financial activities of an organization are calculated.

Target objective for a user or a team for a specified time

Entity schema name

GoalRollupQuery

Import

ImportFile

ImportLog

ImportMap

Incident

IncidentResolution

IntegrationStatus

InternalAddress

Invoice

InvoiceDetail

KbArticle

KbArticleComment

Ent ity typ e co de

Report view name

FilteredGoalRollupQuery

FilteredImport

FilteredImportFile

FilteredImportLog

FilteredImportMap

FilteredIncident

FilteredIncidentResolution

FilteredIntegrationStatus

FilteredInternalAddress

FilteredInvoice

FilteredInvoiceDetail

FilteredKbArticle

10 FilteredKbArticleComment

Description

period.

Query that is used to filter the results of the goal rollup.

Status and ownership information for an import job.

File name of file used for import.

Failure reason and other detailed information for a record that failed to import.

Data map used in import.

Service request case associated with a contract.

Special type of activity that includes description of the resolution, billing status, and the duration of the case.

For internal use only.

Order that has been billed.

Line item in an invoice containing detailed billing information for a product.

Structured content that is part of the knowledge base.

Comment on a knowledge

Entity schema name

KbArticleTemplate

Lead

LeadAddress

LeadCompetitors

LeadProduct

Letter

List

ListMember

Ent ity typ e co de

Report view name

FilteredKbArticleTemplate

24 FilteredLeadCompetitors

27 FilteredLeadProduct

FilteredLead

FilteredLeadAddress

FilteredLetter

FilteredList

FilteredListMember

Description

base article.

Template for a knowledge base article that contains the standard attributes of an article.

Prospect or potential sales opportunity. Leads are converted into accounts, contacts, or opportunities when they are qualified.

Otherwise, they are deleted or archived.

For internal use only.

Represents the intersect table for the leadcompetitors_associationre lationship.

Represents the intersect table for the leadproduct_associationrelatio nship.

Activity that tracks the delivery of a letter. The activity can contain the electronic copy of the letter.

Group of existing or potential customers created for a marketing campaign or other sales purposes.

Represents the intersect table for the following relationships:

Entity schema name Ent ity typ e co de

Report view name Description

 listaccount_association

 listcontact_association

 listlead_association

MailMergeTemplate

Metric

MonthlyFiscalCalendar

Opportunity

OpportunityClose

FilteredMailMergeTemplate Template for a mail merge document that contains the standard attributes of that document.

FilteredMetric

FilteredMonthlyFiscalCalendar Monthly fiscal calendar of an organization. A span of time during which the financial activities of an organization are calculated.

3 FilteredOpportunity

Type of measurement for a goal, such as money amount or count.

Potential revenue-generating event, or sale to an account, which needs to be tracked through a sales process to completion.

FilteredOpportunityClose Activity that is created automatically when an opportunity is closed, containing information such as the description of the closing and actual revenue.

OpportunityCompetitors 25 FilteredOpportunityCompetitor s

OpportunityProduct 10

FilteredOpportunityProduct

Represents the intersect table for the opportunitycompetitors_associ ationrelationship.

Association between an opportunity and a product.

Entity schema name

OrderClose

Organization

PhoneCall

PluginAssembly

PluginType

PluginTypeStatistic

PriceLevel

Privilege

Ent ity typ e co de

Report view name

FilteredOrderClose

FilteredOrganization

FilteredPhoneCall

FilteredPluginAssembly

FilteredPluginType

FilteredPluginTypeStatistic

FilteredPriceLevel

FilteredPrivilege

Description

Activity generated automatically when an order is closed.

Top level of the Microsoft

Dynamics CRM business hierarchy. The organization can be a specific business, holding company, or corporation.

This view contains the format that is used in Microsoft

Dynamics CRM for currency, date and time format, number format, negative number handling, pricing decimal precision, and start day of the week. It also defines the fiscal period for the organization.

Activity to track a telephone call.

Assembly that contains one or more plug-in types.

Type that inherits from the

IPlugin interface and is

contained within a plug-in assembly.

Plug-in type statistic.

Entity that defines pricing levels.

Permission to perform an action in Microsoft Dynamics

CRM. Microsoft Dynamics

Entity schema name

ProcessSession

Product

ProductAssociation

ProductPriceLevel

ProductSalesLiterature

ProductSubstitute

Publisher

PublisherAddress

Ent ity typ e co de

Report view name Description

FilteredProcessSession

FilteredProduct

FilteredProductAssociation

FilteredProductPriceLevel

CRM checks for the privilege and rejects the attempt if the user does not hold the privilege.

Information that is generated when a dialog is run. Every time that you run a dialog, a dialog session is created.

Information about products and their pricing information.

Represents the intersect table for the productassociation_associatio nrelationship.

Information about how to price a product in the specified price level, including pricing method, rounding option, and discount type based on a specified product unit.

21 FilteredProductSalesLiterature Represents the intersect table for the productsalesliterature_associa tionrelationship.

FilteredProductSubstitute

FilteredPublisher

Represents the intersect table for the productsubstitute_associationr elationship.

A publisher of a Microsoft

Dynamics CRM solution.

FilteredPublisherAddress Address and shipping information. Used to store additional addresses for a

Entity schema name Ent ity typ e co de

Report view name Description

QuarterlyFiscalCalendar

Queue

QueueItem

Quote

QuoteClose

QuoteDetail

RecurringAppointmentMa ster

RelationshipRole

RelationshipRoleMap

FilteredQuarterlyFiscalCalend ar

FilteredQueue

FilteredQueueItem

FilteredQuote publisher.

Quarterly fiscal calendar of an organization. A span of time during which the financial activities of an organization are calculated.

A list of records requiring action, such as accounts, cases, and activities.

A specific item in a queue, such as a case record or an activity record.

Formal offer for products and/or services, proposed at specific prices and related payment terms, which is sent to a prospective customer.

FilteredQuoteClose

FilteredQuoteDetail

Activity generated when a quote is closed.

Product line item in a quote.

The details include such information as product ID, description, quantity, and cost.

The master appointment of a recurring appointment series.

FilteredRecurringAppointment

Master

FilteredRelationshipRole

Deprecated. Relationship

between an account or contact and an opportunity.

FilteredRelationshipRoleMap

Deprecated. Mapping of the

primary associated objects between which the relationship role is valid.

Entity schema name

Report

ReportCategory

ReportEntity

ReportLink

ReportVisibility

Resource

ResourceGroup

ResourceSpec

RibbonCommand

RibbonContextGroup

Ent ity typ e co de

Report view name

FilteredReport

FilteredReportCategory

Description

Data summary in an easy-toread layout.

Categories related to a report.

A report can be related to multiple categories.

FilteredReportEntity

FilteredReportLink

FilteredReportVisibility

FilteredResource

FilteredResourceGroup

FilteredResourceSpec

Entities related to a report. A report can be related to multiple entities.

Links and dependencies between reports. A report may drill through to another report, or it may have another report as a sub-report.

Area in which to show a report. A report can be shown in multiple areas.

User or facility/equipment that can be scheduled for a service.

Resource group or team whose members can be scheduled for a service.

Selection rule that allows the scheduling engine to select a number of resources from a pool of resources. The rules can be associated with a service.

For internal use only. 11

FilteredRibbonCommand

FilteredRibbonContextGroup For internal use only.

Entity schema name

RibbonDiff

RibbonRule

RibbonTabToCommandM ap

Role

RollupField

SalesLiterature

SalesLiteratureItem

SalesOrder

SalesOrderDetail

SalesProcessInstance

SavedQuery

SdkMessage

Ent ity typ e co de

Report view name

FilteredRibbonDiff

FilteredRibbonRule

FilteredRibbonTabToComman dMap

FilteredRole

FilteredRollupFieldItem

FilteredSalesLiterature

FilteredSalesLiteratureItem

FilteredSalesOrder

FilteredSalesOrderDetail

Description

For internal use only.

Grouping of security privileges. Users are assigned roles that authorize their access to Microsoft Dynamics

CRM.

Field to be rolled up to calculate the actual and inprogress values against the goal.

Storage of sales literature, which may contain one or more documents.

Item in the sales literature collection.

Quote that has been accepted.

Line item in a sales order.

32 FilteredSalesProcessInstance For internal use only.

FilteredSavedQuery Saved query against the database.

FilteredSdkMessage Message that is supported by the Microsoft

Dynamics CRM SDK.

Entity schema name

SdkMessageFilter

Service

ServiceAppointment

Ent ity typ e co de

Report view name

FilteredSdkMessageFilter

FilteredService

FilteredServiceAppointment

Description

Filter that defines which

Microsoft

Dynamics CRM SDK messages are valid for each type of entity.

For internal use only. SdkMessagePair

SdkMessageProcessingSt ep

SdkMessageProcessingSt epImage

SdkMessageProcessingSt epSecureConfig

SdkMessageRequest

SdkMessageRequestField 46

SdkMessageResponse 46

SdkMessageResponseFie ld

SemiAnnualFiscalCalend ar

FilteredSdkMessagePair

FilteredSdkMessageProcessin gStep

FilteredSdkMessageRequestFi eld

For internal use only.

FilteredSdkMessageResponse For internal use only.

FilteredSdkMessageResponse

Field

FilteredSemiAnnualFiscalCale ndar

Stage in the execution pipeline that a plug-in is to execute.

FilteredSdkMessageProcessin gStepImages

FilteredSdkMessageProcessin gStepSecureConfig

For internal use only.

FilteredSdkMessageRequest For internal use only.

For internal use only.

Calendar representing the semi-annual span of time during which the financial activities of an organization are calculated.

Activity that represents work done to satisfy a customer's need.

Activity offered by the

Entity schema name Ent ity typ e co de

Report view name

ServiceContractContacts 20 FilteredServiceContractContac ts

ServiceEndpoint

SharePointDocumentLoca tion

SharePointSite

Site

Solution

SolutionComponent

StatusMap

FilteredServiceEndpoint

FilteredSharePointDocumentL ocation

FilteredSharePointSite

FilteredSite

FilteredSolution

FilteredSolutionComponent

FilteredStatusMap

Description

organization to satisfy its customer's needs. Each service activity includes date, time, duration, and required resources.

Represents the intersect table for the servicecontractcontacts_asso ciationrelationship.

Service endpoint that can be contacted.

Document libraries or folders on a computer that is running

SharePoint Server from where documents can be managed in Microsoft Dynamics CRM.

SharePoint Server site from where documents can be managed in Microsoft

Dynamics CRM.

Location or branch office where an organization does business. An organization can have multiple sites.

A solution that contains

Microsoft Dynamics CRM customizations.

A component of a Microsoft

Dynamics CRM solution.

Contains valid status reasons, and the default status reason.

Only certain status reasons are valid for each status value.

Entity schema name

StringMap

Subject

SystemForm

SystemUser

SystemUserProfiles

SystemUserRoles

Task

Team

Ent ity typ e co de

Report view name

FilteredStringMap

FilteredSubject

FilteredSystemForm

FilteredSystemUser

FilteredSystemUserProfiles

15 FilteredSystemUserRoles

FilteredTask

9 FilteredTeam

Description

Contains valid numeric values for items in a drop-down list, equivalent labels for those values, and the display order for items in the list.

Information regarding subjects available in Microsoft

Dynamics CRM.

Organization-owned entity customizations, including form layout and dashboards.

Person with access to

Microsoft Dynamics CRM and who can own records.

Represents the intersect table for the systemuserprofiles_associatio nrelationship.

Represents the intersect table for the systemuserroles_associationr elationship.

Generic activity representing work to be done.

Collection of system users that routinely collaborate.

Teams can be used to simplify record sharing and provide team members with common access to organization data when team members belong to different business units.

Entity schema name

TeamMembership

TeamProfiles

TeamRoles

Template

Territory

TransactionCurrency

UnresolvedAddress

UoM

UoMSchedule

UserFiscalCalendar

UserQuery

UserSettings

Ent ity typ e co de

Report view name

23 FilteredTeamMembership

FilteredTeamProfiles

FilteredUoMSchedule

Description

Represents the intersect table for the teammembership_association relationship.

Represents the intersect table for the teamprofiles_associationrelati onship.

40 FilteredTeamRoles

FilteredTemplate

Represents the intersect table for the teamroles_associationrelation ship.

Template for an email message that contains the standard attributes of an email message.

FilteredTerritory Territory represents sales regions.

FilteredTransactionCurrency Currency in which a financial transaction is carried out.

FilteredUnresolvedAddress For internal use only.

FilteredUoM Unit of measure.

Grouping of units.

FilteredUserFiscalCalendar

FilteredUserQuery

15 FilteredUserSettings

Custom fiscal calendar used for tracking sales quotas.

Saved database query that is owned by a user.

User's preferred settings.

Entity schema name

WebResource

Workflow

WorkflowDependency

WorkflowLog

Ent ity typ e co de

Report view name

FilteredWebResource

Description

FilteredWorkflow

Data equivalent to files used in Web development. Web resources provide client-side components that are used to provide custom user interface elements.

Set of logical rules that define the steps necessary to automate a specific business process, task, or set of actions to be performed.

FilteredWorkflowDependency

Deprecated. Dependencies

for a process.

FilteredWorkflowLog Log used to track process execution.

Test and troubleshoot reports

After you have created a report, test it to see if it produces the results that you want.

Test a report

1. Test the report in Microsoft Visual Studio within the Preview tab.

2. If any errors are reported, correct the cause of the errors, and run the test again.

3. When the report functions correctly, publish the report to the report server. To do this, in

Microsoft Dynamics CRM choose Sales > Reports. Select New and then fill out the requested information.

4. Run the published report from Microsoft Dynamics CRM to verify the report's operation.

Suggestions for testing a report

The following list of suggestions is provided as a guide for testing your reports:

 SQL-based reports only: Verify that your reports access Microsoft Dynamics CRM data only through filtered views to follow Microsoft Dynamics CRM security restrictions.

 SQL-based reports only: Check the number of SQL table joins. Reports might not run if there are too many table joins. After uploading your report, open the pre-filter section of your report and add some related entities, for example, accounts that have associated opportunities. Run the report with the related entities. If you have a max SQL joins error on execution, you may want to either simplify the report or remove some Advanced Find filterable entities.

 Verify that report filters are specified for the correct entities. After uploading the report, open the report and check whether any entities aliased for Advanced Find filtering should be exposed for report pre-filtering.

 If the report is querying a custom entity, validate that the entity can be correctly filtered.

Validate that the report returns data based on user roles with user-level security on entities, custom security roles, and other roles.

 Some reports are published as context-sensitive reports. Therefore, they can be run against selected records in a grid. For those types of reports, verify that the report can be run against system views, custom system views, user queries, and selected records.

 Verify that snapshots of the report can be taken through the Scheduling Wizard in the

Microsoft Dynamics CRM Web application.

 Verify that you can save the report to a PDF file. Reports frequently print better with PDF formatting.

 Verify that detailed sub-reports are hidden when you publish the report, so they are not executed directly by users.

Report drill-through fails in Visual Studio Report Viewer

Some parameters in the reports that are generated by the Report Wizard are marked internal

(read-only). Therefore, when you upload the reports into Visual Studio, and try to drill through, the

Visual Studio Report Viewer does not display the reports. To correct this, use Visual Studio

Report Designer to change the parameters from internal to hidden. Clear the Internal check box, and make sure that the Hidden check box is checked for each of the following parameters:

 CRM_Drillthrough

 CRM_DrillthroughFilterBy

 CRM_FilterText

 CRM_URL

The parameters that are prefixed with CRM_Filtered, such as CRM_FilteredAccount or

CRM_FilteredContact, also have to be marked as hidden and not internal.

Note

Your report may not contain all the parameters listed here.

Publish reports

To make reports available to users, you publish the report in Microsoft Dynamics CRM.

Publish a report in Microsoft Dynamics CRM by using the web application

1. Create a new report or modify a report by using SQL Server Data Tools. More

information: Create a new report using SQL Server Data Tools

2. Sign in to Microsoft Dynamics CRM, and select Sales > Reports.

3. On the command bar, select New.

4. In the Report:New Report dialog box, in the Report Type list, select Existing File, select Browse, and then specify the location of the .rdl file in the File Location box.

5. Specify appropriate data in the Details section of the Report:New Report dialog box.

6. Select Save and Close.

You can test the report by selecting it from the Available Reports list. To add the report to context-sensitive lists and forms in Microsoft Dynamics CRM follow the steps in

Determine where the report will appear .

Tip

To update the report or to update the information that is displayed in Microsoft

Dynamics CRM, such as the description, in the Available Reports list select the report and then select Edit on the command bar.

Determine where the report will appear

1. Select the report in the Reports view, and select Edit on the command bar.

2. In the Report dialog box, specify values in the Categorization section according to the

following descriptions:

 Categories: Categorizes the report according to its intended purpose. For example, a sales report can be included in context-sensitive lists and forms in the Sales area of

Microsoft Dynamics CRM.

 Related Record Types: Associates the report to specific entities, such as accounts or contacts.

 Display In: Enables the report to be displayed in context-sensitive forms and lists.

You can restrict where the report is displayed. If you intend to publish a hidden report, clear the Display In box.

3. Select Save and Close.

By default, a report is uploaded as a user-owned report. To make the report visible to the whole organization, you can do either of the following when editing a report:

 In the Report dialog box, select the Administration tab, and then in the Viewable By field, select Individual.

 In the Report dialog box, on the Actions menu, select Publish Report for External Use.

Specify a default filter for the report

You can define a default filter for a report so that the filter criteria are used every time the report is run.

1. Select a report in the Reports grid, and on the More Actions (…) menu, select Edit Default

Filter.

2. In the Report Viewer dialog box, define the default filter criteria that will be used every time the report runs, and select Save Default Filter.

In This Section

Best practices for reports

Improve performance of reports

Improve report performance by using filters

Microsoft Dynamics CRM Online reporting considerations

RDL sandboxing for Microsoft Dynamics CRM Online

Best practices for reports

The following best practices can help you to produce reports that are easier to write, comply with established standards, and execute with improved efficiency.

General best practices

This section provides best practices for creating custom Fetch-based and SQL-based reports.

Use an existing report to create custom reports

Check whether there is an existing report in Microsoft Dynamics CRM that is close to the design that you are looking for. Download the report definition of the report, and then modify the RDL file instead of creating a new one from scratch. By doing this, you will save development time and reduce report writing errors.

Use Microsoft Dynamics CRM formats for currency, number, date and time, calendar

The FilteredUserSettings view contains information about currency format, date and time format, number format, negative number, starting day of the week, calendars, and other formats.

Microsoft Dynamics CRM provides the fn_GetFormatStrings database function to obtain the date, time, number, currency, and calendar formats from the FilteredUserSettings view.

Use these resources to correctly format data values in your reports.

Set the page size

Reporting Services does not provide explicit page orientation, such as portrait and landscape modes, or preset page sizes. Standard Microsoft Dynamics CRM reports were designed for 8.25 x 11 (portrait) or 11 x 8.25 (landscape) page sizes that work for both US letter and A4 paper.

Back up your reports

Make backup copies of your reports and store them on a computer other than the reporting server.

Define truncation if needed

Text wrapping is the default behavior for a text box report item in Reporting Services. This means that, unless indicated otherwise, all text will wrap at the defined width of any text area and then grow vertically. If truncation is specified, a text box will truncate text at the width of the text box within the specified padding (default is 2pt left and right.) Any maximum length truncation beyond this will require custom coding.

The default Microsoft Dynamics CRM reports are set up with tool tips to show static text or values from data fields when the user hovers the mouse pointer over the report item. If you use

truncation, consider setting the ToolTip property to the field value so that the full text will appear when the user hovers over the truncated text.

Best practices when you create reports that include date and time fields

When you create reports that use date and time fields, be aware of the following:

 To be consistent with the date and time values in Microsoft Dynamics CRM, when you create reports that use a Coordinated Universal Time (UTC) based field (Time-Zone Independent or

Date Only) don’t convert the value to a regional time-zone based (User Local) value.

 If you make a change to the date and time behavior of a field in an entity, you may need to regenerate reports that use that date and time for the report to display the field correctly.

 Regenerate Report Wizard reports. Edit the report using the Report Wizard with the same parameters to regenerate the report.

 Regenerate reports based on a managed solution. For managed solutions, instead of editing the report, re-import the solution to regenerate the report.

 Regenerate custom reports created with Microsoft Visual Studio. Update the date and time fields in Visual Studio as necessary and republish the report. More information:

Modify an existing SQL-based report using SQL Server Data Tools

For more information about date and time fields, see Behavior of Date and Time data type.

SQL-based reports

This section provided best practices for SQL-based reports only.

Writing stored procedures

Adding custom stored procedures to the Microsoft Dynamics CRM database is not supported.

However, you can create a separate database and write stored procedures to that database.

Limit text length and number of items in charts

Microsoft Dynamics CRM reports use only some of the possible chart types from Reporting

Services. For any chart type, limiting label length and number of items is recommended for the chart contents to be displayed correctly. When Reporting Services displays a chart with long labels, the chart itself becomes too small to be usable. There are several ways to do this:

 Limit your chart label length explicitly, truncating it if it is necessary.

 Consider limiting the number of items displayed in charts. For more information, see

Sample:

Limit the number of items displayed in a chart .

Use embedded images in a report

The easiest way to use images with Reporting Services is to put the images into a database. If the images are not in a database, you can use embedded images in .png, .gif, or .jpg formats in a report. The image files that are used by Microsoft Dynamics CRM image files are located in the

C:/Inetpub/wwwroot/_imgs/ico folder on a default Microsoft Dynamics CRM installation.

General

These guidelines are applicable for both Fetch-based and SQL-based reports.

 Limit a report to display information from a specified time period, instead of displaying all records in the Microsoft Dynamics CRM database.

 Pre-filter a report so that the dataset is limited.

 Calculate aggregate totals by using aggregations in a FetchXML query or a SQL statement, instead of passing raw data to Reporting Services and grouping.

 Limit the number of datasets used, if possible.

 When you compare dates, use the UTC date fields for comparisons. For example, compare the createdonutc fields and not the createdon fields in the FetchXML query or a filtered view.

SQL-based Reports

These guidelines are applicable for SQL-based reports only.

 Don’t create a report that uses a large dataset or a complex SQL query available on-demand to all users.

 Don’t select all columns from a Microsoft Dynamics CRM filtered view. Instead, explicitly specify the columns that you want to select in the SQL statement.

 Use SQL stored procedures instead of inline SQL.

Important

Currently, report queries with hierarchical operators, such as the Under operator, cannot be used with report filtering. When you try to run a report that uses a hierarchical operator, the report will not render.

In this topic

Enabling data pre-filtering in Fetch-based reports

Enabling data pre-filtering in SQL-based reports (CRM on-premises only)

Passing filters in the filter summary

Default filters

Enabling data pre-filtering in Fetch-based reports

Fetch-based reports support only automatic data pre-filtering. A report can have multiple data sets and multiple FetchXML queries. One data set supports one FetchXML query. To enable prefiltering for the primary or linked entity in a Fetch-based report, you must set the value of the

enableprefiltering parameter to “1”, and specify a parameter name in the

prefilterparametername property. The parameter name should start with “CRM_” to specify it as

a hidden parameter. As with the Microsoft SQL Server-based report, this parameter specified in the FetchXML query acts as a sub query within the FetchXML query, and the sub query is constructed with the value specified by the user in the Advanced Find area while running a report.

The following example displays how to enable pre-filtering for the primary entity in the FetchXML query:

<CommandText

</entity>

</fetch>

</CommandText>

Similarly, you can enable pre-filtering for the linked entity. You can also specify a different prefiltering condition for the linked entity in the FetchXML query by specify a different and unique name for the parameter name in the prefilterparametername property.

If you are manually modifying a Fetch-based report definition without using the Report Wizard in the Microsoft Dynamics CRM Web application or SQL Server Data Tools to enable pre-filtering for primary and linked entities, make sure that you:

1. Set the value of the enableprefiltering

parameter to 1 for the required entity or linked entity, and specify a unique parameter name for the prefilterparametername property.

2. Create a corresponding query parameter with the same name as specified for the

prefilterparametername property. Make sure that the parameter name starts with

CRM_

to specify it as a hidden parameter.

<Value>=Parameters!CRM_FilteredAccount.Value</Value>

</QueryParameter>

3. Create a corresponding report parameter with the same name.

<DataType>String</DataType>

<Prompt>CRM Filtered Account</Prompt>

</ReportParameter>

</ReportParameters>

Enabling data pre-filtering in SQL-based reports (CRM on-premises only)

There are two ways that you can enable data pre-filtering on Microsoft Dynamics CRM SQLbased reports: automatic and explicit.

Automatic pre-filtering

Automatic data pre-filtering is suited for simple queries. To enable automatic data pre-filtering on a report, you can use aliases for entity tables in queries. You do this by using an alias name that starts with

CRMAF_

For example, the following table shows a simple query modified to enable pre-filtering on the

Account entity.

Query without pre-filtering Modified query with automatic pre-filtering enabled

SELECT <column1>, <column2>, <columnN> SELECT <column1>, <column2>, <columnN>

Query without pre-filtering

FROM FilteredAccount;

Modified query with automatic pre-filtering enabled

FROM FilteredAccount AS

CRMAF_FilteredAccount;

When you enable automatic data pre-filtering functionality by using the

CRMAF_

prefix, Microsoft

Dynamics CRM modifies the query to include a parameter (for example, P1) when it is uploaded to Microsoft Dynamics CRM, as shown in the following table.

Query with automatic pre-filtering Modified by Microsoft Dynamics CRM

SELECT <column1>, <column2>, <columnN>

FROM FilteredAccount AS

CRMAF_FilteredAccount;

SELECT <column1>, <column2>, <columnN>

FROM (@P1) AS CRMAF_FilteredAccount;

Microsoft Dynamics CRM will pass a query to the P1 parameter depending on how the report is being filtered. In other words, automatic data pre-filtering acts as a sub-query within the existing query.

The following examples illustrate how Microsoft Dynamics CRM passes queries to the parameter

(P1) as per different filtering requirements. In these examples, it is assumed that you are running the report from the Reports area in Microsoft Dynamics CRM, and are using the data filtering option.

Example 1: If you want to view only active accounts, the resulting query would be as follows:

SELECT <column1>, <column2>, <columnN>

FROM (SELECT FilteredAccount.* FROM FilteredAccount WHERE statecode = 0)

AS CRMAF_FilteredAccount

Example 2: If you are within a specific account and run the report, the resulting query would be

as follows:

SELECT <column1>, <column2>, <columnN>

FROM (SELECT FilteredAccount.* FROM FilteredAccount WHERE AccountId =

'<CurrentAccountId>')

AS CRMAF_FilteredAccount

Example 3: If you are looking at a list of three selected accounts and you choose the option to

run the report against the selected records, the resulting query would be as follows:

SELECT <column1>, <column2>, <columnN>

FROM (SELECT FilteredAccount.* FROM FilteredAccount WHERE AccountId in

('<1stAccountId>', '<2ndAccountId>', '<3rdAccountId>')

AS CRMAF_FilteredAccount

When any entity table names are aliased, the Advanced Find user interface is automatically included in the deployed report when it is run from Microsoft Dynamics CRM.

To alias an entity table name in Query Builder, right-click each table in your report, choose

Properties, and then enter the alias value in the form CRMAF_FilteredEntity, for example,

CRMAF_FilteredAccount.

Limitation of Automatic Pre-filtering

When you use the

CRMAF_

prefix to enable automatic pre-filtering, Microsoft Dynamics CRM adds a parameter in the query. With a more complex query, such as a query that uses UNION statements, this can lead to unexpected results because Microsoft Dynamics CRM might only add the parameter to the first query.

For example, consider the following query containing UNION statements:

SELECT <column1>, <column2>, <columnN>

FROM FilteredAccount AS CRMAF_FilteredAccount

WHERE address1_stateorprovince = ‘FL'

UNION

SELECT <column1>, <column2>, <columnN>

FROM FilteredAccount AS CRMAF_FilteredAccount

WHERE address1_stateorprovince = 'CA'

When you upload the report, Microsoft Dynamics CRM may filter only the first query using the parameter. This leads to the filtering not being applied to the second query:

SELECT <column1>, <column2>, <columnN>

FROM (@P1) AS CRMAF_FilteredAccount WHERE address1_stateorprovince = 'FL'

UNION

SELECT <column1>, <column2>, <columnN>

FROM FilteredAccount AS CRMAF_FilteredAccount

WHERE address1_stateorprovince = 'CA'

In the above example, while running the report from the Reports area in Microsoft Dynamics

CRM and choosing the filter as annual revenue greater than 1,000,000, Microsoft Dynamics CRM will pass a query to the P1 parameter as follows:

SELECT <column1>, <column2>, <columnN>

FROM (SELECT FilteredAccount.* from FilteredAccount where AnnualRevenue > 1000000) AS

CRMAF_FilteredAccount

WHERE address1_stateorprovince = 'FL'

UNION

SELECT <column1>, <column2>, <columnN>

FROM FilteredAccount AS CRMAF_FilteredAccount

WHERE address1_stateorprovince = 'CA'

This implies that the query would return only those accounts in Florida with an annual revenue greater than $1,000,000 and all the accounts in California, which is not what you intended. You wanted to view all the accounts in Florida and California with annual revenue greater than

$1,000,000.

If you download the report from Microsoft Dynamics CRM and open it in Microsoft Visual Studio, you will see the original version of the report that you uploaded into Microsoft Dynamics CRM. If you download the report directly from Microsoft SQL Server Reporting Services, you will notice that Microsoft Dynamics CRM had modified the query but did not place the parameter where you wanted it to exist.

For complex queries like this, you must use explicit pre-filtering.

Explicit pre-filtering

For complex queries such as queries using UNION statements, you may need to use explicit prefiltering. Unlike automatic pre-filtering, Microsoft Dynamics CRM does not rewrite the report query by passing values to the parameters during explicit pre-filtering when such a report is uploaded to

Microsoft Dynamics CRM. You must explicitly make the required changes to the report by adding the pre-filtering parameter to the report, and then referencing the parameter in the query. You can then execute the query by using dynamic SQL.

When you use dynamic SQL, filtering through Advanced Find is enabled by creating a hidden parameter named CRM_FilteredEntity, for example, CRM_FilteredAccount, and by using this parameter in a dynamic SQL query expression. This parameter enables filtering on the table data obtained from the specified filtered view.

Taking the same example as discussed earlier to highlight the limitation of automatic pre-filtering, the following table shows a query with automatic pre-filtering modified to use explicit pre-filtering by using dynamic SQL. It is also assumed that while running the report from the Reports area in

Microsoft Dynamics CRM, the filter has been applied as annual revenue greater than 1,000,000.

Query with automatic pre-filtering Query modified to use explicit pre-filtering

SELECT <column1>, <column2>, <columnN>

FROM FilteredAccount AS

CRMAF_FilteredAccount

WHERE address1_stateorprovince = ‘FL'

UNION

SELECT <column1>, <column2>, <columnN>

FROM FilteredAccount AS

CRMAF_FilteredAccount

WHERE address1_stateorprovince = 'CA'

DECLARE @SQL nvarchar(4000)

DECLARE @CRM_FilteredAccount nvarchar(2000)

Set @CRM_FilteredAccount = 'Select

FilteredAccount.* FROM FilteredAccount where

AnnualRevenue > 1000000'

SET @SQL = 'SELECT <column1>, <column2>,

FROM ('+@CRM_FilteredAccount+') AS FA where address1_stateorprovince = ''FL''

UNION

Query with automatic pre-filtering Query modified to use explicit pre-filtering

SELECT <column1>, <column2>, <columnN>

FROM ('+@CRM_FilteredAccount+') as CA where address1_stateorprovince = ''CA'' '

EXEC (@SQL)

Note

Most of the standard Microsoft Dynamics CRM SQL-based reports use the explicit prefiltering option.

Passing filters in the filter summary

A filter summary displays the value of the filter that is used when a report is run. In Microsoft

Dynamics CRM reports, it is displayed as a text box report item in the report header that contains the filter text value. When the user runs the report, the Report Viewer displays an Edit Filter button. When the button is clicked, it enables the user to define a data filter. An example of a filter summary can be found in the User Summary report that is included with Microsoft Dynamics

CRM.

To add a filter summary to a report, follow these steps:

1. Create a hidden string parameter called CRM_FilterText.

2. Add a text box report item to the report and set its Value property as follows:

=Parameters!CRM_FilterText.Value.

When the report is run, the value of the CRM_FilterText parameter will be set by the system to the text of the current filter.

Default filters

When you publish a report, you can set a default filter. For all the reports that were created by using the report wizard, if you do not set a default filter, the filter is automatically set to all records of the entity modified within the last 30 days. For the procedure to define a default report filter,

see Publish reports .

In this topic

Tips and solutions for reporting

Third-party Microsoft Dynamics CRM adapters for SSIS

ETL tools

Tips and solutions for reporting

Typically, for most organization’s reporting needs, these settings are adequate. To make sure that your users do not exceed these settings and to improve report querying performance in general, consider the following best practices.

 When you create custom reports or dashboards, design them to query smaller datasets over shorter periods of time by adding a time-based filter in the report to limit the results, such as the current month or quarter.

 We recommend that you limit the number of entities that are needed to return the result. This helps reduce the time required to run the query and return the result set.

 We recommend that you reduce the number of records shown in detailed reports. Suitable filtering can be used to reduce the number of records returned by the query to reduce timeouts.

 For aggregated or summarized reports, queries must be used to push the aggregation to the database and not fetch detailed records and perform aggregation in the Microsoft SQL Server

Reporting Services report.

 When appropriate for your business, users should run the default (out-of-box) reports and dashboards. These reports and dashboards are typically designed to query per user datasets, so in most cases will not exceed the dataset limit.

If CRM Online users must run reports that exceed these settings, we recommend that you review the following options for assistance with complex reporting needs. Both options effectively offload reporting workloads from CRM Online to another SQL Server datastore by using a CRM data integration solution.



Third-party Microsoft Dynamics CRM adapters for SSIS are used in conjunction with SQL

Server Integration Services (SSIS) to extend the capabilities for integration with CRM Online data.

 Extract transform load

ETL tools provide a new tool set for creating analysis of CRM Online

data by combining multiple data sources or extracting data to the data warehouse solution if

SSIS is not in use. ETL tools provide comprehensive solutions for connecting CRM systems to move data.

Important

Notice that when you use these tools, we recommend that you move or synchronize data during nonbusiness hours.

If needed, there are many Microsoft Dynamics Partners who can help provide a solution for your specific reporting needs such as creating an offline copy of the data specifically used for running large reports. These Partners are knowledgeable with the CRM data integration tools available.

More information: Find the right partner

Third-party Microsoft Dynamics CRM adapters for SSIS



CozyRoc SSIS+ component for Microsoft Dynamics CRM



KingswaySoft SSIS Integration Toolkit for Microsoft Dynamics CRM



RSSBus SSIS task for Microsoft Dynamics CRM



Team4 SSIS Connector for Microsoft CRM



PragmaticWorks TaskFactory SSIS Source/Destination for Dynamics CRM

ETL tools



Scribe Insight and Scribe Online with adapter for Microsoft Dynamics CRM



Productivity tools from Informatica

RDL sandboxing for Microsoft Dynamics CRM Online

In Microsoft Dynamics CRM Online, the reports run in the sandbox mode. This is done by enabling Report Definition Language (RDL) Sandboxing in Microsoft SQL Server Reporting

Services. The RDL Sandboxing lets you detect and restrict the usage of specific types of resources. As a result, certain features in Microsoft Dynamics CRM Online may not be available.

For more information, see MSDN: Enabling and Disabling RDL Sandboxing .

The current RDL Sandboxing configuration settings in Microsoft Dynamics CRM Online are described in the following sections in this topic.

In this topic

Limits of the array result length and string result length

Allowed types and denied members

Common denied members

Limits of the array result length and string result length

The maximum number of items allowed in an array return value for an RDL expression is increased from 250 to 102400. The maximum number of items allowed in a string return value for an RDL expression is also increased from 250 to 102400. This enables you to include images and logos with sizes up to 75 KB, which will be stored in a database with Base64 encoding.

Allowed types and denied members

The RDL Sandboxing feature enables you to create a list of approved types and a list of denied members. The list of approved types is called an allow list. The list of denied members that are not permitted in the RDL expressions is called a block list.

The following table contains a list of allowed types and denied members available in sandbox mode in Microsoft Dynamics CRM Online.

Allowed Types

System.Array

Denied Members

CreateInstance

Allowed Types

System.DateTime

System.Object

System.DbNull

System.Math

System.String

System.TimeSpan

Denied Members

Finalize

GetType

MemberwiseClone

Resize

FromBinary

GetDateTimeFormats

GreaterThan

GreaterThanOrEqual

GetType

MemberwiseClone

ReferenceEquals

Finalize

MemberwiseClone

GetObjectData

GetTypeCode

BigMul

DivRem

IEEERemainder

Pow

Hours

Allowed Types

System.Convert

System.StringComparer

System.TimeZone

Denied Members

TicksPerDay

TicksPerHour

TicksPerMillisecond

TicksPerMinute

TicksPerSecond

Zero

TryParse

TryParseExact

ChangeType

IConvertible.ToBoolean

IConvertible.ToByte

IConvertible.ToChar

IConvertible.ToDateTime

IConvertible.ToDecimal

IConvertible.ToDouble

IConvertible.ToInt16

IConvertible.ToInt32

IConvertible.ToInt64

IConvertible.ToSByte

IConvertible.ToSingle

IConvertible.ToType

IConvertible.ToUInt16

IConvertible.ToUInt32

IConvertible.ToUInt64

Create

Finalize

Allowed Types

System.Uri

System.UriBuilder

System.Globalization.CultureInfo

System.Text.RegularExpressions.Match

System.Text.RegularExpressions.Regex

Denied Members

GetType

MemberwiseClone

Unescape

Parse

Escape

Finalize

ClearCachedData

Empty

NextMatch

Result

Synchronized

CacheSize

CompileToAssembly

GetGroupNames

GetGroupNumbers

GetHashCode

Unescape

UseOptionC

UseOptionR capnames caps

Allowed Types

Microsoft.VisualBasic.Constants

Denied Members

capsize capslist roptions pattern factory

IsMatch

Matches

Iserializable.GetObjectData

InitializeReferences

RightToLeft

Options vbAbort vbAbortRetryIgnore vbApplicationModal vbArchive vbBinaryCompare vbCancel vbCritical vbDefaultButton1 vbDefaultButton2 vbDefaultButton3 vbExclamation vbFormFeed vbGet vbHidden vbHide

Allowed Types Denied Members

vbHiragana vbIgnore vbInformation vbKatakana vbLet vbLinguisticCasing vbMaximizedFocus vbMinimizedFocus vbMinimizedNoFocus vbMsgBoxHelp vbMsgBoxRight vbMsgBoxRtlReading vbMsgBoxSetForeground vbNo vbNormal vbNormalFocus vbNormalNoFocus vbObjectError vbOK vbOKCancel vbOKOnly vbQuestion vbReadOnly vbRetry vbRetryCancel vbSet vbSystem vbSystemModal

Allowed Types

Microsoft.VisualBasic.ControlChars

Microsoft.VisualBasic.Conversion

Microsoft.VisualBasic.DateInterval

Microsoft.VisualBasic.Financial

Microsoft.VisualBasic.Interaction

Denied Members

VbTypeName vbVolume

Zero

Finalize

GetType

MemberwiseClone

Err

ErrorToString

Fix

Finalize

GetType

MemberwiseClone

Finalize

GetType

MemberwiseClone

IRR

NPV

MIRR

AppActivate

Beep

CallByName

Command

CreateObject

Allowed Types

Microsoft.VisualBasic.Information

Microsoft.VisualBasic.Strings

Denied Members

Environ

Finalize

Shell

Choose

Switch

Erl

Err

GetAllSettings

GetObject

GetSetting

GetType

InputBox

MemberwiseClone

MsgBox

SaveSetting

IsError

IsDBNull

Lbound

Ubound

SystemTypeName

Finalize

GetType

MemberwiseClone

Lset

Rset

Allowed Types

Microsoft.Crm.Reporting.RdlHelper

Denied Members

Common denied members

The following table contains a list of denied members common in allowed types:

DateString

Duration

Equality

Equals

Erl

Filter

GetChar

GroupNameFromNumber

GroupNumberFromName

Int

MaxValue

MinValue

Negate

Timer

TimeString

ToBinary

Finalize

GetType

MemberwiseClone

In This Section

Sample: Limit the number of items displayed in a chart

Sample: Display the top X values

Sample: Make a report context-sensitive

Sample: Limit the number of items displayed in a chart

Chart reports are limited to 15 data points. The dataset must limit the result set to the top 15 rows for the charted value. Additionally, a 16th "other" data point value is optional. This value represents an aggregation of all other rows in the domain. The 16th value is always sorted to the bottom of the result set. This adds a level of complexity to reports that contain drill-through functionality that is appropriate for some reports.

Note

The number of data points and label length may have to be reduced to correctly display the contents of the chart.

Example

Description

The following is a SQL query example that generates the top 15 data points plus a 16th other data point for a chart:

Code

INSERT INTO @AcctTopTbl SELECT Top 15 accountid FROM FilteredAccount ORDER BY Revenue

Desc

SELECT AcctTop.accountid, AcctTop.name, AcctTop.Revenue, 1 As SortOrder FROM (SELECT Top

15 accountid, name, Revenue FROM FilteredAccount ORDER BY Revenue Desc) AS AcctTop

UNION

SELECT Null As accountid, 'Other' As name, Sum(Revenue) As Revenue, 2 As SortOrder FROM

FilteredAccount

WHERE accountid NOT IN (Select accountid FROM @AcctTopTbl)

ORDER BY SortOrder Asc, Revenue Desc

Example

Description

The following example demonstrates how to limit a number of data points shown in the table by using the FetchXML query. You have to provide two data sets with one FetchXML query per dataset. The results from the first dataset query are passed through the multi-valued parameters to the second dataset to filter the results of the query. Dataset1 retrieves the top 15 records ordered by revenue and Dataset2 retrieves the “TotalRevenue” aggregating all accounts except the accounts from DataSet1.

Code

DataSet1:

</entity>

</fetch>

DataSet2:

</filter>

</entity>

</fetch>

Report Parameter:

...

<DataSetName>DataSet1</DataSetName>

<ValueField>accountid</ValueField>

</DataSetReference>

</DefaultValue>

</ReportParameter>

Sample: Display the top X values

Microsoft Dynamics CRM includes several reports that display the top X items of an entity, where the user can specify the value of X.

To query for the top items, use dynamic SQL. Assign the SQL query string that includes the userspecified parameter to a variable. This resolves the user-specified parameter. The query string is then passed to the SQL EXEC function together with the user-specified parameter.

Example

Description

In the following SQL example, the TopCount parameter contains the user-supplied value.

Code

Declare @SQL nVarchar (4000)

SET @SQL = '

Select Top ' + CONVERT(nvarchar(10), @TopCount) + ' kb.kbarticleid FROM

(' + @CRM_FilteredKBArticle + ') kb '

Exec (@SQL)

Comments

If you’re authoring a FetchXML-based report, this is the corresponding FetchXML query.

</entity>

</fetch>

Accounts in the Related Record Types categorization and specify Forms for related record

types in the Display in field of the Report: New form.

Create and configure a context-sensitive report

1. Create a report that contains fields from a Filtered<entity> database view and establish one or more SQL JOINs with other related filtered views as required.

2. Use CRMAF_Filtered<entity> as an alias name in the report's SQL query statement. For example:

SELECT CRMAF_FilteredActivityPointer.activitytypecodename as activitytypecodename,

CRMAF_FilteredActivityPointer.regardingobjectidname as regardingobjectidname,

CRMAF_FilteredActivityPointer.subject as subject,

CRMAF_FilteredAccount.name

FROM FilteredActivityPointer AS CRMAF_FilteredActivityPointer

INNER JOIN FilteredAccount As CRMAF_FilteredAccount on

CRMAF_FilteredAccount.accountid =

CRMAF_FilteredActivityPointer.regardingobjectid

If you have a Fetch-based report, you can use the following FetchXML query instead of

the SQL query:

<fetch>

</link-entity>

</entity>

</fetch>

3. When you upload the report to Microsoft Dynamics CRM through the Report: New form, select all entities in the Related Record Types categorization that filtered views are referred to in the report's SQL code.

4. In Display In field, select Forms for related record types or Lists for related record

types. Selecting Lists for related record types enables you to run a report from the entity

list grid. Selecting Forms for related record types lets you run a report from the entity form.

Copy reports between Microsoft Dynamics CRM on-premises deployments

The preferred method to copy a report between organizations or deployments is to include the report and any custom entities the report uses in a solution. If you do this, the entity types are mapped automatically by the system. If you choose to manually copy a report to another

Microsoft Dynamics CRM deployment, you must change the entity type codes for custom entities referred to in the report.

In this topic

Fix the type code for a custom entity used in a report

Copy a report between deployments

Fix the type code for a custom entity used in a report

The type code for a custom entity may be different on different Microsoft Dynamics CRM installations. If your report contains references to a custom entity type code, such as when you perform a drill-through to a custom Microsoft Dynamics CRM entity, you must change the type code of the custom entity referred to in your report to the actual type code of the custom entity on the other system you are deploying the report to.

The entity type code for all default (non-custom) entities is pre-defined.

&etc=<entity_type_code>.

The recommended method to refer to the type code is to define a hidden parameter in the report and set its value to the custom entity type code on the original system. After deployment to another Microsoft Dynamics CRM installation, use a SQL statement to set the parameter's value to the type code of the custom entity on that system.

To use a CRM_OTC parameter instead of a hard-coded type code in a drill-through link to Microsoft Dynamics CRM

1. Obtain the custom entity's type code value. To do this, run the following SQL query on the Microsoft Dynamics CRM organization database. Substitute an appropriate organization_MSCRM name. Locate the type code of your custom entity in the resultset. use <organization>_MSCRM select Name,ObjectTypeCode from dbo.Entity order by ObjectTypeCode

2. In the report, create two report parameters: CRM_URL and CRM_OTC. CRM_OTC should be of type string. The default CRM_OTC value should be set to the value obtained in step 1.

3. On the report item that should be used for a drill-through link, add the following Value code:

=Parameters!CRM_URL.Value &"?ID={" &

Fields!new_custentityid.Value.ToString() &

"}&OTC="+Parameters!CRM_OTC.Value

4. Preview and save the report.

5. Copy the report to the destination server according to the instructions in the following section.

Copy a report between deployments

After you redeploy Microsoft Dynamics CRM from one server to another, custom reports must be individually copied to the redeployed (destination) server.

To redeploy one or more reports

1. When you copy a report that references a custom entity type code, you should update the definition of the CRM_OTC report parameter to reflect the object type code of the entity in

the destination system.

From the destination Microsoft Dynamics CRM server, open a browser window and navigate to the source system Microsoft Dynamics CRM.

2. In the Microsoft Dynamics CRM Reports list, select the custom report. On the toolbar, select Edit and then select Actions. In the Actions menu, select Download Report.

3. Select Save. Specify a file name when you are prompted and save the report to the destination system. A copy of the report now exists on the destination system.

4. In the browser, navigate to Microsoft Dynamics CRM on the destination system.

5. In the toolbar located above the Microsoft Dynamics CRM Reports list, select New.

6. In the Report:New Report dialog box, fill in the source file location. Also, fill in the

Details section of the form.

7. Select Save and Close.

8. Your report will now be displayed in the Reports list. You may have to select an appropriate category or entity from the drop-down menus above the toolbar to see the report.

If you do not want to define a default filter, go to step 14.

9. Select your report in the Reports list.

10. In the toolbar, point to More Actions, and then select Edit Default Filter from the menu.

11. In the Report Viewer dialog box, define the default filter criteria that will be used every time the report runs.

12. Select Save Default Filter.

13. Select Run Report.

After the report is tested and functions correctly, follow these steps to add the report to contextsensitive lists and forms within Microsoft Dynamics CRM.

To add the report to context-sensitive lists and forms in Microsoft Dynamics CRM

1. Select the report in the Reports list.

2. On the Actions toolbar, select Edit.

3. In the Report dialog box, fill in the Categorization section according to the following descriptions.

 Categories: Categorizes the report according to its intended purpose. For example, a sales report can be included in context-sensitive lists and forms in the Sales area of

Microsoft Dynamics CRM.

 Related Record Types: Associates the report to specific entities, such as an account or contact. The report can be displayed in context-sensitive lists and forms for those entities.

 Display In: This setting enables the report to be displayed in context-sensitive forms and lists. You can restrict where the report is displayed by using this setting. If you intend to publish a hidden report, clear the Display In text box.

 Languages: Associates the report to all or English language only.

4. Select Save and Close.

Send us your comments about this document

If you have a question or comment about this document, click to send an e-mail message to the

Microsoft Dynamics CRM content team .

If your question is about Microsoft Dynamics CRM products, and not about the content of this book, search the Microsoft Help and Support Center or the Microsoft Knowledge Base .

Anuncio

Report writing with CRM 2015 for online and on-premises

Contents

Report writing with CRM 2015 for online and on-premises

In This Section

Related Sections

Planning Guide for Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online

Installing Guide for Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online

Administration Guide for Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM

Online

Operating Guide for Microsoft Dynamics CRM 2013 (on-premises)

Get started writing reports

Supported

Microsoft

Dynamics

CRM

Versions

Report

Query

Language

Requires

Report

Authoring

Extension?

.RDL file

Data

Provider

.RDL file

Report

Query

In This Section

Related Sections

Report writing environment using SQL Server Data Tools

Required tools

Note

Required privileges

Report development process

See Also

Create a new report using SQL Server Data Tools

Note

In This Topic

Create a custom Fetch-based report (CRM Online and CRM on-premises)

Tip

Advanced Find tab choose Download Fetch XML. Copy the FetchXML into the Query

Tip

Create a custom SQL-based report (Microsoft Dynamics CRM on-premises only)

Next.

Tip

See Also

Working with Microsoft Dynamics CRM reports

In This Section

See Also

Format report content

Use formatting values in reports

Note

Date and time values

Number values

Base currency value

Transaction currency

Format property of the report. For information about how to add columns to a dataset, see

See Also

Add report navigation

Note

Dynamic drill through to Microsoft Dynamics CRM

To set up a drill-through report in Microsoft Dynamics CRM

FilteredOpportunity.

See Also

Categorize and display reports in different languages

Note

See Also

Use parameters in reports

Note

In this topic

Adding parameters

CRM_CurrencyPositivePattern parameters.

ReportParameter and QueryParameter parameters.

Hidden parameters

Special parameters

CRM_FilterText

CRM_URL

CRM_FilteredEntity