Esta página foi traduzida pela API Cloud Translation.

Jira Server (Data Center)

O conetor do Jira Server (Data Center) permite-lhe estabelecer ligação ao Jira Software Data Center e realizar operações de inserção, eliminação, atualização e leitura.

Versões suportadas

Este conetor suporta as versões V2 e V3 da API Jira Server Data Center.

Antes de começar

No seu projeto do Google Cloud, faça as seguintes tarefas:

Certifique-se de que a conetividade de rede está configurada. Para obter informações sobre padrões de rede, consulte o artigo Conetividade de rede.
Conceda a função IAM roles/connectors.admin ao utilizador que está a configurar o conetor.
Conceda as funções de IAM roles/secretmanager.viewer e roles/secretmanager.secretAccessor à conta de serviço que quer usar para o conector.
Ative os seguintes serviços:
- secretmanager.googleapis.com (Secret Manager API)
- connectors.googleapis.com (API Connectors)
Para saber como ativar serviços, consulte o artigo Ativar serviços. Se estes serviços ou autorizações não tiverem sido ativados anteriormente para o seu projeto, é-lhe pedido que os ative quando configurar o conector.

Configure o conetor

Uma associação é específica de uma origem de dados. Isto significa que, se tiver muitas origens de dados, tem de criar uma associação separada para cada origem de dados. Para criar uma associação, faça o seguinte:

Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.
Aceda à página Ligações
Clique em + CRIAR NOVO para abrir a página Criar associação.
Na secção Localização, escolha a localização para a ligação.
1. Região: selecione uma localização na lista pendente.
  Para ver a lista de todas as regiões suportadas, consulte o artigo Localizações.
2. Clique em SEGUINTE.
Na secção Detalhes da associação, conclua o seguinte:
1. Conetor: selecione Jira Server (Data Center) na lista pendente de conetores disponíveis.
2. Versão do conetor: selecione a versão do conetor na lista pendente de versões disponíveis.
3. No campo Nome da ligação, introduza um nome para a instância de ligação.
  Os nomes das associações têm de cumprir os seguintes critérios:
  - Os nomes das associações podem usar letras, números ou hífenes.
  - As letras têm de ser minúsculas.
  - Os nomes das associações têm de começar com uma letra e terminar com uma letra ou um número.
  - Os nomes das associações não podem exceder 49 carateres.
4. Opcionalmente, introduza uma Descrição para a instância de associação.
5. Opcionalmente, ative o Registo na nuvem e, em seguida, selecione um nível de registo. Por predefinição, o nível do registo está definido como Error.
6. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
7. Para usar a associação para subscrições de eventos, selecione Ativar subscrição de eventos. São apresentadas as seguintes opções:
  - Ativar subscrição de eventos com entidade e ações: selecione esta opção para usar a associação para a subscrição de eventos e as operações do conetor (entidades e ações).
  - Ativar apenas subscrição de eventos: selecione esta opção para usar a associação apenas para a subscrição de eventos. Se selecionar esta opção, clique em Seguinte e, de seguida, configure a subscrição de eventos.
  Nota: os seguintes passos de configuração de associação adicionais são necessários se optar por ativar entidades, operações e ações para a associação:
  - Destinos
  - Autenticação
8. Opcionalmente, configure as definições do nó de associação:
  - Número mínimo de nós: introduza o número mínimo de nós de ligação.
  - Número máximo de nós: introduza o número máximo de nós de ligação.
  Um nó é uma unidade (ou uma réplica) de uma ligação que processa transações. São necessários mais nós para processar mais transações para uma ligação e, inversamente, são necessários menos nós para processar menos transações. Para compreender como os nós afetam os preços dos conectores, consulte o artigo Preços dos nós de ligação. Se não introduzir valores, por predefinição, os nós mínimos são definidos como 2 (para uma melhor disponibilidade) e os nós máximos são definidos como 50.
9. (Opcional) Na secção Definições avançadas, selecione a caixa de verificação Usar proxy para configurar um servidor proxy para a ligação e configurar os seguintes valores:
10. Opcionalmente, se quiser usar SSL, selecione Ativar SSL. São apresentados os detalhes da configuração SSL.
  1. Selecione um tipo de loja fidedigna. Pode ser Público, Privado ou Ligação não segura.
  2. Selecione os certificados conforme apresentado com base na sua seleção da loja de confiança.
  3. Se estiver a usar o mTLS, selecione os certificados do armazenamento de chaves na secção Armazenamento de chaves.
  Nota:
  - Todos os seus certificados têm de ser certificados X.509 e têm de estar no formato PEM (Privacy Enhanced Mail).
  - Não pode selecionar diretamente um certificado quando configura o SSL. Tem de armazenar todos os seus certificados e chaves privadas como um segredo do Secret Manager e, em seguida, selecionar o segredo necessário durante a configuração SSL.
11. Opcionalmente, clique em + ADICIONAR ETIQUETA para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
12. Clique em SEGUINTE.
Na secção Destinos, introduza os detalhes do anfitrião remoto (sistema de back-end) ao qual quer estabelecer ligação.
1. Tipo de destino: selecione um Tipo de destino.
  - Para especificar o nome de anfitrião ou o endereço IP de destino, selecione Endereço do anfitrião e introduza o endereço no campo Anfitrião 1.
  - Para estabelecer uma ligação privada, selecione Anexo do ponto final e escolha o anexo necessário na lista Anexo do ponto final.
    Nota: para saber como criar uma associação de ponto final, consulte Associação de serviço do PSC e Associação de ponto final. Depois de criar a associação do ponto final, esta fica visível na lista Associação do ponto final.
  Se quiser estabelecer uma ligação pública aos seus sistemas de back-end com segurança adicional, pode considerar configurar endereços IP estáticos de saída para as suas ligações e, em seguida, configurar as regras da firewall para permitir apenas os endereços IP estáticos específicos.
  
  Para introduzir destinos adicionais, clique em +ADICIONAR DESTINO.
2. Clique em SEGUINTE.
Na secção Autenticação, introduza os detalhes de autenticação.
1. Selecione um Tipo de autenticação e introduza os detalhes relevantes.
  Os seguintes tipos de autenticação são suportados pela ligação do Jira Server (Data Center):
  - Palavra-passe do utilizador
  - Chave da API
  - Token de acesso pessoal
  - OAuth 2.0 – Código de autorização
2. Clique em SEGUINTE.
Rever: reveja os detalhes da ligação e da autenticação.
Clique em Criar.

Detalhes da subscrição de eventos

Na secção Detalhes da subscrição de eventos, indique os detalhes da conta do Jira Server (Data Center) onde as subscrições de eventos vão ser criadas.

Tipo de destino: selecione Endereço do anfitrião.
Anfitrião: introduza o URL de registo da sua conta do Jira Server (Data Center). Serão criadas subscrições de eventos para este URL.
Token da API: selecione o segredo do Secret Manager que contém o token da API associado ao nome de utilizador.
Versão do Secret: selecione uma versão do Secret.
Ativar o enriquecimento de dados: selecione esta caixa de verificação se quiser que o acionador do Jira Server (Data Center) obtenha a carga útil completa do evento da instância do Jira Server (Data Center). Consulte Saída do acionador para ver exemplos.
Selecione Ativar conetividade privada para uma conetividade segura entre a sua aplicação de back-end e a sua ligação. Se selecionar esta opção, tem de realizar passos de configuração adicionais depois de criar a associação. Para mais informações, consulte o artigo Conetividade privada para subscrição de eventos.
Introduza a configuração de mensagens não entregues. Se configurar a fila de mensagens rejeitadas, a ligação escreve os eventos não processados no tópico Pub/Sub especificado. Introduza os seguintes detalhes:
1. ID do projeto de mensagens não entregues: o ID do projeto do Google Cloud onde configurou o tópico Pub/Sub de mensagens não entregues.
2. Tópico de mensagens não entregues: o tópico do Pub/Sub onde quer escrever os detalhes do evento não processado.

Configure a autenticação

Introduza os detalhes com base na autenticação que quer usar.

Palavra-passe do utilizador
- Nome de utilizador: introduza a conta de utilizador do Jira Server (Data Center) usada para autenticação.
- Palavra-passe: introduza a palavra-passe associada à conta.
API Token
- Nome de utilizador: introduza o nome de utilizador do Jira Server (Data Center) usado para criar o token da API.
- Token da API: selecione o segredo do Secret Manager que contém o token da API.
Chave de acesso pessoal
- Chave de acesso pessoal: indique o segredo do Secret Manager que contém a chave de acesso pessoal.
- Versão do Secret: selecione a versão do Secret para o Secret selecionado.
OAuth 2.0 – Código de autorização
- ID de cliente: indique o ID de cliente conforme fornecido pela sua aplicação externa.
- Âmbitos: especifique os âmbitos de autorização necessários.
- Segredo do cliente : selecione o segredo do Secret Manager. Tem de ter criado o Secret do Secret Manager antes de configurar esta autorização.
- Versão do Secret: selecione a versão do Secret do Secret Manager para o segredo do cliente.
- URL de autorização: faculte o URL gerado durante a criação do cliente.

Configuração do Jira Server (Data Center)

Para ver informações sobre como configurar uma conta da Atlassian e iniciar sessão no Jira Cloud, consulte a página inicial da Atlassian.

Configure uma morada do anfitrião e detalhes de autenticação

Inicie sessão na sua instância do Jira Cloud.
Introduza o endereço do anfitrião, que são os detalhes da instância.
Introduza o seu nome de utilizador, que é o ID da conta Atlassian.
Aceda a Definições para gerar o token da API.
Selecione Definições da conta Atlassian nas definições pessoais.
Clique no separador Segurança, encontre os tokens de API e clique em Criar e gerir tokens de API.
Clique em Criar token de API.
Introduza uma etiqueta memorável e concisa para o seu token na caixa de diálogo apresentada e clique em Criar.
Clique em Copiar para a área de transferência, cole o token no script e guarde-o para utilização posterior.

Passos adicionais após a criação da associação

Se selecionou OAuth 2.0 - Authorization code para a autenticação, tem de realizar os seguintes passos adicionais após criar a associação:

Na página Ligações, encontre a ligação criada recentemente.
Tenha em atenção que o Estado do novo conetor é Autorização necessária.
Clique em Autorização obrigatória.
É apresentado o painel Editar autorização.
Copie o valor do URI de redirecionamento para a sua aplicação externa.
Valide os detalhes da autorização.
Clique em Autorizar.
Se a autorização for bem-sucedida, o estado da ligação é definido como Ativo na página Ligações.

Nova autorização para o código de autorização

Se estiver a usar o tipo de autenticação Authorization code e tiver feito alterações de configuração na sua aplicação Jira Server (Data Center), tem de voltar a autorizar a ligação do Jira Server (Data Center). Para autorizar novamente uma associação, siga estes passos:

Clique na associação necessária na página Associações.
É apresentada a página de detalhes da associação.
Clique em Editar para editar os detalhes da associação.
Valide os detalhes de OAuth 2.0 – Código de autorização na secção Autenticação.
Se necessário, faça as alterações necessárias.
Clique em Guardar. Esta ação direciona para a página de detalhes da associação.
Clique em Editar autorização na secção Autenticação. É apresentado o painel Autorizar.
Clique em Autorizar.
Se a autorização for bem-sucedida, o estado da ligação é definido como Ativo na página Ligações.

Exemplos de configuração de ligação

Esta secção apresenta os valores de exemplo para os vários campos que configura quando cria a ligação ao Jira Server.

Tipo de ligação Web do Jira

Nome do campo	Detalhes
Localização	us-east1
Conetor	Jira Server (Data Center)
Versão do conetor	1
Nome da ligaçã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 anfitrião
anfitrião	192.0.2.0
Nome de utilizador	NOME DE UTILIZADOR
Chave da API	API_TOKEN
Versão do secret	1

Limitações do sistema

O conector do Jira Server (Data Center) pode processar um máximo de 15 transações por segundo, por nó e limita todas as transações que excedam este limite. Por predefinição, os Integration Connectors atribuem 2 nós (para uma melhor disponibilidade) a uma ligação.

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

Nota: o número de nós de conectores de integração é dimensionado automaticamente de forma dinâmica com base na sua utilização. No entanto, se quiser reservar capacidade para grandes volumes sem esperar pela escalabilidade automática, pode ajustar o valor mínimo de nós para uma ligação. São necessários mais nós para processar mais transações para uma associação. Por outro lado, são necessários menos nós se uma associação processar menos transações. Para configurar os valores dos nós, faça o seguinte:

Se for cliente de pagamento conforme o uso, configure o valor mínimo e máximo do nó na página de edição da associação.
Se for cliente com base numa subscrição, contacte o apoio técnico.

O número máximo de transações que um nó pode processar depende de vários fatores. Assim, antes de ajustar os nós mínimos para um melhor débito, é recomendável verificar se os seus sistemas de back-end estão configurados de forma ideal para processar o tráfego necessário.

Use a ligação do Jira Server (Data Center) numa integração

Depois de criar a ligação, esta fica disponível no Apigee Integration e no Application Integration. Pode usar a ligação numa integração através da tarefa Conectores.

Para compreender como criar e usar a tarefa Connectors no Apigee Integration, consulte o artigo Tarefa Connectors.
Para compreender como criar e usar a tarefa Connectors na integração de aplicações, consulte o artigo Tarefa Connectors.

Exemplos de operações de entidades

Esta secção fornece exemplos de como realizar as operações de entidades neste conector.

Exemplo: problemas com listas

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Problemas na lista Entity.
Selecione a operação LIST e, de seguida, clique em Concluído.
Na secção Task Input da tarefa Connectors, pode definir o filterClause de acordo com o requisito do cliente.

Tem de usar aspas simples (') para incluir o valor de uma cláusula de filtro. Pode usar a cláusula filter para filtrar registos com base nas colunas.

Pode usar a cláusula filter para filtrar registos com base nas colunas. Por exemplo, para filtrar registos, use a seguinte filterClause: Location='US' e region='us-east1'.

filterClause

Exemplo: obter problemas

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Problemas na lista Entity.
Selecione a operação GET e, de seguida, 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 secção Entrada da tarefa da tarefa Conetores, clique em EntityId e, em seguida, introduza 10000 no campo Valor predefinido.
O valor do ID da entidade deve ser transmitido diretamente. Por exemplo, 10000. Aqui, 10000 é o valor da chave primária exclusivo, que é transmitido.

Para usar a operação Get, a entidade tem de ter uma chave principal exclusiva. Caso contrário, não é possível realizar a operação Get.

Exemplo – Problemas de eliminação

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

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, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
  "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, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
  "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, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
  "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, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
  "Id": 10023.0,
  "IssueId": null
}
```

Exemplo: criar utilizadores

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Utilizadores na lista Entity.
Selecione a operação Create e, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
  "AccountId": "557058:0a04612c-746d-4d47-a909-71ba797fe228"
}
```

Exemplo: criar registos de tempo

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Registos de trabalho na lista Entity.
Selecione a operação Create e, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
  "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, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
```
{
  "Name": "NEW_TASK",
  "Description": "New Description"
} 
```
Defina o ID da entidade para a entidade dos IssueTypes . Para definir o ID da entidade, clique em entityId e, de seguida, introduza 10038 no campo Valor predefinido.
Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
  "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, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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, de seguida, introduza 10024 no campo Valor predefinido.
Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
  "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, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 dos Sprints . Para definir o ID da entidade, clique em entityId e, de seguida, introduza 2 no campo Valor predefinido.
Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
}
```

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, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 dos comentários . Para definir o ID da entidade, clique em entityId e, de seguida, introduza 2 no campo Valor predefinido.
Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
}
```

Obtenha ajuda da comunidade do Google Cloud

Pode publicar as suas perguntas e discutir este conector na comunidade do Google Cloud nos Fóruns do Cloud.

O que se segue?

Compreenda como suspender e retomar uma associação.
Compreenda como monitorizar a utilização do conector.
Compreenda como ver os registos do conetor.