For Developers

If you want to write your own CMIS client, profound knowledge about the CMIS standard is mandatory. As a starting point the OpenCMIS client examples may be helpful: https://chemistry.apache.org/java/examples/: new window

Note: Apache Chemistry does not support aspects.

Available Repositories

The available repositories can be configured the following way:

• The desk of the user is a repository by default.
• The repositories defined in the CMIS configuration (see chapter “Configuration of the Fabasoft Integration for CMIS”).
• The repositories returned by the use case FSCCMIS@1.1001:CMISFilterRepositories.

The “aspect” Parameter

The aspect parameter can be used to retrieve all properties of an object that are defined on a specified form and that contain a value. Additionally, the standard properties atom:icon, cmis:baseTypeId and cmis:createdBy are available.

Usage:

To get a list of all child objects following URL can be used:

https://<webserver>/<vdir>/cmis/<repository>/<object>/children?aspect=<action>

Note: When accessing object lists via CMIS, a maximum of 1000 objects can be loaded without paging. When using paging (maxItems parameter), more than 1000 objects can still be loaded. In addition, in children requests that set the aspect parameter, the estimated total number of objects in a list is transmitted in the fsc:estimatedNumItems XML attribute.

To get the values of all available properties (that contain a value) the following URL can be used:

https://<webserver>/<vdir>/cmis/<repository>/<object>/entry?aspect=<action>

The value of the aspect parameter is matched with the value of the Action property. The Action property can be defined on the desired object class, on the “User Interface” tab in the Forms property. The matching action determines the used form. The form contains form pages. All properties of a basic type (string, integer, date, contents and so on) that are assigned to the form pages and that contain a value are included in the response XML. Properties that contain no value are not included in the XML due to performance reasons.

In the following example properties of the form that matches the COOATTREDIT@1.1:EditObjectAttributes action are returned.

In the following example the properties objname and objversmaxnr of the object COO.1.3285.4.945 are set.

In the following example a Microsoft Word document is created directly on the desk. The name “My document” and the subject “My subject” are set.

In the following example an object should be created in a folder that consists of several object lists. The document should be created in the folder COO.1.3285.4.934 in the object list COO.1.1.1.1907.

aspect=true

The aspect=true parameter is only for internal use. It reduces the amount of data that is transferred to the client (the response XML contains only the most important information). This setting does not conform to the CMIS specification.

Note: The URL pointing to the PDF overview is included for objects without content.

Update of Properties

The CMIS service “updateProperties” can be used to modify properties that are defined in the aspect.

SOAP Message Example

The following example shows how to use the aspect parameter in a SOAP message.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://docs.oasis-open.org/ns/cmis/messaging/200908/" xmlns:fsc="http://www.fabasoft.com/">
  <soapenv:Header/>
   <soapenv:Body>
      <ns:getChildren>
         <ns:repositoryId>COO.1.506.1.215</ns:repositoryId>
         <ns:folderId>COO.1.506.1.345</ns:folderId>
         <ns:extension>
           <fsc:aspect>true</fsc:aspect>
         </ns:extension>
      </ns:getChildren>
   </soapenv:Body>
</soapenv:Envelope>

Long Lists

The HTTP header x-fsc-statekey enables optimized loading of long object lists by using a state server.

1. The client enables the use of a state by including the header with the value “none”.
2. The server can respond with a new key in the response header.
3. The client can use the received key in subsequent requests.

User-Defined Forms

The properties of user-defined forms can be accessed like any other property.

When you create a “Container With User Data” or “Room With User Data” containing one list or several lists on the same form page the first list can be retrieved the following way.

If several lists on different form pages are available the $ operator can be used to access each list.

In the following example, properties of the form that matches the COOATTREDIT@1.1:EditObjectAttributes action are returned. The properties of the user-defined form are included.

Quota

If a user quota is defined for a Fabasoft Folio Domain, the data is also available in the response XML of the following call:

https://<webserver>[<port>]/<vdir>/cmis

• fsc:maxquota
  Maximum available storage space (in MB) for the user.
• fsc:curquota
  Currently used storage space (in KB) by the user.
• fsc:maxobjcount
  Maximum available number of objects for the user.
• fsc:curobjcount
  Number of objects created by the user.
• fsc:maxcontsize
  Maximum size (in bytes) of a single document.

Example:

<fsc:properties>
  <cmis:property propertyDefinitionId="fsc:maxquota">
   <cmis:value>10240</cmis:value>
  </cmis:property>
  <cmis:property propertyDefinitionId="fsc:maxobjcount">
    <cmis:value>10000</cmis:value>
  </cmis:property>
  <cmis:property propertyDefinitionId="fsc:curobjcount">
   <cmis:value>115</cmis:value>
  </cmis:property>
  <cmis:property propertyDefinitionId="fsc:curquota">
    <cmis:value>1701483</cmis:value>
  </cmis:property>
  <cmis:property propertyDefinitionId="fsc:maxcontsize">
    <cmis:value>2147483647</cmis:value>
  </cmis:property>
</fsc:properties>

Synchronized Collection

The following URL can be used to get a collection of all objects that are marked as synchronized by a user:

https://<webserver>[<port>]/<vdir>/cmis/<repository>/-/synchronize

Additional Properties

Following properties are available:

• The property fsc:objTeamRoom returns the Teamroom (COO address) of a document or folder.
• The property fsc:objDeleted returns true if the object is in the wastebasket.
• The property fsc:canSetContentStream determines whether the object can be modified.
• The property fsc:contentStreamEncryption determines the encryption method of the object.

The properties canSetContentStream and contentStreamEncryption are only included in the response XML if the object is modifiable or encrypted.

Example:

<cmis:propertyBoolean propertyDefinitionId="fsc:canSetContentStream">
  <cmis:value>true</cmis:value>
</cmis:propertyBoolean>

<cmis:propertyString propertyDefinitionId="fsc:contentStreamEncryption">
  <cmis:value>AES 256 CBC</cmis:value>
</cmis:propertyString>

Providing Documents

The available document types are defined in the Web Service Configuration:

• Object Classes for Newly Created Content Objects
  Objects of object classes in this list are included.
• Object Classes Allowed in Web Folders
  Objects of object classes in this list are included. If Show PDF Summary is set to “Yes” a PDF overview is generated. Additionally, for objects not in this list (and that are not excluded) a PDF overview is generated.
• Object Classes Not Allowed in Web Folders
  Objects of object classes in this list are excluded.

Performance

Please be aware that some operations like getting the folder tree of a large structure may exceed the system resources.

Additional Arguments

The following additional arguments are available:

Parameter needChoices

To reduce the amount of data generated choices are no longer provided by default, starting with version 2019. If these additional choices are needed the URL parameter needChoices=true may be added.