配置集成
现在您已经添加了HTTP集成，接下来配置您的集成。这些端点数据和服务操作配置构成了创建可操作微应用程序的基础。
添加数据端点
将数据端点配置为将相关数据读入缓存。我们希望向用户显示(或希望触发事件或操作)的任何数据都必须被缓存。
要添加一个数据端点，请遵循以下步骤:
选择数据加载．
- 下数据端点配置,输入端点的名字．
(可选)添加模板变量如果有必要的话)。这个字段提供了一个动态值，用于HTTP请求定义中。模板变量使您能够在以下任一情况下重写或更改原始端点定义的所有参数:
- 动作前更新或动作后更新
- 行动调用
- 增量同步
例如，您可能希望在增量同步期间使用模板变量的动态值。
- 选择添加变量．
- 输入新变量的名称。
选择一个数据类型而且源．选择的数据类型决定了源的选项。
- 下DATETIME数据类型,静态值,输入一个价值．
- 下DATETIME数据类型,相对的日期，选择一个时间段。
- 选择配置菜单,并输入格式类型细节Datetime如果有必要的话)。
- 选择保存．
您创建的新变量现在可以用于HTTP请求。当您在mustache标签之间输入一个变量而该变量不存在时，弹出窗口允许您通过选择添加该变量创建变量．
注意:
模板变量值是按照标准HTTP编码规则百分比编码的。如果您不希望发生这种情况，或者知道这些值已经是百分比编码的，那么您必须使用triple-stash mustache标签而不是普通的双mustaches来防止双编码。例如:将{{example}}修改为{{{example}}}。
在配置模板变量之后，您必须定义请求方法、分页类型，并为这两种类型测试服务完全同步而且增量同步各部分如下所述。
配置请求方法和URL。
(可选)选择+添加参数和配置查询，头，或在必要时请求正文参数。
注意:
的数据类型您的选择决定属性的格式。格式决定了微应用程序中的字段。使用胡子标记引用参数名称。例如,{{parameterName}}。
选择分页类型．必须选择的分页类型取决于目标应用程序集成的API标准。参考目标应用程序集成的API文档，查看应用程序集成使用的分页方法。
我们的HTTP集成允许您从以下标准分页方法中进行选择。页面，抵消,光标方法包含一个字段页面大小值它定义了每页要提取的记录数。
- 没有一个—未定义分页。
页面-设置每页的返回量限制。
例子:
https://example.com?limit=100&page=3抵消-提供两个参数，偏移量和极限。Offset定义要跳过的记录数，限制每页显示的记录数。
例子:
https://example.com?limit=100&offset=300链接—定义分页方法来定义正文中的下一页链接。
例子:
{“数据”[…]“下一个”:https://example.com?lpage=3}标题链接—类似于链接分页，但基于URL页头定义分页。
例子:
链接:< https://api.github.com/search/code?q=addClass +用户% 3 amozilla&page = 15 >;rel = "下一个",< https://api.github.com/search/code?q=addClass +用户% 3 amozilla&page = 34 >;rel = "最后一次"光标—游标分页使用特定记录的唯一标识符，该标识符用作指向下一个要查询记录的指针，以返回结果页面。
例子:
https://example.com?paginationToken=BFLMPSVZOData-选择您的OData版本以按照OData标准执行分页。
- 选择测试参数检查端点是否配置正确。选择一个要测试的页面数并选择测试参数．选择完成闭合刀刃。
- (可选)切换分页边界如有必要，为您返回的记录定义条件。这个礼物是专为页面而且抵消分页类型，并依赖于目标SoR需求。
- 设置可加载的最大页面数变量(默认为10000，最大为1000000)。使用此变量可以在需要时限制从SoR返回的记录量。可加载的最大页面数可以为每个端点单独配置。
选择测试参数检查端点是否配置正确。
如果测试成功，继续下一步。如果收到错误提示信息，请根据提示信息进行故障排除。
脚本转换
有关配置脚本转换的更多信息，请参见脚本转换．
获取数据结构
控件中创建表获取数据结构部分。
- 选择生成表．
- 选择从API或从JSON：
- 从API-自动从定义的端点获取数据。
- 从JSON如果有必要，使用From Sample JSON来粘贴API，例如你有响应但现在不能调用API。(可选)定义的根路径如果需要定义的端点的备用根。根路径必须用JSON指针表示法定义。
- 选择生成表．
设置你的主键,选择编辑属性铅笔图标和切换主键对于用作主键的属性(例如，id)．重要的是，主键列不能包含空值。不要将数据类型更改为TIMESTAMP。
注意:
当创建一个定制的集成和微应用程序时，你必须总是分配一个主键来启用正确的增量加载，而不是在同步数据时完全覆盖。
(可选)选择添加表并根据目标应用程序的需要配置额外的表属性，然后单击保存．然后可以从API端点重新加载表结构。
增量同步
与增量同步切换后，您可以设置同步。也就是说，在更频繁的间隔内只下载上次数据同步后更新的记录。要做到这一点，请配置您希望API调用运行的频率。至少输入一个服务器时间参数。离开时不设置同步计划将同步设置为手动。
只有在目标应用程序需要自定义参数时才需要它们。如果需要，请查阅目标应用程序集成文档。如果创建一个用于同步的自定义字符串，您必须在方括号中输入。例如[updated >=] ' YYY-MM-DD HHmm '。
有关同步的更多信息，请参见设置数据同步在下面。
- 中已创建表的基本名称获取数据结构Section并选择:
- 从API-自动从定义的端点获取数据。
- 从示例JSON当需要粘贴API时使用From Sample JSON，例如你有响应但现在不能调用API。
- 选择添加．
数据端点已映射，现在可以设置服务操作。
注意:
在设置和添加端点之后，表结构就锁定了。如果您需要重构，您必须创建和配置一个新的数据加载端点。
添加额外的API调用
在为应用程序集成配置数据端点时，可以向原始父端点添加额外的子端点以启用调用链接。一旦您设置了数据端点，您就可以添加更多的关联端点。
遵循以下步骤:
选择编辑在您想要添加子调用的集成菜单上。
集成页面将打开。
选择添加子API调用从Data Endpoint菜单中添加:
选择父表并定义端点，就像在上面Data Loading部分的步骤中所做的那样。
在定义请求方法时，您可以将路径设置为静态值或列值。您的API调用链现在与父API调用相关联。您定义的父/子端点现在可以在Data Endpoint页面中显示出来。
注意:
在创建集成时，建议只从一个端点而不是多个端点加载数据。在可能的情况下，优先批处理调用，而不是单独的端点调用。
合并表
当配置子API调用时，你可以选择以下选项来合并子表和父表:
选择不合并如果您不想合并父表和子表。
选择合并的细节从record系统中获取所有的任务和请求，以及请求的每个细节，并合并它们，例如，如果父表和子表是:
/需求列表{" id ": 123,“标题”:“车”、“角色”:“秩序”,“类别”:“销售”}和:
/ request-detail / 123 {" id ": 123年,“标题”:“车”、“Desc”:“配合”,“日期”:“2020-01-01”}之后返回下表合并的细节选择:
| Id | 标题 | 角色 | 类别 | 描述 | 日期 |
|---|---|---|---|---|---|
| 123 | 车 | 订单 | 销售 | 蓬式汽车 | 2020-01-01 |
选择合并的子表将每个子表单独追加到父表上。使用上面的例子，合并为子列表的结果如下:
| Id | 标题 | 角色 | 类别 | id | 标题 | Desc | 日期 |
|---|---|---|---|---|---|---|---|
| 123 | 车 | 订单 | 销售 | 123 | 车 | 蓬式汽车 | 2020-01-01 |
配置表
您可以重新配置表主键，而无需设置新的配置。为此，请在表屏幕中删除各个表条目，重新同步表，并选择新的主键。
支持时间格式
HTTP集成支持以下时间格式为您的记录数据系统:
- ISO日期格式
- OData格式
“yyyy-M-dd HH: mm: ss。瑞士”,“M / d / h yy:毫米”,“M / d / yyyy h: mm: ss“,“dd / MM / yy HH: MM”,“MMM d, yyyy h:mm:ss a”，“dd-MMM-yyyy HH: mm: ss”,"MMMM d, yyyy h:mm:ss a""dd mm yyyy HH:mm:ss"，“EEEE, MMMM d, yyyy h:mm:ss a”，“EEEE, d MMMM yyyy HH:mm:ss 'o''clock'”，“h:毫米”,“HH: mm”,“h: mm: ss”,“HH: mm: ss”
添加服务操作
当您配置了HTTP集成之后，您就可以配置服务操作了。通过服务操作，您可以在应用程序集成的记录系统上配置回写操作。您可以使用与数据端点类似的方式配置服务操作。由于您的应用程序集成可以是任意数量的定制组合，我们将采用通用方法来解释服务操作的工作方式。您还可以选择配置您的服务操作，通过设置操作执行前后的数据更新来检查目标System of Record (SoR)。
配置业务动作参数和模板变量时，不支持以下字符:
空格！＂＃％＆＇（）＊+，．/；<＝>@［＼］＾｛|｝～真正的，假，其他的，零，未定义的，这．
要添加服务操作，请遵循以下步骤:
- 选择您在下面创建的集成应用程序名称．
- 选择服务的行动而且添加新的服务操作．
- 给它一个动作名称(如Get JIRA Ticket Info)。
- (可选)选择添加参数在参数节并定义所需的参数的名字，数据类型而且价值．
定义你的行动的执行在动作序列部分:
- 进入端点URI路径:/ rest / api / 2 /问题/ {{issueKey}})。
配置您的请求方法基于应用程序集成的API需求。
注意:
使用胡子标记引用参数名称。例如,{{parameterName}}。
- 选择添加保存服务操作。现在可以根据需要添加额外的服务操作。
动作序列
您可以配置您的服务操作序列，通过操作执行以及操作前后的数据更新来返回数据。操作前和操作后的数据更新是可选的，旨在对微应用程序访问的数据提供健壮的检查，并确保在配置可操作的微应用程序时数据总是准确的。(可选)在操作执行前配置数据更新，确保微应用终端用户操作时数据完全同步。例如，您希望确保可操作微应用程序上显示的数量是需要批准的正确数量，并且在创建和批准之间没有更新。
重要的是:
此操作执行能力之前的数据更新仅与文本组件。这意味着操作执行前的其他数据更改不会显示给最终用户。同样地，如果为页面逻辑的文本组件，则检查不运行。如果Workspace用户进行并发修改，则不会出现警告。
操作执行前的数据更新
要在执行之前设置数据更新，请遵循以下步骤:
- 选择现有的数据端点要从中获取更新记录的。
- (可选)使包括孩子端点只有在子数据端点需要获取更新记录的全部详细信息时才会如此。
- (可选)扩展原文件端点URI如果它允许更新获取单个记录。例如，如果数据端点URI
https://domain/api/items是更新的https://domain/api/items/itemId．新的端点URI必须返回与原始端点相同的数据结构，否则数据解析将失败。
注意:
如果在初始设置之后更改了端点配置，则更改不会自动传播到这里。
- (可选)使用扩展原有请求参数添加额外的参数如果它允许对单个记录进行筛选。
选择测试参数检查端点是否配置正确。选择一个要测试的页面数并选择测试参数．选择完成闭合刀刃。
如果测试成功，继续下一步。如果收到错误提示信息，请根据提示信息进行故障排除。
配置完成后，选择保存．
动作执行后的数据更新
(可选)为了确保您的数据在操作执行后完全同步，您可以配置一个数据更新来从您的目标应用程序系统的记录中获取新的数据。
要在执行后设置数据更新，请遵循以下步骤:
- 选择现有的数据端点要从中获取更新记录的。
- (可选)使包括孩子端点只有在子数据端点需要获取更新记录的全部详细信息时才会如此。
- (可选)扩展原文件端点URI如果它允许更新获取单个记录。例如，如果数据端点URI
https://domain/api/items是更新的https://domain/api/items/itemId．新的端点URI必须返回与原始端点相同的数据结构，否则数据解析将失败。 (可选)使用扩展原有请求参数添加额外的参数如果它允许对单个记录进行筛选。
选择测试参数检查端点是否配置正确。选择一个要测试的页面数并选择测试参数．选择完成闭合刀刃。
如果测试成功，继续下一步。如果收到错误提示信息，请根据提示信息进行故障排除。
配置完成后，选择保存．
验证所需的实体
使用表格验证存储在缓存中的当前表列表和应用于这些表的筛选器。
现在可以设置和运行第一次数据同步了，除非您需要创建自定义关系。有关更多信息，请参见设置数据同步．
API请求方法
你现在可以根据你的应用集成API需求配置你的请求方法，使用以下组件:
- 得到—从应用程序集成SOR检索资源而不修改。
- 帖子—在应用集成SOR中创建一个新资源。
- 把—更新应用集成中的现有资源。
- 补丁—对资源进行部分更新。
- 删除—删除资源。
具有以下可配置的API参数:
- 头—定义请求头中包含的与授权相关的参数。
- 路径-在查询字符串之前的端点路径内定义参数。
- 查询-在端点的查询字符串中定义参数。
- 身体-定义请求体中包含的参数。
脚本转换
有关配置脚本转换的更多信息，请参见脚本转换．
创建自定义的关系
使用的关系页创建集成中的表之间的自定义连接。如果您有多个Base url并且需要多个集成，或者您希望在同一个集成中创建自定义关系，那么您可能会使用它。这是一个高级用例，我们建议你在开始映射多个集成之前，先熟悉在单个集成上创建微应用。
- 在Manage Microapps页面中，选择要验证实体的集成旁边的菜单。
- 选择编辑然后的关系．
选择添加新的关系．
“添加关系”页面打开。
- 可以将主表映射到外表。
- 输入您想要的别名。
现在可以根据在每个集成上设置的主键映射和添加额外的引用列。
重要的是:
如果删除一个表，所有关系也会被删除。
设置数据同步
从集成的应用程序中提取数据到Microapps平台，以便与缓存进行比较。作为最佳实践，完全同步每24小时执行一次，增量同步可以配置为每5分钟进行一次。
有关同步化规则的完整信息，请参阅不符合其时间表和否决规则的同步化同步数据．
- 在Manage Microapps页面中，选择要设置同步的集成旁边的菜单。
选择同步．
集完整的而且增量数据同步值。
完整的删除本地缓存并从源系统提取所有数据。
重要的是:
运行完全同步可能需要很长时间。我们建议在晚上或通常在非工作时间运行完全同步。可以在任何时候取消正在进行的数据同步X图标。
增量只提取已更改(新的和更新的)记录。不加载已删除的数据。
重要的是:
并不是所有的api都支持增量同步。
当你定义每天或每周同步，同步在你选择的时间段内随机发生。例如，选择00-04每日全同步将在该时间段内随机选择的时间运行全同步。
- 选择保存．
注意:
如果需要，您还可以选择箭头图标来按需运行集成。
显示集成日志
使用集成日志查看按严重程度分类的变更历史。使用它来排除集成中的问题。例如，如果您看到同步失败，请检查集成日志以了解原因。或者，如果没有显示预期的卡，请检查集成日志，以查看是否发生了同步。
- 在Manage Microapps页面中，选择要查看其集成日志的集成旁边的菜单。
- 选择集成的日志．
- 检查条目，如果需要，选择菜单来通过Errors进行筛选。
出口集成配置
您可以导出集成配置。所有凭据都将被丢弃。这包括密码和客户端详细信息。只导出Microapps服务器中保存的配置。例如，导出保留用户名而不保留密码，同时导出保留OAuth配置而不保留客户端机密。
- 在Manage Microapps页面中，选择要导出的集成旁边的菜单。
选择出口配置．
该服务。宾州文件下载。
下一步要去哪里
现在你已经创建并配置了你的自定义集成，构建你自己的微应用程序来提供最佳的终端用户体验，满足你的需求，并简化日常工作流程。有关更多信息，请参见创建microapps．