Esta página foi traduzida pela API Cloud Translation.

Gerenciamento de serviços do Jira

Com o conector do Jira Service Management, você pode se conectar ao Jira Service Management e realizar operações de inserção, exclusão, atualização e leitura.

Antes de começar

Antes de usar o conector do Jira Service Management, siga estas etapas:

No seu projeto do Google Cloud, faça o seguinte:
- Conceder o papel do IAM roles/connectors.admin ao usuário e configurar o conector.
- Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.
- 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

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). 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, siga estas etapas:

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 Gestão de serviços do Jira 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 ter mais de 49 caracteres.
4. Como opção, insira uma Descrição para a instância de conexão.
5. Como opção, 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. Insira um ID da Central de Serviços do usuário autenticado. Por padrão, recebemos o primeiro ID retornado de uma chamada extra para receber todas as mesas de serviço. Você pode obter o ServiceDeskId executando uma consulta de lista para a entidade ServiceDesks.
8. Insira o nível de detalhamento da conexão, que varia de 1 a 5. O nível de detalhes mais alto registrará todos os detalhes da comunicação (solicitação,resposta e certificados SSL).
9. 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.
10. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
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.
  - Selecione Endereço do host na lista para especificar o nome do host ou o endereço IP do destino.
  - Para estabelecer uma conexão particular com seus sistemas de back-end, Selecione Anexo de endpoint na lista e depois selecione o anexo de endpoint necessário. na lista Endpoint Attachment.
    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.
  Os seguintes tipos de autenticação são compatíveis com a conexão do Jira Service Management:
  - OAuth2.0
  - Básico
  - APIToken
2. Clique em PRÓXIMA.
Revisão: revise os detalhes de conexão e autenticação.
Clique em Criar.

Configurar a autenticação

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

OAuth2.0
- ID do cliente: ID do cliente conforme fornecido pelo aplicativo externo.
- Escopos: escopos de permissão. O escopo offline_access precisa ser usado com o conector de gerenciamento de serviços do Jira. Para entender como os escopos funcionam e para conferir todos os escopos disponíveis para o Jira Service Management, consulte Escopos.
- Chave secreta do cliente: selecione a chave Gerenciador de secrets. É preciso criar o secret do Secret Manager antes de configurar a autorização.
- Versão do secret: a versão do secret do cliente no Secret Manager.
Básico
- Nome de usuário: a conta de usuário do Jira Service Management usada para autenticação.
- Senha: a senha associada à conta.
APIToken
- Nome de usuário: o nome de usuário do Jira Service Management usado para criar o token de API.
- Token da API: a senha do nome de usuário será um token da API. Selecione o Secret do Secret Manager que contém o token de API associado ao nome de usuário do Jira Cloud.

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

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

Na página "Conexões", localize 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 será exibido.
Copie o valor do 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 mudanças de configuração no aplicativo Jira Service Management: Autorize novamente sua conexão do Jira Service Management. Para autorizar novamente uma conexão, siga estas etapas:

Clique na conexão necessária na página "Conexões".
A página de detalhes da conexão será aberta.
Clique em Editar para editar os detalhes da conexão.
Verifique os detalhes de OAuth 2.0 - Código de autorização 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 Authorize é mostrado.
Clique em Autorizar.
Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página Conexões.

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.
No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.
Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:
- Lista
- Receber
- Criar
- Atualizar
- Excluir
Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações da entidade, como as operações não estão listadas na lista Operations.
Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada e um de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Limitações do sistema

O conector de gerenciamento de serviço do Jira pode processar 15 transações por segundo, por nó, e limita todas as transações 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 maneira dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes aguardando o 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 processa menos transações. Para configurar o 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 de conexão.
Se você tem uma 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 os nós mínimos para melhorar a capacidade de processamento, verifique se os sistemas de back-end estão configurados de maneira ideal para lidar com o tráfego necessário.

Ações

O conector do Jira Service Managmenet fornece ações, como AddAttachment, Attach AgoraFile e CreateCustomer. Para saber como configurar ações, consulte os Exemplos de ação.

Exemplos de ação

Esta seção descreve como executar algumas das ações neste conector.

Exemplo: anexar um arquivo temporário

Este exemplo anexa um arquivo temporário e fornece um ID de anexo que você usa para adicionar um anexo.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação AttachTemporaryFile e clique em Concluído.
Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:
```
  {
    "Content": "test to create 1 temporaryid"
  }
```

Se a ação for bem-sucedida, seu Resposta connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:

[{
    "TemporaryAttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8",
    "FileName": "16324233309516250343.connector.txt"
}]

Exemplo: adicionar um anexo

Esse exemplo anexa o arquivo temporário ao ID da solicitação fornecido no payload de entrada.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação AddAttachment 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:
```
{
    "AttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8",
    "RequestId": "10032"
}  
```

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

[{
  "Success": "true",
  "filename": "16324233309516250343.connector.txt",
}]

Exemplo: criar um cliente

Este exemplo cria um cliente.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação CreateCustomer 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:
```
{
  "Email": "something@something.com",
  "FullName": "Something"
} 
```

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

[{
    "Key": null,
    "AccountId": "qm:476582de-e968-4bc9-b0be-0349e8e3ec97:244dd7e4-0b49-4468-adac-561ab09bf2bb",
    "Name": null,
    "EmailAddress": "something@something.com",
    "DisplayName": "Something",
    "Active": "true",
    "Timezone": "Asia/Calcutta",
    "_links.jirarest": "https://google-team-zlre6yes.atlassian.net/rest/api/2/user?accountId=qm%3A476582de-e968-4bc9-b0be-0349e8e3ec97%3A244dd7e4-0b49-4468-adac-561ab09bf2bb",
    "_links.avatarurls.48x48": "https://avatar-management.services.atlassian.com/default/48",
    "_links.avatarurls.24x24": "https://avatar-management.services.atlassian.com/default/24",
    "_links.avatarurls.16x16": "https://avatar-management.services.atlassian.com/default/16",
    "_links.avatarurls.32x32": "https://avatar-management.services.atlassian.com/default/32",
    "_links.self": "https://google-team-zlre6yes.atlassian.net/rest/api/2/user?accountId=qm%3A476582de-e968-4bc9-b0be-0349e8e3ec97%3A244dd7e4-0b49-4468-adac-561ab09bf2bb"
}]

Exemplos de operações de entidade

Exemplo: listar todas as solicitações

Este exemplo lista todas as solicitações na entidade Requests.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Solicitações na lista Entity.
Selecione a operação LIST e clique em Concluído.

Exemplo: receber solicitações de um ID específico da central de atendimento

Este exemplo recebe a solicitação com a RequestKey como DP1-14 da entidade Requests.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Requests na lista Entity.
Selecione a operação LIST e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em filter realmente e e insira RequestKey='DP1-14' no campo Valor padrão.
Aqui, RequestKey é o valor da chave primária da entidade Requests.

Exemplo: criar uma solicitação

Este exemplo cria uma solicitação na entidade Requests.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Requests 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:
```
{, , ,) VALUES ('2', '1', '','test');
    "RequestTypeId": "2",
    "ServiceDeskId": "1",
    "Summary": "test",
    "Description": "test"
  }
  
```
Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
 {
    "RequestId": "10032"
  } 
  
```

Usar o Terraform para criar conexões

É possível usar o Terraform recurso para criar uma nova conexão.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Para conferir um exemplo de modelo do Terraform para criação de conexão, consulte Exemplo de modelo.

Ao criar essa conexão usando o Terraform, você precisa definir as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
proxy_enabled	BOOLEAN	Falso	Marque esta caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme	ENUM	Falso	O tipo de autenticação a ser usado para autenticar no proxy ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de usuário a ser usado para autenticar o proxy do ProxyServer.
proxy_password	SECRET	Falso	Uma senha a ser usada para autenticação no proxy ProxyServer.
proxy_ssltype	ENUM	Falso	O tipo de SSL a ser usado na conexão com o proxy ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, TUNNEL

Usar a conexão do Jira Service Management em uma integração

Depois de criar a conexão, ela fica disponível na integração da Apigee e na integração do aplicativo. É 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 a Tarefa Conectores.
Para entender como criar e usar a tarefa "Conectores" na integração de aplicativos, consulte Tarefa "Conectores".

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir

Entenda como suspender e retomar uma conexão.
Entenda como monitorar o uso do conector.
Saiba como acessar os registros do conector.