If you want to analyze your custom properties organized in types and aspects, starting from the A.A.A.R. v2.1 you can do it. Form the A.A.A.R. v4.2 version, the extraction task is drastically improved in performance. The custom analytics can be developed on subtypes of content (documents and folders) and all the aspects and it’s particularly useful if you want to study your workflows and custom models in general.
As you probably know, Alfresco is able to extend it’s data model with one or more custom models. This is incredibly powerful because you can store your own metadata (called properties) together with your documents. Also the folders could be stored (and retrieved) together with custom properties.
So, once you have stored the documents and folder with success into your Alfresco, how to know how many of them are in a certain condition instead of another? How to develop and share reports and analytics about it?
Below a brief tutorial on how to develop it with A.A.A.R.
The solution is based on a three step approach:
- Declare your custom properties on types and aspects.
- Extend the A.A.A.R. Data Mart to store the custom properties.
- Extract and use your data from the data mart.
Below a brief description of each step.
ATTENTION: It is mandatory that you perform those steps on a empty A.A.A.R. data mart! If you already have a working A.A.A.R. installation and want to know how to init the AAAR_DataMart, please read it here.
1. Declare your custom properties on types and aspects
With this step you declare the custom properties you want to analyze from your custom types and aspects. This is the only configuration required and consists of an insertion of few simple data in a database table, directly in the AAAR_DataMart. To perform this task, you can use the A.A.A.R. configuration wizard (recommended) or, as alternative, populate the table called AAAR_DataMart.dm_custom_metadata. Below a simple video showing how to perform this task.
If you choose to manage the table by person, add exactly one row per Alfresco’s custom property (for custom documents, folders or aspects). Below a brief description of each field and the instructions on how to fill it.
- Id. Do not evaluate it. An automatic sequence will do it for you once you will commit the row insertion.
- Class. Name of the type/aspect of the property you want to analyze (example: dl:todoList, cm:versionable, ecc.).
- Name. Name of the property you request to extract and analyze. (example: dl:todoStatus, cm:initialVersion, ecc.).
- Type. Name of the type of the property. The value is the Alfresco type (example: d:text, d:boolean, d:date, d:datetime, ecc.).
- Is_document_subtype. Possible values: Y or N. Set it to ‘Y’ if the class is a cm:document subtype. Set it to ‘N’ otherwise.
- Is_folder_subtype. Possible values: Y or N. Set it to ‘Y’ if the class is a cm:folder subtype. Set it to ‘N’ otherwise.
- Is_aspect. Possible values: Y or N. Set it to ‘Y’ if the class is an aspect. Set it to ‘N’ otherwise.
- Is_active. Possible values: Y or N. Set it to ‘Y’ if want to extract data about it, to be analyzed. Set it to ‘N’ otherwise.
- Alfresco_id. Probably you have to set it to ‘1’. This field contains the Alfresco installation your custom type/aspect referrers to. By default you have to evaluate it to 1, according to the AAAR_DataMart.dm_dim_alfresco table.
Once the table is completed, you can go ahead to the next task where you are going to set the AAAR_DataMart structures.
2. Extend the data structures
Now that you have declared the custom properties you want to analyze, it’s time to set up the AAAR_DataMart with some custom data structures. With this operation you are going to create some custom tables used by the Pentaho jobs and transformations to store the custom data.
To perform this task, simply execute the ‘AAAR_Create_custom_structures’ script you can find in the ‘<biserver-ce>/pentaho-solution/system/AAAR/endpoints/kettle/script’ folder.
If no errors will appear in the console: CONGRATULATIONS! You can go ahead to the next third and final task.
3. Extract your data and analyze
Now that everything is ready, you can run the ‘AAAR_Extract’ script, as usual. Even multiple times, if you need. To understand how to do it, you can read here.