drc-cmis · PyPI · Python 包索引

用于管理CMIS后端Documenten API资源的适配器。

这些详情尚未由PyPI验证

项目链接

主页

项目描述

版本：:: 1.9.0
源：:: https://github.com/open-zaak/cmis-adapter
关键词：:: CMIS, Documenten API, VNG, Common Ground
Python版本：:: 3.7

python-versions django-versions

为Documenten API提供CMIS后端连接器。

由Maykin Media B.V.开发，由乌德勒支市政府委托，并得到Súdwest-Fryslân市政府和Open Zaak项目团队的支持。

简介

文档API CMIS适配器允许Django实现轻松连接到兼容CMIS的文档管理系统(DMS)。最值得注意的是，它被Open Zaak用于将DMS作为Documenten API的后端，而不是使用其自己的后端。

功能

支持CMIS 1.0和CMIS 1.1，但不是所有绑定。以下是每个CMIS版本支持的绑定列表。

	CMIS 1.0	CMIS 1.1
Web服务绑定	支持	未测试
AtomPub绑定	未测试	未测试
浏览器绑定	不适用	支持

对于支持的绑定，实现了以下功能

从兼容CMIS的DMS中检索和存储文档。
支持文档的读取和写入。
支持文档的检出/检入。
支持自定义数据模型以存储额外的元数据。

测试平台

使用CMIS 1.0 Web服务绑定测试Corsa平台（感谢BCT）
使用CMIS 1.1浏览器绑定测试Alfresco Enterprise 5.2.3（感谢Contezza）
Alfresco CE 6.1.2-ga（用于CI）

安装

注意：如果您使用Open Zaak 1.3.1或更高版本，CMIS适配器已包含在内，无需单独安装。

要求

Python 3.7或更高版本
setuptools 30.3.0或更高版本
Django 3.2或更高版本

安装

在您的Django项目中安装库

$ pip install drc-cmis

在您的Django settings.py 中的 INSTALLED_APPS 中添加

INSTALLED_APPS = [
    ...
    "drc_cmis",
    ...
]

创建一个映射文件，以匹配Documenten API属性与DMS模型中的自定义属性。请参阅映射配置。
在您的 settings.py 中添加以下设置以启用它

# Enables the CMIS-backend and the Django admin interface for configuring
# the DMS settings.
CMIS_ENABLED = True

# Absolute path to the mapping of Documenten API attributes to (custom)
# properties in your DMS content model.
CMIS_MAPPER_FILE = /path/to/cmis_mapper.json

以超级用户身份登录到Django管理，并配置CMIS后端。

映射配置

有两个重要概念

内容模型 - 用于在文件夹和文档上存储（自定义）属性（的）DMS配置。这些属性被称为CMIS属性。
CMIS映射器 - 一个包含从Documenten API属性到CMIS属性的转换的JSON文件。

在DMS内容模型中将Documenten API属性映射到（自定义）CMIS属性应非常小心进行。当DMS存储这些属性时，Documenten API依赖于它们的存在以创建适当的响应。

以下是CMIS映射器的片段

{
  "DOCUMENT_MAP": {
    "titel": "drc:document__titel"
  }
}

DOCUMENT_MAP描述了Documenten API中EnkelvoudigInformatieObject资源的映射。在这个片段中，仅将EnkelvoudigInformatieObject.titel属性映射到自定义CMIS属性drc:document_titel。

使用CMIS-适配器通过CMIS进行Documenten API的通信。因此，当通过Documenten API创建文档时，属性将转换为CMIS属性，如下所示（请注意，这是一个简化的请求示例）。

<?xml version="1.0"?>
<soapenv:Envelope xmlmsg:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlmsg:msg="http://docs.oasis-open.org/ns/cmis/messaging/200908/" xmlmsg:core="http://docs.oasis-open.org/ns/cmis/core/200908/">
<soapenv:Header />
<soapenv:Body>
  <msg:createDocument>
    <msg:repositoryId>d6a10501-ef36-41e1-9aae-547154f57838</msg:repositoryId>
    <msg:properties>
      <core:propertyString propertyDefinitionId="drc:document__titel">
      <core:value>example.txt</core:value>
    </msg:properties>
    <msg:folderId>workspace://SpacesStore/7c6c7c86-fd63-4eec-bcf8-ffb59f6f6b90</msg:folderId>
  </msg:createDocument>
</soapenv:Body>
</soapenv:Envelope>

以下展示了映射配置的示例，其中包含了所有可能的Documenten API资源和属性，具体位于test_app/cmis_mapper.json文件中（cmis_mapper.json）。与这些CMIS属性定义相关的DMS内容模型，针对Alfresco（一个开源DMS），位于/alfresco/extension/alfreso-zsdms-model.xml文件中（alfreso-zsdms-model.xml）。映射和模型应该保持一致。

映射

内容模型和CMIS-mapper配置需要保持一致。对于每个对象，API资源、CMIS对象类型、CMIS基类型以及（可配置的）CMIS-mapper对象都将进行描述。

文档

文档本身、其内容和元数据。

Documenten API资源	EnkelvoudigInformatieObject
CMIS对象类型 *	drc:document
CMIS基类型	cmis:document
CMIS-mapper对象	DOCUMENT_MAP