Skip to main content

Records Management User Guide

Simflofy's Records Management Service will let users manage their files as records allowing you to put records on hold, add security marks and set retention schedules. In Simflofy a record is any document that has a Retention Schedule applied to it.

In a Federated Search view with RM capabilities you can add a retention schedule to a file which will add additional records management action options.

In the top menu of the Records Management Dashboard you will use the Records Management Button to set up the options that will be available to users to manage files declared as records.

Records List

From the Records List tab you will find a list of all of the files that have been declared as records. Use the search box to filter the list by file name.

You can also use the dropdown list to filter your record list by:

  • Disposition Schedule
  • Records on Hold
  • Security marks
  • Hold Types
  • Repository
  • Other dispositions

Record Actions

Each record will have an action button on it for you to apply various actions to the record. Some of these actions can be done for multiple records by using the Bulk Record Actions. Note: Certain actions will not list as available if the source repository doesn't allow them.


View all the details of the selected record including disposition schedule and document history. From the detail pane you can take actions on the record such as refile, undeclare the record, delete it, put the record on hold, and facilitate document events.


Destroys the document in the source repository, removes the index from federated search, and optionally, deletes all RM History/Metadata associated with the document.

Undeclare Record

This action will remove the file from the Record Management View.

Add to Hold

Putting a record on hold will prevent all interactions with the record and its metadata until the hold expires or is removed. Records can have multiple holds and holds can be indefinite. Creating Holds

Add Security Marks

Once applied to a record, only users and groups with that mark will be able to interact with this document. Security Marks can only exist as part of a Security Group and are not shared between groups. Assigning Security Marks

Retention Schedules

A retention schedule is a list of Disposition Steps that can be applied to a document. A record can have multiple schedules.

Files can be added to retention schedules in Federated Search from the Records Management button.

Records can be added to a retention schedule by

  1. Select Add Retention Schedule
  2. Select the schedule from the dropdown menu
  3. Check the box for Declare as a Record
  4. Click Save

You can also replace a file's retention schedule with another by selecting Details from the action button then clicking Refile. Select the schedule you want to replace then select the one you want to replace it with.

Create a Retention Schedule

Add Record Holds

Putting a document on hold will lock a document to all other actions. Records and Active Content can be under multiple holds at once.

To place a hold on a record, select Add to Hold from the dropdown Actions or Bulk Record Actions button. In the Add to Hold window, select the Hold you want to place on the file(s). And click Save.

All holds are searchable from the Record List tab and in Federated Search.

More detail on Record Holds

Record Audits

Selecting this option from the RM Actions dropdown list will take you to an audit list of all records in the platform.

The Audit table provides the following detail:

  • Record ID
  • Action
  • Audit Time
  • Description
  • User
  • Organization

Use the search criteria and action dropdowns to filter the audit table by first selecting the search criteria and then selecting or adding the desired values. Click search to refresh the table and see your filtered results.

You can also use the search field to narrow down the audit list.

Using the export button users can export the audit table to a CSV or PDF file. From the export form you have several options.

  • Create Record of Report. This option will prompt the user to chose the repository the record should be added to and the schedule the report should be filed under. Both required.
  • Clear Exported Audits from history. This action will clear the filtered results and cannot be reversed
  • Name the Report (required)

In federated search Simflofy lets users mark files as records, search for records and record holds. This can be done individually or in bulk through the bulk action button in the top menu.

With the Records Management result widget added to your federated search content view you can add a record to a retention schedule, view any events that happened on that record as well as view the record's metadata.

To mark a file as a record click the Records Management button next to the file and select Declare as a Record from the dropdown list.

From here you will be prompted to select a retention schedule for the record. And the declare as a record box will be checked automatically.

Note: In Federation Services, being a record does not automatically lock a document to changes via content services.

Admin Properties

RM Simflofy Admin Properties

simflofy.rmfalseEnables RM features for users with the correct roles as well as adding a series of checks onto Content Services to prevent changing records. The current license will be checked for Records Management before enabling these features
simflofy.rm.index.interval1dThe period on which Simflofy will read through all declared records and perform automated steps/update record counts for schedules. Takes the form [integer][time unit], 1d is 1 Day, 1w is 1 Week, 1M is 1 Month. Only d,w,M are valid
simflofy.rm.index.time0The hour of the day, in which the index will run. Uses hours of day, 0 is midnight and 23 is 11PM. Can be updated in the TSearch UI in the Retention Schedules page
simflofy.rm.hold.check.interval1d The period on which Simflofy will read through all document holds and expired the holds where necessary. Takes the form [integer][time unit], 1d is 1 Day, 1w is 1 Week, 1M is 1 Month. Only d,w,M are valid
simflofy.rm.hold.check.time0 The hour of the day, in which the check will run. Uses hours of day, 0 is midnight and 23 is 11PM. Can be updated in the TSearch UI in the Holds page