webprofil / wp-deqar-reports
TYPO3 与 DEQAR 的连接器
Requires
- typo3/cms-core: ^11.5
Replaces
- typo3-ter/wp-deqar-reports: v2.0.2
This package is auto-updated.
Last update: 2024-09-12 15:54:07 UTC
README
此扩展允许您从 TYPO3 后端直接提交 DEQAR 报告(https://www.eqar.eu)并在您的网站上显示它们。
扩展设置
扩展设置在 TYPO3 安装的全局范围内集中设置。
基本设置
属性设置
此外,您可以为每个属性进行设置。以下表格显示了哪些属性及其前缀组合是可用的(x)。在后台,属性分为三个单独的选项卡,分别称为“显示属性”、“提交属性”和“预填充属性”。
show_
- 类型:复选框
- 示例字段名:show_agency
- 示例标签:显示机构。如果启用,此属性将在“列表视图”和“上传表单”中显示。默认情况下,所有 show_* 复选框都处于激活状态。
submit_
- 类型:复选框
- 示例字段名:submit_agency
- 示例标签:提交机构。如果启用,此属性将在“上传表单”中传输。默认情况下,所有 submit_* 复选框都处于激活状态。
prefill_
- 类型:输入字段(字符串)
- 示例字段名:prefill_agency
- 示例标签:预填充机构
使用给定值预填充属性。默认情况下,字段为空。如果为此属性启用了 show_,则“上传表单”的值将预填充。如果为此属性禁用了 show_,则值将在 API 传输时隐藏。如果同时禁用了 show_ 和 submit_,则此值已过时。
注意:programme_* 字段位于项目模型中,而不是报告中。
模块
简介
此扩展由一个模块组成。模块应在 TYPO3 后端中使用。该模块使用扩展设置调用 API。
列表视图
基本上,打开模块时,将显示此“列表视图”。它显示上传报告的按钮、列表的年份筛选器和所有现有记录的列表。年份筛选器显示从最旧的 TYPO3 记录(valid_from)到当前年份的所有年份。最初激活当前年份。
注意:来自 DEQAR 的旧条目(即最旧的 TYPO3 记录的年份)不可见!
列表显示来自 TYPO3 和 DEQAR 的所有记录!列表根据扩展设置中给出的机构进行筛选。它们按其 ID(两个系统中的每条记录一行)分组。通常,两个系统中的记录是相同的。但它们可以不同,如果有人在 DEQAR 系统中手动上传或在未传输到 DEQAR 的情况下上传到 TYPO3。在这种情况下,将显示来自 TYPO3 的数据。
不显示具有禁用 show_* 属性的扩展设置中的所有属性(列)。
表格按 date_from(升序)排序。
对于 valid_from 和 valid_to,使用扩展设置中的日期格式。
列表视图显示每条记录一行表格。
以下列可以是可见的
项目与报告之间存在 1:n 关系。因此,可以存在多个项目。
上传表单
DEQAR API 允许您在一次调用中发送多个报告。但此模块只提交单个报告。上传表单可以显示以下表单字段。
可以添加多个(1:n 关系)5 个 programme_* 字段。根据 API,它们可能需要。
对于 valid_from 和 valid_to,使用扩展设置中的日期格式。
不显示具有禁用 show_* 属性的扩展设置中的所有属性。
如果激活“转至DEQAR”复选框,则使用API调用。否则仅创建TYPO3记录。此复选框默认激活。
纸质副本
如果激活,则禁用“ser_report_file”。
否则,当“ser_report_file”填写时,禁用“纸质副本”。
机构
机构选择器(Select2)默认填充API的值:https://backend.deqar.eu/connectapi/v1/institutions/ “limit==100000” 此API可以直接通过JS使用,无需认证。
“Select2”用于在选择框内搜索。见:https://select2.org/data-sources/ajax
选项标签是机构的名称和deqar_id。例如:“维也纳大学(DEQARINST0784)” 选项值是deqar_id(例如:DEQARINST0784)
deqar_id用于API传输。此外,标签存储在TYPO3数据库中供视图使用。
可以选择多个机构。
提交
提交表单后,将验证必填字段(见数据模型)。同时必须遵守日期格式和条件必填字段。
如果没有错误,数据将通过API传输:https://docs.deqar.eu/data_submission/#submission-api
此外,还将创建TYPO3记录。
API响应
如果调用失败(返回错误),将写入TYPO3错误日志消息。错误结果将分配给视图。因此,可以在HTML视图中进行处理。如果调用成功,则将完整的数据数组分配给HTML视图。因此,前端开发者可以处理所有或所需的数据以满足其需求。API返回“report_id”属性。这必须存储(更新)到TYPO3记录中。
API调用
请参阅官方文档了解如何使用令牌:https://docs.deqar.eu/data_submission/#authentication
链接
与该扩展相关的官方文档的有用链接
- https://backend.deqar.eu/webapi/v2/swagger/
- https://docs.deqar.eu/web_api/#example-2-cross-border-reports-by-a-specific-agency
- https://backend.deqar.eu/webapi/v2/browse/institutions/?agency=EAEVE
- https://docs.deqar.eu/report_data/(必填字段)
- https://docs.deqar.eu/report_data/#validity
Eter(不需要)
- https://www.eter-project.com/api/doc/#/hei-export/get_hei_export(ETER的API)
- https://www.eqar.eu/qa-results/download-data-sets/?cn-reloaded=1(ETER的下载)
- https://docs.deqar.eu/report_data/#institutions(API提供ETER)
插件
简介
扩展由一个插件组成。插件应在TYPO3前端中使用。
TYPO3插件在前端显示来自TYPO3和DEQAR的报告。如果两个系统中都存在报告,则使用TYPO3的数据。可以在一个或多个页面上包含。
插件设置
列表视图显示给定时间范围内的所有记录。时间范围可在插件设置(Flexform)中配置。因此有两个设置
- load_from(YYYY-MM-DD)
- load_until(YYYY-MM-DD)
如果load_from为空,则不使用开始日期。将显示所有文件。
如果load_until为空,则使用当前日期。将显示所有直到今天的文件。
列表视图
插件显示给定时间范围内的所有报告列表。报告按以下顺序排序
- 决定(1,2,3,4)
- 机构按字母顺序
- valid_from
没有搜索、过滤、分页和手动排序的可能性。
报告通过扩展设置“agency”进行过滤(如果已设置)。