Article published on the 27th of June, 2024.
This functionality is released in a Beta version. The functionality may be subject to change as bugs are found a fixed.
The "Save Microsoft Teams chats" step is an action step which can be used to save chat messages, along with their message- and attachment contents, to a location in WorkPoint.
This action can be used with or without the output from a Save Microsoft Teams chats form step as input.
Currently, three different types of configurations can be set up for this step type:
- Entity teams chat: Using this configuration, you can save correspondence from an entity's associated Microsoft Team channels.
- Teams chat: Using this configuration, you can save individual Teams chat messages between two individuals to a specified location within WorkPoint.
- Group chat: Using this configuration, you can save group chat correspondence to a specified location within WorkPoint.
You can create multiple configurations per instance of this step. You can e.g., create a Teams chat- and a Group chat configuration on the same step.
The following image shows an example configuration for the Save Microsoft Teams chats step:
Parameters
| Parameter name | Type | Required | Description |
|---|---|---|---|
| General | |||
| Title | String | Yes | The display title of the step, shown to the user when the step is displayed in a process. |
| Description | String | No | A description text, shown to the user below the step title when the step is displayed in a process. |
| Name | String | Yes | A unique name for the individual process step. No two steps in the same process can share the same name. |
| Continue button title | String | Yes | The text on the Continue button shown in the bottom right of the process window, which allows the user to continue to the next step of the process. |
| Step Input | Object | No | An object used as input for this step. Can e.g., be the output from a "Save Microsoft Teams chat form" step, or the "TeamsActivity" object from the process context. |
| Options | |||
| ZIP result | Boolean | No | Select whether the files output by the save operation should be zipped and saved in the location specified in the "Save location" tab. If set to "Yes", all output files will be zipped and saved in the specified location. The ZIP file will be given the name and title set in the Fields tab. If no name is provided, the file will be named "TeamsChatExport". If set to "No", all outputs are saved in the specified location with file details defined in the Fields tab, except the file names. |
| Configurations | |||
| Entity teams chat | |||
| Title | String | Yes | Provide a title for the configuration. This title is not shown to the end user. |
| Business module | String | Yes | Select the business module containing the entity from which this form should display information. |
| Entity | Integer | Yes | The ID of the entity in the selected business module from which this form displays information. |
| Channel | Array | No | Select the Teams channels messages should be exported from. If no channel is selected, all channels will be extracted, creating a separate message content file per channel, named accordingly. |
| Start Date | String | No | Select a start date from which Teams chats from the selected channels should be saved. |
| End Date | String | No | Select an end date from which Teams chats from the selected channels should be saved. |
| Include message content | Boolean | No | Select whether chat messages should be part of the material saved. |
| Include attachments | Boolean | No | Select whether attachments from messages should be part of the material saved. If set to "Yes", and the ZIP result setting is also set to "Yes", the attachments will be included in the packaged ZIP file and references are relative to the zip file. If set to "Yes", and the ZIP result setting is set to "No", the attachments will be copied to the location (if not already there) and references will be to the new attachment location. |
| Message content file type | String | No | Select the file type(s) of the message content files. Available options are:
|
| Teams chat | |||
| Title | String | Yes | Provide a title for the configuration. This title is not shown to the end user. |
| Team Id | String | Yes | In this field, you must provide the Team Id of the team which contains the correspondence to be saved. |
| Channel | Array | No | In this field, you must provide the channel(s) from which you wish to save correspondence. |
| Start Date | String | No | Select a start date from which Teams chats from the selected channels should be saved. |
| End Date | String | No | Select an end date from which Teams chats from the selected channels should be saved. |
| Include message content | Boolean | No | Select whether chat messages should be part of the material saved. |
| Include attachments | Boolean | No | Select whether attachments from messages should be part of the material saved. If set to "Yes", and the ZIP result setting is also set to "Yes", the attachments will be included in the packaged ZIP file and references are relative to the zip file. If set to "Yes", and the ZIP result setting is set to "No", the attachments will be copied to the location (if not already there) and references will be to the new attachment location. |
| Message content file type | String | No | Select the file type(s) of the message content files. Available options are:
|
| Group chat | |||
| Title | String | Yes | Provide a title for the configuration. This title is not shown to the end user. |
| Chat Id | String | Yes | In this field, you must provide the Chat Id of the chat which contains the correspondence you wish to save. |
| Start Date | String | No | Select a start date from which Teams chats from the selected channels should be saved. |
| End Date | String | No | Select an end date from which Teams chats from the selected channels should be saved. |
| Include message content | Boolean | No | Select whether chat messages should be part of the material saved. |
| Include attachments | Boolean | No | Select whether attachments from messages should be part of the material saved. If set to "Yes", and the ZIP result setting is also set to "Yes", the attachments will be included in the packaged ZIP file and references are relative to the zip file. If set to "Yes", and the ZIP result setting is set to "No", the attachments will be copied to the location (if not already there) and references will be to the new attachment location. |
| Message content file type | String | No | Select the file type(s) of the message content files. Available options are:
|
Comments
0 comments
Please sign in to leave a comment.