第三章 使用管理门户（三）

浏览管理门户

管理门户有两种不同的视图模式可供选择以进行页面导航。可以通过单击管理门户功能区中所需的查看按钮随时在查看模式之间切换。视图模式有：

• 分栏视图 Columns view ——分栏显示页面；这是默认模式。此查看模式允许选择收藏夹并分配自定义资源。
• 列表视图 List view — 在下拉列表中显示页面名称。

注意：除了使用视图导航管理门户外，还可以通过位于功能区中的搜索工具直接进入页面；有关详细信息，请参阅本章中的管理门户功能区部分。

Columns view

“列视图”显示用于到达目标页面的子菜单。如果单击最终子菜单中的标题/名称，则会显示目标页面；如果在框内单击而不是在标题/名称本身上单击，则操作窗格将显示在右侧。

操作窗格

操作窗格解释了一个菜单选项，并允许执行与其相关的多项操作。要在“列”视图中显示操作窗格，请在最终子菜单中的选项周围的框内单击，而不是在选项本身上单击。可以在操作窗格中执行以下操作：

• 将目标页面添加到主页上的收藏夹列表中，如管理门户欢迎窗格中所述。
• 查看加载页面和分配自定义资源所需的系统资源，如在管理门户中使用自定义资源中所述。

注意：如果资源的名称在操作窗格中被截断，请将指针移到名称上以查看其全部内容。

• 单击 Go 转到目标页面。

操作窗格仅在“列”视图中可用。当使用列表视图或搜索工具导航到页面时，无法将其添加为收藏夹或分配自定义资源。

第二章 使用管理门户（二）

管理门户概述

本节介绍管理门户页面的一些常见布局元素。

注意：在管理门户中的任何位置，将光标移到菜单项上都会显示该项目的描述。

管理门户主页

管理门户主页的标题是 Welcome, <user>。在标题旁边，功能区包含以下选项：

• 两个视图按钮，可让指定如何在菜单列中显示链接。
• 搜索栏，位于功能区的右侧。当指定一个词并按 Enter 键时，将显示包含该词的所有页面的列表；然后，可以单击要显示的目标页面，而无需浏览子菜单。

以下部分描述了主页的区域：

管理门户菜单栏

位于主页左边缘的菜单栏是导航门户的主要方法。

管理门户欢迎窗格

欢迎窗格位于主页的中心，包括经常访问的页面的快捷方式。它包含以下字段：

• 收藏夹Favorites — 列出选择为收藏夹的管理门户页面（请参阅操作窗格）；可以单击每个页面标题直接转到该页面。
• 最近Recent — 列出自上次启动 IRIS 以来最近显示的页面。
• Did you know? — 显示提示。
• 链接 Links - 指向可能想要访问的页面的链接。

管理门户消息窗格

位于主页右侧边缘的消息窗格显示一般系统信息并提供指向系统仪表板的链接。

如果实例是镜像成员，则消息窗格还显示它所属的镜像、其状态和成员类型以及指向镜像监视器的链接。

管理门户标题

页眉位于管理门户中每个页面的顶部，可用于快速导航门户。

标题包含以下链接：

测试环境为正式环境备份恢复，现在在测试环境尝试搭建mirror，重启了一下数据库，结果全部变为只读了，该怎么解决数据库的只读挂载呢？

[TOC]

第一章 使用管理门户（一）

IRIS数据平台使您能够通过 Web 应用程序Management Portal 执行系统管理和管理任务。这种方法的一个优点是 IRIS 不必安装在用来管理安装的系统上。现在，通过网络远程管理系统，受制于为站点建立的访问控制，变得更加容易。跨版本兼容性问题被最小化，因为数据及其格式信息都直接来自被管理的系统。

默认情况下，管理门户在安装了IRIS 的专用 Web 服务器上运行。可以选择禁用专用 Web 服务器（使用 WebServer 设置）并配置不同的 Web 服务器来运行管理门户。

启动管理门户

可以通过以下方式启动管理门户：

• 在 Microsoft Windows 平台上，单击 IRIS 启动器菜单上的管理门户（Management Portal）。
• 在Web 浏览器中，直接转到管理门户 URI，格式如下：

http://machine:port/csp/sys/UtilHome.csp

第二十六章 源代码文件 REST API 参考（八）

GetEnsClassType

此方法返回用于创建产品的类的名称列表。可以指定要获取的类的类型，例如业务服务类。

URL

GET http://server:port/api/atelier/v1/namespace/ens/classes/type

type 是一个整数，并返回对应于该整数的类，如下所示：

• Adapters 1

• InboundAdapters 2

• OutboundAdapters 3

• Messages 4

• Requests 5

• Responses 6

• BusinessServices 7

• BusinessProcesses 8

• BusinessOperations 9

• DataTransformation 10

• Production 11

• BusinessHost 12

• Dashboard 13

• Rule 14

JSON Messages

以下返回的内容是一个类名数组：

第二十五章 源代码文件 REST API 参考（七）

Query

此方法对 IRIS 表执行 SQL 查询并返回结果。请求正文是指定查询的 JSON 对象。它返回一个匹配查询条件的对象数组。每个返回的对象都包含与查询返回的一行相关的信息。

URL

POST http://server:port/api/atelier/v1/namespace/action/query

SQL 查询在 URL 请求的正文中指定。查询必须在指定的命名空间中指定一个数据库。

此调用需要标头 Content-Type application/json。

JSON Messages

返回内容是一个对象数组。错误将出现在每个源代码文件对象的状态属性中：

第二十四章 源代码文件 REST API 参考（六）

Compile

此方法编译源代码文件。它允许一次编译多个源代码文件。它返回一个对应源代码文件对象的数组。

要编译的文件列表作为 JSON 数组在 http 请求的正文中传递。例如，[ "%Api.DocDB.cls", ... ]。

有关示例和其他详细信息，请参阅本手册教程章节中的编译文件。

URL

POST http://server:port/api/atelier/v1/namespace/action/compile

此调用需要标头 Content-Type application/json。

URL Parameters

• 可以传递 URL 参数“flags”（默认为“cuk”），该参数将传递给编译器。

• 如果不希望返回已编译的源代码文件的源，则可以使用值 0 传递 URL 参数 'source'。

JSON Messages

以下是编译 Atelier.NewClass1 时返回的内容：

第二十三章 源代码文件 REST API 参考（五）

DeleteDoc

此方法删除指定命名空间中的命名源代码文件。它返回相应的源代码文件对象。

与源代码文件有关的错误将在源代码文件对象的状态属性中。

有关示例和其他详细信息，请参阅本手册教程章节中的删除文件。

URL

DELETE http://server:port/api/atelier/v1/namespace/doc/doc-name

注意：如果要删除 CSP 文件 ，则 doc-name 的值包括 /（斜杠）字符。这就是定义 DeleteDoc 的 URLMap 包含此参数名称的 (.*) 而不是 :docname 的原因。有关详细信息，请参阅创建 REST 服务中的“为 REST 创建 URL 映射”。

JSON Messages

以下是源代码文件 xyz.mac 的 DELETE 的返回内容：

创建只读账号，分配资源新建角色，资源限制只读，但新建的用户还是可以修改。。。

分配的是所有以%DB和%service开始的资源，但部分是Use的权限，搞不明白。。。

我该怎么创建一个sql 的只读账号呢？

第二十二章 源代码文件 REST API 参考（四）

PutDoc

此方法保存提供的源代码文件。如果文件不存在，此方法将创建它，如果文件存在，此方法将现有文件替换为指定的文件。为确保覆盖文件的正确版本，请指定 If-None-Match 标头以及先前 PutDoc 或 GetDoc 的 ETAG 标头中返回的时间戳值。如果要覆盖文件而不检查版本，请指定 ?ignoreConflict=1 URL 参数。该方法返回一个对应的源代码文件对象。如果要保存二进制文件，请将传入 JSON 消息的 enc 元素设置为 true，并将文件内容包含为 base64 块数组。如果在保存过程中更改了服务器上的文本（例如通过源代码管理挂钩），则更新后的文本将在返回的源代码文件的内容数组中返回。

与源代码文件有关的错误将在返回的源代码文件对象的状态属性中。

版本 2 PutDoc 能够接受三种格式的文件内容：默认 UDL 格式、XML 格式和旧 %RO 导出实用程序使用的格式。 PutDoc 自动识别文件内容的格式。

有关示例和其他详细信息，请参阅本手册教程章节中的在命名空间中创建新文件或更新现有文件。

URL and Input JSON Message

PUT http://server:port/api/atelier/v1/namespace/doc/doc-name

下面是一个ObjectScript片段，它允许为InterSystems IRIS创建数据库、命名空间和Web应用程序:

	set currentNS = $namespace
	
	zn "%SYS"
	
	write "Create DB ...",!
	set dbName="testDB"
 	set dbProperties("Directory") = "/InterSystems/IRIS/mgr/testDB"
 	set status=##Class(Config.Databases).Create(dbName,.dbProperties)
	write:'status $system.Status.DisplayError(status)
	write "DB """_dbName_""" was created!",!!
	
	
	write "Create namespace ...",!
	set nsName="testNS"
	//DB for globals
	set nsProperties("Globals") = dbName
	//DB for routines
	set nsProperties("Routines") = dbName
	set status=##Class(Config.Namespaces).Create(nsName,.nsProperties)
	write:'status $system.Status.DisplayError(status)
	write "Namespace """_nsName_""" was created!",!!
	
	
	write "Create web application ...",!
	set webName = "/csp/testApplication"
	set webProperties("NameSpace") = nsName
	set webProperties("Enabled") = $$$YES
	set webProperties("IsNameSpaceDefault") = $$$YES
	set webProperties("CSPZENEnabled") = $$$YES
	set webProperties("DeepSeeEnabled") = $$$YES
	set webProperties("AutheEnabled") = $$$AutheCache
	set status = ##class(Security.Applications).Create(webName, .webProperties)
	write:'status $system.Status.DisplayError(status)
	write "Web application """webName""" was created!",!
	
	zn currentNS

在Caché基础课程中，同学们同时学习了Caché开发和ObjectScript语法。为了帮助大家完成练习，我们提供了ObjectScript快速参考（俗称 "小抄"）。

它不是所有ObjectScript的参考资料! 它是学生在课程中使用的ObjectScript命令和函数的列表，以及对象、集合等的常用语法。它还包含一些有用的宏。

我们正在为开发者社区提供一个pdf版本。

在测试你的代码时，你经常会遇到需要检查对象的实际内容。无论是使用 ZWRITE 还是 $system.OBJ.Dump()，

你会得到一个简单的属性图片，"--- 属性值---"

而 "--- swizzled references ---" 更容易让人混淆 

用“--- calculated references ---" 你只是被留在了后面。

ObjectScriptt至少有三种处理错误的方法（状态代码status codes、异常 exceptions, SQLCODE等）。大多数系统代码使用状态码，但由于一些原因，异常更容易处理。在处理遗留代码时，你要花一些时间在不同的技术之间进行转换。我经常使用这些片段作为参考。希望它们对其他人也是有用的。

第二十一章 源代码文件 REST API 参考（三）

GetDocNames

此方法返回源代码文件名列表。可选的 cat 和 type 约束源代码文件的类型。

URL

GET http://server:port/api/atelier/v1/namespace/docnames

GET http://server:port/api/atelier/v1/namespace/docnames/cat

GET http://server:port/api/atelier/v1/namespace/docnames/cat/type

其中

• cat 指定类别代码：CLS = class; RTN = routine； CSP = CSP 文件； OTH = other。默认为 *。
• type 指定源代码文件类型。可以是 * 通配符或文件类型。对于 CLS，类型必须是 *。对于 RTN，类型可以是 mac、int、inc、bas 、mvi 或 mvb。对于 CSP，type 可以是 js 或 css 等文件类型的列表，以逗号分隔。默认为 *。

URL Parameters

• URL 参数 'generated=1' 指定应包含生成的源代码文件。
• URL 参数 'filter' 提供了一个可用于匹配名称的 SQL 过滤器。

JSON Messages

以下是返回的内容，源代码文件描述符数组：

医疗行业的互操作性在改善病人护理、降低医疗服务提供者的成本以及为提供者提供更准确的情况方面发挥着重要作用。然而，由于有这么多不同的系统，数据的格式也有很多不同的方式。有许多标准被创造出来以试图解决这个问题，包括HL7v2、HL7v3和CDA，但每一种都有其缺点。

FHIR，即快速医疗互操作性资源，是一种新的医疗数据格式，旨在解决这些问题。它是由国际卫生级七组织（HL7）开发的，该组织还开发了HL7v2、HL7v3和CDA。

今天我们将探讨如何在VS代码中借助IntelliSense和自动完成功能，通过使用FHIR Schema 创建和验证FHIR资源。

第 1 步 :从FHIR 官方网站 https://www.hl7.org/fhir/下载 JSON schema file 文件用来做资源校验

第 2 步: 创建文件夹（在这个例子中，我使用病人文件夹和病人资源），并将提取的fhir.schema.json文件复制到同一文件夹，然后从VS Code中打开文件夹

第 3 步: 通过修改setting.json文件，设置VS代码以识别FHIR模式。
按CTRL+SHIFT+P并输入工作区设置JSON文件

第 4 步: 在同一文件夹中创建一个新文件patient.fhir.json。
按Ctrl+Space，你将通过IntelliSense获得FHIR资源的所有属性

第二十章 源代码文件 REST API 参考（二）

GetMetaData

此方法返回命名数据库的 METADATA.zip 文件的二进制内容。 Atelier 使用此文件来存储索引信息，以便为将来的会话保留此信息。

URL

GET http://server:port/api/atelier/v1/%25SYS/metadata/database

注意：因为 % 是 URL 特殊字符，所以要指定文字 %，必须在其后跟 25（百分号字符的十六进制代码）。因此，必须使用 %25SYS 来指定文字 %SYS。

HTTP 返回码

• HTTP 200 如果正常。
• 如果源代码文件不存在，则返回 HTTP 404。
• HTTP 500 如果发生意外错误（详细信息将在状态错误数组中）。

GetCSPApps

此方法返回在服务器上定义或为服务器上指定命名空间定义的 Web 应用程序列表。

URL

GET http://server:port/api/atelier/v1/%25SYS/cspapps

GET http://server:port/api/atelier/v1/%25SYS/cspapps/namespace

其中：

namespace

指定命名空间的名称。如果未指定命名空间，则此方法返回所有命名空间的 Web 应用程序。

第十九章 源代码文件 REST API 参考（一）

源代码文件 REST 接口支持以下方法：

cache的题目资源，类似于Oracle的OCP试题那种，能反应出对基础概念的掌握。

第十八章 源代码文件 REST API 教程（三）

编译文件

Compile 方法编译传入 JSON 数组中名称指定的源代码文件。例如，要编译 xyz.mac，请发布以下内容：

http://localhost:52773/api/atelier/v1/INVENTORY/action/compile

使用以下 JSON 消息：

["xyz.mac"]

该方法返回：

{
  "status": {
    "errors": [],
    "summary": ""
  },
  "console": [
    "",
    "Compilation started on 08/14/2016 15:25:20 with qualifiers 'cuk'",
    "xyz.int is up to date. Compile of this item skipped.",
    "Compilation finished successfully in 0.008s."
  ],
  "result": {
    "content": []
  }
}

对于一些源代码文件，例如类，Compile 在返回的内容中返回存储信息。

删除文件

第十七章 源代码文件 REST API 教程（二）

获取在命名空间中定义的源代码文件

要获取有关命名空间中源代码文件的信息：

• 首先，使用 GetDocNames 方法获取文件的名称。
• 然后用GetDoc 方法获取一个文件的内容，也可以用GetDocs 方法获取多个文件的内容。
• 如果要提高应用程序的网络效率，可以保留源代码文件的名称和内容的本地缓存，并使用 GetModifiedDocNames 方法仅获取内容发生变化的源代码文件的名称或使用带有 If-None-Match HTTP 标头的 GetDoc 方法。

GetDocNames 方法返回映射到命名空间的所有数据库中的所有源代码文件的名称。

第十六章 源代码文件 REST API 教程（一）

本章提供了一个简短的教程，通过一系列示例演示如何使用源代码文件 REST API。它包含以下部分：

API 基础

Atelier 用于访问 IRIS 源代码文件的 API 使用 REST 架构风格。 REST 的名字来源于“Representational State Transfer”。与许多 REST API 一样 IRIS 源代码文件 REST API 使用 HTTP GET、POST、PUT、DELETE 和 HEAD 方法，并将 JSON 用于传入和传出消息体。

要调用 API 方法，需要了解以下内容：

推荐一篇文章，南方医院HIS系统的更换与建设探索！

第十五章 源代码文件 REST API 简介

源代码文件 REST API 简介

此 REST API 提供对源代码文件的访问。我们开发此 API 是为了允许 Atelier（我们基于 Eclipse 的 IDE）访问 IRIS 服务器上的 IRIS 代码文件。可以使用 API 执行访问 IRIS 代码文件所需的操作。这些行动包括：

• 获取 IRIS 实例上可用的命名空间
• 查找命名空间中定义的类定义和例程
• 获取类和例程的文本定义
• 更新类定义或例程
• 创建新的类定义或例程
• 删除类定义或例程
• 编译 IRIS 类或例程
• 通过对表执行 SQL 查询来发现 IRIS 环境的属性

这些操作提供了访问 IRIS 源代码文件的机制。为了创建 IRIS 开发环境，应该了解此 API 并全面了解 IRIS 源代码文件如何在 IRIS 中使用。

这是一个特殊用途的 API。如果正在创建开发环境或处理类似的应用程序，例如类浏览器，可能会发现此 API 很有用。但是，它不是用于访问 IRIS 对象的通用 REST API。

第十四章 手动创建 REST 服务（二）

指定数据格式

可以定义 REST 服务以处理不同格式的数据，例如 JSON、XML、文本或 CSV。 REST 调用可以通过在 HTTP 请求中指定 ContentType 元素来指定它期望发送的数据的形式，并且可以通过在 HTTP 请求中指定 Accept 元素来请求返回数据格式。

在 DocServer 示例中，GetNamespaces() 方法检查 REST 调用是否使用以下内容请求 JSON 数据：

If $Get(%request.CgiEnvs("HTTP_ACCEPT"))="application/json"

本地化 REST 服务

REST 服务返回的任何字符串值都可以本地化，以便服务器以不同语言存储多个版本的字符串。然后，当服务接收到包含 HTTPAccept-Language 标头的 HTTP 请求时，服务会使用相应版本的字符串进行响应。

本地化 REST 服务：

1. 在实现代码中，不要包含硬编码的文字字符串，而是使用 $$$Text 宏的实例，为宏参数提供如下值：

• 默认字符串
• （可选）该字符串所属的域（将字符串分组到域中时，本地化更易于管理）
• （可选）默认字符串的语言代码

例如，而不是这个：

 set returnvalue="Hello world"

第十三章 手动创建 REST 服务（一）

本附录描述了如何通过继承 %CSP.REST 类来手动创建 REST 服务；此过程创建了一个手动编码的 REST 服务，它不能与所有 API 管理工具一起使用。

手动创建 REST 服务的基础知识

要手动定义 REST 服务，请执行以下操作：

• 创建一个 REST 服务类 — %CSP.REST 的子类。在子类中：
  • 定义一个 URL 映射，该映射指定为 REST URL 和 HTTP 方法执行的 IRIS 方法。
  • 可以选择指定 UseSession 参数。此参数控制每个 REST 调用是在其自己的 Web 会话下执行还是与其他 REST 调用共享一个会话。
  • （可选）覆盖错误处理方法。

如果想将实现代码与调度代码分开，可以在单独的类中定义实现 REST 服务的方法，并从 URL 映射中调用这些方法。

• 定义一个使用 REST 服务类作为其调度类的 Web 应用程序。

要定义 Web 应用程序及其安全性，请转至 Web 应用程序页面（单击System Administration > Security > Applications > Web Applications）。

定义 Web 应用程序时，将 Dispatch Class 设置为 REST 服务类的名称。

第十二章 使用中的 OpenAPI 属性

本附录列出了 API 管理工具在生成 REST 服务类时使用的 OpenAPI 2.0 规范的属性。此处未列出的属性将被忽略。有几个扩展属性；它们的名称以 x-ISC 开头。

Swagger

• basePath

• consumes

• host

• produces

• definitions (请注意，API 管理工具在生成代码时不使用 Schema 对象的任何属性)

• parameters (for details, see “Parameter Object”)

• paths (for details, see “Path Item Object”)

• info (for details, see “Info Object”)

• swagger (must be "2.0")

有关这些属性的详细信息，请参阅 https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swagger-object。

Info Object

• title

• description

• x-ISC_RequiredResource (访问 REST 服务的任何端点所需的已定义资源及其访问模式 (resource:mode) 的逗号分隔列表)

• version

第十一章 /api/mgmnt/ API 参考

此参考列出了 /api/mgmnt/ 服务中的端点，所有这些端点都适用于较新的 REST 服务。下表总结了端点并指出它们是否也适用于手动编码的 REST 服务。

第十章 发现和记录 REST API

本章讨论如何发现实例上可用的 REST 服务以及如何为 REST 服务生成文档。

使用 /api/mgmnt 服务发现 REST 服务

/api/mgmnt 服务包括可用于发现 REST 服务类和启用 REST 的 Web 应用程序的调用。

发现 REST 服务

要使用 /api/mgmnt 服务来发现实例上可用的 REST 服务，请使用以下 REST 调用：

• 对于 HTTP 操作，选择或指定 GET。
• 对于 URL，请指定以下形式的 URL：

http://localhost:52773/api/mgmnt/v2/

或者，如果只想检查一个命名空间：

http://localhost:52773/api/mgmnt/v2/:namespace

其中 localhost 是服务器的名称，52773 是运行 IRIS 的 Web 服务器端口，命名空间是要检查的命名空间。

（请注意，这些调用会忽略手动编码的 REST 服务。要发现手动编码的 REST 应用程序，请使用调用 GET /api/mgmnt/ 和 GET /api/mgmnt/:v1/:namespace/restapps。）

如果调用成功，IRIS 以 JSON 格式返回一个列出 REST 服务的数组。例如：

第九章 REST 服务安全

如果 REST 服务正在访问机密数据，应该对服务使用身份验证。如果需要为不同的用户提供不同级别的访问权限，还要指定端点所需的权限。

为 REST 服务设置身份验证

可以对 IRIS REST 服务使用以下任何形式的身份验证：

• HTTP 身份验证标头 — 这是 REST 服务的推荐身份验证形式。
• Web 会话身份验证 — 其中用户名和密码在 URL 中的问号后面指定。
• OAuth 2.0 身份验证 - 请参阅以下小节。

REST 应用程序和 OAuth 2.0

要通过 OAuth 2.0 对 REST 应用程序进行身份验证，请执行以下所有操作：