Book Image

Alfresco 3 Records Management

Book Image

Alfresco 3 Records Management

Overview of this book

The Alfresco Records Management feature set is so complete that it is one of the very limited number of systems, and the only Open Source solution, that has been fully certified for Records Management use by the US Department of Defense. Record keeping is important because accurate records are really the only way that organizations can demonstrate compliance with regulatory requirements. The amount of regulation that organizations must comply with has gone up dramatically over the last decade, and the complexity of record management has increased proportionally.Alfresco 3 Records Management is a complete guide for setting up records programs within organizations. The book is the first and only one that describes Alfresco's implementation of Records Management. It not only teaches the technology for implementing Records Management, but also discusses the important roles that both processes and people play in the building of a successful records program.Alfresco 3 Records Management starts with a description of the importance of record keeping, especially from a regulatory compliance perspective. It then discusses Records Management best practices and standards, and goes on to describe step by step how to identify documents that need to be managed as records, how to use Alfresco Records Management software to set up the File Plan structure for organizing the storage of records, and then how to manage the lifecycle of the records.The book provides detailed instructions for installing and configuring Alfresco Records Management. The topics covered include setting up a record File Plan, filing records, establishing record retention schedules, setting up security and permissions, assigning metadata, extending the content model, using advanced search techniques, and creating system activity audit reports. The book also provides "deep-dive" information from a developer's perspective about how the Records Management module was implemented within the Alfresco Share platform.Alfresco 3 Records Management covers features available in both the Community and Enterprise versions of Alfresco software. By the end of this book, you will be able to successfully develop a records policy and implement it within Alfresco Records Management.
Table of Contents (18 chapters)
Alfresco 3 Records Management
Credits
About the Author
About the Reviewer
www.PacktPub.com
Preface
Free Chapter
1
Records Management

Preface

Alfresco Enterprise Content Management (ECM) software provides content-centric features in the areas of Document Management (DM), Web Content Management (WCM), and Microsoft SharePoint-like Collaboration. Alfresco is particularly strong in handling the storage of large amounts of content and in enabling collaboration. Alfresco software is licensed as either open source Community or with a fully-supported Enterprise license.

There has been incredible growth in the breadth of the capabilities of Alfresco software since the initial Alfresco software release in 2005. Much of that growth has been possible due to good software architectural decisions that Alfresco developers made early on. Those early decisions drove the development of a solid and extensible software foundation that has enabled new capabilities to be rapidly built out.

In late 2009, Alfresco introduced another new capability, an extension for Records Management that was not only compatible with, but also certified for, the Department of Defense (DoD) 5015.2 Records Management standard.

The announcement was notable, because firstly, the certification for 5015.2 is difficult to achieve. Only a few more than a dozen vendors out of an industry with vendors numbering in the hundreds have managed to be certified for 5015.2. Secondly, it was notable because Alfresco made the records software available as a free component in the open source community version of its software. Prior to that announcement, certified Records Management software was available for many tens, if not hundreds, of thousands of dollars.

The focus of this book is the Alfresco Records Management Module. To fully understand how Alfresco Records Management works, and why it works the way it does, it is necessary to also understand many of the basics of Records Management. This book tries to cover sufficient background in Records Management to bring users up to speed so that they can effectively set up a records program within their organization and then go about implementing the program using Alfresco Records Management.

As a result of the approach taken, the first chapter in the book is focused almost exclusively on Records Management without any specifics on the Alfresco implementation. After that, we dive down into great detail about how to set up, configure, and actually use Alfresco Records Management.

Dick Weisinger, the author of this book, is Vice President and Chief Technologist at Formtek, Inc. Formtek and provides Enterprise Content Management (ECM) software and services to its customers globally. Headquartered in the US, Formtek has partners and customers in the Americas, Asia, and Europe. Records Management and Alfresco software are some of Formtek's core capabilities.

Note

Additional information can be found about Formtek products and services at http://www.formtek.com.

What this book covers

Chapter 1, Records Management, describes the importance of Records Management and provides an overview of the general principles and the benefits that can be derived from implementing Records Management. Both Records Management standards, ISO 15489 and DoD 5015.2, are introduced.

Chapter 2, Getting Started with the Alfresco Records Management Module, narrows the discussion of Records Management to the Alfresco Records Management implementation. This chapter describes in detail how to install Alfresco Share with the Records Management Module, and then how to create the Alfresco Share Records Management site. In the latter part of this chapter, we discuss technical details of Alfresco webscripts and some of the underlying implementation of the Records Management dashlet.

Chapter 3, Introduction to the Alfresco Share Records Management Site, describes the basic framework of an Alfresco Share site, describing Share dashboards and collaboration features. The chapter also gives an overview of the File Plan and Records Search pages, which are unique to the Records Management site. At the end of this chapter, we examine some of the internal workings of Share site dashboards and the dashlets contained within them.

Chapter 4, Metadata and the Alfresco Content Model, introduces the Content Model structure used by Alfresco for defining document types and for specifying the metadata properties that are associated with document types. This chapter discusses in great detail how to define and extend document types and aspects of the Alfresco Content Model. Specifically the Records Management content models are looked at in detail.

Chapter 5, Creating the File Plan, describes best practices for developing a File Plan that uniquely fits the needs of your organization. We then see how to take the File Plan design and implement it within Alfresco. The chapter describes the mechanics of the File Plan implementation which involves creating the DoD 5015.2 foldering hierarchy of Series, Category, and Folder container. In the latter part of the chapter, we look at the internals of the File Plan page within the Records Management site. We note that this page is similar to and shares code with the Document Library page used by standard Share sites.

Chapter 6, Creating Disposition Schedules, describes how record retention and lifecycle information is defined within the disposition schedule. This chapter shows how a disposition schedule is created and applied at the Category level within the File Plan. The end of the chapter examines how the disposition page in the web client is constructed and interacts with the Alfresco repository using AJAX. We also see in detail how and where disposition information is stored within the repository.

Chapter 7, Filing Records, shows that methods other than the Alfresco Share web browser interface can be used to file records. The chapter describes how records can also be filed from an e-mail client, like Microsoft Outlook, or directly from the file system, using, for example, Windows Explorer in the Microsoft Windows operating system, or via FTP or batch loading programs. At the end of the chapter, we examine the low-level details of how files are uploaded and stored in the repository, and we also look at the internals of the upload form that allows multiple files to be selected for upload from the browser client.

Chapter 8, Managing Records, covers how to perform operations on records once the records have been filed into the File Plan. The operations discussed include copy, move, delete, the creation of links between records, and the viewing of a record's audit history. The latter part of the chapter discusses some of the internal implementation details of the built-in web preview capability.

Chapter 9, Following the Lifecycle of a Record, walks through the possible steps of the record lifecycle, typically from filing to destruction. The discussion includes record transfer and record accession, and describes how and why records might need to be frozen. The difference between the destruction and deletion of records is also described. The discussion on implementation internals looks at e-mail notifications and how background scheduled jobs automatically process steps of the record lifecycle.

Chapter 10, Searching Records and Running Audits, describes how to perform basic and complex searches for records in the File Plan, and how frequently used searches can be saved and later recalled and reused. The chapter describes the Audit Tool within the Records Management console and shows how reports can be run to audit actions and events that have occurred in the records system. At the end of the chapter, the internal implementation of the repository webscripts that are used to implement search and audit capabilities are discussed.

Chapter 11, Configuring Security and Permissions, explains how to create and modify users and groups that will have access to the Alfresco Share Records Management site. It describes how to create and modify Records Management roles and then how to assign permissions to those roles. The chapter also discusses how to set access rights for areas within the File Plan. The end of the chapter describes how webscripts are used to retrieve user, group, and role information from the repository.

Chapter 12, Configuring Records Management Parameters, discusses a number of useful administrative features that are available in the Records Management console. One of these tools allows the user to add custom metadata properties to extend the standard Alfresco Records Management content model. Other administrative tools are used to create custom events and to specify relationship types between records. In the implementation discussion for this chapter, we look in detail at how Alfresco implements dynamic metadata extensions to the content model.

Appendix A, Records Management Standards discusses the ISO 15489 and DoD 5015.2 standards in greater detail than covered in Chapter 1.

Appendix B, The Records Content Model, shows the detailed structure of the content model for Records Management in Alfresco.

Appendix C, Records Management Terms, lists and defines commonly used terms used in Records Management.

Note

You can download Appendices A, B, and C from https://www.packtpub.com/alfresco-3-records-management/book.

What you need for this book

The focus of this book is on the Alfresco Records Management module and requires only the following Alfresco software and Alfresco software stack elements:

  • Alfresco 3.2r+ Software, Enterprise, or Community

  • Alfresco 3.2r+ Records Management Module, Enterprise or Community

Note

Alfresco offers stack-complete installation bundles on both Windows and Linux that include all elements of the stack needed for the software to run, like the database (MySQL) and application server (Tomcat).

More information is provided in Chapter 2 where the software installation is discussed in detail.

Who this book is for

The primary target audience of this book includes individuals who will be implementing Records Management programs for their organizations. It will be particularly relevant to Records Managers, Business Analysts, and Software Developers.

Alfresco Share Developers will also be interested in some of the implementation details which are discussed here and which can be applied generally to other Alfresco Share development projects.

Alfresco Share is built on the Spring-Surf framework which extensively uses client and server-side Javascript and the FreeMarker templating language. At the end of many of the chapters are sections which are aimed at developers and which discuss the implementation details of Records Management within Alfresco Share. An understanding of Javascript, FreeMarker, and HTML would be useful when reading those sections of this book. Readers not interested in the details of the implementation should feel free to skip over those sections of the book.

No prior knowledge of Alfresco Share software is required to follow this book.

Conventions

In this book, you will find a number of styles of text that distinguish between different kinds of information. Here are some examples of these styles, and an explanation of their meaning.

Code words in text are shown as follows: "Objects of the type disposition action, or rma:dispositionAction, are being tracked."

A block of code is set as follows:

## Title
header.fileplan=File Plan
## Filters
label.transfers=Transfers
label.holds=Holds

Any command-line input or output is written as follows:

C:\>net config workstation

New terms and important words are shown in bold. Words that you see on the screen, in menus or dialog boxes for example, appear in the text like this: "We can click on Next and then on Finish to create the new e-mail account".

Note

Warnings or important notes appear in a box like this.

Note

Tips and tricks appear like this.

Reader feedback

Feedback from our readers is always welcome. Let us know what you think about this book — what you liked or may have disliked. Reader feedback is important for us to develop titles that you really get the most out of.

To send us general feedback, simply send an e-mail to , and mention the book title via the subject of your message.

If there is a book that you need and would like to see us publish, please send us a note in the SUGGEST A TITLE form on www.packtpub.com or e-mail us at .

If there is a topic that you have expertise in and you are interested in either writing or contributing to a book, see our author guide on www.packtpub.com/authors.

Customer support

Now that you are the proud owner of a Packt book, we have a number of things to help you to get the most from your purchase.

Note

Downloading the example code for this book

You can download the example code files for all Packt books you have purchased from your account at http://www.PacktPub.com. If you purchased this book elsewhere, you can visit http://www.PacktPub.com/support and register to have the files e-mailed directly to you.

Errata

Although we have taken every care to ensure the accuracy of our content, mistakes do happen. If you find a mistake in one of our books — maybe a mistake in the text or the code we would be grateful if you would report this to us. By doing so, you can save other readers from frustration and help us improve subsequent versions of this book. If you find any errata, please report them by visiting http://www.packtpub.com/support, selecting your book, clicking on the errata submission form link, and entering the details of your errata. Once your errata are verified, your submission will be accepted and the errata will be uploaded on our website, or added to any list of existing errata, under the Errata section of that title. Any existing errata can be viewed by selecting your title from http://www.packtpub.com/support.

Piracy

Piracy of copyright material on the Internet is an ongoing problem across all media. At Packt, we take the protection of our copyright and licenses very seriously. If you come across any illegal copies of our works, in any form, on the Internet, please provide us with the location address or website name immediately so that we can pursue a remedy.

Please contact us at with a link to the suspected pirated material.

We appreciate your help in protecting our authors, and our ability to bring you valuable content.

Questions

You can contact us at if you are having a problem with any aspect of the book, and we will do our best to address it.