Alfresco Documentation
Published on Alfresco Documentation (https://docs.alfresco.com)

Home > Alfresco Governance Services 2.6 > Records Management

Records Management

Records Management controls important information that needs to be retained over time. It's used in highly regulated environments, for managing governmental information or personnel records, or where information might be audited.

Fully integrated into Alfresco Content Services, Records Management makes it easy to work with files and have them declared as records at the right time, without changing the way you work.

  • Records Management video tutorials [1] Watch these videos for tips on using Alfresco Records Management.
  • Getting started with Records Management [2] Although Alfresco Records Management has a huge amount of functionality available, it's actually pretty easy to learn the essentials and get up and running.
  • Using Records Management [3] With Alfresco Records Management you store and control all your records in a dedicated site. A Records Management site is like other Alfresco sites, but with additional controls placed on its content.
  • Installing [4] Use this information when installing and configuring Records Management.
  • Upgrading [5] To upgrade Records Management you need to make sure you're running the correct version of Alfresco Content Services.
  • Administering [6] RM Admin Tools is where you configure the Records Management site.
  • Records Management FAQs [7] Here are the answers to some frequently asked questions about Records Management.
  • Records Management Glossary [8] The glossary explains the meaning of terms and acronyms that are used in the Alfresco Records Management documentation.
Parent topic: Alfresco Governance Services [9]

Records Management video tutorials

Watch these videos for tips on using Alfresco Records Management.

  • Create a Records Management site [10] Learn how to create a Records Management site.
  • Import Records Management test data [11] Learn how to import Records Management test data.
  • Add a record category [12] Learn how to add a record category.
  • Create a retention schedule [13] Learn how to create a retention schedule.
  • Create retention schedule steps [14] Learn how to create retention schedule steps.
  • Create a record folder [15] Learn how to create a record folder.
  • Set user permissions [16] Learn how to set user permissions.
  • File a record [17] Learn how to file a record.
  • Declare an easy access record [18] Learn how to declare an easy access record.
  • File an unfiled record [19] Learn how to file an unfiled record.
  • Add a record type [20] Learn how to add a record type.
  • Edit record metadata [21] Learn how to edit record metadata.
  • Complete a record [22] Learn how to complete a record.
  • Process a record [23] Learn how to process a record.
  • Automate the File Plan [24] Learn how to automate the File Plan.
Parent topic: Records Management [25]

Create a Records Management site

Learn how to create a Records Management site.

Parent topic: Records Management video tutorials [1]

Import Records Management test data

Learn how to import Records Management test data.

Parent topic: Records Management video tutorials [1]

Add a record category

Learn how to add a record category.

Parent topic: Records Management video tutorials [1]

Create a retention schedule

Learn how to create a retention schedule.

Parent topic: Records Management video tutorials [1]

Create retention schedule steps

Learn how to create retention schedule steps.

Parent topic: Records Management video tutorials [1]

Create a record folder

Learn how to create a record folder.

Parent topic: Records Management video tutorials [1]

Set user permissions

Learn how to set user permissions.

Parent topic: Records Management video tutorials [1]

File a record

Learn how to file a record.

Parent topic: Records Management video tutorials [1]

Declare an easy access record

Learn how to declare an easy access record.

Parent topic: Records Management video tutorials [1]

File an unfiled record

Learn how to file an unfiled record.

Parent topic: Records Management video tutorials [1]

Add a record type

Learn how to add a record type.
Note: The Add Record Metadata option is only available in DoD 5015.2-STD compliant Records Management sites.

Parent topic: Records Management video tutorials [1]

Edit record metadata

Learn how to edit record metadata.

Parent topic: Records Management video tutorials [1]

Complete a record

Learn how to complete a record.

Parent topic: Records Management video tutorials [1]

Process a record

Learn how to process a record.

Parent topic: Records Management video tutorials [1]

Automate the File Plan

Learn how to automate the File Plan.

Parent topic: Records Management video tutorials [1]

Getting started with Records Management

Although Alfresco Records Management has a huge amount of functionality available, it's actually pretty easy to learn the essentials and get up and running.

What you do in Records Management will vary hugely depending on your role, and how your company is organized. This guide is split into two sections, one for Records Managers, and one for Records Management users. You might find that these guides don't exactly match what you do in your day-to-day job, but even if they don't you should find them useful in getting started, and in understanding the basic concepts of Records Management and how the processes fit together.

  • Life cycle of a record [26] You can create a record either by uploading it to the Records Management File Plan, or by declaring a file in another Alfresco site as a record.
  • Getting started for Records Managers [27] As a Records Manager you're responsible for ensuring the Alfresco Records Management site is properly organized and managed.
  • Getting started for Records Management Users [28] As a user of the Alfresco Records Management site you need to file records and process them as easily as possible.
Parent topic: Records Management [25]

Life cycle of a record

You can create a record either by uploading it to the Records Management File Plan, or by declaring a file in another Alfresco site as a record.

When you have added all required metadata to a record you can mark the record as complete. This makes it an active part of the File Plan, and subject to the rules of the retention schedule it is associated with.

It then goes through various time and event based steps such as cut off and retention, until it is eventually transferred elsewhere, or destroyed, according to its retention schedule.

Record Lifecycle

Parent topic: Getting started with Records Management [2]
Parent topic: Using Records Management [3]

Getting started for Records Managers

As a Records Manager you're responsible for ensuring the Alfresco Records Management site is properly organized and managed.

The background configuration of the site should be managed by your Records Management administrator in the RM Admin Tools.

This leaves you to get on with managing the site organization, devising and ensuring the implementation of retention and disposal schedules, and enabling appropriate access to information.

In this guide you'll see how to get started with the basics immediately.

  • Adding a record category [29] You can create a record category at the top level in the File Plan or within another record category.
  • Creating a retention schedule [30] A retention schedule is created against and associated with a record category. First you create a summary of the schedule, then the steps in the schedule.
  • Creating retention schedule steps [31] When you've set up a retention schedule, you need to add retention steps. The steps give the retention schedule it's control over records and folders.
  • Customizing the end of the financial year [32] You can set the end date of the financial year and the end of the financial quarter.
  • Adding a record folder [33] You can add record folders within a record category.
  • Setting user permissions [34] Setting user permissions on folders and categories lets you control who can see and work in different areas of the File Plan.
Parent topic: Getting started with Records Management [2]

Adding a record category

You can create a record category at the top level in the File Plan or within another record category.
  1. In the File Plan go to the location for the new record category.
  2. Click New Category.

    The New Record Category dialog box displays.

  3. Enter details for the new category. Fields marked with an asterisk (*) are required.

    Metadata field Description
    Name* The name for the record category.
    Title* The title for the record category.
    Description A description of the record category.
    Record Category ID* A unique identifier for the record category is generated automatically. You can change this now, but you can't edit it once the category has been created.
    Vital Record Indicator Defines whether records in this category have a review process. The Vital Record Indicator is applied to all record folders within that category. You can change this at folder level.

    Users with Records Manager permissions receive a notification email when vital records are due for review.

    Period The time period for the review cycle. Reviews are recurring based on the period you select. The review period is required when the Vital Record Indicator option is selected.
    Note: The "Quarter" option splits the year into 4 sets of 3 months, beginning with Jan/Feb/March. "Financial Quarter" is the same but based on the start date of your system-configured financial year.
    The review period is displayed on the details page for folders and records in the category.
    Expression Enter a number as the Expression to accompany the Period type. If you enter “Week” and “3”, this would mean a review cycle of 3 weeks.

    If you select a Period that doesn't require an Expression then this field isn't available.

  4. Click Save.

    The new category displays in the File Plan.

Parent topic: Getting started for Records Managers [27]
Parent topic: Building the File Plan [35]

Creating a retention schedule

A retention schedule is created against and associated with a record category. First you create a summary of the schedule, then the steps in the schedule.
  1. Hover over a record category in the File Plan and click View Details.

    The category details page displays and if the category already has a retention schedule then you'll see the schedule summary and steps.

  2. Click Create Retention Schedule.
  3. In the General section, click Edit.
  4. Complete all fields:

    Field Description
    Retention Authority The authority that states how the record should be retained and disposed, for example Sarbanes-Oxley Act (SOX) or Corporate procedures.
    Retention Instructions A summary of the retention schedule.

    This information is not actively used but this text is displayed in the record category summary in the File Plan, and is important from a legal perspective.

    Applied to Record Folder: the retention schedule is applied to folders and all operations occur at the folder level. With this setting, you cannot manage records as individual units. If you cut off the folder, all records will be cut off.

    Record: the retention schedule is applied to records and all operations occur at the record level.

    Note: If you add folders to a category before setting up the retention schedule, then you can only select Record Folder.
  5. Click Save.

    The category details page now displays a summary of the new or updated retention schedule.

Next you need to add steps to the retention schedule.

Parent topic: Getting started for Records Managers [27]
Parent topic: Retention schedules [36]

Creating retention schedule steps

When you've set up a retention schedule, you need to add retention steps. The steps give the retention schedule it's control over records and folders.
  1. Hover over a record category in the File Plan and click View Details.

    The category details page displays showing the retention schedule summary.

  2. In the Retention Steps section, click Edit.

    The Edit Retention Schedule page displays.

  3. Click Add Step and select a retention action.

    Option Description
    Cut off This is the first step in a retention schedule. Once a record is cut off this triggers the records retention period. You can't add records to a folder that's been cut off.
    Retain This is an alternative first step that is a 'placeholder' step which delays the next retention step until after a selected time period or event.
    Transfer Records are transferred from one location to another. This can be applicable to both electronic and non-electronic records, and will be used, for example, when transferring records from an organization to an archive.
    Accession An advanced form of transfer usually involving the specific legal and physical transfer of records between organizations.
    Destroy Electronic records are removed from the Records Management system and destroyed, and non-electronic records must be destroyed.

    Note: You can add multiple steps to a retention schedule, but the first step must be either a Cut off or Retain action, and no steps can be added after the Destroy action.
  4. Select whether the action will be triggered after a period of time or when a specified event occurs:

    Option Description
    After a period of Select the time period after which the step action will take place.
    Note: If you select XML Duration from the Period Type drop down list you can specify a time interval using XML syntax.

    The syntax should take the form of:

    P = Period (required)

    nY = Number of years

    nM = Number of months

    nD = Number of days

    T = Start time of a time section (required if specifying hours, minutes, or seconds)

    nH = Number of hours

    nM = Number of minutes

    nS = Number of seconds

    For example, 'P2M10D' represents two months and ten days.

    Created Date = The date when the file or record is first added to Alfresco.

    Retention Action = The date when the last retention action took place. Don't select this for the first step in the schedule.

    The "Quarter" option splits the year into 4 sets of 3 months, beginning with Jan/Feb/March. "Financial Quarter" is the same but based on the start of your system-configured financial year. See Customizing the end of the financial year [37].
    When event happens Select the event after which the step action will take place.

    Most events must be completed manually in the record details page, or you can use rules to automatically complete these events.

    The Obsolete, Superseded, and Related Record Transferred To Inactive Storage events are automatically completed when relevant relationships are set up between records [38].

    Note: You can select both options, or multiple events, and have the action triggered by Whichever event is earlier or When all events have happened.

    The date selected here is displayed as the Retention as of date in the details page for records or folders, depending on which the retention applies to. If you select an event then this field will display None, and you should complete the event on the details page.

  5. If you added a Destroy step then there is an additional Keep record metadata after record destruction option. If you select this option then destroyed records are still represented in the File Plan rather than being completely deleted. An audit trail and metadata remain but the records can't be accessed.

    Note: The metadata is maintained indefinitely unless it is manually deleted from the File Plan by someone with the ALFRESCO_ADMINISTRATOR role, or another role that has been given permissions to delete the metadata.
  6. Enter a Step Description.
  7. Click Save.

    Tip: You can click the Edit icon edit icon or Delete icon delete icon next to a step to edit or delete it.
  8. When you've entered all the required steps click Done.
You return to the category details page, which displays the retention steps. Click View Description to the right of a step to display the description.

Parent topic: Getting started for Records Managers [27]
Parent topic: Retention schedules [36]

Customizing the end of the financial year

You can set the end date of the financial year and the end of the financial quarter.
Important: If you make adjustments to your financial year as per the instructions below, it is important you carry out the same procedure on your new installation every time you upgrade to a new version of Alfresco Governance Services.
  1. Go go <TOMCAT_HOME>/webapps/alfresco/WEB-INF/lib/alfresco-repository-2.6.x.jar.
  2. Copy period-type-context.xml to <TOMCAT_HOME>/shared/classes/alfresco/extension.
  3. Rename the file to custom-period-type-context.xml.
  4. Change all the value properties to suit the dates of your financial year.

    For example, the following would customize your system to start the financial year in October.

    <bean id="period.end.of.financial.month" class="org.alfresco.repo.dictionary.types.period.EndOfFinancialMonth" >
    		<property name="startDayOfMonth">
                <value>1</value>
            </property>
    		<property name="startMonth">
                <value>10</value>
            </property>
    	</bean>
    	<bean id="period.end.of.financial.quarter" class="org.alfresco.repo.dictionary.types.period.EndOfFinancialQuarter" >
    		<property name="startDayOfMonth">
                <value>1</value>
            </property>
    		<property name="startMonth">
                <value>12</value>
            </property>
    	</bean>
    	<bean id="period.end.of.financial.year" class="org.alfresco.repo.dictionary.types.period.EndOfFinancialYear" >
    		<property name="startDayOfMonth">
                <value>1</value>
            </property>
    		<property name="startMonth">
                <value>9</value>
            </property>
    	</bean>
  5. Restart the server.
  6. (Optional) If you change your financial periods this does not update any previously set calculated schedules and you will need to edit all retention schedules to ensure the new period start date is used. See Editing a retention schedule [39].
Parent topic: Getting started for Records Managers [27]

Adding a record folder

You can add record folders within a record category.
  1. Select a folder in the File Plan.
  2. Click New Folder.

    The New Record Folder dialog box displays.

  3. Enter details for the new category. Fields marked with an asterisk (*) are required.

    Metadata field Description
    Name* The name for the record folder.
    Title* The title for the record folder.
    Description A description of the record folder.
    Record Folder ID* A unique identifier for the record folder is generated automatically. You can change this now, but you can't edit it once the folder has been created.
    Location If relevant specify the physical location of the records contained within this folder.
    Supplemental Marking List If available, select any suitable properties from the list. Entries on this list are set up by your Alfresco administrator and are only available if you have been given the required permission.
    Vital Record Indicator Defines whether records in this folder have a review process. The Vital Record Indicator is applied to all records within the folder. You can change this at record level.
    Note: If you don't select this option and the category the folder is in has a Vital Record Indicator set, then the category setting will be applied to the folder once it is created.

    If you do select this option it will override any Vital Record Indicator set in the category.

    Users with Records Manager permissions receive a notification email when vital records are due for review.

    Period The time period for the review cycle. Reviews are recurring based on the period you select. The Review Period is required when the Vital Record Indicator check box is selected.
    Note: The "Quarter" option splits the year into 4 sets of 3 months, beginning with Jan/Feb/March. "Financial Quarter" is the same but based on the start date of your system-configured financial year. See Customizing the end of the financial year [37].
    The review period is displayed on the details page for records in the folder.
    Expression Enter a number as the Expression to accompany the Period type. If you enter “Week” and “3”, this would mean a review cycle of 3 weeks.

    If you select a Period that doesn't require an Expression then this field isn't available.

  4. Click Save.

    The new folder is now shown in the File Plan.

The new record folder is marked as Open, which means that records can be filed in it. The date of opening is the same as the creation date.

Parent topic: Getting started for Records Managers [27]
Parent topic: Building the File Plan [35]

Setting user permissions

Setting user permissions on folders and categories lets you control who can see and work in different areas of the File Plan.
Tip: Remember that until you have given users permission for a folder or category they won't be able to see it or work with its contents.
  1. Click Manage Permissions when you're in the folder or category you want to set permissions for in the File Plan.

    Tip: You can also hover over a folder in the File Plan and click More then Manage Permissions, or a category in the File Plan and click Manage Permissions.

    The Manage Permissions page opens with the name of the selected folder or category displayed. Any users and groups that currently have permissions assigned are also displayed. You can change existing user permissions or Remove them entirely.

  2. Click Add User or Group.
  3. Enter the name of an individual user, a group, or a Records Management role and click Search.

    All users, groups, and roles matching the search are displayed.

  4. Click Add next to the user, group, or role that you want to add permissions for.

    Tip: You can add permissions for as many users, groups, and roles as you want.
  5. Select either Read and File or Read Only.

    Read and File allows users to work with content, whereas users with Read Only permission can only view content.

  6. When you're finished click Save to return to the File Plan.

    The permissions you've set are now applied to the folder or category you selected and any folders or categories it contains. You can change these as needed on a folder or category basis.

Parent topic: Getting started for Records Managers [27]
Parent topic: Managing permissions [40]

Getting started for Records Management Users

As a user of the Alfresco Records Management site you need to file records and process them as easily as possible.

Your Records Manager will have organized the site and set up retention and retention schedules, leaving you to get on with managing and processing the site records.

In this guide you'll see how to get started with the basics immediately.

  • Filing an electronic record [41] Electronic records are files that are uploaded to a records folder. Non-electronic records might be paper files that can be stored in a physical location.
  • Declaring a file as a record [42] You can create records from files in non-Records Management sites and add them straight into the File Plan.
  • Filing an unfiled record [43] When you've declared a record from a non-Records Management site it's added to the Unfiled Records area. You now need to add it to a records folder.
  • Adding record metadata [44] All records in the File Plan have metadata, which you can think of as records properties.
  • Editing record metadata [45] You can edit record metadata to add information to a record.
  • Completing a record [46] Content added to the File Plan must be set to complete before it is recognized as a record.
  • Processing records [47] Retention steps are generally completed manually, though retain and cut off steps can be completed automatically by a system process that is run daily. You can also set up a rule to complete steps automatically.
Parent topic: Getting started with Records Management [2]

Filing an electronic record

Electronic records are files that are uploaded to a records folder. Non-electronic records might be paper files that can be stored in a physical location.
  1. In the record folder where you want to file a record click File.
  2. Click Electronic.
  3. Click Select Records to File and find the file that you want to upload.

    Tip: You can also select multiple items in the standard multi-select way.
    The files are uploaded as record and display in the File Plan as incomplete records. You need to make sure any required metadata is added before you can set records to complete.

Parent topic: Getting started for Records Management Users [28]
Parent topic: Filing records [48]

Declaring a file as a record

You can create records from files in non-Records Management sites and add them straight into the File Plan.
  1. In the Document Library of an Alfresco site find the file you want to declare as a record.
  2. Hover over the file and click More then Declare as Record.

    The file is added to the Unfiled Records area, in the explorer panel of your Records Management site. It's still visible in its original site, identified by the Easy access record icon, but is locked and with a limited set of actions available.

    Note: You can't declare a record if your permission level for the site is Consumer, or if the file is locked.

    A file that has been declared as a record can be deleted. The records remain in the File Plan.

This record can now be filed in the File Plan. You can find it in the Unfiled Records area in the File Plan explorer panel. New records display in the File Plan as incomplete records. You need to make sure any required metadata is added before you can set records to complete.
Note: You can also set up folder rules in a non-Records Management site so the files can be automatically declared as records. For example, you could create a rule that when a file is tagged as "Confirmed", then a record will be created of that file and added to the Records Management site.

Parent topic: Getting started for Records Management Users [28]
Parent topic: Easy access records [49]

Filing an unfiled record

When you've declared a record from a non-Records Management site it's added to the Unfiled Records area. You now need to add it to a records folder.
  1. Click the Unfiled Records area on the explorer panel on the left of the page.

    All unfiled records are displayed.

    Note: You can add additional folders to the Unfiled Records area to create a folder hierarchy to help manage unfiled records. You can also declare items as records directly from within the Unfiled Records area structure.
  2. Hover over an unfiled record and click More then File to....
  3. Select a records folder to file the record in then click File.

    Note: There are multiple other actions available including Reject so you can reject the record from the File Plan, and Move to so you can move the record to another location in the Unfiled Records hierarchy.
The record's added to the File Plan, and if you haven't already you can now go and edit metadata.

Parent topic: Getting started for Records Management Users [28]
Parent topic: Filing records [48]

Adding record metadata

All records in the File Plan have metadata, which you can think of as records properties.
If you associate the record with a specific type by selecting the Add Record Metadata option then additional metadata options are required for the record. You need to complete all the required metadata before you can set a record to complete.

The Add Record Metadata option is only available in DoD 5015.2-STD compliant Records Management sites.

Note: Adding record metadata isn't mandatory, but can be useful to allow additional metadata to be added against a file.
  1. Hover over an incomplete record in the File Plan and click More then Add Record Metadata.

    Tip: For non-electronic records the Add Record Metadata is available as soon as you hover over them, you don't need to click More.

    The available record types are displayed.

  2. Select the appropriate record type.
    Record type Description
    Web Record A web page.
    Scanned Record A file that is scanned into the Records Management system.
    PDF Record A PDF file.
    Digital Photograph Record A photographic image file.

    Tip: You can select multiple items in the standard multi-select way.
  3. Click OK.

    Some record metadata is mandatory. Before you can complete a record, you must edit the metadata to complete the mandatory fields.

Icons next to the record show the record types that it's been associated with. Hover over an icon to display the record type.

Parent topic: Getting started for Records Management Users [28]
Parent topic: Filing records [48]

Editing record metadata

You can edit record metadata to add information to a record.
Before you can complete a record, you must enter any required details about the record in the metadata. You can't edit record metadata after you have set the record to complete.
  1. Hover over a record in the File Plan and click Edit Metadata.

    The Edit Metadata page displays. The metadata fields you see on this page depend on the file type, and whether or not record types have been associated with the file. The metadata is divided into sections, with additional sections dependant on if a record type has been associated with the item.

  2. Enter the record metadata. Fields marked with an asterisk (*) are required.

    If your Records Management system is DoD 5015.2-STD compliant then every file includes the DOD5015 Record section, which is a default set of basic metadata fields. The default record metadata fields are:

    Record
    Publication date* The date that the record is published. Select the date from the calendar selection box.
    Originator* The person or department in the originating organization.
    Originating Organization* The organization that created the record.
    Media Type The general media type such as audio, video, or document.
    Format The format in which the record is stored, such as electronic or physical file.
    Date received The date that the record was received from the originator.
    Addressee The email address of the originating organization to be used for correspondence.
    Other Addressee The secondary recipients of the message (CC).
    Location The physical location of the record, generally only applicable to non-electronic records.
    Supplemental Marking List Any additional properties applicable to the record. This list is defined by the Alfresco administrator in the List of Values in the RM Admin Tools.

    This is available in both standard and DoD 5015.2-STD compliant File Plans.

    You can't save this page until you complete any required fields.

  3. Click Save.

Parent topic: Getting started for Records Management Users [28]
Parent topic: Filing records [48]

Completing a record

Content added to the File Plan must be set to complete before it is recognized as a record.
Hover over an incomplete record in the File Plan and click Complete Record.

Tip: Incomplete records are marked.

If a record has mandatory metadata that hasn't been completed then a message lets you know that required metadata is missing.

Once a record is completed, it comes under the control of the record category it is filed under, and security restrictions apply.
Note: A record can be filed in multiple categories, see Linking records [50] for more details.

Parent topic: Getting started for Records Management Users [28]
Parent topic: Filing records [48]

Processing records

Retention steps are generally completed manually, though retain and cut off steps can be completed automatically by a system process that is run daily. You can also set up a rule to complete steps automatically.
If a retention step is complete (the time period is finished or the required events have been completed), then additional options are available for folders or records, dependant on whether the retention schedule is set to folder or record level.

If you apply an action to a folder then it will also be applied to all records within the folder.

Hover over a folder/record in the File Plan and click the action that is available to move to the next step in the retention schedule.

Action Select this to...
Cut off Cuts off the record/folder and triggers the retention period. Records can't be added to a folder that's been cut off.
End Retention Ends the retention period for the record/folder.
Transfer Transfers the record/folder to the previously specified location. An audit trail and metadata is retained.

By default transferred records/folders are temporarily held in the Transfers area of the File Plan until you hover over them and click Complete Transfer.

Accession Transfers the record/folder to the previously specified location. An audit trail and metadata is retained.

This usually involves the specific legal and physical transfer of records between organizations.

By default accessioned records/folders are temporarily held in the Transfers area of the File Plan until you hover over them and click Complete Transfer.

Destroy Removes the record/folder content from the Records Management system. If the Maintain record metadata after destroy option is selected in the retention schedule, then a visual representation of the record, an audit trail, and metadata is retained in the File Plan.

If the record was declared from a file in an Alfresco site then the file is also removed.

Note: Each time you manually run an action, that option is replaced with the next action step in the retention schedule, and a new option for undoing the step you've just done, for example, Undo Cut Off.

Icons next to the record/folder indicate their current stage in the schedule.

Parent topic: Getting started for Records Management Users [28]
Parent topic: Managing record folders [51]
Parent topic: Managing records [52]

Using Records Management

With Alfresco Records Management you store and control all your records in a dedicated site. A Records Management site is like other Alfresco sites, but with additional controls placed on its content.

Access a Records Management site just as you would any other Alfresco site, from the My Sites dashlet or the Sites menu.

Instead of storing your files in a document library as you do in a "regular" Alfresco site, in a Records Management site you file your records in the File Plan. And you can't edit the content of records; once they're in the File Plan record content is considered to be final.

You file records by adding them from your computer to the File Plan, or if you're in another Alfresco site you can declare a file as a record and it will be added to the Records Management site. Once files are added to the File Plan you can edit their metadata (properties) but you can't edit their actual content.

If you're new to Alfresco then take a look at Using Alfresco [53] to help you get started.

For more details on setting up and administering Records Management see Administering Records Management [54].
Note: It's recommended that you use the File Plan for Records Management actions rather than going through the repository.
  • Life cycle of a record [26] You can create a record either by uploading it to the Records Management File Plan, or by declaring a file in another Alfresco site as a record.
  • The File Plan [55] The File Plan is a container for records, folders, categories and retention schedules. It's effectively a virtual filing cabinet for storing records, and is the basic structure of Records Management. This structure lets you classify and group records with similar characteristics.
  • Retention schedules [36] Retention schedules define how records are managed in the Records Management system until their eventual destruction or transfer to another location. The period between a record being completed and becoming part of the File Plan, and being destroyed/transferred is known as its retention period.
  • Managing permissions [40] To ensure the security of your Records Management system you can easily manage user permissions to control which users and groups can see and work in different sections of the File Plan.
  • Filing records [48] Filing records is the process of classifying records and putting them into the correct location in the File Plan.
  • Easy access records [49] In many cases you might want to create records from files that already exist in Alfresco, rather than creating a record from scratch.
  • Managing the File Plan [56] The record categories, record folders, and records in the File Plan structure each have an appropriate set of actions. You can access the actions by hovering over an item in the File Plan or by clicking on an item name. Use these actions to manage the File Plan.
  • Automating the File Plan [57] In the File Plan you can define category and folder rules to manage your content automatically. You can come up with many creative solutions to make sure specific content processes are automated so you don't have to do the work yourself.
  • Searching records [58] You can use the Records Search to quickly search the File Plan to find records, and save your search query to use again.
  • Auditing and reporting [59] You can view audit logs for record categories, record folders, and records, and whenever a record or folder is transferred, added to a hold, accessioned, or destroyed, you can file a report to keep a record of the process.
Parent topic: Records Management [25]

Life cycle of a record

You can create a record either by uploading it to the Records Management File Plan, or by declaring a file in another Alfresco site as a record.

When you have added all required metadata to a record you can mark the record as complete. This makes it an active part of the File Plan, and subject to the rules of the retention schedule it is associated with.

It then goes through various time and event based steps such as cut off and retention, until it is eventually transferred elsewhere, or destroyed, according to its retention schedule.

Record Lifecycle

Parent topic: Getting started with Records Management [2]
Parent topic: Using Records Management [3]

The File Plan

The File Plan is a container for records, folders, categories and retention schedules. It's effectively a virtual filing cabinet for storing records, and is the basic structure of Records Management. This structure lets you classify and group records with similar characteristics.

The top level of the File Plan is created when you create a Records Management site. This is like an empty virtual filing cabinet - you then add drawers (categories), folders, and records to it.

File Plan

Remember that it's far more versatile than a physical filing cabinet, but the following rules are enforced when working with the File Plan structure:

  • The top level of the File Plan can only contain record categories.
  • A category can contain other categories and folders.
  • A folder can contain only records.

The structure of the File Plan will generally reflect different parts of your organization and can be made up of the following elements:

Record category
The record category contains the retention and retention schedules for its folders and records. In other words it controls how records are managed, and how they're disposed of when they're not needed any more.
Record folder
A record folder is created in a record category, and inherits the attributes of the record category. The record folder is considered to be under the control of the record category. Once the record folder is created, security restrictions apply. A record folder can be open or closed, and a closed record folder cannot accept records for filing.
Record
A record is a document in the File Plan. It's filed in a record folder, and is under the control of a record category.
Vital record
A vital record is a record that is considered to be essential to the operation of an organization. A vital record must be reviewed periodically, according to its review period. The review period is attached to the record category or folder.

You can create a File Plan structure from scratch or load the Records Management test data [60] to use as a starting point. This gives you a sample File Plan that you can rework to meet your needs.

You can also automate the File Plan by applying rules to categories and folders [61]. This means that records can be moved automatically through the record lifecycle, without you having to do any of the work.

  • Opening the File Plan [62] You can use the File Plan to manage, view, and work with records.
  • Browsing the File Plan [63] The File Plan consists of an explorer panel and a content list.
  • Building the File Plan [35] The File Plan is built up by adding levels made up of categories and folders.
Parent topic: Using Records Management [3]

Opening the File Plan

You can use the File Plan to manage, view, and work with records.
  1. Click File Plan in the Records Management site.

    The records list takes up most of the File Plan main page. You can filter the records list and navigate the File Plan using the explorer panel down the left side of the page.

  2. Use the Options menu to select how you want to view the library content, and the sorting options to sort records.
Note: It's recommended that you use the File Plan for Records Management actions rather than going through the repository.
Parent topic: The File Plan [55]

Browsing the File Plan

The File Plan consists of an explorer panel and a content list.

The explorer panel has the following sections:

Navigation
A tree view of the records management hierarchy. The icon indicates a category contains subfolders. Click the icon to view its contents.
File Plan
A list of transition types that records can be in. You can click these to view all matching records.
Saved Searches
A list of the saved searches. You can click these to view all matching records.

The location path above the content list shows your current position in the File Plan hierarchy. Each location path item is a link so you can easily return to any part of the current navigation path. Click Navigate Up to display the contents of the folder one level higher.

Use the sort menu to change the criteria used to sort the File Plan contents. You can toggle between ascending and descending sort order.

Parent topic: The File Plan [55]

Building the File Plan

The File Plan is built up by adding levels made up of categories and folders.
Only a few users have the capability to add folders and categories, and this is tightly controlled to make sure that your system remains compliant. Capabilities are assigned to user roles in the RM Admin Tools. You might be assigned the capability to create folders but not categories, or just have the capability to add records.
Note: Capabilities given to a role are not the same as permissions. Capabilities define what you can do in the Records Management site, whereas permissions are specific to sections of the File Plan. Permissions are applied at category and folder level using the Manage Permissions option, and you use these to decide which users can see specific sections of the File Plan, and if they can read and file in that section. See Managing permissions [64] for further details.

When you create a container (category or folder) the system records the date of creation and the user who created it. This information is recorded in the object's metadata. Metadata can be thought of as a set of properties, and are where all key information about an item, folder, or category is stored. Record categories carry the most metadata as they hold the retention instructions for the whole category.

The following rules are enforced when working with the File Plan structure:

  • The top level of the File Plan can only contain record categories.
  • A category can contain other categories and folders.
  • A folder can contain only records.
  • Loading test data [60] You can load Records Management test data which creates a sample File Plan that you can use to get started.
  • Adding a record category [29] You can create a record category at the top level in the File Plan or within another record category.
  • Adding a record folder [33] You can add record folders within a record category.
Parent topic: The File Plan [55]

Loading test data

You can load Records Management test data which creates a sample File Plan that you can use to get started.
Note: The test data is intended to give you an idea how a File Plan is structured. You don't need to load it if you don't want to.
  1. Click then Customize Dashboard.

    The Customize Dashboard page displays the current layout and configuration of your dashboard.

  2. Click Add Dashlets and drag and drop the RM Data Set Import dashlet onto the columns below:
  3. Click OK to save the dashboard configuration.

    The Import Data Set dashlet is added to the site dashboard.

  4. Select DOD 5015 Example Data from the Data Set menu on the new dashlet and click Import.

    A sample File Plan and associated data is imported to your Returns Management site. You can explore and edit the File Plan as you would with a plan you created from scratch.

Parent topic: Building the File Plan [35]

Adding a record category

You can create a record category at the top level in the File Plan or within another record category.
  1. In the File Plan go to the location for the new record category.
  2. Click New Category.

    The New Record Category dialog box displays.

  3. Enter details for the new category. Fields marked with an asterisk (*) are required.

    Metadata field Description
    Name* The name for the record category.
    Title* The title for the record category.
    Description A description of the record category.
    Record Category ID* A unique identifier for the record category is generated automatically. You can change this now, but you can't edit it once the category has been created.
    Vital Record Indicator Defines whether records in this category have a review process. The Vital Record Indicator is applied to all record folders within that category. You can change this at folder level.

    Users with Records Manager permissions receive a notification email when vital records are due for review.

    Period The time period for the review cycle. Reviews are recurring based on the period you select. The review period is required when the Vital Record Indicator option is selected.
    Note: The "Quarter" option splits the year into 4 sets of 3 months, beginning with Jan/Feb/March. "Financial Quarter" is the same but based on the start date of your system-configured financial year.
    The review period is displayed on the details page for folders and records in the category.
    Expression Enter a number as the Expression to accompany the Period type. If you enter “Week” and “3”, this would mean a review cycle of 3 weeks.

    If you select a Period that doesn't require an Expression then this field isn't available.

  4. Click Save.

    The new category displays in the File Plan.

Parent topic: Getting started for Records Managers [27]
Parent topic: Building the File Plan [35]

Adding a record folder

You can add record folders within a record category.
  1. Select a folder in the File Plan.
  2. Click New Folder.

    The New Record Folder dialog box displays.

  3. Enter details for the new category. Fields marked with an asterisk (*) are required.

    Metadata field Description
    Name* The name for the record folder.
    Title* The title for the record folder.
    Description A description of the record folder.
    Record Folder ID* A unique identifier for the record folder is generated automatically. You can change this now, but you can't edit it once the folder has been created.
    Location If relevant specify the physical location of the records contained within this folder.
    Supplemental Marking List If available, select any suitable properties from the list. Entries on this list are set up by your Alfresco administrator and are only available if you have been given the required permission.
    Vital Record Indicator Defines whether records in this folder have a review process. The Vital Record Indicator is applied to all records within the folder. You can change this at record level.
    Note: If you don't select this option and the category the folder is in has a Vital Record Indicator set, then the category setting will be applied to the folder once it is created.

    If you do select this option it will override any Vital Record Indicator set in the category.

    Users with Records Manager permissions receive a notification email when vital records are due for review.

    Period The time period for the review cycle. Reviews are recurring based on the period you select. The Review Period is required when the Vital Record Indicator check box is selected.
    Note: The "Quarter" option splits the year into 4 sets of 3 months, beginning with Jan/Feb/March. "Financial Quarter" is the same but based on the start date of your system-configured financial year. See Customizing the end of the financial year [37].
    The review period is displayed on the details page for records in the folder.
    Expression Enter a number as the Expression to accompany the Period type. If you enter “Week” and “3”, this would mean a review cycle of 3 weeks.

    If you select a Period that doesn't require an Expression then this field isn't available.

  4. Click Save.

    The new folder is now shown in the File Plan.

The new record folder is marked as Open, which means that records can be filed in it. The date of opening is the same as the creation date.

Parent topic: Getting started for Records Managers [27]
Parent topic: Building the File Plan [35]

Retention schedules

Retention schedules define how records are managed in the Records Management system until their eventual destruction or transfer to another location. The period between a record being completed and becoming part of the File Plan, and being destroyed/transferred is known as its retention period.

A retention schedule is attached to a record category, and once a file has been completed as a record it's subject to the rules of the retention schedule that's attached to the category it's in.

A retention schedule contains one or more steps that define a particular action to be carried out. These actions can be carried out after a period of time, after certain events, or a combination of the two.

The steps that can make up a retention schedule are:

Option Description
Cut off This is the first step in a retention schedule. Once a record is cut off this triggers the records retention period. You can't add records to a folder that's been cut off.
Retain This is an alternative first step that is a 'placeholder' step which delays the next retention step until after a selected time period or event.
Transfer Records are transferred from one location to another. This can be applicable to both electronic and non-electronic records, and will be used, for example, when transferring records from an organization to an archive.
Accession An advanced form of transfer usually involving the specific legal and physical transfer of records between organizations.
Destroy Electronic records are removed from the Records Management system and destroyed, and non-electronic records must be destroyed.
Note: You can add multiple steps to a retention schedule, but the first step must be either a Cut off or Retain action, and no steps can be added after the Destroy action.
When a retention schedule is created you specify whether its instructions are applied at folder or record level.
  • Folder level - you manage the folder through the retention schedule and all the records it contains are processed as a single entity.
  • Record level - records in a folder are managed individually through the retention schedule and can be at different stages of the retention process to other records in the folder.
Tip: When a record folder is cut off, this cuts off all individual records in the folder, regardless of their current state.

Retention steps can be manually completed once they are considered eligible (the time period has passed and/or the events have been completed), though the retain and cut off steps can be completed automatically by a system process that is run daily. All other retention steps must be completed manually, or by setting up a rule to complete them automatically. If a retention step is complete, then additional options are available for folders or records, dependant on whether the retention schedule is set to folder or record level, see Actioning retention steps [47].

  • Example of a retention schedule [65] Retention schedules can be set up to account for all different kinds of operational processes.
  • Creating a retention schedule [30] A retention schedule is created against and associated with a record category. First you create a summary of the schedule, then the steps in the schedule.
  • Creating retention schedule steps [31] When you've set up a retention schedule, you need to add retention steps. The steps give the retention schedule it's control over records and folders.
  • Editing a retention schedule [66] Once a retention schedule has been created you can go back and edit it at any point.
Parent topic: Using Records Management [3]

Example of a retention schedule

Retention schedules can be set up to account for all different kinds of operational processes.
Here is an example of the steps in a fairly straightforward retention schedule.

Records that are associated with this schedule will be cut off after one month in the File Plan. They will then be retained in the File Plan for two years or until they're no longer needed, whichever comes first. At that point they will then be destroyed.

Retention Schedule example

Parent topic: Retention schedules [36]

Creating a retention schedule

A retention schedule is created against and associated with a record category. First you create a summary of the schedule, then the steps in the schedule.
  1. Hover over a record category in the File Plan and click View Details.

    The category details page displays and if the category already has a retention schedule then you'll see the schedule summary and steps.

  2. Click Create Retention Schedule.
  3. In the General section, click Edit.
  4. Complete all fields:

    Field Description
    Retention Authority The authority that states how the record should be retained and disposed, for example Sarbanes-Oxley Act (SOX) or Corporate procedures.
    Retention Instructions A summary of the retention schedule.

    This information is not actively used but this text is displayed in the record category summary in the File Plan, and is important from a legal perspective.

    Applied to Record Folder: the retention schedule is applied to folders and all operations occur at the folder level. With this setting, you cannot manage records as individual units. If you cut off the folder, all records will be cut off.

    Record: the retention schedule is applied to records and all operations occur at the record level.

    Note: If you add folders to a category before setting up the retention schedule, then you can only select Record Folder.
  5. Click Save.

    The category details page now displays a summary of the new or updated retention schedule.

Next you need to add steps to the retention schedule.

Parent topic: Getting started for Records Managers [27]
Parent topic: Retention schedules [36]

Creating retention schedule steps

When you've set up a retention schedule, you need to add retention steps. The steps give the retention schedule it's control over records and folders.
  1. Hover over a record category in the File Plan and click View Details.

    The category details page displays showing the retention schedule summary.

  2. In the Retention Steps section, click Edit.

    The Edit Retention Schedule page displays.

  3. Click Add Step and select a retention action.

    Option Description
    Cut off This is the first step in a retention schedule. Once a record is cut off this triggers the records retention period. You can't add records to a folder that's been cut off.
    Retain This is an alternative first step that is a 'placeholder' step which delays the next retention step until after a selected time period or event.
    Transfer Records are transferred from one location to another. This can be applicable to both electronic and non-electronic records, and will be used, for example, when transferring records from an organization to an archive.
    Accession An advanced form of transfer usually involving the specific legal and physical transfer of records between organizations.
    Destroy Electronic records are removed from the Records Management system and destroyed, and non-electronic records must be destroyed.

    Note: You can add multiple steps to a retention schedule, but the first step must be either a Cut off or Retain action, and no steps can be added after the Destroy action.
  4. Select whether the action will be triggered after a period of time or when a specified event occurs:

    Option Description
    After a period of Select the time period after which the step action will take place.
    Note: If you select XML Duration from the Period Type drop down list you can specify a time interval using XML syntax.

    The syntax should take the form of:

    P = Period (required)

    nY = Number of years

    nM = Number of months

    nD = Number of days

    T = Start time of a time section (required if specifying hours, minutes, or seconds)

    nH = Number of hours

    nM = Number of minutes

    nS = Number of seconds

    For example, 'P2M10D' represents two months and ten days.

    Created Date = The date when the file or record is first added to Alfresco.

    Retention Action = The date when the last retention action took place. Don't select this for the first step in the schedule.

    The "Quarter" option splits the year into 4 sets of 3 months, beginning with Jan/Feb/March. "Financial Quarter" is the same but based on the start of your system-configured financial year. See Customizing the end of the financial year [37].
    When event happens Select the event after which the step action will take place.

    Most events must be completed manually in the record details page, or you can use rules to automatically complete these events.

    The Obsolete, Superseded, and Related Record Transferred To Inactive Storage events are automatically completed when relevant relationships are set up between records [38].

    Note: You can select both options, or multiple events, and have the action triggered by Whichever event is earlier or When all events have happened.

    The date selected here is displayed as the Retention as of date in the details page for records or folders, depending on which the retention applies to. If you select an event then this field will display None, and you should complete the event on the details page.

  5. If you added a Destroy step then there is an additional Keep record metadata after record destruction option. If you select this option then destroyed records are still represented in the File Plan rather than being completely deleted. An audit trail and metadata remain but the records can't be accessed.

    Note: The metadata is maintained indefinitely unless it is manually deleted from the File Plan by someone with the ALFRESCO_ADMINISTRATOR role, or another role that has been given permissions to delete the metadata.
  6. Enter a Step Description.
  7. Click Save.

    Tip: You can click the Edit icon edit icon or Delete icon delete icon next to a step to edit or delete it.
  8. When you've entered all the required steps click Done.
You return to the category details page, which displays the retention steps. Click View Description to the right of a step to display the description.

Parent topic: Getting started for Records Managers [27]
Parent topic: Retention schedules [36]

Editing a retention schedule

Once a retention schedule has been created you can go back and edit it at any point.
  1. Hover over a record category in the File Plan and click View Details.

    The category details page displays and if the category already has a retention schedule then you'll see the schedule summary and steps.

  2. In the General section click Edit to edit the basic details, or click Edit in the Retention Steps section to edit, add, or delete steps.
  3. When you've finished click Done.
Parent topic: Retention schedules [36]

Managing permissions

To ensure the security of your Records Management system you can easily manage user permissions to control which users and groups can see and work in different sections of the File Plan.
In Alfresco Records Management there are 2 different methods for managing what users can and can't do:
  • Roles and capabilities are managed by the Alfresco administrator, and control the actions users have within the File Plan, such as the ability to create record categories or record folders.
  • User permissions are managed at folder and category level, and control whether users can read and file or just read.
User permissions aren't granted by default. If a user hasn't been given permission to read a folder or category, then they won't see it in the File Plan. Only Records Management Administrators are granted access to all areas of the File Plan by default.

By managing your user permissions you can create restricted areas of the File Plan that are only available to selected users. For an area that all users should have access to, you need to make sure that all users have been given permission to see it.

  • Setting user permissions [34] Setting user permissions on folders and categories lets you control who can see and work in different areas of the File Plan.
Parent topic: Using Records Management [3]

Setting user permissions

Setting user permissions on folders and categories lets you control who can see and work in different areas of the File Plan.
Tip: Remember that until you have given users permission for a folder or category they won't be able to see it or work with its contents.
  1. Click Manage Permissions when you're in the folder or category you want to set permissions for in the File Plan.

    Tip: You can also hover over a folder in the File Plan and click More then Manage Permissions, or a category in the File Plan and click Manage Permissions.

    The Manage Permissions page opens with the name of the selected folder or category displayed. Any users and groups that currently have permissions assigned are also displayed. You can change existing user permissions or Remove them entirely.

  2. Click Add User or Group.
  3. Enter the name of an individual user, a group, or a Records Management role and click Search.

    All users, groups, and roles matching the search are displayed.

  4. Click Add next to the user, group, or role that you want to add permissions for.

    Tip: You can add permissions for as many users, groups, and roles as you want.
  5. Select either Read and File or Read Only.

    Read and File allows users to work with content, whereas users with Read Only permission can only view content.

  6. When you're finished click Save to return to the File Plan.

    The permissions you've set are now applied to the folder or category you selected and any folders or categories it contains. You can change these as needed on a folder or category basis.

Parent topic: Getting started for Records Managers [27]
Parent topic: Managing permissions [40]

Filing records

Filing records is the process of classifying records and putting them into the correct location in the File Plan.
There are three ways that you can create records:
  • Create a record by uploading files
  • Create a non-electronic record that references a physical record such as a paper record or microfilm
  • Select an item in another Alfresco site (non-Records Management) and declare it as a record
Note: You can also import folders, categories, and even entire File Plans, and any records that they contain, see Exporting and importing File Plan content [67].

Your Alfresco administrator can also set up your system so that emails to specified addresses are captured and stored as records

A record is not considered to be complete until all the required metadata has been added to it. You select Edit Metadata to complete required metadata.

In DoD 5015.2-STD compliant Records Management sites you can also select to Add Record Metadata and associate the file with a record type, so that when you edit metadata there is type-specific metadata to add.

Once that's done you can select to Complete Record and it will be subject to the retention rules that apply to the folder you've placed it in.

Note: When you set up a record category or folder you can specify that it will be used to hold Vital Records. A vital record must be reviewed on a periodic basis, as defined on the record category or folder.
  • Filing an electronic record [41] Electronic records are files that are uploaded to a records folder. Non-electronic records might be paper files that can be stored in a physical location.
  • Filing a non-electronic record [68] Non-electronic records might be paper files that can be stored in a physical location. Filing a non-electronic record in the File Plan means the file can be traced and details of where it is physically stored can be recorded.
  • Filing an unfiled record [43] When you've declared a record from a non-Records Management site it's added to the Unfiled Records area. You now need to add it to a records folder.
  • Adding record metadata [44] All records in the File Plan have metadata, which you can think of as records properties.
  • Editing record metadata [45] You can edit record metadata to add information to a record.
  • Requesting record information [69] If you need additional information to complete a record, you can request this from other users.
  • Completing a record [46] Content added to the File Plan must be set to complete before it is recognized as a record.
Parent topic: Using Records Management [3]

Filing an electronic record

Electronic records are files that are uploaded to a records folder. Non-electronic records might be paper files that can be stored in a physical location.
  1. In the record folder where you want to file a record click File.
  2. Click Electronic.
  3. Click Select Records to File and find the file that you want to upload.

    Tip: You can also select multiple items in the standard multi-select way.
    The files are uploaded as record and display in the File Plan as incomplete records. You need to make sure any required metadata is added before you can set records to complete.

Parent topic: Getting started for Records Management Users [28]
Parent topic: Filing records [48]

Filing a non-electronic record

Non-electronic records might be paper files that can be stored in a physical location. Filing a non-electronic record in the File Plan means the file can be traced and details of where it is physically stored can be recorded.
  1. In the record folder where you want to file a record click File.
  2. Click Non-electronic.
  3. Enter details for the file you are making a record of.

    Only the Name and Title are required, but you should enter enough information so that the record will be recognized by other users.

  4. Click Save.

    A new record is created and displays in the File Plan as an incomplete record. You need to make sure any required metadata is added before you can set records to complete.

Parent topic: Filing records [48]

Filing an unfiled record

When you've declared a record from a non-Records Management site it's added to the Unfiled Records area. You now need to add it to a records folder.
  1. Click the Unfiled Records area on the explorer panel on the left of the page.

    All unfiled records are displayed.

    Note: You can add additional folders to the Unfiled Records area to create a folder hierarchy to help manage unfiled records. You can also declare items as records directly from within the Unfiled Records area structure.
  2. Hover over an unfiled record and click More then File to....
  3. Select a records folder to file the record in then click File.

    Note: There are multiple other actions available including Reject so you can reject the record from the File Plan, and Move to so you can move the record to another location in the Unfiled Records hierarchy.
The record's added to the File Plan, and if you haven't already you can now go and edit metadata.

Parent topic: Getting started for Records Management Users [28]
Parent topic: Filing records [48]

Adding record metadata

All records in the File Plan have metadata, which you can think of as records properties.
If you associate the record with a specific type by selecting the Add Record Metadata option then additional metadata options are required for the record. You need to complete all the required metadata before you can set a record to complete.

The Add Record Metadata option is only available in DoD 5015.2-STD compliant Records Management sites.

Note: Adding record metadata isn't mandatory, but can be useful to allow additional metadata to be added against a file.
  1. Hover over an incomplete record in the File Plan and click More then Add Record Metadata.

    Tip: For non-electronic records the Add Record Metadata is available as soon as you hover over them, you don't need to click More.

    The available record types are displayed.

  2. Select the appropriate record type.
    Record type Description
    Web Record A web page.
    Scanned Record A file that is scanned into the Records Management system.
    PDF Record A PDF file.
    Digital Photograph Record A photographic image file.

    Tip: You can select multiple items in the standard multi-select way.
  3. Click OK.

    Some record metadata is mandatory. Before you can complete a record, you must edit the metadata to complete the mandatory fields.

Icons next to the record show the record types that it's been associated with. Hover over an icon to display the record type.

Parent topic: Getting started for Records Management Users [28]
Parent topic: Filing records [48]

Editing record metadata

You can edit record metadata to add information to a record.
Before you can complete a record, you must enter any required details about the record in the metadata. You can't edit record metadata after you have set the record to complete.
  1. Hover over a record in the File Plan and click Edit Metadata.

    The Edit Metadata page displays. The metadata fields you see on this page depend on the file type, and whether or not record types have been associated with the file. The metadata is divided into sections, with additional sections dependant on if a record type has been associated with the item.

  2. Enter the record metadata. Fields marked with an asterisk (*) are required.

    If your Records Management system is DoD 5015.2-STD compliant then every file includes the DOD5015 Record section, which is a default set of basic metadata fields. The default record metadata fields are:

    Record
    Publication date* The date that the record is published. Select the date from the calendar selection box.
    Originator* The person or department in the originating organization.
    Originating Organization* The organization that created the record.
    Media Type The general media type such as audio, video, or document.
    Format The format in which the record is stored, such as electronic or physical file.
    Date received The date that the record was received from the originator.
    Addressee The email address of the originating organization to be used for correspondence.
    Other Addressee The secondary recipients of the message (CC).
    Location The physical location of the record, generally only applicable to non-electronic records.
    Supplemental Marking List Any additional properties applicable to the record. This list is defined by the Alfresco administrator in the List of Values in the RM Admin Tools.

    This is available in both standard and DoD 5015.2-STD compliant File Plans.

    You can't save this page until you complete any required fields.

  3. Click Save.

Parent topic: Getting started for Records Management Users [28]
Parent topic: Filing records [48]

Requesting record information

If you need additional information to complete a record, you can request this from other users.
  1. Hover over a record in the File Plan and click More then Request Information.
  2. Click Select and select a user or group to request the information from.
  3. Enter details of what you need in the Requested information box.
  4. Click Request Information.

    A task will be assigned to the selected user and will show in their My Tasks dashlet. Once they mark the task as done the information they provide will be shown in a task assigned to the user who requested the information. Access the information through your My Tasks dashlet and click Task Done to close the information request.

Parent topic: Filing records [48]

Completing a record

Content added to the File Plan must be set to complete before it is recognized as a record.
Hover over an incomplete record in the File Plan and click Complete Record.

Tip: Incomplete records are marked.

If a record has mandatory metadata that hasn't been completed then a message lets you know that required metadata is missing.

Once a record is completed, it comes under the control of the record category it is filed under, and security restrictions apply.
Note: A record can be filed in multiple categories, see Linking records [50] for more details.

Parent topic: Getting started for Records Management Users [28]
Parent topic: Filing records [48]

Easy access records

In many cases you might want to create records from files that already exist in Alfresco, rather than creating a record from scratch.

With Alfresco Records Management you can declare files in non-Records Management site as records. When you create an "easy access record", a record of the file is added to the Records Management site. The file is still visible in its original site, identified by the Easy access record icon, but is locked and with a limited set of actions available.

This means that most users never need to think about records, file plans, or retention schedules. They just declare the file as a record, and the rest is handled by the Records Administrator and any rules that they've set up.

When a record is created from a file it's added to the Unfiled Records area of the Records Management site. A Records Manager then has numerous options for Filing an unfiled record [43] and Managing unfiled records [70]

There are three options available for declaring files as records:
  • Declare as Record

    A file declared as a record is added to the Unfiled Records area, in the explorer panel of the Records Management site.

    It's still visible in its original site as an easy access record, identified by the Easy access record icon, but is locked and with a limited set of actions available.

  • Declare Version as Record

    The version of a file declared as a record is added to the Unfiled Records area, in the explorer panel of the Records Management site, and is identified there as a version record by the Version record icon.

    It's still available in its original site, with a full set of actions available.

  • Auto-Declare Options

    Each time a new major or minor version of the file is created, the version is declared as a record and added to the Unfiled Records area, in the explorer panel of the Records Management site. It's identified there as a version record by the Version record icon.

    It's still available in its original site, with a full set of actions available, identified by the Major revisions major versions icon or the All revisions all versions icon.

    Note: Your Alfresco Administrator can choose to only make these options available to certain users only. If they've done this then you'll need to be a member of the RECORD_CONTRIBUTORS group for these options to be available.

    And as with standard Alfresco functionality you need to have the required permissions before you can do anything with files.

You can see version details of records created from versions in the file preview screen on the Records Management site. When records are created from versions of the same file, a relationship between the records is automatically created.

You can also classify a file [71] and declare it as a record at a later date, and it will keep any classifications applied.

  • Classifying files and folders [71] You can classify files and folders and apply security marks so that they can only be viewed or accessed by users who have the required security clearance.
  • Declaring a file as a record [42] You can create records from files in non-Records Management sites and add them straight into the File Plan.
  • Declaring a file version as a record [72] When files are updated in Alfresco, a new version number of the file is created. You can declare one or more of these versions as records, allowing you to keep on record changes that have been made throughout the life cycle of a file.
  • Setting auto-declare options [73] You can set up auto-declare option for files so that major and minor version numbers will automatically be declared as records.
  • Moving easy access records [74] Although easy access records have most of their options removed, you can still move them to a different place in their originating site.
  • Hiding easy access records [75] Once a file has been declared as a record, you have the option to hide it from its originating site.
  • Rejected records [76] After you've created a record from a file, the Records Manager has the option to reject the record from the Records Management site.
Parent topic: Using Records Management [3]

Classifying files and folders

You can classify files and folders and apply security marks so that they can only be viewed or accessed by users who have the required security clearance.
There are four security classification levels you can assign. Security groups provide additional classification options.
Note: You can also classify records [77] in the File Plan.

See Classification rules and tips [78] for more on classifying content.

You can autoclassify by by adding instructions, manually apply classifications and security marks, or both.

  1. In the Document Library of an Alfresco site hover over a file or folder and select More, then Classify.

    You can classify using both Security Classification and Security Groups. You'll only see the classification options that you have security clearance for.

To autoclassify:

  1. Click Add Instructions.
  2. Click on a guide to view its topics.
  3. Click Add instructions next to the topic you want to apply instructions from then click Select.

    Tip: You can click View to check what classification level and security marks the topic instructions contain.
  4. Repeat for as many topics as you want to add.
  5. Click Apply.

    All the topics you've selected will have their instructions applied to the item you're classifying.

    Tip: If topics contain instructions that clash then the higher level of classification will apply. For example if you add two topics, one with a classification level of Top Secret, and one with Secret, then the Top Secret level will apply.

To manually add classifications and security marks:

  1. Select a classification from:

    • Top Secret
    • Secret
    • Confidential
    • Unclassified
    Tip: If you select Unclassified then the item will be available to all users.
  2. Enter a classification agency, for example, government or other body (optional).
  3. Select one or more classification reasons from the list of available reasons.
  4. You can optionally set a Downgrade Schedule or a Declassification Schedule.

    Downgrade Schedule

    Set a schedule for when the item will be downgraded, for example, from Top Secret to Secret. You can enter a specific date for the downgrade to take place, an event that means a downgrade should be considered, and instructions on how to carry out the downgrade. All of these are optional, but once you've entered a downgrade date, event, or both, you're required to enter instructions.

    Declassification Schedule

    Set a schedule for when the file will be declassified. These means when its classification level will be set to Unclassified. You can enter a specific date for the declassification to take place, an event that means declassification should be considered, and exemptions for when declassification shouldn't take place. All of these are optional.

    Note: Downgrade and declassification schedules are not automated. Any reclassification needs to be done manually.
  5. Click security marks to apply them to the item, and again to remove them.

    See How security controls work [79] for more details.

  6. Click Classify.

    The item now displays its classification level, and can only be seen by those with the required security clearance.

    Tip: Items set to Unclassified with no applied security marks can be seen by all users.
    The option to Share the file is no longer available for Top Secret, Secret, or Confidential items. When a file or folder is declared as a record it retains its classification level and any security marks.

    The classification reason and classification-related properties can be seen in the Properties when you preview the file.

    Note: When you classify a file it isn't added to the Records Management site File Plan. If you want to create a record from it you still need to declare the file as a record [80].

    If you delete a classified file then it's permanently deleted and isn't available in your Trashcan. If you delete a classified folder then all of its content is permanently deleted, even items that haven't been directly classified themselves.

Parent topic: Easy access records [49]

Declaring a file as a record

You can create records from files in non-Records Management sites and add them straight into the File Plan.
  1. In the Document Library of an Alfresco site find the file you want to declare as a record.
  2. Hover over the file and click More then Declare as Record.

    The file is added to the Unfiled Records area, in the explorer panel of your Records Management site. It's still visible in its original site, identified by the Easy access record icon, but is locked and with a limited set of actions available.

    Note: You can't declare a record if your permission level for the site is Consumer, or if the file is locked.

    A file that has been declared as a record can be deleted. The records remain in the File Plan.

This record can now be filed in the File Plan. You can find it in the Unfiled Records area in the File Plan explorer panel. New records display in the File Plan as incomplete records. You need to make sure any required metadata is added before you can set records to complete.
Note: You can also set up folder rules in a non-Records Management site so the files can be automatically declared as records. For example, you could create a rule that when a file is tagged as "Confirmed", then a record will be created of that file and added to the Records Management site.

Parent topic: Getting started for Records Management Users [28]
Parent topic: Easy access records [49]

Declaring a file version as a record

When files are updated in Alfresco, a new version number of the file is created. You can declare one or more of these versions as records, allowing you to keep on record changes that have been made throughout the life cycle of a file.
  1. In the Document Library of an Alfresco site find the file you want to declare a version of as a record.

    Tip: You can see a file's version history by clicking on the file, then in the file preview screen scrolling down to the Version History section. You can revert to previous versions by clicking the Revert version icon.
  2. Hover over the file and click More then Declare Version as Record.

    The file is added to the Unfiled Records folder, in the explorer panel of your Records Management site, and is identified there as a version record by the Version record icon. The file is still available in its original site, with a full set of actions available.

    Note: You can't declare a version as a record if your permission level for the site is Consumer, or if the file is locked, or synced with an Alfresco in the Cloud site.
You can find these records in the Unfiled Records folder in the File Plan explorer panel. New records display in the File Plan as incomplete records. Any required metadata needs to be added before the records can be set to complete.
Note: A file that has had versions declared as records can be deleted. The records remain in the File Plan.

If you delete or destroy a record that was declared from a version, then that version is marked as deleted and can't be accessed. Other versions of the file remain unaffected.

Tip: You can also set up folder rules in a non-Records Management site so the file versions can be automatically declared as records. For example, you could create a rule that when a file is tagged as "Confirmed", then a record will be created of that file version and added to the Records Management site. Version details will be available when looking at the record in the file preview screen on the Records Management site.
Parent topic: Easy access records [49]

Setting auto-declare options

You can set up auto-declare option for files so that major and minor version numbers will automatically be declared as records.
Auto-declare options are set on a file by file basis, though you can set up a folder rule and apply auto-declare settings to multiple files.
  1. In the Document Library of an Alfresco site find the file you want to set auto-declare options for.
  2. Hover over the file and click More then Auto-Declare Options.

    The Set Auto-Declare Options screen opens with the default setting of Never.

  3. Select to automatically declare versions as records:

    • For major versions only

      Each time a new major version of the file is created, the version is declared as a record and added to the Unfiled Records area, in the explorer panel of your Records Management site. It's identified there as a version record by the Version record icon. In its originating site it'll display the Major revisions icon, and the Easy access record icon next to each recorded version in the Version History section of the file preview screen.

    • For all major and minor versions

      Each time a new major or minor version of the file is created, the version is declared as a record and added to the Unfiled Records area, in the explorer panel of your Records Management site. It's identified there as a version record by the Version record icon. In its originating site it'll display the All revisions icon, and the Easy access record icon next to each recorded version in the Version History section of the file preview screen.

  4. Click OK to save these settings.

    You can change the settings whenever you need to, but any records already created will be unaltered.

From this point forwards, each time a new version of the file is saved, a record is automatically created from the version and can be filed in the File Plan. You can find them in the Unfiled Records area in the File Plan explorer panel. New records display in the File Plan as incomplete records. Any required metadata needs to be added before the records can be set to complete. Version details will be available when looking at the record in the file preview screen on the Records Management site.
Note: A file that has had versions declared as records can be deleted. The records remain in the File Plan.

Parent topic: Easy access records [49]

Moving easy access records

Although easy access records have most of their options removed, you can still move them to a different place in their originating site.
This can be useful if you want to keep files that have been declared as records in a dedicated part of a site.
  1. In the Document Library of an Alfresco site find a file that's been declared as a record.
  2. Hover over the file and select Move Record.
  3. Choose the folder where you want to place the content.

    Files that have been declared as records can be moved to anywhere in their current site, but cannot be moved to a different site.

  4. Click Move.

    The file is moved to it's new location in the site. The record of the file in the Records Management site is unaffected.

Parent topic: Easy access records [49]

Hiding easy access records

Once a file has been declared as a record, you have the option to hide it from its originating site.

This can help to avoid any confusion with site members trying to work with files that have been declared as records.

Once hidden, the record created from the file is available as usual in the Records Management site, but in its originating site it's no longer available in the document library.
  1. In the Document Library of an Alfresco site find a file that's been declared as a record.
  2. Hover over the file and select Hide Record.
  3. Click OK to confirm that you want to hide the record.

    The record's now hidden from the Document Library. Once a record has been hidden it can't be unhidden. If a record is rejected from the Records Management site then it will become visible again with a warning that it's been rejected.

Parent topic: Easy access records [49]

Rejected records

After you've created a record from a file, the Records Manager has the option to reject the record from the Records Management site.
If they reject the record then the original file will display a warning that it's a Rejected Record. At this point the options to declare the file as a record aren't available. You can:
  • Click Rejected record reason to view the reason why the record was rejected.
  • Click Remove rejected warning to remove the rejection warning. The options to declare the file as a record are now available again.

Parent topic: Easy access records [49]

Managing the File Plan

The record categories, record folders, and records in the File Plan structure each have an appropriate set of actions. You can access the actions by hovering over an item in the File Plan or by clicking on an item name. Use these actions to manage the File Plan.
Note: The standard Alfresco Copy to, Move to and renaming options are available for record categories, record folders, and records. See Keeping your library organized [81] for further details.
  • Managing record categories [82] There are various options available to help you manage record categories. These are available to users with the appropriate capabilities.
  • Managing record folders [51] There are various options available to help you manage record folders. These are available to users with the appropriate capabilities.
  • Managing records [52] There are various options available to help you manage record. These are available to users with the appropriate capabilities.
  • Managing records holds [83] You can add records and folders to a hold to freeze them and suspend their retention schedules.
  • Exporting and importing File Plan content [84] You can quickly and easily import and export Records Management content, from individual record folders through to an entire File Plan.
Parent topic: Using Records Management [3]

Managing record categories

There are various options available to help you manage record categories. These are available to users with the appropriate capabilities.
In the File Plan hover over a record category to display the available actions:

Action Select this to...
View Details View the record category details page, where you can see the metadata and a full list of actions.
Edit Metadata Edit the record category metadata.
Manage Permissions Set the user and group access for the category.
Copy to Create a copy of the category in another location in the File Plan.
Move to Move the category to another location in the File Plan.
Delete Delete the category from the File Plan.
View Audit Log View the auditing information for the category. The Audit Log displays the activity information and has options to export and file as a record.
Manage rules Create and edit rules so that category content is managed automatically.
  • Viewing record category details [85] The record category details page gives you access to the actions available to be performed on the category, the custom metadata, the retention schedule, and the category URL.
  • Editing a record category [86] You can edit a record category if you need to make any changes to its metadata.
  • Deleting a record category [87] When you don't need a record category any more you can delete it.
Parent topic: Managing the File Plan [56]

Viewing record category details

The record category details page gives you access to the actions available to be performed on the category, the custom metadata, the retention schedule, and the category URL.
  1. Hover over a record category in the File Plan and click View Details.

    The details page displays. On this page, you can see the metadata, the retention schedule, and the available actions in the Actions list.

    If no retention schedule has been set for the record category, you create it here. If a retention schedule exists, you can edit it.

    Where a retention schedule exists, click View Description in the Retention Steps section to display the description for a particular step.

  2. Click the location link above the record category name to return to the File Plan.
Parent topic: Managing record categories [82]

Editing a record category

You can edit a record category if you need to make any changes to its metadata.
  1. Hover over a record category in the File Plan and click Edit Metadata.

    The Edit Metadata page displays.

  2. Edit the metadata details as necessary.
  3. Click Save.
Parent topic: Managing record categories [82]

Deleting a record category

When you don't need a record category any more you can delete it.
  1. Hover over a record category in the File Plan and click Delete.

    A confirmation dialog box displays.

  2. Click Delete.

    The record category is removed from the Records Management system.

    Important: This will also delete the folders and records within the record category.
Parent topic: Managing record categories [82]

Managing record folders

There are various options available to help you manage record folders. These are available to users with the appropriate capabilities.
In the File Plan hover over a record folder to display the available actions. The standard actions available are shown. Additional options are available dependant on the stage a folder is at in the retention schedule. See the relevant topics for further details.

Action Select this to...
View Details View the record folder details page, where you can see the metadata and a full list of actions.
Edit Metadata Edit the record folder metadata.
Close Folder Close the folder. A closed record folder cannot accept records for filing. When you close the folder, this action toggles to the Re-open Folder action.
Edit Retention Date If a folder is subject to a folder level retention schedule, you can review the retention date for the next step in the retention schedule that applies to the folder.
Review All Mark all vital records in a folder as having been reviewed.
Add to Hold Hold the folder. You can view on hold folders in the Holds area on the explorer panel. When you hold the folder, this action toggles to the Remove from Hold action.
Copy to Create a copy of the folder in another location in the File Plan.
Move to Move the folder to another location in the File Plan.
Manage Permissions Set the user and group access for the folder.
Delete Delete the folder from the File Plan.
View Audit Log View the auditing information for the folder. The Audit Log displays the activity information in a new window and has options to export or file this information as a record.
Manage rules Create and edit rules so that folder content is managed automatically.

Note: When the folder is closed or on hold, a limited set of actions is available.
  • Viewing record folders [88] The record folder details page gives you access to the actions available to be performed on the folder, the custom metadata, and the folder URL.
  • Editing a record folder [89] You can edit a record folder if you need to make any changes to its metadata.
  • Completing folder events [90] If a retention schedule has event-based steps, then you need to complete those events before the schedule can move on to the next step. Some steps are automatically completed but most of them you need to complete manually.
  • Editing a folder retention date [91] If a folder is subject to a folder level retention schedule, you can review the retention date for the next step in the retention schedule that applies to the folder. This is done at folder level only and does not affect the retention schedule.
  • Processing records [47] Retention steps are generally completed manually, though retain and cut off steps can be completed automatically by a system process that is run daily. You can also set up a rule to complete steps automatically.
  • Adding record folders to a hold [92] Users with the appropriate capabilities can add records and folders to a hold.
  • Closing a record folder [93] Users with the appropriate capability (Folder Control) can close folders. Closed folders cannot accept any further records.
  • Deleting a record folder [94] When you don't need a record folder any more you can delete it.
Parent topic: Managing the File Plan [56]

Viewing record folders

The record folder details page gives you access to the actions available to be performed on the folder, the custom metadata, and the folder URL.
  1. Hover over a record folder in the File Plan and click View Details.

    The details page displays. On this page, you can see the metadata and the available actions in the Actions list.

  2. Click the location link above the record folder name to return to the File Plan.
Parent topic: Managing record folders [51]

Editing a record folder

You can edit a record folder if you need to make any changes to its metadata.
  1. Hover over a record folder in the File Plan and click Edit Metadata.

    The Edit Metadata page displays.

  2. Edit the metadata details as necessary.
  3. Click Save.
Parent topic: Managing record folders [51]

Completing folder events

If a retention schedule has event-based steps, then you need to complete those events before the schedule can move on to the next step. Some steps are automatically completed but most of them you need to complete manually.
  1. Click the title of a folder in the File Plan.

    The record details page is displayed. All incomplete events for the current schedule step are displayed.

  2. Click Complete Event.
  3. In the complete Event box select a date and time for the completion of the event..
  4. Click OK.
When all incomplete events are complete the folder can move onto the next step in the schedule.
Parent topic: Managing record folders [51]

Editing a folder retention date

If a folder is subject to a folder level retention schedule, you can review the retention date for the next step in the retention schedule that applies to the folder. This is done at folder level only and does not affect the retention schedule.
  1. Hover over a folder in the File Plan and click More then Edit Retention Date.

    The Edit Retention Date dialog box displays. The current retention date is highlighted.

  2. Select a new retention date and click Update.

    A message displays confirming that the retention date is updated. This overrules any review dates set in the retention schedule.

Parent topic: Managing record folders [51]

Processing records

Retention steps are generally completed manually, though retain and cut off steps can be completed automatically by a system process that is run daily. You can also set up a rule to complete steps automatically.
If a retention step is complete (the time period is finished or the required events have been completed), then additional options are available for folders or records, dependant on whether the retention schedule is set to folder or record level.

If you apply an action to a folder then it will also be applied to all records within the folder.

Hover over a folder/record in the File Plan and click the action that is available to move to the next step in the retention schedule.

Action Select this to...
Cut off Cuts off the record/folder and triggers the retention period. Records can't be added to a folder that's been cut off.
End Retention Ends the retention period for the record/folder.
Transfer Transfers the record/folder to the previously specified location. An audit trail and metadata is retained.

By default transferred records/folders are temporarily held in the Transfers area of the File Plan until you hover over them and click Complete Transfer.

Accession Transfers the record/folder to the previously specified location. An audit trail and metadata is retained.

This usually involves the specific legal and physical transfer of records between organizations.

By default accessioned records/folders are temporarily held in the Transfers area of the File Plan until you hover over them and click Complete Transfer.

Destroy Removes the record/folder content from the Records Management system. If the Maintain record metadata after destroy option is selected in the retention schedule, then a visual representation of the record, an audit trail, and metadata is retained in the File Plan.

If the record was declared from a file in an Alfresco site then the file is also removed.

Note: Each time you manually run an action, that option is replaced with the next action step in the retention schedule, and a new option for undoing the step you've just done, for example, Undo Cut Off.

Icons next to the record/folder indicate their current stage in the schedule.

Parent topic: Getting started for Records Management Users [28]
Parent topic: Managing record folders [51]
Parent topic: Managing records [52]

Adding record folders to a hold

Users with the appropriate capabilities can add records and folders to a hold.
A hold allows objects on hold for a particular reason to be tracked as a set. Holds prevent changes to on hold objects, which have their retention schedules suspended until the hold is removed.
Note: When you add a folder to a hold, all records within the folder are also added to the hold. The records can't be removed from the hold individually, they can only be removed from the hold by removing the entire folder.
  1. Hover over a record folder in the File Plan and click More then Add to Hold.

    The Add to Hold screen displays.

    Note: This option isn't available if no holds have been set up in the Holds area or you don't have permission to put records on the existing holds.
  2. Select one or more holds and click OK.

    A message displays confirming that the folder is on hold, and the folder now displays the Frozen icon.

    Note: Records and folders remain on hold until they have been removed from all holds they're added to.
The folder remains in its' place in the File Plan. It is also shown in the Holds area of the explorer panel.
Note: To remove a record folder from a hold hover over it in the File Plan or the Holds area and select Remove from Hold.
Parent topic: Managing record folders [51]

Closing a record folder

Users with the appropriate capability (Folder Control) can close folders. Closed folders cannot accept any further records.
Hover over a record folder in the File Plan and click Close Folder.

A message displays confirming that the folder is closed.

Note: The action for this folder changes to Re-open Folder, which allows the folder to be reopened.
Parent topic: Managing record folders [51]

Deleting a record folder

When you don't need a record folder any more you can delete it.
  1. Hover over a record folder in the File Plan and click Delete.

    A confirmation dialog box displays.

  2. Click Delete.

    The record folder is removed from the Records Management system.

    Note: This will also delete the records within the record folder.
Parent topic: Managing record folders [51]

Managing records

There are various options available to help you manage record. These are available to users with the appropriate capabilities.
In the File Plan hover over a record to display the available actions. The standard actions available are shown. Additional options are available dependant on the stage a record is at in the retention schedule. See the relevant topics for further details.

Action Select this to...
Download Download the file to your computer.
Edit Metadata Edit the metadata for the record.
Complete Record Declare the file as a record. All required metadata fields must be complete. When you declare the file as a record, this action toggles to the Reopen Record action.
Reviewed Marks a vital record as reviewed.
Reopen Record Revert the item back to an incomplete record.
Add Record Metadata Associate an undeclared record with one or more record types.

This option is only available in DoD 5015.2-STD compliant Records Management sites.

Add to Hold Hold the record. You can view on hold records in the Holds area on the explorer panel. When you hold the record, this action toggles to the Remove from Hold action.
Copy to Create a copy of the record in another location in the File Plan.
Move to Move the record to another location in the File Plan.
File to File an unfiled record to the File Plan.
Link to File a record in multiple locations in the File Plan and create a link. This gives the appearance of duplicating the record in another location, though actually there is just one record stored in multiple folders. Changes made to the record in one location will be reflected in the other locations.
Unlink Record Available for records that have been linked from another record, you can unlink the record. This will remove it from the folder it was linked to.
Delete Delete the record from the File Plan.
View Audit Log View the auditing information for this record. The Audit Log displays the activity information in a new window and has options to export or file this information as a record.
Reject Reject an unfiled record. If you select to reject a record then you need to enter a reason for the rejection. This reason be viewed when looking at the file the record was created from in it's originating site.
Request Information Request further information about a record from other users. This is only available for incomplete records.
Manage Permissions Use the Manage Permissions option to control user permissions for records.
Add Relationship Add a relationship between records such as a cross-reference or obsoleted by.

When a record has been completed not all of these actions will be available.

When the record is on hold (identified by the Frozen icon), a limited set of actions is available.

Vital records display the Vital record icon.

  • Viewing records [95] The record details page gives you access to the actions available to be performed on a record, the custom metadata, references to and from other records, and the record URL.
  • Linking records [96] You can link records to a folder other than the one they're filed in to file them in multiple locations in the File Plan.
  • Creating relationships between records [97] You can add relationships to records to create a connection between them. This can be useful, for example, to track records that have been superseded or obsoleted.
  • Reviewing vital records [98] If you've set up a review period for vital records in the record category or folder, you can review this for individual records.
  • Managing unfiled records [99] All records filed from a non-Records Management site are added to the Unfiled Records area by default.
  • Completing record events [100] If a retention schedule has event-based steps, then you need to complete those events before the schedule can move on to the next step. Some steps are automatically completed but most of them you need to complete manually.
  • Editing a review date [101] If you've set up a review period for vital records in the record category or folder, you can edit the review date for individual records.
  • Editing a record retention date [102] If a record is subject to a record level retention schedule, you can review the retention date for the next step in the retention schedule that applies to the record. This is done at record level only and does not affect the retention schedule.
  • Processing records [47] Retention steps are generally completed manually, though retain and cut off steps can be completed automatically by a system process that is run daily. You can also set up a rule to complete steps automatically.
  • Adding records to a hold [103] Users with the appropriate capabilities can add records and folders to a hold.
  • Reverting a record to be an incomplete record [104] If you need to stop a record from being subject to retention schedules, you can reopen it so that it reverts to being an incomplete record.
  • Deleting records [105] When you don't need a record any more you can delete it.
Parent topic: Managing the File Plan [56]

Viewing records

The record details page gives you access to the actions available to be performed on a record, the custom metadata, references to and from other records, and the record URL.
  1. Click the title of a record in the File Plan.

    The record details page displays. On this page, you can see the record details and the available actions in the Actions list.

  2. Click the location link above the record name to return to the File Plan.
Parent topic: Managing records [52]

Linking records

You can link records to a folder other than the one they're filed in to file them in multiple locations in the File Plan.
This gives the effect of "duplicating" the record in another location, though there is still only one record, but it's now contained in more than one folder. Changes made to the record in one location will be reflected in all the other locations, and this includes deleting the record.
Important: It's recommended that you don't link a record to a location where it will be subject to a retention schedule with different steps or a different sequence of steps.
Note: The link option is only available to users who have the Link Records capability assigned to them by the Records Management Administrator.
  1. Hover over a record in the File Plan and click More then Link to.
  2. Select a folder in the File Plan to link a record to.
  3. Click Link.

    A link is created in the destination folder. All copies of the record display the Linked icon.

    Note: Linked records won't move to the next retention step until the period for the current step has been completed in all retention schedules it falls under. So in effect they follow the retention schedule that has the longest period for a step.
You can click More then Unlink Record against the record in the destination folder. This will remove the linked record from the destination folder.
Note: The unlink option is only available to users who have the Unlink Records capability assigned to them by the Records Management Administrator.
Parent topic: Managing records [52]

Creating relationships between records

You can add relationships to records to create a connection between them. This can be useful, for example, to track records that have been superseded or obsoleted.
  1. Hover over a record in the File Plan and click More then Add Relationship.
  2. Select a relationship type in the New Relationship screen.

    Note: Most relationships don't alter or affect a record in any way, they are just used to create an association between records.

    However, if you select Obsoleted by/Obsoletes or Superseded by/Supersedes, then any outstanding retention schedule obsoleted or superseded events will be automatically completed.

  3. Click Select Record and then select a record to create a relationship with by clicking Add.
  4. Click OK.

    The selected record is shown in the New Relationship screen.

  5. Click Create.

    You can repeat these steps to add relationships to multiple other records. You can see details of any relationships when you click on a record to preview it, and relationships can be added and deleted here if you have the correct permissions.

    When records are created from versions of the same file, a relationship between the records is automatically created.

Parent topic: Managing records [52]

Reviewing vital records

If you've set up a review period for vital records in the record category or folder, you can review this for individual records.
Users with Records Manager permissions receive a notification email when vital records are due for review.
  1. When a record is due for review hover over it in the File Plan.

    Tip: You can search for vital records using the Records Search on the More menu. Records that are due for review will display a warning symbol in the search results.
  2. Click Reviewed.

    A message displays saying that the record has been successfully reviewed. The review date is displayed in the record audit log.

Parent topic: Managing records [52]

Managing unfiled records

All records filed from a non-Records Management site are added to the Unfiled Records area by default.
Tip: Access the Unfiled Records area using the explorer panel to the left of the File Plan.

Unfiled records can have been declared as records from a non-Records Management site, from within the Unfiled Records area, or could be reports generated from within the File Plan. Filing an unfiled record [43] describes how records in the Unfiled Records area are processed.

You don't have to use this area as a flat structure, you can configure it to your own requirements.

You can create a full folder hierarchy within the Unfiled Records area and use rules [61] to automate the processing of unfiled records.

You can use the Manage Permissions option to control which users can file and reject unfiled records.

There are also many of the usual options available, including the options to copy and move records and folders within the Unfiled Records area. If you select to Reject a record then you need to enter a reason for the rejection. This reason can be viewed when looking at the file the record was created from in its originating site.

Parent topic: Managing records [52]

Completing record events

If a retention schedule has event-based steps, then you need to complete those events before the schedule can move on to the next step. Some steps are automatically completed but most of them you need to complete manually.
  1. Click the title of a record in the File Plan.

    The record details page is displayed. All incomplete events for the current schedule step are displayed.

  2. Click Complete Event.
  3. In the complete Event box select a date and time for the completion of the event.
  4. Click OK.
When all incomplete events are complete the record can move onto the next step in the schedule.
Parent topic: Managing records [52]

Editing a review date

If you've set up a review period for vital records in the record category or folder, you can edit the review date for individual records.
  1. Hover over a record in the File Plan and click More then Edit Review Date.

    The Edit Review Date dialog box displays. The current review date is highlighted.

  2. Select a new review date and click Update.

    A message displays confirming that the review date is updated. This overrules any review dates set at folder or category level.

Parent topic: Managing records [52]

Editing a record retention date

If a record is subject to a record level retention schedule, you can review the retention date for the next step in the retention schedule that applies to the record. This is done at record level only and does not affect the retention schedule.
  1. Hover over a record in the File Plan and click More then Edit Retention Date.

    The Edit Retention Date dialog box displays. The current retention date is highlighted.

  2. Select a new retention date and click Update.

    A message displays confirming that the retention date is updated. This overrules any review dates set in the retention schedule, even if you update the retention schedule.

Parent topic: Managing records [52]

Processing records

Retention steps are generally completed manually, though retain and cut off steps can be completed automatically by a system process that is run daily. You can also set up a rule to complete steps automatically.
If a retention step is complete (the time period is finished or the required events have been completed), then additional options are available for folders or records, dependant on whether the retention schedule is set to folder or record level.

If you apply an action to a folder then it will also be applied to all records within the folder.

Hover over a folder/record in the File Plan and click the action that is available to move to the next step in the retention schedule.

Action Select this to...
Cut off Cuts off the record/folder and triggers the retention period. Records can't be added to a folder that's been cut off.
End Retention Ends the retention period for the record/folder.
Transfer Transfers the record/folder to the previously specified location. An audit trail and metadata is retained.

By default transferred records/folders are temporarily held in the Transfers area of the File Plan until you hover over them and click Complete Transfer.

Accession Transfers the record/folder to the previously specified location. An audit trail and metadata is retained.

This usually involves the specific legal and physical transfer of records between organizations.

By default accessioned records/folders are temporarily held in the Transfers area of the File Plan until you hover over them and click Complete Transfer.

Destroy Removes the record/folder content from the Records Management system. If the Maintain record metadata after destroy option is selected in the retention schedule, then a visual representation of the record, an audit trail, and metadata is retained in the File Plan.

If the record was declared from a file in an Alfresco site then the file is also removed.

Note: Each time you manually run an action, that option is replaced with the next action step in the retention schedule, and a new option for undoing the step you've just done, for example, Undo Cut Off.

Icons next to the record/folder indicate their current stage in the schedule.

Parent topic: Getting started for Records Management Users [28]
Parent topic: Managing record folders [51]
Parent topic: Managing records [52]

Adding records to a hold

Users with the appropriate capabilities can add records and folders to a hold.
A hold allows objects on hold for a particular reason to be tracked as a set. Holds prevent changes to on hold objects, which have their retention schedules suspended until the hold is removed.
Note: When you add a folder to a hold, all records within the folder are also added to the hold. The records can't be removed from the hold individually, they can only be removed from the hold by removing the entire folder.
Tip: You can only put records on hold if holds have been created to add them to.
  1. Hover over a record in the File Plan and click More then Add to Hold.

    The Add to Hold screen displays.

    Note: This option isn't available if no holds have been set up in the Holds area or you don't have permission to put records on the existing holds.
  2. Select one or more holds and click OK.

    A message displays confirming that the record is on hold, and the record now displays the Frozen icon.

    Note: Records and folders remain on hold until they have been removed from all holds they're added to.
The record remains in its place in the File Plan. It is also shown in the Holds area of the explorer panel.
Note: To remove a record from a hold hover over it in the File Plan or the Holds area and select Remove from Hold.
Parent topic: Managing records [52]

Reverting a record to be an incomplete record

If you need to stop a record from being subject to retention schedules, you can reopen it so that it reverts to being an incomplete record.
Hover over a record in the File Plan and click More then Reopen.

The record is now marked as an incomplete record in the file plan and is not subject to the rules of the retention schedule. You can set it to complete again whenever needed.

Parent topic: Managing records [52]

Deleting records

When you don't need a record any more you can delete it.
  1. Hover over a record in the File Plan and click Delete.

    A confirmation dialog box displays.

  2. Click Delete.

    The record is removed from the Records Management system. If the record was declared from a file in an Alfresco site then the file is also removed.

Parent topic: Managing records [52]

Managing records holds

You can add records and folders to a hold to freeze them and suspend their retention schedules.

You can create as many different holds as you want, which are represented as folders in the Holds area.

Tip: Access the Holds area using the explorer panel to the left of the File Plan.

In the Holds area there's a New Hold option which you use to set up your different hold types. Once you have a list of different holds you can put records [103] and record folders [92] on as many of the different holds as required.

You can also add records to a hold direct from the Records Search [106].

When you add a folder to a hold, all records within the folder are also added to the hold. They'll stay on hold until removed from the hold or the hold is deleted.

In the Holds area you can look through your Holds and when you go into a hold you can see the records that are on it. The records aren't removed from the File Plan though. They retain their place in the File Plan with limited actions available, and are identified as being on hold by the Frozen icon.
Note: Only users with permissions to view a hold will see the Frozen icon next to records in the File Plan that are on that hold. Users without permission to view the hold will see the record but have no indication that it is on a hold. This provides confidentially on record holds.

You can use the Manage Permissions option to control which users can view, create, edit, and delete holds. Users who don't have read permission for a specific hold will not receive any indication that records it contains are in that hold.

Tip: You can hover over a hold and click Generate Hold Report to create a report on the hold. The report is filed as an incomplete record in your selected destination.
  • Creating holds [107] Users with the appropriate capabilities can create multiple holds that are then used when records are put on hold.
Parent topic: Managing the File Plan [56]

Creating holds

Users with the appropriate capabilities can create multiple holds that are then used when records are put on hold.
Tip: You can only put records on hold if holds have been created to add them to.
  1. Click on the Holds area of the File Plan in the explorer panel, and click New Hold.
  2. Enter a Name, Description and Reason for the hold.

    Note: The reason will be used to when deciding which hold a record should be put on.
  3. Click Save.

    A new hold is now available for putting records on. You put records on hold by hovering over them in the File Plan and selecting the Add to Hold option.

You can edit and delete holds by hovering over them in the File Plan and selecting the appropriate option, as well as managing their permissions and viewing an audit log.
Parent topic: Managing records holds [83]

Exporting and importing File Plan content

You can quickly and easily import and export Records Management content, from individual record folders through to an entire File Plan.

This can be useful if you want to quickly build your File Plan, or parts of it, based on a File Plan that already exists on an Alfresco system.

You can move entire blocks of content – record categories, record folders, records, metadata, and retention schedules – within a File Plan or to another File Plan.

Files are imported and exported using the Alfresco Content Package (ACP) format. You can also choose to import and export the content as a zip file. Exported files contain all structural information including record categories, folders, and retention schedules, so they make for seamless building of a File Plan in another Alfresco system.

  • Exporting content [108] Exporting a records category or folder bundles the contents and structure into an Alfresco Content Package (ACP). You can also choose to export the content as a zip file.
  • Exporting a File Plan [109] Exporting a File Plan bundles the contents and structure of the entire plan into an Alfresco Content Package (ACP). You can also choose to export the plan as a zip file.
  • Importing content [110] Importing an Alfresco Content Package (ACP) or zip file into a Records Management system expands the package to its original structure. Existing content will not be overwritten.
Parent topic: Managing the File Plan [56]

Exporting content

Exporting a records category or folder bundles the contents and structure into an Alfresco Content Package (ACP). You can also choose to export the content as a zip file.
  1. In the File Plan click the check boxes for the record category and/or folders you want to export.
  2. Click Selected Items then Export.
  3. Select the file format for the export and click OK.

    Note: A zip file retains the file structure, making it bigger than an ACP. In an ACP the file structure is stored in an xml file.

    Depending on your browser, you are either prompted to specify a destination or the file is automatically downloaded to a default location.

Parent topic: Exporting and importing File Plan content [84]

Exporting a File Plan

Exporting a File Plan bundles the contents and structure of the entire plan into an Alfresco Content Package (ACP). You can also choose to export the plan as a zip file.
  1. Anywhere in the File Plan click Export All.
  2. Select the file format for the export and click OK.

    Note: A zip file retains the file structure, making it bigger than an ACP. In an ACP the file structure is stored in an xml file.

    Depending on your browser, you are either prompted to specify a destination or the file is automatically downloaded to a default location.

Parent topic: Exporting and importing File Plan content [84]

Importing content

Importing an Alfresco Content Package (ACP) or zip file into a Records Management system expands the package to its original structure. Existing content will not be overwritten.
  1. Go to the level in the File Plan structure where you want to import the ACP/zip file.
  2. Click Import.
  3. Click Select Import File and find the file that you want to upload.

    Important: You should only import an ACP/zip file that was exported from another Records Management File Plan.

    The Records Management content is extracted from the uploaded file with it's original structure maintained.

Parent topic: Exporting and importing File Plan content [84]

Automating the File Plan

In the File Plan you can define category and folder rules to manage your content automatically. You can come up with many creative solutions to make sure specific content processes are automated so you don't have to do the work yourself.

Rules dictate how content entering, leaving, or currently residing in a category or folder is managed.

There are three parts to a content rule:

  • The event that triggers the rule
  • The conditions the content has to meet
  • The action performed on the content

The events that can trigger a rule are:

  • A content item arrives in the folder
  • A content item leaves the folder (it's moved or deleted)
  • A content item in the folder is modified

Here are some examples of how you can use rules to automate repetitive tasks:

  • All records without a record type placed in a category are associated with a specific record type
  • All incomplete records placed in a folder are completed
  • All records that are cut off in a folder have the event Case Closed completed
  • All folders created in a specific category are added to a hold
  • Defining rules for a category or folder [111] Use rules to manage your File Plan content automatically. There are two ways to define rules: create your own rules or link to rules already created for a different category or folder.
  • Working with a set of rules [112] You can easily view and maintain the individual rules that makes up the rule set. You can add, edit, and delete rules, make a rule inactive, and change the run order. You can also manually run rules.
  • Working with linked rules [113] When a category or folder has linked rules there are less editing options than when it has its own set of rules. You can either link to a different rule set or you can break the link completely.
Parent topic: Using Records Management [3]

Defining rules for a category or folder

Use rules to manage your File Plan content automatically. There are two ways to define rules: create your own rules or link to rules already created for a different category or folder.

When you define a rule, it only applies to new content added to the category/folder. Items that were in the category/folder before the rule was defined aren't affected by it. You can manually apply the category/folder rules with the Run Rules action.

If you create rules for a category, depending on the rule settings, they can apply to folders and categories created in the category, records placed in folders in the category, or both.

Note: Even if a category/folder doesn't have its own rules, it could have inherited category/folder from a parent folder. A message on the Rules page lets you know if this is the case.
  • Creating a rule [114] You can create rules for a category or folder, in much the same way that you might apply rules to your emails.
  • Linking to an existing rule set [115] The Link to Rule Set option lets you reuse an existing rule set that's already defined for another category or folder.
Parent topic: Automating the File Plan [57]

Creating a rule

You can create rules for a category or folder, in much the same way that you might apply rules to your emails.
Note: If a category/folder already has rules applied to it (indicated by the icon) you can add new rules to it by adding to a set of rules [116].
  1. Click Manage Rules when you're in the folder or category you want to set rules for in the File Plan.

    Tip: You can also hover over a folder or category in the File Plan and click More then Manage Rules.
  2. Click Create Rules.
  3. Enter a name and a description (optional) for the rule.
  4. Select when the rule will be triggered:
    • Items are created or enter this folder: The rule will be applied to content that gets added to this category/folder. This includes any item that is copied to, created in, or uploaded to the folder.
    • Items are updated: When an item in this folder is modified, the rule will be applied to it.
    • Items are deleted or leave this folder: The rule will be applied to content that is moved out of the category/folder or deleted.

    Note: A rule can have more than one event, condition, and action. Click the + or - icons to add or remove rows.
  5. Select if the rule will be applied If the following apply, If the following don't apply, or both.

    Here are 3 examples of conditions that you could apply to trigger a rule:

    • The rule is applied if the record title contains the word 'urgent' (If the following apply)
    • The rule is applied if the record title does not contain the word 'urgent' (If the following don't apply)
    • The rule is applied if the record title contains the word 'urgent', unless the record was created before a specified date (If the following apply and If the following don't apply)
  6. Select criteria for which content the rule will apply to, and remember that you can use the + and - icons to add and remove extra criteria.

    Note: Selecting Show more on these menus displays the Select property screen where you can select additional properties. Click the folders on the left of the screen to show the properties they contain on the right of the screen. Selecting Show in menu selects that property and adds it to all criteria menus when setting up the current rule.
  7. Select the action you want performed when the conditions are met.

    When you've selected an action you might need to select further options, for example if you select to reject items click Reject to specify a reason.

    Tip: If you select File to, Copy to, or Move to you need specify a destination Record Folder. You can click Select to choose an existing folder, or you can type in a Record Folder Location, for example /category/category/folder, or a combination of the two. Select the Create Full Path to Folder option to ensure that the specified path is created if it doesn't already exist. It won't be created if it doesn't fit the File Plan structure.

    There are also extensive autocomplete options [117].

    If you select Execute script then scripts are only available if they've been set up by your Alfresco administrator in Repository > Data Dictionary > Records Management > Records Management Scripts.

  8. Select additional options:
    • Turn off rule: Switch off the rule.
    • Rule applies to subfolders: Apply the rule to this category and all its subcategories and subfolders.
    • Run rule in background Lets you continue working while the rule is running. You can also select an action to run if there's a problem with the rule with the rule. These actions are the same as the Execute script action, and are set up by your Alfresco administrator.
  9. Click Create, or Create and Create Another to save this rule and start creating another.
  • Rules autocomplete options [117] If you type part of a record property at any place in the path then autocomplete options are displayed.
Parent topic: Defining rules for a category or folder [111]

Rules autocomplete options

If you type part of a record property at any place in the path then autocomplete options are displayed.
For example, if you type rm then you'll be offered options that include:
  • Date filed {node.rma:dateFiled}
  • Identifier {node.rma:identifier}
  • Location {node.rma:location}

Records will be put into the File Plan based on each individual record property value.

So for example you could set a path of /category/{node.rma:location}. When the rule is run records with a Location property of US would be put in /category/US, and records with a Location property of France would be put in /category/France.

Date options set that part of the path to the date the rule is run. For example if it's run on Monday then:
  • Short Day {date.day.short} = Mon
  • Long Day {date.day.long} = Monday

By default  autocomplete options are based on the first two letters you type, and only five options for each type of suggestion are offered at a time. Type more letters to narrow down the displayed options.

Tip: This can be configured in the properties file.
Available autocomplete options are:
  • Last accessed = node.cm:accessed
  • When created = node.cm:created
  • Creator = node.cm:creator
  • Description = node.cm:description
  • Last modified = node.cm:modified
  • Modifier = node.cm:modifier
  • Name = node.cm:name
  • Title = node.cm:title
  • Date filed = node.rma:dateFiled
  • Unique database ID = node.rma:dbUniquenessId
  • Identifier = node.rma:identifier
  • Location = node.rma:location
  • Original = node name node.rma:origionalName
  • Node ID = node.sys:node-uuid
  • Store ID = node.sys:store-identifier
  • Store protocol = node.sys:store-protocol
  • Short Day (for example, Mon) = date.day.short, date.day
  • Long Day (for example, Monday) = date.day.long
  • Day Number (for example, 1) = date.day.number
  • Day of Month (for example, 18) = date.day.month
  • Day of Year (for example, 216) = date.day.year
  • Short Month (for example, Jan) = date.month.short
  • Month (for example, Jan) = date.month
  • Long Month (for example, January) = date.month.long
  • Month Number (for example, 01) = date.month.number
  • Short Year (for example, 14) = date.year.short
  • Year (for example, 14) = date.year
  • Long Year (for example, 2014) = date.year.long
  • Week of Year (for example, 31) = date.year.week

Parent topic: Creating a rule [114]

Linking to an existing rule set

The Link to Rule Set option lets you reuse an existing rule set that's already defined for another category or folder.
Note: If a category or folder already has linked rules applied (indicated by the icon) you can link to new rules by linking to a different rule set [118].
  1. Hover over a category/folder with no rules applied and click More then Manage Rules.
  2. Click Link to Rule Set.
  3. Find the category/folder you want to use.

    Select the site then select a folder. Check the rules listed to make sure you're linking to the correct folder.

    Note: Locations that you don't have permission to access are disabled.
  4. Click Link.

    Note: You can click View Rule Set to view the rule details, or Change to select a different rule to link to.
  5. Click Done.
Parent topic: Defining rules for a category or folder [111]

Working with a set of rules

You can easily view and maintain the individual rules that makes up the rule set. You can add, edit, and delete rules, make a rule inactive, and change the run order. You can also manually run rules.

You can create many rules to form a full set of rules, and then apply multiple rules to categories and folders.

When you select the Manage Rules action for a category/folder with defined rules, the Rules page is split into two.

The left side of the page lists the rules that make up the rule set. If the category/folder inherits rules from a parent category/folder, those rules appear here too. The rules run in the order they're listed. Inherited rules are always run first.

A check mark to the left of the rule means it's active.

Selecting an individual rule in this list displays its details on the right side of the page.

  • Adding to a set of rules [119] A set of rules can include any number of individual rules, and you can add new rules to a category or folder as you need.
  • Editing a rule [120] You might need to revisit your rules from time to time and make some changes to keep them current. If you don’t want to use a specific rule anymore but think you might need it again in the future, you can just disable it.
  • Reordering the rules in the rule set [121] As part of managing your rule set you can pick the order in which the rules are run. If your category or folder has inherited rules, those are always run first in the order they're listed. Any rules marked as inactive are simply skipped.
  • Turning off inherited rules [122] If a category or folder is inheriting rules from a parent category or folder, you can easily turn them on and off as needed.
  • Deleting a rule [123] When a category or folder has a rule applied that you don't need anymore, you can delete the individual rule.
Parent topic: Automating the File Plan [57]

Adding to a set of rules

A set of rules can include any number of individual rules, and you can add new rules to a category or folder as you need.
  1. Click Manage Rules when you're in the folder or category in the File Plan you want to manage rules for.

    Tip: You can also hover over a category/folder with rules applied (indicated by the icon) and click More then Manage Rules.
  2. Click New Rule.

    On the New Rule page you can add a new rule to a set of rules in exactly the same way as the first time you created a rule, see creating a rule [124].

After creating the last rule you return to the Rules page. Any new rules created are added at the end of the rule set.
Parent topic: Working with a set of rules [112]

Editing a rule

You might need to revisit your rules from time to time and make some changes to keep them current. If you don’t want to use a specific rule anymore but think you might need it again in the future, you can just disable it.
  1. Click Manage Rules when you're in the folder or category in the File Plan you want to edit rules for.

    Tip: You can also hover over a category/folder with rules applied (indicated by the icon) and click More then Manage Rules.
  2. On the left side of the page, click the rule you want to edit.

    Note: This will be shown in the rule summary on the right side of the page. You can't edit linked or inherited rules here; that has to be done in the category/folder where they were created.
  3. Click Edit.
  4. Make your changes. You can edit any of the rule details: name, description, rule definition, and options.
  5. Click Save.
Parent topic: Working with a set of rules [112]

Reordering the rules in the rule set

As part of managing your rule set you can pick the order in which the rules are run. If your category or folder has inherited rules, those are always run first in the order they're listed. Any rules marked as inactive are simply skipped.
  1. Click Manage Rules when you're in the folder or category in the File Plan you want to reorder rules for.

    Tip: You can also hover over a category/folder with rules applied (indicated by the icon) and click More then Manage Rules.
  2. On the left side of the page drag and drop rules to where you want them in the list.

    Note: You can't reorder linked or inherited rules here; that has to be done in the folder where they were created. Click Reset to return the rule set to its last saved order.
  3. Click Save.
Parent topic: Working with a set of rules [112]

Turning off inherited rules

If a category or folder is inheriting rules from a parent category or folder, you can easily turn them on and off as needed.
Turning inherited rules on and off works at an individual category/folder level, and will not affect any other categories/folders.
  1. Click Manage Rules when you're in the folder or category in the File Plan you want to switch off inherited rules for.

    Tip: You can also hover over a category/folder with rules applied (indicated by the icon) and click More then Manage Rules.

    If a category/folder has inherited rules these are displayed on the left side of the page.

  2. Click Inherit Rules.

    Any inherited rules are turned off for the category/folder and Don't Inherit Rules is shown. You can click Don't Inherit Rules to turn inherited rules back on for the category/folder.

Parent topic: Working with a set of rules [112]

Deleting a rule

When a category or folder has a rule applied that you don't need anymore, you can delete the individual rule.
  1. Click Manage Rules when you're in the folder or category in the File Plan you want to delete rules for.

    Tip: You can also hover over a category/folder with rules applied (indicated by the icon) and click More then Manage Rules.
  2. On the left side of the page, click the rule you want to delete.

    If you might want to use the rule again, consider disabling it instead. Edit the rule to do that.

    Note: You can't delete linked or inherited rules here; that has to be done in the folder where they were created.
  3. Click Delete.
  4. When you're asked to confirm the deletion, click Delete.
Parent topic: Working with a set of rules [112]

Working with linked rules

When a category or folder has linked rules there are less editing options than when it has its own set of rules. You can either link to a different rule set or you can break the link completely.

When you select the Manage Rules action for a category or folder with linked rules, the Rules page shows the name and path of the category/folder whose rule set is being referenced.

Note: The category/folder might also inherit rules from a parent category/folder. A message lets you know if this is the case.

Changes to the rule set have to be done in the category/folder where the rules were originally defined. It's easy to get to the Rules page for the source category/folder: just click View Rule Set.

  • Linking to a different rule set [125] If you want to change the rules you're linked to, you can easily link to a different rule set.
  • Breaking the link to a rule set [126] If you don't need your rules anymore, breaking the link is easy. This leaves the category/folder without any rules.
Parent topic: Automating the File Plan [57]

Linking to a different rule set

If you want to change the rules you're linked to, you can easily link to a different rule set.
  1. Click Manage Rules when you're in the folder or category in the File Plan you want to change linked rules for.

    Tip: You can also hover over a category/folder with rules applied (indicated by the icon) and click More then Manage Rules.
  2. Click Change.

    Note: This option only shows if the category/folder has linked rules.
  3. Select the site then select a folder.

    You can only select locations you have permission to access.

  4. Click Link.

    This breaks the link to the original rule set and links you to the new one.

  5. Click Done.
Parent topic: Working with linked rules [113]

Breaking the link to a rule set

If you don't need your rules anymore, breaking the link is easy. This leaves the category/folder without any rules.
  1. Click Manage Rules when you're in the folder or category in the File Plan you want to break a link to rules for.

    Tip: You can also hover over a category/folder with rules applied (indicated by the icon) and click More then Manage Rules.
  2. Click Unlink.

    The link between the current category/folder and the linked rules is now broken.

Parent topic: Working with linked rules [113]

Searching records

You can use the Records Search to quickly search the File Plan to find records, and save your search query to use again.

You can either do a basic search, just searching for a term as you would in a search engine, or you can use the advanced search functionality. There's lots of options available for you to set really specific searches that you can use again and again. See Advanced search options [127] for more details on getting the most out of the search tool.

  • Accessing the Records Search [128] You can search records to find those that you're looking for, and save searches for future use.
  • Creating a search [129] You can search all the contents of your Records Management site. You can narrow the results of your search by specifying relevant metadata fields and container types (category, folder, record). Once you create a search, you can save it to use again.
  • Using a saved search [130] The Records Management site includes a number of default searches that you can use instead of creating your own. You also have access to searches you've created and saved yourself, as well as those created by other users.
  • Saving a search [131] When you've run a search and are looking at the search results, you can select to save it.
  • Printing search results [132] You can print the search results.
  • Exporting search results [133] You can export search results as an Alfresco Content Package (ACP).
  • Deleting a saved search [134] You can delete any of your own saved searches, and if you have the required user permissions you can also delete the default searches included with the Records Management site.
  • Adding search results to a hold [106] Users with the appropriate capabilities can add records and folders to a hold. A hold allows objects on hold for a particular reason to be tracked as a set. Holds prevent changes to on hold objects, which have their retention schedules suspended until the hold is removed. When you add a folder to a hold, all records within the folder are also added to the hold.
  • Advanced search options [135] As well as basic searches where you search for a specific word, you can also create more complex full text searches with multiple matches, tokens, phrases, wildcards, ranges, and grouping.
Parent topic: Using Records Management [3]

Accessing the Records Search

You can search records to find those that you're looking for, and save searches for future use.
  1. In the Records Management site click Records Search.

    The Search page displays.

  2. Click the Criteria tab to perform a search or the Results tab to view the results of a search.
Parent topic: Searching records [58]

Creating a search

You can search all the contents of your Records Management site. You can narrow the results of your search by specifying relevant metadata fields and container types (category, folder, record). Once you create a search, you can save it to use again.
See Advanced search options [135] for how to get the most out of the search facility.
  1. On the Records Search Criteria tab enter a search term in the box.
  2. If you want you can use the Search by field and Search Date options to do a more advanced search.

    Search criteria Description
    Search by Select from the options available what you want to search for. When you select an option it's added to the field below where you can then enter your search criteria. For example if you select Retention Schedule > Retention Action Name, the field name retentionActionName: is added and you can then type a retention action name, such as retentionActionName:cutoff. Don't insert a space between the colon and the search term. You can select multiple criteria.
    Search Date Select a date to search on or even multiple dates, see searching for date ranges [136].
  3. Expand the Results options section and specify the content you want displayed in the search results.
    1. In the Metadata section, select the metadata fields that you want to display in the search results. The metadata name becomes a column title in the results table, which can then be sorted.
    2. In the Order section, specify how you want to sort the search results.
    3. In the Components section, select the type of components you want the search to return.
  4. Click Search.

    The search results display in a table on the Results tab.

Clicking New Search returns you to the Criteria tab and clears the search fields, setting them to their default values. This lets you easily create a new search.
  • Search query examples [137] Use these examples to see how the Search by and Search Date options work.
  • Search field options [138] If you select to Search by for a search, then the following fields are available if you select a Content, Record, or Retention Schedule field.
  • Search record type field options [139] If you select to Search by for a search, then the following fields are available if you select a Web Record, Scanned Record, PDF Record, or Digital Photograph Record field.
Parent topic: Searching records [58]

Search query examples

Use these examples to see how the Search by and Search Date options work.
Finding folders/records due for cut off before 1st Jan 2010
dispositionActionName:cutoff and dispositionActionAsOf:[MIN TO "2010-01-01"]
Finding records due for transfer before 1st Jan 2010
dispositionActionName:transfer and dispositionActionAsOf:[MIN TO "2010-01-01"]
Finding categories or folders with a monthly cycling date
vitalRecordReviewPeriod::month
Note: Ensure that you've selected the component in the Results options section.
Parent topic: Creating a search [129]

Search field options

If you select to Search by for a search, then the following fields are available if you select a Content, Record, or Retention Schedule field.
Title Field name Description
Keywords (text and name) keywords Used to search for the name, title, description fields, and text. This field is tokenized.
Identifier identifier The unique identifier for the record. The system generates this identifier.
Name name The name of the record. This is populated with the name of the file that was uploaded.
Title title The title of the record. This is populated with the name of the file that was uploaded. Change the value to show the title of the record.
Description description A short description of the record.
Creator creator The person(s) who created this record.
Created created The date that this record was created.
Modifier modifier The last user to make any modifications to this record.
Modified modified The time that the last modification occurred.
Author author The name of the document author(s).
Originator originator The person or department in the Originating Organization.
Date Filed dateFiled The date that the record was filed.
Publication Date publicationDate The date that the record is published. Select the date from the calendar selection box.
Review Date reviewDate The date that this record is due for review.
Originating Organization originatingOrganization This is who created the document/record in the first place. Often this will be the organization running the software, but in some cases might be an external organization.
Media Type mediaType The type of the media.
Format format The media on which the record is stored.
Date Received dateReceived The date that the record was received from the originator.
Location location The physical location of the record. This is mainly applicable to non-electronic records.
Addressee address The address of the originating organization to be used for correspondence.
Other Addressee otherAddress The CC list from an email.
Supplemental Marking List markings This list is defined in the RM List of Values tool in the RM Admin Tools.
Retention Events dispositionEvents User defined retention events.
Retention Action Name dispositionActionName The name of the retention action. The values can be Accession, Destroy, Retain, Transfer, and Cutoff.
Retention Action As of Date dispositionActionAsOf The date that the retention action occurred.
Retention Events Eligible dispositionEventsEligible Specifies whether this record has any eligible events. The values can be true or false.
Retention Period dispositionPeriod The period of time to which the retention action is set. The values can be day, fymonthend, fyquarterend, fyyearend, monthend, quarterend, yearend, immediately, month, none, notset, quarter, week, or year.
Has Retention Schedule dispositionSchedule Specifies whether this record is under a retention schedule. The value can be true or false.
Retention Instructions dispositionInstructions The text summary of the retention steps.
Retention Authority dispositionAuthority The legislation relevant to the retention instructions, in particular, relating to the disposal of the record. For example, GRS 2 Item 7.
Hold Reason holdReason The reason that the record is in the Hold area.
Vital Record Review Period vitalRecordReviewPeriod The review period set for a vital record. The values can be day, fymonthend, fyquarterend, fyyearend, monthend, quarterend, yearend, immediately, month, none, notset, quarter, week, year.
Parent topic: Creating a search [129]

Search record type field options

If you select to Search by for a search, then the following fields are available if you select a Web Record, Scanned Record, PDF Record, or Digital Photograph Record field.
Note: These options are only available in DoD 5015.2-STD compliant Records Management sites.
Record type Special type name Description
Scanned records dod:scannedFormat Image Format
Scanned records dod:scannedFormatVersion Image Format Version
Scanned records dod:resolutionX Image Resolution X
Scanned records dod:resolutionY Image Resolution Y
Scanned records dod:scannedBitDepth Scanned Bit Depth
PDF records dod:producingApplication Producing Application
PDF records dod:producingApplicationVersion Producing Application Version
PDF records dod:pdfVersion PDF version
PDF records dod:creatingApplication Creating application
PDF records dod:documentSecuritySettings Document security settings
Digital photograph records dod:caption Caption
Digital photograph records dod:photographer Photographer
Digital photograph records dod:copyright Copyright
Digital photograph records dod:bitDepth Bit Depth
Digital photograph records dod:imageSizeX Image Size X
Digital photograph records dod:imageSizeY Image Size Y
Digital photograph records dod:imageSource Image Source
Digital photograph records dod:compression Compression setting
Digital photograph records dod:iccIcmProfile ICC/ICM profile
Digital photograph records dod:exifInformation EXIF information
Web records dod:webFileName Web file name
Web records dod:captureMethod Method of capture
Web records dod:contentManagementSystem Content management System
Web records dod:webPlatform Web platform
Web records dod:webSiteName Web site name
Web records dod:webSiteURL Web site URL
Web records dod:captureDate Date of capture
Web records dod:contact Capture contact
Parent topic: Creating a search [129]

Using a saved search

The Records Management site includes a number of default searches that you can use instead of creating your own. You also have access to searches you've created and saved yourself, as well as those created by other users.
  1. On the Records Search page click Saved Searches and select a search option.

    The Critera tab is auto-filled with the saved search options. You can change these if you want.

  2. Click Search.

    The search results display in a table on the Results tab.

Parent topic: Searching records [58]

Saving a search

When you've run a search and are looking at the search results, you can select to save it.
  1. Click Save Search.
  2. Enter a Name and Description for the search.
  3. Click Save.

    The search you save will be available for all site members.

The saved search displays in the Saved Searches menu on the Search page. The same list is available in the explorer panel of the File Plan.
Note: The saved search feature saves only the search query and not the results. This means that when you next use the saved search, you might get different results, depending on the activity in the Records Management system.
Parent topic: Searching records [58]

Printing search results

You can print the search results.
  1. Click the Records Search Results tab to view the search results.
  2. Click Printer Layout.
  3. Print the page using your browser print option.
  4. Click Screen Layout to return to the standard view.
Parent topic: Searching records [58]

Exporting search results

You can export search results as an Alfresco Content Package (ACP).
  1. Click the Records Search Results tab to view the search results.
  2. Click Export.

    Depending on your browser you are prompted to open or save the file.

    Note: You can also export the results from the Printer Layout view.
Parent topic: Searching records [58]

Deleting a saved search

You can delete any of your own saved searches, and if you have the required user permissions you can also delete the default searches included with the Records Management site.
  1. Click the Saved Searches menu on the Search page to view the available search queries.
  2. Select the query you want to delete.

    The Critera tab is displayed so you can check that this is the search you want to delete.

  3. Click Delete Search.
  4. Click Remove to confirm the deletion.
Parent topic: Searching records [58]

Adding search results to a hold

Users with the appropriate capabilities can add records and folders to a hold. A hold allows objects on hold for a particular reason to be tracked as a set. Holds prevent changes to on hold objects, which have their retention schedules suspended until the hold is removed. When you add a folder to a hold, all records within the folder are also added to the hold.
  1. Click the Records Search Results tab to view the search results.
  2. Select search results then click Add to Hold.

    The Add to Hold screen displays.

  3. Select one or more holds and click OK.

    A message displays confirming that the record or folder is on hold.

    Note: If no holds have been set up in the Holds area then the screen will be empty. Records and folders remain on hold until they have been removed from all holds they're added to.
The selected records and/or folders remain in their place in the File Plan. They are also shown in the Holds area of the explorer panel.
Note: To remove a record from a hold hover over it in the File Plan or the Holds area and select Remove from Hold.
Parent topic: Searching records [58]

Advanced search options

As well as basic searches where you search for a specific word, you can also create more complex full text searches with multiple matches, tokens, phrases, wildcards, ranges, and grouping.

Full text searches can be very simple, using a text string, or you can do more complex searches with multiple matches, tokens, phrases, wildcards, ranges, and grouping. The search syntax follows the format:

<field-name>:<search-value>
  • <field-name> is the field within Records Management. For example, identifier is the field name for the unique record identifier.
  • : (colon) separates the field name from the search value. Make sure there's no space between the colon separator and the value.
  • <search-value> is the value that you want to search for.

Alfresco Records Management has a large number of fields to search against, see Search field options [140] and Search record type field options [141]. The search query requires that you enter the internal name of these fields in the text box. The Search by menu list assists you when entering the fields.

To search for phrases, wrap the value string in "quotes". You can also use the wildcard matching characters, question mark (?) for a single character, and asterisk (*) for zero or more characters to apply to any text value.

  • Searching for text [142] To search for a simple text string in any record content, enter the text string.
  • Search using wildcards [143] An example of a simple wildcard query is to match any word starting with 'health' in any record name, title, description, or content.
  • Searching for multiple fields [144] Multiple fields can be combined to match additional results. Each field, by default, will be OR combined with the previous.
  • Searching for phrases [145] To search for phrases, wrap the value string in "double quotes". An example of phrase matching is to match the field originator with the phrase “John Smith”.
  • Searching for exact term [146] To search for exact terms, prefix the term with an equals symbol (=). An example of exact term matching is to match the word “part”.
  • Searching for dates [147] To search for date values, you can match date fields exactly.
  • Searching for date ranges [148] To search for date values, you can match date fields in a range.
  • Searching for special types [149] To search for special types, you can match the special type names using ASPECT.
  • Searching for empty strings [150] An example of searching for empty strings is to match all the empty Location fields.
  • Searching for components [151] In the Results options section, the Components area allows you to select the type of components to search. You can search for Records, Record Folders, and Record Categories, as well as On Hold and Cut off records. For record searches, you can also search for incomplete records and vital records.
  • Searching using special operators [152] Additional special operators can form rich search queries. The following special operations are available:
Parent topic: Searching records [58]

Searching for text

To search for a simple text string in any record content, enter the text string.
For example, to find the text “healthcare” in any completed record:
  1. Type healthcare in the Search Text box.
  2. In the Results options section, select the components you want to search.

    To find a simple text string in any record name, title, description, or content, enter the following in the Query Text box:

    keywords:healthcare

    The keywords field is a special field name that allows you to match against the name, title, description, and content of a record.

    The basic syntax for matching against a field in search queries is the syntax format of the keywords field, then the colon (:), followed by the value to match against.

Parent topic: Advanced search options [135]

Search using wildcards

An example of a simple wildcard query is to match any word starting with 'health' in any record name, title, description, or content.
  1. In the Search Text box, enter:

    keywords:health*

  2. In the Results options section, select the components you want to search..
The single and multiple wildcard characters can be combined as needed. For example, "*care" and "*car?" both match "healthcare".
Parent topic: Advanced search options [135]

Searching for multiple fields

Multiple fields can be combined to match additional results. Each field, by default, will be OR combined with the previous.
  1. In the Search Text box, enter:

    keywords:healthcare keywords:hospital

  2. To return results that only contain both terms, use AND between the terms:

    keywords:healthcare AND keywords:hospital

  3. In the Results options section, select the components you want to search.
The NOT operator and grouping of terms with brackets "(" and ")" are supported. For example:
(KEYWORDS:healthcare AND KEYWORDS:hospital) AND NOT KEYWORDS:clinic
Parent topic: Advanced search options [135]

Searching for phrases

To search for phrases, wrap the value string in "double quotes". An example of phrase matching is to match the field originator with the phrase “John Smith”.
  1. In the Search Text box, enter:

    originator:"John Smith"

  2. In the Results options section, select the components you want to search.
Wildcards are supported within phrase matching. For example, to match records that contain the text "John Smith" or "John Smithe" in the Originator metadata field, use the following query text:
originator:"John Smith*" 

You can also escape embedded quotes in a phrase using back slash \.

Parent topic: Advanced search options [135]

Searching for exact term

To search for exact terms, prefix the term with an equals symbol (=). An example of exact term matching is to match the word “part”.
  1. In the Search Text box, enter:

    =part

  2. In the Results options section, select the components you want to search.

This search will match "part" but will not match other terms that contain "part", such as "partners".

Parent topic: Advanced search options [135]

Searching for dates

To search for date values, you can match date fields exactly.
To return records that were filed on 10th September 2009:
  1. In the Search by menu, select Records and then Date Filed.
  2. Select the date using the Search Date control. The query text displays as:

    "2009-09-10"

Parent topic: Advanced search options [135]

Searching for date ranges

To search for date values, you can match date fields in a range.
To return date ranges, the syntax requires the From and To dates to be surrounded by square brackets. For example, to return records that were filed on or before the 10th January 2010:
  1. In the Search by menu, select Records and then Date Filed.
  2. Add the following search query:

    [MIN TO "2010-01-10"]

You must surround the query with square brackets. Use the TO token between dates to represent the range.

Use the MIN special token to denote the minimum possible date that can be represented by the system.

Use the MAX and NOW special tokens to indicate the maximum possible date and the current date, respectively.

For example, to find all records that were filed today, use the following query text:
dateFiled:NOW
Parent topic: Advanced search options [135]

Searching for special types

To search for special types, you can match the special type names using ASPECT.
Note: These options are only available in DoD 5015.2-STD compliant Records Management sites.
For example, to search for all digital photograph records:
  1. In the Search Text box, type:

    ASPECT:"dod:digitalPhotographRecord"

  2. In the Results options section, select the check box for Records.
You can also search on the following special fields:

Special fields Description
dod:scannedRecord Search for all scanned records.
dod:pdfRecord Search for all PDF records.
dod:webRecord Search for all web page records.
Parent topic: Advanced search options [135]

Searching for empty strings

An example of searching for empty strings is to match all the empty Location fields.
  1. In the Search Text box, enter:

    location:””

  2. In the Results options section, select the check box for Records (Completed only) and deselect the other component options.
  3. Click Search.
The Results tab shows the completed records that have empty Location fields.
Parent topic: Advanced search options [135]

Searching for components

In the Results options section, the Components area allows you to select the type of components to search. You can search for Records, Record Folders, and Record Categories, as well as On Hold and Cut off records. For record searches, you can also search for incomplete records and vital records.
For example, to search for only vital records:
  1. In the Results options section, select the check box for Records (Completed Only) .
  2. Select the check box for Vital Only.
  3. In the Metadata section, select the check box for Vital Record.
  4. Click Search.
The Results tab shows the vital records (the Vital Record field has a value of Yes).
Note: The vital records that are due for review will have the icon next to Yes.
Parent topic: Advanced search options [135]

Searching using special operators

Additional special operators can form rich search queries. The following special operations are available:
  • ISNULL:"field" matches a field that has not been set to any value
  • ISNOTNULL:"field" matches a field that contains any value
For example:
  1. To return all records where the Description metadata field has not been set to any value, type:

    ISNULL:"cm:description"

  2. To return all records where the Subject metadata field has been set to any value:

    ISNOTNULL:"cm:title"

Parent topic: Advanced search options [135]

Auditing and reporting

You can view audit logs for record categories, record folders, and records, and whenever a record or folder is transferred, added to a hold, accessioned, or destroyed, you can file a report to keep a record of the process.
Note: You can only view audit logs if your Alfresco administrator has given you the Access Audit permission.

Whenever a record is transferred, added to a hold, accessioned or destroyed, you have the option to file a report. The report contains details of the item, the retention authority, what the retention step was, when it was performed, who by, and any location changes. The report is filed as a record.

The audit log contains the entire history of an object since the point it was added to the File Plan, and can be useful for finding out about specific events that have occurred during an objects life cycle, and any users that have been involved.

Every entry in the audit log is timestamped and where metadata has been changed, the original values and changed values are recorded.

When viewing an audit log you can also select to export it or to file it as a record.

Note: Users with access to the RM Admin Tools can run an audit of the entire Records Management system.
  • Filing a report [153] Whenever a record or folder is transferred, added to a hold, accessioned, or destroyed, you can file a report to keep a record of the process.
  • Viewing an audit log [154] You can view audit logs for record categories, record folders, and records.
Parent topic: Using Records Management [3]

Filing a report

Whenever a record or folder is transferred, added to a hold, accessioned, or destroyed, you can file a report to keep a record of the process.
When you file a report it's filed as a record which you can then complete and process as with any other record.
  1. In the File Plan hover over a destroyed folder or record, or a folder or record awaiting transfer or accession completion, and click File Report.

    Note: Records and folders waiting for transfer and accession completion are stored by default in the Transfers area in the explorer panel. Records on a hold are stored by default in the Holds area in the explorer panel.
  2. Reports are filed by default to the Unfiled Records area of the File Plan. To select an alternate location deselect the File report to 'Unfiled Records' option and choose a different destination folder.

    Note: As with all records you must select a folder, not a category, to file the report to.
  3. Click File Report.
The report is filed as an incomplete record in your selected destination.
Parent topic: Auditing and reporting [59]

Viewing an audit log

You can view audit logs for record categories, record folders, and records.
Hover over a record category, folder, or record in the File Plan and click More then View Audit Log.

Note: You can only view audit logs if your Alfresco administrator has given you the Access Audit permission.

The audit log displays.

You can click Export to export the audit log, or File as Record to select a location in the File Plan and file the audit log as a record.
Parent topic: Auditing and reporting [59]

Installing

Use this information when installing and configuring Records Management.
  1. Download and apply the Records Management AMP files to your existing Alfresco Content Services installation.
  2. Restart the Alfresco Content Services server.
  3. Log in to Alfresco Content Services Share and create the Records Management site.

    Note: When you install Records Management the Security Controls features are installed at the same time.
  • Prerequisites and supported platforms [155] The supported platforms are the combinations of operating systems, databases, and application servers that are tested and certified for Alfresco Content Services.
  • Installing Records Management AMP files [156] Records Management is installed by applying two AMP files to an existing Alfresco installation.
  • Uninstalling the Records Management AMP files [157] The Records Management AMP files can be uninstalled using the Module Management Tool (MMT).
  • Creating the Records Management site [158] After you've installed the Records Management AMP files, you're ready to go ahead and create a Records Management site.
  • Records Management global properties settings [159] Use this information to understand the alfresco-global.properties settings for Records Management.
Parent topic: Records Management [25]

Prerequisites and supported platforms

The supported platforms are the combinations of operating systems, databases, and application servers that are tested and certified for Alfresco Content Services.

See Supported Platforms [160] for information about prerequisites and requirements.

Parent topic: Installing [4]

Installing Records Management AMP files

Records Management is installed by applying two AMP files to an existing Alfresco installation.
The installation procedure uses the following Records Management AMP files:
alfresco-rm-enterprise-repo-2.6.x.amp Contains Records Management functionality that's applied to an existing Alfresco installation.
alfresco-rm-enterprise-share-2.6.x.amp Contains Records Management functionality that's applied to an existing Alfresco Share installation.
Note: Install the AMPs manually as described below, rather than using the apply_amps tool.
  1. Stop the Alfresco server.
  2. Delete the tomcat\webapps\alfresco and tomcat\webapps\share folders in the Alfresco installation directory.

    Deleting these directories forces Tomcat to read the edited WAR files when Alfresco is restarted.

    Note: If you are using non-Windows systems, such as Mac OS X and Linux, you'll need to replace the backslashes by forward slashes in directory paths.
  3. Browse to the Support Portal [161] and download the Records Management AMP zip which contains the following files:

    • alfresco-rm-enterprise-repo-2.6.x.amp
    • alfresco-rm-enterprise-share-2.6.x.amp
  4. Copy the AMP files to the Alfresco amps and amps_share directories.

    Copy this file to the Alfresco amps directory:
    • alfresco-rm-enterprise-repo-2.6.x.amp
    and this file to the Alfresco amps_share directory:
    • alfresco-rm-enterprise-share-2.6.x.amp
  5. Change into the root of the Alfresco installation directory. Directories specified in the following procedures are relative to this directory.
  6. Run the following commands to install the AMP files:

    java -jar bin\alfresco-mmt.jar install amps\alfresco-rm-enterprise-repo-2.6.x.amp tomcat\webapps\alfresco.war
    java -jar bin\alfresco-mmt.jar install amps_share\alfresco-rm-enterprise-share-2.6.x.amp tomcat\webapps\share.war
  7. Start the Alfresco server.
  8. Check the AMP files have been installed successfully, using these commands:

    java -jar bin\alfresco-mmt.jar list tomcat\webapps\alfresco.war
    and
    java -jar bin\alfresco-mmt.jar list tomcat\webapps\share.war
  9. Start Alfresco Share by browsing to:

    http://<your-server-name>:<port number>/share

    At this point, the Records Management module is installed. Next, create a Records Management site.

Parent topic: Installing [4]
Related information
Installing an AMP file [162]
Uninstalling an AMP file [163]

Uninstalling the Records Management AMP files

The Records Management AMP files can be uninstalled using the Module Management Tool (MMT).

Records Management (RM) consists of two AMP files, which are applied during installation. One of the AMP files, representing the core RM functionality, is applied to the Alfresco WAR file, and the other, representing the RM Share UI component is applied to the Share WAR file. Both of the AMP files need to be removed in order to uninstall RM. Use the Module Management Tool (MMT) to do this. For more information on the tool, see Module Management Tool (MMT) [164]

MMT is a command line tool. The syntax for uninstalling an AMP file using MMT is:
          java -jar bin\alfresco-mmt.jar uninstall <ModuleId> <WARFileLocation>
        
Note: The apply_amps command does not uninstall AMP files (even if you remove the AMP files manually from the amps and amps_share directories). Use apply_amps to install AMP files only.
  1. Change into the root of the Alfresco installation directory.
  2. Find the core RM AMP file using the following command:

                 java -jar bin\alfresco-mmt.jar list tomcat\webapps\alfresco.war                        
              

    This shows the core RM component:

    Module 'alfresco-rm-enterprise-repo' installed in 'tomcat\webapps\alfresco.war'
                -    Title:        Records Management
                -    Version:      2.6
                -    Install Date: Mon November 6 12:04:49 BST 2017
                -    Description:   Alfresco Record Management Extension

    You'll need the Module ID, alfresco-rm-enterprise-repo, to uninstall the AMP file.

  3. Find the Share RM AMP file using the following command:

                 java -jar bin\alfresco-mmt.jar list tomcat\webapps\share.war                        
              

    This shows the Share RM component:

                Module 'alfresco-rm-enterprise-share' installed in 'tomcat\webapps\share.war'
                -    Title:        Alfresco Record Management Share Extension
                -    Version:      2.6
                -    Install Date: Mon November 6 12:05:24 BST 2017
                -    Description:   Alfresco Record Management Share Extension           
              

    You'll need the Module ID, alfresco-rm-enterprise-share, to uninstall the AMP file.

  4. Use these commands to uninstall the AMP files:

                java -jar bin\alfresco-mmt.jar uninstall alfresco-rm-enterprise-repo tomcat\webapps\alfresco.war            
              
                java -jar bin\alfresco-mmt.jar uninstall alfresco-rm-enterprise-share tomcat\webapps\share.war            
              
  5. You can check that the AMP files have been removed by rerunning the commands:

               java -jar bin\alfresco-mmt.jar list tomcat\webapps\alfresco.war                        
            
    and
                 java -jar bin\alfresco-mmt.jar list tomcat\webapps\share.war                        
              
  6. Delete the tomcat\webapps\alfresco and tomcat\webapps\share folders in the Alfresco installation directory.

    Deleting these directories forces Tomcat to read the edited WAR files when Alfresco is restarted.

  7. Restart Alfresco to see your changes.
Parent topic: Installing [4]

Creating the Records Management site

After you've installed the Records Management AMP files, you're ready to go ahead and create a Records Management site.
  1. Start Alfresco, and then log in using your administrator credentials.
  2. Open the Sites menu and click Create Site.

    Tip: You can also click Create Site on the My Sites dashlet.
  3. Select Records Management Site as the Type.

    The Name, URL Name and Description will be completed for you automatically. You can edit the Description if needed. The URL name is used as part of the site URL.

    Note: The site visibility can't be changed as only public sites are available for Records Management. You can only create one records management site.
  4. Select a Compliance option to define which compliance model to use for your file plan. This selection defines the metadata available for records in the file plan.

    • Standard - The standard set of record metadata is available.
    • DoD 5015.2-STD - Record metadata required for DoD 5015.2-STD is available. Mandatory metadata includes the originator, the originating organization, the publication date, the destroy action.

    Note: If you select Standard then users can still customize the metadata available on individual records.
  5. Click Save.
You'll see the dashboard for the new Records Management site which you can now customize. Sites that you create are automatically added to your Favorites list. Now you can:
  • Load Test Data [165] by adding the Import Data Set dashlet for an example of how to structure a File Plan
  • Use the RM Admin Tools on the Records Management dashboard More menu to access the administration features
Note: The user who created the Records Management site is automatically made a member of the Records Management Administrator role. Other users can access different areas of the RM Admin Tools depending on the capabilities given to the role that they're in.
Parent topic: Installing [4]

Records Management global properties settings

Use this information to understand the alfresco-global.properties settings for Records Management.

Settings for Records Management are listed in the <configRoot>/classes/alfresco/module/org_alfresco_module_rm/alfresco-global.properties file. For example:

rm.ghosting.enabled=true
rm.notification.role=RecordsManager
imap.server.attachments.extraction.enabled=false
audit.enabled=true
audit.rm.enabled=true
audit.rm.runas=admin
cache.writersSharedCache.maxItems=10000
cache.writersSharedCache.cluster.type=fully-distributed
rm.rule.runasadmin=true
rm.autocompletesuggestion.minfragmentsize=2
rm.autocompletesuggestion.maxsuggestions.path=5
rm.autocompletesuggestion.maxsuggestions.node=5
rm.autocompletesuggestion.maxsuggestions.date=5
rm.autocompletesuggestion.nodeParameterSuggester.aspectsAndTypes=rma:record,cm:content
rm.dispositionlifecycletrigger.cronexpression=0 0/5 * * * ?
Note: These settings supplement any settings in the <classpathRoot>/alfresco-global.properties file. If a value appears in both files, the Records Management value overrides the <classpathRoot>/alfresco-global.properties value.

Any setting that is false by default, is not shown in the alfresco-global.properties.

A full listing of the settings and their values is shown in this table:
Table 1. Records Management properties with default values and meanings
Setting Meaning
audit.enabled Enable/disable auditing. Default is true.
audit.rm.enabled Enable/disable Records Management auditing. Default is true.
audit.rm.runas Set the user that the audit log runs under. Default is system. Alfresco doesn't audit events triggered by the system; for example, cron jobs. Set this value to admin for these jobs if you want them to be captured in the audit log.

Alternatively, create a user, provide the correct permissions and configure the jobs to run as that user.

audit.rm.viewLog.maxSize=100 The log can be viewed from Share or directly via the Audit log web script. By default the log does not exceed 100 entries. If the maximum size of the log is not configured in the alfresco-global-properties file then it will default to 100. If you include the size parameter in the request it will only be applied if it is less than or equal to the maximum size allowed, or it will be ignored.
cache.writersSharedCache.cluster.type Extended permission service cache: type of cluster used. Default is fully-distributed.
cache.writersSharedCache.maxItems Extended permission service cache: maximum number of items (node references) that are stored in the writer caches. Default is 10000.
imap.server.attachments.extraction.enabled Enable/disable IMAP server attachments. Default is false.
rm.autocompletesuggestion.maxsuggestions.date Auto-complete suggestions: maximum number of date suggestions to provide. Default is 5.
rm.autocompletesuggestion.maxsuggestions.node Auto-complete suggestions: maximum number of node suggestions to provide. Default is 5.
rm.autocompletesuggestion.maxsuggestions.path Auto-complete suggestions: maximum number of path suggestions to provide. Default is 5.

rm.autocompletesuggestion.minfragmentsize

Auto-complete suggestions: Minimum size of fragment to trigger a search. Default is 2.

rm.autocompletesuggestion.nodeParameterSuggester.aspectsAndTypes

Auto-complete suggestions: Comma-separated list of types and aspects used by the node parameter autocomplete suggester. Default is rma:record,cm:content.
rm.content.cleaner This setting is used in conjunction with rm.content.cleansing.enabled=true. Default is contentCleanser.522022M.

When content is sent for deletion, it is cleansed using the default 5220.22-M algorithm. The content is then destroyed, and the node is deleted (if ghosting is not enabled).

If you add a custom content cleaner bean, this can be specified using this property.

rm.content.cleansing.enabled Set whether content can be deleted immediately (data cleansing). This applies to deleted (destroyed) classified records and classified documents.

The default setting of false allows deleted (destroyed) files to be restored (from the Trashcan if they are documents, or by using a recovery tool, if they are records).

This approach is only effective for installations with a single magnetic disk. In other situations, such as RAID or SSD, hardware techniques or process ensure that the content is non-recoverable.

rm.dispositionlifecycletrigger.cronexpression

Disposition lifecycle trigger cron job expression. Default is 0 0/5 * * * ?.
rm.ghosting.enabled Enable/disable ghosting of records, when a record is deleted. Default is true.
rm.notification.role

Specify which role receives notifications; for example, when notifications when vital records are due for review. Default is RecordsManager.

A background job executes by default every 15 minutes to search for vital records that are due for review, and sends a notification. The template for the email notification is editable, and is stored in the Records Management section of the Data Dictionary.

rm.record.contributors.group.enabled

Set which groups can perform Records Management actions; for example, Declare as Record. Default is false.

If this is set to true, only members of the RECORD_CONTRIBUTORS group can perform these actions.

rm.rule.runasadmin Require admin rights/ normal rights to run rules. Default is true.
version.store.enableAutoVersionOnTypeChange Set whether a version is automatically created when the type of a document is changed. Default is false.
Parent topic: Installing [4]

Upgrading

To upgrade Records Management you need to make sure you're running the correct version of Alfresco Content Services.
Check the Supported Platforms [160] and the Alfresco Content Services upgrade paths [166].
Note: If upgrading directly from Alfresco Records Management 2.3.2 ensure you have created an 'rm' site first before upgrading. If you don't do this an error will occur.

When your Alfresco Content Services installation is upgraded, you can apply the new AMP files for Alfresco Records Management.

  1. Ensure that your current Records Management production environment is running an Alfresco version that is supported for upgrading.
  2. Download Alfresco Content Services 5.2.2 and the Records Management AMP zip from the Support Portal [161].
  3. Upgrade to Alfresco Content Services 5.2.2.

    For more information about upgrading, see Upgrading Alfresco [167].

    You can start the Alfresco server at this point to verify that the upgrade was successful.

  4. Apply the Alfresco Records Management to the upgraded Alfresco Content Services installation.

    Follow the instructions in Applying the Records Management AMP files [168].

    Note: If you have easy access records (previously know as in-place records) that are pre-2.3.0.8 versions of Records Management, then you also need to run a webscript [169] so that easy access records created in pre-2.3.0.8 sites are shown in the search results of users without Records Management permissions.
  5. Restart the Alfresco Content Services server, if it is already running.
  6. Log in to Alfresco Share to view the Records Management data.
Your existing Records Management data is migrated to Alfresco Content Services.

When you upgrade from a previous version of Records Management to the Alfresco Records Management install, any existing Records Management data is preserved (it is 'patched' in the same way as updated data in the server). The File Plan structures will appear as they did in 1.0 and the previous Records Management site is migrated. Therefore, you do not need to create the Records Management site again.

From Records Management 2.0 onwards you cannot create a record series; instead you create a record category with no retention schedule. The record series is retained as a deprecated model construct to be used when migrating existing record series from a 1.0 installation. This means that any previously created record series will appear and behave as record categories in 2.2, but will be of the deprecated type record series (directly extended from record category). If any custom data was defined for record series in 1.0, this will still appear in the Records Management site, but only for the migrated record series.

Note also that any pre-configured saved searches from your previous version are not available after an upgrade.

  • Upgrading easy access records from pre-2.3.0.8 versions [170] If you upgrade from a pre-2.3.0.8 version of Records Management, then an additional webscript needs to be run so that easy access records (previously known as in-place records) created in pre-2.3.0.8 sites are shown in the search results of users without Records Management permissions.
Parent topic: Records Management [25]

Upgrading easy access records from pre-2.3.0.8 versions

If you upgrade from a pre-2.3.0.8 version of Records Management, then an additional webscript needs to be run so that easy access records (previously known as in-place records) created in pre-2.3.0.8 sites are shown in the search results of users without Records Management permissions.

It can be run as a one-off operation to convert all existing records or, for better performance on larger repositories, it can also be run on a user-defined number of records.
Note: Easy access records created on Records Management 2.3.0.8 and later are shown without running the webscript.
There are four paramaters available for the webscript.
  • batchsize (mandatory) - the batch size to process records in. So for example, if you enter batchsize=100, then records will be processed in consecutive batches of 100.
  • maxProcessedRecords (optional) - the maximum number of records to be processed. If unspecified, this value defaults to that of the batchsize. If set to 0, all records are processed.
  • export (optional) - "true" or "false" (the default is false). If true is selected then a list of processed records is exported in csv format. The list shows the file name and file node reference.
  • parentNodeRef (optional) - process records in a specified folder and its sub-folders. See step 3 for how to get the parentNodeRef node reference.
You need Alfresco Administrator permissions to run the webscript.
  1. Paste or type http://<server name>:<server port>/alfresco/s/api/rm/rm-dynamicauthorities into your browser.
  2. Append your required parameters, for example:

    • To process 50 records in one batch of 50 type http://<server name>:<server port>/alfresco/s/api/rm/rm-dynamicauthorities?batchsize=50
    • To process 100 records in two batches of 50 type http://<server name>:<server port>/alfresco/s/api/rm/rm-dynamicauthorities?batchsize=50&maxProcessedRecords=100
    • To process all pre-2.3.0.8 records in batches of 100 type http://<server name>:<server port>/alfresco/s/api/rm/rm-dynamicauthorities?batchsize=100&maxProcessedRecords=0
    • To process 10 records in one batch of 10 with csv output type http://<server name>:<server port>/alfresco/s/api/rm/rm-dynamicauthorities?batchsize=10&maxProcessedRecords=10&export=true
  3. Press Enter to run the webscript. You may be prompted for your system username and password.

    Note: If you enter a large batch number then your browser may time out. The process will continue running in the background and details will be recorded in the server logs. As such, it's recommended that you set a maxProcessedRecords or use parentNodeRef to process a folder at a time.
    Tip: To get the parentNodeRef for a folder go to its parent folder, then hover over the folder and select View Details. The node ref will be shown in the browser address.

    Finding a node ref

  4. Results and/or errors are reported as a JSON-formatted string, or a CSV file if you use the export parameter. Processed records are shown in the alfresco.log as below:

    2016-09-16 13:46:44,409 INFO  [org.alfresco.repo.web.scripts.roles.DynamicAuthoritiesGet] [http-apr-8080-exec-6] Processing – BEGIN
    [ output cut ]
    2016-09-16 13:46:47,131 INFO  [org.alfresco.repo.web.scripts.roles.DynamicAuthoritiesGet] [http-apr-8080-exec-6] Processing record file149 (2016-1474021730514).txt - BEGIN
    2016-09-16 13:46:47,150 INFO  [org.alfresco.repo.web.scripts.roles.DynamicAuthoritiesGet] [http-apr-8080-exec-6] Processing record file149 (2016-1474021730514).txt - END
    2016-09-16 13:46:47,152 INFO  [org.alfresco.repo.web.scripts.roles.DynamicAuthoritiesGet] [http-apr-8080-exec-6] Processing record file150 (2016-1474021731516).txt - BEGIN
    2016-09-16 13:46:47,174 INFO  [org.alfresco.repo.web.scripts.roles.DynamicAuthoritiesGet] [http-apr-8080-exec-6] Processing record file150 (2016-1474021731516).txt - END
    2016-09-16 13:46:47,238 INFO  [org.alfresco.repo.web.scripts.roles.DynamicAuthoritiesGet] [http-apr-8080-exec-6] Processing - END
    2016-09-16 13:46:47,238 INFO  [org.alfresco.repo.web.scripts.roles.DynamicAuthoritiesGet] [http-apr-8080-exec-6] Processed first 100 records.
Parent topic: Upgrading [5]

Administering

RM Admin Tools is where you configure the Records Management site.

The user who created the Records Management site is automatically made a member of the Records Management Administrator group. Other users can access different areas of the RM Admin Tools depending on the capabilities given to the role that they're in.

  • Opening the RM Admin Tools [171] You can easily configure Records Management using the RM Admin Tools.
  • Audit [172] The Audit tool is used for external audits to demonstrate compliance to regulatory requirements, and for internal audits for process improvement.
  • Custom metadata [173] Records Management has default sets of metadata for records, record categories, record folders, and non-electronic documents.
  • Define roles [174] Records Management roles and capabilities control what functionality is available to users.
  • Email Mappings [175] One of the many ways that you can file data in the Records Management system is by storing inbound emails as records.
  • Events [176] The life cycle of a record is controlled by either time-based or event-based triggers that are set in the retention schedule. You can edit events and create entirely new ones. When you create an event, you can't delete it.
  • List of values [177] When users edit metadata for folders and records, one of the field types available is a list of values.
  • Relationships [178] In the File Plan you can create relationships between records.
  • User Rights Report [179] The User Rights Report gives you a summary of the Records Management site users, groups, and roles.
  • Users and groups [180] Alfresco users and groups are created by the Alfresco administrator using the Alfresco Share Admin Tools. You can then assign these users and groups to Records Management roles using the Users and Groups tool in the RM Admin Tools.
Parent topic: Records Management [25]

Opening the RM Admin Tools

You can easily configure Records Management using the RM Admin Tools.
Note: The user who created the Records Management site is automatically made a member of the Records Management Administrator group. Other users can access different areas of the RM Admin Tools depending on the capabilities given to the role that they're in.
In a Records Management site click RM Admin Tools.

The RM Admin Tools opens on the Audit page, with various tools available on the left side of the page. Click a tool to manage that part of your site.

Parent topic: Administering [6]

Audit

The Audit tool is used for external audits to demonstrate compliance to regulatory requirements, and for internal audits for process improvement.

It displays auditing information collected from the system to show whether business rules are being followed, and to ensure that any unauthorized activity can be identified and traced. This tool is especially important for systems that deal with classified information.

The Audit tool maintains a complete trace of all the actions on every record and cannot be altered. The information that is captured and stored includes:

  • Any action on any record, folder, category, or the File Plan
  • The user who carried out the action
  • The date and time of the action

The Audit tool displays by default when you access the RM Admin Tools.

  • Running an audit [181] The Audit tool displays by default when you open the Records Management Console.
  • What's in an audit [182] When you run an audit, you are provided with details of all the actions that have taken place in your Records Management site.
  • Stopping and starting the audit log [183] If you have an audit running then you can stop it and restart it later.
  • Filing the audit log as a record [184] When you've run an audit log you then have the option to file it as a record.
  • Exporting the audit log [185] You can export the audit log which is useful for archiving it regularly so that you can examine or analyze system activity.
  • Viewing the full log [186] You can view the full contents of the log file in a separate window. From there you can save an HTML version of the report on your computer or in the Records Management File Plan.
  • Clearing the audit log [187] If you've run an audit you can quickly clear it to delete all captured actions.
Parent topic: Administering [6]

Running an audit

The Audit tool displays by default when you open the Records Management Console.
When you run an audit you can select to run a full audit or you can filter the results.
  1. If you want to filter the audit results then choose from one or more of the following options:

    Filter action
    By default only the first 20 log entries are displayed. Use this option to select the number of displayed entries.
    Select from and to dates for actions to include in the audit.
    Click Specify and search for then select a user you want to audit, then click Add.
    Select an event type to audit. You can only select one event type.
  2. When you've selected the audit filters you want, click Run Audit Report.

    Note: If you don't want to filter the results, then just click Run Audit Report without making any filter selections.
The most recent entries in the log (up to 20) display in chronological order. You can see who performed each event, the user's role, and when it was performed. You can also click a column header to sort the results.
Tip: Click Details to see more information on a specific event.
Parent topic: Audit [172]

What's in an audit

When you run an audit, you are provided with details of all the actions that have taken place in your Records Management site.

The type of action that is recorded in the audit log includes:

  • Capture of all electronic records: file, declare, undeclared
  • Re-categorization of an electronic record within the file plan: a move
  • Any change to any Retention Schedule (instructions): create, modify, destroy
  • Any retention actions carried out by authorized roles: cut off, retain, transfer, review, close folder, reopen folder
  • The adding or removal of an object to a hold
  • Any change made to any metadata associated with File Plan or electronic records, for example, change to vital record indicator
  • Amendment and deletion of metadata by a user
  • Any internal or user event triggered by the system or by the user, for example, SUPERSEDED, GAO Audit, End of Fiscal Year, and so on
  • Changes made to the access permissions
  • Creation, amendment, or deletion of a user or group
  • Changes made to the capabilities (functional access permissions)
  • Changes made to supplemental markings
  • Export and import
  • Deletion / destruction of records
  • Changes to the auditing levels and settings
  • Search operations carried out by users
Parent topic: Audit [172]

Stopping and starting the audit log

If you have an audit running then you can stop it and restart it later.

  1. Click Stop in the Audit tool of the RM Admin Tools if you have an audit running.

    A dialog box prompts you to confirm the action.

  2. Click Yes.

    The auditing tool stops capturing and storing the activity in the Records Management system.

  3. To start the audit log again, click Start. When prompted, click Yes to confirm the action.
Parent topic: Audit [172]

Filing the audit log as a record

When you've run an audit log you then have the option to file it as a record.

  1. When you've run an audit, click File as Record in the Audit tool of the RM Admin Tools.
  2. Choose the destination folder for the audit record.
  3. Click OK.

    A message confirms that the audit log has been filed as a record in the selected folder in the File Plan.

    Note: You'll need to add any required metadata before the record can be completed.
  4. Click OK to dismiss the message. You can also click View Record to display the audit report in the Records Management site.
Parent topic: Audit [172]

Exporting the audit log

You can export the audit log which is useful for archiving it regularly so that you can examine or analyze system activity.
When you export the audit log, this doesn't affect the audit log in the system.
When you've run an audit, click Export in the Audit tool of the RM Admin Tools.

Depending on your browser you'll be prompted to open or save the file or it will be saved automatically. The exported audit log is an HTML file.

Parent topic: Audit [172]

Viewing the full log

You can view the full contents of the log file in a separate window. From there you can save an HTML version of the report on your computer or in the Records Management File Plan.
  1. When you've run an audit, click View Recent Log in the Audit tool of the RM Admin Tools.

    A separate window opens displaying the audit log.

  2. You can save the log report in one or both of the following ways:
    • Click Export to save the report to your computer.
    • Click File as Record to file the report in the File Plan.

    Note: If you select File as Record you'll need to add any required metadata before the record can be completed.
  3. Close the window.
Parent topic: Audit [172]

Clearing the audit log

If you've run an audit you can quickly clear it to delete all captured actions.
  1. When you've run an audit, click Clear Full Log in the Audit tool of the RM Admin Tools.

    A message prompts you to confirm the action.

  2. Click Yes to clear the audit log.
Parent topic: Audit [172]

Custom metadata

Records Management has default sets of metadata for records, record categories, record folders, and non-electronic documents.

You can also add custom metadata that you can associate with each of these different types of records management objects.

You can choose from text fields, date pickers, check boxes, and if you've set up a list of values [188], selection menus.

If required you can choose to make specific custom data mandatory, so that users have to include it when they are completing a record.

Note: If you add mandatory metadata to a records management object type that already has existing instances, the newly mandatory metadata won't be applied to existing instances, as this could cause inconsistencies with the File Plan.
  • Creating custom metadata [189] You can create custom metadata for record categories, record folders, records, and non-electronic documents. When you create custom metadata, you can't delete it.
  • Editing custom metadata [190] You can easily edit any custom metadata that you've set up.
Parent topic: Administering [6]

Creating custom metadata

You can create custom metadata for record categories, record folders, records, and non-electronic documents. When you create custom metadata, you can't delete it.
  1. Click Custom Metadata in the RM Admin Tools.
  2. Select an option in the Object column: Non-Electronic Document, Record, Record Category, or Record Folder.

    The right column lists any custom metadata that's already been defined for the selected object.

  3. Click New.

    The New Metadata page displays.

  4. Type a name for the metadata in the Name field.

    This name is used as the label on the Edit Metadata page.

  5. Select a data Type.

    The type can be of the following values:

    Type Description
    Text Adds a text field to the Edit Metadata page. When you select this option, you can select the Use selection list check box, so instead of a text field there will be a selection menu of the list created with the List of Values tool [177].
    Check box Adds a check box to the Edit Metadata page.
    Date Adds a date field to the Edit Metadata page.

    Note: The Use selection list option is only available if a list has been created with the List of Values tool [177].
  6. To configure this metadata field as a selection menu:
    1. Select the Use selection list check box.
    2. Select a list name from the menu.
  7. Select the Mandatory check box to set this metadata to be mandatory on the Edit Metadata page.

    Note: Mandatory metadata must be completed before a record can be set to completed.
  8. Click Create.
The new metadata displays in the right column of the Custom Metadata page.
Parent topic: Custom metadata [173]

Editing custom metadata

You can easily edit any custom metadata that you've set up.

  1. Click Custom Metadata in the RM Admin Tools.
  2. Select an option in the Object column: Non-Electronic Document, Record, Record Category, or Record Folder.

    The right column lists any custom metadata that's already been defined for the selected object.

  3. Click Edit to the right of the metadata you want to work with.

    The Edit Metadata Property page displays.

  4. Make the required changes then click Save.

    Note: You can't edit the type (text, boolean or date) or the Mandatory option for existing custom metadata.
Parent topic: Custom metadata [173]

Define roles

Records Management roles and capabilities control what functionality is available to users.
Alfresco has several default roles that users and groups can be assigned to:
  • Records Management Administrator
  • Records Management Power User
  • Records Management Records Manager
  • Records Management Security Officer
  • Records Management User
Note: There are also In-Place Readers and In-Place Writers roles but you can't assign users or groups to these in the RM Admin Tools.

These are displayed when you open the Define Roles tool. You can create as many more roles as you need.

Capabilities control what each role can do in the Records Management system, and with nearly 60 unique capabilities to choose from, they can vary hugely between roles.

Tip: The role of Records Management Administrator has all capabilities assigned to it, so take a look at this to see the full list of capabilities available.

You assign users and groups who will all require the same levels of functionality to a role (a user can be assigned to multiple roles at the same time). Assign users and groups to roles using the Users and Groups tool [191]. You can manage roles to change the capabilities that they have.

Capabilities don't conflict and are not hierarchical. A user can be granted a single capability and that capability will not grant any further capabilities. Any user can have zero or more capabilities within the system. A user that has no capabilities is effectively barred from the Records Management system.

Tip: Remember that roles and capabilities are different to permissions, which are set against folders and categories directly in the File Plan.
  • Viewing the capabilities for a role [192] All existing roles are displayed when you open the Define Roles tool.
  • Adding new roles [193] There are five default Records Management roles, but you can add as many more as you need.
  • Editing a role [194] You can edit a role whenever you need to make changes to its name or the capabilities it's been assigned.
  • Deleting a role [195] You can delete a role whenever you need to.
Parent topic: Administering [6]

Viewing the capabilities for a role

All existing roles are displayed when you open the Define Roles tool.

  1. Click Define Roles in the RM Admin Tools.
  2. In the Roles column, select a role to view.

    The list of capabilities assigned to that role display in the Capabilities column.

  3. Select another role to view its assigned capabilities.
Parent topic: Define roles [174]

Adding new roles

There are five default Records Management roles, but you can add as many more as you need.

  1. Click Define Roles in the RM Admin Tools.
  2. Click New Role.

    The New Role page displays all available capabilities, which are organized into groups. You can choose individual items or an entire group to define the categories for the role you're creating.

  3. Enter a name for the role.
  4. Select the capabilities that you wish to apply to the role.
    1. To select an individual capability within a group, click the check box.
    2. To select a group of capabilities, click Select All.

      For example, to select all capabilities for controlling folders, click Select All for the Folder Control group.

    Note: A new role should at a minimum be given the View Records capability so that it can at least view records in the File Plan.
  5. Click Create.
The new role displays in the list of available roles. Now you can add users and groups to the role.
Parent topic: Define roles [174]

Editing a role

You can edit a role whenever you need to make changes to its name or the capabilities it's been assigned.
  1. Click Define Roles in the RM Admin Tools.
  2. In the Roles column, select the role you want to edit.
  3. Click Edit Role.
  4. Edit the name and capabilities as required.
  5. Click Save.
Parent topic: Define roles [174]

Deleting a role

You can delete a role whenever you need to.
Important: Once a role is deleted all users and groups in the role will no longer have access to Records Management.
  1. Click Define Roles in the RM Admin Tools.
  2. In the Roles column, select the role you want to delete.
  3. Click Delete Role.

    A message prompts you to confirm the action.

  4. Click OK.
Parent topic: Define roles [174]

Email Mappings

One of the many ways that you can file data in the Records Management system is by storing inbound emails as records.

The IMAP protocol allows email applications that support IMAP to connect to and interact with Alfresco repositories directly from the mail application.

Alfresco has multiple maps between email headers and Alfresco metadata properties set up by default. You can view these with the Email Mappings tool.

This means that when an email is saved to Records Management, metadata from the email header is captured and mapped to metadata for the record.

For example, an email Subject heading is mapped by default to the Alfresco property title. This is displayed as in the Email Mappings tool as messageSubject to cm:title. The email header field messageSubject is on the left and is separated by the word “to”, which indicates that it is mapped to a property cm:title.

When you're viewing emails within the Records Management system, the title property shows the email’s Subject heading.

As well as the default mappings, you can also add your own or delete existing ones.

  • Adding an email map [196] The pre-defined email mappings cover the most commonly used email headers. You can include additional email header mappings using the Email Mappings tool.
  • Deleting an email map [197] You can delete an email map whenever it's no longer needed.
Parent topic: Administering [6]

Adding an email map

The pre-defined email mappings cover the most commonly used email headers. You can include additional email header mappings using the Email Mappings tool.
  1. Click Email Mappings in the RM Admin Tools.
  2. Type the email header field in the Map box or select one from the menu.
  3. Click Select to select an Alfresco property name.

    You can select an Alfresco property or a custom property.

  4. Click Add.

    The new mapping displays in the list of email mappings.

Parent topic: Email Mappings [175]

Deleting an email map

You can delete an email map whenever it's no longer needed.
  1. Click Email Mappings in the RM Admin Tools.
  2. Browse the list to find the mapping you want to delete.
  3. Click Delete then click Yes to confirm.

    This removes the mapping from the list.

Parent topic: Email Mappings [175]

Events

The life cycle of a record is controlled by either time-based or event-based triggers that are set in the retention schedule. You can edit events and create entirely new ones. When you create an event, you can't delete it.
Events are triggered when actions occur on a record or folder, such as it being versioned, cut off, closed, superseded, or obsoleted. All events belong to one of the following event types:
  • Simple - a standard Records Management event
  • Obsoleted - an item is invalid or out of date and is generally not replaced
  • Superseded - an item is invalid or out of date and is to be replaced with a current record
  • Cross Referenced Record Transferred - a record that is cross referenced is transferred

The following default events are available in Records Management:

  • Abolished - Simple
  • All Allowances Granted Are Terminated - Simple
  • Case Closed - Simple
  • Case Complete - Simple
  • No longer needed - Simple
  • Obsolete - Obsoleted
  • Redesignated - Simple
  • Related Record Transferred to Inactive Storage - Cross Referenced Record Transferred
  • Separation - Simple
  • Study Complete - Simple
  • Superseded - Superseded
  • Training Complete - Simple
  • WGI action complete - Simple
  • Creating a new event [198] Records Management provides an extensive list of events, but it's easy to add to these.
  • Editing an event [199] You can edit all events, whether they are system defaults or ones that you've created.
Parent topic: Administering [6]

Creating a new event

Records Management provides an extensive list of events, but it's easy to add to these.

  1. Click Events in the RM Admin Tools.
  2. Click New Event.

    The New Event page displays.

  3. In the Name field, enter a name for the event.
  4. In the Type field, select the event type from the following:
    • Simple - a standard Records Management event that must be manually completed by a user
    • Obsoleted - an event that is automatically completed when a record is obsoleted by another record based on their relationship
    • Superseded - an event that is automatically completed when a record is superseded by another record based on their relationship
    • Cross Referenced Record Transferred - an event that is automatically completed when a cross referenced record (based on their relationship) is transferred
    • Versioned - an event that is automatically completed when a record is versioned
  5. Click Save.
The new event displays on the Events page.
Parent topic: Events [176]

Editing an event

You can edit all events, whether they are system defaults or ones that you've created.

Note: It's recommended that you don't edit events that are actively in use on your system.
  1. Click Events in the RM Admin Tools.
  2. Browse the list to find the event you want to edit.
  3. Click Edit.

    The Edit Event page displays.

  4. Change the details as necessary.
  5. Click Save.
Parent topic: Events [176]

List of values

When users edit metadata for folders and records, one of the field types available is a list of values.
Two predefined lists are provided with Records Management:
  • Supplemental Markings: security categories that are recommended by the DoD 5015.2
  • Transfer Locations: the names of your storage locations
Note: These are available for both standard and DoD 5015.2-STD compliant File Plans.

You need to provide values for these lists so that users can select from them when they edit metadata. The recommended values for Supplemental Markings are Confidential, Restricted, Secret, Top Secret and Unclassified.

You can also set up new lists as needed, and you can use these lists when you create custom metadata [200].

Where the value is a text string, you can also enter the value using a list of values menu. For example, on the Edit Metadata page, you enter the value for the Mimetype field by selecting a value from the menu.

Important: Administrators can see all security marks and other metadata when browsing the repository (for example, using the Node Browser).
  • Creating a list of values [201] Creating a list is a two step process. First you create the empty list and then you edit it to add the values. Once you create a list, you cannot delete it.
  • Editing a list of values [202] Use the Edit feature to add and delete values for a list. You can also control the user and group access to the values in the list.
  • Renaming a list of values [203] If you need to rename a list of values then it's very easy to do.
Parent topic: Administering [6]

Creating a list of values

Creating a list is a two step process. First you create the empty list and then you edit it to add the values. Once you create a list, you cannot delete it.
  1. Click List of Values in the RM Admin Tools.
  2. Click New List.

    The New List dialog box displays.

  3. In the Name field, enter a name for the list.

    Note: The list name must be unique.
  4. Click OK.
The name of the new list displays on the Lists page.
Parent topic: List of values [177]

Editing a list of values

Use the Edit feature to add and delete values for a list. You can also control the user and group access to the values in the list.
  1. Click List of Values in the RM Admin Tools.
  2. Locate the list you want to modify, and then click Edit.

    The Edit List page displays.

  3. To add values to the list:
    1. In the empty field at the top of the page, type the new value.
    2. Click Add.

      The value name displays in the Values table.

    Note: You can click Delete next to a value to remove it from the list.
  4. To control the user and group access to the individual values in the list:
    1. In the Values table, click the value you want to set access for.

      The selected value is highlighted.

    2. On the right side of the page, click Add.

      The Add Access dialog box displays.

    3. In the search field, type the full or partial name of a user or group.

      You must enter at least three (3) characters.

    4. Click Search.

      A list of users and groups matching the search criteria displays.

    5. Click Add to the right of the user or group you want to have access to the selected value.

      The user or group displays in the right column. You can add as many users and groups as required.

    Note: Only users that you give access to here will be able to see the value when they edit metadata.
  5. When you have finished editing the values and access, click Done to save all changes.
Parent topic: List of values [177]

Renaming a list of values

If you need to rename a list of values then it's very easy to do.

  1. Click List of Values in the RM Admin Tools.
  2. Locate the list you want to rename, and then click Rename.

    The Rename List dialog box displays.

  3. Edit the list name and then click OK.
The modified name displays on the Lists page.
Parent topic: List of values [177]

Relationships

In the File Plan you can create relationships between records.
There are two types of relationships that can be established between records:
  • Bi-directional - a two-way relationship such as a cross-reference
  • Parent/Child - a relationship where the child is dependant upon its parent, such as when the parent is superseded by the child

The names given to individual relationships are based on the different types of referencing, and are what makes each one unique.

You can see the default relationship types that are included in Records Management and you can create new and manage existing relationships.

  • Creating a new relationship [204] The RM Admin Tools has several default relationships. You can add more relationships, but once you create a relationship you can't delete it.
  • Editing a relationship [205] You can't delete relationships once they're created, but you can edit them.
Parent topic: Administering [6]

Creating a new relationship

The RM Admin Tools has several default relationships. You can add more relationships, but once you create a relationship you can't delete it.
  1. Click Relationships in the RM Admin Tools.
  2. Click New Relationship.

    The New Relationship page displays.

  3. Select the relationship type:
    • Bi-directional
    • Parent/Child
  4. If the relationship type is Bi-directional, complete the Label field, and if the relationship type is Parent/Child, complete the Source and Target fields.

    The values you enter display in the File Plan when a user creates the reference.

    Tip: The existing default values give good examples of how to label relationships.
  5. Click Save.

    The new relationship appears in the list.

Parent topic: Relationships [178]

Editing a relationship

You can't delete relationships once they're created, but you can edit them.
  1. Click Relationships in the RM Admin Tools.
  2. Locate the relationship you want to modify, and then click Edit.

    The Edit Relationship page displays. You can't change the relationship type; only the field values can be modified.

  3. Make the necessary changes:
    • If the relationship type is Bi-directional, edit the Label field.
    • If the relationship type is Parent/Child, edit the Source and Target fields.
  4. Click Save.
Parent topic: Relationships [178]

User Rights Report

The User Rights Report gives you a summary of the Records Management site users, groups, and roles.
The report is divided into three sections:
  • Users - All users of the Records Management site, and the roles and groups they are a member of
  • Roles - All roles in the Records Management site, and the users in those roles
  • Groups - All groups that are members of the Records Management site, and the users in those groups
You can access the report by clicking User Rights Report in the RM Admin Tools.
Parent topic: Administering [6]

Users and groups

Alfresco users and groups are created by the Alfresco administrator using the Alfresco Share Admin Tools. You can then assign these users and groups to Records Management roles using the Users and Groups tool in the RM Admin Tools.

Once you've assigned them to a role [206] they'll be able to use the level of Records Management functionality that role has been given.

Note: There are some system groups that are generated by default, such as site_swsdp_SiteManager. These can't be assigned to a role.
  • Adding users and groups to a role [207] Adding users and groups to a role gives them permission to use the level of Records Management functionality that role has been given.
Parent topic: Administering [6]

Adding users and groups to a role

Adding users and groups to a role gives them permission to use the level of Records Management functionality that role has been given.
  1. Click Users and Groups in the RM Admin Tools.

    All existing roles are displayed. When you click on a role the groups and users assigned to that role are displayed.

  2. Locate the role you want to add groups or users to and click on it.

    Existing groups and users assigned to the role are displayed.

  3. Click Add next to Groups or Users, depending on which you want to add.

    The Add User or Add Group page displays.

  4. Enter a search term and click Search.

    All users or groups matching your search are displayed.

  5. Click Add next to the user or group that you want to add to the role.

    The new group users is added to the role.

    Note: You can remove a group or user from a role at any time by selecting them and clicking Remove then Yes to confirm.
Parent topic: Users and groups [180]

Records Management FAQs

Here are the answers to some frequently asked questions about Records Management.
  • What are the differences between a DoD 5015.2 and standard Records Management sites? [208]
  • How does classification interact with standard Records Management permissions? [209]
  • Why can't I see a classified file? [210]
  • Why are the tags showing more files than I can see? [211]
  • Why can't I upload a file when I have the required permissions? [212]
  • Are RSS feeds secure? [213]
  • Why isn't hot backup working properly? [214]
  • Records uploaded using CIFS, WebDav, or FTP don't have any content? [215]

What are the differences between a DoD 5015.2 and standard Records Management sites?

When you create a Records Management site you can choose to create a DoD 5015.2 site or a standard site. If your organization is required to meet DoD 5015.2 compliance, then select DoD 5015.2-STD. Records on a DoD 5015.2 site have additional madatory metadata the must be completed. Mandatory metadata includes the originator, the originating organization, the publication date, the destroy action.

back to top [216]

How does classification interact with standard Records Management permissions?

There are two levels of interaction between classification and permissions. To view a classified file or record you need to have read permissions for that file and the required clearance level. To classify a file or record, or edit the classification, you need to have read and file permission and clearance to use the classification level(s) involved.

back to top [216]

Why can't I see a classified record when I have the required clearance?

Having the required clearance level isn't all that's needed to view a classified record. You also need to have the required permissions, including but not restricted to permission to view the category, permission to view the folder, and permission to view the record.

back to top [216]

Why are the tags showing more files than I can see?

Depending on your security clearance level, some files or records might be hidden from you in Alfresco. The tags link displays the total number of files that have that tag, but when you click it you'll only be able to see those that you have access to.

Hidden tagged files

back to top [216]

Why can't I upload a file when I have the required permissions?

In each folder you can't have multiple files of the same name. You might have permissions to add files, but may not have security clearance to see, for example, files that have been classified as Top Secret. If you try to upload a file when there is already one in the folder, even if you can't see it, you'll receive a message: Unexpected error occurred during upload of new content.

back to top [216]

Are RSS feeds secure?

RSS feeds are secure, but the login credentials are stored by the browser you're using and not Alfresco. As such it's recommended that you close your browser after logging out of Alfresco and / or lock your computer while you're away from it.

back to top [216]

Why isn't hot backup working properly?

The default behavior for classified records is "immediate delete", which means that content is deleted immediately, and will not be included in a hot backup. If you have performed a hot backup and you try to retrieve content that was deleted, a Requested resource is not available message is displayed.

back to top [216]

Records uploaded using CIFS, WebDav, or FTP don't have any content?

There's a known issue that when users with the Records Management User role and Read and File permissions add a record using CIFS, WebDav, or FTP, the record is added but it's content is removed. Other issues may also occur. It's recommended that users in this situation are given an alternate Records Management role to resolve the issue.

back to top [216]

Parent topic: Records Management [25]

Records Management Glossary

The glossary explains the meaning of terms and acronyms that are used in the Alfresco Records Management documentation.
Accession
Accession is when responsibility for a record is relinquished by moving it into another system or institution. The institution is usually a government archive, such as NARA.

The key difference between an accession and a transfer is that when records are accessioned they are no longer the responsibility of your Records Management system. When transferred (to another physical location) you are still responsible for the record. Accession reports can be used to record when a record was accessioned, where it went, and why.

Capabilities
Capabilities are assigned to user roles in the RM Admin Tools and define what you can do in the Records Management site, whereas permissions are specific to sections of the File Plan. For example, you might be assigned the capability to create folders but not categories, or just have the capability to add records.
Category
Record categories contains the retention and retention schedules for folders and records. They control how records are managed, and how they're disposed of when they're not needed any more. The top level of the File Plan can only contain record categories. A category can contain other categories and folders.
Classify
Both files and records can be classified using their Classify option to apply a security classification and security marks. When a file or record is classified it can only be seen by those with the required security clearance, and the security classification level is shown on screen.
Closed (Record Folder)
When a record folder is closed then no more records can be added to it. Records can't be moved into or out of a closed record folder. You can reopen a closed record folder. Record folders are automatically closed when they're cut off.
Completed Record
A completed record is one that has all the information (metadata) present for it’s business context to make sense. A record can't be disposed of until it's complete. Usually a record can only be completed when all the mandatory metadata has been entered.
Cut Off
This is the first step in a retention schedule. Once a record or folder is cut off this triggers the records retention period. Cut Off or inactive records can't be edited. Cut off or inactive record folders are closed.
Declare as Record
You can declare files in non-Records Management sites as records. When you create an "easy access record", a record of the file is added to the Records Management site. The file is still visible in its original site but is locked and has only a limited set of actions.
Disposable Item
A disposable item is a record that can be disposed of by being processed through a retention schedule.
DoD 5015.2-STD
If you create a site of this type then in has additional metadata requirements, as required by the US Department of Defense. Mandatory metadata includes the originator, the originating organization, the publication date, the destroy action.
Easy Access Records (previously In-place Records)
Records that are created from a file that's in another site, rather than being uploaded directly to the Records Management site. The originating file can still be found and accessed in it’s original location after it has been declared a record and is in the File Plan.
Electronic Record
A record such as an email, spreadsheet, or image that can be stored in the Records Management site. A non-electronic record is a physical record such as a paper letter or microfilm.
Events
The life cycle of a record is controlled by either time-based or event-based triggers that are set in the retention schedule. Events are triggered when actions occur on a record or folder, such as it being versioned, cut off, closed, superseded, or obsoleted.
File Plan
The File Plan is a container for records, folders, categories and retention schedules. It's effectively a virtual filing cabinet for storing records, and is the basic structure of Records Management. This structure lets you classify and group records with similar characteristics. The top level of the File Plan is created when you create a Records Management site.
Hold
A hold is a state that you can put records and record folders in to freeze them and suspend their retention schedules indefinately. The reason for doing this often relates to a legal issue. Records and folder on hold can't be edited or disposed of, until such a time that they are removed from the hold or the hold itself is deleted.
Non-electronic Record
A non-electronic record is a physical record such as a paper letter or microfilm. A non-electronic record in the File Plan is a reference to this physical record. A electronic record is a record such as an email, spreadsheet, or image that can be stored in the Records Management site.
Publication Date
The date that a record is completed and becomes part of the File Plan. This is mandatory metadata in DoD 5015.2-STD.
Rejected records
After you've created a record from a file, the Records Manager has the option to reject the record from the Records Management site. If they reject the record then the original file will display a warning that it's a Rejected Record. At this point the options to declare the file as a record aren't available.
Retention Schedule (previously Disposition Schedule)
A schedule of actions, events, and rules that determines how records are managed throughout their lifecycle. The actions that can happen in a retention schedule are: Retain – for a period or until an event, Cutoff – retention schedule triggered, Transfer – move to another location/system, Accession - record moved to another authority, Destroy - removed from the system
Security Classification
A predefined security group made up of security marks (Top Secret, Secret, Confidential, and Unclassified). It can be assigned to content and users, to control who can see sensitive information.
Security Clearance
Security clearance is determined by which security marks are assigned to users. Once marks are applied to content then users can only see that content if they have the required security clearance.
Security Control
Security controls is the collective term for security classifications and security groups, which in turn are made up of one or more security marks.
Security Groups
These are security controls that can be created in addition to the predefined Classification group.
Security Mark
Security marks are the individual components that make up a security group with each mark representing a different security requirement. They're applied to content and users to control access to content. Only users with a mark assigned to them can see content that has been classified with that mark.
Transfer
You can transfer records and record folders between locations. Transferred records/folders are temporarily held in the Transfers area of the File Plan until you hover over them and click Complete Transfer.
Unfiled records
When a record is declared from a non-Records Management site it's added to the Unfiled Records area. It then needs to be added to a records folder.

Parent topic: Records Management [25]

Source URL: https://docs.alfresco.com/rm/concepts/welcome-rm.html

Links:
[1] https://docs.alfresco.com/../topics/alfresco-video-tutorials-rm.html
[2] https://docs.alfresco.com/../concepts/rm-gs-overview.html
[3] https://docs.alfresco.com/../concepts/rm-intro.html
[4] https://docs.alfresco.com/../tasks/rm-install-proc.html
[5] https://docs.alfresco.com/../tasks/rm-upgrade-proc.html
[6] https://docs.alfresco.com/../concepts/rm-admin-intro.html
[7] https://docs.alfresco.com/../references/rm-user-faqs.html
[8] https://docs.alfresco.com/../references/rm-glossary.html
[9] https://docs.alfresco.com/../concepts/welcome-gs.html
[10] https://docs.alfresco.com/../concepts/rm-tutorials-01.html
[11] https://docs.alfresco.com/../concepts/rm-tutorials-02.html
[12] https://docs.alfresco.com/../concepts/rm-tutorials-03.html
[13] https://docs.alfresco.com/../concepts/rm-tutorials-04.html
[14] https://docs.alfresco.com/../concepts/rm-tutorials-05.html
[15] https://docs.alfresco.com/../concepts/rm-tutorials-06.html
[16] https://docs.alfresco.com/../concepts/rm-tutorials-07.html
[17] https://docs.alfresco.com/../concepts/rm-tutorials-08.html
[18] https://docs.alfresco.com/../concepts/rm-tutorials-09.html
[19] https://docs.alfresco.com/../concepts/rm-tutorials-10.html
[20] https://docs.alfresco.com/../concepts/rm-tutorials-11.html
[21] https://docs.alfresco.com/../concepts/rm-tutorials-12.html
[22] https://docs.alfresco.com/../concepts/rm-tutorials-13.html
[23] https://docs.alfresco.com/../concepts/rm-tutorials-14.html
[24] https://docs.alfresco.com/../concepts/rm-tutorials-15.html
[25] https://docs.alfresco.com/../concepts/welcome-rm.html
[26] https://docs.alfresco.com/../concepts/rm-record-lifecycle.html
[27] https://docs.alfresco.com/../concepts/rm-gs-managers.html
[28] https://docs.alfresco.com/../concepts/rm-gs-users.html
[29] https://docs.alfresco.com/../tasks/rm-recordcategory-add.html
[30] https://docs.alfresco.com/../tasks/rm-dispschedule-create.html
[31] https://docs.alfresco.com/../tasks/rm-dispschedule-createsteps.html
[32] https://docs.alfresco.com/../tasks/rm-set-financial-year.html
[33] https://docs.alfresco.com/../tasks/rm-recordfolder-add.html
[34] https://docs.alfresco.com/../tasks/rm-set-permissions.html
[35] https://docs.alfresco.com/../concepts/rm-fileplanstruct-create.html
[36] https://docs.alfresco.com/../concepts/rm-dispschedule.html
[37] https://docs.alfresco.com/rm-set-financial-year.html
[38] https://docs.alfresco.com/rm-records-manage-reference.html
[39] https://docs.alfresco.com/rm-dispschedule-edit.html
[40] https://docs.alfresco.com/../concepts/rm-manage-permissions.html
[41] https://docs.alfresco.com/../tasks/rm-electronic-file.html
[42] https://docs.alfresco.com/../tasks/rm-create-record.html
[43] https://docs.alfresco.com/../tasks/rm-file-unfiled.html
[44] https://docs.alfresco.com/../tasks/rm-metadata-add.html
[45] https://docs.alfresco.com/../tasks/rm-metadata-edit.html
[46] https://docs.alfresco.com/../tasks/rm-record-declare.html
[47] https://docs.alfresco.com/../tasks/rm-dispsched-actions.html
[48] https://docs.alfresco.com/../concepts/rm-records-overview.html
[49] https://docs.alfresco.com/../concepts/rm-easy-access.html
[50] https://docs.alfresco.com/rm-records-manage-link.html
[51] https://docs.alfresco.com/../tasks/rm-recordfolder-manage.html
[52] https://docs.alfresco.com/../tasks/rm-records-manage.html
[53] http://docs.alfresco.com/5.2/topics/sh-uh-welcome.html
[54] https://docs.alfresco.com/rm-admin-intro.html
[55] https://docs.alfresco.com/../concepts/rm-fileplan.html
[56] https://docs.alfresco.com/../concepts/rm-fileplan-manage.html
[57] https://docs.alfresco.com/../concepts/rm-rules.html
[58] https://docs.alfresco.com/../concepts/rm-search.html
[59] https://docs.alfresco.com/../concepts/rm-auditing.html
[60] https://docs.alfresco.com/../tasks/rm-load-testdata.html
[61] https://docs.alfresco.com/rm-rules.html
[62] https://docs.alfresco.com/../tasks/rm-fileplan-access.html
[63] https://docs.alfresco.com/../concepts/rm-fileplan-browse.html
[64] https://docs.alfresco.com/rm-manage-permissions.html
[65] https://docs.alfresco.com/../references/rm-disp-example.html
[66] https://docs.alfresco.com/../tasks/rm-dispschedule-edit.html
[67] https://docs.alfresco.com/rm-export-import.html
[68] https://docs.alfresco.com/../tasks/rm-nonelect-file.html
[69] https://docs.alfresco.com/../tasks/rm-records-manage-requestinfo.html
[70] https://docs.alfresco.com/rm-records-manage-unfiled.html
[71] https://docs.alfresco.com/../tasks/rm-classify-file.html
[72] https://docs.alfresco.com/../tasks/rm-create-version-record.html
[73] https://docs.alfresco.com/../tasks/rm-autodeclare-options.html
[74] https://docs.alfresco.com/../tasks/rm-easy-access-move.html
[75] https://docs.alfresco.com/../tasks/rm-easy-access-hide.html
[76] https://docs.alfresco.com/../references/rm-rejected-records.html
[77] https://docs.alfresco.com/rm-classify-record.html
[78] https://docs.alfresco.com/../references/rm-classification-tips.html
[79] https://docs.alfresco.com/../concepts/rm-sc-overview.html
[80] https://docs.alfresco.com/rm-create-record.html
[81] http://docs.alfresco.com/5.2/concepts/library-organize.html
[82] https://docs.alfresco.com/../tasks/rm-recordcategory-manage.html
[83] https://docs.alfresco.com/../concepts/rm-manage-holds.html
[84] https://docs.alfresco.com/../concepts/rm-export-import.html
[85] https://docs.alfresco.com/../tasks/rm-recordcategory-view.html
[86] https://docs.alfresco.com/../tasks/rm-recordcategory-edit.html
[87] https://docs.alfresco.com/../tasks/rm-recordcategory-delete.html
[88] https://docs.alfresco.com/../tasks/rm-recordfolder-view.html
[89] https://docs.alfresco.com/../tasks/rm-recordfolder-edit.html
[90] https://docs.alfresco.com/../tasks/rm-recordfolder-events.html
[91] https://docs.alfresco.com/../tasks/rm-recordfolder-editdispdate.html
[92] https://docs.alfresco.com/../tasks/rm-recordfolder-freeze.html
[93] https://docs.alfresco.com/../tasks/rm-recordfolder-close.html
[94] https://docs.alfresco.com/../tasks/rm-recordfolder-delete.html
[95] https://docs.alfresco.com/../tasks/rm-records-manage-view.html
[96] https://docs.alfresco.com/../tasks/rm-records-manage-link.html
[97] https://docs.alfresco.com/../tasks/rm-records-manage-reference.html
[98] https://docs.alfresco.com/../tasks/rm-records-manage-review.html
[99] https://docs.alfresco.com/../concepts/rm-records-manage-unfiled.html
[100] https://docs.alfresco.com/../tasks/rm-records-manage-events.html
[101] https://docs.alfresco.com/../tasks/rm-records-manage-editdate.html
[102] https://docs.alfresco.com/../tasks/rm-records-manage-dispdate.html
[103] https://docs.alfresco.com/../tasks/rm-records-manage-freeze.html
[104] https://docs.alfresco.com/../tasks/rm-records-manage-reopen.html
[105] https://docs.alfresco.com/../tasks/rm-records-manage-delete.html
[106] https://docs.alfresco.com/../tasks/rm-search-addhold.html
[107] https://docs.alfresco.com/../tasks/rm-create-hold.html
[108] https://docs.alfresco.com/../tasks/rm-export.html
[109] https://docs.alfresco.com/../tasks/rm-export-fileplan.html
[110] https://docs.alfresco.com/../tasks/rm-import.html
[111] https://docs.alfresco.com/../concepts/rm-rules-define.html
[112] https://docs.alfresco.com/../concepts/rm-rules-defined.html
[113] https://docs.alfresco.com/../concepts/rm-rules-linked.html
[114] https://docs.alfresco.com/../tasks/rm-rules-define-create.html
[115] https://docs.alfresco.com/../tasks/rm-rules-define-link.html
[116] http://docs.alfresco.com/5.2/tasks/library-folder-rules-new.html
[117] https://docs.alfresco.com/../references/rm-rules-substitutions.html
[118] https://docs.alfresco.com/rm-rules-change-link.html
[119] https://docs.alfresco.com/../tasks/rm-rules-new.html
[120] https://docs.alfresco.com/../tasks/rm-rules-edit.html
[121] https://docs.alfresco.com/../tasks/rm-rules-reorder.html
[122] https://docs.alfresco.com/../tasks/rm-rules-inherited.html
[123] https://docs.alfresco.com/../tasks/rm-rules-delete.html
[124] https://docs.alfresco.com/rm-rules-define-create.html
[125] https://docs.alfresco.com/../tasks/rm-rules-change-link.html
[126] https://docs.alfresco.com/../tasks/rm-rules-break-link.html
[127] https://docs.alfresco.com/rm-search-syntax.html
[128] https://docs.alfresco.com/../tasks/rm-search-access.html
[129] https://docs.alfresco.com/../tasks/rm-search-create.html
[130] https://docs.alfresco.com/../tasks/rm-search-saved.html
[131] https://docs.alfresco.com/../tasks/rm-search-save.html
[132] https://docs.alfresco.com/../tasks/rm-search-print.html
[133] https://docs.alfresco.com/../tasks/rm-search-export.html
[134] https://docs.alfresco.com/../tasks/rm-search-saved-delete.html
[135] https://docs.alfresco.com/../concepts/rm-search-syntax.html
[136] https://docs.alfresco.com/rm-search-daterange.html
[137] https://docs.alfresco.com/../concepts/rm-search-examples.html
[138] https://docs.alfresco.com/../concepts/rm-search-fields.html
[139] https://docs.alfresco.com/../concepts/rm-search-specialfields.html
[140] https://docs.alfresco.com/rm-search-fields.html
[141] https://docs.alfresco.com/rm-search-specialfields.html
[142] https://docs.alfresco.com/../tasks/rm-search-text.html
[143] https://docs.alfresco.com/../tasks/rm-search-wildcards.html
[144] https://docs.alfresco.com/../tasks/rm-search-multiple.html
[145] https://docs.alfresco.com/../tasks/rm-search-phrases.html
[146] https://docs.alfresco.com/../tasks/rm-search-exactterm.html
[147] https://docs.alfresco.com/../tasks/rm-search-dates.html
[148] https://docs.alfresco.com/../tasks/rm-search-daterange.html
[149] https://docs.alfresco.com/../tasks/rm-search-specialtypes.html
[150] https://docs.alfresco.com/../tasks/rm-search-emptystring.html
[151] https://docs.alfresco.com/../tasks/rm-search-components.html
[152] https://docs.alfresco.com/../tasks/rm-search-operators.html
[153] https://docs.alfresco.com/../tasks/rm-file-report.html
[154] https://docs.alfresco.com/../tasks/rm-audit-viewing.html
[155] https://docs.alfresco.com/../concepts/supported-stacks.html
[156] https://docs.alfresco.com/../tasks/rm-amp-install.html
[157] https://docs.alfresco.com/../tasks/rm-amp-uninstall.html
[158] https://docs.alfresco.com/../tasks/rm-create-site.html
[159] https://docs.alfresco.com/../concepts/rm-ref-global-props.html
[160] http://docs.alfresco.com/5.2/concepts/supported-platforms-ACS.html
[161] http://support.alfresco.com
[162] http://docs.alfresco.com/tasks/amp-install.html
[163] http://docs.alfresco.com/tasks/uninstall-amp.html
[164] http://docs.alfresco.com/5.2/concepts/dev-extensions-modules-management-tool.html
[165] https://docs.alfresco.com/rm-load-testdata.html
[166] http://docs.alfresco.com/5.2/concepts/upgrade-path.html
[167] http://docs.alfresco.com/5.2/concepts/ch-upgrade.html
[168] https://docs.alfresco.com/rm-amp-install.html
[169] https://docs.alfresco.com/rm-upgrade-2308.html
[170] https://docs.alfresco.com/../tasks/rm-upgrade-2308.html
[171] https://docs.alfresco.com/../tasks/rm-console-access.html
[172] https://docs.alfresco.com/../concepts/rm-audit-intro.html
[173] https://docs.alfresco.com/../concepts/rm-custmeta-intro.html
[174] https://docs.alfresco.com/../concepts/rm-roles-intro.html
[175] https://docs.alfresco.com/../concepts/rm-emailmap-intro.html
[176] https://docs.alfresco.com/../concepts/rm-events-intro.html
[177] https://docs.alfresco.com/../concepts/rm-lov-intro.html
[178] https://docs.alfresco.com/../concepts/rm-relationships-intro.html
[179] https://docs.alfresco.com/../tasks/rm-userrights-view.html
[180] https://docs.alfresco.com/../concepts/rm-usergroups-intro.html
[181] https://docs.alfresco.com/../tasks/rm-audit-access.html
[182] https://docs.alfresco.com/../concepts/rm-audit-actions.html
[183] https://docs.alfresco.com/../tasks/rm-audit-startstop.html
[184] https://docs.alfresco.com/../tasks/rm-audit-filerecord.html
[185] https://docs.alfresco.com/../tasks/rm-audit-export.html
[186] https://docs.alfresco.com/../tasks/rm-audit-viewlog.html
[187] https://docs.alfresco.com/../tasks/rm-audit-clear.html
[188] https://docs.alfresco.com/rm-lov-intro.html
[189] https://docs.alfresco.com/../tasks/rm-custmeta-create.html
[190] https://docs.alfresco.com/../tasks/rm-custmeta-edit.html
[191] https://docs.alfresco.com/rm-usergroups-intro.html
[192] https://docs.alfresco.com/../tasks/rm-roles-view.html
[193] https://docs.alfresco.com/../tasks/rm-roles-add.html
[194] https://docs.alfresco.com/../tasks/rm-roles-edit.html
[195] https://docs.alfresco.com/../tasks/rm-roles-delete.html
[196] https://docs.alfresco.com/../tasks/rm-emailmap-add.html
[197] https://docs.alfresco.com/../tasks/rm-emailmap-delete.html
[198] https://docs.alfresco.com/../tasks/rm-events-add.html
[199] https://docs.alfresco.com/../tasks/rm-events-edit.html
[200] https://docs.alfresco.com/rm-custmeta-intro.html
[201] https://docs.alfresco.com/../tasks/rm-lov-create.html
[202] https://docs.alfresco.com/../tasks/rm-lov-edit.html
[203] https://docs.alfresco.com/../tasks/rm-lov-rename.html
[204] https://docs.alfresco.com/../tasks/rm-relationships-create.html
[205] https://docs.alfresco.com/../tasks/rm-relationships-edit.html
[206] https://docs.alfresco.com/rm-roles-intro.html
[207] https://docs.alfresco.com/../tasks/rm-usergroups-add.html
[208] https://docs.alfresco.com/rm-user-faqs.html%23rm-user-faqs__dod-differences
[209] https://docs.alfresco.com/rm-user-faqs.html%23rm-user-faqs__classification-permissions
[210] https://docs.alfresco.com/rm-user-faqs.html%23rm-user-faqs__classification-hidden
[211] https://docs.alfresco.com/rm-user-faqs.html%23rm-user-faqs__tags
[212] https://docs.alfresco.com/rm-user-faqs.html%23rm-user-faqs__duplicate
[213] https://docs.alfresco.com/rm-user-faqs.html%23rm-user-faqs__rss
[214] https://docs.alfresco.com/rm-user-faqs.html%23rm-user-faqs__delete
[215] https://docs.alfresco.com/rm-user-faqs.html%23rm-user-faqs__cifs
[216] https://docs.alfresco.com/rm-user-faqs.html%23top