Configuration

(Vic has been tested against Alfresco Community version 4.0 and above.)

Although Vic will be able to access the CMIS repository without any configuration, many additional features will only work once configured.

Metadata and Search

Alfresco supports metadata, defined by Alfresco itself or by a custom extension. This metadata can be displayed in Vic. Vic needs to know which metadata to display and uses one or more config files in the Alfresco repository to determine this. It is the job of the Alfresco administrator to create and maintain these config files.

What metadata is supported
* Properties defined on Types or Aspects
* Associations

Where are the config files saved
* In the Alfresco folder /Data Dictionary/Vic Configs. This will need creating by the administrator

Searching by metadata
Once configured, metadata search boxes are added to the Advanced Search dialog in Vic.
The search metadata fields must be defined within a 'search_group' the config xml. The search group is titled and expandable.

When defining a 'search-field' you must include a 'type' and a 'display-label'. The options for 'type' are:
* String
* Multi
* Date

What does the XML look like

You can download the schema definition to validate your configuration files, or to check the allowed format.

Here is an example - myExample-config.xml.

<alfresco-config>
  <properties>

   <!-- A built-in property -->
    <config type="properties" name="basic">
      <property name="cmis:lastModificationDate"/>
    </config>

   <!-- A sample aspect defined as my:myCustomAspect in Alfresco -->
    <config type="aspect" name="P:my:myCustomAspect">
      <property name="my:myAspectProperty"/>    
      <property name="my:myOtherAspectProperty"/>   
    </config>

   <!-- Another aspect with a property that takes a value from a list. -->
    <config type="aspect" name="P:my:myChildCustomAspect" parent="P:my:myCustomAspect">
      <property name="my:myAspectProperty">
        <constraint type="List">
          <value>My Value 1</value>
          <value>My Value 2</value>
        </constraint>
      </property>   
      <property name="my:myOtherAspectProperty"/>   
    </config>

   <!-- A sample type defined as my:myCustomType in Alfresco -->
    <config type="type" name="D:my:myCustomType">
      <property name="my:myTypeProperty"/>  
      <property name="my:myOtherTypeProperty"/> 
    </config>
  </properties>

  <associations>
   <!-- A sample association my:myTypeAssociation defined on on my:myCustomType. -->
    <config type="type" name="D:my:myCustomType">
      <association name="R:my:myTypeAssociation" display-label="My Association"/>
    </config>
  </associations>

  <search>
    <search-group id="myCustomGroup" display-label="Custom Metadata" expanded="false">
      <search-field aspect="P:my:myCustomAspect" property="my:myAspectProperty" type="String" display-label="Aspect Property"/>
      <search-field aspect="P:my:myCustomAspect" property="my:myOtherAspectProperty" type="String" display-label="Other Aspect Property"/>
    </search-group>
  </search>
</alfresco-config>

User Settings

User configuration settings are saved in the "User Homes/username" Alfresco space structure under a folder vic_workspace.
NOTE: If you are testing Vic using the admin user, remember to create a home folder for the admin user

Configure default CMIS folder mappings for users

Create a file called cmis-folder-mappings.txt in the users vic_workspace folder (described in the section above).

The content of cmis-folder-mappings.txt is a comma delimited list of folders to map e.g.

e.g. /MyFolder,/MyOtherFolder/OtherSubFolder
NOT /Company Home/MyFolder

In this example, the user will have the /MyFolder and /OtherSubFolder cmis folders automatically mapped when they log in. NOTE - if they unmap the folder(s), they will be re-mapped the next time the user starts Vic.