Teams Message Integration and Sending

Version

Function Description

• You can achieve the Teams integration function through the Teams Integration plugin.

• You can configure and send Teams messages in the export setting of Task Schedule.

• You can integrate multiple Teams applications.

Notes

Note 1

The report server must be accessible from the external network and needs to be configured for HTTPS access.

Sample domain address: https://xxx.xxx.com or http://xxx/webroot/decision

Note 2

The report server needs to be able to access the Teams server.

If the report server is on an internal network and cannot access the Teams server, the forward proxy configuration is supported.

Teams Environment Preparation

You have completed preparation works based on Teams Integration Environment Preparation.

Plugin Download

You can obtain the plugin at https://community.finereport.com/plugin/?id=84.

For details about the installation of the server designer plugin, see Designer Plugin Management.

APP Management

1. Server

Configure Server Address (format: https://Domain name:Port number/webroot/decision) and click Save. Otherwise, problems may occur during sending.

Note:

1. Use a second-level or higher-level domain name that has passed the Internet Content Provider (ICP) Filing. You are advised to use port number 80 or 443.

2. The address will be used to generate platform single sign-on (SSO) links, template SSO links, and delivery result links in the quick configuration. Make sure that the domain name and port number of this address are consistent with the trusted domain names set in the Teams backend web authorization and JS-SDK.

3. The address (format: https://Domain name:Port number/decision or http://Domain name:Port number/decision) needs to be accessible from external networks. Click Save after configuration.

2. Creating the Teams Application

Go to Microsoft Azure, choose App registrations > Teams Integration Test > Overview, and find the information shown in the following table. Configure corresponding settings (Teams App Name, App_Id, Tenant ID, and App_Secret) in the decision-making platform based on the above information. After configuration, click Yes. The following table describes configuration items and relevant operations.

Setting Item	Value	Example
Teams App Name	Custom value	Teams Integration Test
App_Id	Application (client) ID under App registrations > Teams Integration Test > Overview > Essentials in Microsoft  Azure.
Tenant ID	Directory (tenant) ID under App registrations > Teams Integration Test > Overview > Essentials in Microsoft  Azure.
App_Secret	Client secrets under App registrations > Teams Integration Test > Certificates & secrets in Microsoft Azure in section "Configuring Certificates and Secrets" in Teams Integration Environment Preparation.

After successful creation of Teams apps, you can modify/delete information and integrate multiple Teams apps, as shown in the following figure.

Member Management

You can select one user match way based on the actual situation.

You can set User Match Way to Teams Account Match, Manual Match, or Custom Match. The following figure shows the Member Management page.

Note:

1. Users uniformly manage all integrated Teams apps regardless of the numbers of Teams apps being integrated.

2. After switching the match way, you need to click Save to synchronize users.

3. The match way directly affects the user identity authentication in the message sending of Task Schedule.

1. Matching the Teams Account

Teams Account Match involves matching the Teams account with the user account in the report system, resulting in a one-to-one match.

Information in Teams Contacts includes Name, Teams account, Teams Member ID, and Department.

2. Manual Match

When you select Manual Match as User Match Way, an additional Username column will appear in the Teams Contact table. Click the drop-down icon, a dropdown box appears, allowing you to select the corresponding account from the report system for manual match, as shown in the following figure.

Note:

1. When selecting Manual Match, you can select Select None for Username.

2. Manual Match allows you to freely select the report users that match Teams users, enabling multiple Teams users to match the same report user.

3. Custom Match

Match Teams users of corresponding data columns with report users through the set server dataset. If one Teams user corresponds to multiple report users, the first report user is matched by default.

Match Setting appears after you select Custom Match. Select a dataset, a Teams member ID, and a username for match, as shown in the following figure.

APP Quick Configuration

1. Teams Proxy Jump

Note:

You do not need to set the proxy server address if the report server is configured on an external network.

You need to configure the proxy server address if the report server is configured on an internal network and not accessible to the Teams server or external networks.

You do not need to configure the proxy server address under Teams Management > App Quick Configuration if the report server is configured on an internal network, and the customer server and external networks are accessible to each other in normal network environments.

a. Check whether you can ping login.microsoftonline.com and https://graph.microsoft.com/v1.0 on the report server. If you can ping them successfully, you do not need to configure the proxy server address.

b. If you cannot ping them successfully, find two proxy servers and configure the NGINX forward proxy for the two proxy servers, which need to be configured with two proxy URLs (login.microsoftonline.com and https://graph.microsoft.com/v1.0).

c. The following figure shows the platform configuration.

Enter the correct proxy server addresses in the text box. Separate the two proxy server addresses with a semicolon (;). Click Test Connection and Save.

2. Creating Teams Link

Note:

When generating the link, make sure to select the corresponding Teams APP name.

Two types of Teams links can be generated, with one used to access platform directories through SSO and the other used to access templates through SSO.

a. Access platform directories through SSO.

Select a Teams App name, select Decision-Making Platform from the drop-down list of Webpage, click Generate Link, and click Copy, as shown in the following figure.

b. Access templates through SSO.

Select a Team APP name, select Single Template from the drop-down list of Webpage, and select a template. If you need to set parameters, you can click Parameter Setting to set parameters as needed. After parameter setting, select Parse Parameter Value. Finally, click Generate Link, and click Copy, as shown in the following figure.

3. Teams Webhook

a. Go to the Apps page in Teams, search for Webhook, and follow the following steps to create a Webhook.

b. Add the Webhook to the teams and channels where you want to send Teams messages during creation.

c. Name the Webhook and click Create.

d. Wait until a URL for the Webhook is generated after creation. Copy the URL and click Done. The Incoming Webhook has been successfully added to the selected team.

e. Go to the Teams Management page in the decision-making platform, click the App Quick Configuration tab, click New Webhook, select a Teams app from the drop-down list, and set Webhook Name and Webhook URL (same with the URL copied in the fourth step mentioned above).

After completing the entry, click Test Connection and Save.

f. You can view a test message of the Webhook in the Teams channel if the test connection is successful.

1. Click  in the toolbar, and select Website in the pop-up app tab.

2. Enter the custom tab name and the URL (for accessing platform directories through SSO) generated in section "Creating Teams Link."

3. Click the added tab to view the FineReport decision-making system. You can also achieve the SSO effect based on configurations in section "Member Management."

Basic Setting

You need to select platform users who have already been matched with Teams users in Teams Integration Example.

Schedule Object

Note:

You need to select Generate Result (Except for General Result) Separately Based on User in Default User Group. Otherwise, you cannot view the report results based on the permissions on the decision-making platform and cannot use relevant functions. For details, see section "File Processing."

Schedule Cycle

File Processing

Set Processing Method to Client Notification and Push Terminal to Teams Notification, and select the Teams Webhook to be sent from the drop-down list.

You can set Message Type to Link Message, Image/Text Message, or File Message.

• Link Message: Messages are sent through report links. When the login user clicks a report preview link, SSO is supported.

• Image/Text Message: If you select this type, the FineReport server (whose address must start from      https) must be accessible by Teams.

• Image Message: The current template will be delivered as a snapshot.

• File Message: Files are sent through links. You can click links to download files.

Note:

When different results are generated for different users, users can be mentioned during message sending. To mention them, you need to configure a fixed placeholder and wrap it with <at> and </at> tags (for example, <at>Test</at>). The placeholder can be any character string and will be replaced with the platform account in the end.

4. The following table sequentially displays the effects of Link Message, Image/Text Message, Image Message, and File Message.

Note:

The message card may be displayed with some text trimming, because the specific card width may be subject to restrictions and automatic adjustments by the Microsoft Teams platform, even if you can change the message card width through layout and content. That is, Teams may automatically adjust the card width based on factors such as the screen size, device type, and display layout to ensure the best user experience. Therefore, while you can make some adjustments, it is impossible to completely control and fix the width of the card. You are advised to design and arrange the card content as needed, making sure the card displays and adapts correctly on different devices and screens.

Message Type	Configuration Page	Teams Effect
Link Message
Image/Text Message
File Message
Image Message