Esta página foi traduzida pela API Cloud Translation.

Jira Server (Data Center)

O conector do Jira Server (Data Center) permite se conectar ao Jira Software Data Center e realizar operações de inserção, exclusão, atualização e leitura.

Versões compatíveis

Esse conector é compatível com as versões V2 e V3 da API do Jira Server Data Center.

Antes de começar

No seu projeto do Google Cloud, faça o seguinte:

Verifique se a conectividade de rede está configurada. Para informações sobre padrões de rede, consulte Conectividade de rede.
Conceda o papel do IAM roles/connectors.admin ao usuário que está configurando o conector.
Conceda os papéis do IAM roles/secretmanager.viewer e roles/secretmanager.secretAccessor à conta de serviço que você quer usar para o conector.
Ative os seguintes serviços:
- secretmanager.googleapis.com (API Secret Manager)
- connectors.googleapis.com (API Connectors)
Para entender como ativar os serviços, consulte Como ativar serviços. Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, faça o seguinte:

No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.
Acessar a página "Conexões"
Clique em + CRIAR NOVO para abrir a página Criar conexão.
Na seção Local, escolha o local da conexão.
1. Região: selecione um local na lista suspensa.
  Para conferir a lista de todas as regiões com suporte, consulte Locais.
2. Clique em PRÓXIMA.
Na seção Detalhes da conexão, faça o seguinte:
1. Conector: selecione Jira Server (Data Center) na lista suspensa de conectores disponíveis.
2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
3. No campo Nome da conexão, insira um nome para a instância de conexão
  Os nomes de conexão precisam atender aos seguintes critérios:
  - Os nomes de conexões podem usar letras, números ou hifens.
  - As letras precisam ser minúsculas.
  - Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
  - Os nomes das conexões não podem exceder 49 caracteres.
4. Como opção, insira uma Descrição para a instância de conexão.
5. Se quiser, ative o Cloud Logging e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
7. Para usar a conexão em assinaturas de eventos, selecione Ativar assinatura de eventos. As seguintes opções vão aparecer:
  - Ativar assinatura de eventos com entidade e ações: selecione essa opção para usar a conexão para assinatura de eventos e operações de conector (entidades e ações).
  - Ativar somente a assinatura de eventos: selecione essa opção para usar a conexão apenas para assinatura de eventos. Se você selecionar essa opção, clique em Próxima e configure a inscrição no evento.
  Observação:as etapas de configuração de conexão adicionais a seguir são necessárias se você ativar entidades, operações e ações para a conexão:
  - Destinos
  - Authentication
8. Opcionalmente, defina as Configurações do nó de conexão:
  - Número mínimo de nós: digite o número mínimo de nós de conexão.
  - Número máximo de nós: digite o número máximo de nós de conexão.
  Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.
9. (Opcional) Na seção Configurações avançadas, marque a caixa de seleção Usar proxy para configurar um servidor proxy para a conexão e defina os seguintes valores:
10. Como opção, se quiser usar SSL, selecione Ativar SSL. Os detalhes da configuração do SSL serão exibidos.
  1. Selecione um tipo de loja de confiança. Pode ser Pública, Particular ou Conexão não segura.
  2. Selecione os certificados com base na sua seleção de loja de confiança.
  3. Se você estiver usando mTLS, selecione os certificados de armazenamento de chaves na seção Armazenamento de chaves.
  Observação:
  - Todos os certificados precisam estar no formato X.509 e precisam estar no formato PEM (Privacy Enhanced Mail).
  - Não é possível selecionar um certificado diretamente ao configurar o SSL. É preciso armazenar todos os seus certificados e chaves privadas como um Secret do Secret Manager e, em seguida, selecionar o secret exigido durante a configuração do SSL.
11. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
12. Clique em PRÓXIMA.
Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
1. Tipo de destino: selecione um Tipo de destino.
  - Para especificar o nome do host ou o endereço IP de destino, selecione Endereço do host e insira o endereço no campo Host 1.
  - Para estabelecer uma conexão particular, selecione Anexo de endpoint e escolha o anexo necessário na lista Anexo de endpoint.
    Observação : para entender como criar um anexo de endpoint, consulte Anexo de serviço PSC e anexo de endpoint. Depois de ter criado o anexo de endpoint, ele vai aparecer na lista Anexo do endpoint.
  Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.
  
  Para inserir outros destinos, clique em +ADICIONAR DESTINO.
2. Clique em PRÓXIMA.
Na seção Autenticação, insira os detalhes da autenticação.
1. Selecione um Tipo de autenticação e insira os detalhes relevantes.
  A conexão do Jira Server (Data Center) aceita os seguintes tipos de autenticação:
  - Senha do usuário
  - Token da API
  - Token de acesso pessoal
  - Código de autorização OAuth 2.0
2. Clique em PRÓXIMA.
Revisão: revise os detalhes de conexão e autenticação.
Clique em Criar.

Detalhes da inscrição em eventos

Na seção Detalhes da assinatura de evento, forneça detalhes da conta do Jira Server (Data Center) em que as assinaturas de evento serão criadas.

Tipo de destino:selecione Endereço do host.
Host:insira o URL de registro da sua conta do Jira Server (Data Center). As inscrições em eventos serão criadas para esse URL.
Token da API:selecione o secret do Secret Manager que contém o token da API associado ao nome de usuário.
Versão do secret:selecione uma versão do secret.
Ativar o enriquecimento de dados:marque essa caixa de seleção se quiser que o gatilho do Jira Server (Data Center) recupere o payload completo do evento da instância do Jira Server (Data Center). Consulte Saída do acionador para ver exemplos.
Selecione Ativar conectividade particular para uma conectividade segura entre o aplicativo de back-end e a conexão. Se você selecionar essa opção, precisará executar mais etapas de configuração depois de criar a conexão. Para mais informações, consulte Conectividade particular para assinatura de eventos.
Insira a configuração de mensagens inativas. Se você configurar a carta inativa, a conexão gravará os eventos não processados no tópico do Pub/Sub especificado. Digite os seguintes detalhes:
1. ID do projeto de dead-letter : o ID do projeto do Google Cloud em que você configurou o tópico de dead-letter do Pub/Sub.
2. Tópico de mensagens mortas : o tópico do Pub/Sub em que você quer gravar os detalhes do evento não processado.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

Senha do usuário
- Nome de usuário: digite a conta de usuário do Jira Server (Data Center) usada para autenticação.
- Senha: digite a senha associada à conta.
Token da API
- Nome de usuário: digite o nome de usuário do Jira Server (Data Center) usado para criar o token de API.
- Token da API: selecione o secret do Secret Manager que contém o token da API.
Token de acesso pessoal
- Token de acesso pessoal: forneça o secret do Secret Manager que contém o token de acesso pessoal.
- Versão do secret: selecione a versão do secret escolhido.
OAuth 2.0 - Código de autorização
- ID do cliente: informe o ID do cliente conforme fornecido pelo aplicativo externo.
- Escopos: especifique os escopos de permissão necessários.
- Chave secreta do cliente : selecione a chave Secret Manager. É necessário criar a chave secreta do Secret Manager antes de configurar esta autorização.
- Versão do secret: selecione a versão do secret do cliente no Secret Manager.
- URL de autorização : forneça o URL gerado durante a criação do cliente.

Configuração do Jira Server (Data Center)

Para informações sobre como configurar uma conta da Atlassian e fazer login no Jira Cloud, consulte Página inicial da Atlassian.

Configurar um endereço de host e detalhes de autenticação

Faça login na sua instância do Jira Cloud.
Insira o endereço do host, que são os detalhes da instância.
Insira seu nome de usuário, que é o ID da sua conta da Atlassian.
Acesse Configurações para gerar o token de API.
Selecione Configurações da conta da Atlassian em configurações pessoais.
Clique na guia Segurança, encontre "Tokens de API" e clique em Criar e gerenciar tokens de API.
Clique em Criar token de API.
Na caixa de diálogo que aparece, insira um marcador memorável e conciso para o token e clique em Criar.
Clique em Copiar para a área de transferência, cole o token no script e salve para uso futuro.

Etapas adicionais após a criação da conexão

Se você selecionou OAuth 2.0 - Authorization code para autenticação, siga estas etapas adicionais depois de criar a conexão:

Na página "Conexões", localiza a conexão recém-criada.
O Status do novo conector será Autorização necessária.
Clique em Autorização necessária.
O painel Editar autorização é exibido.
Copie o valor de URI de redirecionamento para seu aplicativo externo.
Verifique os detalhes da autorização.
Clique em Autorizar.
Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página "Conexões".

Reautorização do código de autorização

Se você estiver usando o tipo de autenticação Authorization code e tiver feito alterações de configuração no aplicativo Jira Server (Data Center), será necessário autorizar novamente a conexão do Jira Server (Data Center). Para reautorizar uma conexão, siga estas etapas:

Clique na conexão desejada na página "Conexões".
A página de detalhes da conexão será aberta.
Clique em Editar para mudar os detalhes da conexão.
Verifique os detalhes do Código de autorização do OAuth 2.0 na seção Autenticação.
Se necessário, faça as mudanças necessárias.
Clique em Salvar. Isso leva você à página de detalhes da conexão.
Clique em Editar autorização na seção Autenticação. O painel Autorizar é exibido.
Clique em Autorizar.
Se a autorização for concluída, o status da conexão será definido como Ativo na página "Conexões".

Exemplos de configuração de conexão

Esta seção lista os valores de exemplo para os vários campos que você configura ao criar a conexão do Jira Server.

Tipo de conexão da Web do Jira

Nome do campo	Detalhes
Local	us-east1
Conector	Jira Server (Data Center)
Versão do conector	1
Nome da conexão	google-cloud-jira-rest-conn
Conta de serviço	my-service-account@my-project.iam.gserviceaccount.com
Número mínimo de nós	2
Número máximo de nós	50
Tipo de destino	Endereço do host
host	192.0.2.0
Nome de usuário	NOME DE USUÁRIO
Token da API	API_TOKEN
Versão do secret	1

Limitações do sistema

O conector do Jira Server (Data Center) pode processar até 15 transações por segundo, por nó, e limita qualquer transação além desse limite. Por padrão, o Integration Connectors aloca dois nós (para melhor disponibilidade) para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Observação:o número de nós do Integration Connectors será escalonado automaticamente de forma dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes sem esperar pelo escalonamento automático, ajuste o valor mínimo do nó para uma conexão. Mais nós são necessários para processar mais transações para uma conexão. Por outro lado, menos nós são necessários se uma conexão processar menos transações. Para configurar os valores do nó, faça o seguinte:

Se você for um cliente de pagamento por utilização, configure o valor mínimo e máximo do nó na página de edição da conexão.
Se você for um cliente por assinatura, entre em contato com o suporte.

O número máximo de transações que um nó pode processar depende de vários fatores. Portanto, antes de ajustar o número mínimo de nós para melhorar a capacidade de processamento, recomendamos que você verifique se os sistemas de back-end estão configurados de maneira ideal para lidar com o tráfego necessário.

Usar a conexão do Jira Server (Data Center) em uma integração

Depois de criar a conexão, ela fica disponível na integração da Apigee e Application Integration. É possível usar a conexão em uma integração pela tarefa de conectores.

Para entender como criar e usar a tarefa "Conectores" na integração da Apigee, consulte Tarefa "Conectores".
Para entender como criar e usar a tarefa "Conectores" na Application Integration, consulte Tarefa "Conectores".

Exemplos de operações de entidade

Nesta seção, mostramos exemplos de como realizar as operações de entidade neste conector.

Exemplo: listar problemas

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Problemas" na lista Entity.
Selecione a operação LIST e clique em Concluído.
Na seção Entrada de tarefa da tarefa Conectores, é possível definir a filterClause de acordo com a exigência do cliente.

Use aspas simples (') para colocar o valor de uma cláusula de filtro. É possível usar a cláusula de filtro para filtrar registros com base nas colunas.

É possível usar a cláusula de filtro para filtrar registros com base nas colunas. Por exemplo, para filtrar registros, use a seguinte filterClause: Location='US' e region='us-east1'.

filterClause

Exemplo: receber problemas

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Problemas" na lista Entity.
Selecione a operação GET e clique em Concluído.
Defina o ID da entidade como 10000, que é o ID da chave a ser transmitido para problemas. Para definir o ID da entidade, na seção Entrada da tarefa da tarefa Conectores, clique em EntityId e insira 10000 no campo Valor padrão.
O valor do ID da entidade precisa ser transmitido diretamente. Por exemplo, 10000. Aqui, 10000 é o valor exclusivo da chave primária, que é transmitido.

Para usar a operação "Get", a entidade precisa ter uma chave primária exclusiva. Caso contrário, a operação não poderá ser realizada.

Exemplo: excluir problemas

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Problemas" na lista Entity.
Selecione a operação DELETE e clique em Concluído.
Defina o ID da entidade como 10000, que é a chave a ser transmitida. Para definir o ID da entidade, na seção Entrada da tarefa da tarefa Conectores, clique em EntityId e insira 10000 no campo Valor padrão.

Exemplo: criar IssueTypes

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione IssueTypes na lista Entity.
Selecione a operação Create e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
  "Name": "task123456",
  "Description": "New description is added."
}
```
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
  "Id": "10041"
}  
```

Exemplo: criar problemas

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Problemas" na lista Entity.
Selecione a operação Create e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
    "IssueTypeName": "Subtask", 
    "ProjectName": "kanban4", 
    "Summary": "Summary Added", 
    "ParentKey": "KN-6" 
}
```
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
  "Id": 10071.0
}
```

Exemplo: criar sprints

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Sprints" na lista Entity.
Selecione a operação Create e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
  "Name": "PROJ Sprint Googlecloud",
  "State": "future",
  "Goal": null,
  "OriginBoardId": 2.0,
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
}
```
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
  "Id": 23.0
}   
```

Exemplo: criar comentários

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Comentários" na lista Entity.
Selecione a operação Create e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
  "IssueId": 10001.0,
  "Body": "Adding comments to above ID by editing it"
}
```
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
  "Id": 10023.0,
  "IssueId": null
}
```

Exemplo: criar usuários

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Usuários" na lista Entity.
Selecione a operação Create e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
  "GroupName": null,
  "DisplayName": "Sample",
  "EmailAddress": "sample@gmail.com",
  "Active": true,
  "TimeZone": null,
  "Locale": "en_US",
  "AccountType": "atlassian"
}
```
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
  "AccountId": "557058:0a04612c-746d-4d47-a909-71ba797fe228"
}
```

Exemplo: criar registros de trabalho

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Registros de trabalho" na lista Entity.
Selecione a operação Create e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
  "IssueKey": "GJCT-1",
  "Started": "2023-06-10 08:08:08",
  "TimeSpent": "2000"
}
```
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
  "Id": "41718",
  "IssueId": 10000.0
}
```

Exemplo: atualizar IssueTypes

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione IssueTypes na lista Entity.
Selecione a operação Update e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
  "Name": "NEW_TASK",
  "Description": "New Description"
} 
```
Defina o ID da entidade como a entidade de IssueTypes . Para definir o ID da entidade, clique em entityId e insira 10038 no campo Valor padrão.
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
  "Id": "10038"
}
```

Exemplo: problemas de atualização

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Problemas" na lista Entity.
Selecione a operação Update e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
  "AssigneeAccountId": "61d572aa7c6f9800705289a1",
  "AssigneeName": "Charlie b"
}
```
Defina o ID da entidade como a entidade dos problemas . Para definir o ID da entidade, clique em entityId e insira 10024 no campo Valor padrão.
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
  "AssigneeDisplayName": "Charlie b"
}
```

Exemplo: atualizar sprints

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Sprints" na lista Entity.
Selecione a operação Update e clique em Concluído.

Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

{
  "Name": "PROJ Sprint Googlecloud_Updated",
  "State": "future",
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
}

Defina o ID da entidade como a entidade das sprints . Para definir o ID da entidade, clique em entityId e insira 2 no campo Valor padrão.
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
}
```

Exemplo: atualizar comentários

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Comentários" na lista Entity.
Selecione a operação Update e clique em Concluído.