Successfully!

Error!

Teams Message Integration and Sending

  • Last update:  2023-11-18
  • Overview

    Version

    Report Server Version

    Plugin Version

    Functional Change

    V11.0

    V1.2

    /

    Function Description

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

    • You can configure and send Teams messages in File Processing of Task Schedule.

    • You can integrate multiple Teams applications.

    iconNote:
    Currently, the single sign-on function is only supported on the Teams client.

    Preparation

    Environment Preparation

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

    Teams Integration Preparation

    You have completed Teams integration preparation works based on the document Teams Integration Example.

    Sending Teams Messages through Task Schedule

    Basic Setting

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

     

    Schedule Object

    iconNote:
     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.

     

    The supported messages include Link Message, Text Message, File Message, and Image Message.

    • Link Message: Messages are sent in the report link format. When you preview the report by clicking the link, the single sign-on function is supported. That is, the current login user's account can be automatically logged in here.

    • 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 sent as a snapshot.

    • File Message: The file is sent in the link format. You can click the link to download the file.

     

    iconNote:
    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 (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, Text Message, Image Message, and File Message.

    iconNote:
     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. / You are advised to design and arrange the card content based on actual needs, ensuring that the card can be displayed and adapted properly on different devices and screens.

    MessageType
    Setting PageTeams Effect

    Link Message

    WXWorkCapture_17003182074013.png

    Text Message

    WXWorkCapture_17003182074013.png

    File Message

    WXWorkCapture_17003182074013.png

    Image Message

    Sending Teams Messages Through the Template Message Event Plugin

    The Template Message Event plugin in V1.8.0 and later versions are compatible with Teams Webhook message sending. After updating the plugin, you can see the Webhook configuration on the setting page and send messages based on configurations.

    For details about complete functions of the Template Message Event plugin, see Template Message Event.

    iconNote:
    The Teams Integration plugin and the Template Message Event plugin with consistent versions must be installed in both the local designer environment and the server environment.

    Event Setting

    1. Add a Template Message event and configure relevant settings on the Message Receiver tab page.

     

    2. Choose System Management > Teams Management > App Quick Configuration, set Webpage to Single Template, select the needed template, click Generate Link, and copy the link.

     

    3. Go back to the designer setting page, click the Message Content tab, set Client to Teams Push, and select the needed app from the drop-down list in Teams App. Enter the link copied in the previous step and customize Title and Content as needed.

    iconNote:
    You can use the placeholder mentioned in section "File Processing" for Content configurations to achieve the Teams mention function.

     

    Effect Display

     WXWorkCapture_17003189532867.png

    iconNote:
    After you click the link, the content is opened in the preset browser. Ensure that the decision-platform has been logged in (as the user bound to the Teams account) in the browser. Otherwise, the link content cannot be accessed properly.

    Attachment List


    Theme: Fine Mobile
    Already the First
    Already the Last
    • Helpful
    • Not helpful
    • Only read

    Doc Feedback