Usando o Toggl Track com o IBM App Connect Enterprise

O Toggl Track é um software de controle de tempo para empresas e freelancers. Ele pode rastrear o tempo gasto em projetos e analisar a produtividade.

As etapas a seguir mostram como se conectar a uma conta do Toggl Track e configurar um nó do Toggl Track Request usando a descoberta de conector. Você pode seguir um procedimento semelhante para configurar um nó de entrada do Toggl Track para monitorar a entrada do Toggl Track, criando um fluxo que contenha um nó de entrada do Toggl Track e configurando-o por meio da descoberta do conector.

1. No Kit de Ferramentas do IBM App Connect Enterprise, crie um fluxo que contenha um nó “Toggl Track Request ”.
2. Selecione o nó Toggl Track Request no fluxo para mostrar as propriedades do nó no editor.
3. Na guia Básico, clique em Launch Connector Discovery.
   É exibido um painel no qual você especifica o nome do projeto de política e os detalhes do cofre a serem usados durante a descoberta do conector.
4. Especifique os detalhes do projeto de política e do cofre a serem usados durante a descoberta do conector:
   1. No campo Projeto de política, especifique o projeto de política que é usado para armazenar as políticas criadas durante a descoberta do conector.
      Como alternativa, você pode criar um novo projeto de política clicando em Novo e, em seguida, especificando o nome do novo projeto de política. Em seguida clique em Concluir.
   2. Especifique o cofre a ser usado durante a descoberta do conector. Por padrão, as credenciais que são usadas durante a descoberta do conector são armazenadas em um cofre de diretório externo, que é um cofre App Connect Enterprise que pode ser usado por qualquer servidor de integração. Como alternativa, você pode armazenar as credenciais em um cofre do servidor de integração, que é criado no diretório de trabalho do servidor de integração e pode ser usado somente por esse servidor de integração específico.
      Para especificar o cofre a ser usado para armazenar as credenciais, conclua as etapas na seção Usando o assistente Connector Discovery de um dos tópicos a seguir:

      • Configuração de um cofre de diretório externo
      • Configuração de um vault do servidor de integração
   3. No campo Chave do cofre, digite a chave do cofre usada para acessar as credenciais armazenadas no cofre. A chave do cofre deve ter pelo menos 8 caracteres.
   4. Opcional: ' Por padrão, o local do vault e a chave do vault especificados são salvos como preferências no Toolkit para que os valores sejam predefinidos quando você iniciar o Connector Discovery. Se você não quiser que as preferências sejam salvas, desmarque Salvar nas preferências do vault.
5. Clique em Launch Discovery para iniciar o assistente de Connector Discovery para o conector do Toggl Track.
   A janela Connector Discovery é exibida. Se as conexões (contas) existentes do Toggl Track estiverem disponíveis, será exibida uma lista dessas conexões. Se não houver conexões existentes, o status do conector do Toggl Track será mostrado como ' Not connected.
   • Se uma ou mais conexões (contas) do Toggl Track estiverem disponíveis, conclua as etapas a seguir:
     1. Selecione a conexão (conta) que você deseja usar clicando nela.
     2. Clique no tipo de objeto desejado e, em seguida, selecione a ação que deseja executar no objeto. Por exemplo, para recuperar bugs do Toggl Track, clique em Registros de tempo e, em seguida, em Recuperar registros de tempo.
   • Se não houver conexões (contas) existentes, conclua as etapas a seguir:
     1. Clique no tipo de objeto necessário e, em seguida, selecione a ação que deseja executar nesse objeto. Por exemplo, para recuperar bugs do Toggl Track, clique em Registros de tempo e, em seguida, em Recuperar registros de tempo.
     2. Clique em Connect (Conectar ) para exibir um menu no qual você deve selecionar um dos seguintes tipos de autorização:
        • Fornecer credenciais para uso do App Connect (BASIC)
        • Forneça credenciais para uso do App Connect (API KEY)
     3. Selecione um tipo de autorização e clique em Continue (Continuar). É exibida uma janela na qual você insere os detalhes da sua conta.
     4. Se você selecionou Fornecer credenciais para o App Connect usar (BASIC) como o tipo de autorização, insira os seguintes detalhes:
        • Servidor URL : Especifique o endereço URL para o servidor de API que faz chamadas em tempo de execução.
        • Nome de usuário: especifique um nome de usuário autorizado a acessar o Toggl Track.
        • Senha: Especifique uma senha para o nome de usuário.
        • Permitir certificados autoassinados: Selecione True (Verdadeiro ) ou False (Falso ) no menu suspenso.
        • Substituir o servidor URL : Necessário se você quiser se conectar a um ponto de extremidade em uma rede privada usando o cliente de rede privada ou se quiser substituir o servidor URL. Especifique um valor de substituição para o host e a porta do conector no formato ' <http or https>://<host_name>:<port>. Se você não estiver usando o cliente de rede privada ou não precisar de uma substituição, deixe esse campo em branco.
        • Nome do proxy : Selecione ou especifique o nome do proxy que você deseja que o ` App Connect ` utilize para encaminhar as chamadas do conector. Este campo só é obrigatório se as chamadas precisarem passar por um proxy. Ao utilizar o Kit de Ferramentas do IBM App Connect Enterprise, o nome do proxy deve ser especificado no seguinte formato: {PolicyProjectName}:HTTPProxyPolicyName
     5. Se você selecionou Fornecer credenciais para o App Connect usar (API KEY) como o tipo de autorização, insira os seguintes detalhes:
        • Servidor URL : Especifique o endereço URL para o servidor de API que faz chamadas em tempo de execução.
        • Token da API: Especifique o token de acesso que você usa para acessar o Toggl Track.
        • Permitir certificados autoassinados: Selecione True (Verdadeiro ) ou False (Falso ) no menu suspenso.
        • Substituir o servidor URL : Necessário se você quiser se conectar a um ponto de extremidade em uma rede privada usando o cliente de rede privada ou se quiser substituir o servidor URL. Especifique um valor de substituição para o host e a porta do conector no formato ' <http or https>://<host_name>:<port>. Se você não estiver usando o cliente de rede privada ou não precisar de uma substituição, deixe esse campo em branco.
        • Nome do proxy : Selecione ou especifique o nome do proxy que você deseja que o ` App Connect ` utilize para encaminhar as chamadas do conector. Este campo só é obrigatório se as chamadas precisarem passar por um proxy. Ao utilizar o Kit de Ferramentas do IBM App Connect Enterprise, o nome do proxy deve ser especificado no seguinte formato: {PolicyProjectName}:HTTPProxyPolicyName
     6. Clique em Conectar.

     Para obter mais informações sobre como conectar-se ao Toggl Track, consulte “Como usar o IBM App Connect com o Toggl Track” na documentação sobre Entrega Contínua (CD) do IBM App Connect in containers.

6. Defina as propriedades necessárias do conector no assistente.

   Se você adicionar condições para ações de recuperação ou atualização, poderá, opcionalmente, usar a filtragem de condições para refinar as condições que são aplicadas. Para usar a filtragem por condições, saia do assistente de descoberta de conectores clicando no botão Fechar (X) e, em seguida, siga as instruções na seção “Usando a filtragem por condições ”.

   Também é possível definir propriedades que especificam o número máximo de registros a serem recuperados e a ação a ser tomada se esse limite for excedido.
7. Quando você terminar de especificar as propriedades no assistente Connector Discovery, clique em Salvar.
   As credenciais utilizadas para se conectar ao Toggl Track são armazenadas no cofre, e os demais detalhes de conexão são salvos na política do Toggl Track. Os valores das propriedades definidas no assistente são retornados ao nó “Toggl Track Request” no Toolkit do IBM App Connect Enterprise.
8. Quando terminar a descoberta e salvar os valores de propriedade, saia do assistente Connector Discovery clicando no X no canto superior direito da janela ou pressionando Alt+F4.
9. Voltar à edição do nó “Solicitação de Rastreamento do Toggl” no Kit de Ferramentas do IBM App Connect Enterprise.
   As propriedades do conector que foram definidas no assistente Connector Discovery (na etapa 6) agora estão visíveis no nó Toggl Track Request no editor de propriedades. A guia Basic (Básico ) mostra os valores das propriedades Action (Ação ) e Object (Objeto ) que você definiu no assistente. Por exemplo, se você selecionou Registros de horas > Recuperar registros de horas no assistente, as seguintes propriedades ficam visíveis na guia Básico do nó:

   • Ação - ' RETRIEVEALL
   • Objeto - ' getMeTimeEntries_model

   Os valores das propriedades Action e Object são exibidos em formato somente leitura. Se quiser alterar esses valores, você pode fazê-lo clicando novamente em Launch Connector Discovery e definindo novos valores no assistente do Connector Discovery.

   A propriedade Schema base name especifica o nome base dos arquivos de esquema que descrevem o formato das mensagens de solicitação e resposta que são enviadas e recebidas do conector do Toggl Track. O nome da base do esquema é definido automaticamente na primeira vez em que você executa a descoberta do nó e se baseia no nome do fluxo atual e no nome do nó. Se você definir essa propriedade manualmente antes de executar a descoberta pela primeira vez, o valor que você definiu será usado. Se você renomear os esquemas após a descoberta, deverá editar essa propriedade para que corresponda ao nome base do esquema usado pelos esquemas renomeados no projeto. Se você alterar essa propriedade após a descoberta, deverá renomear os nomes dos esquemas para que correspondam ou executar a descoberta novamente.

   Dependendo da ação que foi selecionada durante a descoberta, o assistente do Connector Discovery gera um esquema de solicitação e um esquema de resposta ou apenas um esquema de resposta. Um esquema de solicitação é gerado somente se a ação e o objeto selecionados exigirem uma mensagem de solicitação. O esquema de solicitação gerado é usado para validação da mensagem de solicitação. Se a ação foi " RETRIEVE ou " DELETE, somente o esquema de resposta é retornado pelo conector.

   Os arquivos de esquema gerados são adicionados ao projeto e podem ser usados por um nó de mapeamento para transformar dados de entrada ou saída. O nome de arquivo completo do esquema é derivado do nome de base do esquema (como " gen/MyMessageFlow.Toggl_Track_Request), com o sufixo " response.schema.json ou " request.schema.json. Você pode abrir o esquema clicando em Open request schema (Abrir esquema de solicitação ) ou Open response schema (Abrir esquema de resposta).

10. Verifique se as configurações de propriedade no nó Toggl Track Request estão corretas e, em seguida, salve o fluxo de mensagens.
11. Na guia Connection (Conexão ) do nó Toggl Track Request (Solicitação de rastreamento do Toggl ), a propriedade Policy (Política) mostra o nome da política que contém os detalhes da identidade de segurança a ser usada para a conexão. A política tem um tipo de " Toggl Track.
    Para obter mais informações, consulte a política do Toggl Track.
12. Opcional: Defina a propriedade Timeout na guia Connection (Conexão ) para especificar o tempo (em segundos) que o nó aguarda para que o Toggl Track processe a operação.
13. A guia Filter do nó Toggl Track Request contém propriedades que controlam como o fluxo de mensagens seleciona os dados. Os valores iniciais dessas propriedades são extraídos dos valores de propriedade que foram definidos para o conector Toggl Track no assistente Connector Discovery, incluindo as propriedades de opções de filtro e quaisquer condições que tenham sido especificadas (conforme descrito na etapa 6). Em seguida, se você retornar ao assistente Connector Discovery e alterar os valores de quaisquer propriedades (adicionando novas condições, por exemplo), essas atualizações serão refletidas nas propriedades definidas no nó.

    As propriedades Filter Options controlam quais objetos devem ser operados quando o nó Toggl Track Request for executado. As propriedades Filter Limit controlam o número máximo de itens a serem recuperados e a ação a ser tomada se o limite for excedido.

    Você pode modificar os valores clicando em Edit (Editar ) ao lado do valor que deseja modificar na seção Filter Options (Opções de filtro ) e alterando os valores de propriedade que foram definidos na seção Filter Limit (Limite de filtro ).

    Os valores de propriedade podem ser valores de texto ou expressões ESQL ou XPATH que são resolvidos a partir do conteúdo da mensagem que é passada para o nó Toggl Track Request à medida que ele é executado.

14. Na guia Request (Solicitação ), defina a propriedade Data location (Localização dos dados) para especificar a localização na árvore de mensagens de entrada que contém os dados do objeto a serem criados no Toggl Track. Esses dados formam a solicitação que é enviada do nó Toggl Track Request para o sistema Toggl Track.
15. Na guia Result (Resultado ), defina a propriedade Output data location (Localização dos dados de saída) para especificar a localização na árvore de mensagens de saída para conter os dados do registro que é criado no Toggl Track.
16. Por padrão, as mensagens de solicitação são validadas em relação ao esquema de solicitação que foi gerado durante a descoberta do conector. Você pode desativar a validação da solicitação ou alterar as configurações de validação usando as propriedades de Validação do nó Toggl Track Request.
17. Salve o fluxo de mensagens.