Conector Four51 Criar no Jitterbit Design Studio
A atividade de criação do Four51 disponível dentro do conector Four51 permite que você crie novos dados no Four51 via a API OrderCloud usando o Jitterbit.
Nota
Antes de configurar uma operação de criação do Four51, você precisará ter um endpoint do Four51 definido. Para mais informações sobre como criar um endpoint, consulte endpoint do conector Four51.
Esta página descreve como criar novos dados no Four51 usando um exemplo de criação de um novo endereço de comprador usando o Jitterbit.
Importante
Este exemplo é utilizado apenas para fins de demonstração e não cobre todas as opções disponíveis no produto; consulte Design Studio para uma documentação mais abrangente.
As seções a seguir estão divididas em iniciar a atividade de criação, definir os componentes da operação e implantar e executar a operação.
Criando uma operação de criação do Four51
Nota
Se você ainda não está familiarizado com o Jitterbit, consulte Introdução ou Design Studio para informações detalhadas sobre como usar o produto.
-
Dentro do seu projeto no Jitterbit Studio, existem várias maneiras de iniciar uma nova atividade de criação do Four51. Cada uma das opções a seguir iniciará o Assistente de Criação do Four51 para guiá-lo pelo processo.
- Vá para Arquivo > Novo > Conectores > Nova Criação do Four51.
- Na árvore à esquerda sob Conectores, clique com o botão direito na categoria Four51, e selecione Nova Criação do Four51.
- Na árvore à esquerda sob Conectores, clique duas vezes na categoria Four51, depois clique com o botão direito em Atividades de Criação do Four51 e selecione Nova Criação do Four51.
- Na barra de ferramentas superior, clique no ícone do conector (peça de quebra-cabeça laranja)
. No popup, selecione Four51, depois selecione Criação do Four51.
-
A tela de Endpoint do Assistente de Criação Four51 deve abrir na visualização principal do Studio. Esta tela solicita que você selecione o endpoint no qual gostaria de criar novos dados. Você já deve ter configurado seu endpoint em endpoint do conector Four51. Use o menu suspenso para selecionar o endpoint apropriado. Clique em Próximo quando terminar.
-
As próximas telas do Assistente de Criação Four51 ajudam você a detalhar o objeto específico no qual deseja criar dados. A primeira dessas telas, Seção, pede que você selecione uma das categorias de nível superior listadas dentro do Four51: "Autenticação", "Comprador", "Pedido", "Organização" ou "Perspectiva do Usuário".
Nota
Você pode descobrir quais seleções fazer consultando a API do OrderCloud. Por exemplo, essas cinco categorias de nível superior correspondem diretamente às listadas no lado esquerdo do Console da API do OrderCloud. As telas de seleção de objetos restantes também seguem a organização da API do OrderCloud.
No exemplo, queremos criar um novo endereço de comprador, então selecionamos a seção "Comprador" e clicamos em Próximo para continuar.
-
A próxima tela do Assistente de Criação Four51, chamada Recurso, exibe os recursos disponíveis dentro da seção selecionada. No exemplo, como queremos criar um novo endereço, selecionamos "Endereços" e clicamos em Próximo para continuar.
-
A tela de seleção final no Assistente de Criação Four51, chamada Endpoint de Recurso, exibe os objetos finais disponíveis para o recurso selecionado. No exemplo, para criar um novo endereço, selecionamos a opção "Criar Novo Endereço". Clique em Concluir para continuar.
Nota
Os endpoints de recurso disponíveis para cada recurso de seção dependem do tipo de atividade Four51 selecionada para a operação (ou seja, criar, ler, atualizar, atualização parcial ou excluir).
-
O Jitterbit irá prosseguir com a criação de uma estrutura de solicitação e resposta da API que permitirá que os dados sejam criados via API do OrderCloud. Uma nova aba deve aparecer no Studio chamada Four51 Create Activities. Você pode renomear sua atividade de criação aqui, se desejar; no exemplo, a nossa é chamada "Four51 Create - Buyer > Addresses > Create New Address." Você também pode usar os botões + - ou setas para expandir todos os elementos dentro de cada estrutura.
Nota
O "xp" na estrutura acima significa "Extended Properties" e é parte da API do OrderCloud. Esta propriedade permite que você adicione campos personalizados à maioria dos objetos. Para saber mais sobre como usar a propriedade XP, veja Four51 connector advanced.
-
Em seguida, na mesma tela, clique no botão Create Operation localizado em Use in an Integration no canto superior direito. Isso criará a operação do Jitterbit que criará um novo endereço de comprador no Four51.
-
Uma nova aba deve abrir no Studio chamada Operations, contendo uma representação gráfica da atividade de criação.
Nota
Os ícones para Source, Request, Response e Target na imagem acima são marcadores 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 disco múltiplo para salvar todas as alterações em seu projeto de integração. Você deve ver o asterisco na aba Operations e o título da operação desaparecerem à medida que sua nova atividade de criação é agora 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 Source, Request, Response e Target.
Você pode retornar à representação gráfica da operação que você criou e clicar duas vezes em cada ícone para configurar cada componente, ou pode criar o Source, Request, Response e Target separadamente e, em seguida, arrastá-los da árvore à esquerda diretamente para os ícones na representação visual da 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 a seção Design Studio da nossa documentação.
-
Source: 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 da operação e selecionando Remove From Graph.
Nota
Uma variedade de tipos de fonte está disponível no Jitterbit. Veja Sources para mais informações.
-
Target: Clique duas vezes no ícone Target. 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 Create New Target, dê um Name ao seu alvo (por exemplo, 'Create Target'). Em seguida, 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 'Create_File.txt' para o exemplo.
Nota
Você também pode enviar para uma variedade de tipos de alvo diferentes. O tipo não precisa ser o mesmo que o tipo de fonte. Veja Targets para opções.
-
Request: Clique duas vezes no ícone Request e selecione Create New Transformation. Isso abrirá o Transformation Wizard, que o guiará na criação da solicitação.
Nota
Informações adicionais sobre estruturas de solicitação estão disponíveis em Transformations.
-
Na primeira tela, Nome, forneça um Nome para sua transformação ou deixe como o padrão. Em seguida, use o dropdown Fonte para selecionar a fonte para a transformação. No exemplo, nossa fonte é codificada, então selecionaremos "Nenhum." Clique em Concluir para continuar.
-
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 a outra. Para este exemplo, para codificar a fonte, clique duas vezes em cada campo no lado do destino e digite os seguintes valores usados no exemplo no script:
DESTINO: ENTRADA > CreateNewAddress > Parâmetros Script buyerID <trans>
"TestBuyerID0001"
</trans>
Nota
O buyerID acima vem do ID da Organização Compradora existente na qual queremos criar o novo endereço. O buyerID de exemplo
TestBuyerID0001
já foi criado na instância do OrderCloud para este exemplo. Consulte Organização Compradora em pré-requisitos do conector Four51 para mais informações.DESTINO: ENTRADA > CreateNewAddress > RequestParameters Script ID <trans>
"TestAddressID0000"
</trans>
CompanyName <trans>
"Test Company"
</trans>
FirstName <trans>
"First"
</trans>
LastName <trans>
"Last"
</trans>
Street1 <trans>
"Main Street"
</trans>
City <trans>
"San Francisco"
</trans>
State <trans>
"CA"
</trans>
Zip <trans>
"123456"
</trans>
Country <trans>
"US"
</trans>
Phone <trans>
"123456789"
</trans>
AddressName <trans>
"Test_Address"
</trans>
Nota
Todas as informações fornecidas acima são novos dados que não existem na instância de exemplo do OrderCloud.
Após codificar a origem, seu mapeamento de transformação deve se parecer com o mostrado abaixo.
-
-
Resposta: Clique duas vezes no ícone Resposta e selecione Criar Nova Transformação. Isso abrirá o Assistente de Transformação, que o guiará na criação da resposta.
Nota
Informações adicionais sobre estruturas de resposta estão disponíveis em Transformações.
-
Na primeira tela, Nome, forneça um Nome para sua transformação ou deixe como padrão. Em seguida, use o dropdown Alvo para selecionar o alvo da transformação. No exemplo, queremos usar a resposta da API do OrderCloud, então selecionamos "Resposta da Função Four51." Clique em Próximo para continuar.
-
Na próxima tela, Alvo, 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 criação que acabamos de configurar, então escolha "Criar." Clique em Próximo para continuar.
-
A tela Alvo agora exibirá um menu suspenso para selecionar a atividade. Escolha a atividade de criação que você acabou de configurar. As estruturas de solicitação e resposta associadas à atividade de criação selecionada devem agora aparecer. Clique em Concluir para continuar.
-
A aba Transformações deve abrir onde você pode completar seu mapeamento. Use o + para expandir os lados de origem e alvo. Clique e arraste a pasta "SAÍDA" do lado esquerdo (lado da origem) para a pasta "SAÍDA" do lado direito (lado do alvo). Sua tela de mapeamento deve agora se parecer com a mostrada abaixo.
-
Sua operação configurada deve se parecer com o exemplo mostrado abaixo.
Implantando e executando a operação
Com a atividade de criação do Four51 totalmente configurada, estamos prontos para implantar e executar a operação.
-
Na aba Operações, clique no ícone de implantar
.
-
Em seguida, clique no ícone de executar
para colocar a operação na fila para execução.
-
Na parte inferior da tela, o Monitor de Operações deve indicar que sua operação foi executada com sucesso. Se não, você pode clicar duas vezes no ícone de Status para visualizar quaisquer mensagens de log.
-
Você também deve ver agora a resposta de saída que foi mapeada para seu arquivo de destino 'Create_File.txt'. No exemplo, o arquivo agora é criado no armazenamento temporário no agente privado (ou seja, o padrão '/tmp/jitterbit/TemporaryStorage' para Linux ou 'C:\Windows\Temp\Jitterbit\' para Windows). O status de '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"> <CreateNewAddress> <Status>1</Status> <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> </CreateNewAddress> </ns:OUTPUT>
-
Além disso, ao verificar o Console da API do OrderCloud em Comprador > Endereços, você deve encontrar o novo endereço do comprador criado.