Add a new MS Word report in Creatio

After you install the MS Word plug-in, you can start setting up the report.

To add a new report:

1. Add a new report record in Creatio. Read more >>>
2. Navigate to the record's page and set up the fields and tables to display in the report. Read more >>>

Example

Set up a "Meeting minutes" report in the Activities section.

Add a new MS Word report record in Creatio

note

If you plan to migrate the package to a different environment, create a new package and set it as current.

1. Click to open the System Designer.

2. Navigate to the "System setup" block and click "Report setup."

   This will open the Report setup section.

3. Click New report → MS Word (Fig. 1).

   Fig. 1 MS Word report setup

   

4. Enter the new report name, e. g. "Meeting minutes."

5. Select a section where the report should be available. For example, specify the Activities section for the "Meeting minutes" report.

6. Select the Show in the section list view and/or Show in the section record page checkboxes, depending on where the report should be available (Fig. 2).

   Fig. 2 Add the Meeting minutes report

   

Proceed to configure the report data fields and tables.

Set up the content of a MS Word report

You can add simple data, such as a contact name or activity date, as well as table data. In the table data, you can display records that are directly connected to the primary report object, as well as records of objects with the reverse connection.

Set up the report fields

1. Open a MS Word report in the Report setup section. For example, open the "Meeting minutes" report created earlier.

2. Click on the report page in the Set up report data block.

3. This will open a column selection window. Select all columns that hold the data required for the report (Fig. 3). For example, select the Subject column to display the activity name in the report. Add the Start and Due columns to display the activity time frame, etc.

   Fig. 3 The report page field setup

   

As a result, the added columns will become available when setting up the report layout in the Creatio MS Word plug-in.

If necessary, add Boolean fields, such as the Do not use phone contact checkbox or Confirmed activity checkbox, to your report. Use special macros to set up displaying of the Boolean fields in the report. Learn more: Basic macros in the MS Word reports.

Set up the report tables

In the tables, you can display a number of records connected to the primary report object. The displayed records can belong to objects that are connected to the report object directly, as well as to objects with the reverse connection.

Set up a table by the connected object's data

Example

The primary object of the "Meeting minutes" report is an activity. The report must display a table with the list of activity participants (records of the "Activity participant" object connected to the corresponding activity).

1. Open a MS Word report in the Report setup section. For example, open the "Meeting minutes" report created earlier.

2. Click on the report page in the Set up report tables block.

3. Fill out the fields on the report table page (Fig. 4):

   1. In the Table object field, select an object whose data will be used to create a table. For example, select the "Activity participant" object to add a table containing the list of the meeting participants.
   2. In the Table name field, specify the table title that will display when setting up the report layout in the Creatio MS Word plug-in.
   3. In the Column of report table object field, specify the column that will link the records in the table object to the primary object of the report. For example, the "Activity" column.
   4. In the Column of the primary report object field, specify the column that Creatio will use to filter the table records. In most cases, the column of the report table object is "Id."
   5. Select the Hide the table if it contains no data checkbox to avoid displaying empty tables in the report.

   Fig. 4 The general settings of the Activity participants table

   

4. On the Table parameters tab, set up the list of report table columns. Click and select the columns to add to the list. For example, to create a list of activity participants with their names and roles, add the Participant and Role columns.

5. Set the sorting order of the table records. Click next to a column and select "Ascending" or "Descending" in the menu to sort the table records based on the values in that column. For example, set the "Ascending" sorting order for the "Participant" column to sort the list of participants alphabetically by name (Fig. 5).

   Fig. 5 The report table record sorting settings

   

   Make sure that your MS Word template includes all the report table columns involved in the sorting rules to apply the sorting rules when printing the report. Learn more about adding table data to the template using the plug-in: Set up the report in the MS Word plug-in and upload it in Creatio.

   You can also sort the table records by several columns. The sorting is performed by the column with a higher position in the group of settings of the table columns.

6. If necessary, go to the Table filters tab and set up an additional filter whose conditions will define which records should appear in the report table. For example, use the following filter to display only those participants who are the company's employees: "Participant.Type = Employee; Customer" (Fig. 6).

   Fig. 6 Report table record filters

   

7. Click Apply to save the report table settings.

8. Save the settings on the report page.

As a result, the added table columns will become available when setting up the report layout in the Creatio MS Word plug-in.

Set up table by data of object with reverse connection

Example

The primary object of the "Meeting minutes" report is an activity. Besides the table with the list of activity participants, the report must display a list of participants of the opportunity connected to the current meeting.

1. Open an MS Word report record in the Report setup section. For example, open the "Meeting minutes" report created earlier.

2. Click in the report page under Set up report tables.

3. Fill out the fields on the report table page (Fig. 7):

   1. In the Table object field, select an object whose data will be used to create a table. For example, to add a table with the opportunity participants, select "Opportunity participant."
   2. In the Table name field, specify the table title that will display when setting up the report layout in the Creatio MS Word plug-in.
   3. In the Column of report table object field, specify the column that will link the records in the table to the primary object of the report – the activity. In our example, it is the "Opportunity" column of the "Opportunity participant" objects.
   4. In the Column of the primary report object field, specify the column of the primary report object that connects the object with the table. In our example, it is the "Opportunity" column of the "Activity" object.
   5. Select the Hide the table if it contains no data checkbox to avoid displaying empty tables in the report.

   Fig. 7 The general settings of the Opportunity participants table

   

4. On the Table parameters tab, set up the list of report table columns. Click and select the column to add it to the list. For example, select the Contact, Role, and Account columns to display the addresses of the meeting participants.

5. Set the sorting order of the table records. Click next to a column and select "Ascending" or "Descending" in the menu to sort the table records based on the values in that column.

6. If necessary, go to the Table filters tab and set up an additional filter whose conditions will define which records should appear in the report table. For example, use the following filter to display the participants who are the company's customers: "Account.Type = Customer."

7. Click Apply to save the report table settings. Save the settings on the report page.

As a result, the added table columns will become available when setting up the report layout in the Creatio MS Word plug-in.

After you create a report in Creatio, you can set up the report in the MS Word plug-in.

Copy the MS Word report

Copy the report to set up similar reports faster.

The report copy keeps the original report template and the following settings:

• columns
• macros
• tables
• filters.

Click Copy in the Report setup section to copy a report.

Click next to the table's name to copy a table to the same report.

Transfer the package with the report to another development environment (optional)

1. Click to open the System Designer.

2. Click "Advanced settings" in the "Admin area" block.

3. Click Add → Data in the section list's toolbar (Fig. 8).

   Fig. 8 The Add menu in the Configuration section

   

4. Bind the data to the following elements (Fig. 9):

   • SysModuleReport_ReportName – the report. Use the report Id from the dbo.SysModuleReport database table to bind it. For example, it is "SysModuleReport_MeetingMinutes" for the "Meeting minutes" report.
   • SysModuleReportTable_ReportName – the table part of the report. Use the report Id from the dbo.SysModuleReportTable database table to bind it. For example, it is "SysModuleReportTable_MeetingMinutes" for the "Meeting minutes" report.

   Fig. 9 The bound report data in the Configuration section list

   

Proceed to transfer the package with the report to another environment.

---

See also

Install Creatio plug-in for MS Word

Set up the report in the MS Word plug-in and upload it in Creatio

---

Resources

Print-ready reports