Ir para o conteúdo

Leitura do Conector Four51

A atividade de leitura Four51 disponível no Conector Four51 permite que você leia dados existentes no Four51 por meio da API OrderCloud usando Jitterbit.

Nota

Antes de configurar uma operação de leitura Four51, você precisará ter um endpoint Four51 definido. Para obter mais informações sobre como criar um endpoint, consulte Endpoint do conector Four51.

Esta página descreve como ler dados existentes no Four51 usando um exemplo de obtenção de um endereço de comprador existente usando Jitterbit. Este exemplo usa o mesmo endereço de comprador que foi criado como exemplo em Four51 Connector Create.

Importante

Este exemplo é usado apenas para fins de demonstração e não cobre todas as opções disponíveis no produto; consulte Design Studio para obter documentação mais abrangente.

As seções a seguir são divididas em iniciar a atividade de leitura, definir os componentes da operação e implantar e executar a operação.

Criando uma Operação de Leitura Four51

Nota

Se você ainda não estiver familiarizado com o Jitterbit, consulte Introdução ou Design Studio para obter informações detalhadas sobre como usar o produto.

  1. Dentro do seu projeto no Jitterbit Studio, existem várias maneiras de iniciar uma nova atividade de leitura do Four51. Cada uma das opções a seguir iniciará o Assistente de leitura Four51 para guiá-lo durante o processo.

    • Vá para Arquivo > Novo > Conectores > Nova leitura do Four51.
    • Na árvore à esquerda em Conectores, clique com o botão direito na categoria Four51 e selecione Nova leitura do Four51.
    • Na árvore à esquerda em Conectores, clique duas vezes na categoria Four51, clique com o botão direito em Atividades de leitura Four51 e selecione Nova leitura Four51.
    • Na barra de ferramentas superior, clique no ícone do conector (peça de quebra-cabeça laranja) anexo. No pop-up, selecione Four51 e, em seguida, selecione Four51 Read.
  2. A tela Endpoint do Four51 Read Wizard deverá abrir na visualização principal do Studio. Esta tela pede para selecionar o endpoint no qual você gostaria de obter os dados existentes. Você já deve ter configurado seu endpoint em Four51 Connector Endpoint. Use o menu suspenso para selecionar o endpoint apropriado. Clique em Avançar quando terminar.

    anexo

  3. As próximas telas do Assistente de leitura Four51 ajudam você a detalhar o objeto específico no qual deseja obter dados. A primeira dessas telas, Seção, solicita que você selecione um dos itens principais listados. categorias de nível dentro de Four51: "Autenticação", "Comprador", "Pedido", "Organização" ou "Perspectiva do usuário".

    Nota

    Você pode descobrir quais seleções fazer consultando a API OrderCloud. Por exemplo, essas cinco categorias de nível superior correspondem diretamente àquelas listadas no lado esquerdo do Console da API OrderCloud. As demais telas de seleção de objetos também seguem a organização da API OrderCloud.

    No exemplo, queremos obter um endereço de comprador existente, então selecionamos a seção "Comprador" e clicamos em Avançar para continuar.

    anexo

  4. A próxima tela do Four51 Read Wizard, chamada Resource, exibe os recursos disponíveis na seção selecionada. No exemplo, como queremos obter um endereço existente, selecionamos "Endereços" e clicamos em Avançar para continuar.

    anexo

  5. A tela de seleção final no Four51 Read Wizard, chamada Resource Endpoint, exibe os objetos finais disponíveis para o recurso selecionado. No exemplo, para ler um endereço existente, selecionamos a opção “Obter um único endereço”. Clique em Concluir para continuar.

    Nota

    Os endpoints de recursos disponíveis para cada recurso de seção dependem do tipo de atividade Four51 selecionada para a operação (ou seja, criação, leitura, atualização, atualização de patch ou atividade de exclusão).

    anexo

  6. A Jitterbit prosseguirá com a criação de uma estrutura de solicitação e resposta de API que permitirá a leitura dos dados por meio da API OrderCloud. Uma nova aba deve aparecer no Studio chamada Four51 Read Activities. Você pode renomear sua atividade de leitura aqui, se desejar; no exemplo, o nosso é chamado de "Four51 Read - Buyer > Addresses > Get a Single Address." Você também pode usar os botões + - ou setas para expandir todos os elementos dentro de cada estrutura.

    anexo

    Nota

    O "xp" na estrutura acima significa "Propriedades estendidas" e faz parte da API OrderCloud. Esta propriedade permite adicionar campos personalizados à maioria dos objetos. Para saber mais sobre como usar a propriedade XP, consulte Four51 Connector Advanced.

  7. Em seguida, na mesma tela, clique no botão Criar Operação localizado em Usar em uma Integração no canto superior direito. Isto criará a operação Jitterbit que obterá o endereço do comprador existente de Four51.

  8. Uma nova aba deverá abrir no Studio chamada Operations, contendo uma representação gráfica da atividade de leitura.

    anexo

    Nota

    Os ícones de Origem, Solicitação, Resposta e Destino na imagem acima são espaços reservados para os componentes da operação, que definiremos na próxima seção.

    Salve sua operação clicando no ícone de disco único para salvar apenas esta operação ou no ícone de vários discos para salvar todas as alterações em seu projeto de integração. Você deverá ver o asterisco na aba Operações e o título da operação desaparecer à medida que sua nova atividade de leitura for criada e salva em seu projeto.

Definindo os Componentes da Operação

Em seguida, precisamos definir os outros componentes da operação que aparecem na representação gráfica, incluindo Origem, Solicitação, Resposta e Destino.

Você pode retornar à representação gráfica da operação que criou e clicar duas vezes em cada ícone para configurar cada componente ou pode criar Origem, Solicitação, Resposta e Almeje separadamente e depois arraste e solte-os da árvore à esquerda diretamente nos ícones na representação visual de sua operação.

Muitos tipos diferentes de dados podem ser usados para cada componente da operação. Para saber mais sobre opções adicionais de personalização, consulte o Design Studio seção de nossa documentação.

  • Fonte: Para simplificar este exemplo, a fonte será codificada. Portanto, removeremos a fonte clicando com o botão direito no ícone da fonte no gráfico de operação e selecionando Remover do gráfico.

    Nota

    Uma variedade de tipos de fontes estão disponíveis no Jitterbit. Veja Fontes para mais.

  • Alvo: clique duas vezes no ícone Alvo. No exemplo, registraremos a resposta da API OrderCloud em um arquivo de texto temporário para fornecer informações sobre sucesso/falha. Clique no botão Criar novo alvo e dê um Nome ao seu alvo (por exemplo, 'Ler alvo único'). A seguir, para este exemplo, queremos gravar no local de armazenamento temporário padrão em nosso Agente Privado, então selecionamos um Type de "Temporary Storage" e inserimos um Filename de 'Read_Single.txt' para o exemplo.

    Nota

    Você também pode enviar para uma variedade de tipos de destino diferentes. O tipo não precisa ser igual ao tipo de origem. Consulte Fontes e alvos para opções.

  • Solicitação: Clique duas vezes no ícone Solicitação e selecione Criar Nova Transformação. Isso abrirá o Assistente de Transformação que orientará você na criação da solicitação.

    Nota

    Informações adicionais sobre estruturas de solicitação são fornecidas em Transformações.

    1. Na primeira tela, Nome, forneça um Nome para sua transformação ou deixe como padrão. Em seguida, use o menu suspenso Fonte para selecionar a origem da transformação. No exemplo, nossa fonte está codificada, então selecionaremos "Nenhum". Clique em Concluir para continuar.

    2. A aba Transformações deve abrir onde você pode completar seu mapeamento. Use o + para expandir os itens na árvore de destino à direita. Em uma transformação padrão, você arrastaria e soltaria cada campo que gostaria de mapear de uma árvore para outra. Para este exemplo, para codificar a origem, clique duas vezes em cada campo no lado do destino e digite os seguintes valores usados no exemplo no script:

      ALVO: INPUT > GetaSingleAddress > Parâmetros Script
      ID do comprador <trans>
      "TestBuyerID0001"
      </trans>
      endereçoID <trans>
      "TestAddressID0000"
      </trans>

      Nota

      O buyerID acima é o ID existente da organização compradora na qual o endereço está, e o addressID acima é o ID existente do novo endereço que foi criado durante a criação do conector Four51 exemplo.

      Depois de codificar a fonte, seu mapeamento de transformação deve ser semelhante ao mostrado abaixo.attachment

  • Resposta: Clique duas vezes no ícone Resposta e selecione Criar nova Transformação. Isso abrirá o Assistente de Transformação que orientará você na criação da resposta.

    Nota

    Informações adicionais sobre estruturas de resposta são fornecidas em Transformações.

    1. Na primeira tela, Nome, forneça um Nome para sua transformação ou deixe como padrão. Em seguida, use o menu suspenso Target para selecionar o destino da transformação. No exemplo, queremos usar a resposta da API OrderCloud, então selecionamos "Four51 Function Response". Clique em próximo para continuar.

    2. Na próxima tela, Target, selecione o botão de opção para o tipo de atividade da qual você deseja usar a resposta. Neste caso, queremos usar a resposta da atividade de leitura que acabamos de configurar, então escolha “Ler”. Clique em próximo para continuar.

    3. A tela Target agora exibirá um menu suspenso para selecionar a atividade. Escolha a atividade de leitura que você acabou de configurar. As estruturas de solicitação e resposta associadas à atividade de leitura selecionada deverão aparecer agora. Clique em Concluir para continuar.

    4. A aba Transformações deve abrir onde você pode completar seu mapeamento. Use o + para expandir os lados de origem e de destino. Clique e arraste a pasta "OUTPUT" do lado esquerdo (lado de origem) para a pasta "OUTPUT" do lado direito (lado de destino). Sua tela de mapeamento agora deve ser semelhante à mostrada abaixo.

      anexo

      Nota

      Se você estiver lidando com grandes quantidades de dados, também poderá usar as opções de paginação, pesquisa, filtragem ou classificação descritas em Four51 Connector Advanced.

Sua operação configurada deve ser semelhante ao exemplo mostrado abaixo.

anexo

Implantando e Executando a Operação

Com a atividade de leitura do Four51 totalmente configurada, estamos prontos para implantar e executar a operação.

  1. Na aba Operações, clique em implantar anexo ícone.

  2. Em seguida, clique em executaranexo ícone para colocar a operação na fila para execução.

  3. Na parte inferior da tela, o Monitor de operação deverá indicar que sua operação foi executada com sucesso. Caso contrário, você pode clicar duas vezes no ícone Status para visualizar quaisquer mensagens de registro.

    anexo

  4. Agora você também deve ver a resposta de saída que foi mapeada para seu arquivo de destino 'Read_Single.txt'. No exemplo, o arquivo agora é criado no armazenamento temporário no Agente Privado (ou seja, padrão '/tmp/jitterbit/TemporaryStorage' para Linux ou 'C:\ Windows\Temp\Jitterbit\' para Windows). O status '1' indica que a operação foi bem-sucedida.

    <?xml version="1.0" encoding="UTF-8"?>
    <ns:OUTPUT xmlns:ns="urn:F51oln-res:document:F51oln:oln:entities">
        <GetaSingleAddress>
            <Status>1</Status>
            <Meta>
                <ItemRange/></Meta>
            <Items>
                <Item>
                    <ID>TestAddressID0000</ID>
                    <CompanyName>Test Company</CompanyName>
                    <FirstName>First</FirstName>
                    <LastName>Last</LastName>
                    <Street1>Main Street</Street1>
                    <City>San Francisco</City>
                    <State>CA</State>
                    <Zip>123456</Zip>
                    <Country>US</Country>
                    <Phone>123456789</Phone>
                    <AddressName>Test_Address</AddressName>
                </Item>
            </Items>
        </GetaSingleAddress>
    </ns:OUTPUT>
    
  5. Como esta foi uma operação de leitura, não há alterações na API OrderCloud. No entanto, você ainda pode ler as mesmas informações no Console da API OrderCloud em Comprador > Endereços.

    anexo