Procedure for Adding a Document Library to an Application

The following is a simplified walkthrough for integrating the module into an application:

1. If necessary, add foreign keys to docs_assigned for your application’s tables with which you want to associate multiple documents per record.
2. Add two Business Process Owner tasks: [Define Document Library Folders] and [Define Document Categories and Types] that point to the existing views ab-doc-def-folder.axvw and ab-doc-def-cat-type.axvw, respectively.
3. Create a [Manage Document Library] view to add/edit/delete documents, with appropriate permanent filters for your application. Use the Compliance view [Environmental & Risk Management / Compliance Management / Compliance Program Manager / Manage Document Library] as a template. Your view should include any new foreign keys that you added in step 1.
4. Create a [View Document Library] report view to search and view documents. Use the Compliance view [Environmental & Risk Management/Compliance Management/Operational Reports/Document Library] as a template. Make sure that your view enforces the docs_assigned. doc_review_grp security. Your view should include any new foreign keys that you added in step 1.
5. Optionally create a paginated report for the document library. See the Compliance view http://localhost:8080/archibus/schema/ab-products/risk/compliance/paginate/ab-comp-document-paginate-rpt.axvw as an example.

Other Considerations

• There is no common view for managing the Document Library. Each application needs its own custom view to manage its application-specific primary keys in the docs_assigned table and to implement any custom logic or filter consoles.
• The Document Categories, Types, and Folders are common across all activities. You cannot create a subset of these items that can only be seen and used within a specific activity.
• Document Folders, Categories, and Types are optional components. Each integration of Document Library can implement all or a subset of them.
• The Document Library is a central repository for all activities, so documents uploaded in one activity can be viewed in another. There is no activity_id field for an activity to “own” and restrict documents. For organizational purposes, your application or the end-user can create a top-level document folder named after the application in order to easily browse, search, and filter all documents for your application.

Usage Notes

• Folder names must be unique for the entire Document Library Folder hierarchy, even if they are in different parent folders. For example, if you have two folders named FY12 and FY13, and you create a folder named “Invoices” with FY12 as the parent, you cannot create another folder called “Invoices” even if the parent is FY13.
• Document Review Group security must be enforced by each custom Document Library view. Reusable centralized support for this feature is under consideration for future releases.
• Security groups cannot be applied to document folders, only to individual documents.