Implement Word report using basic macros

Level: beginner

To implement the example:

1. Create a report. Read more >>>
2. Set up the report columns. Read more >>>
3. Set up the report template. Read more >>>
4. Upload the file of report template to Creatio. Read more >>>
5. Set up how to display the report. Read more >>>

Example

Generate the custom "Account data" Word report from the Accounts section page and account page. The report must include the following account fields:

• uppercase Name.
• Type.
• Primary contact.

1. Create a report

1. Open the Customer 360 app in the No-Code Designer.

2. Open the Advanced settings tab in the No-Code Designer. To do this, click in the top right → "Application management" → "Application Hub" → Customer 360 app → "Advanced settings."

3. Create a user-made package to add the report. To do this, click → Create new package → fill out the package properties → Save.

   For this example, create the sdkMsWordReportBasicMacros user-made package.

4. Change the current package. Instructions: Change the current package.

   For this example, change the current package to sdkMsWordReportBasicMacros user-made package.

5. Open the Report setup section. To do this, click in the top right → System setup → Report setup.

6. Click New report.

7. Fill out the report properties.

   Property	Property value
   Report name	Account data
   Object	Account
   Show in the list view	Select the checkbox
   Show in the record page	Select the checkbox

8. Apply the changes.

As a result, Creatio will add the "Account data" report to the Report setup section.

2. Set up the report columns

1. Add the report columns.

   1. Go to the Set up report data block.
   2. Add the column of account name. To do this, click → open the Column field → select the Name → click Select.
   3. Add the Type and Primary contact columns similarly.

   As a result, the "Account data" report data will be as follows.

   

2. Add the macro tag to the column.

   For this example, add the macro tag to the Name column. To do this:

   1. Open the setting page of the Name column. To do this, go to the Set up report data block and double-click the column or click in the column row.
   2. Go to the Title property.
   3. Add the [#Upper#] macro tag to the Name column. The [#Upper#] macro converts the value of a string to uppercase.
   4. Save the changes.

3. Apply the changes.

As a result, the "Account data" report data will be as follows.

3. Set up the report template

1. Install the Creatio plug-in for Microsoft Word. Instructions: Install Creatio plug-in for Microsoft Word (user documentation). This is a one-time procedure.

2. Run the Microsoft Word app.

3. Connect to the Creatio instance that includes the created report.

   1. Open the Creatio tab.

   2. Click Connect. This opens the Login window.

   3. Enter the Creatio user credentials.

   4. Click . This opens the Available Servers window.

   5. Click New. This opens the Server Connection Setup window.

   6. Fill out the server properties.

      Property	Property value
      Name	An arbitrary server name. For example, "Creatio."
      Link	URL of the Creatio instance that includes the created report. For example, https://mycreatio.com/.

   7. Click OK. This closes the Server Connection Setup window.

   8. Click OK. This closes the Available Servers window and adds the server name to the Server field of the Login window.

   9. Click OK. This closes the Login window and connects to the Creatio instance.

4. Select the report to set up the template.

   1. Open the Creatio tab.
   2. Click Select report. This opens the Creatio Word reports window.
   3. Select "Account data" report.
   4. Click OK. This closes the Creatio Word reports window and opens the Word report data panel that includes the "Account data" report data set up in the Creatio instance.

5. Set up the template layout based on your business goals.

As a result, the template of the "Account data" report will look as follows.

4. Upload the file of report template to Creatio

1. Open the Creatio tab.
2. Click Save to Creatio.

As a result, the template file of the "Account data" report will be uploaded to the report page in Creatio.

5. Set up how to display the report

1. Add the report to the Accounts section page.

   1. Open the Accounts list page. To do this, click in the top right → Application management → Application Hub → Customer 360 → Accounts list page.

   2. Add a button that opens the "Account data" report.

      1. Add a Button type component to the toolbar of the Freedom UI Designer.

      2. Click and fill out the button properties.

         Element	Property	Property value
         Button that opens the "Account data" report	Title	Print report
         	Action	Print report
         	Which data to print?	List Account | DataTable

   3. Save the changes.

2. Add the report to the account page.

   1. Open the Accounts form page. To do this, click in the top right → Application management → Application Hub → Customer 360 → Accounts form page.

   2. Add a button that opens the "Account data" report.

      1. Add a Button type component to the toolbar of the Freedom UI Designer.

      2. Click and fill out the button properties.

         Element	Property	Property value
         Button that opens the "Account data" report	Title	Print report
         	Action	Print report
         	Print settings	Print report for the current record

   3. Save the changes.

As a result:

• Creatio will add the Print report button that lets you open the "Account data" report from the Accounts section page.

  

• Creatio will add the Print report button that lets you open the "Account data" report from the account page.

  

View the result

To view the result of the example that generates the "Account data" report from the Accounts section:

1. Open the Accounts section.
2. Select an arbitrary account. For example, "Alpha Business."
3. Generate the report. To do this, click Print report → Account data.
4. Save the report file to your device.
5. Open the report file.

As a result, Creatio will generate the "Account data" report from the Accounts section. View the result >>>

To view the result of the example that generates the "Account data" report from the account page:

1. Open the Accounts section.
2. Open the page of an arbitrary account. For example, "Alpha Business."
3. Generate the report. To do this, click Print report → Account data.
4. Save the report file to your device.
5. Open the report file.

As a result, Creatio will generate the "Account data" report from the account page. View the result >>>

Resources

Package with example implementation