集成Jira
与Jira集成以跟踪问题并获得关于任何设备、内部网或信使上的任务的自动更新。使用以下过程来启用与Jira的集成。完成此过程后,现有级别的审计日志记录将继续存在,包括使用Citrix Microapps执行的任何操作。
注意:
我们提供了两个Jira集成模板供您使用。对于大多数用例,我们建议使用更新的HTTP集成。HTTP集成提供了配置缓存数据结构的更强大功能。有关每个集成中可用的微应用程序的完整细节,请参见使用Jira微应用程序.
检查先决条件
您希望通过此集成使用的所有用户帐户必须在设置为的帐户设置中对其电子邮件具有可见性任何人.这意味着服务帐户以及用户通过OAuth登录到Citrix Workspace的帐户。导航到https://id.atlassian.com/manage-profile/profile-and-visibility,如有需要,登录联系部分,并在电子邮件帐户旁边选择任何人下谁能看到这个?菜单。
注意:
Jira不再支持Internet Explorer 11。使用Internet explorer11配置此微应用程序将导致错误。切换到其他浏览器(Chrome、Edge等)进行正确配置。
在Jira中准备集成后,您将需要这些工件来在Citrix Workspace Microapps中添加集成:
- 基URL:
templatebaseurl
取代{cloud-id}
你的cloud-ID。如果您需要找到您的云- id,请以JIRA实例的管理员身份登录并查看URL。 - 授权URL:预定义的。这是在设置目标应用程序集成时提供的授权服务器URL。
- 标记的URL:预定义的。这是访问授权令牌的URL。
- Epic-Name-customFieldId:这是在Jira管理门户找到的。看到替换Service Action变量.
- 客户机ID:客户端ID是表示授权服务器唯一的客户端注册信息的字符串。
- 客户的秘密:客户端秘密是在设置目标应用程序集成时发出的唯一字符串。
- 用户名:这是您的服务帐户用户名。
- 密码:这是您的服务帐号密码。
注意:
建议在可用的情况下始终使用OAuth 2.0作为服务身份验证方法。OAuth 2.0确保您的集成满足您所配置的微应用程序的最大安全合规。
在开始集成过程之前,必须满足以下先决条件:
一个专用用户帐户,具有对您想要管理的Jira项目的“浏览项目”访问权限。
有关管理用户的详细信息,请参见https://www.atlassian.com/software/jira/guides#ManagingUsers-Addingusers.
有关如何将用户添加到Jira项目的权限方案的详细信息,请参见管理项目权限.
将Citrix Gateway配置为支持Jira的单点登录,这样一旦用户登录,他们就会自动再次登录,而无需再次输入他们的凭据。请按照Jira单点登录配置.有关配置SSO的详细信息,请参见Citrix Gateway Service.
启用OAuth 2.0 (3LO)
在实现OAuth 2.0 (3LO)之前,您需要在Jira应用程序管理中为您的应用程序启用它。
- 导航到应用程序管理.
- 通过选择创建一个新的应用程序创建新应用,输入名称,同意条款,然后选择创建.
- 复制客户机ID而且秘密供以后使用
- 在api和特性在侧导航栏中,单击+添加
- 的“功能”部分中api和功能页面找到OAuth 2.0 (3LO),并选择添加然后配置.
- 进入回调URL.将此URL设置为应用程序可访问的任何URL。当你在应用程序中实现OAuth 2.0 (3LO)时(参见下一节),redirect_uri必须匹配此URL。
- 单击“保存更改”。
你的屏幕看起来是这样的:
创建API令牌
脚本或其他进程可以使用API令牌对Jira Cloud应用程序或Confluence Cloud执行基本身份验证。如果您验证的Atlassian帐户启用了两步验证,则必须使用API令牌。
- 在登录到Atlassian帐户时,转到API的令牌.
- 选择创建API令牌中为令牌输入一个名称标签字段。
- 复制到剪贴板并保存以备以后使用。
你必须进入API的令牌作为你的密码当您将集成添加到Citrix Workspace Microapps时。
添加Jira平台REST API
如果您还没有添加Jira平台REST API,现在就添加。
- 在api和特性在侧导航栏中,单击+添加.
- 在api部份api和功能页面找到OAuth 2.0 (3LO),并选择添加然后配置.
- 为应用程序添加所需的作用域。
添加回调URL
向实例配置中添加自定义URL,以授予对私有数据的访问权,并启用OAuth身份验证的用户操作。要找到您的微应用程序服务器URL,请登录到Citrix Cloud,然后选择Microapps瓷砖。在URL栏中,复制URL的第一部分。这是你的微应用服务器URL。一节{yourmicroappserverurl}
由租户部分、区域部分和环境部分组成:https:// {tenantID}。{地区(美国/欧盟/ ap-s)} .iws.cloud.com
.
对于HTTP Jira集成,必须添加两个不同的回调url。但是,Jira应用程序只能有一个回调URL。这意味着您需要注册两个应用程序;一个用于用户操作,另一个用于同步。它们必须有不同的回调url。
https:// {yourmicroappserverurl} / admin / api / gwsc /认证/ serverContext
https:// {yourmicroappserverurl} / app / api /认证/ serviceAction /回调
注意:
在添加Jira集成时,请注意回调url。服务鉴权和服务动作鉴权具有不同的回调url。客户端ID和Secret必须与服务身份验证或服务动作身份验证回调URL相对应。
将集成添加到Citrix Workspace Microapps
按照以下步骤设置Jira HTTP集成。对于大多数用例,我们建议使用更新的HTTP集成。已预先选择身份验证选项。确保在完成流程时选中了这些选项。我们建议在大多数用例中使用这个更新的HTTP集成。HTTP集成提供了配置缓存数据结构的更强大功能。
注意:
默认情况下,该集成将同步六(6)个月的数据。我们建议您根据您的需要和机票的通常使用年限修改此值。筛选器基于最近一次更新,而不是创建。要更改此设置,必须修改
timeToSync
数据加载端点中的变量。看到替换数据加载变量.
遵循以下步骤:
- 从Microapp集成页面,选择添加新的集成,从citrix提供的模板中添加新的集成.
- 选择下面的吉拉瓦集成.
- 输入一个集成的名字对于积分。
- 输入连接器参数.
- 输入实例基URL或者简单地替换
{cloud-id}
在示例中使用您的云ID。如果您需要找到您的云- id,请以JIRA实例的管理员身份登录并查看URL。这个云- id是一个通用唯一标识符(UUID),它是一个8-4-4-4-12位十六进制数字,是URL的一部分。或者,您可以使用管理凭据进行身份验证,并将GET请求发送到https://api.atlassian.com/oauth/token/accessible-resources
.Cloud-ID是响应的一部分。 - 选择一个图标从图标库集成,或保留这个作为默认的Jira图标。
- 启用本地实例如果您正在创建本地连接,请切换。有关更多信息,请参见本地实例.由于您的Jira实例的Jira Cloud API v2和Jira Server API v2之间的差异,您还必须手动更新集成的某些部分。联系支持。
- 输入实例基URL或者简单地替换
下服务认证中,选择OAuth 2.0从身份验证方法菜单并完成身份验证详细信息。已预先选择身份验证选项。确保在完成流程时选中了这些选项。使用OAuth 2.0安全协议为委托访问生成请求/授权令牌。建议在可用的情况下始终使用OAuth 2.0作为服务身份验证方法。OAuth 2.0确保您的集成满足您所配置的微应用程序的最大安全合规。
- 选择授权代码从Grant型流程菜单。这授予了一个临时代码,客户端用它交换访问令牌。代码从授权服务器获得,您可以在其中看到客户端请求的信息。只有这种授权类型支持安全用户模拟。这将显示回调URL,在注册应用程序时使用。服务鉴权和服务动作鉴权具有不同的回调url。
- 输入authorization_code在授权类型值字段。
- 选择请求体从令牌授权菜单。
- 选择URL编码表单从令牌内容类型菜单。
- 你的授权URL预定义的。这是在设置目标应用程序集成时提供的授权服务器URL。
- 你的标记的URL预定义的。这是访问授权令牌的URL。
- 确保输入以下内容范围.此字符串由授权服务器在设置目标集成应用程序时定义。要同步其他实体,必须在此处添加作用域。用空格分隔的下列语句:
读:jira-user读:jira-work管理:jira-project管理:jira-configuration写:jira-work管理:jira-data-provider offline_access
. - 输入您的客户机ID.客户端ID是表示授权服务器唯一的客户端注册信息的字符串。您可以通过在Jira帐户中注册OAuth客户端来收集这些信息和秘密。客户端ID和Secret必须与服务身份验证回调URL相对应。
- 输入您的客户的秘密.客户端秘密是在设置目标应用程序集成时发出的唯一字符串。
- 输入您的标题前缀.(可选)如果您的承载字冠与默认字冠不同,请输入头冠。
下服务动作认证,启用在操作中使用独立用户身份验证toggle服务动作认证在服务动作级进行认证。已预先选择身份验证选项。确保在完成流程时选中了这些选项。
- 选择OAuth 2.0从身份验证方法菜单并完成身份验证详细信息。
- 选择授权代码从Grant型流程菜单。这授予了一个临时代码,客户端用它交换访问令牌。代码从授权服务器获得,您可以在其中看到客户端请求的信息。只有这种授权类型支持安全用户模拟。这将显示回调URL,在注册应用程序时使用。服务鉴权和服务动作鉴权具有不同的回调url。
- 输入authorization_code在授权类型值字段。
- 选择请求体从令牌授权菜单。
- 选择URL编码表单从令牌内容类型菜单。
- 你的授权URL预定义的。这是在设置目标应用程序集成时提供的授权服务器URL。
- 你的标记的URL预定义的。这是访问授权令牌的URL。
- 确保输入以下内容范围.此字符串由授权服务器在设置目标集成应用程序时定义。要同步其他实体,必须在此处添加作用域。用空格分隔的下列语句:
读:jira-user读:jira-work管理:jira-project管理:jira-configuration写:jira-work管理:jira-data-provider offline_access
. - 输入您的客户机ID.客户端ID是表示授权服务器唯一的客户端注册信息的字符串。您可以通过在Jira帐户中注册OAuth客户端来收集这些信息和秘密。客户端ID和Secret必须与服务动作身份验证回调URL相对应。
- 输入您的客户的秘密.客户端秘密是在设置目标应用程序集成时发出的唯一字符串。
- 输入您的标题前缀.(可选)如果您的承载字冠与默认字冠不同,请输入头冠。
- 如果你选择了OAuth 2.0认证方式,可选择+添加参数包括访问令牌参数.访问令牌参数定义目标应用程序授权服务器(如有必要)所需的访问令牌参数。
- (可选)如果要为此集成激活速率限制,请启用请求速率限制切换并设置请求数每时间间隔.
- (可选)使日志记录切换以保持24小时的日志记录用于支持目的。
的请求超时字段默认为120。
- 选择保存继续。
- 下OAuth授权中,选择授权使用您的服务帐户登录。弹出一个Webex登录屏幕。
- 输入您的服务帐户用户名和密码并选择登录.
- 选择接受.
继续执行以下步骤完成设置过程。
替换Service Action变量
要启用“创建史诗”页面功能,必须手动修改创建史诗而且创建Epic wo Assignee服务操作。取代{Epic-Name-customFieldId}
的值EpicFieldId
使用史诗名称存储在其中的自定义字段的id作为模板变量。
- 在Jira管理门户中,导航到问题.选择自定义字段从左边菜单。查找条目史诗般的名字然后选择屏幕另一侧的菜单。选择查看字段信息.
- 复制并保存URL末尾的数值。
- 回到Microapps,选择Jira集成旁边的菜单,然后编辑.选择服务的行动从左侧导航栏。
- 选择一个服务操作旁边的菜单并选择编辑,或选择服务操作的名称。让我们从创建史诗服务的行动。
在编辑服务动作屏幕,下模板变量取代
{Epic-Name-customFieldId}
的值EpicFieldId
使用前面在Jira中收集的自定义字段id的模板变量。- 选择保存完成。
- 现在对另一个服务操作重复此操作:创建Epic wo Assignee.
替换数据加载变量
默认情况下,该集成将同步六(6)个月的数据。我们建议您根据您的需要和机票的通常使用年限修改此值。筛选器基于最近一次更新,而不是创建。要更改此设置,必须修改timeToSync
中的变量问题数据加载端点。
- 从Microapp集成页面,选择Jira集成旁边的菜单,然后编辑.的数据加载屏幕上打开。如果在配置界面,选择数据加载从左侧导航栏。
- 控件旁边的菜单问题端点,然后选择编辑,或选择端点的名称:问题.
- 在编辑数据端点屏幕,下模板变量的值
timeToSync
变量与你想要的值。 选择应用在屏幕底部,并确认。
现在可以设置并运行第一次数据同步了。有关同步规则、不符合其时间表的同步和否决规则的完整信息,请参见同步数据.
有关API端点和表实体的详细信息,请参见Jira HTTP连接器规范.
使用Jira微应用程序
我们的Jira HTTP集成带有以下预配置的开箱即用的微应用程序:
创建史诗:创建一个新的吉拉史诗的细节。
注意:
若要启用“创建史诗”页功能,必须修改创建史诗而且创建Epic wo Assignee服务操作。看到替换Service Action变量.
通知或页面 | 用例的工作流 |
---|---|
创建史诗页面 | 提供用于创建新的Jira史诗的表单,包括输入史诗名称并选择问题类型、项目和可选的受让人,以及用于添加描述的字段。 |
项目页面 | 提供一个可搜索的表单,用于选择要将新史诗分配给的项目。 |
创建机票:创建一个新的带详细信息的Jira票据。
通知或页面 | 用例的工作流 |
---|---|
创建票务页面 | 提供用于创建新的Jira票据的表单,包括选择问题类型、项目和可选的受让人,以及用于添加描述的字段。 |
项目页面 | 提供一个可搜索的表单,用于选择要将新票据分配给的项目。 |
门票:查看票据、添加注释、创建子任务以及更改状态和受让人。
通知或页面 | 用例的工作流 |
---|---|
注释编辑(已分配票据)通知 | 当分配给用户的现有票据上的注释被编辑时,他们会在Workspace中收到关于已编辑注释的通知。 |
注释编辑(报告的票据)通知 | 当对用户报告的现有票据进行注释编辑时,他们会在Workspace中收到关于已编辑注释的通知。 |
新注释(已分配票据)通知 | 当一个新的注释被添加到分配给用户的现有票据中时,他们会收到一个通知。 |
新的评论(报告的票据)通知 | 当一个新的评论被添加到用户报告的现有票证中时,他们会收到一个通知。 |
票务分配给您(更改)通知 | 当现有的票据被分配给用户时,他们会收到一个通知。 |
票务分配给你(新)通知 | 当一个新票据被分配给用户时,他们会收到一个通知。 |
机票受让人变更(报告)通知 | 当票据被重新分配时,票据的报告者会收到一个通知。 |
票据状态变更(已分配票据)通知 | 当机票的状态发生变化时,机票的受让人将收到通知。 |
机票状态变更(已报告)通知 | 当票据的状态发生变化时,票据的报告人会收到通知。 |
评论详情页面 | 提供带有详细信息的注释的只读视图。 |
创建子任务页面 | 提供用于为Jira票据创建子任务的表单。 |
票务详情页面 | 提供Jira票据的详细视图,其中包含直接从页面添加注释和修改状态、优先级和受让人的字段。 |
票页面 | 允许用户通过搜索字段,项目选择器和状态选择器搜索Jira票,快速切换所有,我的,分配,报告,观看和评论票。 |
添加Legacy Jira集成
除了上面的步骤外,还请按照以下说明设置遗留集成。
先决条件
对于遗留集成,您需要这些值。
- URL
- 用户名
- 密码-必须输入API的令牌作为你的密码当您将集成添加到Citrix Workspace Microapps时
- 身份验证方法(凭据或OAuth2)
对于OAuth 2.0,您还需要:
- 客户机ID
- 客户的秘密
设置检索问题的持续时间
对于Legacy Jira集成,设置希望在Jira中检索问题的持续时间。当您将集成添加到Citrix Workspace Microapps时,可以通过应用负载过滤器限制集成从Jira检索的数据量。
使用您的专用用户帐户和密码登录Jira。
注意:
如果您正在使用现有帐户,则用户名不是帐户的电子邮件。要找到帐户的Username,登录到您的Jira实例,选择概要文件缩略图,选择配置文件.
输入要检索的问题的天数。
默认值:90天。
添加Jira Legacy集成
遵循以下步骤:
从概览页面中选择开始.
将打开管理集成页面。
- 选择添加新的集成,从citrix提供的模板中添加新的集成.
- 选择要添加的Jira贴图。
为集成输入一个名称。
- 进入连接器参数你收集的先决条件。
- 输入您的URL.
输入您的服务认证用户名而且密码.
注意:
进入API的令牌您在前面的步骤中收集的密码当您将集成添加到Citrix Workspace Microapps时。
- 选择一个身份验证方法.使用OAuth 2.0安全协议为委托访问生成请求/授权令牌。
- 凭证—凭据使用客户端的凭据。
- Oauth 2.0—进入OAuth客户端ID而且OAuth客户端秘密在先决条件过程中收集到的。
- 选择数量更改门票周加载.
- 选择添加.
的Microapp集成页面打开与您添加的集成及其微应用程序。从这里开始,您可以添加另一个集成,继续设置开箱即用的微应用程序,或者为该集成创建一个新的微应用程序。
现在可以设置并运行第一次数据同步了。由于可以从集成应用程序中提取大量数据到Microapps平台,我们建议您使用表格页,为第一次数据同步筛选实体,以加快同步速度。有关更多信息,请参见验证所需的实体.有关同步规则、不符合其时间表的同步和否决规则的完整信息,请参见同步数据.
有关API端点和表实体的详细信息,请参见Jira连接器规格.
遗留的Jira微应用程序
我们的Jira集成带有以下预配置的开箱即用的微应用程序:
创建机票:创建一个新的带详细信息的Jira票据。
通知或页面 | 用例的工作流 |
---|---|
创建票务页面 | 提供用于创建新的Jira票据的表单,包括选择问题类型、项目和可选的受让人,以及用于添加描述的字段。 |
门票:查看票据、添加注释、创建子任务以及更改状态和受让人。
通知或页面 | 用例的工作流 |
---|---|
注释编辑(已分配票据)通知 | 当分配给用户的现有票据上的注释被编辑时,他们会在Workspace中收到关于已编辑注释的通知。 |
注释编辑(报告)通知 | 当对用户报告的现有票据进行注释编辑时,他们会在Workspace中收到关于已编辑注释的通知。 |
新注释(已分配票据)通知 | 当一个新的注释被添加到分配给用户的现有票据中时,他们会收到一个通知。 |
新的评论(报告的票据)通知 | 当一个新的评论被添加到用户报告的现有票证中时,他们会收到一个通知。 |
票务分配给您(更改)通知 | 当现有的票据被分配给用户时,他们会收到一个通知。 |
票务分配给你(新)通知 | 当一个新票据被分配给用户时,他们会收到一个通知。 |
机票受让人变更(报告)通知 | 当票据被重新分配时,票据的报告者会收到一个通知。 |
票据状态变更(已分配票据)通知 | 当机票的状态发生变化时,机票的受让人将收到通知。 |
机票状态变更(已报告)通知 | 当票据的状态发生变化时,票据的报告人会收到通知。 |
添加评论页面 | 提供用于向Jira票据添加注释的表单。 |
更改受让人页面 | 提供用于更改Jira票据的受让人的表单。 |
“更改状态”页面 | 提供用于更改Jira票据状态的表单。 |
评论详情页面 | 提供带有详细信息的注释的只读视图。 |
创建子任务页面 | 提供用于为Jira票据创建子任务的表单。 |
票务详情页面 | 提供带有详细信息的Jira票据的只读视图。 |
票页面 | 允许用户搜索分配给他们的Jira票,由他们报告,或他们已经评论。 |