Projects:Alfresco Integration/Technical Specifications

Contents 1 Introduction 2 New API 2.1 Attachment Method window 2.2 Metadata Value table 2.3 Attachment Configuration window 3 Attachments section 4 Upload / Edit popup customization 5 Update existing processes using Attachment to new API 5.1 Print and Attach 5.2 C_FILE table

Introduction

In this document are described the developments needed to make core attachments customizable.

New API

• Create an AttachImplementation abstract class.
  • Methods to Upload, Download, DownloadAll, Delete and Update.
  • Core implements a CoreAttachImplementation class used by default.
  • Each module implementing an attachment method must implement this class.

Attachment Method window

This window is accessible only with System Administrator role. Defines each attachment method available in the system. The search key identifies the class that implements the method.

Header

• Table: C_Attachment_Method
• Fields:
  • Ad_Module_Id
  • Name
  • Search Key

Metadata

List of fields that can be added to the Upload and Update popups. This table will belong to Attachment Method window and Windows, tabs, fields || tabs window.

• Table: OBUIAPP_Parameter
• Fields/Columns:
  • Tab ID
  • Name
  • Search Key
  • Reference
  • Reference Value
  • Show In Description
  • Is user editable
  • Property path
  • Attachment Method ID

Metadata Value table

This table will contain the value of all the metadata for each attachment (c_file). This table will not have any window related to it.

• Table: C_FILE_METADATA
• Columns:
  • ID
  • OBUIAPP_PARAMETER_ID
  • C_FILE_ID
  • NumericValue
  • DateValue
  • StringValue
  • Identifier

Attachment Configuration window

Header

• Table: C_Attachment_Conf
• Only 1 active record for each Client.
• Fields:
  • List of Attachment Method.

The Attachment Method identifies the class implementing it by its value. This field will not be update-able. Modules implementing an attachment method must have an annotation with the corresponding attachment method value. Modules implementing an attachment method might add new fields on this window to configure them (url, port, user, password,...)

Attachments section

• Change name of Edit Description link.

Upload / Edit popup customization

• The upload/edit popup will show all the metadata defined for the attachment method. In case of uploading, the attachment method to take into account will be the one defined in Attachment Configuration. In case of editing, the attachment method to take into account will be the attachment method that was used to upload the file that is being edited.

Update existing processes using Attachment to new API

Print and Attach

• Update ReportManager class to use new api.

C_FILE table

New field will be created in c_file:

• AttachmentConfiguration: the attachment configuration used for attaching the file