---
title: "Short Message Format Workflow"
slug: "short-message-format-workflow"
updated: 2024-11-19T21:29:51Z
published: 2024-11-19T21:29:51Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.revealdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Short Message Format Workflow

## **RSMF Workflow**

Processing should automatically recognize and process valid RSMF files.

1. Upload the RSMF files to your S3 bucket.
2. Under **Import Data**
  1. Select the folder containing the RSMF files.

![220 - 01 - RSMF_S3_Import](https://education.revealdata.com/hs-fs/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/220%20-%2001%20-%20RSMF_S3_Import.png?quality=high&width=688&height=416&name=220%20-%2001%20-%20RSMF_S3_Import.png)
  2. Select **Import Selection**.

![220 - 02 - Import Selection](https://education.revealdata.com/hs-fs/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/220%20-%2002%20-%20Import%20Selection.png?quality=high&width=300&height=189&name=220%20-%2002%20-%20Import%20Selection.png)

## Searching and filtering RSMF metadata for export

RSMF contains several key metadata that may be searched and filtered in preparing the data for export to Review. Reveal Processing handles this in the following manner as part of export preparation.

1. Under **Selective Set Module**, create a **New Selective Set**.
2. Under **Selective Set Builder** use the dropdown arrow to choose ***Short Message****.*
3. You may check **Apply Date Restriction** and then choose a date or dates ***After***, ***Before***or ***Between***specified values. This will filter on Master Date.
4. Under the **Short Message** tab, you may choose to:
  1. Specify the **Conversations** for export, recalling that RSMF conversations are grouped by day (in PDF digest documents) and continuing conversation are threaded together in PDF metadata.
  2. Specify the **Participants** of interest for export (using either CONVERSATIONPARTICIPANTS or CONVERSATIONSLICESENDERS as set out under **Exports** below).
5. **Add** these values to the **Selective Set Table**.
6. **Run Search**.

![220 - 03 - RSMF Selective Set Search](https://education.revealdata.com/hs-fs/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/220%20-%2003%20-%20RSMF%20Selective%20Set%20Search.png?quality=high&width=688&height=503&name=220%20-%2003%20-%20RSMF%20Selective%20Set%20Search.png)

## RSMF Export

Current email export fields around participants have been extended to account for participants within an RSMF conversation with the following available export fields:

- ***CONVERSATION*** - This should be populated with the display field in RSMFConversations for all exported events.
- ***CONVERSATIONID*** - This should be populated with the Id field in RSMFConversations for all exported events.
- ***CONVERSATIONPARTICIPANTS*** - This should be all participants in a given conversation.
- ***CONVERSATIONSLICESENDERS*** - This should be all participants who sent messages within a given 24-hour window.
- ***CONVERSATIONPLATFORM*** - RSMF text application, capturing values such as *SMS*, *WhatsApp*, etc.

> [!NOTE]
> Note
> 
> If the **Parentid** field is populated inside of the source rsmf_manifest.json, Reveal Processing will group these events together as a family/thread instead of grouping together by time slice. In this event, the exported record will include all events for that family/thread regardless of their date/time.
> 
> 
> 
> Keyword searching and selective set filtering can isolate individual events within a conversation. If isolated events are exported, they will be exported without the rest of the conversation. The exception to this is if the events are part of a **Parentid** field family/thread as described above.

> [!NOTE]
> Note
> 
> **Native Only** exports allows for some export capabilities of RSMF data by exporting parent RSMD Events to create an EML.

## RSMF Rendering for Export Purposes

The current deliverable for RSMF at export time is a text conversion of a 24-hour window of a scoped conversation, though this may also be rendered as a json file. **Short Message Handling**must be set to ***Conv. by Day*** format selection in the Export Module to generate this output.

***HTM*** is the default export format when ***Conv. by Day*** is the method chosen for handling short messages.

This rendering should include inline images, icons, and avatars as appropriate. Responses and Reactions should be indicated with a tab structure. Given a FileID for a short message within a conversation, create a rendering of a 24-hour window of messages within the conversation. Ultimately what is developed here is what will be utilized at export time.

## RSMF in Review

Once exported to Review from Processing, the RSMF conversation slice documents and metadata will be available for review.

![220 - 03a - RSMF to Review](https://5796933.fs1.hubspotusercontent-na1.net/hub/5796933/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/220%20-%2003a%20-%20RSMF%20to%20Review.png?width=1216&quality=high)

The records can be filtered for by using the following fields: *App Name = "RSMF_EVENT"* or *Type of Document = “SHORT MESSAGE”*.

![220 - 04 - Filter RSMF_EVENT](https://5796933.fs1.hubspotusercontent-na1.net/hub/5796933/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/220%20-%2004%20-%20Filter%20RSMF_EVENT.png?width=424&quality=high)

![220 - 05 - Filter Short Message](https://5796933.fs1.hubspotusercontent-na1.net/hub/5796933/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/220%20-%2005%20-%20Filter%20Short%20Message.png?width=428&quality=high)

Below is an example of a RSMF conversation slice rendered into a conversation view. The Native / HTML Text Set will need to be indexed for this to be available.

![220 - 06 - Short Message Conversation in Review-1](https://5796933.fs1.hubspotusercontent-na1.net/hub/5796933/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/220%20-%2006%20-%20Short%20Message%20Conversation%20in%20Review-1.png?width=683&quality=high)

For additional technical information about RSMF, please see [***Processing Short Message Format (RSMF)***](/reveal/docs/processing-short-message-format-rsmf).

## Related

- [Review Tracking](/review-tracking.md)
- [S3 Temporary Path to Review Manager Import Workflow](/s3-temporary-path-to-review-manager-import-workflow.md)
- [AI Model Building Workflow](/ai-model-building-workflow.md)
- [Migration Export – Local Discovery](/migration-export-local-discovery.md)
- [Document Review Workflow](/document-review-workflow.md)