OmniStudio Documentation Traduzido

OmniStudio Foundation
Copyright 2021 Vlocity LLC, uma empresa Salesforce. Todos os direitos reservados. As informações neste documento estão sujeitas a
alterações sem aviso prévio. Esta documentação e o software, ferramentas, modelos e outros materiais descritos neste documento (“
Materiais Vlocity ”) são fornecidos exclusivamente sob um contrato de serviços de assinatura ou contrato de confidencialidade . Os
Materiais Vlocity podem ser usados ou copiados somente de acordo com os termos desses contratos. Nenhuma parte dos Materiais
Vlocity pode ser reproduzida, armazenada em um sistema de recuperação ou transmitida de qualquer forma ou meio eletrônico ou
mecânico, incluindo fotocópia ou gravação para qualquer finalidade que não seja o uso pessoal do licenciado, conforme estabelecido no
contrato aplicável, sem a permissão prévia por escrito da Vlocity LLC. Vlocity é uma marca registrada da Vlocity LLC, uma empresa da
Salesforce, assim como outros nomes e marcas. Outras marcas que aparecem aqui podem ser marcas registradas de seus respectivos
proprietários.
© 2021 Vlocity LLC, a Salesforce

company
Índice
Sumário
OmniStudio .........................................................................................................................1
Noções Básicas do OmniScript.............................................................................................2
Noções básicas de FlexCards ...............................................................................................4
Use o Formulários Juntos.....................................................................................................6
Guia de estilo personalizável para o Newport Design System .................................................7
Implementações que podem ser chamadas ...........................................................................8
Visualizando o namespace e a versão do OmniStudio Pacote Vlocity......................................9
Práticas recomendadas do OmniScript................................................................................ 10
OmniScript Designer Overview ........................................................................................... 11
Figura 1. Estrutura do Script ............................................................................................... 18
Referência de configuração do OmniScript.......................................................................... 29
Exibir instâncias de OmniScript salvas para contas e contatos ................................................ 37
Exibir instâncias de OmniScript salvas em páginas ObjectRecord ............................................ 37
Exibir todas as instâncias de OmniScript salvas .................................................................... 37
Figura 2. Barra de pesquisa simples .................................................................................... 39
Figura 3. Artigo aberto no OmniScript como um bloco recolhível .............................................. 39
Figura 4. Artigo aberto em uma janela modal ........................................................................ 40
Painel de configuração ................................................................................................... 44
Painel de propriedades................................................................................................... 44
elemento OmniScript.......................................................................................................... 52
Propriedades da mensagem do usuário ............................................................................... 57
Redirecionar Propriedades................................................................................................. 58
Transformações de envio e resposta ................................................................................... 58
Selecionando um modo de invocação.................................................................................. 59
Adicionar uma mensagem de ação...................................................................................... 60
Estrutura de mensagens .................................................................................................... 60
Comunicar-se com OmniScript a partir de um componente Web do Lightning ............................ 60

company
Mensagem com mensagens de postagem de janela e mensagens de armazenamento de sessão 63
DataRaptor Extrair Ação Propriedades................................................................................. 64
Relacionado Tópicos......................................................................................................... 65
Ação de postagem do DataRaptor Propriedades ................................................................... 65
Tópicos relacionados ........................................................................................................ 65
Propriedades da ação de transformação do DataRaptor......................................................... 66
DataRaptor Turbo Action Propriedades ................................................................................ 69
Confirmando a exclusão do registro..................................................................................... 69
Exibindo mensagens de uma ação de exclusão .................................................................... 70
Excluir propriedades da ação ............................................................................................. 70
Propriedades da ação de e-mail.......................................................................................... 72
Propriedades da ação HTTP .............................................................................................. 74
Ação do Procedimento de Integração Propriedades ............................................................... 76
Veja Também .................................................................................................................. 78
Navegar para um aplicativo ................................................................................................ 78
Veja Também .................................................................................................................. 79
Navegue até um login ou logout da comunidade.................................................................... 79
Veja Também .................................................................................................................. 79
Navegar para um componente............................................................................................ 80
Veja Também .................................................................................................................. 81
Navegar para a Página atual .............................................................................................. 81
Veja Também .................................................................................................................. 81
Navegar a um Conhecimento Artigo .................................................................................... 82
Veja Também .................................................................................................................. 82
Navegar para um OmniScript ............................................................................................. 82

company
Veja Também .................................................................................................................. 83
Navegue até uma página nomeada ou página nomeada da comunidade .................................. 83
Veja Também .................................................................................................................. 84
Navegar para um item de navegação .................................................................................. 84
Veja Também .................................................................................................................. 84
Navegar para um Página do objeto ..................................................................................... 84
Veja Também .................................................................................................................. 85
Navegar para uma página de registro .................................................................................. 85
Veja Também .................................................................................................................. 85
Navegue até uma página de relacionamento de registro......................................................... 85
Veja Também .................................................................................................................. 86
Navegar para uma página da Web ...................................................................................... 86
Veja Também .................................................................................................................. 86
Reiniciar um OmniScript .................................................................................................... 86
Veja Também .................................................................................................................. 86
Navegar Ação Propriedades............................................................................................... 87
Exemplo.......................................................................................................................... 89
Estrutura de classe de amostra........................................................................................... 92
Veja Também .................................................................................................................. 92
Ação Remota Propriedades ............................................................................................... 93
Antes de você começar ..................................................................................................... 98
Veja Também ................................................................................................................ 100
Ação Quadra Propriedades .............................................................................................. 100
Veja Também ................................................................................................................ 100
Veja Também ................................................................................................................ 102
Veja Também ................................................................................................................ 103
Configurando um Editar Quadra........................................................................................ 103
Exibindo elementos em um bloco de edição ....................................................................... 103
Configurando Modos de Exibição e Modelos....................................................................... 105

company
Modos LWC................................................................................................................... 105
Modelos angulares ......................................................................................................... 105
Compatível Elementos .................................................................................................... 106
O que vem a seguir......................................................................................................... 107
Veja Também ................................................................................................................ 107
Adicionando, editando e excluindo registros com ações de edição de bloco ............................ 108
Criando, editando e excluindo registros com ações padrão e mapeamento sObject .................. 108
Adicionando ações personalizadas.................................................................................... 109
Adicionando ações globais............................................................................................... 109
Veja Também ................................................................................................................ 110
Exibindo Sprites em Edição Quadra .................................................................................. 110
Exibindo ícones SVG dinamicamente ................................................................................ 110
Veja Também ................................................................................................................ 111
Configurando um modo de seleção no bloco de edição ........................................................ 111
Veja Também ................................................................................................................ 112
Trabalhando com Fórmulas no Bloco de Edição .................................................................. 112
Veja Também ................................................................................................................ 113
Substituindo uma edição LWC Quadra............................................................................... 113
Veja Também ................................................................................................................ 114
Extensão a Editar Bloco LWC........................................................................................... 114
Antes de você começar ................................................................................................... 114
Veja Também ................................................................................................................ 116
Estendendo o Edit Block Label LWC ................................................................................. 116
Veja Também ................................................................................................................ 117
Estendendo o Bloco de Edição Novo LWC ......................................................................... 117
Veja Também ................................................................................................................ 118
Editar Quadra Propriedades ............................................................................................. 119
Veja Também ................................................................................................................ 119
Exemplo de etapa........................................................................................................... 121
Veja Também ................................................................................................................ 125

company
Adicionar e configurar um bloco de digitação antecipada ...................................................... 125
Veja também ................................................................................................................. 126
Fazer uma chamada HTTP a partir de um bloco Type Ahead ................................................ 127
Veja também ................................................................................................................. 127
Usando o bloco de digitação antecipada com dados JSON................................................... 127
Veja também ................................................................................................................. 128
Usando o preenchimento automático do Google Maps em OmniScripts .................................. 128
Veja também ................................................................................................................. 130
Use o bloco Type Ahead com DataRaptor .......................................................................... 131
Veja também ................................................................................................................. 131
Propriedades do bloco de digitação antecipada................................................................... 131
Propriedades do texto ..................................................................................................... 157
Criar um componente Web do Lightning personalizado para OmniScript............................. 158
Atualizar os dados do elemento LWC personalizado ............................................................ 168
Mapear respostas para o JSON de dados do OmniScript...................................................... 169
Criar e mapear dados dentro do elemento LWC personalizado.............................................. 171
Métodos def inidos........................................................................................................... 179
Variáveis Disponíveis ...................................................................................................... 179
Exemplos ...................................................................................................................... 181
Adicionar componentes Web do Lightning personalizados a um OmniScript ....................... 186
Estilo OmniScripts ........................................................................................................... 188
Visualizando suas alterações ........................................................................................... 195
Modificar o comportamento da interface do usuário do OmniScript .................................... 196
Implantar, iniciar e incorporar OmniScripts........................................................................ 203
Adicione seu OmniScript a uma página da comunidade........................................................ 207
Adicione seu OmniScript a uma página do Lightning ............................................................ 208
Veja também ................................................................................................................. 211
Iniciar OmniScripts em Comunidades a partir de URLs......................................................... 211
Iniciando um OmniScript no Lightning ................................................................................ 213
Iniciando um OmniScript a partir de uma ação de layout ....................................................... 214
Veja também ................................................................................................................. 215
Veja também ................................................................................................................. 218

company
Criar OmniScripts em vários idiomas ................................................................................ 219
Configuração avançada para elementos de formulário OmniScript...................................... 232
Figura 5. Exemplo E Junção............................................................................................. 242
Figura 6. Exemplo de consulta prof unda ............................................................................ 243
Figura 7. Exemplo com uma junção OR ............................................................................. 243
Figura 8. Exemplo de conf iguração de campo de controle .................................................... 244
Figura 9. Configuração do campo de controle ..................................................................... 245
Figura 10. Configuração do Campo Dependente ................................................................. 245
Figura 11. Dependência de campo definida no Salesforce .................................................... 246
Dados OmniScript e integrações externas ......................................................................... 247
Veja também ................................................................................................................. 251
Casos de uso comuns ..................................................................................................... 252
Acesse os dados JSON................................................................................................... 252
Sintaxe Adicional............................................................................................................ 253
Renomear nós JSON de dados ........................................................................................ 254
Preencher Elementos ...................................................................................................... 254
Concatenar valores ......................................................................................................... 256
Definir dados com fórmulas e funções ............................................................................... 256
Definir e acessar dados aninhados .................................................................................... 257
Veja também ................................................................................................................. 258
Veja também ................................................................................................................. 260
Operadores de fórmula compatíveis .................................................................................. 260
Funções OmniScript........................................................................................................ 260
Tabela 1. Funções de conversão ...................................................................................... 260
Tabela 2. Funções Condicionais ....................................................................................... 261
Tabela 3. Funções de Texto ............................................................................................. 261
Tabela 4. Funções de Data .............................................................................................. 262
Tabela 5. Funções agregadas .......................................................................................... 262
Criar uma fórmula ou agregado em um OmniScript........................................................... 263
Veja também .............................................................................................................. 265
Criar uma interf ace DataRaptor para mapear dados OmniScript para um PDF...................... 266
Veja também .............................................................................................................. 266

company
Mapear campos OmniScript para um PDF....................................................................... 267
Veja também .............................................................................................................. 267
Adicionar uma ação de PDF ao OmniScript ..................................................................... 267
Veja também .............................................................................................................. 268
Adicionar um arquivo ou imagem ao OmniScript............................................................... 268
Propriedades do arquivo ............................................................................................... 269
Veja também .............................................................................................................. 269
Propriedades da imagem .............................................................................................. 269
Veja também .............................................................................................................. 269
Vinculando sua organização do Salesforce à sua conta do DocuSign .................................. 270
Preparando documentos do DocuSign............................................................................ 270
Vinculando um modelo do DocuSign ao Vlocity ................................................................ 270
Campos de mapeamento do OmniScript para o modelo DocuSign ...................................... 270
Preenchendo um modelo do DocuSign usando o DataRaptor Transform.............................. 271
Gerenciando OmniScripts................................................................................................. 273
Incorporar FlexCards em um OmniScript........................................................................... 276
Referência Leia-me do OmniScript .................................................................................... 277
Cartões ........................................................................................................................... 279
Flyouts ............................................................................................................................ 279
Fontes de dados .............................................................................................................. 280
Design e layout ................................................................................................................ 280
Opções de publicação...................................................................................................... 280
Implantar FlexCards ......................................................................................................... 280
Desenhista de FlexCard.................................................................................................... 280
Comece com FlexCards.................................................................................................... 293
Construa um FlexCard com o FlexCard Designer ............................................................... 294
Criar um novo FlexCard.................................................................................................... 296
Adicionar uma ação a um FlexCard ................................................................................... 298
Tipos de ação de cartão .................................................................................................. 300
Veja também ................................................................................................................. 306
Exemplo 1. Exemplo: Suspender Plano de Dispositivo Móvel ................................................ 307
o que está incluído....................................................................................................... 308

company
Baixe e Importar a Pacote de dados ............................................................................... 308
Veja Também ............................................................................................................. 309
O que é Incluído .......................................................................................................... 313
Importar Pacote de dados ............................................................................................. 313
Veja Também ............................................................................................................. 314
Exemplo 2. Exemplo: Atualizar Lista de Produtos ................................................................ 314
Veja Também ............................................................................................................. 316
Adicionar elementos a um FlexCard .................................................................................. 318
Figura 12. Estrutura do FlexCard dentro do FlexCard Designer ............................................. 319
Veja Também ............................................................................................................. 324
Veja Também ............................................................................................................. 328
Veja Também ............................................................................................................. 329
Exemplo 3. Exemplo: Exibir informações da conta e do caso ................................................ 330
Exemplo 4. Exemplo: passar ID de contato para Flexcard f ilho como um ContextId .................. 331
Veja também .............................................................................................................. 337
Passar Atributos Pais para o FlexCard Filho .................................................................... 338
Passar todos os registros dos pais para o f ilho FlexCard ................................................... 338
Baixe e Importar.......................................................................................................... 339
Atributos..................................................................................................................... 344
Grupo Atributos ........................................................................................................... 345
Coluna Propriedades.................................................................................................... 345
Tipo de campo Propriedades......................................................................................... 349
Propriedades comuns do elemento de alternância............................................................ 360
Alternar Elemento Propriedades .................................................................................... 360
Estados do FlexCard ........................................................................................................ 363
Exemplo 5. Exemplo: Informações da Política FlexCard ....................................................... 365
Configurar uma fonte de dados em um FlexCard................................................................ 368

company
Exemplo 7. Passe o ContextId .......................................................................................... 373
Exemplo 8. Exemplo de JSON personalizado ..................................................................... 378
Qual é o próximo ......................................................................................................... 387
Veja Também ............................................................................................................. 387
Veja Também ............................................................................................................. 388
Qual é o próximo ......................................................................................................... 389
Veja Também ............................................................................................................. 389
Veja também .............................................................................................................. 390
Qual é o próximo ......................................................................................................... 390
Veja Também ............................................................................................................. 391
Veja também .............................................................................................................. 391
O que vem a seguir...................................................................................................... 394
Veja também .............................................................................................................. 397
Configurar um FlexCard no FlexCard Designer .................................................................. 398
Veja também ................................................................................................................. 401
Veja também ................................................................................................................. 402
Exemplo 9. Exemplo: Atualizar Lista de Produtos ................................................................ 402
Baixe e importe o DataPack .......................................................................................... 404
Veja também .............................................................................................................. 405
Elementos de estilo FlexCard............................................................................................ 407
Veja também ................................................................................................................. 410
Veja também ................................................................................................................. 411
Veja também ................................................................................................................. 411
Veja também ................................................................................................................. 412
Exemplo 10. Assunto responsivo de exemplo e elementos de campo CaseId .......................... 413
Pontos de interrupção disponíveis .................................................................................. 414
Veja também .............................................................................................................. 414
Exemplo 11. Assunto responsivo de exemplo e elementos de campo CaseId .......................... 415
Veja também .............................................................................................................. 416
Veja também .............................................................................................................. 417
Veja também .............................................................................................................. 417

company
Veja também .............................................................................................................. 418
Veja também .............................................................................................................. 418
Veja também .............................................................................................................. 419
Propriedades de 'Adicionar CSS personalizado' de FlexCards ............................................ 420
Veja também .............................................................................................................. 421
Exemplo 12. Exemplo de elemento de tabela de dados agrupado com cores de fundo alternadas
.................................................................................................................................... 421
Propriedades de 'Adicionar CSS personalizado' de FlexCards ............................................ 422
Veja também .............................................................................................................. 423
Veja também .............................................................................................................. 423
Veja também .............................................................................................................. 428
Passar Strings Concatenadas como Valores em FlexCards ................................................ 431
Ativar rastreamento em um FlexCard ................................................................................ 432
Visualização do FlexCard Designer ................................................................................... 432
Visualizar um FlexCard em diferentes pontos de interrupção da viewport ........................... 437
Ativar um FlexCard .......................................................................................................... 438
Configurar opções de publicação em um FlexCard ............................................................ 439
Adicionar etiquetas personalizadas aos campos suportados em um FlexCard..................... 442
Passar dados de um LWC OmniScript para um FlexCard incorporado................................. 443
Recarregue um FlexCard após atualizar um LWC OmniScript em um flyout ......................... 447
Adicionar um FlexCard a uma página do Lightning ............................................................ 448
Adicionar um FlexCard a uma página da comunidade ........................................................ 448
Execute FlexCards fora do Salesforce com OmniOut ......................................................... 448
Acesse o ContextId de um FlexCard em uma página da comunidade .................................. 449
Configurar perfis da comunidade para FlexCards............................................................... 450
Versionamento e clonagem de FlexCards.......................................................................... 451
Veja também ................................................................................................................. 453
Veja também ................................................................................................................. 455
Excluir um FlexCard......................................................................................................... 456
Importar um FlexCard....................................................................................................... 457
Baixe os DataPacks de Amostra FlexCard ......................................................................... 458
Exportar um FlexCard ...................................................................................................... 458

company
Baixe um FlexCard LWC do FlexCard Designer .................................................................. 459
Baixe um FlexCard LWC fora da plataforma do FlexCard Designer...................................... 460
FlexCards Contexto Variáveis ........................................................................................... 460
problemas de FlexCards................................................................................................... 462
Exemplo 13. Exemplo ..................................................................................................... 463
Exemplo 14. Exemplo ..................................................................................................... 464
Baixe o recurso estático OmniOut..................................................................................... 465
Instalar dependências OmniOut ........................................................................................ 465
Incluir LWCs personalizados aninhados em seu OmniOut OmniScript ................................ 466
Adicionar um componente Web OmniScript Lightning ao OmniOut..................................... 467
Adicione um FlexCard LWC ao OmniOut ........................................................................... 470
Criar um aplicativo conectado para OmniOut..................................................................... 471
Configurar vários idiomas no OmniOut para OmniScripts................................................... 472
Execute o OmniOut no modo de desenvolvimento ............................................................. 473
Navegue até um URL de um OmniScript em um aplicativo OmniOut.................................... 475
Navegue até um URL de um FlexCard em um aplicativo OmniOut ....................................... 476
Mova OmniOut para seu aplicativo .................................................................................... 477
Adicionar OmniScripts ao Adobe Experience Manager ....................................................... 480
Adicione folhas de estilo personalizadas ao seu aplicativo OmniOut................................... 483
Conecte seu aplicativo OmniOut ....................................................................................... 484
Veja Também ................................................................................................................ 486
Baixe, conf igure e execute o aplicativo expresso (1) ............................................................ 486
Configure e execute o aplicativo React (2).......................................................................... 487
Veja Também ................................................................................................................ 488
Veja Também ................................................................................................................ 492
Visão geral do DataRaptor Turbo Extract........................................................................... 495
Visão geral da extração do DataRaptor .............................................................................. 501
Visão geral da transformação do DataRaptor ..................................................................... 517
DataRaptor Visão geral da carga ....................................................................................... 524
Práticas recomendadas do DataRaptor.............................................................................. 530
Listar entrada para DataRaptors........................................................................................ 530
Usar fórmulas em DataRaptors ......................................................................................... 532

company
Tipos de dados de saída do DataRaptor ............................................................................ 534
DataRaptor Desenvolvedor Características........................................................................ 535
Use um ID para recuperar dados ...................................................................................... 536
Solicitação de exemplo.................................................................................................... 536
Resultado de exemplo ..................................................................................................... 537
Use parâmetros para recuperar dados ............................................................................... 537
Solicitação de exemplo.................................................................................................... 537
Cache para DataRaptors e procedimentos de integração .................................................... 546
Segurança para DataRaptors e Procedimentos de Integração ............................................. 548
Veja Também ................................................................................................................... 552
Crio um Procedimento de Integração ................................................................................ 552
Acessar dados de procedimento de integração JSON com campos de mesclagem .............. 554
Etapas do procedimento de integração do grupo usando blocos ........................................ 555
Veja Também ................................................................................................................ 556
Veja Também ................................................................................................................ 559
Veja Também ................................................................................................................ 562
Veja Também ................................................................................................................ 565
Veja Também ................................................................................................................ 567
Veja Também ................................................................................................................ 569
Ações do Procedimento de Integração .............................................................................. 581
Entradas: renomear nós nos dados de entrada ................................................................... 583
LocationData : adicionar valores literais ............................................................................. 584
TextWithCode : concatenar valores literais e mesclar campos ............................................... 584
DeptArray : Defina uma matriz.......................................................................................... 584
AfterTax e CalculateNet : f aça cálculos simples usando fórmulas........................................... 584
ConcatName : Concatenar Dois campos de mesclagem ....................................................... 585
RetrieveDept : usar uma função e recuperar um valor de matriz ............................................ 585
CalcFirstOf ThisMonth : Execute um cálculo de data complexo .............................................. 585
AssembleOutput : crie a estrutura dos dados de saída ......................................................... 585
Resposta: retorne os dados de saída................................................................................. 586
Colete IDs para a postagem do Chatter.............................................................................. 589
Crie o procedimento de integração com a ação do Chatter ................................................... 589

company
Relacionado Tópicos....................................................................................................... 595
Criar o modelo de e-mail.................................................................................................. 598
Veja Também ................................................................................................................ 598
Selecione um destinatário de e-mail .................................................................................. 598
Veja Também ................................................................................................................ 598
Crie o procedimento de integração com a ação de email ...................................................... 598
Veja Também ................................................................................................................ 599
Teste o procedimento de integração com a ação de e-mail ................................................... 599
Veja Também ................................................................................................................ 600
Veja Também ................................................................................................................ 601
Veja Também ................................................................................................................ 601
Adicionar NASA como um site remoto ............................................................................... 601
Veja Também ................................................................................................................ 602
Obtenha uma chave de API da NASA ................................................................................ 602
Veja Também ................................................................................................................... 607
Crio um Procedimento de Integração ................................................................................ 607
Acessar dados de procedimento de integração JSON com campos de mesclagem .............. 609
Etapas do procedimento de integração do grupo usando blocos ........................................ 610
Veja Também ................................................................................................................ 611
Veja Também ................................................................................................................ 614
Veja Também ................................................................................................................ 617
Veja Também ................................................................................................................ 620
Veja Também ................................................................................................................ 622
Veja Também ................................................................................................................ 624
Veja Também ................................................................................................................ 628
Veja Também ................................................................................................................ 631
Veja Também ................................................................................................................ 632
Veja Também ................................................................................................................ 634
Veja Também ................................................................................................................ 636
Ações do Procedimento de Integração .............................................................................. 636
Entradas: renomear nós nos dados de entrada ................................................................... 639

company
LocationData : adicionar valores literais ............................................................................. 639
TextWithCode : concatenar valores literais e mesclar campos ............................................... 639
DeptArray : Defina uma matriz.......................................................................................... 640
AfterTax e CalculateNet : f aça cálculos simples usando fórmulas........................................... 640
ConcatName : Concatenar Dois campos de mesclagem ....................................................... 640
RetrieveDept : usar uma função e recuperar um valor de matriz ............................................ 640
CalcFirstOf ThisMonth : Execute um cálculo de data complexo .............................................. 640
AssembleOutput : crie a estrutura dos dados de saída ......................................................... 641
Resposta: retorne os dados de saída................................................................................. 641
Colete IDs para a postagem do Chatter.............................................................................. 644
Crie o procedimento de integração com a ação do Chatter ................................................... 645
Veja Também ................................................................................................................ 647
Veja Também ................................................................................................................ 649
Veja Também ................................................................................................................ 649
Relacionado Tópicos....................................................................................................... 650
Veja Também ................................................................................................................ 651
Veja Também ................................................................................................................ 652
Veja Também ................................................................................................................ 653
Veja Também ................................................................................................................ 654
Criar o modelo de e-mail.................................................................................................. 654
Veja Também ................................................................................................................ 654
Selecione um destinatário de e-mail .................................................................................. 654
Veja Também ................................................................................................................ 654
Crie o procedimento de integração com a ação de email ...................................................... 654
Veja Também ................................................................................................................ 655
Teste o procedimento de integração com a ação de e-mail ................................................... 655
Veja Também ................................................................................................................ 656
Veja Também ................................................................................................................ 657
Veja Também ................................................................................................................ 657
Adicionar NASA como um site remoto ............................................................................... 657
Veja Também ................................................................................................................ 657
Obtenha uma chave de API da NASA ................................................................................ 657

company
Tratamento de Erros em Procedimentos de Integração....................................................... 662
Variáveis de ambiente em DataRaptors e procedimentos de integração .............................. 663
Objetos Externos em Procedimentos de Integração ........................................................... 664
Procedimentos de Teste: Procedimentos de Integração para Teste de Unidade ................... 667
Veja Também ................................................................................................................ 669
Veja Também ................................................................................................................ 672
Invocação do Procedimento de Integração ........................................................................ 672
Configurações para procedimentos de integração de longa duração................................... 678
Continuação em chamadas de longa duração .................................................................... 684
Exemplo 15. Exemplo de classe VlocityContinuationIntegrationTest.cls .................................. 685
5. Use o método OmniStudio.OmniContinuation.getResponse para recuperar a resposta.
Exemplo 16. Exemplo de classe OmniContinuationTest.cls................................................... 688
Figura 13. Procedimentos de Cálculo e Matrizes ................................................................. 694
Exemplo de cálculo para cotação de seguro de vida .......................................................... 695
Matrizes de Cálculo.......................................................................................................... 696
Exemplo 17. Caso de Uso de Amostra de Propriedade e Acidentes ....................................... 699
Exemplo 18. Caso de uso de amostra de integridade do grupo.............................................. 699
Veja Também ............................................................................................................. 716
Visão geral dos procedimentos de cálculo......................................................................... 717
Declarativo Procedimentos de cálculo............................................................................... 729
Veja Também ................................................................................................................ 734
Veja Também ................................................................................................................ 735
Configurar uma ação de Vlocity ........................................................................................ 744
Atualizar lógica de filtro para ações de Vlocity................................................................... 773
Atualizar configurações de perfil para ações de contrato.................................................... 774
Atualizar o tipo de link para uma ação ............................................................................... 775
URL de destino e parâmetros de URL ................................................................................ 776
Exemplo 19. Exemplo de parâmetro de URL....................................................................... 778
Exibir ações de Vlocity com a barra de ferramentas de ação de Vlocity ............................... 778
Referência de função........................................................................................................ 780
Exemplo de código Apex para uma função personalizada .................................................. 809

company
Listar entrada em funções personalizadas......................................................................... 810
Ativar rastreamento para componentes do OmniStudio...................................................... 811
Acompanhamento de eventos de componentes do OmniStudio.......................................... 812
Acompanhamento de eventos OmniScript ......................................................................... 813
Acompanhamento de eventos do procedimento de integração ........................................... 813
Acompanhamento de eventos da estrutura de cartões ....................................................... 815
Acompanhamento de eventos para campos personalizados............................................... 816
ID de interação da sessão de rastreamento........................................................................ 816
Pré-processador de dados de rastreamento....................................................................... 817
Referência de componentes da Web do OmniStudio Vlocity Lightning ................................ 818
Configurar componentes da Web do Lightning .................................................................. 818
Estender os componentes da Web do Vlocity Lightning ..................................................... 818
Implantar componentes da Web do Lightning .................................................................... 820
Iniciar URLs de componentes da Web do Lightning com vlocityLWCWrapper...................... 821
Referência Leia-me do LWC de base Vlocity ...................................................................... 822
Migração de dados com OmniStudio DataPacks ................................................................ 823
Criar um DataPack ......................................................................................................... 824
Importar um DataPack..................................................................................................... 824
Tipos de objeto DataPack suportados ................................................................................ 825
Corrija o erro de importação/exportação do DataPack: Nenhuma configuração encontrada ....... 826
Instalar o IDX Workbench ................................................................................................ 828
Configurar ativação e compilação do LWC OmniScript e FlexCard ......................................... 828
Configuração do IDX Workbench para migração ................................................................. 828
Migração e comparação de objetos ................................................................................... 839
Use o IDX Workbench Process Profiler .............................................................................. 844
Comparar versões do OmniScript e do procedimento de integração ....................................... 845
Executar procedimentos de teste ...................................................................................... 847
Comandos do menu do IDX Workbench............................................................................. 853

company
OmniStudio
OmniStudio
OmniStudio fornece um conjunto de serviços, componentes e objetos de modelo de dados que se combinam para
criar aplicativos Industry Cloud. Crie interações guiadas usando dados de sua organização do Salesforce e fontes
externas.
Com OmniStudio , você pode criar:
• OmniScripts , que contêm a lógica de interação

• DataRaptors , que transferem e transformam dados entre o Salesforce e as ferramentas OmniScripts , FlexCards e
procedimentos de integração.
• Procedimentos de integração, que agrupam operações do lado do servidor para eficiência e reutilização
• FlexCards , que exibem dados e ações de lançamento

company
OmniStudio Basics
Crie consoles de serviço e aplicativos de nuvem do setor com os blocos de construção básicos do OmniStudio .
Noções Básicas do OmniScript

Uma Vlocidade OmniScript orienta os usuários através de processos complexos com respostas rápidas,
personalizadas e consistentes. Por exemplo, você pode criar um OmniScript para orientar:
• Um agente de atendimento ao cliente para adicionar um novo cliente

• Um agente de seguros para atualizar uma apólice
• Um usuário final para concluir uma interação de autoatendimento, como solução de problemas
Você pode criar uma interação guiada para corresponder ao fluxo do seu processo. OmniScript é uma ferramenta de
script declarativa, o que significa que você a cria com cliques, não com código. Para criar a estrutura de um
OmniScript , você arrasta e solta diferentes tipos de elementos para:
• Adicione ações como extrair dados ou enviar um email

• Agrupe itens criando uma etapa ou exibindo uma lista de itens que o cliente pode selecionar
• Criar uma função como uma fórmula
• Adicione campos de entrada e pesquisas para o usuário inserir dados
• Refinar a exibição usando um título ou bloco de texto
• Crie ramificações que ajustem dinamicamente os controles e habilite ou desabilite etapas dependendo das
escolhas que o usuário fizer no processo guiado
• Configure cálculos e mensagens que forneçam feedback imediato e verificação de erros ao usuário
Os modelos controlam o estilo e a aparência dos OmniScripts . Você pode personalizar se sua interação guiada tem
um modo horizontal ou vertical, marca e quaisquer outros aspectos que deseja alterar.

company
Você pode iniciar um OmniScript de qualquer lugar, incluindo:
• Um botão de ação como o mostrado aqui na página da conta

• Um link de ação em um cartão

company
Noções básicas de FlexCards
Os FlexCards fornecem ferramentas para criar componentes e aplicativos de interface do usuário específicos do
setor e centrados no cliente na plataforma Salesforce. Os FlexCards são ricos em informações e ações relevantes ao
contexto do cliente. Crie seus FlexCards em uma ferramenta de design declarativa e adicione-os às suas páginas do
Lightning ou da Comunidade.
Contexto do cliente
Cada cliente está vinculado a vários aspectos dos produtos e serviços da sua empresa. Os clientes têm contas,
métodos preferenciais de recebimento de contas, meios de contato preferenciais e um histórico dos produtos que
adquiriram, bem como de suas interações com a empresa. Quando os agentes precisam usar sistemas diferentes
para coletar informações contextuais sobre o cliente, isso afeta o atendimento ao cliente. Use FlexCards para
otimizar o envolvimento do cliente.
Projetista
O FlexCard Designer é uma ferramenta declarativa para criar componentes de interface do usuário. Crie interfaces
de usuário dinâmicas centradas no cliente sem código a partir de uma interface de arrastar com edição WYSIWYG .
Veja OmniStudio FlexCards .
FlexCards
Um FlexCard é um bloco que contém uma combinação de informações pertinentes e links para processos dentro de
um contexto específico. Por exemplo, um cartão de conta pode incluir informações exclusivas da conta, como:
• Status
• Prioridade ou serviço nível acordo
• Data de criação

company
• As ações em um cartão de conta podem incluir:
• Fechando um caso
• Abrindo um novo caso
• Criando uma nova tarefa
No FlexCard Designer, você pode criar uma ação que inicia ou atualiza um OmniScript , navega para uma página da
Web ou aplicativo, exibe um submenu, dispara um evento, atualiza valores de campo e muito mais. Consulte
Adicionar uma ação a um FlexCard .
Design e layout
elementos individuais ou adicione CSS personalizado diretamente em um elemento no FlexCard Designer. Você
também pode tornar os elementos responsivos. Consulte Elementos de estilo FlexCard .
Fontes de dados
Selecione entre várias opções de fonte de dados para recuperar dados a serem exibidos em seus FlexCards . Para
obter uma lista de fontes de dados disponíveis no FlexCard Designer, consulte FlexCards Data Source Reference .
DataRaptor ou Procedimento de Integração?

OmniStudio Os DataRaptors leem ou gravam dados do Salesforce SObject ou executam dados de etapa única
transformações. Os procedimentos de integração do OmniStudio podem interagir com vários tipos de dados e
processá-los em várias etapas. Para alguns casos de uso, um único DataRaptor é suficiente. Os Procedimentos de
Integração geralmente chamam um ou mais DataRaptors e são mais flexíveis e poderosos. Use estas diretrizes para
ajudá-lo a determinar qual construir.
Use um único DataRaptor se:
• Você precisa ler dados de SObjects ou gravar dados em SObjects , mas não ambos.
• Os SObjects que você precisa ler ou gravar para ter um relacionamento definido. Por exemplo, Contas e Contatos
têm um relacionamento porque um Contato pode ter um valor AccountId .
• Você só precisa trabalhar com dados JSON ou XML. Nenhum SObjects está envolvido .
• Você pode realizar qualquer filtragem, cálculo ou reformatação necessária de valores de dados usando uma ou
uma série de fórmulas .
• Você pode fazer as alterações necessárias na estrutura de dados mapeando nós JSON de entrada para JSONnodes
de saída .
Use um Procedimento de Integração se:
• Você precisa ler e gravar em um ou mais SObjects , o que significa que você precisa chamar pelo menos
doisDataRaptors .
• Os SObjects que você precisa ler e/ou gravar para não ter um relacionamento definido.
• A transformação de seus dados não pode ser feita apenas com fórmulas. Por exemplo, condições diferentes
determinam se alguma filtragem ou cálculos são executados.

company
• Os mapeamentos de nós JSON não são simples e/ou exigem uma série de etapas.
• Você precisa ler ou gravar em vários tipos de fonte de dados, como SObjects , arquivos CSV, externalobjects ,
classes do Apex e assim por diante.
• Você precisa executar ações como chamar uma API REST, enviar um email, mesclar listas, manipular erros e assim
por diante.
Veja Também
• Práticas recomendadas do DataRaptor
• Práticas recomendadas do procedimento de integração
Use o Formulários Juntos

Use os aplicativos OmniStudio juntos. Crie interações guiadas com OmniScripts ; obter e postar dados com
DataRaptors e Procedimentos de Integração; e exibir dados e ações de lançamento com FlexCards .
Aqui está um exemplo de FlexCards , OmniScripts e DataRaptors usados juntos para:
• Exibir e fornecer um contexto para informações e ações

• Complete um guiado processo
• Recupere os dados corretos para o processo
O agente visualiza informações e ações relacionadas ao pedido contidas no cartão. Quando o agente clica no link de
novo pedido no cartão, um OmniScript é iniciado para iniciar um processo guiado de compra de produtos.
OmniScript usa um DataRaptor para obter uma lista de produtos para exibição. Em seguida, o agente pode escolher
um ou mais produtos para compra. Quando o processo de compra termina, o OmniScript retorna o agente à exibição
que inclui o cartão Pedidos.

company
Guia de estilo personalizável para o Newport Design System
Os clientes da Vlocity têm seu próprio conjunto de diretrizes de marca e especificações de design, principalmente
para aplicativos voltados para o cliente. A Vlocidade Omniscript e Designers de Cartões permitem que você escolha
entre dois modelos:
• Lightning: Refere- se ao Salesforce Lightning Design System.

• Newport: Isso faz referência ao guia de estilo do Vlocity .
Sobre o Newport Design System

Newport é a estrutura CSS que permite aos clientes redefinir o tema de todos os componentes Vlocity em um só
lugar. Destina-se a ser uma ferramenta para designers e desenvolvedores da Web para redefinir facilmente todos os
componentes do Vlocity em um único local e gerar arquivos CSS personalizados e otimizados que podem ser usados
de forma consistente em todos os componentes e páginas.
O Newport Design System suporta duas funções:
• Fornece um guia de estilo visual de nível de consumidor pronto para uso.

• Fornece uma estrutura para renomear e atualizar componentes Vlocity globalmente.
Designers

company
Use o novo Design System [versão beta] para revisar todos os componentes e baixar uma biblioteca do Sketch para
acelerar o projeto.
Desenvolvedores
Vá para a Vlocity Repositório do Github para ajudá-lo a personalizar e renomear todos os modelos baseados em
Vlocity Newport em um só lugar.
Implementações que podem ser chamadas

Vlocity Apex e as Ações Remotas de OmniScripts e Procedimentos de Integração suportam a interface Callable .
Embora as interfaces VlocityOpenInterface e VlocityOpenInterface2 permitam implementações flexíveis com uma

assinatura uniforme, elas residem no pacote gerenciado Vlocity e não são verdadeiramente
Padrões do Salesforce. No entanto, as classes que implementam VlocityOpenInterface ou
VlocityOpenInterface2 também implementa a Callable Interface , que é um padrão do Salesforce.
Além disso, as Ações Remotas de OmniScripts e Procedimentos de Integração podem invocar qualquer classe que
implemente Callable , independentemente de implementar VlocityOpenInterface ou VlocityOpenInterface2 . Você
especifica as propriedades Classe Remota, Método Remoto e Entrada Adicional da mesma maneira para classes que
implementam qualquer uma dessas interfaces.
Para alterar classes personalizadas que implementam VlocityOpenInterface ou VlocityOpenInterface2 para

implementações Callable , converta a assinatura com algumas linhas de código:
global with sharing class ClassName implements Callable

{
public Object call(String action, Map<String, Object> args) {
Map<String, Object> input = (Map<String, Object>)args.get('input');

Map<String, Object> output = (Map<String, Object>)args.get('output');
Map<String, Object> options = (Map<String, Object>)args.get('options');
return invokeMethod(action, input, output, options);

}
private Object invokeMethod(String methodName, Map<String, Object> inputMap, Map<String, Object>
outMap, Map<String, Object> options) {
...
} ...
}
Para obter um exemplo completo, consulte Fazer uma chamada remota de longa duração usando
OmniStudio.OmniContinuation .

company
Visualizando o namespace e a versão do OmniStudio Pacote Vlocity
Para verificar o namespace e a versão do seu OmniStudio Pacote Vlocity :
1. Ir para Configuração .
2. Na caixa Busca rápida , insira Pacotes instalados e clique em Pacotes instalados .
3. Verifique se a versão mais recente do pacote está listada na página Pacotes Instalados.
4. Na página Pacotes Instalados, clique em seu OmniStudio atual Pacote Vlocity .
A página resultante exibe o OmniStudio Detalhes do pacote Vlocity , incluindo namespace, número da versão e
informações de licença.
Veja também
Visão geral de pacotes na ajuda do Salesforce.

company
OmniScripts
Um OmniScript é um envolvimento do cliente omnicanal e uma ferramenta de negócios criada na plataforma

Salesforce. Os OmniScripts permitem que você crie interações dinâmicas com o cliente sem código e implemente em
vários canais e dispositivos. Os administradores podem definir um script uma vez e implantá-lo em um aplicativo
Salesforce ou em uma página da Web.
Crie OmniScripts para orientar os usuários pelos processos de vendas e serviços com respostas rápidas e
personalizadas e integração perfeita com aplicativos e dados corporativos.
Práticas recomendadas do OmniScript

Aprimore o desempenho e a usabilidade do OmniScript seguindo as práticas recomendadas do OmniScript sempre
que possível.
Processo de negócios e lógica

As melhores práticas de processos e lógica de negócios incluem:
• Use um proprietário para cada OmniScript .

• Identifique elementos reutilizáveis construindo um esqueleto de todo o OmniScript .
• Documente a finalidade de um elemento na propriedade Notas internas do elemento.
• Mantenha as classes DataRaptors e Apex evitando alterações no nome do elemento. Se o nome do elemento
precisar ser atualizado, aplique as alterações de nome à classe DataRaptor ou Apex.
• Evite atribuir um ContextId no OmniScript . do OmniScript ContextId é uma chave reservada que atribui um ID de
registro da URL.
• Quando os processos são repetíveis em vários OmniScripts , crie um OmniScript reutilizável e adicione - o aos
OmniScripts pai apropriados . Ver Embutir um OmniScript em outro OmniScript .
Interface do usuário
Os OmniScripts usam os componentes da Web do Lightning para definir o estilo de elementos individuais e do
próprio OmniScript .
melhores práticas incluem:
• Crie componentes da Web do Lightning personalizados que estendem o componente de um elemento OmniScript
para aplicar alterações de estilo. Para obter mais informações, consulte Estender o componente da Web do
Lightning de um elemento OmniScript
• Aplique a marca global usando o Newport Design System. Para obter mais informações, consulte Aplicar marca
global a OmniScripts .

company
Princípios de design da experiência do usuário
Os princípios de design de UX incluem:
• Reduza o número de campos nos quais o usuário deve inserir informações preenchendo previamente os campos
usando dados contextuais . Para obter mais informações , consulte Pré preenchimento OmniScript Elementos
usando Data Raptor .
• Evite confundir o usuário dividindo os processos em etapas mais curtas que contenham uma quantidade mínima
de elementos .
• Guie o usuário criando um texto de ajuda contextual e ordenando logicamente os campos de entrada.
Fatores de desempenho
Existe um conjunto de práticas recomendadas tanto para o desempenho do lado do cliente quanto para o
desempenho do lado do servidor.
As melhores práticas do lado do cliente incluem:
• Reduza exibições condicionais, mesclar campos, fórmulas sempre que possível.

• Acelere a aplicação de respostas cortando o Response JSON. Para obter mais informações, consulte Manipular
JSON com as propriedades de transformações de envio/resposta .
• Remova os espaços dos nomes dos elementos para melhorar o tempo de carregamento do OmniScript .
• Reduza o número de elementos no script. Um único OmniScript não deve exceder 200 elementos.
• Execute a lógica no servidor sempre que possível, incluindo lógica condicional em Procedimentos de Integração e
fórmulas em DataRaptors .
• Teste o desempenho ativando o rastreamento de tempo. Se o rastreamento de tempo não for usado na
produção, desative o recurso antes de implantar na produção. Para obter mais informações , consulte Serviço de
rastreamento OmniStudio .
As melhores práticas do lado do servidor incluem:
• Reduza o tamanho do payload de uma solicitação cortando a solicitação JSON. Para obter mais informações,
consulte Manipular JSON com as propriedades de transformações de envio/resposta .
• Reduza as viagens de ida e volta do servidor usando os Procedimentos de Integração sempre que várias ações
forem executadas entre as etapas.
Execute os Procedimentos de Integração de forma assíncrona, ativando a propriedade disparar e esquecer.
• Remova dados desnecessários cortando a saída de extração do DataRaptor .
OmniScript Designer Overview

O OmniScript Designer permite que você visualize formulários da Web dinâmicos à medida que os cria usando uma
interface de arrastar e soltar com edição WYSIWYG.

company
Ao criar seu script, visualize elementos dentro das etapas, visualize alterações de propriedade ao vivo e acesse
orientação contextual com ajuda no produto para descobrir e aprender sobre a funcionalidade sem sair do script.
Para Acesso a Designer OmniScript , consulte Acesse o Designer OmniScript .
NOTA
O OmniScript Designer é otimizado para uso no navegador Google Chrome.
Cabeçalho (1) , painel de navegação (2) , tela (3) , painel de construção (4) , painel de propriedades (5) , painel de
configuração (6) , visualização (7)
Destaques do Designer OmniScript

Os recursos notáveis do OmniScript Designer incluem:
• Construa seus scripts em um Canvas amplo e ajustável e visualize instantaneamente as alterações feitas nas
propriedades do elemento .
• Reposicionamento, clonagem e ajuste da largura dos elementos de etapa ao longo de uma grade horizontal de 12
colunas.
• Acessando elementos inativos e navegando entre elementos em visualizações de alto nível e detalhadas a partir
do Painel de Navegação .
• Configurando elementos do painel Propriedades.
• Pesquisando e arrastando elementos para o Canvas a partir do painel Build.
• Configurando as configurações de todo o script no painel Configuração.
• Visualizando a Ajuda contextual no produto para descobrir e aprender sobre elementos e propriedades sem sair
do seu script.
• Visualizando, testando e depurando seu script no Preview.

company
Cabeçalho (1)
No Cabeçalho, visualize metadados e execute ações relacionadas ao seu script.
Visualize metadados de alto nível sobre seu OmniScript , como Tipo , Subtipo , Versão , Idioma e status de ativação .
Na navegação de ações, alterne entre o modo de design e visualização, crie uma nova versão, ative ou desative a
versão atual, edite as configurações básicas, baixe seu OmniScript e obtenha instruções de inicialização.
Painel de Navegação (2)

Acesse e navegue entre ações, etapas e elementos de etapa ativos e inativos no Painel de navegação.
A guia Slide View fornece uma visão de alto nível da estrutura de scripts grandes e complexos. Clique em um slide para
abrir o painel Propriedades de uma etapa ou ação.
A guia Tree View fornece uma visão detalhada da estrutura do script. Clique em uma ramificação para abrir o painel
Propriedades de uma etapa, elemento ou ação.
Tela (3)
(A) Crie seus scripts arrastando elementos do painel Build para o Canvas.
(B) Reorganize, clone e exclua elementos conforme necessário.

company
(C) Ajuste a largura da tela de ambos os lados.
(D) Expanda Etapas para visualizar e configurar elementos. Ajuste a largura dos elementos em uma grade de 12
colunas e arraste os elementos um ao lado do outro para ocupar automaticamente a largura restante da grade.
(E) Veja a aparência de seus scripts com um tema Newport ou Lightning sem alternar para a Visualização.
Construir painel (4)

Arraste elementos de ação, exibição, função, grupo e entrada e OmniScripts inteiros do painel Build para o Canvas
para criar seus scripts.
Painel de propriedades (5)
No painel Propriedades, configure as propriedades para ação, exibição, função, grupo, entrada e elementos
OmniScript incorporáveis na interface do usuário ou edite as propriedades como JSON.
Painel de configuração (6)

Defina as configurações opcionais de todo o script no painel Configuração.
Defina as configurações básicas, Opções de gráfico de etapas , Opções de salvamento , Opções de conhecimento ,
Mensagens de erro , Estrutura de mensagens e Tokens do Lightning Design System na interface do usuário ou edite
as propriedades como JSON.
Ajuda no produto
Nos painéis Construção, Propriedades e Configuração, acesse a Ajuda no produto para visualizar informações
contextuais e instruções sobre elementos e propriedades sem sair do script.

company
(A) Acesse informações em linha sobre propriedades com dicas de ferramentas.
(B) Veja a documentação detalhada sobre a funcionalidade do elemento com painéis de ajuda deslizantes.
Visualização (7)
Visualizar
(A) Visualize seu script em tempo real com dados reais.
(B) Insira um ID de registro no campo Context Id e clique em atualizar para visualizar seu formulário com dados de
teste.
(C) Visualize como um OmniScript aparece em diferentes dispositivos, como celular, desktop e tablet, com o recurso
Visualizar dispositivo .
(D) Com a lista suspensa Tema , veja como seu OmniScript fica com um tema Lightning ou Newport. Se uma folha de
estilo Newport personalizada estiver na organização, ela substituirá a folha de estilo Newport pronta para uso.
(E) Recarregue o Canvas para redefinir os dados e atualize o Data JSON e o Action Debugger.
(F) O Data JSON fornece um formato JSON fácil de ler, que é atualizado quando você insere valores em campos de
dados no Canvas. Também , copie a JSON inteiro com apenas um clique.
Depurar
(G) O Action Debugger permite depurar solicitações de ação e dados de resposta. Pesquise ações, copie nós
específicos com um clique e limpe os logs do console.

company
Acessar o Designer OmniScript
Acesse o OmniScript Designer por meio do menu inicializador do aplicativo Salesforce.
1. Clique em Iniciador de aplicativos .

2. Selecionar a Aplicativo OmniScript .
3. Na página da lista OmniScripts , clique em Novo para criar um OmniScript , selecione um OmniScript existente
ou importe um OmniScript de outra organização usando um pacote de dados.
Criar um OmniScript
Crie um novo OmniScript para criar um formulário no OmniScript Designer.
IMPORTANTE
Ao usar um OmniScript existente no OmniScript Designer, crie uma nova versão do OmniScript para
atualizar o conjunto de propriedades do OmniScript . Sem uma nova versão, podem aparecer erros no
designer. Ver Atualize um do OmniScript Conjunto de propriedades .
1. Na página inicial do OmniScripts , clique em Novo .
2. Digite um nome para seu OmniScript .
3. Insira um Tipo , Subtipo e Idioma . Type, SubType e Language combinam-se para criar um identificador
exclusivo que se torna o nome de um componente web do Lightning do OmniScript compilado. Por exemplo,
um OmniScript em que Type=account , SubType =Create e Language=English gera um LWC denominado
accountCreateEnglish .
4. (Opcional) Insira uma Descrição para seu OmniScript .
5. Clique em Salvar .
Configurar _ um OmniScript
Defina as configurações opcionais para o OmniScript no painel Configuração do OmniScript Designer, como tornar o
OmniScript reutilizável ou ativar o rastreamento.
Antes de começar
Crie um OmniScript . Consulte Criar um OmniScript .
1. No OmniScript , clique em Configuração para visualizar o painel Configuração.

2. Configure propriedades de configuração específicas. Consulte Referência de configuração do OmniScript .
Qual é o próximo
Próximos passos, construa seu script. Consulte Criar um OmniScript com elementos no OmniScript Designer .
Veja Também
• Configurar elementos no OmniScript Designer
• do OmniScript Designer

company
Criando a estrutura do script
Crie a lógica que é executada quando o script é executado, construindo uma estrutura hierárquica de Actions e Steps
.
As ações fora das etapas executam ações para todo o script, como obter, postar, avaliar e transformar dados. As
etapas geralmente incluem os elementos Block , Input e Display , mas também podem incluir Actions como botões e
Functions específicos da etapa. Saiba mais sobre as definições de estrutura de script OmniScript . Cada página de um
OmniScript é chamada de Etapa e pode conter elementos de Grupo, como Blocos, Elementos de entrada, como
Caixas de seleção, Ações, como Ações de email, e Funções, como Fórmulas.
Construir um OmniScript com elementos no OmniScript Designer

company
Arraste elementos e OmniScripts inteiros do painel Build para a tela para criar seus scripts no OmniScript Designer.
Siga a estrutura hierárquica de Ações e Etapas para construir seu script. As ações fora das etapas executam ações
para todo o script, como obter, postar, avaliar e transformar dados. As etapas geralmente incluem os elementos
Bloco, Entrada e Exibição, mas também podem incluir Ações como botões e Funções específicas da etapa. Saiba mais
sobre Estrutura de script OmniScript Definições .
Figura 1. Estrutura do Script
Antes de começar

company
1. Crie um OmniScript . Consulte Criar um OmniScript .
2. Configure seu OmniScript com configurações opcionais. Consulte Configurar um
OmniScript .
1. No OmniScript , clique em Construir para abrir o painel Construir.
2. (Opcional) Preencha os campos de dados em seu OmniScript . Para preencher os campos de dados do script,
clique em Ações e arraste a Ação de extração do DataRaptor para a tela. uma. Digite um nome no campo
Nome .
b. Na lista suspensa Ação de extração do DataRaptor , selecione um DataRaptor que recupere dados de um
ou mais objetos Salesforce relacionados.
c. (Opcional) Para configurar outras propriedades da ação de extração do DataRaptor , consulte Propriedades
da ação de extração do DataRaptor .
NOTA
Para executar mais de uma chamada de servidor para buscar dados, use um Procedimento de
Integração ou um
Ação Bloquear .
3. (Opcional) Configure as opções de cancelamento para direcionar os usuários que cancelam um OmniScript para
uma experiência diferente do Salesforce. Ver Configurar OmniScript Cancelar Opções .
4. Para criar uma página para seu formulário:
a. Clique em Grupos e arraste Etapa para a tela.
b. Para preencher seu formulário com campos de dados e outros elementos, clique na seta para baixo na
etapa e arraste os elementos do painel Construir para a etapa. Ver Passos .
NOTA
As ações colocadas dentro de uma etapa são renderizadas como botões.
5. Para postar as alterações feitas nos campos de dados:

a. Digite um nome no campo Nome .
b. Na lista suspensa DataRaptor Post Action , selecione um DataRaptor que poste dados de volta ao
Salesforce.
c. (Opcional) Para configurar outras propriedades de ação posterior do DataRaptor , consulte Propriedades
de ação posterior do DataRaptor .
NOTA
Para executar mais de uma chamada de servidor para buscar dados, use um Procedimento de
Integração ou um
Ação Bloquear .
6. Para encerrar o OmniScript e retornar o usuário para onde o script foi iniciado ou para um URL personalizado:
1. Clique em Ações e arraste uma ação de navegação para a tela.

company
2. Para configurar a Ação de Navegação, clique no ícone de ajuda (?) ao lado do título Propriedades da Ação
de Navegação no painel Propriedades ou consulte Ação de Navegação .
Qual é o próximo
Próximos passos, configure seus elementos. Consulte Configurar elementos no OmniScript Designer .
Veja Também
• Visualizar um OmniScript
• Dados de teste no OmniScript Designer
Configurar elementos no OmniScript Designer

Configure elementos para seu OmniScript no painel Propriedades do designer quando um elemento for selecionado,
como o nome, o rótulo e as instruções para um elemento de etapa.
Antes de começar

2. Configure seu OmniScript com configurações opcionais. Consulte Configurar um OmniScript .
3. Adicione elementos ao seu OmniScript . Consulte Criar um OmniScript com elementos no OmniScript Designer .
1. Em seu OmniScript , clique em um elemento na tela ou no Painel de Navegação para abrir o painel
Propriedades.
2. Insira valores para quaisquer campos obrigatórios marcados com um asterisco (*), como o campo Nome de um
elemento de entrada de texto.
3. (Opcional) Para visualizar um elemento inativo, consulte Ativar elementos no OmniScript Designer .
4. (Opcional) Insira valores para campos opcionais, como os campos Placeholder e Label de um elemento de
entrada de texto.
5. (Opcional) Para saber mais sobre uma propriedade específica, passe o mouse sobre o ícone de dica de
ferramenta ( i ) ao lado do nome da propriedade.

company
6. (Opcional) Para documentação detalhada sobre o elemento selecionado, selecione o ícone de ajuda (?) ao lado
do nome da propriedade. Veja Também OmniScript Elemento Referência .
7. Para ativar o elemento, clique em Ativo .
Qual é o próximo
Próximas etapas, visualize a aparência e a funcionalidade do seu OmniScript . Ver Visualizar um OmniScript .
Veja Também
• Iniciar um OmniScript com LWC OmniScript Wrapper
Ativar elementos no OmniScript Designer

Ative um elemento inativo selecionando o elemento no painel de navegação do OmniScript Designer.
Quando um elemento é desativado, ele desaparece da tela. Visualize etapas e ações inativas e ativas localizadas fora
das etapas na exibição de slides do painel de navegação. Visualize todos os elementos inativos e ativos, incluindo
aqueles dentro de etapas, na visualização em árvore do painel de navegação.

company
Painel de navegação: exibição de slides (padrão)
Painel de navegação: visualização em árvore
Ativando Elementos de Etapa ou Ação

Para ativar uma etapa ou ação inativa fora de uma etapa:
1. No OmniScript , no painel Navegação, clique no ícone Exibição de slide s ou no ícone Exibição em árvore.
2. Clique na etapa ou ação que deseja ativar.
3. No painel Propriedades, clique em Ativar .
Ativando Elementos Dentro das Etapas

Para ativar um elemento inativo dentro de uma etapa:
1. No OmniScript , no painel Navegação, clique no ícone Exibição em árvore.

2. Clique em uma etapa e clique no elemento que deseja ativar.
3. No painel Propriedades, clique em Ativar .
Veja Também
• Crio um OmniScript
Visualizar um OmniScript
Visualize a aparência e a funcionalidade do OmniScript visualizando o OmniScript no OmniScript Designer .
Antes de começar

2. Configure seu OmniScript com configurações opcionais. Consulte Configurar um OmniScript .
3. Adicione elementos ao seu OmniScript . Consulte Criar um OmniScript com elementos no OmniScript Designer .
4. Configure seus elementos OmniScript . Consulte Configurar elementos no OmniScript Designer .
1. Em seu OmniScript , clique em Visualizar .

company
2. Para opções de visualização adicionais, selecione estas propriedades:
• ID de contexto : se o OmniScript não tiver uma ação Definir valores que defina um ContextId , para visualizar
o formulário com dados de teste, insira um ID de registro.
IMPORTANTE
Usar a ação Definir valores para definir o ID de contexto só funciona na visualização.
NOTA
Confirme se um Context Id está definido em sua fonte de dados. Por exemplo, se você tem
um
DataRaptor Extract Action que obtém registros de conta, você deve ter um parâmetro de
entrada cuja fonte de dados seja ContextId e cujo valor de filtro seja o nome de saída da
extração de DataRaptor , como AccountId .
• Dispositivo de visualização : para visualizar como seu OmniScript aparece em diferentes dispositivos,
selecione Celular , Tablet ou Desktop .
• Tema : visualize seu OmniScript com um tema Lightning ou Newport .
• Para redefinir os campos de dados em seu OmniScript após fazer alterações, clique no ícone recarregar.
3. (Opcional) Oculte o Data JSON e o Action Debugger clicando em X . Exiba o JSON de dados e a ação novamente
clicando no botão do painel de depuração que aparece quando o painel é fechado.

company
Qual é o próximo
Próximos passos, teste seu OmniScript . Consulte Dados de teste no OmniScript Designer .
Veja Também
Dados de teste no OmniScript Designer

Teste seu OmniScript no OmniScript Designer adicionando dados de teste, exibindo os dados JSON e depurando
solicitações de ação e dados de resposta.
Antes de começar
Visualize a aparência e a funcionalidade do seu OmniScript . Ver Visualizar um OmniScript .
Adicionar dados de teste

1. A partir de OmniScript , clique em Visualizar .
2. Se o OmniScript não tiver uma ação SetValues que defina um ContextId , para visualizar o formulário com
dados, insira um ID de registro no campo Context ID .
NOTA
Confirme se um ContextId está definido em sua fonte de dados. Por exemplo, se você tem um
DataRaptor Extract Action que obtém registros de conta, você deve ter um parâmetro de
entrada cuja fonte de dados seja ContextId e cujo valor de filtro seja o nome de saída da
extração de DataRaptor , como AccountId .
Visão os dados JSON

1. Visualize os dados JSON no Data JSON .
2. (Opcional) Clique no ícone da área de transferência para copiar o JSON completo.

company
Visualizar e depurar solicitações de ação e dados de resposta
1. Clique em Action Debugger para abrir o console de depuração.
2. (Opcional) Pesquise um nome de ação no campo Pesquisar .
3. (Opcional) Para copiar um nó específico, clique no ícone da área de transferência ao lado do nó. Por exemplo,
copie Opções Remotas em uma Ação de Extração do DataRaptor .

company
4. (Opcional) Para limpar o console de depuração, clique em Limpar logs .
5. (Opcional) Clique no ícone de recarregamento para preencher novamente o console de depuração com novos
dados de solicitação e resposta de ação.
Próximos passos
Próximas etapas, inicie seu OmniScript em uma página do Lightning ou da Comunidade. Ver Ativar e Implantar
OmniScript .
Veja Também
Estrutura de script OmniScript Definições

Vlocity Os OmniScripts são definidos pelos Administradores diretamente no aplicativo Vlocity .

company
Um script é definido por meio da seguinte estrutura hierárquica declarativa:
• Script : O script é o contêiner mestre para todos os controles. Os scripts podem ser versionados, portados para
diferentes idiomas, incorporados em scripts pai, exportados para outras organizações e ativados em produção.
• Step : Um script pode conter um ou mais Steps. O usuário navega pelas Etapas usando os botões Próximo e
Anterior. A lógica para impor validação de campo ou campos obrigatórios pode ser opcionalmente aplicada para
cada etapa.
• Entradas : As entradas são controles HTML que formam o conteúdo de entrada do script.
• Funções : As funções permitem avaliar dados, fornecer mensagens e obter a localização de um usuário.

company
• Grupos : Os elementos podem ser combinados em Grupos. Por exemplo, elementos de entrada de rua, cidade,
estado e código postal podem ser combinados em um bloco de endereço. Os grupos estão contidos nas Etapas e
podem ser repetidos para capturar uma matriz de dados.
• Ações : os elementos de ação acionam uma variedade de ações definidas pelo usuário, incluindo remota ou REST
para se comunicar com fontes externas e Procedimento de Integração, Extração de DataRaptor ou Postagem de
DataRaptor para mover dados entre o script e os objetos do Salesforce. Os elementos de ação podem ser iniciados
como um botão no script ou executados remotamente entre as etapas.
• Display : Os elementos de display apresentam informações ao usuário.
• OmniScripts : Um OmniScript inteiro pode ser incorporado em outro script, permitindo que você reutilize scripts
menores em vários scripts maiores.
Atualizar o conjunto de propriedades de um OmniScript

Ao usar um OmniScript existente no OmniScript Designer, crie uma nova versão do OmniScript para atualizar o
conjunto de propriedades do OmniScript . Sem uma nova versão, podem aparecer erros no designer. Evite ou
resolva esse erro atualizando o conjunto de propriedades do OmniScript .
Exemplo Erro
1. Em seu OmniScript , clique em Nova versão para acionar uma classe que adiciona quaisquer propriedades JSON
ausentes.
2. Repita o processo para qualquer OmniScript mais antigo ou importado .
Veja Também

company
Referência de configuração do OmniScript

de configuração do OmniScript oferece várias opções de configuração que permitem definir a aparência e o
comportamento do OmniScript .
Propriedades de configuração padrão

As propriedades de configuração padrão se aplicam a todo o OmniScript e não são incluídas nas seções de
propriedades. Ver Propriedade de configuração Seções .
Propriedade Descrição Exemplo
Guia Console Ícone Aplica um ícone à guia do console onde o OmniScript está incorporado. As configurações n/D
do Rótulo da guia do console e do ícone da guia do console no OmniScript só serão
aplicadas se o OmniScript possuir toda a guia ou subguia. As configurações de Rótulo da
guia do console e Ícone da guia do console não serão usadas se o OmniScript estiver
incorporado em uma página com outros componentes.
Guia Console Título Aplica texto à guia do console onde o OmniScript está incorporado. A Consola n/D
configurações de rótulo de guia e ícone de guia do console no OmniScript só serão aplicadas
se o
O OmniScript possui toda a guia ou subguia. As configurações de Rótulo da guia do
console e Ícone da guia do console não serão usadas se o OmniScript estiver incorporado
em uma página com outros componentes.
Moeda Código Por padrão, o OmniScript usa a moeda padrão da organização em organizações de Configurar um
moeda única e a moeda de um usuário em organizações de várias moedas. Substitua a Moeda do OmniScript
moeda padrão configurando o campo de código de moeda. Código
Reutilizável Permite que o OmniScript seja incorporado em outro OmniScript quando selecionado. Incorporar um
OmniScript em outro
OmniScript
Tipo de elemento para Permite que um componente Web personalizado do Lightning substitua todos os elementos Adicionar componentes
Componente LWC de um tipo de elemento específico. Web do Lightning
Mapeamento personalizados a um
OmniScript
Elemento Modelo Um tipo de elemento específico, como Texto ou Bloco de edição, que é substituído por seu Ativar SEO para
componente Web do Lightning personalizado. OmniScripts
Ativar SEO Disponibilize a URL do seu OmniScript para os mecanismos de pesquisa. Ativar SEO para
OmniScripts
Permitir Descarregar Habilita um site de licença? aviso a ser acionado ao recarregar, navegar ou fechar a janela. n/D
Aviso Para obter opções de personalização modal, consulte Estender e substituir um componente
da Web do OmniScript Modal Lightning .
Buscar lista de opções Permite que os valores da lista de opções sejam recuperados no carregamento do script n/D
Valores no script quando marcado. Se desmarcado , listas de opções vai ser buscado na hora do projeto.
Carregar
Web relâmpago O componente Web do Lightning personalizado de destino que você mapeia para seu tipo de Ativar SEO para
Componente elemento. OmniScripts

company
JSON de dados de Seed Data JSON permite que o OmniScript seja propagado com dados na inicialização. Ele Semeie dados em um
semente não permite fazer referência a outros dados com a sintaxe %element% ou o uso de OmniScript
expressões. Por mais robusto funcionalidade , use o Set Values ação .
Acompanhamento dados personalizados na tabela Vlocity Tracking Entry adicionando pares de chave/valor. n/D
personalizado Requer que o Serviço de Rastreamento de Vlocity esteja habilitado nas Configurações
Dados Personalizadas.
Propriedade de configuração Seções

As seções de propriedades de configuração incluem conjuntos de propriedades que se aplicam a uma configuração
específica, como a exibição de artigos da Base de conhecimento em seu OmniScript .
Seção Descrição Configuração
Opções do gráfico de etapas Oculte o gráfico de etapas ou escolha onde exibi-lo em relação ao seu OmniScript Opções do gráfico de etapas
.
Cancelar Opções Habilite a funcionalidade de cancelamento e configure como o comportamento de Configurar OmniScript Cancelar
cancelamento é executado. Opções
Salvar Opções Permita que os usuários salvem um OmniScript para uso posterior. Configurar Salvar Opções
Conhecimento Opções Ative a exibição de artigos de conhecimento no OmniScript ou ao lado dele . Integrar o Salesforce
Conhecimento com OmniScript
Erro Mensagens Defina uma mensagem de erro padrão ou simplifique as mensagens de erro para os Personalizar OmniScript Erro
usuários. Mensagens
Mensagens Passe informações usando Pub/Sub, windowPostMessage e Session Storage. Estrutura de mensagens
Estrutura
Estilo Opções Personalize o design do seu OmniScript usando folhas de estilo personalizadas, Estilo OmniScripts
tokens de design e uma animação de rolagem.
Configurar um do OmniScript Moeda Código

Substitua a moeda padrão de uma organização em um OmniScript definindo o código de moeda do OmniScript .
Por padrão, o OmniScript usa a moeda padrão de uma organização em organizações de moeda única e a moeda de
um usuário em organizações de várias moedas. Use uma das opções nesta tabela para substituir o código de moeda
padrão.
Moeda da Opção Exemplo
organização
Moeda Única Em Configuração do OmniScript , clique em Código de moeda e Moeda Código = JPY
selecione uma moeda na lista suspensa.
Multi Moeda dinamicamente o código de moeda de um URL usando o & c__ OmniScriptCurrencyCode =JPY
parâmetro OmniScriptCurrencyCode .
Opções do gráfico de etapas

Oculte ou mova um gráfico de etapas do OmniScript usando as opções do gráfico de etapas. Para personalizar o
gráfico de etapas, consulte Personalizar o componente do gráfico de etapas .

company
Propriedade Descrição
Posicionamento do gráfico Exiba o gráfico de etapas em ambos os lados do OmniScript ou acima do OmniScript selecionando Direita , Esquerda
de etapas ou Superior .
Esconder Oculta o gráfico de etapas dos usuários.
Veja Também
• Personalize o Componente do gráfico de etapas
• Referência de configuração do OmniScript
Configurar OmniScript Cancelar Opções
Navegue os usuários para diferentes experiências do Salesforce após cancelar um OmniScript configurando as
opções de cancelamento.
de cancelamento do OmniScript permite que os usuários cancelem um OmniScript de uma Etapa clicando em um
link de cancelamento. A opção de cancelamento direciona o usuário para uma experiência do Salesforce definida nas
opções de cancelamento. As opções de cancelamento são criadas com base na ação de navegação e usam os
mesmos tipos de referência de página para navegar para diferentes experiências.
NOTA
Reiniciar OmniScript não é suportado como uma opção de cancelamento. Ver Reiniciar um
OmniScript .
1. No painel Setup do OmniScript , expanda Cancel Options e clique em Enable Cancel .

2. Em Rótulo do Campo , insira o texto de exibição da opção Cancelar. O texto é exibido como um link clicável em
cada elemento Step.
3. (Opcional) Marque Mostrar prompt antes de cancelar? e digite o texto em Cancelar mensagem para exibir
uma mensagem de prompt. O prompt permite que os usuários retornem ao OmniScript ou confirmem o
cancelamento.
4. (Opcional) Substitua a entrada existente no histórico do navegador definindo a opção Substituir? propriedade
para Sim . Se Substituir? estiver definido como Sim , os usuários não poderão navegar de volta para o
OmniScript .
5. Determine a experiência do Salesforce para a qual o link de cancelamento direcionará clicando e selecionando
um
Tipo de referência de página . Esta página contém mais instruções para cada tipo de referência de página que
oferece suporte a opções de cancelamento. Para informações sobre Referência de página Tipos , consulte
Referência de página Tipos .
Referência de página Modelo Descrição
Aplicativo Inicie um aplicativo padrão ou personalizado disponível no inicializador de aplicativos. Os aplicativos

conectados não são suportado .
Página nomeada da Direcione os usuários para uma página nomeada em uma comunidade.
comunidade

company
Componente Navegue até os componentes do Aura e os componentes da Web do Lightning.
Página atual Acionar uma atualização de página na página atual assim que o usuário concluir o OmniScript .
Conhecimento Artigo Exiba artigos de conhecimento no OmniScript .
Conecte-se Abra uma página de login da Comunidade.
LWC OmniScript Lançar outro LWC OmniScript .
Página nomeada Abra uma página nomeada padrão.
Item de navegação Uma página exibindo conteúdo mapeado em uma CustomTab .
Objeto Direcione os usuários para uma página de objeto padrão ou personalizada.
Registro Abra uma página que interage com um registro do Salesforce.
Registro de relacionamento Abra uma página de relacionamento de registro.
Vlocity OmniScript Lançar um separado OmniScript .
Página da Internet Abra um URL externo .
6. Em Parâmetros de destino , insira parâmetros adicionais para passar para a experiência selecionada.
7. (Opcional) Configure as opções do Messaging Framework. Ver Estrutura de mensagens .
O que vem a seguir

Implante o OmniScript e adicione-o a uma página para testar a funcionalidade de cancelamento. Ver Ativar e
Implantar OmniScript .
Veja Também
• Navegar Ação Propriedades
• Navegar Ação
Salvar e retomar um OmniScript

Permita que os usuários salvem e retomem OmniScripts usando a propriedade Save Options do OmniScript . Os
usuários podem marcar links, iniciar uma instância salva de uma página de objeto ou enviar o link por e-mail.
Configure URLs personalizados para retomar instâncias de OmniScript salvas em diferentes domínios. Por exemplo,
um cliente pode iniciar um OmniScript dentro de uma Comunidade e, em seguida, um representante de
atendimento ao cliente pode retomar o OmniScript dentro do Console de serviço.
Próximos passos
Configurar opções de salvamento
Configurar opções de salvamento

Permita que os usuários salvem e retomem OmniScripts configurando a funcionalidade Salvar para depois.
1. Do OmniScript Painel de configuração , expanda a seção Salvar opções .

2. Clique em Permitir salvar para mais tarde para ativar o recurso Salvar para mais tarde.

company
3. (Opcional) Habilite as etapas para salvar automaticamente uma instância quando um usuário clicar no botão
Avançar em uma etapa marcando Salvar automaticamente na próxima etapa .
4. No campo Salvar modelo de nome , insira um nome para a instância do OmniScript . Este campo oferece
suporte a campos de mesclagem — por exemplo, % LastName %, %FirstName% - Application . Se este campo
for deixado em branco, o padrão é Saved- OmniScript Name-[ RowId ] ."
5. No campo Salvar em dias , insira um número para permitir que a instância do OmniScript permaneça utilizável
por vários dias. Se um usuário tentar retomar o script depois que ele expirar, o script será reiniciado.
6. Defina o campo Salvar ID do objeto para anexar a instância Salva do OmniScript a um registro. O valor padrão é
% ContextId % . Este campo suporta campos de mesclagem. Para obter mais informações, consulte Acessar o
JSON de dados do OmniScript com campos de mesclagem .
7. (Opcional) Permita que os usuários mesclem dados em um OmniScript atualizado marcando Merge Saved Data
JSON em OmniScript atualizado . Se a opção não estiver habilitada, os usuários que abrirem uma instância
salva começarão a partir do início da versão atualizada do OmniScript . Do utilizador Mensagem :
NOTA
Quando um OmniScript é Ativado, ele gera um LWC único, tornando-o salvo
OmniScript da versão anterior inutilizáveis. Se a opção Merge Saved Data JSON no OmniScript
atualizado estiver habilitada, quando uma instância salva for iniciada, o
O OmniScript mescla os dados da instância salva no OmniScript atualizado .
8. Na seção Salvar padrões de URL , mapeie a URL da instância do OmniScript para um campo personalizado em
um Objeto.
Consulte Mapear URLs de instâncias salvas para campos personalizados .
9. (Opcional) Para habilitar Permitir salvar para mais tarde em uma base por etapa:
a. A partir de um elemento Step, expanda a seção Save Options .
b. Marque ou desmarque Permitir salvar para mais tarde para ativar ou desativar Salvar para mais tarde na
etapa.
Qual é o próximo
Mapear URLs de instâncias salvas para campos personalizados
Veja Também
• Personalize a mensagem de erro Salvar para mais tarde
• Elementos de exibição condicional em OmniScripts salvos para diferentes perfis de usuário
• OmniScripts em andamento e concluídos
• Especificar um link de currículo em uma página do Visualforce

company
Mapear URLs de instâncias salvas para campos personalizados
Configure onde uma instância salva do OmniScript é iniciada no Salesforce mapeando URLs para campos
personalizados no objeto Salvado do OmniScript .
Configure Salvar padrões de URL para controlar o formato de URL que mapeia para qualquer campo personalizado.
Você deve criar um campo personalizado no objeto Saved OmniScript para cada URL adicional que você salvar em
uma instância OmniScript .
Antes de começar
Ao usar páginas de comunidade para iniciar instâncias de OmniScript salvas , adicione o componente Vlocity LWC OmniScript Wra pper à página de
comunidade. Ver Lançar um OmniScript com LWC OmniScript Embrulho .
1. Em Configuração do Salesforce, abra o Gerenciador de objetos e selecione o objeto OmniScript salvo .

2. Adicione um novo campo personalizado que aceite URLs.
3. Copie o nome da API do campo .
4. Na seção Salvar padrões de URL , no campo Nome da API do campo, cole o nome da API do campo.
5. No campo Padrão de URL , insira um URL usando estes padrões de sintaxe:
NOTA
Os OmniScripts devem usar os padrões de URL do LWC OmniScript Wrapper para iniciar URLs
de instância do OmniScript salvos.
• Páginas da comunidade :
Usando o padrão de URL do Community LWC OmniScript Wrapper, inclua o parâmetro c__ instanceId e
configure-o como {0} . Defina o parâmetro c__target como {1} .
https://myDomain.force.com/CommunityName/s/CommunityPage/ c__layout = relâmpago&c __

instanceId ={0}& c__target ={1}
NOTA
A página da Comunidade que abre a instância salva deve ter o componente LWC
OmniScript Wrapper presente. Ver Lançar um OmniScript com LWC
OmniScript Embrulho .
• Relâmpago Páginas :
Usando o padrão de URL do Lightning LWC OmniScript Wrapper, adicione o parâmetro c__ instanceId e
defina-o como {0} . Defina o parâmetro c__target como {1} .
https://myDomain.force.com/lightning/cmp/namespace__vlocityLWCOmniWrapper? c__layout =
relâmpago&c __ instanceId ={0}& c__target ={1}
6. (Opcional) Teste o OmniScript seguindo estas etapas:
a. Salve e ative o OmniScript .
b. Visualize o OmniScript e salve a instância.

company
c. Copie o link OmniScript salvo .
d. Cole o link em seu navegador para visualizar a instância salva.
NOTA
Se o link não funcionar, verifique se o formato do URL e os nomes de todas as páginas
da comunidade estão corretos.
Qual é o próximo
Personalize a mensagem de erro Salvar para mais tarde
Veja Também
• Configurar Salvar Opções
Personalize a mensagem de erro Salvar para mais tarde

Crie mensagens de erro personalizadas com a estrutura de tratamento de erros do OmniScript .
Quando vários usuários estão atualizando a mesma instância salva do OmniScript , o primeiro usuário que salva a
OmniScript torna-se o proprietário dessa instância. O usuário que não consegue salvar o OmniScript recebe um erro
informando que ele precisa atualizar o OmniScript . Personalize a mensagem de erro que os usuários recebem usando
a propriedade Error Messages . Para obter mais informações , consulte Personalizar OmniScript Erro Mensagens .
1. No painel Configuração do OmniScript , expanda a seção Mensagens de erro .

2. Deixe o valor do caminho em branco. A mensagem de erro está no caminho raiz do OmniScript .
3. Na seção Mensagens de erro personalizadas , deixe o valor do caminho em branco. O erro mensagem está no
_ Caminho raiz do OmniScript .
4. No campo Valor , insira este texto de mensagem de erro padrão: Este OmniScript salvo foi atualizado desde a
retomada. Para ver as atualizações mais recentes, saia e retome o OmniScript salvo novamente.
5. No campo Mensagem , insira uma mensagem de erro personalizada.
6. Salve e ative o OmniScript .
7. (Opcional) Teste o OmniScript seguindo estas etapas:
a. Abra o OmniScript e salve uma instância.
b. a instância salva do OmniScript em duas guias separadas.
c. Em uma das instâncias, adicione informações adicionais e salve o OmniScript .
d. Na outra instância, tente adicionar informações e salve a instância para visualizar o erro personalizado.
Veja Também

company
• Mapear URLs de instâncias salvas para campos personalizados
Elementos de exibição condicional em OmniScripts salvos para diferentes perfis de usuário

Controle quais elementos OmniScript são exibidos para diferentes usuários de perfil em uma instância OmniScript
salva usando condições.
Quando o OmniScript é retomado, ele usa o perfil do usuário atual. As condições nos elementos podem determinar
se o usuário tem acesso ao elemento. Por exemplo, um agente pode ver dados que não são exibidos aos clientes.
1. Na propriedade Exibição Condicional de um elemento, clique em Adicionar Condição .

2. No primeiro campo, digite userProfile .
3. No segundo campo, insira o nome de um perfil de usuário. Por exemplo , Administrador do Sistema.
A figura a seguir mostra as configurações de um elemento que é exibido apenas para agentes da central de
atendimento.
Veja Também
OmniScripts em andamento e concluídos

Permita que os usuários visualizem OmniScripts em andamento que foram salvos para uso posterior usando as
páginas do Visualforce e o Vlocity Bancada de trabalho OmniScript .
Use páginas pré-criadas do Visualforce para contas e contatos, crie páginas personalizadas do Visualforce para
registros adicionais ou exiba todos os registros no Vlocity Bancada de trabalho OmniScript .

company
NOTA
Se um OmniScript for iniciado a partir do contexto de um registro de contato ou conta, você
poderá visualizar todos os OmniScripts em andamento ou concluídos para essa conta ou contato
específico na seção História do cliente .
Exibir instâncias de OmniScript salvas para contas e contatos

Adicione a página do Visualforce OmniScriptInstanceAccountPage fornecida ao layout da conta ou a
OmniScriptInstanceContactPage ao layout do contato .
Exibir instâncias de OmniScript salvas em páginas ObjectRecord

OmniScript salvas em uma página de registro de objeto criando uma página do Visualforce e adicionando o
componente ao layout do objeto.
1. Crie uma nova página do Visualforce.

2. Copie e cole o código a seguir em uma nova página do Visualforce.
< apex:página standardStylesheets ="false" showHeader ="true" standardController =" ObjectName "
extensions=" NS.VFPageControllerBase " sidebar="true" docType ="html-5.0" > <
NS:OmniScriptInstanceComponent standardController ="{! stdController }"/>
</ apex:página >

3. Substitua essas variáveis no código pelos valores apropriados:
• ObjectName Insira o nome da API do objeto padrão ou personalizado.
• NS : Insira o Namespace do pacote. Para obter mais informações, consulte Visualizando o namespace e a
versão do OmniStudio Pacote Vlocity .
Exibir todas as instâncias de OmniScript salvas
Visualize todas as instâncias de OmniScript salvas abrindo o Vlocity Bancada de trabalho OmniScript .
Para abrir o Vlocity Bancada de trabalho OmniScript :
1. Abra o inicializador de aplicativos Salesforce.

2. Clique em Vlocity Bancada de trabalho OmniScript .
Veja Também

company
Especificar um link de currículo em uma página do Visualforce
Os usuários podem criar uma página do VisualForce que especifica a URL personalizada usada para Salvar e
Continuar.
Crie um novo Visual ForcePage e insira o código abaixo. Substitua a variável FieldAPIName pelo Field API Name
especificado em Salvar padrões de URL . Para obter mais informações, consulte Configurar opções de salvamento .
< apex:página standardStylesheets ="false" showHeader ="true"

standardController ="Conta" extensions=" VFPageControllerBase " sidebar="true"
docType ="html-5.0" >
< c:OmniScriptInstanceComponent standardController ="{! stdController }"
resumeFieldName =" FieldAPIName "/> </ apex:page >
Veja também
Integrar o Salesforce Knowledge com OmniScript

Permita que os usuários pesquisem e visualizem artigos do Salesforce Knowledge ao usar um OmniScript . Configure
as opções de conhecimento do OmniScript para pesquisar artigos com base em valores estáticos e entradas
dinâmicas de campos OmniScript ou em uma consulta de uma barra de pesquisa simples.
IMPORTANTE
Sua organização deve ter o Salesforce Knowledge ativado para usar esse recurso.

company
Figura 2. Barra de pesquisa simples
A partir do OmniScript Designer Preview, você pode abrir o artigo em um novo console ou guia do navegador. Ou
você pode visualizar o artigo dentro da Etapa OmniScript ou em uma janela modal.
Figura 3. Artigo aberto no OmniScript como um bloco recolhível

company
Figura 4. Artigo aberto em uma janela modal
Configurar o OmniScript para funcionar com o Salesforce Knowledge

Integre o Salesforce Knowledge em seu OmniScript para permitir que os usuários pesquisem e visualizem artigos do
Salesforce Knowledge no OmniScript . OmniScript também apoia questionando Relâmpago Conhecimento .
Antes de começar
1. Ative o Salesforce Knowledge. Consulte Ativar o Salesforce Knowledge .

2. (Opcional) Ative o Lightning Knowledge. Consulte Ativar conhecimento de iluminação .
IMPORTANTE
Antes de ativar o Lightning Knowledge, consulte Limitações do Lightning Knowledge .
1. No painel Configuração, expanda a seção Opções de conhecimento e marque Ativar conhecimento .

2. (Opcional) Para integrar o Lightning Knowledge ao OmniScript, marque Usar o Lightning Knowledge .
Relâmpago O conhecimento deve ser ativado em sua organização.
3. (Opcional) Selecione Exibir fora do OmniScript para iniciar artigos da base de conhecimento fora de um
OmniScript usando o Vlocity Componente da base de conhecimento do OmniScript em uma página da
comunidade ou do Lightning. Para obter informações sobre como configurar essa opção, consulte Artigos da
Base de conhecimento aberta fora de um OmniScript .
4. Na seção Mapa de campos de consulta de tipo de artigo de conhecimento :
a. Em Nome da API do tipo de artigo/registro , insira o nome da API do tipo de artigo para o Classic
Knowledge ou insira o nome da API do tipo de registro quando usar o Lightning Knowledge estiver
ativado.

company
Nome da API do tipo de registro do Lightning Knowledge
b. Em Field API Name , insira o nome da API do campo a ser pesquisado, como Title . Para vários campos,
insira uma lista separada por vírgulas sem espaços, como Title, namespace__ richText __ c,Summary .
Relâmpago Nome da API do campo de conhecimento

company
5. Para consultar outros tipos de artigo ou registro, clique em + Adicionar novo mapa de campo de tipo de
conhecimento e repita a Etapa 4.
6. Se Usar Lightning Knowledge estiver ativado, insira o nome da API do objeto Lightning Knowledge no campo
Nome da API do objeto Lightning Knowledge , como namespace__Knowledge__ kav .
7. (Opcional) Em Rótulo , insira o texto exibido acima do componente Knowledge, como Artigos sugeridos .
Veja também
• Configurar conhecimento para etapas individuais no OmniScript
Configurar conhecimento para etapas individuais no OmniScript

Após a configuração inicial para configurar seu OmniScript para funcionar com o Salesforce Knowledge, integre o
Knowledge em suas etapas do OmniScript . Configure as opções em cada etapa para habilitar o Knowledge e filtrar
os resultados.
Antes de começar
Configure o OmniScript para funcionar com o Salesforce Knowledge, consulte Configurar o OmniScript para funcionar com o Salesforce Knowledge .
1. No OmniScripts Designer, clique na Etapa em que deseja exibir o componente Knowledge.

2. No painel Propriedades, expanda a seção Opções de conhecimento e clique em Ativar conhecimento .
3. Atualize o idioma do inglês padrão para o idioma de sua preferência.
4. Atualizar Status Público do padrão é Online para Arquivo ou Rascunho .
5. No campo Palavra -chave , insira o texto a ser pesquisado. Isso pode ser um texto literal, como Service
Disconnect . Ou você pode usar campos de mesclagem para dados variáveis. Por exemplo, digite % RouterType
% para permitir que seus usuários insiram palavras-chave para pesquisar em um elemento Text cujo Name seja
RouterType . Para obter informações sobre campos de mesclagem, consulte Acessar o JSON de dados do
OmniScript com campos de mesclagem .
6. Para filtrar artigos por categoria de dados , insira uma consulta SOQL no campo Critérios de categoria de dados
. Por exemplo, digite Troubleshooting__c AT ( Router__c ) para mostrar artigos da subcategoria Router na
categoria pai Troubleshooting . Para obter mais informações sobre como criar consultas para categorias de
dados, consulte Com expressão de filtragem de categoria de dados
NOTA
Você não precisa inserir WITH DATA CATEGORY em sua consulta.
7. (Opcional) Quando o Lightning Knowledge estiver ativado, para filtrar os tipos de registro consultados pela
Etapa, insira o nome da API do Tipo de registro no campo Filtro de tipo de registro . Para vários tipos de
registro, insira uma lista separada por vírgulas sem espaços, como FAQ,INFO .
Veja também
• Abrir artigos da base de conhecimento fora de um OmniScript
Abrir artigos da base de conhecimento fora de um OmniScript

company
Iniciar artigos da base de conhecimento fora de um OmniScript usando o Vlocity Componente da base de
conhecimento do OmniScript em uma página da comunidade ou do Lightning.
A Vlocidade O componente OmniScript Knowledge Base renderiza artigos da base de conhecimento lado a lado com
um
OmniScript ou como um componente autônomo. Ao abrir artigos da base de conhecimento de um OmniScript , o
OmniScript passa informações específicas para o componente para pesquisar a base de conhecimento e renderizar
artigos.
Antes de começar
1. Configure os campos que consultam a base de conhecimento. Consulte Configurar o OmniScript para funcionar com o Salesforce
Knowledge .
2. (Opcional) Defina as consultas da base de conhecimento no nível da etapa. Consulte Configurar conhecimento para etapas individuais no
OmniScript .
1. No painel Configuração do OmniScript , expanda Opções de conhecimento e selecione Ativar conhecimento .
2. Selecione Lightning Knowledge e configure os campos restantes usando as instruções em Configurar
OmniScript para funcionar com o Salesforce Knowledge .
3. Confirme se a opção Exibir fora do OmniScript está ativada.
4. (Opcional) Configure as opções de conhecimento no nível da etapa. Consulte Configurar conhecimento para
etapas individuais no OmniScript .
5. Implante o OmniScript clicando em Ativar versão .
6. Abra o Lightning App Builder e crie uma nova página com um layout contendo pelo menos duas regiões. Ver
Criador de aplicativo Lightning .
7. Na página do Lightning, arraste o componente LWC OmniScript implantado para a página. Consulte Adicionar
um OmniScript a uma comunidade ou página do Lightning .
8. Na seção Componentes, arraste o Vlocity componente OmniScript Knowledge Base para onde você deseja que
ele seja exibido.
9. No campo omniscriptKey , insira o nome do componente LWC OmniScript usando a sintaxe
type_SubType_Language .
10. (Opcional) No campo de layout , insira newport para renderizar o artigo da base de conhecimento com o estilo
do Newport Design System.
11. Salve a página do Lightning e teste o OmniScript na página do Lightning para visualizar o comportamento.
Veja Também
• Configurar o OmniScript para funcionar com o Salesforce Knowledge
Referência de propriedades de opções de conhecimento

As propriedades das Opções de conhecimento são configuráveis nos painéis Configuração e Propriedades no
OmniScript Designer. Ative o Knowledge em seu OmniScript para permitir que os usuários visualizem e pesquisem
artigos de seus artigos do Salesforce Knowledge. Ver Integrar o conhecimento do Salesforce com OmniScript .

company
Propriedade Definição
Permitir Conhecimento Integre o conhecimento do Salescorce com o OmniScript . Você deve ativar essa propriedade no painel Propriedades
para cada Etapa que exibe o componente Knowledge e no painel Configuração.
Painel de configuração
Essas propriedades são exclusivas da seção Opções de conhecimento no painel Configuração.
Exibição externa OmniScript Permite iniciar artigos da base de conhecimento fora de um OmniScript usando o Vlocity Componente
da base de conhecimento do OmniScript em uma página da comunidade ou do Lightning.
Usar Relâmpago Conhecimento Integra o Lightning Knowledge com OmniScript . O Lightning Knowledge deve estar ativado em sua
organização.
Nome da API do artigo/tipo de registro O nome da API do tipo de artigo para o Classic Knowledge ou o nome da API do tipo de registro quando
Usar o Lightning Knowledge está ativado.
Nome da API do campo O nome da API do campo a ser pesquisado, como Title . Para vários campos, insira uma lista separada
por vírgulas sem espaços, como Title, namespace__ richText __ c,Summary .
API de objeto do Lightning Knowledge Se Usar o Lightning Knowledge estiver ativado, insira o nome da API do objeto do Lightning Knowledge,
Nome como namespace__Knowledge__ kav .
Etiqueta O texto exibido acima do componente Knowledge, como Artigos sugeridos .
Painel de propriedades
Essas propriedades são exclusivas da seção Opções de conhecimento no painel Propriedades quando você seleciona
uma Etapa.
Linguagem Selecione o idioma para exibir os artigos.
Status público O tipo de artigo a ser exibido. Insira Online , Arquivado ou Rascunho .
Palavra-chave O texto a ser pesquisado. Isso pode ser um texto literal, como Service Disconnect . Ou insira campos
de mesclagem para dados variáveis. Por exemplo, insira % RouterType % para usar o valor de entrada
de um elemento Text cujo Name é RouterType .
Categoria de dados Critério Filtre os artigos do Knowledge por sua categoria de dados em uma consulta SOQL. Por exemplo, digite
Troubleshooting__c AT ( Router__c ) para mostrar artigos da subcategoria Router na categoria pai
Troubleshooting . A cláusula WITH DATA CATEGORY não é necessária na consulta.
Tipo de registro Filtro Se Usar Lightning Knowledge estiver ativado, insira o nome da API do Tipo de registro para filtrar os
tipos de registro consultados pela Etapa. Para vários tipos de registro, insira uma lista separada por
vírgulas sem espaços, como FAQ,INFO .
Veja Também
• Configurar o OmniScript para funcionar com o Salesforce Knowledge
• Abrir artigos da base de conhecimento fora de um OmniScript
Semear dados em um OmniScript

Preencha os campos OmniScript com dados ou adicione nós ocultos ao OmniScript Data JSON usando a propriedade
Seed Data JSON na seção Configuração do OmniScript .

company
A propriedade Seed Data JSON deve ser usada com valores estáticos que se propagam durante o carregamento
inicial do OmniScript . Para definir valores usando fórmulas ou com informações inseridas no OmniScript após o
carregamento inicial, consulte Definir valores em um OmniScript .
1. No OmniScript Setup , encontre a seção Seed Data JSON e clique em +Add New Key/Value Pair .
2. Insira o nome do elemento a ser preenchido previamente no campo de texto à esquerda. Insira o valor
desejado do elemento no campo de texto à direita. Se o elemento tiver várias respostas, como uma seleção
múltipla, você poderá preencher mais de um valor separando as entradas com um ponto e vírgula.
3. Quando o usuário inicia o script, os elementos especificados na seção Seed Data JSON contêm os valores
estáticos das Configurações de script.
4. Você também pode usar a propriedade Seed Data JSON para adicionar nós ocultos ao Data JSON do OmniScript
. Por exemplo, um OmniScript usado para solução de problemas pode criar um caso. Você pode usar os valo res
padrão de nós ocultos para pré-preencher os valores. Por exemplo, você pode querer que o OmniScript crie um
Case com Tipo, Status e Origem definidos no Data JSON do OmniScript . Usando esse método, você pode ter
vários OmniScripts associados a uma interface DataRaptor que cria o Case.
Veja Também
• Definir valores em um OmniScript
• Pré preenchimento OmniScript Elementos usando DataRaptor
Estrutura de mensagens
Comunique-se entre um OmniScript , janelas, componentes da Web do Lightning e elementos OmniScript usando
mensagens de postagem de janela, mensagens de armazenamento de sessão e mensagens PubSub .
Determine qual objeto ou componente precisa manipular e usar dados e use a propriedade correspondente desta
tabela:
Propriedade Descrição Objeto ou Exemplo
Componente
Janela postar Envie informações de um elemento para um objeto de Janela objeto Mensagem com postagem na
mensagem janela em pares chave-valor. janela
Mensagens e Sessão
Armazenar Mensagens
Pub/Sub Comunique-se com o OmniScript a partir de um LWC Web relâmpago Comunicar com
personalizado enviando pares de valores-chave. Use os Componentes OmniScript de um Lightning
eventos passados nos pares chave-valor para acionar o Componente da Web
comportamento personalizado em um componente.
Sessão Armazenar Envie informações para um objeto de armazenamento de Sessão Armazenar Mensagem com postagem na
sessão usando pares de chave-valor. Um objeto de objeto janela
armazenamento de sessão é limpo quando uma sessão Mensagens e Sessão
de página termina. Armazenar Mensagens
Para obter informações sobre a comunicação com um LWC a partir de um LWC OmniScript incorporado , consulte
Incorporar um componente da Web OmniScript do Lightning em um componente da Web do Lightning .
Veja Também

company
• Incorporar um componente Web OmniScript Lightning em um componente Web Lightning
• Fazer chamadas remotas de componentes da Web do Lightning usando o OmniScript Action Framework
Ativar SEO para OmniScripts

Faça os OmniScripts nas Comunidades aparecerem em pesquisas online ativando o SEO.
SEO OmniScripts armazenam o estado de um OmniScript na URL definindo o parâmetro c__step para o nome de
uma etapa ativa automaticamente. Direcione os usuários para uma etapa específica no OmniScript definindo o
parâmetro c__step em URLs de SEO para um nome de etapa no OmniScript . A atualização da página não faz com
que o OmniScript comece na primeira etapa porque a etapa é armazenada no parâmetro c__step . Inclua
parâmetros adicionais para armazenar o estado dos elementos, inserir dados no JSON de dados do OmniScript , pré-
preencher elementos ou disparar ações do OmniScript condicionalmente . Armazenar o estado permite que um
usuário navegue para as etapas anteriores ou seguintes usando os botões Voltar e Avançar do navegador.
NOTA
SEO é desabilitado automaticamente ao executar OmniScripts Inline . Consulte Exibir OmniScripts
Inline em páginas do Lightning e da comunidade .
NOTA
É possível criar OmniScripts que armazenam o estado no parâmetro c__step sem usar o OmniScript
para fins de SEO. Ver Crio Stateful OmniScript .
Antes de começar
1. Configure o SEO para sua comunidade (Documentação do Salesforce).

2. Revise as práticas recomendadas e considerações de SEO para usuários convidados (documentação do
Salesforce).
1. Na seção Configuração do OmniScript , marque Ativar SEO . O OmniScript adiciona automaticamente o
parâmetro c__step para armazenar o estado de uma Etapa.

company
2. (Opcional) Armazene o estado dos elementos em seu OmniScript , preencha previamente os elementos ou
passe dados para o JSON de dados do OmniScript usando Parâmetros de URL de SEO adicionais.
a. No campo Parâmetros adicionais de URL de SEO , insira um parâmetro com o prefixo c__ . Ao armazenar o
estado de um elemento ou pré-preencher um elemento, use o nome do elemento como seu parâmetro.
Por exemplo, o parâmetro para um elemento chamado Text1 é c__Text1 .
b. Defina o parâmetro igual a um elemento no OmniScript usando a sintaxe do campo de mesclagem ou um
valor estático. Se houver mais de um parâmetro presente, separe os parâmetros com um símbolo & .
Consulte Acessar o JSON de dados do OmniScript com campos de mesclagem . Por exemplo, para
armazenar o estado do elemento Text1, defina o parâmetro c__Text1 igual a %Text1% .
3. Ative o OmniScript e adicione-o a uma comunidade. Consulte Adicionar um OmniScript a uma comunidade ou
página do Lightning .
4. Conceda acesso de usuário convidado em sua comunidade.

company
5. Adicione o URL do OmniScript ao arquivo sitemap.xml da comunidade. Consulte Configurar SEO para sua
comunidade .
6. Use um mecanismo de pesquisa, como o Google, para testar a funcionalidade de SEO.
7. (Opcional) Teste a navegação para frente e para trás do OmniScript usando os botões de avançar e voltar de um
navegador.
Veja Também
• Crio Stateful OmniScripts
Crio Stateful OmniScripts

Habilite o LWC OmniScripts para armazenar o estado de um OmniScript na URL.
Os OmniScripts armazenam o estado de um OmniScript na URL definindo o parâmetro c__step para o nome de uma
Etapa ativa automaticamente. Direcione os usuários para uma etapa específica no OmniScript definindo o parâmetro
c__Step na URL para um nome de etapa no OmniScript . Atualizar a página não faz com que o
OmniScript para começar na primeira etapa porque a Etapa é armazenada no parâmetro c__step . Inclua parâmetros
adicionais para armazenar o estado dos elementos, inserir dados no JSON de dados do OmniScript , pré -preencher
elementos ou disparar ações do OmniScript condicionalmente . Armazenar o estado permite que um usuário
navegue para as etapas anteriores ou seguintes usando os botões Voltar e Avançar do navegador.
NOTA
Para fazer com que um LWC com estado apareça em pesquisas online, consulte Habilitar SEO para
OmniScripts .
1. Na seção Configuração do OmniScript , marque Ativar SEO . O OmniScript adiciona automaticamente o

parâmetro c__step para armazenar o estado de uma Etapa.

company
2. (Opcional) Armazene o estado dos elementos em seu OmniScript , preencha previamente os elementos ou
passe dados para o JSON de dados do OmniScript usando Parâmetros de URL de SEO adicionais.
a. No campo Parâmetros adicionais de URL de SEO , insira um parâmetro com o prefixo c__ . Ao armazenar o
estado de um elemento ou pré-preencher um elemento, use o nome do elemento como seu parâmetro.
Por exemplo, o parâmetro para um elemento chamado Text1 é c__Text1 .
b. Defina o parâmetro igual a um elemento no OmniScript usando a sintaxe do campo de mesclagem ou um
valor estático. Se houver mais de um parâmetro presente, separe os parâmetros com um símbolo & .
Consulte Acessar o JSON de dados do OmniScript com campos de mesclagem . Por exemplo, para
armazenar o estado do elemento Text1, defina o parâmetro c__Text1 igual a %Text1% .
3. Ative o OmniScript e adicione-o a uma página do Lightning ou da comunidade. Consulte Adicionar um

OmniScript a uma comunidade ou página do Lightning .
4. (Opcional) Teste a navegação para frente e para trás do OmniScript usando os botões de avançar e voltar de um
navegador.

company
Veja Também
• Salvar e retomar um OmniScript
Personalizar OmniScript Erro Mensagens

O manipulador de mensagens de erro permite substituir mensagens de erro padrão de chamadas remotas do apex
por mensagens de erro mais amigáveis quando ocorrem erros no OmniScript . A propriedade do manipulador de
mensagens de erro está disponível em elementos de arquivo, elementos de imagem, todos os elementos de ação e
configuração.
NOTA
As mensagens de erro definidas nas propriedades de configuração se aplicam a qualquer erro
correspondente retornado por um elemento, enquanto as mensagens de erro definidas nas
propriedades de uma ação são renderizadas apenas para essa ação.
Erro Mensagem Descrição
Modelo
Erro padrão Uma mensagem padrão que retorna quando nenhuma mensagem de erro personalizada é correspondida ou definida. A
Mensagem propriedade Mensagem de Erro Padrão não está disponível na Instalação.
Erro Mensagem Descrição
Modelo
Personalizado Erro Mensagens que são retornadas com base no caminho e valor definidos. As mensagens de erro personalizadas são
Mensagens configuradas usando os seguintes campos:
• Caminho : um caminho de campo de mesclagem que localiza o valor padrão original dentro de um objeto de erro.
• Valor : A mensagem de erro original, incluindo espaços, que será substituída pelo texto definido no campo Mensagem.
este o valor deve corresponder ao erro original exatamente .
• Mensagem : A mensagem personalizada que substituirá o texto de erro definido no campo Valor.
Definir a mensagem de erro padrão em um elemento OmniScript

Substitua uma mensagem de erro padrão por uma mensagem de erro amigável quando ocorrer um erro de chamada
remota do apex em seu OmniScript . Uma mensagem padrão é retornada quando ne nhuma mensagem de erro
personalizada é correspondida ou definida. Atualize as mensagens de erro padrão para elementos Image, Action e
File.
Antes de começar
Antes de configurar as mensagens de erro , visualize os erros para determinar seu formato.
1. Abra a propriedade Error Messages no elemento que renderiza o erro.

2. No campo Mensagem de erro padrão , insira sua mensagem personalizada.
3. Visualize o erro para garantir que a mensagem seja renderizada.
Veja Também
• Definir uma mensagem de erro personalizada que retorna como um objeto
• Definir uma mensagem de erro personalizada que retorna como uma string

company
Definir uma mensagem de erro personalizada que retorna como um objeto
Defina uma mensagem de erro personalizada para um erro que retorna como um objeto. Uma Mensagem de Erro
Personalizada é retornada com base em um caminho e valor definidos. Defina mensagens de erro personalizadas
para elementos de arquivo, elementos de imagem, todos os elementos de ação e configuração.
Antes de começar
1. Execute o OmniScript para encontrar o erro.

2. Determine o caminho para o erro. Por exemplo, o caminho para errorCode no seguinte erro
[{" errorCode ":" NOT_FOUND","message":"O recurso solicitado não existe"}] é 0 : errorCode .
3. Copie o texto da mensagem de erro que segue o caminho. Por exemplo, o texto da mensagem de erro para
errorCode no seguinte erro: [{" errorCode ":" NOT_FOUND","message":"O recurso solicitado não existe"}] é
NOT_FOUND .
4. Abra a propriedade Error Messages no Action Element que está renderizando o erro.
5. No campo Caminho , insira o caminho determinado pela Etapa 2.
6. No campo Valor , cole o erro original.
7. No campo Mensagem , insira sua mensagem personalizada.
8. Teste para garantir que a mensagem está sendo substituída.
Veja Também
• Definir uma mensagem de erro personalizada que retorna como uma string
• Definir a mensagem de erro padrão em um elemento OmniScript
Definir uma mensagem de erro personalizada que retorna como uma string
Defina uma mensagem de erro personalizada para um erro que retorna como uma string. Uma Mensagem de Erro
Personalizada é retornada com base em um caminho e valor definidos. Defina mensagens de erro personalizadas
para elementos de arquivo, elementos de imagem, todos os elementos de ação e configuração.
Antes de começar
1. Execute o OmniScript para encontrar o erro.

2. Copie o texto após os dois pontos após a palavra Error.
3. Abra a propriedade Error Messages no Action Element que está renderizando o erro.
4. No campo Valor , cole o erro original.
5. No campo Mensagem , insira sua mensagem personalizada.
6. Teste para garantir que a mensagem está sendo substituída.
Veja Também
• Definir a mensagem de erro padrão em um elemento OmniScript
• Definir uma mensagem de erro personalizada que retorna como um objeto

company
elemento OmniScript
Este guia contém explicações dos diferentes elementos que podem ser adicionados a um OmniScript . Cada
elemento usa um extensível Componente da Web do Lightning .
• Bloco de Ação (veja Bloco de Ação )

• Agregados (consulte Criando uma Fórmula ou Agregado em um OmniScript )
• Blocos
• Caixa de seleção (consulte Componentes de entrada do OmniScript )
• Moeda (consulte Componentes de entrada do OmniScript )
• LWC personalizado (consulte Elemento LWC personalizado )
• DataRaptor Extrair Ação
• Ação de postagem do DataRaptor
• DataRaptor Transformar Ação
• DataRaptor Turbo Action
• Data (consulte Componentes de entrada do OmniScript )
• Data/hora (local) (consulte Componentes de entrada do OmniScript )
• Excluir ação (consulte Excluir ação )
• Divulgação (consulte Componentes de entrada do OmniScript )
• Ação de envelope do DocuSign (consulte Preparando documentos do DocuSign )
• Ação de assinatura do DocuSign (consulte Preparando documentos do DocuSign )
• Editar bloco (consulte Usando blocos de edição do OmniScript )
• E-mail
• mail (consulte Ação de e-mail do OmniScript )
• Arquivo (consulte Adicionando um componente de arquivo à estrutura de um OmniScript )
• Fórmulas (consulte Criando campos de fórmula em um OmniScript )
• Título (consulte Componentes de exibição do OmniScript )
• Ação HTTP
• Imagem (consulte Componentes de exibição do OmniScript )
• Ação do procedimento de integração (consulte Ação do procedimento de integração do OmniScript )
• Quebra de linha (consulte Componentes de exibição do OmniScript )
• Lookup (consulte Trabalhando com configurações de consulta de pesquisa )
• Seleção múltipla (consulte Componentes de entrada do OmniScript )
• Ação de Navegação (consulte Ação de Navegação )
• Número (consulte Componentes de entrada do OmniScript )
• OmniScript (consulte Componentes de ação do OmniScript )
• Senha (consulte Componentes de entrada do OmniScript )
• Ação de PDF ( consulte Adicionando uma ação de PDF ao OmniScript )

company
• Rádio (consulte Componentes de entrada OmniScript )
• Grupo de rádio (consulte Componente do grupo OmniScript )
• Intervalo (consulte Componentes de entrada do OmniScript )
• Ação remota (consulte Ação remota do OmniScript )
• Ação de descanso (consulte Ação HTTP )
• Selecione (consulte OmniScripts Select Element )
• Definir erros (consulte Configurando erros em um OmniScript )
• Definir valores (consulte Definir valores em um OmniScript )
• Assinatura (consulte Componentes de entrada do OmniScript )
• Etapa
• Telefone (consulte Componentes de entrada do OmniScript )
• Texto (consulte Componentes de entrada do OmniScript )
• Área de texto (consulte Componentes de entrada do OmniScript )
• Bloco de texto (consulte Componentes de entrada do OmniScript )
• Tempo (consulte Componentes de entrada do OmniScript )
• Bloco de digitação antecipada (consulte Adicionando um bloco de digitação antecipada )
• URL (consulte Elemento de URL OmniScripts )
comuns de propriedades do elemento OmniScript

Cada elemento também inclui um conjunto de propriedades extensível específico para o tipo de elemento. Use o
painel Propriedades no Designer para editar essas propriedades. Algumas propriedades de elementos comuns não
estão disponíveis em determinados elementos.
Adicionar Doença Adicione condições de teste adicionais à Visualização Condicional de um elemento. Exibir condicionalmente
Elementos usando a
propriedade de exibição
condicional .
Adicionar Grupo Condições de grupo para criar expressões complexas. Um grupo permite que um n/D
conjunto de condicionais tenha um operador AND/OR separado. Por exemplo, pode
haver dois grupos com OR juntos, mas dentro de cada grupo pode haver um AND para
garantir que os testes do grupo sejam verdadeiros.
Disponível para O JSON de dados pode preencher previamente o elemento quando ele estiver oculto por n/D
Preencher quando uma condicional.
Escondido
Condicional Visão Se as condições neste campo forem atendidas, o elemento será exibido, se tornará editável Exibir condicionalmente
ou será marcado como obrigatório. O valor campo suporta a sintaxe de mesclagem . Elementos usando a
propriedade de exibição
condicional .

company
Condicional Modelo Os tipos de condição determinam se o elemento é exibido, desabilita somente leitura ou Exibir condicionalmente
se torna necessário quando as condições são avaliadas como verdadeiras. Elementos usando o
Visualização Condicional
Propriedade
Ao controle Largura Exibe a largura do controle na página, usando um intervalo de 1 a 12. n/D
Valor padrão : Define um valor padrão para o elemento. Se o elemento tiver sido preenchido com um Definir um valor padrão
valor, ele não será substituído pelo valor padrão. Suporta sintaxe de mesclagem . para um elemento
Elemento Nome O identificador exclusivo do elemento. Os nomes dos elementos não podem conter espaços n/D
e devem ser exclusivos em um OmniScript .
Largura do Campo Exibido se a caixa de seleção Rótulo fora do campo estiver marcada. Especifica a largura n/D
do campo de entrada separada da Largura do controle. Útil se o rótulo for maior que a
entrada esperada.
Texto de ajuda O texto exibido quando o usuário passa o mouse sobre o ícone de ajuda. n/D
Ajuda Determina se um ícone de ajuda é exibido ao usuário. n/D
Etiqueta fora do Para componentes de entrada, especifica se o rótulo é exibido fora do campo. Válido só n/D
campo quando usando a Experiência Relâmpago .
Etiqueta Rótulo de exibição para o controle. n/D
mascarar Define o formato para entrada do usuário, por exemplo, (999)999-9999. n/D
Máximo Comprimento Número máximo de caracteres que o usuário pode inserir. n/D
Mínimo Comprimento Número mínimo de caracteres que o usuário pode inserir. n/D
Opções Uma matriz de seleções de entrada para controles suspensos, de seleção múltipla e de botão n/D
de opção.
Padrão Erro Texto Mensagem exibida se a entrada não corresponder à expressão. n/D
Padrão O sinalizador de padrão é usado para impor a validação de dados antes do envio. Expressões Regulares
Atualmente, padrões complexos não são suportados, mas a correspondência de padrões
simples funciona. Os padrões aceitam expressões regulares (regex) e texto de erro
personalizado.
Espaço reservado Exibe o texto do espaço reservado em campos vazios. O texto do espaço reservado não é n/D
aplicável se o mascaramento estiver ativado.
Somente leitura Se true, o usuário não poderá modificar o valor no campo. n/D
Repetir Se true para um elemento ou bloco, um usuário pode clicar em + para copiar o elemento ou Pré preenchimento
blocos de elementos no formulário. Repetivel
Blocos
Repetir clone Se true, quaisquer valores do elemento ou bloco de elementos são copiados para instâncias n/D
repetidas do elemento ou bloco.
Repetir Limite Especifica o número de vezes que este elemento pode ser repetido. Por exemplo, para n/D
definir um máximo de duas repetições, defina o Limite de repetição para 1.
Requeridos Especifica se o usuário deve inserir um valor para enviar o formulário. n/D

company
Mostrar/ Ocultar Determina se várias condições devem ser atendidas para renderizar um SO. Quando n/D
Operador definido como Todas as condições são atendidas , um operador AND verifica se todas as
condições são válidas. Quando definido como Qualquer condição é atendida , um
operador OR verifica se alguma das condições é válida.
OmniScript Ação Elementos

Esta página contém uma tabela que explica os elementos OmniScript disponíveis listados na seção Ações.
Elemento Elemento Descrição Referência
Nome
DataRaptor O elemento DataRaptor Extract Action faz uma chamada de DataRaptor Extrair Ação
Extrair Ação saída DataRaptor para preencher um OmniScript com dados
de objetos SFDC. Insere o nome da interface DataRaptor e
parâmetros de entrada .
DataRaptor A Ação Post do DataRaptor confirma dados de Ação de postagem do DataRaptor

Postar ação Objetos OmniScript para SFDC. Insere o nome da Interface
DataRaptor , Data JSON do OmniScript e filesMap .
DataRaptor A ação de transformação do Data Raptor envia o JSON de OmniScript DataRaptor Transformar
Transformar dados OmniScript completo para o DataRaptor e retorna Ação
Ação o mapeamento do DataRaptor .
Excluir Exclui registros especificados de um sObject . Os objetos Se o JSON de dados contiver uma lista de
são especificados por ID, e a prática recomendada é usar contas como esta:
um campo de mesclagem para fazer referência a um ID ou
a uma lista de IDs nos dados {
JSON. "Conta": [
{ " accId ":
["001f400000EPQ8o",
"001f400000BAkbn"]
}
]
}
Você pode excluí-lo especificando o seguinte

campo de mesclagem no campo Path to Id : %
Account:accId %
Para especificar as mensagens a serem

exibidas aos usuários quando a operação for
bem-sucedida ou falhar, defina os campos
correspondentes na seção Mensagens de
erro.
DocuSign O elemento DocuSign Envelope Action envia um email Usando a ação de envelope do DocuSign para
Envelope que contém os documentos pré-preenchidos para E-mail Documentos para assinatura
Ação assinatura ou revisão. Pode _ ser enviado para 1 ou mais
destinatários .
DocuSign O elemento DocuSign Signature Action exibe um modal Usando a ação de assinatura do DocuSign para
Assinatura contendo um documento DocuSign. O usuário do Assine documentos de dentro de um
Ação OmniScript pode assinar o documento diretamente do OmniScript
modal e baixar um PDF do documento assinado.
Elemento Elemento Descrição Referência

Nome

company
E-mail Ação A ação de email usa a API de email do Salesforce para OmniScript E-mail Ação
enviar um modelo de email para o endereço de email de
um usuário, lead ou contato ou enviar um corpo de
email definido na configuração da ação para qualquer
endereço de email.
Integração O elemento Integration Procedure Action permite que várias Procedimentos de Integração
Procedimento ações sejam executadas como um serviço headless
Ação (sem uma interface do usuário) por meio de JavaScript ou
Apex Service.
Navegar Navegue para outra página ou componente usando a ação de Navegar Ação
Ação navegação.
Ação PDF O elemento PDF Action insere Data JSON para DataRaptor Adicionar uma ação de PDF ao OmniScript
Transform. Ele retorna um PDF preenchido com base
sobre OmniScript elementos .
Ação Remota O elemento Remote Action chama uma classe do Apex que Ação Remota OmniScript
implementa VlocityOpenInterface . Dados de entrada JSON
de a OmniScript .
Ação HTTP A Ação HTTP chama uma API HTTP que permite Apex, Ação HTTP
Credenciais Nomeadas, SOAP/XML ou Web.
Entradas de dados JSON do OmniScript .
Definir erros O elemento Set Errors trata de falhas de usuários do Definir erros em um OmniScript
OmniScript .
Definir valores Definir valores lida com valores de elementos em um nó Definir valores em um OmniScript
oculto, etapa atual ou futura.
Ação comum Elemento Propriedades

Os elementos de ação podem ser renderizados como um botão quando colocados em uma Etapa ou Bloco ou
executados remotamente se colocados entre as etapas. Em ambos os casos, você pode especificar uma página de
redirecionamento, onde o usuário pode prosseguir para a próxima Etapa ou Ação ou, se for um botão, voltar para a
Etapa de origem.

company
Invocar Modo Configure o comportamento de resposta da ação. n/D
Padrão : A ação bloqueia a interface do usuário com um controle giratório de carregamento.
Non-Blocking : A ação é executada de forma assíncrona e a resposta é aplicada à interface do

usuário. Não há suporte para transformações pré e pós DataRaptor e anexos grandes.
Fire and Forge t: A ação é executada de forma assíncrona sem retorno de chamada para a
interface do usuário. Não há suporte para transformações pré e pós DataRaptor e anexos grandes.
Uma resposta ainda aparecerá no console de depuração, mas não será aplicada ao Data JSON.
Condicional Visão Todos os elementos Action suportam a visualização condicional. Condicionalmente
Exibição
Elementos
Usando o
Condicional
Visão
Propriedade
Pub/Sub Comunique-se com o OmniScript a partir de um LWC personalizado enviando pares de valores - Comunique-se
Etiqueta chave. Use os eventos passados nos pares chave
O rótulo do botão ou, se estiver sendo executado -valor para acionar
remotamente, o comportamento
o título do bloco de ação. comn/DOmniScript a
personalizado em um componente. partir de um
Nome da página de redirecionamento Nome da página de redirecionamento personalizado. Após o sucesso, o script navega para esta página. Relâmpago
n/D
Sair em branco para desviar a redirecionar página . Rede
Componente
Redirecionar URL do modelo Modelo HTML da página de redirecionamento. O Vlocity fornece modelos para páginas de n/D
redirecionamento ou você pode criar seus próprios.
Sessão Armazenar Envie informações para um objeto de armazenamento de sessão usando pares de chave -valor. Um Mensagem com
Validação Requeridos objeto de armazenamento
Determina se a validação éde sessão éno
executada limpo quando
script ou na uma
Etapasessão
antes de
quepágina
a Açãotermina.
seja invocada. Mensagens
n/D de
Selecione Enviar para validar todo o script ou Etapa para validar apenas a Etapa em que o botão está postagem da
ativado. Quando definido como Etapa , a Ação poderá ser clicada assim que todos os campos janela e
obrigatórios na Etapa contiverem uma entrada válida. Selecionar Nenhum para desviar validação . armazenamento
de sessão
Mensagens
Mensagem de postagem da janela Envie informações de um elemento para um objeto de janela em pares chave -valor. Mensagem com
Mensagens de
postagem da
janela e
armazenamento
de sessão
Mensagens
Categoria de negócios de rastreamento Defina uma categoria de negócios para uma entrada de rastreamento. Por exemplo , comércio Permitir
eletrônico . Rastreamento
para
OmniStudio
Componentes
Acompanhamento de evento de negócios Defina um evento de rastreamento de negócios para uma entrada de rastreamento. Por exemplo , Permitir
Pagamento Plano . Rastreamento
para
OmniStudio
Componentes
Propriedades de ação comum

Propriedades da mensagem do usuário

company
As ações executadas remotamente e entre etapas, ou antes da execução da primeira etapa, contêm essas
propriedades de mensagem do usuário.
Permitir Ação Mensagem Habilita uma entrada de mensagens de ação personalizadas.
Ativar cancelamento padrão Habilita a funcionalidade Abortar para substituir a funcionalidade Go Back padrão. Os usuários só poderão abortar o
OmniScript se a ação falhar.
Falha PróximoEtiqueta Rótulo do botão continuar se a ação falhar e a caixa de seleção Ativar interrupção padrão estiver marcada.
Falha Abortar Etiqueta Rótulo do botão abortar se a ação falhar e a caixa de seleção Enable Default Abort estiver marcada.
Falha Abortar Mensagem Mensagem de confirmação exibida após o usuário clicar no botão abortar.
Rótulo de retorno de falha Rótulo do botão Voltar se a Ação falhar. O comportamento padrão permite que os usuários retornem à etapa anterior, a
menos que não haja etapas anteriores ou a caixa de seleção Ativar interrupção padrão tenha sido marcada.
Em andamento Mensagem : Mensagem exibida enquanto a Ação está sendo executada. Esta propriedade é exclusiva de OmniScripts Angular .
Postar mensagem Mensagem exibido sobre sucesso .
Redirecionar próximo rótulo Rótulo do próximo botão na página de redirecionamento.
Redirecionar a próxima largura Largura do próximo botão na página de redirecionamento.
Validação Requeridos Se a validação do script deve ser verificada antes que a ação seja invocada. O padrão é Enviar . Sair em branco para
desviar validação .
Redirecionar Propriedades
As ações que são colocadas em Etapas e renderizadas como botões contêm esses elementos comuns.
Ao controle Largura Controla a largura do botão.
Redirecionar Anterior Etiqueta O rótulo do botão anterior na página de redirecionamento.
Redirecionar Anterior Largura A largura do botão anterior na página de redirecionamento.
Transformações de envio e resposta

As transformações de envio e resposta são propriedades disponíveis em uma variedade de ações remotas do
OmniScript . Eles fornecem flexibilidade para aparar e reparentar o JSON de solicitação e resposta. Para obter mais
informações sobre como usar as transformações de envio e resposta, consulte Manipulando JSON com a
propriedade de transformações de envio e resposta .
Enviar caminho JSON Essa propriedade permite que um nó do JSON de dados OmniScript seja enviado, em vez de todo o JSON. Especificamos
o nome do nó neste propriedade .
Enviar nó JSON Essa propriedade permite especificar o nome do nó raiz na resposta de saída. Por exemplo, se o OmniScript tiver um nó
Customer na raiz, você poderá rotular o nó novamente para CustomerAccount .

company
Pré-transformação DataRaptor Em situações em que uma transformação mais completa do JSON é necessária, você pode especificar uma interface de
transformação DataRaptor . O serviço será executado no servidor e, em seguida, retornará o corpo da solicitação ao
cliente para envio.
Pós- Transformação DataRaptor Funciona de forma idêntica ao Pre-Transform, exceto que a transformação é aplicada ao corpo da resposta antes de
mesclar no Data JSON.
Caminho JSON de resposta Essa propriedade permite aparar o JSON de entrada. Por exemplo, se a resposta tiver uma hierarquia de três níveis e você
quiser apenas um dos nós, poderá especificar o caminho que deseja extrair. A sintaxe é node:node:node ( separado por
dois pontos ).
Nó JSON de resposta Essa propriedade permite que você repense o JSON de entrada para um nó dentro do OmniScript JSON. Especifique o
nome do elemento OmniScript que será o novo nó raiz para o JSON de resposta.
Selecionando um modo de invocação

Permita que as ações sejam executadas de forma assíncrona, impeça os usuários de avançar para uma etapa futura e
modifique selecionando um modo de invocação.
Invoke Mode permite configurar o comportamento de resposta de uma ação.
Disponível em:
• Ação Remota
• Ação do Procedimento de Integração
Predefinição A ação bloqueia a interface do usuário com um controle giratório de carregamento.
Sem bloqueio A ação é executada de forma assíncrona e a resposta é aplicada à interface do usuário. Não há suporte para transformações
pré e pós DataRaptor e anexos grandes.
Incêndio e Esquecer A ação é executada de forma assíncrona sem retorno de chamada para a interface do usuário. Não há suporte para
transformações pré e pós DataRaptor e anexos grandes. Uma resposta ainda aparecerá no console de depuração, mas não
será aplicada aos dados
JSON.
Carga extra
ExtraPayload é uma propriedade adicional disponível para as ações listadas abaixo. O configurador de script pode
configurar uma carga extra a ser enviada ao fazer a chamada. este propriedade suporta campos de mesclagem .
• Ação Remota
• Ação HTTP
Veja Também
• Adicionar um Ação Mensagem
• OmniScript comum Elemento Propriedades Definições
• Manipular JSON com as propriedades de transformação de envio/resposta

company
Adicionar uma mensagem de ação
Exiba uma mensagem de ação abaixo do controle giratório de carregamento enquanto a ação estiver em execução.
1. Em uma Ação, expanda a propriedade Mensagens do Usuário.

2. Verificar Permitir Ação Mensagem .
3. Em Action Message , insira uma mensagem personalizada ou deixe a mensagem padrão.
Estrutura de mensagens
Comunique-se entre um OmniScript , janelas, componentes da Web do Lightning e elementos OmniScript usando
mensagens de postagem de janela, mensagens de armazenamento de sessão e mensagens PubSub .
Determine qual objeto ou componente precisa manipular e usar dados e use a propriedade correspondente desta
tabela:
Propriedade Descrição Objeto ou Exemplo
Componente
Janela postar Envie informações de um elemento para um objeto de Janela objeto Mensagem com postagem na
mensagem janela em pares chave-valor. janela
Mensagens e Sessão
Armazenar Mensagens
Pub/Sub Comunique-se com o OmniScript a partir de um LWC Web relâmpago Comunicar com
personalizado enviando pares de valores-chave. Use os Componentes OmniScript de um Lightning
eventos passados nos pares chave-valor para acionar o Componente da Web
comportamento personalizado em um componente.
Sessão Armazenar Envie informações para um objeto de armazenamento de Sessão Armazenar Mensagem com postagem na
sessão usando pares de chave-valor. Um objeto de objeto janela
armazenamento de sessão é limpo quando uma sessão Mensagens e Sessão
de página termina. Armazenar Mensagens
Para obter informações sobre a comunicação com um LWC a partir de um LWC OmniScript incorporado , consulte
Incorporar um componente da Web OmniScript do Lightning em um componente da Web do Lightning .
Veja Também
• Fazer chamadas remotas de componentes da Web do Lightning usando o OmniScript Action Framework
Comunicar-se com OmniScript a partir de um componente Web do Lightning

Envie dados de ações e etapas do OmniScript para outros LWCs usando a propriedade Pub/Sub.
A propriedade Pub/Sub permite que os elementos Action e Step enviem dados em pares de chave-valor para outros
LWCs. Os LWCs devem registrar o nome do evento do componente OmniScript e adicionar código para manipular os
dados enviados do evento.
Antes de começar
Revise a documentação do Salesforce sobre como usar PubSub . Ver Comunicar Entre Componentes .
1. Em uma ação ou etapa do OmniScript , selecione o Messaging Framework e marque Pub/Sub .

company
2. Nos campos Chave e Valor, configure quais dados passar para outro LWC.
a. No campo Chave , insira um nome para armazenar o valor.
b. No campo Valor , insira os dados a serem transmitidos ao LWC. O campo aceita a sintaxe de mesclagem.
Ação Exemplo Etapa Exemplo
Passe os dados da resposta da ação no campo de valor usando a sintaxe Passe dados de um elemento dentro da Etapa usando a
de mesclagem. Por exemplo, para passar o nó de resposta " accountId " sintaxe de mesclagem. Por exemplo, para passar um
, insira % accountId % no campo Valor . elemento Text chamado Text1 , insira %Text1% no campo
Valor .
3. Ativar a OmniScript .
4. Em um LWC que recebe dados da Ação ou Etapa, importe o módulo pubsub . Usando este exemplo, substitua
ns pelo namespace do seu pacote Vlocity . Consulte Visualizando o namespace e a versão do OmniStudio
Pacote Vlocity .
importar pubsub de 'ns/ pubsub ';

5. No LWC, registre o evento pubsub . O evento deve ser registrado após a renderização do componente.
Ação pubsub Evento Etapa pubsub Evento
pubsub.register (' omniscript_action ', { data: pubsub.register (' omniscript_step ', {

this.handleOmniAction.bind (this), data: this.handleOmniStepLoadData.bin d (this),
}); });
6. No LWC, crie um manipulador de eventos pubsub .

Ação Evento Manipulador Exemplo Etapa Evento Manipulador Exemplo
handleOmniAction (dados) { handleOmniStepLoadData (dados) {

// executa a lógica para lidar com a ação // executa a lógica para lidar com os dados do pubsub de
dados de resposta a Etapa
} }
7. (Opcional) Se ações ou etapas diferentes exigirem uma lógica diferente no código, use uma instrução switch
para determinar como lidar com o evento. Para informações em instruções switch , veja mudar .
Ação Exemplo Etapa Exemplo

company
Acesse o nome do elemento da ação usando data.name . Acesse o nome do elemento da etapa usando data.name .
handleOmniAction (data) { switch(data.name) { case ' handleOmniStepLoadData (dados) {

SomeNameForAction ': this.handleSomeNameForAction switch(data.name) { case ' FirstStep
(data); ':
parar; case 'SomeNameForAction2':
this.handleSomeNameForAction2(d ata); this.handleOmniFirstStepLoadData (dados);
parar; predefinição: parar; case ' Segundo Passo ':
// trata o caso padrão
}
} this.handleOmniSecondStepLoadData (dados);
parar; predefinição:
handleSomeNameForAction (dados) { // trata o caso padrão
// executa alguma lógica específica para }
Ação SomeNameForAction }
// que tem nome do elemento =
handleOmniFirstStepLoadData (dados) {
" SomeNameForAction "
} // executa alguma lógica específica quando um
Elemento de etapa cujo nome é
handleSomeNameForAction2(data) { // FirstStep é carregado
Ação SomeNameForAction2
// que tem nome do elemento = handleOmniSecondStepLoadData (dados) {
"SomeNameForAction2" // executa alguma lógica específica quando um
} Elemento de etapa cujo nome é
// SecondStep é carregado
}
Acesse o Tipo de Elemento da Ação usando data.type . n/D
handleOmniAction (data) { switch( data.type ) { case

'Ação do procedimento de integração':
this.handleIPActionPubsubEvents (dados);
parar; case 'Ação Remota': this.handleRemoteActionPubsubEvents
(dados);
}
}
handleIPActionPubsubEvents (dados) {
// executa alguma lógica específica para
Ações do Procedimento de Integração
}
handleRemoteActionPubsubEvents (dados) {
// executa alguma lógica específica para Remote
Ações
}
Veja Também
• Mensagem com mensagens de postagem de janela e mensagens de armazenamento de sessão
• Criar um componente Web do Lightning personalizado para OmniScript

company
Mensagem com mensagens de postagem de janela e mensagens de armazenamento de
sessão
Comunique-se entre OmniScript , janelas e componentes com mensagens de postagem de janela e mensagens de
armazenamento de sessão.
Passe informações de elemento e JSON de dados de elementos OmniScript que contenham a mensagem de
postagem da janela, a mensagem de armazenamento de sessão e a mensagem LWC Pub/Sub. Para obter
informações sobre como usar a mensagem pub/sub no OmniScript , consulte Comunicar-se com o OmniScript de um
componente Web do Lightning .
Para adicionar mensagens de postagem de janela ou mensagens de armazenamento de sessão:
1. No elemento, marque a caixa de seleção Window Post Message ou a caixa de seleção Session Storage Message
. Uma vez habilitada, a mensagem padrão envia o nome do elemento e o tipo do elemento.
Mensagem padrão:
{
Tipo: < element_type >,
OmniEleName : < element_name >
}
2. (Opcional) Na propriedade Mensagens , inclua mensagens adicionais no nó inserindo um par de Chave/Valor. O
campo Valor aceita a sintaxe de mesclagem. Para obter informações sobre campos de mesclagem, consulte
Acessar o JSON de dados do OmniScript com campos de mesclagem .
3. (Opcional) Começando com Vlocity Insurance and Health e Vlocity CME Summer '20, passe um valor no
parâmetro de URL c__ messagingKey para alterar o nó que armazena a carga útil do sistema de mensagens para
window.postMessage e mensagem de armazenamento de sessão.
A partir do Vlocity CME Spring '20, os elementos Step suportam o uso de mensagens de postagem de janela,
mensagens de armazenamento de sessão e mensagens. No entanto, as propriedades não aparecem na seção de
propriedades do elemento.
NOTA
Começando com Vlocity Insurance e Health Spring '20, as propriedades wpm, ssm e message
aparecem nas propriedades padrão do elemento Step.
Para adicionar mensagens a uma Etapa:
1. Nas propriedades da Etapa, clique em Editar Propriedades como JSON .

2. Cole o seguinte JSON antes do colchete de fechamento:
" wpm ": falso,

company
" ssm ": falso,
" mensagem ": {}
3. Habilite o WPM ou SSM configurando o valor igual a true .
" wpm ": verdadeiro

4. Adicione pares de chave/valor adicionais dentro do objeto de mensagem.
"message": {"Account":% AccountId %, "Status": % AccountStatus %}
Qual é o próximo
Visualize o OmniScript e teste o comportamento das mensagens inspecionando o navegador.
Veja Também
• Ação comum Elemento Propriedades
• Acompanhamento de alterações para Adobe DTM e Google Analytics
Ação de extração do DataRaptor

Invoque uma extração do DataRaptor para recuperar dados de um ou mais objetos do Salesforce relacionados. Você
também pode usar fórmulas e mapeamentos de campos complexos.
Se o DataRaptor Extract ainda não existir, você pode criá-lo clicando em Create New DataRaptor imediatamente
após arrastar a ação de extração do DataRaptor para o painel de estrutura do OmniScript
1. Arraste a ação de extração do DataRaptor para o painel de estrutura do OmniScript .

2. Para selecionar o DataRaptor Extract a ser chamado, clique no campo DataRaptor Interface e selecione na lista.
Você pode digitar no campo para filtrar a lista.
3. Forneça quaisquer parâmetros de entrada exigidos pelo DataRaptor Extract. Cada campo Data Source deve
corresponder a um parâmetro de entrada DataRaptor Extract. Cada valor de filtro deve corresponder aos
valores no campo sObject ao qual o parâmetro de entrada se refere.
4. Use as propriedades de Transformações de Resposta para cortar ou renomear o JSON de saída. Ver Manipular
JSON com a Transformações de envio /resposta Propriedades .
Veja Também
• Carregar dados do Salesforce no OmniScript usando o DataRaptor
• DataRaptor Extrair Ação Propriedades
DataRaptor Extrair Ação Propriedades

Esta página contém informações sobre Propriedades da Ação do Procedimento de Integração.

company
Interface do DataRaptor Nome da extração do DataRaptor que está sendo chamada.
Fonte de dados Nome de um nó JSON que fornece entrada para o DataRaptor Extract.
Filtro Valor Valor do nó JSON que fornece entrada para o DataRaptor Extract.
Relacionado Tópicos
• DataRaptor Extrair Visão Geral
• Carregar dados do Salesforce no OmniScript usando o DataRaptor
Ação de postagem do DataRaptor

Invoque uma ação DataRaptor Load para gravar dados em um ou mais objetos do Salesforce.
Se o DataRaptor Load ainda não existir, você poderá criá-lo clicando em Create New DataRaptor imediatamente
após arrastar o DataRaptor Post Action para o painel de estrutura do OmniScript .
1. Arraste a Ação Post do DataRaptor para o painel de estrutura do OmniScript .

2. Para selecionar o DataRaptor Load a ser chamado, clique no campo DataRaptor Interface e selecione na lista.
Você pode digitar no campo para filtrar a lista.
3. Use as propriedades Send Transformations para cortar ou renomear o JSON de entrada para que ele tenha a
estrutura que o DataRaptor Load espera. Ver Manipular JSON com a Transformações de envio /resposta
Propriedades .
Veja Também
• Criar um DataRaptor Carregar
• DataRaptor Visão geral da carga
• Ação de postagem do DataRaptor Propriedades
Ação de postagem do DataRaptor Propriedades

Esta página contém informações sobre as propriedades de pós-ação do DataRaptor .
Interface do DataRaptor Nome da carga do DataRaptor que está sendo chamada.
Tópicos relacionados
• Visão geral do carregamento do DataRaptor
Ação de transformação do DataRaptor

Invoque um DataRaptor Transform para reestruturar, renomear e converter dados. Ao contrário das extrações e
cargas do DataRaptor , as transformações não leem nem gravam dados do Salesforce.

company
Se o DataRaptor Transform ainda não existir, você poderá criá-lo clicando em Create New DataRaptor
imediatamente após arrastar o DataRaptor Transform para o painel de estrutura OmniScript .
1. Arraste a Ação de Transformação do DataRaptor para o painel de estrutura do OmniScript .

2. Para selecionar o DataRaptor Transform a ser chamado, clique no campo DataRaptor Interface e selecione na
lista. Você pode digitar no campo para filtrar a lista.
3. Use as propriedades Send/Response Transformations para cortar ou renomear o JSON de entrada para que ele
tenha a estrutura que o DataRaptor Transform espera. Ou você pode cortar ou renomear o JSON de saída para
uma etapa OmniScript subsequente . Ver Manipular JSON com a Transformações de envio /resposta
Propriedades .
• Preenchendo um DocuSign Modelo Usando DataRaptor Transformar
• Criar uma interface DataRaptor para mapear dados OmniScript para um PDF
Propriedades da ação de transformação do DataRaptor

Esta página contém informações sobre as propriedades da ação de transformação do DataRaptor .
Interface do DataRaptor Nome do DataRaptor Transform que está sendo chamado.
• Visão geral da transformação do DataRaptor
DataRaptor Turbo Action

Invoque um DataRaptor Turbo Extract para recuperar dados de um único objeto do Salesforce. Ao contrário de um
DataRaptor Extract padrão, um DataRaptor Turbo Extract não suporta fórmulas ou mapeamentos de campos
complexos.
Se o DataRaptor Turbo Extract ainda não existir, você pode criá-lo clicando em Create New DataRaptor
imediatamente após arrastar o DataRaptor Turbo Action para o painel de estrutura do OmniScript .
1. Arraste o DataRaptor Turbo Action para o painel de estrutura do OmniScript .

2. Para selecionar o DataRaptor Turbo Extract a ser chamado, clique no campo DataRaptor Interface e selecione
na lista. Você pode digitar no campo para filtrar a lista.
3. Forneça quaisquer parâmetros de entrada exigidos pelo DataRaptor Turbo Extract. Cada campo Data Source
deve corresponder a um parâmetro de entrada DataRaptor Turbo Extract. Cada valor de filtro deve
corresponder aos valores no campo sObject ao qual o parâmetro de entrada se refere.

company
NOTE
DataRaptor Turbo Extracts return objects in a nested array format.
4. (Opcional) No campo Caminho JSON da Resposta , insira o nome do objeto retornado na resposta da Ação.
Anexar um | delimitador e um número para acessar a instância correta na matriz aninhada. este permite
OmniScripts para pré preenchimento elementos .
Exemplo de JSON do DataRaptor Turbo Extract Exemplo de caminho JSON de resposta
{ Conta|1
" Conta ": [
{
" RecordTypeId ": "0125w000001NgyvAAC",
"Telefone": "5105551223",
" Nome ": " Aileen Lee",
"Id": "0015w00002D8iCAAAZ"
}
]
}
5. (Opcional) No campo Nó JSON de Resposta, insira VlocityNoRootNode . Isso garante que o objeto não seja
aninhado. Consulte Manipular JSON com as propriedades de transformações de envio/resposta .

company
6. Visualize o OmniScript para testar o DataRaptor Turbo Action.
Veja Também
• Visão geral do DataRaptor Turbo Extract
• DataRaptor Extrair Ação

company
DataRaptor Turbo Action Propriedades
Esta página contém informações sobre as Propriedades da Ação Turbo do DataRaptor .
Interface do DataRaptor Nome do DataRaptor Turbo Extract sendo chamado.
Fonte de dados Nome de um nó JSON que fornece entrada para o DataRaptor Turbo Extract.
Filtro Valor Valor do nó JSON que fornece entrada para o DataRaptor Turbo Extract.
Excluir ação
Permita que os usuários excluam um ou mais registros sObject usando a ação Excluir. Use o ID de registro de um
objeto para determinar qual registro excluir. A Vlocity recomenda usar um campo de mesclagem no campo Path to
Id que se refere a um ID ou a uma lista de IDs no JSON de dados.
Para excluir registros com a ação de exclusão:
1. Visualize o OmniScript e identifique o caminho JSON para o registro. Por exemplo, este JSON de dados contém
uma lista de contas:
{ " Conta ": { " accId ": ["001f400000EPQ8o", "001f400000BAkbn"] } }

2. Nas propriedades Delete Action, clique em Add sObject to Delete.
3. Na coluna Tipo , selecione um Objeto.
4. No campo Path to Id , insira o caminho JSON para o ID do registro usando a sintaxe do campo de mesclagem.
Usando o exemplo de conta, o caminho para excluir a matriz de IDs de conta é: % Account:accId % .
5. Visualize o OmniScript e use o ID de um registro de teste para testar a funcionalidade.
Para exemplos de procedimentos de integração que incluem uma ação de exclusão, consulte Processar matrizes
usando blocos de loop e lidar com erros usando blocos Try-Catch .
Confirmando a exclusão do registro

Permita que os usuários confirmem a exclusão de um registro usando o Modal de Confirmação.
Para alterar o comportamento do modal de confirmação, configure estas propriedades:
• Confirm : Controla se o modal é exibido.

• diálogo de confirmação : Mensagem solicitando ao usuário que confirme a exclusão.
• Confirmar Rótulo : Rótulo do botão para a ação de confirmação.
• Cancelamento : Rótulo do botão para a ação de cancelamento.

company
Exibindo mensagens de uma ação de exclusão
Exiba mensagens quando a operação for bem-sucedida ou falhar configurando estes campos na seção Mensagens de
erro:
• Mensagem Entidade Excluída : Digite uma mensagem que será exibida quando um registro for excluído.
• Excluir Mensagem com Falha : Insira uma mensagem que é exibida quando a ação falha ao excluir um registro.
• Mensagem de ID inválida : insira uma mensagem que é exibida quando uma ID inválida é enviada para a ação de
exclusão.
• Mensagem de erro de configuração : Digite uma mensagem que é exibida quando a ação de exclusão tem um
erro de configuração.
Excluir propriedades da ação

Esta página contém informações sobre Propriedades da ação de exclusão.
Modelo Tipo de registro sObject a ser excluído. Por exemplo, Account é um tipo de sObject .
Caminho para o ID Caminho para o nó JSON que contém o ID ou a lista de IDs dos registros a serem excluídos. Suporta
sintaxe de mesclagem .
Tudo Ou Nenhum Quando marcada, a operação falhará se algum dos registros não for excluído.
Entidade É Excluído Mensagem Mensagem exibida quando um registro é excluído.
Falha ao excluir Mensagem Mensagem exibida quando a ação falha ao excluir um registro.
Mensagem de ID inválida Mensagem exibida quando um ID inválido é enviado para a ação de exclusão.
Configuração Erro Mensagem Mensagem exibida quando a ação de exclusão apresenta um erro de configuração.
confirme Controla se o modal é exibido.
Confirmação Diálogo Mensagem O texto da mensagem do Modal de Confirmação. O texto da mensagem padrão é Tem certeza? este ação
não podes ser desfeito .
confirme Etiqueta Rótulo do botão para a ação de confirmação do Modal de Confirmação.
Cancelar Etiqueta Rótulo do botão para a ação de cancelamento do Modal de Confirmação.
• Confirmando a exclusão do registro
• Exibindo mensagens de uma ação de exclusão
Propriedades da ação do envelope DocuSign

Esta página contém informações sobre as propriedades de ação do envelope DocuSign.
DocuSign Modelos Modelos para os documentos que você deseja assinar.
E-mail Sujeito Linha de assunto do e-mail solicitando assinaturas.
Corpo do e- mail Texto do corpo do e-mail solicitando assinaturas.

company
Formato de data Formato para exibição de valores de data.
Formato de data e hora Formato para exibição de valores de data e hora.
Formato de hora Formato para exibição de valores de tempo.
• Integrando DocuSign com OmniScript
• Exibir na documentação do Moment.js
DocuSign Assinatura Ação Propriedades
Esta página contém informações sobre as propriedades da ação de assinatura do DocuSign.
DocuSign Modelos Modelos para os documentos que você deseja assinar.
DocuSign Retornar URL URL para o qual o usuário é redirecionado após a conclusão da assinatura. Deixe em branco para exibir a página de
redirecionamento padrão.
Formato de data Formato para exibição de valores de data.
Formato de data e hora Formato para exibição de valores de data e hora.
Signatário E-mail O e-mail do signatário. Suporta sintaxe de mesclagem .
Signatário Nome O nome do signatário. Suporta sintaxe de mesclagem .
Formato de hora Formato para exibição de valores de tempo.
• Exibir na documentação do Moment.js
E-mail Ação
A ação de email do OmniScript usa a API de email do Salesforce para enviar um modelo de email para o endereço de
email de um usuário, lead ou contato ou para enviar um corpo de email definido na configuração da ação para
qualquer endereço de email.
A caixa de seleção Usar modelo determina se está usando um modelo de email ou um corpo de email definido.
• Se a caixa de seleção Usar modelo estiver marcada, o email enviará um modelo para um usuário, lead ou
contato.
• Selecionar modelo de e-mail : o ID do modelo de e-mail que deve ser usado.
• objeto de destino do e-mail : o ID do objeto do contato, lead ou usuário para o qual o e-mail deve ser enviado.
• What Id : se você especificar um contato para o campo targetObjectId , um What Id poderá ser usado para
garantir ainda mais que os campos de mesclagem no modelo contenham os dados corretos. Ver a
Documentação da API de email do Salesforce para mais informações .

company
• Salvar como atividade : se esta opção estiver marcada, o email será salvo como um registro de atividade na
página do destinatário no Salesforce.
• Endereço de email de toda a organização : permite que o email seja enviado por um endereço de email de toda
a organização do Salesforce. Para obter mais informações sobre endereços de e -mail de toda a organização,
consulte Endereços de e-mail de toda a organização ,
• Versões de conteúdo : aceita a ID de um ContentDocument que é enviado como anexo com a ação de email.
• Se a caixa de seleção Usar modelo estiver desmarcada, um corpo de e-mail definido na configuração da ação
pode ser enviado para qualquer endereço de e-mail.
• PARA : — Uma matriz de endereços de e-mail ou IDs de objetos dos contatos, leads ou usuários para os quais
você está enviando o e-mail. O máximo número do para Endereços é 100.
• CC : — Uma matriz de endereços de cópia carbono (CC) ou IDs de objeto dos contatos, leads e usuários para os
quais você está enviando o email. O máximo número do ccEndereços é 25.
• BCC: — Uma matriz de endereços de cópia oculta (BCC) ou IDs de objeto dos contatos, leads e usuários para os
quais você está enviando o email. O máximo número do bccEndereços é 25.
• Assunto do e-mail — O assunto do e-mail.
• mail — O corpo do e-mail.
• Definir corpo HTML — Determina se o corpo do email deve ser lido como texto simples ou HTML.
• Lista de anexos — Suporta IDs de anexos mesclados do Data JSON. Por exemplo, % DocGenId % . Quando o e-
mail for enviado, o anexo será adicionado ao e-mail.
Propriedades da ação de e-mail

Esta página contém informações sobre Propriedades de ação de email.
Usar modelo Se marcado, usa um modelo de email do Salesforce. Também determina quais outras propriedades estão
disponíveis.
Para E-mail Endereço Lista Especifica os destinatários no campo PARA do email. Pode aceitar uma matriz de até 100 endereços.
Suporta campos de mesclagem. Disponível se Usar modelo não estiver marcado.
mail CC Endereço Lista Especifica os destinatários no campo CC do email. Pode aceitar uma matriz de até 25 endereços.
mail CCO Endereço Lista Especifica os destinatários no campo CCO do email. Pode aceitar uma matriz de até 25 endereços.
E-mail Sujeito Especifica a linha de assunto do email.
Corpo do e- mail Especifica o corpo do email.
corpo de e- mail HTML Processa o código HTML no corpo do email.

company
Selecionar E-mail Modelo Especifica o modelo de email do Salesforce. Insira o sObject Id e selecione o modelo na lista suspensa.
Disponível se Usar modelo estiver marcado.
ID do objeto de destino de e- Especifica a ID de um contato, usuário ou lead com um endereço de e-mail.

mail
Qual ID Se você especificar um contato no campo ID do objeto de destino de email , essa propriedade poderá garantir ainda
mais que os campos de mesclagem no modelo contenham os dados corretos. Consulte a documentação da API de
email do Salesforce para obter mais informações.
Salvar como atividade Se marcado, salva o email como um registro de atividade na página do destinatário no Salesforce.
Toda a organização E-mail Especifica o remetente no campo DE do email. Presume -se que seja um e-mail que representa toda a organização.
Endereço Se não for especificado, o remetente padrão é o usuário que invocou o Procedimento de Integração. Consulte os
endereços de e-mail de toda a organização na ajuda do Salesforce.
Suporta campos de mesclagem.
Anexos de arquivo a partir de Especifica o nó OmniScript JSON que contém um único ou uma lista de IDs de sObject do Salesforce File .
OmniScript
Documento Anexos a partir Especifica o nó OmniScript JSON que contém um único ou uma lista de IDs de sObject de documento do Salesforce .
de OmniScript
Contente Versões Especifica o ID de um ContentVersion sObject que está incluído como anexo.
Selecionar Documento Especifica os sObjects de anexo a serem adicionados ao email.

Anexos
Acessório Lista Especifica um nó no JSON de dados que contém uma lista de IDs de anexo.
Ação HTTP
Chame serviços da web internos e externos do OmniScript sem codificar ou fazer chamadas de API do Salesforce
usando a ação HTTP.
NOTA
Você deve adicionar o domínio da organização do Salesforce ao campo URL do site remoto de um
site remoto .
Para obter mais informações, consulte Adicionando configurações de site remoto .
Para fazer uma chamada externa com uma ação HTTP:
Use a ação HTTP para:
• Envie solicitações GET, POST, PUT ou DELETE para endpoints REST padrão.
• Chame Apex REST.

company
• Acesse os serviços de identidade do Salesforce Named Credential (OAuth).
Definições:
• Caminho HTTP: o URL de solicitação da API. Por exemplo, /NS/v1/application . NS = namespace da API REST do
Apex. O caminho pode conter campos de mesclagem . Por exemplo, para passar um nó UserId do JSON de dados,
adicione o nome do nó com sinais de porcentagem em ambos os lados, ou seja, % UserId %.
NOTA
A partir do Vlocity Summer '19, você pode passar sinais de porcentagem no URL substituindo o
sinal de porcentagem no URL pela variável $ Vlocity.Percent .
• Método HTTP: O nome do método, que possui dois parâmetros. Por exemplo, doPost (String fullJSON , String
filesMap ) .
• Origem da opção: o tipo de ação HTTP.
• Use credenciais nomeadas (OAuth via Salesforce).
• SOAP/XML (Protocolo de Acesso a Objeto Simples)
• Web (não autenticado ou credenciais no cabeçalho)
• Tempo limite remoto: o tempo limite da solicitação, em milissegundos. O padrão é 30.000 (30 segundos. Máximo
12.0000 (120 segundos).
• DataRaptor Pré e Pós-Transformação : (Opcional) Interface DataRaptor Transform para ser executada antes ou
depois da Ação REST.
Propriedades da ação HTTP

Esta página contém informações sobre Propriedades de Ação HTTP.
Caminho HTTP URL para chamar. Para ações REST do Apex, você pode usar campos de mesclagem para definir essa propriedade.
Começando com Vlocity Spring '19, você pode passar sinais de porcentagem na URL substituindo o sinal de porcentagem
no Caminho pela variável $ Vlocity.Percent .
Método HTTP GET, POST, PUT ou DELETE.
Ponto final Modelo Especifica a ponto final tipo :
• Apex — Invoca Apex REST. Você deve adicionar o domínio da organização do Salesforce ao campo URL do site remoto
de um site remoto .
• Credencial nomeada — Acesse os serviços de identidade de credencial nomeada (OAuth) do Salesforce.
• SOAP/XML — Envie solicitações para terminais REST padrão usando o formato XML para a solicitação e corpos de
resposta .
• Web — Envie solicitações para endpoints REST padrão (não autenticados ou credenciais em cabeçalhos HTTP).
Nomeado Credencial Credencial nomeada do Salesforce. Para Credencial Nomeada e opcionalmente tipos de terminal SOAP/XML.
Cabeçalhos HTTP Cabeçalhos HTTP especificados como pares de chave/valor. Suporta campo de mesclagem sintaxe .
Parâmetros Parâmetros de URL especificados como pares de chave/valor. Suporta campo de mesclagem sintaxe .
Codificar URI Usa códigos de escape HTML no URI.

company
Cache Armazena a resposta em cache.
Com Credenciais Requer credenciais de segurança, como nome de usuário e senha.
Carga extra Envia pares de chave/valor adicionais. Suporta campo de mesclagem sintaxe .
Enviar corpo Envia o Extra Payload como o corpo da solicitação para uma ação POST.
Enviar apenas extra Habilita a ação para enviar pares de chave/valor de carga útil extra sem incluir o JSON de dados do OmniScript .
Carga útil
• Adicionando Configurações de Site Remoto no Guia do desenvolvedor do Apex
Ação do Procedimento de Integração

Invoque um Procedimento de Integração para recuperar dados do Salesforce e dados externos.
Antes de começar
Crie um Procedimento de Integração para lidar com dados

OmniScript .
1. Arraste a Ação do Procedimento de Integração para o painel de estrutura do OmniScript .
2. Para selecionar o Procedimento de Integração a ser chamado, clique no campo Procedimento de Integração e
selecione na lista. Você pode digitar no campo para filtrar a lista.
3. Use as propriedades de Transformações de Resposta para especificar a entrada e para aparar ou renomear o
JSON de saída.
• Send JSON Path — Especifica o nó JSON que contém a entrada para o Procedimento de Integração.
Normalmente, é o nome de um elemento anterior no OmniScript .
• Enviar Nó JSON — Renomeia o nó JSON que contém a entrada para o Procedimento de Integração .
Normalmente, é o nome de um dos parâmetros de entrada do Procedimento de Integração.
• Caminho JSON de resposta — Especifica o nó JSON que contém a saída para retornar ao OmniScript . Por
padrão, todos Os dados do Procedimento de Integração são devolvido .
• Nó JSON de resposta — renomeia o nó JSON que contém a saída para retornar ao OmniScript .
Normalmente, esse é o nome de um elemento subsequente no OmniScript . Ver Manipular JSON com a
Transformações de envio /resposta Propriedades .
4. (Opcional) Use a propriedade Extra Payload para enviar pares de chave/valor adicionais para o Procedimento
de Integração como dados de entrada.
5. Especifique quaisquer propriedades adicionais da Ação do Procedimento de Integração necessárias.
6. (Opcional) Habilite as configurações de enfileiramento enfileirado do procedimento de integração seguindo
estas etapas:
1. Clique no link É enfileirado? caixa de seleção para ativar as configurações.
2. Em Remote Options , adicione este par Key-Value:
Chave Valor
useQueueableApexRemoting verdadeiro

company
7. (Opcional) Quando o Invoke Mode é definido como não bloqueante, os elementos que usam valores padrão
não receberão a resposta porque o elemento é carregado antes do retorno da resposta. Você deve configurar
estas propriedades para mapear a resposta para um elemento:
Propriedade Valor
Nó JSON de resposta VlocityNoRootNode
Caminho JSON de resposta O nome do elemento OmniScript que recebe o valor.
Consulte Manipular JSON com as propriedades de transformações de envio/resposta .
Veja Também
• Ação do Procedimento de Integração Propriedades
• OmniStudio Procedimentos de Integração
• Métodos futuros no Guia do desenvolvedor do Apex
• Configurações para procedimentos de integração de longa duração
• Continuação em chamadas de longa duração
Ação do Procedimento de Integração Propriedades

Esta página contém informações sobre Propriedades da Ação do Procedimento de Integração.
Integração Especifica o Procedimento de Integração a ser executado no formato Type _ Subtype .

Procedimento
Opções remotas Especifica propriedades adicionais para o Procedimento de Integração como pares de chave/valor.
Enviar apenas extra Habilita a ação para enviar pares de chave/valor de carga útil extra sem incluir o JSON de dados do OmniScript .
Carga útil
Usar futuro Especifica que o Procedimento de Integração é executado de forma assíncrona, como um método futuro do
Salesforce, que não pode retornar dados ao OmniScript de chamada .
É Encadeável Habilita as configurações Chainable do Procedimento de Integração subordinado.
Usar continuação Habilita um Procedimento de Integração subordinado que chama ações de longa duração para usar as continuações
do Apex.
Usar enfileirado Ativa etapas encadeadas no Procedimento de Integração subordinado para iniciar trabalhos enfileirados.
É Enfileirado Habilita as configurações do Queueable Chainable do Procedimento de Integração.

Encadeável
Invocar Modo Configura o comportamento de resposta da ação:
• Padrão — Bloqueia a interface do usuário com um spinner de carregamento.

• Sem bloqueio — é executado de forma assíncrona e a resposta é aplicada à interface do usuário. Não há suporte
para transformações pré e pós DataRaptor e anexos grandes. Quando o Modo de Invocação é definido como não
bloqueante, os elementos que usam valores padrão não receberão a resposta porque o elemento é carregado antes
do retorno da resposta. Para mapear a resposta para um elemento, você deve definir Response JSON Node como
VlocityNoRootNode e Response JSON Path para o nome do elemento.

company
• Fire and Forget — Executa de forma assíncrona sem retorno de chamada para a interface do usuário. Pré e Pós
DataRaptor transformações e anexos grandes não são suportados. Uma resposta ainda aparecerá no console de
depuração, mas não será aplicada ao Data JSON.
Mostrar brinde Sobre Exibe uma mensagem quando o Procedimento de Integração subordinado é concluído.
Conclusão
Veja Também
• Métodos futuros no Guia do desenvolvedor do Apex
• Configurações para procedimentos de integração de longa duração
• Continuação em chamadas de longa duração
Navegar Ação
Navegue para várias experiências do Salesforce do OmniScript usando o elemento Navigate Action. Para mais
informações sobre experiências do Salesforce , consulte Referência de página Tipos .
1. Arraste a ação de navegação para o painel de estrutura do OmniScript . Se a Ação de Navegação for renderizada
em uma Etapa, ela se tornará um botão clicável. Se a ação de navegação estiver entre etapas, ela será acionada
automaticamente.
2. (Opcional) Se a ação de navegação for renderizada em uma etapa, determine o estilo do botão clicando no
menu suspenso Variante do botão e selecionando uma variante do botão SLDS . Além das variantes do botão
SLDS, você pode selecionar Link para renderizar a ação de navegação como uma marca de âncora HTML.
3. (Opcional) Se a ação de navegação for renderizada em uma etapa, exiba um ícone SLDS no botão inserindo o
nome do ícone no campo Nome do ícone . Por exemplo, para adicionar o ícone standard_account , insira
Standard:Account .
4. (Opcional) Substitua a entrada existente no histórico do navegador definindo a opção Substituir? propriedade
para Sim . Se Substituir? estiver definido como Sim , os usuários não poderão navegar de volta para o
OmniScript .
NOTA
Por padrão, uma ação de navegação em um aplicativo de console abre o tipo
PageReference em uma nova subguia. Substitua a guia atual em um aplicativo de console
definindo Substituir? para Sim .

company
5. (Opcional) Habilite o LWC OmniScript para enviar mensagens para separar os componentes da Web do
Lightning verificando LWC PubSub Message? e adicionando um par de valores-chave de mensagem. Para obter
mais informações, consulte Comunicar-se com OmniScript de um componente Web do Lightning .
6. (Opcional) Dispare eventos da ação Navigate passando um evento para o OmniScript no parâmetro de URL c__
vlocEvents . O elemento Navigate Action deve ter a propriedade checkbox LWC PubSub Message? habilitado
para disparar o evento. Para obter mais informações sobre como passar parâmetros para um OmniScript ,
consulte Iniciar um OmniScript com LWC OmniScript Wrapper .
7. Determine a experiência do Salesforce para a qual a ação de navegação direcionará clicando e selecionando um
tipo de referência de página . Esta página contém mais instruções para cada tipo de referência de página
compatível com a ação de navegação . Para informações sobre Referência de página Tipos , consulte Referência
de página Tipos .
Referência de página Modelo Descrição
Aplicativo Inicie um aplicativo padrão ou personalizado disponível no inicializador de aplicativos. Os aplicativos

conectados não são suportado .
Página nomeada da Direcione os usuários para uma página nomeada em uma comunidade.
comunidade
Componente Navegue até os componentes do Aura e os componentes da Web do Lightning.
Página atual Acionar uma atualização de página na página atual assim que o usuário concluir o OmniScript .
Conhecimento Artigo Exiba artigos de conhecimento no OmniScript .
Conecte-se Abra uma página de login da Comunidade.
Página nomeada Abra uma página nomeada padrão.
Item de navegação Uma página exibindo conteúdo mapeado em uma CustomTab .
Objeto Direcione os usuários para uma página de objeto padrão ou personalizada.
Registro Abra uma página que interage com um registro do Salesforce.
Registro de relacionamento Abra uma página de relacionamento de registro.
Reiniciar OmniScript Retorne um usuário ao início de um OmniScript e limpe os dados do OmniScript .
Vlocity OmniScript Lançar um separado OmniScript .
Página da Internet Abra um URL externo .
Veja Também
• Configurar OmniScript Cancelar Opções
Navegar para um aplicativo

Direcione os usuários de um OmniScript para um aplicativo padrão, aplicativo personalizado ou uma página dentro
de um aplicativo usando o tipo de referência de página do aplicativo da ação de navegação .
Antes de começar

company
1. Configure as propriedades adicionais da Ação de Navegação e visualize os tipos de referência de página alternativos. Ver Navegar
Ação .
2. Verifique se o aplicativo que você está usando está disponível no Salesforce App Launcher. Para obter mais informações ,
consulte Iniciador de aplicativos .
1. Defina a propriedade do tipo PageReference como App .
2. No campo App Name , insira o appId ou appDeveloperName do App usando o namespace apropriado.
ID do aplicativo O AppDefinition do objeto DurableId .
appDeveloperName A concatenação do namespace e do nome do desenvolvedor do aplicativo. O namespace do aplicativo é padrão,

personalizado ou um namespace de pacote gerenciado. O nome do desenvolvedor pode ser visualizado no App
Manager. Para obter mais informações sobre appDeveloperName , consulte Tipo de referência de página
Sintaxe Exemplos :
• Padrão: conta padrão__

• Personalizado : c__ CustomAccountApp
• Gerenciado : vloc_ps_OmniScriptDesigner
3. (Opcional) No campo Target Page , insira JSON para especificar a página do aplicativo e atributos adicionais. O
campo Página de destino representa a Aplicativos páginaRef propriedade .
{"type": "standard__ navItemPage ","attributes": {" apiName ":

"oui_ dailylwc __ LWCDesigner "}}
4. Ative e visualize o OmniScript para testar o comportamento da navegação.
Veja Também
• Navegar Ação
Navegue até um login ou logout da comunidade

Direcione os usuários de um OmniScript para uma página de login ou logout da comunidade para autenticação.
Antes de começar
Configure as propriedades adicionais da Ação de Navegação e visualize os tipos de referência de página alternativos. Para obter mais informações
, consulte Navegar Ação .
1. Defina a propriedade do tipo PageReference como Login .

2. Configure a propriedade Login Action para login para direcionar o usuário para uma página de login ou logout
para direcionar o usuário para efetuar logout.
3. Visualize o OmniScript ativando o OmniScript e colocando-o em uma comunidade. Para obter mais
informações, consulte Adicionar um OmniScript a uma comunidade ou página do Lightning .
Veja Também
• Navegar Ação

company
Navegar para um componente
Navegue até os componentes do Aura e os componentes da Web do Lightning a partir de um OmniScript usando o
Tipo de referência de página do componente .
Antes de começar
1. Defina a propriedade do tipo PageReference como Component .

2. Insira um nome de componente do Aura no campo Nome do componente usando o formato
NS__ componentName , onde NS é o namespace do seu pacote Vlocity . O vlocityLWCWrapper permite que os
componentes da Web do Lightning sejam endereçáveis por URL. Para obter mais informações, consulte Iniciar
URLs de componentes da Web do Lightning com vlocityLWCWrapper . este campo suporta campos de
mesclagem .
NOTA
O componente Aura deve implementar a interface lightning:isUrlAddressable . Para obter
mais informações , consulte É URL Endereçável .
3. (Opcional) Passe parâmetros usando um formato de string de consulta de URL na propriedade Target Params .
Os parâmetros devem ter um prefixo c__ . Este campo suporta campos de mesclagem.
4. (Opcional) Ao navegar para um componente em um aplicativo de console, adicione um ícone da guia do

console e um rótulo da guia do console definindo os parâmetros c__ tabIcon e c__ tabLabel . A aba c__Ícone
aceita e SLDS
Ícone e c__ tabLabel aceita texto simples. Por exemplo, &c__ tabLabel =Personalizado
Label&c __ tabIcon = standard:account renderiza a guia do console mostrada nesta imagem de exemplo.

company
Veja Também

• Navegar Ação
Navegar para a Página atual

Atualize e navegue para a página atual de um OmniScript usando o Tipo de referência de página da página atual em
uma ação de navegação .
Antes de começar
1. Defina a propriedade do tipo PageReference como Current Page .

2. Aplique atualizações à página atual passando parâmetros que usam um formato de string de consulta de URL
na propriedade Target Params . Os parâmetros devem ter um prefixo c__ . Este campo suporta campos de
mesclagem.
Veja Também
• Navegar Ação

company
Navegar a um Conhecimento Artigo
Exiba um artigo de conhecimento em um OmniScript selecionando o tipo de referência de página de artigo de
conhecimento da ação de navegação .
Antes de começar
1. Defina a propriedade do tipo PageReference como Knowledge Article .

2. Insira o urlName do artigo de conhecimento no campo URL do artigo . este campo suporta campos de
mesclagem .
3. Insira o nome da API articleType no campo Tipo de artigo . Encontre o nome da API articleType removendo __
kav do nome da API do objeto de conhecimento.
NOTA
As comunidades ignoram articleType .
Veja Também

• Navegar Ação
Navegar para um OmniScript

Navegue até um OmniScript usando o Vlocity OmniScript Tipo de referência de página . Os OmniScripts nas páginas
da comunidade devem ser acessados usando o tipo de referência de página da página nomeada da comunidade .
Consulte Navegar para uma página nomeada ou página nomeada da comunidade .
Antes de começar
1. Digite o nome do OmniScript com o prefixo c: no campo LWC OmniScript . O nome do OmniScript é definido
pelo Tipo, Subtipo e Idioma do OmniScript , usando a sintaxe typeSubTypeLanguage . Por exemplo, um
OmniScript com as propriedades Type= myType , SubType =Example e Language=English aparece como um
componente usando a sintaxe myTypeExampleEnglish .
2. Selecione o layout que o OmniScript usa para renderizar clicando na propriedade Layout do OmniScript .

company
3. (Opcional) Preencher o OmniScript de destino passando parâmetros usando um formato de string de consulta
de URL na propriedade Prefill do OmniScript . Os parâmetros devem ter um prefixo c__ . Este campo suporta
campos de mesclagem.
4. (Opcional) Ao navegar para um OmniScript em um aplicativo de console, adicione um ícone da guia do console
e um console
Tab Label definindo os parâmetros c__ tabIcon e c__ tabLabel . O c__ tabIcon aceita um SLDS
Ícone e c__ tabLabel aceita texto simples. Por exemplo, &c__ tabLabel =Personalizado
Label&c __ tabIcon = standard:account renderiza a guia do console mostrada nesta imagem de exemplo.
Veja Também
• Navegar Ação
Navegue até uma página nomeada ou página nomeada da comunidade

Direcione os usuários para uma página padrão ou de comunidade usando o Tipo de referência de página nomeada
ou página nomeada da comunidade.
Antes de começar
Configure as propriedades adicionais da Ação de Navegação e visualize os tipos de referência de página alternativos. Ver Navegar
Ação .
1. Defina a propriedade do tipo PageReference como Página nomeada ou, se a página existir em uma
comunidade, selecione Página nomeada da comunidade .

company
2. No campo Nome da página , insira a API para o nome da página. Os nomes de API para páginas personalizadas
devem incluir __c no nome da API. este campo suporta campos de mesclagem .
3. Ative e visualize o OmniScript para testar o comportamento da navegação.
Veja Também
• Navegar Ação
Navegar para um item de navegação

Navegue de um OmniScript para uma guia personalizada exibindo conteúdo mapeado usando o Tipo de referência
de página de item de navegação de ação de navegação .
Antes de começar
1. Defina a propriedade do tipo PageReference como Navigation Item . Este campo suporta campos de
mesclagem.
2. Localize o nome da guia personalizada e o prefixo do namespace e insira-o no campo Nome da guia usando o
formato NS__ TabName , em que NS é o namespace da guia. Para obter mais informações sobre guias, consulte
Criar guias de página do Lightning . este campo suporta campos de mesclagem .
Veja Também
• Navegar Ação
Navegar para um Página do objeto

Navegue de um OmniScript para uma página de objeto usando o tipo de referência de página de objeto da ação de
navegação .
Antes de começar
1. Defina a propriedade do tipo PageReference como Object .

2. Insira o nome da API do objeto no campo Nome da API do objeto . Objetos personalizados de um pacote
gerenciado requerem um prefixo de namespace usando a sintaxe NS__ APIName , em que NS é o prefixo de
namespace do objeto. este campo suporta campos de mesclagem .
3. Clique na propriedade Action e selecione uma ação para invocar.

company
NOTA
A nova ação abre um diálogo modal.
4. (Opcional) Insira o ID da página do objeto no campo Nome do filtro . O nome do filtro é padronizado como
Recente. Este campo suporta campos de mesclagem.
Veja Também
• Navegar Ação
Navegar para uma página de registro
Navegue de um OmniScript para uma página de registro usando o tipo de referência de página de registro da ação
de navegação .
Antes de começar
1. Defina a propriedade do tipo PageReference como Record .

2. Insira um recordId no campo Record Id . Este campo suporta campos de mesclagem.
3. Clique na propriedade Action e selecione uma ação para invocar.
NOTA
As ações Clonar e Editar abrem um diálogo modal.
4. (Opcional) Insira o nome da API do objeto no campo Nome da API do objeto . Objetos personalizados de um
pacote gerenciado requerem um prefixo de namespace usando a sintaxe NS__ APIName , em que NS é o
prefixo de namespace do objeto. este campo suporta campos de mesclagem .
Veja Também
• Navegar Ação
Navegue até uma página de relacionamento de registro

Navegue de um OmniScript para páginas que interagem com um relacionamento de registro usando o Tipo de
referência de página de relacionamento de registro .
Antes de começar
1. Defina a propriedade do tipo PageReference como Record Relationship .

company
2. Insira um recordId no campo Record Id . Este campo suporta campos de mesclagem.
3. (Opcional) Insira o nome da API do objeto que define o relacionamento no campo Nome da API do objeto .
Objetos personalizados de um pacote gerenciado requerem um prefixo de namespace usando a sintaxe NS__
APIName , em que NS é o prefixo de namespace do objeto. este campo suporta campos de mesclagem .
4. (Opcional) Insira o nome da API do relacionamento no campo Nome da API do relacionamento .
Veja Também
• Navegar Ação
Navegar para uma página da Web

Navegue para uma página da Web a partir de um OmniScript usando o Tipo de referência de página da Web.
Antes de começar
1. Defina a propriedade do tipo PageReference como Web Page .

2. Insira o URL completo de uma página da Web no campo URL da Web . Por exemplo, para navegar até o google,
digite https://google.com .
Veja Também
• Navegar Ação
Reiniciar um OmniScript
Navegue um usuário para uma nova instância do mesmo OmniScript usando a ação Navigate.
1. No OmniScript , adicione uma ação de navegação à tela.

2. Nas propriedades de sua ação de navegação, clique em Editar propriedades como JSON .
3. Localize o nó " targetType " e defina "Restart OmniScript " como o valor.
" targetType ": " Reinicie OmniScript "

4. Salve suas configurações e teste a funcionalidade.
Veja Também
• Navegar para a Página atual

company
Navegar Ação Propriedades
Esta página contém informações sobre as propriedades da ação de navegação.
Variante de botão Se a Ação de Navegação for renderizada em uma Etapa, determina o estilo do botão:
• marca — Usa uma cor de preenchimento específica da marca para indicar uma ação principal.
• outline-brand — Usa uma cor de contorno específica da marca para indicar uma ação primária.
• neutro — genérico botão .
• sucesso — Usa um preenchimento verde para indicar sucesso.
• destrutivo — Usa um preenchimento vermelho para indicar uma ação destrutiva para o usuário, como apagar dados
permanentemente.
• text-destructive — Usa texto vermelho para indicar uma ação destrutiva para o usuário, como apagar dados
permanentemente.
• inverse — Usa um contorno branco e texto para ficar visível em um fundo escuro.
• link — Realçado e sublinhado para indicar a navegação para uma página.
Ícone Nome Nome do ícone do botão.
Referência da página Selecione a referência de página sTipo de objeto :

Modelo
• Aplicativo — Navega para uma página de aplicativo.
• Componente — Navega para um componente da Web do Lightning.
• Página nomeada da comunidade — Navega para uma página nomeada da comunidade.
• Página atual — Executa uma ação na página atual.
• Artigo de conhecimento — Navega para um artigo de conhecimento.
• Login — Navega para um Login ou Logout.
• Página nomeada — Navega para a página com o nome especificado.
• Item de navegação — Navega para uma guia personalizada. Guias do Visualforce, guias da Web, páginas do Lightning e
guias do LightningComponent são compatíveis.
• Object — Navega para uma página sObject .
• Registro — Navega para uma página de registro sObject .
• Relacionamento de registro — Navega para uma lista de registros relacionados ao registro especificado.
• Página da Web — Navega para uma página da Web externa.
• Vlocity OmniScript — Navega para uma Vlocity OmniScript .
Substituir existente Especifica que a página para a qual esta ação navega substitui a página atual no histórico do navegador. Se estiver
Página no navegador marcado, os usuários não poderão navegar de volta para o OmniScript .
História
Componente Nome Nome do componente Web do Lightning.
Parâmetros de destino Parâmetros adicionais para a página.
URL do artigo URL do artigo de conhecimento.
Artigo Modelo Tipo do artigo de conhecimento.
Nome da página Nome da página nomeada.
Aba Nome Nome da guia personalizada.
Nome da API do objeto Nome do sObject . Para objetos personalizados, inclua o namespace, por exemplo, vlocity_ins__ PartyRelationship __c.

company
Objeto Ação Página para a ação a ser executada no sObject :
• Home — Exibe sObject informações .

• Lista — Listas sObject registros .
• Novo — Abre a janela para criar um novo sObject .
Filtro Nome Texto para filtrar a Lista de registros sObject .
Registrar ação Página para a ação a ser executada no registro sObject :
• Clone — Abre a janela para clonar o registro.

• Editar — Abre a janela para editar o registro.
• Exibir — Exibe informações de registro de sObject .
API de relacionamento Nome do relacionamento. Para objetos padrão, geralmente é uma referência de ID, como AccountId . Para objetos
Nome personalizados, geralmente é o nome do objeto relacionado com o sufixo __c alterado para __r.
Substituir Se marcada, pageReference substitui a entrada existente no histórico do navegador e desativa o usuário de navegar de
volta para o OmniScript . Em um contexto de console, o destino substitui a guia atual em vez de abrir uma nova guia.
ID do registro ID do registro sObject .
URL da Web URL da página da Web externa.
LWC OmniScript Nome do OmniScript usando a sintaxe typeSubTypeLanguage .
Layout OmniScript Layout para renderização OmniScript , seja Newport para não-LWC ou Lightning para LWC.
OmniScript Pré Parâmetros para pré-preencher o OmniScript no formato de string de consulta de URL. Os parâmetros devem ter um
preenchimento prefixo c__. Este campo suporta campos de mesclagem. Por exemplo : c__ firstName =% firstName % .
Pub/Sub Permite que o OmniScript envie mensagens para componentes Web do Lightning separados. Depois verificando this ,
especifique uma mensagem valor chave par .
• Navegar Ação
• Botões no Salesforce Lightning Design System
• Ícones no Salesforce Lightning Design System
Ação Remota
Chame as classes do Apex do OmniScript usando o elemento Remote Action.
Antes de começar
Crie uma classe do Apex no Salesforce para chamar do OmniScript .
1. Adicione uma Ação Remota antes de uma Etapa, em uma Etapa ou após uma Etapa para carregar dados ou
enviar dados no OmniScript . O JSON de dados do OmniScript é enviado como entrada .
2. No campo Classe remota , insira o nome da classe do Apex que a ação chama.

company
NOTA
A classe Apex deve implementar NS .VlocityOpenInterface . NS = o namespace da classe
Apex. Para obter informações sobre namespace, consulte Visualizando o namespace e a
3. No campo Método Remoto , insira um método da classe que a Ação chama. Por exemplo — validAddress .
4. (Opcional) Na Interface DataRaptor Pré e Pós-Transformação — opcionalmente, selecione uma interface
DataRaptor Transform para executar antes ou depois da Ação Remota. Ver DataRaptor Visão geral da
transformação .
5. (Opcional) Altere a quantidade de tempo antes que a ação expire usando a propriedade Remote Timeout. No
elemento, clique em Editar Propriedades como JSON e na propriedade remoteTimeout , defina um tempo em
milissegundos. O tempo limite padrão é 30.000 ou 30 segundos. O máximo é 120.000 ou 120 segundos.
6. (Opcional) Configure propriedades adicionais na Ação Remota. Ver Ação Remota Propriedades .
• Nó JSON de resposta : VlocityNoRootNode
• Caminho JSON de resposta : o nome do elemento OmniScript que recebe o valor.
Exemplo
NOTA
Este exemplo faz referência às classes de solução de problemas OmniScript e OmniCallout e
DataObjectService Apex.
No OmniScript de solução de problemas , o elemento callOut1 Remote Action chama um sistema externo para
verificar se o ativo ainda está na garantia.
Ele implementa a classe OmniCallout e o método checkWarrantyStatus :

company
Como este é um exemplo de OmniScript , o método contém uma resposta codificada:

company
A Ação Remota callOut2 chama o método returnItemOrder , que por sua vez chama a classe DataObjectService que
chama uma instância Heroku para retornar um número de pedido:

company
Estrutura de classe de amostra
A seguinte estrutura de classe pode ser usada para chamar um sistema externo:
global com compartilhamento de classe CustomClassName implementa NS.VlocityOpenInterface {
global CustomClassName () {}
global Boolean invokeMethod (String methodName , Map< String,Object > inputMap , Map< String,Object >
outMap , Map< String,Object > options) {
Resultado booleano = true;

tentar{
if( methodName.equals (' customMethodName ')){
// sua implementação, use outMap para enviar a resposta de volta para

OmniScript
else if( methodName.equals ('customMethodName2')){
// sua implementação, use outMap para enviar a resposta de volta para

OmniScript
} catch(Exception e){
resultado = falso;
Retorna resultado ;
Veja Também

company
• Ação HTTP para procedimentos de integração
Ação Remota Propriedades

Esta página contém informações sobre Propriedades de Ação Remota.
Propriedades Descrição
Aula Remota Classe de Interface Aberta Vlocity .
Método remoto Método de Interface Aberta Vlocity .
Opções remotas Adicional classe invocação opções .
Invocar Modo Configura o comportamento de resposta da ação:
• Padrão — Bloqueia a interface do usuário com um spinner de carregamento.

• Sem bloqueio — é executado de forma assíncrona e a resposta é aplicada à interface do usuário.
Não há suporte para transformações Pré e PostDataRaptor e anexos grandes. Quando o Modo de
Invocação é definido como não bloqueante, os elementos que usam valores padrão não receberão a
resposta porque o elemento é carregado antes do retorno da resposta. Para mapear a resposta para
um elemento, você deve definir Response JSON Node como VlocityNoRootNode e Response JSON
Path para o nome do elemento.
• Fire and Forget — Executa de forma assíncrona sem retorno de chamada para a interface do
usuário. Não há suporte para transformações Pré e PostDataRaptor e anexos grandes. Uma resposta
ainda aparecerá no console de depuração, mas não será aplicada ao Data JSON.
Enviar apenas carga extra Habilita a ação para enviar pares de chave/valor de carga útil extra sem incluir o JSON de dados do
OmniScript .
Mostrar brinde Sobre Conclusão Exibe uma mensagem quando a ação remota subordinada é concluída.
Usar continuação Habilita um Procedimento de Integração subordinado que chama ações de longa duração para usar as
continuações do Apex.
Definir propriedades de erros

Esta página contém informações sobre Propriedades da ação Definir erros.
Elemento Nome O elemento OmniScript para o qual um erro deve ser definido.
Valor O erro mensagem . Opções :
• Mesclar campos de uma etapa anterior (% elementName %)

• Valor literal
• Concatenado valores
• Resultados de fórmulas e funções
• Expressões que combinam as opções: "Status do caso: % caseStatus %"
• Definir erros em um OmniScript
Definir propriedades de valores

Esta página contém informações sobre Propriedades de valores definidos.

company
Elemento Nome O nó JSON para o qual um valor deve ser definido.
Valor O valor a ser atribuído ao nó JSON. Opções :

• Valor literal
• Resultados de fórmulas e funções
Elementos de exibição do OmniScript

Esta página contém uma tabela que explica os elementos OmniScript disponíveis listados na seção Exibir.
Elemento Nome Elemento Descrição Exemplo
Quebra de linha O elemento Line Break exibe uma quebra de linha. Use o elemento de quebra de linha para adicionar quebras de
linha em um
OmniScript
Texto Quadra O elemento Text Block exibe um bloco de texto para o usuário. Use o Editor de Rich Text no Vlocity OmniScript
Projetista
OmniScript Função Elementos

Esta página contém uma tabela que explica os elementos OmniScript disponíveis listados na seção Função.
Elemento Elemento Descrição Exemplo Exemplo
Nome Imagem
Agregar O elemento Aggregate fornece Criar uma fórmula Relâmpago Agregado :

uma variedade de funções para ou agregado em
agregação. Ao contrário do um OmniScript
Componente de fórmula, o
componente Agregado
espera entrada na forma de
uma matriz.
Agregado de Newport :

company
Formula The Formula element Create Formula Lightning Formula:
performs calculations that Fields in an
require complex operations. OmniScript
Newport Formula:
Messaging The Messaging element Display To view the different Message types, see
displays comments, Messaging in Displaying Messaging in OmniScripts.
requirements, success, and OmniScripts
warning messaging
depending on whether the
validate expression is true or
false.
Grupo OmniScript
Esta página contém uma tabela que explica os elementos OmniScript disponíveis listados na seção Grupos.
Elemento Elemento Descrição Exemplo Exemplo Imagem
Nome

company
Quadra O elemento Block agrupa elementos Blocos Relâmpago Bloquear :
dentro de um componente Step em
uma estrutura gerenciável.
Bloco Newport :
Editar Quadra O elemento Edit Block agrupa Usar OmniScript Consulte Configurando um Bloco de Edição .
entradas para permitir que os Editar Quadra
usuários adicionem, editem e
excluam registros.

company
Rádio O elemento Radio Group permite Configurando um Grupo de Rádio Relâmpago :
Grupo que os usuários respondam questionário com
rapidamente a um grande volume o Radio Group
de perguntas de múltipla escolha
em uma única etapa.
Grupo de Rádio Newport :
Etapa O elemento Step divide o Passos Relâmpago Etapa :

OmniScript em diferentes seções.
Etapa de Newport :

company
Modelo O bloco Type Ahead é exibido Configurar tipo Relâmpago Modelo Adiante :
À frente como um campo de entrada de À frente Blocos
Quadra texto; o campo auto completa os
resultados com base na entrada
do usuário.
Tipo de Newport Adiante :
Bloco de ação
Começando com Vlocity Insurance e Health Spring '20, execute várias ações OmniScript de forma assíncrona,
agrupando-as em um bloco de ação.
As ações dentro do Action Block são executadas em paralelo e herdam as configurações do Action Block.
Antes de você começar

Visualize o fluxograma do Bloco de Ação para entender como as ações no Bloco de Ação são executadas.
Ação Quadra fluxo gráfico :
Para configurar um Bloco de Ação:
1. Arraste o Bloco de Ação da paleta de elementos para o designer. Coloque o Bloco de Ação dentro de uma
Etapa, antes da primeira Etapa ou entre as Etapas.
2. Arraste até quatro Ações para o Bloco de Ação.

company
3. Selecione um Modo de Invocação para controlar como as ações dentro do Bloco de Ação são executadas.
Predefinição A ação bloqueia a interface do usuário com um controle giratório de carregamento.
Sem bloqueio A ação é executada de forma assíncrona e a resposta se aplica à interface do usuário. Não há suporte para
transformações pré e pós DataRaptor e anexos grandes.
Incêndio e Esquecer A ação é executada de forma assíncrona sem retorno de chamada para a interface do usuário. Não há suporte para
transformações pré e pós DataRaptor e anexos grandes. Uma resposta ainda aparece no console de depuração, mas
não se aplica ao Data JSON.
• Nó JSON de resposta : VlocityNoRootNode
• Caminho JSON de resposta : o nome do elemento OmniScript que recebe o valor.
5. (Opcional) Marque Aplicar se houver erro para permitir que ações executadas com êxito apliquem suas
respostas ao JSON de dados do OmniScript, mesmo quando outras ações no Bloco de ação falharem. Quando
Aplicar se o erro estiver desmarcado, as ações bem-sucedidas não aplicam suas respostas ao JSON de dados
quando outra ação no bloco falha.
6. (Opcional) Quando o Bloco de Ação estiver dentro de uma Etapa, defina Validação Necessária como Etapa para
evitar que o Bloco de Ação seja executado quando houver erros na Etapa.
7. Visualize o OmniScript para testar o comportamento do Action Block.

company
NOTA
No Vlocity Insurance and Health Spring '20, a propriedade Conditional View do Action Block não
está disponível no LWC Designer. Para editar a propriedade de Visualização Condicional, alterne
temporariamente para o Designer Clássico e configure as propriedades de Visualização
Condicional. Depois que a visualização condicional estiver configurada, salve o OmniScript e volte
para o LWC OmniScript Designer.
Veja Também
• Ação comum Elemento Propriedades

• OmniScript Ação Elementos
• Ação Quadra Propriedades
Ação Quadra Propriedades

Esta página contém informações sobre as propriedades do Bloco de Ação.
Aplicar Se Erro Permite que as ações executadas com êxito apliquem suas respostas ao JSON de dados do OmniScript mesmo quando outras
ações no Bloco de Ação falharem.
Predefinição Uma opção Invoke Mode , Default bloqueia a interface do usuário com um spinner de carregamento até que a ação termine
de ser executada.
Sem bloqueio Uma opção Invoke Mode , Non-Blocking, executa a ação de forma assíncrona e a resposta é aplicada à interface do usuário.
Não há suporte para transformações pré e pós DataRaptor e anexos grandes. Quando Invoke Mode é definido como
nonblocking, os elementos que usam valores padrão não receberão a resposta porque o elemento é carregado antes que a
resposta retorne. Para mapear a resposta para um elemento, você deve definir Response JSON Node como
VlocityNoRootNode e Response JSON Path para o nome do elemento.
Incêndio e Esquecer Uma opção Invoke Mode , Fire and Forget executa a ação de forma assíncrona sem retorno de chamada para a interface do
usuário. Não há suporte para transformações pré e pós DataRaptor e anexos grandes. Uma resposta aparece no console de
depuração, mas não é aplicada ao Data JSON.
Validação Quando definido como Step , Validation Required impede que o Action Block seja executado quando existirem erros na Step.
Requeridos
Veja Também
• Ação Quadra
• OmniScript comum Elemento Propriedades Definições
Quadra
Combine grupos lógicos de elementos em uma Etapa OmniScript usando um elemento Bloco.

company
Os blocos ajudam a agrupar informações para criar dados JSON aninhados. Os blocos estão contidos nas Etapas e
podem ser repetidos para capturar uma matriz de dados. Por exemplo, elementos de rua, cidade, estado e código
postal podem ser combinados em um bloco de endereço.
NOTA
Os blocos não suportam o elemento LWC personalizado. Ver Elemento LWC personalizado .
Para adicionar e configurar um Bloco:
1. Arraste um elemento Block para a tela do OmniScript e nomeie o elemento.

2. Em Rótulo do Campo , insira um rótulo que é exibido para os usuários.
3. (Opcional) Marque Recolher para renderizar um Bloco recolhido no OmniScript .
4. (Opcional) Em Configurações de repetição , marque Ativar repetição para permitir que os usuários adicionem
várias entradas de bloco. Blocos repetíveis armazenam dados em um formato de matriz, onde cada entrada de
bloco é indexada em uma matriz sob o nome do elemento do bloco. Se você planeja acessar dados de um
elemento em um bloco repetível, consulte Avaliação de elementos em blocos repetíveis . Para informações
sobre pré-enchimento blocos , consulte Pré preenchimento Repetivel Blocos .

company
5. (Opcional) Marque Clone ao Repetir para clonar valores quando um Bloco for repetido.
6. (Opcional) No campo Limit Repeat , insira um número para definir o número de vezes que um bloco pode ser
repetido.
7. Visualize o OmniScript e teste a funcionalidade.
8. Observe o formato de saída de dados JSON com base em sua configuração para mapear dados JSO N de Blocos.
Nenhum exemplo de JSON de bloco Exemplo de bloco JSON Repetivel Exemplo de bloco JSON
Veja Também
• Editar Quadra
• Modelo À frente Quadra
Editar Quadra
Começando com Vlocity Insurance and Health Winter '20 e Vlocity CME Winter '20, o LWC OmniScript oferece
suporte a Edit Blocks.
Crie, edite e exclua vários registros externos ou do Salesforce em uma página usando Editar bloco.
Por exemplo, se você estiver coletando as informações de contato de uma conta, poderá adicionar um bloco de
edição ao OmniScript para permitir que os usuários adicionem um registro para cada contato.

company
NOTA
Na versão Summer '17, os três primeiros campos do Edit Block são exibidos por padrão. No
Winter '18, os campos de exibição devem ser escolhidos pelo usuário ao configurar o Edit Block no
OmniScript Designer. Ao desabilitar um OmniScript ativo com um Bloco de Edição criado antes do
Winter '18, você deve determinar quais campos deseja exibir no Bloco de Edição
Bloqueie antes de reativar o OmniScript .
Qual é o próximo
Selecione um Modo de Edição e configure o Bloco de Edição para exibir elementos. Ver Configurando um Editar
Bloquear .
Veja Também
• Adicionando, editando e excluindo registros com ações de edição de bloco
• Substituindo uma edição LWC Quadra
• Trabalhando com Fórmulas no Bloco de Edição
• Configurando um modo de seleção no bloco de edição
• Exibindo Sprites em Edição Quadra
• Editar Quadra Propriedades
Configurando um Editar Quadra

Começando com Vlocity Insurance and Health Winter '20 e Vlocity CME Winter '20 , o LWC OmniScript oferece
suporte a Edit Blocks.
NOTA
Blocos de edição não suportam o elemento LWC personalizado. Para obter mais informações,
consulte Elemento LWC personalizado .
Blocos de edição permitem que um usuário adicione e edite várias entradas em uma única matriz. Por exemplo, você
pode usar um bloco de edição para listar e editar a lista de contatos de uma conta. Blocos de edição são blocos
repetíveis por padrão. O preenchimento prévio de blocos repetíveis com dados é possível usando um formato de
matriz. Para obter mais informações, consulte Pré-preencher blocos repetíveis .
Exibindo elementos em um bloco de edição

Edit Block exibe três elementos na visualização padrão do Edit Block e pode exibir elementos adicionais na
visualização de edição. É possível ocultar elementos, ocultar elementos da visualização de edição.

company
• Para exibir um elemento na visualização padrão do Edit Block, marque a caixa de seleção ao lado do elemento no
painel de estrutura. este elemento também parece quando edição um entrada .
Exemplo de visualização padrão :
• Para exibir apenas elementos quando um usuário edita uma entrada, deixe a caixa de seleção ao lado do
elemento no painel de estrutura desmarcada. Exemplo Editar Visualizar :
• Para ocultar um elemento no Edit Block, no elemento, clique em Edit as JSON e defina Hide igual a true .
Para obter mais informações, consulte Ocultar elementos do OmniScript .
• Para exibir apenas um elemento na visualização padrão do Bloco de Edição:
1. Marque a caixa de seleção ao lado do elemento no painel de estrutura.

2. No Elemento, clique em Editar como JSON e defina Hide igual a true . O elemento é exibido na visualização
padrão da entrada e fica oculto ao editar a entrada.

company
Configurando Modos de Exibição e Modelos
Habilite OmniScripts LWC e OmniScripts Angular para exibir diferentes interfaces de usuário do Bloco de Edição
usando Modos LWC e Modelos Angulares.
Modos LWC
Selecione um modo no campo Edit Block Mode do Edit Block para alterar a exibição e a funcionalidade do Edit
Block.
Modo Notas de configuração Relâmpago Exemplo de
Exemplo Newport
Em linha n/D
Mesa n/D
Demonstrativo Financeiro (FS) • A largura total combinada dos elementos deve

ser menor ou igual a 12.
• Vlocity recomenda exibir menos de doze
elementos.
• Elementos ocultos não afetam a largura total de
exibição
Cartões n/D
NOTA
Disponível a partir de
Seguro Vlocity e
Saúde Primavera '20
Cartões Longos Na versão Winter '20, a largura de LongCards deve

ser definida como 12.
Modelos angulares
Adicione um modelo ao EditBlock Campo ID do modelo HTML para modificar a exibição e a funcionalidade do Bloco
de Edição.
Modelo Nome Relâmpago Exemplo Exemplo de Newport
Responsivo tabela vlcEditBlock.html
Cartões - vlcEditBlockCards.html

company
Demonstrativo Financeiro
vlcEditBlockFS.html
Em linh a - vlc EditBloc kInline.ht ml
longas -
vlcEditBlockLongCards.html
Compatível Elementos
Os seguintes elementos são compatíveis com Editar Bloco:
• Agregar
• Caixa de seleção
• Moeda
• Encontro
• Data hora

company
• Divulgação
• E-mail
• Arquivo
• Fórmula
• Título
• Ação HTTP
• Imagem
• Quebra de linha
• Olho para cima
• Ação da Matriz
• Seleção múltipla
• Número
• Senha
• Rádio
• Grupo de rádio
• Variar
• Ação Remota
• Selecionar
• Assinatura
• Telefone
• Texto
• Área de texto
• Texto Quadra
• Modelo À frente Quadra
• Tempo
• URL
O que vem a seguir

Adicione ações a um Bloco de Edição ou use o mapeamento SObject para criar, editar e excluir registros. Consulte
Adicionando, editando e excluindo registros com ações de edição de bloco .
Veja Também

company
Adicionando, editando e excluindo registros com ações de edição de bloco
Permita que os usuários adicionem, editem e excluam registros usando as ações remotas padrão do Edit Block.
Adicione funcionalidade personalizada configurando ações adicionais.
Editar bloco suporta estas ações:
• Ação HTTP
• Ação Remota
Criando, editando e excluindo registros com ações padrão e mapeamento sObject

Adicione a funcionalidade de Mapeamento sObject adicionando Ações Remotas ao Bloco de Edição para cada opção
que você deseja disponibilizar ao Usuário. Essas ações remotas acessarão as classes do Apex criadas para o Edit
Block e a ferramenta sObject Mapping. As ações padrão usam a propriedade de mapeamento sObject para
determinar como as entradas são mapeadas para um sObject .
NOTA
No LWC OmniScript Designer, a seção SObject Mapping não funciona. Para editar o mapeamento
SObject , use o designer clássico. Quando as edições estiverem concluídas, volte para o LWC
OmniScript Designer para testar o mapeamento.
Para permitir que um usuário crie novas entradas, edite entradas ou exclua entradas:
1. Adicione uma Ação Remota ao Bloco de Edição.

2. Configure o Bloco de Edição usando a convenção de nomenclatura de elemento, Classe e Métod o para cada
uma dessas entradas de tabela:
Elemento Nome Classe Método
(Editar nome do elemento do bloco)- DefaultOmniScriptEditBlock novo

Novo
(Editar nome do elemento do bloco)- DefaultOmniScriptEditBlock editar
Editar
(Editar nome do elemento do bloco)- DefaultOmniScriptEditBlock excluir
Excluir
Mapeie as entradas do Bloco de edição para objetos do Salesforce usando a propriedade MAPEAMENTO DE OBJETO.
Os campos ocultos do usuário, como um ID, permanecem disponíveis para mapeamento.
Para adicionar entradas de mapeamento ao Bloco de Edição:
1. Clique em MAPEAMENTO DE OBJETO para expandir a seção.

2. Clique em Selecionar objeto e selecione um objeto do Salesforce.
3. Clique em + Adicionar mapeamento .

company
4. No campo Editar elemento do bloco, insira o nome de um elemento que está no bloco de edição.
NOTA
Por padrão, novas entradas são adicionadas e as entradas existentes são atualizadas. Para
criar um novo registro em vez de atualizar um existente, marque a caixa de seleção Duplicar
chave .
5. No campo sObject , selecione um campo sObject . O elemento será mapeado para este campo.
NOTA
Você deve adicionar um Elemento de Texto para armazenar o Id do registro no Bloco de
Edição . O elemento que contém o ID do registro deve mapear para o sObject's Campo de ID na
seção MAPEAMENTO DE OBJETO . Para ocultar a exibição do elemento na interface do usuário,
consulte Usando a propriedade Hide em componentes OmniScript .
Adicionando ações personalizadas

Adicione ações personalizadas para incluir funcionalidades adicionais em seu Bloco de Edição.
Para adicionar uma ação personalizada:
1. Adicione uma ação ao bloco de edição.

2. Nomeie o elemento. As ações no bloco de edição aparecerão no menu suspenso abaixo das ações padrão por
padrão.
3. (Opcional) Para que uma ação substitua as ações padrão Nova, Editar ou Excluir na interface do usuário, nomeie
o elemento Ação e anexe o tipo de ação.
Substituir Ação Exemplo Elemento Nome
Novo Adicionar usuárioNovo
Editar Alterar endereçoEditar
Excluir Remover ContaExcluir
4. Adicione um rótulo à ação.

5. Configure o Ação .
Adicionando ações globais

Execute ações em todo o JSON para o bloco de edição adicionando ações globais. As ações globais são exibidas fora
das entradas Editar Bloco.
Para adicionar uma ação global:
1. Adicione uma ação ao bloco de edição.

2. Nomeie o elemento e acrescente Global ao Nome do Elemento. Por exemplo, para tornar uma ação com o
nome do elemento DeleteUsers uma ação global, o nome do elemento deve ser DeleteUsersGlobal .

company
3. Adicione um rótulo à Ação.
4. Configure o Ação .
Veja Também
• Configurando um Editar Quadra
Exibindo Sprites em Edição Quadra

Exiba Sprites para indicar informações sobre uma entrada de registro Edit Block usando as propriedades Default Svg
Sprite e Default Svg Icon . Por exemplo, um ícone de usuário pode ser exibido se a entrada for um registro de
contato. O Vlocity é compatível com os ícones do Lightning Design System encontrados aqui . Exiba dinamicamente
diferentes sprites mapeando os valores possíveis do Elemento de controle SVG para ícones SLDS no Mapa do
elemento de controle SVG .
Substituindo o Sprite e Ícone SVG Padrão Para

substituir o Sprite e Ícone SVG Padrão:
1. Procure um ícone SLDS e observe a categoria e o nome do ícone.

2. No campo Sprite SVG padrão , insira a categoria do ícone.
3. No campo Ícone SVG padrão , insira o nome do ícone.
4. Visualize o OmniScript para visualizar o novo ícone SVG padrão.
Exibindo ícones SVG dinamicamente

Para exibir dinamicamente diferentes ícones SVG:
1. No Elemento de Controle SVG do Bloco de Edição , insira o nome de um Elemento no Bloco de Edição.
2. No Mapa do Elemento de Controle Svg , clique em Adicionar Ícone SVG.
3. No campo Valor do ícone SVG, insira um valor possível para o Elemento de controle SVG.
4. Procure um ícone SLDS e observe a categoria e o nome do ícone.
5. No campo Svg Sprite , insira a categoria do ícone.
6. No campo Ícone Svg , digite o nome do ícone.
7. Visualize o OmniScript e insira o valor do Elemento de controle SVG para testar a funcionalidade.
8. (Opcional) Repita as etapas para valores de elemento adicionais.

company
Veja Também
Configurando um modo de seleção no bloco de edição

Os modos de seleção permitem que os usuários alterem o valor booleano de uma entrada Editar bloco no JSON de
dados clicando em Editar entradas de bloco.
NOTA
Modo de Seleção está disponível apenas para Cartões, LongCards e Mesa.
Para definir um modo de seleção:
1. Adicione um elemento Checkbox ao Edit Block e nomeie o elemento. Por exemplo , elemento Nome =
PaidInFull .
2. (Opcional) Oculte o elemento do Edit Block clicando em Edit as JSON e definindo Hide igual a true .
3. No Edit Block, defina Select Mode igual a Single ou Multi .
4. Insira o nome do elemento Checkbox no campo Checkbox Element Name .
5. Visualize o OmniScript , crie entradas de Editar bloco e selecione as entradas.
6. Clique em { Dados } para abrir o painel de dados e visualizar os valores booleanos para a entrada Editar Bloco.

company
Veja Também
Trabalhando com Fórmulas no Bloco de Edição
Execute equações e combine strings usando Formula Elements. Coloque fórmulas em um Bloco de Edição para
acessar os valores do elemento em uma entrada específica do Bloco de Edição. Coloque a Fórmula fora do Bloco de
Edição na mesma Etapa para acessar um valor de elemento para todas as entradas do Bloco de Edição.
Para acessar dados em uma entrada específica do Bloco de Edição:
1. Adicione um elemento Fórmula ao Bloco de Edição.

2. Usando a sintaxe do campo de mesclagem, adicione o Nome do Elemento do Bloco de Edição e o Nome do
Elemento para o elemento que você deseja acessar na Fórmula. Por exemplo, % EditBlock:FirstName % . Para
obter mais informações sobre campos de mesclagem, consulte Acessar o JSON de dados do OmniScript com
campos de mesclagem .
3. Adicione um |n após o nome do elemento Editar bloco para definir a fórmula para acessar apenas o valor do
campo de mesclagem para sua instância. O uso da sintaxe |n é necessário porque o Bloco de Edição armazena
valores de entrada em um formato de matriz. O resultado sintaxe é % EditBlock|n:FirstName % .
4. Concatene valores combinando-os usando a sintaxe |n. Por exemplo, % EditBlock | n:FirstName% + " " + %
EditBlock|n:LastName % .

company
Para acessar cada índice de uma matriz Editar Bloco em uma fórmula:
1. Coloque uma Fórmula fora do Bloco de Edição.

2. No editor de fórmulas, adicione o nome do elemento usando a sintaxe do campo de mesclagem. Por exemplo,
para retornar a soma de todas as entradas de um elemento Number em um Edit Block, você usaria a seguinte
sintaxe no editor de fórmulas: SUM(%EditBlock1:NetIncome%) , em que NetIncome é o nome de um elemento
Number.
3. (Opcional) Ao usar o modelo vlcEditBlockFS.html, exiba a fórmula na parte superior do Bloco de Edição
adicionando o nome do elemento Fórmula à propriedade Elemento de Soma do Bloco de Edição .
Veja Também

Substituindo uma edição LWC Quadra

Aplique código personalizado a um Bloco de Edição estendendo e substituindo os componentes do Bloco de Edição.

company
Blocos de edição contêm até três campos de substituição de LWC com base no modo de edição do bloco de edição.
Para obter informações sobre os Modos de Edição, consulte Configurando um Bloco de Edição .
Propriedade Descrição Compatível Editar Exemplo
Modos
Componente LWC Personalize o componente Editar bloco estendendo o Tudo Estendendo o Bloco de
Sobrepor componente Editar bloco. Edição
LWC
Editar rótulo de bloco LWC Personalize o rótulo do Bloco de Edição substituindo Cartões, Cartões Longos Estendendo o Bloco de
Substituição de componente o componente do rótulo. Edição
Etiqueta LWC
Editar bloco novo LWC Personalize o clique em Editar cartão de bloco para Cartões Estendendo o Bloco de
Substituição de componente criar novas entradas substituindo o componente Novo Edição
LWC. Novo LWC
Veja Também
Extensão a Editar Bloco LWC

Personalize o Edit Block de um LWC OmniScript estendendo o Edit Block LWC.
O Edit Block LWC substitui todo o Edit Block LWC, a menos que o Edit Mode seja Cards ou Long Cards. Cartões e
Cartões Longos incluem LWCs extensíveis adicionais. Para obter informações sobre as opções de cartões e cartões
longos LWC, consulte Substituindo um bloco de edição LWC .

Certifique-se de compreender os requisitos para estender o componente da Web do Lightning de um elemento
OmniScript . Para obter mais informações, consulte Estender o componente da Web do Lightning de um elemento
OmniScript .
Para estender e personalizar o Edit Block LWC:
1. No VisualStudio , crie um LWC personalizado ou baixe um exemplo de Edit Block LWC personalizado clicando
aqui . O código no exemplo personalizado do LWC altera o plano de fundo do cartão Edit Block para verde.
Edição original Cartão de bloqueio Exemplo de cartão de edição personalizada

company
2. No arquivo JavaScript do LWC, estenda o Edit Block LWC. Usando este exemplo de código, substitua o NS pelo
namespace do pacote. Para obter informações sobre como localizar o namespace, consulte Visualizando o
namespace e a versão do OmniStudio Pacote Vlocity . Exemplo :
importar omniscriptEditBlock de "VLOCITYNAMESPACE/ omniscriptEditBlock ";

importar modelo de "./editblockCardCustomize.html" exportar classe padrão
editblockCardCustomize estende
omniscriptEditBlock {
// suas propriedades e métodos aqui
render()
{
if ( this.jsonDef ) {
this._ hasChildren = this.jsonDef.children.length > 0; this._ isFirstIndex = this.jsonDef.index === 0;
if (this._ isCards && this._ isFirstIndex ) {

// esconde o primeiro cartão curto sem filhos
if (!this._ hasChildren ) {
this.classList.add ( this._theme + '-hide');
} senão {
this.classList.remove ( this._theme + '-hide');
}
}
}
Retorna modelo ;
}
}
3. Adicione código ao LWC personalizado.
4. Implante o LWC personalizado no Salesforce. Consulte Implantar componentes da Web do Lightning .
5. Vá para o OmniScript que contém o Edit Block LWC.

company
6. No campo Edit Block's LWC Component Override , insira o nome do LWC personalizado.
7. Ative o OmniScript e visualize suas alterações.
Veja Também
Estendendo o Edit Block Label LWC

Personalize o rótulo de um bloco de edição de LWC para os modos de edição de cartões e cartões longos
estendendo o LWC de rótulo de bloco de edição.
Exclusivo para o modo de edição Cards e Long Cards, o Edit Block Label LWC substitui os rótulos originais, incluindo
ações globais. Para obter informações sobre opções adicionais de LWC de cartões longos, consulte Substituindo um
bloco de edição de LWC .

OmniScript .
Para estender e personalizar o Edit Block Label LWC:
1. No VisualStudio , crie um LWC personalizado ou baixe um exemplo de Edit Block LWC personalizado clicando
aqui . O código no exemplo de LWC personalizado altera o rótulo de uma ação global para verde.
Edição original Quadra Etiqueta Personalizado Editar Quadra Etiqueta
2. No arquivo JavaScript do LWC, estenda o LWC Edit Block Label. Usando este exemplo de código, substitua o NS
pelo namespace do pacote. Para obter informações sobre como localizar o namespace, consulte Visualizando o
namespace e a versão do OmniStudio Pacote Vlocity . Exemplo :
importar omniscriptEditBlockLabel de "NS/ omniscriptEditBlockLabel ";

importar modelo de "./editblockLabelCustomize.html" exportar classe padrão
editblockLabelCustomize estende
omniscriptEditBlockLabel {
render()
{
Retorna modelo ;

company
}
}
6. Nas propriedades do Edit Block, selecione Edit Block Mode e clique em Cards ou LongCards .
7. No campo Edit Block Label Component Override do bloco , insira o nome do LWC personalizado.
Veja Também
Estendendo o Bloco de Edição Novo LWC

Personalize o novo cartão de entrada de um LWC Edit Block estendendo o Edit Block New LWC.
Exclusivo do modo Card Edit, o Edit Block New LWC substitui o novo cartão de entrada. Para obter informações
sobre opções adicionais de cartões LWC, consulte Substituindo um bloco de edição LWC .

OmniScript .
Para estender e personalizar o Edit Block New LWC:
1. No VisualStudio , crie um LWC personalizado ou baixe um exemplo personalizado de Editar Bloco Novo LWC
clicando aqui . O código no exemplo de LWC personalizado altera a cor do texto para verde.
Bloco de edição original novo cartão Novo exemplo de bloco de edição personalizada

company
2. No arquivo JavaScript do LWC, estenda o Edit Block New LWC. Usando este exemplo de código, substitua o NS
pelo namespace do pacote. Para obter informações sobre como localizar o namespace, consulte Visualizando o
namespace e a versão do OmniStudio Pacote Vlocity .
Exemplo:
importar omniscriptEditBlockNew de "NS/ omniscriptEditBlockNew ";

importar modelo de "./editblockNewCustomize.html" exportar a classe padrão
editblockNewCustomize extends
omniscriptEditBlockNew {
render()
{
Retorna modelo ;
}
}
6. Nas propriedades do Edit Block, clique em Edit Block Mode e selecione Cards .
7. No campo Editar bloco de substituição do novo componente LWC do bloco , insira o nome do LWC
personalizado.
Veja Também


company
Editar Quadra Propriedades
Esta seção contém informações sobre as propriedades de Editar Bloco. Para obter informações sobre como
configurar essas propriedades, consulte Configurando um Bloco de Edição .
Permitir Excluir Permite que os usuários acessem uma ação que exclui uma entrada.
Permitir Editar Permite que os usuários acessem uma ação que edita uma entrada.
Permitir novo Permite que os usuários acessem uma Ação que cria uma nova entrada no Bloco de Edição.
Excluir rótulo O rótulo de texto que aparece para a ação de exclusão.
Editar Quadra Modo Exclusivo para LWC OmniScripts ; define o estilo para as entradas do Bloco de Edição.
Editar Etiqueta O rótulo de texto que aparece para a ação de edição.
Novo rótulo O rótulo de texto que aparece para a Nova Ação.
Sprite SVG padrão O nome da categoria Sprite SVG padrão. Por padrão, este campo é definido para a categoria de utilitário.
Ícone SVG padrão O nome do ícone SVG padrão que está dentro da categoria do Sprite SVG padrão. Por padrão, este campo é definido
para o ícone do usuário.
Controle SVG Elemento O nome de um elemento no Bloco de Edição cujo valor controla dinamicamente se um ícone SVG alternativo é
exibido.
Elemento de soma O Elemento de Soma exibe o valor de uma Fórmula colocada fora do Bloco de Edição.
Selecionar Modo Exclusivo do LWC OmniScript , o Select Mode permite que os usuários definam o valor booleano de uma caixa de
seleção como true selecionando Editar entradas de bloco. O Modo de Seleção está disponível apenas para Cartões,
LongCards e Blocos de Edição de Tabela.
Caixa de seleção Elemento Insira o nome de um elemento Checkbox no Edit Block. Este elemento permite que o Modo de Seleção funcione.
Nome
sMapeamento de Objetos Permite que os usuários usem as ações padrão do Vlocity para mapear as entradas do Bloco de Edição para registros
do Salesforce.
Para obter informações sobre propriedades comuns, consulte Definições de propriedades comuns do elemento
OmniScript .
Veja Também
Configurando um questionário com o Radio Group

company
do OmniScript permite criar e exibir perguntas em formato de questionário.
NOTA
O Radio Group oferece as mesmas opções para cada pergunta. Para fornecer opções diferentes
para cada pergunta, consulte Adicionar opções para seleções, seleções múltiplas e botões de opção .
Para configurar um questionário com o Radio Group:
1. Arraste um grupo de rádio para uma etapa existente no painel de estrutura.

2. Propriedades do Grupo de Rádio , em Opções, adicione Valores e Rótulos . Esses representar a usuários
selecionável opções .
NOTE
Using a value f rom a Radio Group as a conditional in another element requires adding
the Radio Group's element name as the parent node. The image below displays an
example of how to ref erence a Radio Group value in a conditional:
3. (Opcional) Selecione o botão Definir tudo ao lado de uma opção para verificar todos os campos de uma vez
quando a opção for selecionada.

company
4. Em Perguntas do grupo de rádio , adicione perguntas no campo Rótulo e insira Valores para armazenar a
resposta do usuário. Os rótulos representam as perguntas exibidas à esquerda das opções selecionáveis.
5. (Opcional) Defina a largura dos rótulos de rádio . Alterar a largura dos rótulos do grupo de rádio altera a
largura dos rótulos de opções.
6. Visualize o OmniScript para testar o questionário.
Passos
Ao criar a estrutura de script para um OmniScript , as etapas devem ser usadas para criar cada "página" do
formulário. Os usuários podem navegar pelas Etapas usando os botões Próximo e Anterior. Você pode habilitar a
validação de campo para uma Etapa, o que significa que todos os campos obrigatórios na Etapa devem ser
preenchidos para avançar. Elementos de exibição condicional O uso da propriedade de exibição condicional pode ser
feito aplicando exibições condicionais às etapas. Isso permite que você crie um OmniScript que oferece diferentes
experiências com base nas respostas do usuário.
Exemplo de etapa
No exemplo de OmniScript mostrado abaixo, a primeira etapa é chamada de Informações do agente:

company
Aqui está o mesmo Step renderizado no formulário:

company
O campo Instrução na configuração do elemento Step aparece no modo Horizontal e é rico em HTML:

company
O Step Chart do OmniScript pode ser ocultado marcando Hide Step Chart na Configuração do Script:
A propriedade Step Chart Label permite que você escreva um texto separado do rótulo de exibição principal da
Etapa:

company
Bloco de digitação à frente
Exiba uma lista de resultados quando um usuário começar a digitar em um campo de entrada usando o Bloco de
digitação antecipada. Quando um usuário seleciona um registro, o Bloco Type Ahead pode recuperar informações
adicionais relacionadas ao registro. Por exemplo, um bloco Type Ahead pode ser usado com um DataRaptor para
listar contas nos resultados.
No OmniScript Designer, o Bloco Type Ahead está localizado na seção Grupos de Componentes Disponíveis.
Exiba uma lista de resultados quando um usuário começar a digitar em um campo de entrada usando o Bloco de
digitação antecipada. Quando um usuário seleciona um registro, o Bloco Type Ahead pode recuperar informações
adicionais relacionadas ao registro. Por exemplo, um bloco Type Ahead pode ser usado com um DataRaptor para
listar contas nos resultados.
No OmniScript Designer, o Bloco Type Ahead está localizado na seção Grupos de Componentes Disponíveis.
Veja Também
• Adicionar e configurar um bloco de digitação antecipada
• Fazer uma chamada HTTP a partir de um bloco Type Ahead
• Usando o preenchimento automático do Google Maps em OmniScripts
• Usando o bloco de digitação antecipada com dados JSON
• Use o bloco Type Ahead com DataRaptor
• Modelo À frente Quadra Propriedades
Adicionar e configurar um bloco de digitação antecipada

Configure como os usuários podem criar e editar registros no Bloco de Edição.
1. Adicione o elemento Type Ahead Block à tela do OmniScript.

company
NOTA
Se existir um bloco Type Ahead em um elemento Block, somente um elemento Block é
permitido.
Adicionar vários blocos aninhados resultará em erros.
2. Adicione um elemento Action no Bloco Type Ahead para recuperar dados ou semear o Bloco Type Ahead com
dados. Os blocos de digitação antecipada são compatíveis apenas com o uso de uma única ação.
Fontes de dados compatíveis Descrição Exemplo de digitação antecipada
Dados JSON Acessa uma matriz de dados presentes no JSON de Usando o bloco de digitação antecipada com
dados do OmniScript. dados JSON
Ação de extração do DataRaptor Recupera dados internos ou externos do Salesforce. Use o bloco Type Ahead com DataRaptor
Google Maps Automático Chama uma API do Google Maps para recuperar Como usar o preenchimento automático do
Completo dados do Google Maps. Google Maps em
OmniScripts
Ação HTTP Recupera dados externos. Faça uma chamada HTTP de um Type Ahead
Quadra
Ação Remota Recupera dados de uma classe do Apex. n/D
3. Adicione elementos de entrada no bloco Type Ahead para mapear os dados de resposta.
Para ocultar um elemento, como um Id, do usuário, preencha-o previamente com dados do TypeAhead usando
estas etapas:
a. No painel de propriedades do elemento, clique em Editar como JSON . A definição JSON do elemento é
exibida.
b. Defina o valor da propriedade hide como true .
c. Marque a caixa disponível para pré-preenchimento quando oculto .
4. Configure propriedades adicionais no Bloco de Edição para definir o acesso a dados de um usuário. Consulte
Propriedades do bloco de digitação antecipada .
5. Adicione estilo e comportamento personalizados substituindo os componentes LWC Type Ahead Block. O
campo Substituição do componente LWC substitui apenas o componente Type Ahead.
Tipo de LWC de Bloco Descrição
Antecipado
omniscriptTypeahead Substitui o componente Type Ahead que lista os resultados dos dados.
omniscriptTypeaheadBlock Substitui o componente Type Ahead Block que incorpora o componente Type Ahead.
Barra de progresso Os blocos LWC Type Ahead exibem uma barra de progresso ao recuperar os resultados dos dados. Para
obter informações sobre como personalizar a barra de progresso, consulte Base Vlocity LWC ReadMe
Reference .
Veja também
• Usando o preenchimento automático do Google Maps em OmniScripts

company
• Bloco de digitação à frente
• Propriedades do bloco de digitação antecipada
Fazer uma chamada HTTP a partir de um bloco Type Ahead

Recupere dados de um URL em seu bloco de digitação antecipada usando uma ação HTTP.
1. Adicione um bloco de digitação antecipada ao seu OmniScript.
2. Arraste a ação HTTP para o Bloco Type Ahead. Consulte Definições de estrutura de script OmniScript para obter
mais informações.
3. Configure sua ação HTTP inserindo seu caminho HTTP e seu método HTTP.
4. Adicione campos ao seu Bloco de digitação antecipada para os itens que estão sendo retornados pela ação
HTTP.
Por padrão, a entrada do usuário será filtrada em relação a uma correspondência LIKE. Para retornar resultados não
filtrados, marque a caixa de seleção Desativar filtro de dados nas propriedades do Bloco de digitação antecipada.
Veja também
Usando o bloco de digitação antecipada com dados JSON

O Type Ahead Block pode usar um Data JSON como sua origem em vez de uma API, HTTP ou ação remota. O uso de
um Data JSON permite que a resposta do Type Ahead Block seja feita do lado do cliente, em ve z de precisar fazer
chamadas de servidor.
Por exemplo, você pode querer usar um Data JSON com uma matriz contendo uma lista dos nomes de seus planos
de cobertura. Conforme seu agente começa a digitar, uma lista de nomes de planos é exibida, permitindo que o
agente escolha um.
Para usar um Data JSON como a origem do seu bloco Type Ahead:
1. Marque a caixa de seleção Usar JSON de Dados

2. No caminho JSON de dados, insira o nome de um nó JSON de nível raiz retornado pela resposta da ação.
NOTA
O caminho JSON de dados só aceita dados no nível raiz do JSON.

company
Por padrão, a entrada do usuário é filtrada usando uma correspondência LIKE . Para retornar resultados não
filtrados, marque Disable Data Filter nas propriedades do Type Ahead Block.
Para fazer com que o bloco Type Ahead se comporte como o elemento Lookup, marque a caixa de seleção Lookup
Mode . Em vez de digitar para retornar um conjunto de valores, os usuários selecionam em um conjunto de valores.
Veja também
Usando o preenchimento automático do Google Maps em OmniScripts

Recupere dados do Google Maps e exiba um local no bloco Type Ahead usando a API do Google Maps.
A funcionalidade do Google Maps do bloco Type Ahead requer que você use uma chave de API do Google Maps. Veja
Google .
2. etiqueta do campo do bloco Type Ahead , insira o texto a ser exibido no campo de pesquisa do google maps.
3. Marque a caixa de seleção Ativar preenchimento automático do Google Maps para exibir a seção
Preenchimento automático do Google Maps .
4. No campo Chave de API do Google Maps, insira sua chave de API JavaScript do Google Maps. Se você não tiver
uma chave de API JavaScript do Google Maps, obtenha uma do Google.
5. (Opcional) Para ocultar o widget do Google Maps, marque Ocultar mapa .
6. Clique no campo Filtro de país e selecione um país.
7. Visualize o OmniScript para executar uma pesquisa e retornar uma resposta do Google.
8. Abra o Action Debugger para visualizar a resposta.

company
Estes são os nós de resposta disponíveis:
• As respostas retornam conjuntos de dados exclusivos, dependendo da configuração.
Além dos nós de resposta padrão, esta tabela exibe nós de resposta que também podem estar disponíveis na
resposta do Google. Para obter informações detalhadas sobre cada nó de resposta, consulte Google
Geocoding API (documentação do Google).
Nó de resposta Descrição
endereço da Rua Um endereço de rua.
rota Uma rota nomeada, por exemplo, I-5.
interseção Um cruzamento importante.
político Uma entidade política.
país Uma entidade política nacional.
geometria Um objeto contendo longitude e latitude.
administrativo_area_level_1 Uma entidade civil de primeira ordem abaixo do nível do país, por exemplo, estados.
administrativo_area_level_2 Uma entidade civil de segunda ordem, por exemplo, condados.
administrativo_area_level_3 Uma entidade civil de terceira ordem.
administrativo_area_level_4 Uma entidade civil de quarta ordem.
administrativo_area_level_5 Uma entidade civil de quinta ordem.
coloquial_area Um nome alternativo comum para a entidade.
localidade Uma cidade incorporada.
sublocalidade Uma entidade civil de primeira ordem abaixo da localidade. A sublocalidade pode conter entidades
civis adicionais em nós de sublocality_level_1 a sublocality_level_5 .
vizinhança Uma vizinhança.
premissa Um local, por exemplo, um edifício.
subinstalação Uma entidade de primeira ordem abaixo de um local, por exemplo, um edifício.
plus_code Uma referência de localização codificada tirada da latitude e longitude.
Código postal Um código postal.

company
recurso_natural Uma característica natural importante.
aeroporto Um aeroporto.
parque Um nome de parque.
ponto de interesse Um ponto de interesse, geralmente uma importante entidade local, por exemplo, a Golden Gate
Bridge.
tipos Uma matriz contendo o tipo da resposta. Por exemplo, San Francisco é um tipo de localidade.
9. Adicione um elemento ao bloco Type Ahead para mapear dados de um nó de resposta do Google. Os
elementos no bloco Type Ahead aparecem como um elemento filho selecionável na seção Google
Transformation .
10. Na seção Transformações do Google, clique em Adicionar novo mapeamento .

11. Selecione um elemento filho e mapeie-o para um nó de resposta do Google .
Consulte a resposta do depurador de ações e mapeie esses tipos de dados aninhados adicionais inserindo a
notação correta no campo Nó de resposta do Google :
Nó de resposta Tipo de dados Exemplo de notação
geometria Objeto geometria:local:lat
tipos Variedade tipos|1
12. Salve o OmniScript e execute-o na visualização para visualizar seus mapeamentos.
Veja também

company
Use o bloco Type Ahead com DataRaptor
Recupere dados em seu bloco Type Ahead usando DataRaptor

2. Arraste um componente DataRaptor Extract Action para a estrutura do Type Ahead Block. Consulte Definições
de estrutura de script OmniScript para obter mais informações.
3. Para configurar sua ação de extração do DataRaptor , selecione uma interface do DataRaptor e defina seus
parâmetros de entrada. Para passar a entrada do usuário para o DataRaptor, defina um parâmetro de entrada
para o nome do elemento do bloco Type Ahead.
4. Adicione campos ao seu bloco de digitação antecipada.
5. Para preencher os campos, defina os nomes dos elementos para corresponder aos dados extraídos retornados
pela ação de extração do DataRaptor. Para obter mais informações sobre como preencher elementos, consulte
Prefill OmniScript Elements using DataRaptor .
Veja também
Propriedades do bloco de digitação antecipada
Esta página contém informações sobre as propriedades do bloco Type Ahead.
Tecla de digitação Onde aplicar os dados retornados pela ação. Para invocar JavaScript para análise, defina Data Process Function .
antecipada
Modo de edição Marque para exibir os campos no bloco Type Ahead automaticamente. Se o Modo de edição não estiver marcado, os
usuários poderão clicar no botão editar para exibir os campos. A exibição do campo permite que os usuários insiram
informações nos campos sem usar a digitação antecipada.
Chave da API do Google Insira uma chave de API do Google Maps.

Maps
Novo rótulo de item Permite que os usuários adicionem uma nova entrada ao usar o bloco Type Ahead. Por padrão, os usuários só
podem escolher na lista de valores.
Ocultar botão de edição Impede que o botão Editar seja exibido. Se o Modo de edição estiver marcado, os campos Bloco de digitação
antecipada ainda serão exibidos para o usuário.
Ocultar mapa Oculta o widget do Google Maps no OmniScript.
Resposta do Google O nome do nó de resposta do Google. Visualize o OmniScript para executar a pesquisa do Google e visualizar todos os
Nó nós de resposta disponíveis no depurador de ações.
Veja também

company
Elementos de entrada OmniScript

Esta página contém uma tabela que explica os elementos OmniScript disponíveis listados na seção Entradas.
Elemento Descrição do elemento Imagem de exemplo
Nome
Caixa de seleção Checkbox é um controle de entrada booleano. Ele retorna true Caixa de seleção Relâmpago:
ou false para o Data JSON.
Caixa de seleção de Newport:

company
Moeda O elemento Currency registra um valor de moeda em uma única Moeda Relâmpago:
linha. Para configurar o símbolo de moeda exibido no
OmniScript, você tem as seguintes opções:
• Em organizações do Salesforce de moeda única, o Código de

moeda é definido como a moeda da organização por padrão.
Nenhuma configuração é necessária.
• Em organizações do Salesforce com várias moedas, o Código
de moeda muda para o código de moeda de um usuário atual
por padrão. Nenhuma configuração é necessária. Para obter
informações sobre como configurar várias moedas, consulte
Gerenciar várias moedas .
• Substitua o código da moeda por um valor padrão. Na
Configuração de script, defina o campo Código de moeda para
um código de moeda compatível.
• Na URL que inicia o script, defina o
Parâmetro OmniScriptCurrencyCode. Por exemplo:
&OmniScriptCurrencyCode=JPY
• (Exclusivo para LWC OmniScripts) Exiba o CurrencyCode
marcando a caixa de seleção Exibir código de moeda no
elemento Moeda.
• Em uma página do VisualForce que exibe um OmniScript,
definindo o strOmniScriptCurrencyCode como um código de
moeda.
Moeda de Newport:
Personalizado Exclusivo para LWC OmniScripts, adicione um LWC personalizado a n / D

LWC um OmniScript usando o elemento Custom LWC. Consulte
Elemento LWC personalizado .

company
Encontro O elemento Date é usado para campos de entrada que devem Data do Relâmpago:
conter uma data. O tipo de data pode ser definido como String
ou Date para um elemento Date. Definir o Tipo de Data para
String resulta no uso da Data Absoluta. O formato de data do
modelo, pode ser definido na configuração do elemento.
O padrão é aaaa-MM-dd.
Data de Newport:
Data hora O elemento Date é usado para campos de entrada que devem Data/hora do relâmpago:
conter uma data e hora. Exibe dois campos. A propriedade
timezone oferece a opção de definir o fuso horário para a hora
do objeto User ou a hora local do navegador.
Data/Hora de Newport:

company
Divulgação Exibe o texto da Divulgação e possui uma caixa de seleção para o Divulgação do Relâmpago:
usuário selecionar se concorda ou não com a divulgação.
Divulgação de Newport:

company
E-mail O elemento Email é usado para campos de entrada que devem E-mail Relâmpago:
conter um endereço de email.
E-mail Newport:
Arquivo O elemento File permite que o usuário carregue um arquivo Arquivo Relâmpago:
de seu computador para que seja acessível pelo OmniScript.
Arquivo Newport:

company
Imagem O elemento Image define uma imagem no Omniscript. Imagem do Relâmpago:
Imagem de Newport:
Olho para cima O elemento Lookup chama o serviço DataRaptor Output para Pesquisa Relâmpago:
consultar tabelas SFDC e preencher o elemento com os
resultados da consulta. s
Pesquisa de Newport:

company
Seleção múltipla Quando um valor é selecionado, o "Value" independente de Seleção múltipla do relâmpago:
idioma no Data JSON é preenchido.
Seleção múltipla de Newport:
Número Um campo de entrada numérico. Número do Relâmpago:
Número de Newport:

company
Password The Password element is a password field. Lightning Password:
Newport Password:

company
Radio Radio buttons let a user select one of a limited number of Lightning Radio Display Mode Options:
options. Options are displayed in a vertical list.
Horizontal:
Image:
Vertical:
Newport Radio Display Mode Options:
Horizontal:

company
Image:
Segment:
Vertical:

company
Lightning Range:
Newport Range:
Range O elemento Range é usado para campos de entrada que devem

conter um valor dentro de um intervalo.

company
Select Displays a dropdown menu of values. When a value is Lightning Select:
selected, the language-independent "value" is populated
in the Data JSON.
Lightning Select Dropdown:
Newport Select:
Newport Select Dropdown:

company
Assinatura O elemento Signature coleta uma assinatura durante um Assinatura do Relâmpago:
OmniScript. Este campo pode ser obrigatório.
Assinatura de Newport:
Telefone O elemento Telefone é usado para campos de entrada que Telefone Relâmpago:
devem conter um número de telefone.
Telefone Newport:

company
Texto O elemento Text é um campo de entrada de texto de uma linha. Texto Relâmpago:
Texto de Newport:
Área de texto O elemento Text Area é um campo de entrada de texto de várias Área de Texto Relâmpago:
linhas.
Área de Texto de Newport:

company
Tempo O elemento Time permite que os usuários insiram uma hora no Tempo do Relâmpago:
campo.
Hora de Newport:
URL O elemento URL é usado para campos de entrada que devem URL do relâmpago:
conter um endereço de URL.
URL de Newport:
Elemento de caixa de seleção OmniScripts

Permita que os usuários marquem uma caixa de seleção adicionando o elemento Checkbox ao OmniScript. Por
exemplo, mapeie a resposta sim/não do usuário para um campo verdadeiro/falso em um registro.
1. Arraste um elemento Checkbox do painel Build para a tela.

2. No painel Propriedades, dê um nome ao elemento no campo Nome .
3. Em Rótulo do Campo , insira um rótulo visível para o usuário.

company
4. (Opcional) Selecione Valor padrão para habilitar a caixa de seleção por padrão. O valor é true ou false no
Data JSON.
5. (Opcional) Para propriedades adicionais, consulte Definições de propriedades comuns do elemento
OmniScript .
Veja também
• Elementos de entrada OmniScript
• Referência do elemento OmniScript
Elemento de moeda OmniScripts

Permita que os usuários insiram um valor em moeda adicionando o elemento Moeda ao OmniScript. Atualize
as opções de formato padrão, como o número de casas decimais a serem exibidas, o valor mínimo e máximo
da moeda e muito mais.
1. Arraste um elemento Currency do painel Build para a tela.

4. (Opcional) Para substituir o formato padrão permitido, selecione Máscara Personalizada e insira uma
nova máscara no campo Substituição de Formato: Máscara Personalizada . Por exemplo, a máscara
###,### transforma uma entrada de 123456 em 123.456. Consulte Máscara Padrão .
5. (Opcional) Em Format Override: Decimal Places , insira um número para alterar o número padrão de
casas decimais a serem exibidas.
6. (Opcional) Em Valor mínimo da moeda , insira o valor mínimo que um usuário pode inserir, como 1 .
7. (Opcional) Em Valor máximo da moeda , insira o valor máximo que um usuário pode inserir, como 10.000
.
8. (Opcional) Selecione Permitir números negativos para permitir que os usuários insiram valores negativos,
como -15 .
9. (Opcional) Selecione Ocultar separadores de vírgulas para ocultar vírgulas para valores maiores que três
dígitos. Por exemplo, exiba 1.000 em vez de 1.000.
10. (Opcional) Selecione Exibir código de moeda para exibir um código de moeda com base na localidade do
usuário conectado. Por exemplo, se a localidade do usuário for en-US, o código da moeda será USD.
OmniScript .
Veja também
• Elemento de número OmniScripts
Propriedades personalizadas do componente Web do Lightning
As propriedades do elemento personalizado do Lightning Web Component são configuráveis no painel
Propriedades quando você seleciona o elemento. Com o elemento Componente da W eb do Lightning
personalizado, incorpore um componente da Web do Lightning personalizado ao OmniScript.
Nome LWC Insira o nome do componente personalizado para renderizá-lo em um OmniScript ativo.

company
Nome da propriedade Insira um nome de propriedade usando o formato de atributo HTML para passá-lo para o componente customizado. Por
exemplo, a propriedade recordId é convertida no atributo HTML record -id.
Origem da propriedade Insira um valor para passar na propriedade. Os valores podem usar a sintaxe do campo de mesclagem para passar um nó
JSON. Por exemplo, para passar o nó JSON ContextId, insira %ContextId%.
LWC autônomo Uma caixa de seleção que permite o uso de um LWC autônomo.
Veja também
• Elemento LWC personalizado
• Definições comuns de propriedades do elemento OmniScript
Elemento de data de OmniScripts

Permita que os usuários selecionem uma data em um seletor de datas adicionando um elemento Date ao seu
OmniScript. Defina as datas mínimas e máximas e o formato da data.
1. Arraste um elemento Date do painel Build para a tela.

4. Em Minimum Date , insira a data mais antiga que o usuário pode selecionar no seletor de datas, como
01-01-1950 .
NOTA
O formato inserido deve ser o mesmo do campo Formato de data . Por exemplo, para definir a
data mínima para 1º de janeiro de 1950, se o formato de data for MM-DD-AAAA , você deverá
inserir 01-01-1950 .
5. Em Maximum Date , insira a data mais recente que o usuário pode selecionar no seletor de data, como
12-31-2019 .
NOTA
O formato inserido deve ser o mesmo do campo Formato de data . Por exemplo, para definir
a data máxima para 31 de dezembro de 2019, se o formato de data for MM-DD-AAAA , você
deverá inserir 31-12-2019 .
6. Em Formato de data , insira o formato para exibir a data. Por exemplo, se o formato for MM-DD-AAAA e
o usuário selecionar 3 de janeiro de 2020 no seletor de data, a data será exibida como 01-03-2020 . Para
obter mais opções de formato, consulte Day.js .
7. (Opcional) Na seção Opções avançadas , atualize os valores das seguintes propriedades:
• Tipo de dados : especifica como exibir a data no JSON de dados.
• Se definido como String , o formato de data do modelo é aplicado. String é o tipo de dados padrão.
• Se definido como Data , a data é codificada como uma data/hora ISO 8601, como 2018-01-
28T05:00:00.000Z .
• Model Date Format : Especifica como a data é formatada no Data JSON quando Data Type é definido
como String . Por exemplo, AAAA-MM-DD . Para obter mais opções de formato, consulte Day.js .
OmniScript .
Veja também
• Elemento de data/hora de OmniScripts
company
Elemento de data/hora de OmniScripts

Permita que os usuários selecionem uma data em um seletor de data e uma hora em uma lista adicionando o
elemento Data/Hora ao OmniScript. Defina as datas mínimas e máximas e os formatos de data e hora.
1. Arraste um elemento Text do painel Build para a tela.

4. Em Minimum Date , insira a data mais antiga que o usuário pode selecionar no seletor de datas, como
01-01-1950 .
NOTA
O formato inserido deve ser o mesmo do campo Formato de data . Por exemplo, para definir a
data mínima para 1º de janeiro de 1950, se o formato de data for MM-DD-AAAA , você deverá
inserir 01-01-1950 .
5. Em Maximum Date , insira a data mais recente que o usuário pode selecionar no seletor de data, como
12-31-2019 .
NOTA
O formato inserido deve ser o mesmo do campo Formato de data . Por exemplo, para definir
a data máxima para 31 de dezembro de 2019, se o formato de data for MM-DD-AAAA , você
deverá inserir 31-12-2019 .
6. Em Formato de data , insira o formato para exibir a data. Por exemplo, se o formato for MM-DD-AAAA e
o usuário selecionar 3 de janeiro de 2020 no seletor de data, a data será exibida como 01-03-2020 . Para
obter mais opções de formato, consulte Day.js .
7. Em Formato de hora , insira o formato para exibir a hora, como hh:mm a , que é o padrão.
NOTA
Digite h ou hh para hora , m ou mm para minuto, s ou ss para segundos e a para am/pm.
Uma única letra, como h ou m , não tem zero à esquerda. Remova o a para exibir 24 horas.
Por exemplo, hh:mm a exibe 03:30 pm , h:mm a exibe 3:30 pm e hh:mm:ss . exibe 15:30 01 .
Para obter mais opções de formato, consulte Day.js .
8. Em Intervalo de tempo , insira os intervalos dentro de uma hora que o usuário pode selecionar na lista
suspensa de tempo. Por exemplo, insira 15 para períodos de 15 minutos dentro da hora, como 12:00,
12:15, 12:30, 12:45 e assim por diante. O intervalo padrão é 30 .
9. Na seção Opções avançadas , selecione um fuso horário :
• Selecione Fuso horário local para usar o fuso horário do navegador.
• Selecione Fuso horário do usuário para usar o fuso horário definido no perfil do usuário conectado.
OmniScript .
Veja também
• Elemento de data de OmniScripts
company
Elemento de divulgação de OmniScripts

Permita que os usuários concordem com uma declaração de divulgação adicionando um elemento de
Divulgação ao seu OmniScript. Insira a cópia em um editor de rich text.
1. Arraste um elemento Disclosure do painel Build para a tela.

4. (Opcional) Selecione o campo Obrigatório para marcar a caixa de seleção ao lado da instrução
obrigatória.
5. (Opcional) Clique no campo Texto para inserir o texto da sua declaração de divulgação.
OmniScript .
Veja também
Elemento de e-mail OmniScripts

Permita que os usuários insiram um endereço de email adicionando o elemento Email ao seu OmniScript.
Atualize o formato padrão permitido com Opções de validação.
1. Arraste um elemento Email do painel Build para a tela.

4. (Opcional) Na seção Opções de validação, atualize as opções de validação de dados:
• Em Padrão , insira um padrão para substituir o formato de e-mail padrão permitido. Use
correspondência de padrões simples. Expressões regulares (regex) aceitas. Consulte Expressões
Regulares .
• Em Texto de erro de padrão , insira a mensagem exibida se a entrada não corresponder à expressão
em Padrão .
OmniScript .
Veja também
Elemento de seleção múltipla de OmniScripts

Permita que os usuários selecionem vários itens adicionando o elemento Multi-select ao seu OmniScript. Exiba
opções verticalmente, horizontalmente ou como uma imagem.
1. Arraste um elemento Multi-select do painel Build para a tela.


company
4. (Opcional) No Modo de exibição , selecione como exibir os botões de opção. As seguintes opções de lista
disponíveis:
• Horizontal : (Padrão) Exibe os botões de opção um ao lado do outro.
• Vertical : exibe botões de opção empilhados.
• Imagem : Exibe cada botão de opção como uma imagem.
5. (Opcional) Se você selecionar Imagem no modo de exibição , as seguintes são propriedades adicionais
que você pode configurar:
• Largura : Define a largura da imagem.
• Altura : Define a altura da imagem.
• Contagem de imagens na linha : define quantas imagens por linha serão exibidas.
• Ativar legenda : exibe uma legenda abaixo da imagem.
6. Em Option Source , selecione de onde vem a lista de opções. Selecione um dos seguintes:
• Manual : (Padrão) Insira manualmente os pares valor/rótulo. Disponível quando o Modo de Exibição
não é Imagem .
• Personalizado : insira a classe e o método do Apex que retorna as opções. Use o formato
ClassName.method . Consulte Preenchendo valores da lista de opções do Apex .
• SObject : recupera os valores da lista de opções do objeto e campo do Salesforce. Utilize o formato
ObjectAPIName.FieldAPIName .
• Imagem : Quando a Imagem é selecionada como Modo de exibição, insira manualmente os pares de
valor/rótulo e carregue as imagens para exibição. Se nenhuma imagem for carregada, o rótulo será
exibido na caixa de imagem.
7. Se você selecionar Manual ou Imagem como uma fonte de opção , para cada opção, siga estas etapas:
a. Clique em + Adicionar nova opção .
b. Insira o Valor e o Rótulo visível .
c. Se sua opção for uma imagem, selecione uma imagem disponível na lista suspensa Escolher imagem
existente .
Ou faça upload de uma imagem do seu computador na seção Ou faça upload de uma nova imagem .
d. (Opcional) Marque Usar como padrão para tornar a opção selecionada por padrão.
8. Se você selecionar Personalizado como uma Origem da Opção , em Origem , insira o nome de um
método para chamar uma classe no formato class.method .
9. Se você selecionar SObject como uma Origem da Opção , na Origem , insira o nome de um campo em um
objeto no formato SObject.field .
10. (Opcional) Para exibir opções com base na seleção de outro valor, configure o tipo de campo de controle
seguindo estas etapas:
uma. Para definir a origem do campo de controle:
• Para recuperar as opções da lista de opções de uma classe do Apex, selecione Personalizado .
• Para recuperar valores de lista de opções dependentes de um objeto do Salesforce, selecione
SObject .
b. Em Controlando a origem do campo , insira uma classe do Apex.
c. Em Controlling Field Element , insira um nome de elemento OmniScript.
OmniScript .
Veja também
• Elemento de Seleção de OmniScripts
company
Elemento de número OmniScripts

Permita que os usuários insiram um número adicionando o elemento Number ao seu OmniScript. Limite o que
o usuário pode inserir definindo uma máscara.
1. Arraste um elemento Number do painel Build para a tela.

4. Em Máscara , defina o formato permitido que o usuário pode inserir. Consulte Máscara Padrão .
NOTA
O símbolo # e os inteiros 1-9 representam um dígito no campo. Você pode separar os
números inteiros usando vírgulas e um único decimal. O decimal só é aplicado se um usuário o
inserir no campo. Por exemplo, a máscara ###,###.## transforma uma entrada de 123456,78
em 123.456,78. Insira um símbolo + ou - para retornar um número inteiro positivo ou negativo.
5. (Opcional) Para opções de validação e outras propriedades adicionais, consulte Definições comuns de
propriedades do elemento OmniScript .
Veja também
• Elemento de moeda OmniScripts
Elemento de senha OmniScripts
Permita que os usuários insiram uma senha adicionando o elemento Password ao OmniScript. Defina os
comprimentos mínimo e máximo da senha.
1. Arraste um elemento Password do painel Build para a tela.

4. Em Comprimento mínimo da senha , insira o número mínimo de caracteres que o usuário deve inserir
para uma senha válida.
5. Em Comprimento Máximo da Senha , defina o número máximo de caracteres que o usuário pode inserir
para uma senha válida.
Veja também
Elemento de rádio OmniScripts

Permita que os usuários selecionem um de vários itens adicionando o elemento Radio ao seu OmniScript.
Exiba opções verticalmente, horizontalmente, como uma imagem ou estilizada com base no Newport Design
System.

company
1. Arraste um elemento Radio do painel Build para a tela.
4. (Opcional) No Modo de exibição , selecione como exibir os botões de opção. As seguintes opções de lista
disponíveis:
• Horizontal : (Padrão) Exibe os botões de opção um ao lado do outro.
• Vertical : exibe botões de opção empilhados.
• Imagem : Exibe cada botão de opção como uma imagem.
• Segmentado (somente Newport) : Exiba cada botão de opção como um link estilizado com base no
Newport Design System. Consulte Personalizando OmniScripts e Cartões com o Vlocity Newport Design
System .
5. (Opcional) Se você selecionar Imagem no modo de exibição , as seguintes são propriedades adicionais
que você pode configurar:
• Largura : Define a largura da imagem.
• Altura : Define a altura da imagem.
• Contagem de imagens na linha : define quantas imagens por linha serão exibidas.
• Ativar legenda : exibe uma legenda abaixo da imagem.
• Manual : (Padrão) Insira manualmente os pares valor/rótulo. Disponível quando o Modo de Exibição
não é Imagem .
• Imagem : Quando a Imagem é selecionada como Modo de exibição, insira manualmente os pares de
valor/rótulo e carregue as imagens para exibição. Se nenhuma imagem for carregada, o rótulo será
exibido na caixa de imagem.
7. Se você selecionar Manual ou Imagem como uma fonte de opção , para cada opção, siga estas etapas:
c. Se sua opção for uma imagem, selecione uma imagem disponível na lista suspensa Escolher imagem
existente . Ou faça upload de uma imagem do seu computador na seção Ou faça upload de uma
nova imagem .
d. (Opcional) Marque Usar como padrão para tornar a opção selecionada por padrão.
e. (Opcional) Marque o Avanço Automático para avançar o usuário para a próxima etapa ao clicar
nesta opção.
uma. Para definir a origem do campo de controle:
SObject .

company
OmniScript .
Veja também
• Elemento de Seleção de OmniScripts
• Controlando a propriedade do campo
Elemento de intervalo de OmniScripts

Permite que os usuários selecionem um número de um intervalo especificado adicionando o elemento Range
ao OmniScript. Especifique os valores de incremento e use valores dinâmicos e estáticos para definir os valores
mínimo e máximo para o intervalo.
1. Arraste um elemento Range do painel Build para a tela.

4. Em Etapa , insira um valor de incremento do intervalo de entrada. Por exemplo, digite 2 para que o
usuário possa selecionar 2, 4, 6, 8 e 10 de um intervalo de 2 a 10 ou 4,5, 6,5, 8,5 e 10,5 de um intervalo de
4,5 a 10,5. A etapa padrão é 1 .
5. Para criar um intervalo selecionável, configure as seguintes propriedades:
• Valor mínimo : Define o menor número selecionável no intervalo.
• Valor máximo : Define o número mais alto selecionável no intervalo.
NOTA
Ambos os campos aceitam valores dinâmicos e estáticos. Os valores dinâmicos são
definidos usando campos de mesclagem. Por exemplo, para usar um valor de elemento
Number, cujo nome de elemento é Number1 , para definir dinamicamente seu valor mínimo
ou máximo, insira %Number1% . Os valores estáticos aceitáveis incluem números inteiros,
negativos e decimais, como 1 , -5 e .5 .

OmniScript .
Veja também
Elemento de Seleção de OmniScripts

Permita que os usuários selecionem em uma lista suspensa adicionando um elemento Select ao seu
OmniScript. Insira opções manualmente ou extraia opções dinamicamente de uma classe e método do Apex
ou para um objeto do Salesforce.
1. Arraste um elemento Select do painel Build para a tela.

company
• Manual : (Padrão) Insira manualmente os pares valor/rótulo.
5. Se você selecionar Manual como uma fonte de opção , para cada opção, siga estas etapas:
c. (Opcional) Marque Usar como padrão para tornar a opção selecionada por padrão.
d. (Opcional) Marque o Avanço Automático para avançar o usuário para a próxima etapa ao clicar
nesta opção.
a. Para definir a origem do campo de controle:
SObject .
OmniScript .
Veja também
• Elemento de seleção múltipla de OmniScripts
• Controlando a propriedade do campo
• Elemento de rádio OmniScripts
Elemento de telefone OmniScripts

Permita que os usuários insiram um número de telefone adicionando um elemento Telefone ao OmniScript.
Limite o comprimento e o formato do número que o usuário pode inserir.
1. Arraste um elemento Telefone do painel Construir para a tela.

4. (Opcional) Em Mask , atualize o formato permitido inserindo um padrão personalizado. O padrão é (999)
999-9999 . Consulte Máscara Padrão .
5. (Opcional) Em Comprimento mínimo , atualize o número mínimo de caracteres que o
usuário deve inserir.

company
6. (Opcional) Em Comprimento máximo , atualize o número máximo de caracteres que o usuário pode
inserir.
Veja também
Elemento de área de texto OmniScripts

Permita que os usuários insiram várias linhas de texto adicionando um elemento Text Area ao OmniScript.
Limite o número de caracteres que o usuário pode inserir.
1. Arraste um elemento Text Area do painel Build para a tela.

4. (Opcional) Em Comprimento mínimo , insira o número mínimo de caracteres que o usuário deve inserir.
5. (Opcional) Em Comprimento máximo , insira o número máximo de caracteres que o usuário pode inserir.
OmniScript .
Veja também
• Elemento de texto OmniScripts
Elemento de texto OmniScripts

Permita que os usuários insiram uma linha de texto adicionando o elemento Text ao OmniScript. Limite o
comprimento do texto usando valores mínimos e máximos e defina as informações permitidas usando a
propriedade mask.
1. Arraste um elemento Text do painel Build para a tela.

4. (Opcional) Para definir o tipo de informação e seu formato, insira uma máscara como (999)
999-9999[x9999] , que aceita um número de telefone norte-americano com um ramal opcional. Consulte
Máscara Padrão .
5. (Opcional) Em Comprimento mínimo , defina o comprimento mínimo permitido do texto, como 1 .
6. (Opcional) Em Comprimento máximo , defina o comprimento máximo de texto permitido, como 300 .
Veja também
• Elemento de área de texto OmniScripts

company
Propriedades do texto
As propriedades de texto são configuráveis no painel Propriedades quando você seleciona um elemento de
texto. Com o elemento Texto, permita que os usuários insiram uma linha de texto em seu OmniScript.
mascarar Especifica a entrada permitida e define o formato da entrada. Use A para qualquer letra, 9 para qualquer número, * para
qualquer caractere e [ ] para incluir caracteres opcionais. Para obter informações adicionais sobre o padrão, visite
https://imask.js.org/guide.html#masked-pattern e revise a Máscara de padrão .
Comprimento mínimo O número mínimo de caracteres que o usuário deve inserir.
Comprimento máximo O número máximo de caracteres que o usuário pode inserir.
Veja também
• Elemento de texto OmniScripts
Elemento de tempo de OmniScripts

Permita que os usuários selecionem em uma lista de horários adicionando o elemento Time ao OmniScript.
Formate a exibição e defina os intervalos de tempo.
1. Arraste um elemento Time do painel Build para a tela.

4. Em Minimum Time , insira o horário mais cedo que o usuário pode selecionar, como 12:00 am .
NOTA
O formato inserido deve ser o mesmo do campo Formato de hora . Por exemplo, para
definir a hora mínima para meia-noite, se o formato de hora for hh:mm a , você deverá
inserir 12:00 am .
5. Em Tempo Máximo , insira o último horário que o usuário pode selecionar, como 20:00 .
NOTA
O formato inserido deve ser o mesmo do campo Formato de hora . Por exemplo, para
definir o horário máximo para 20h, se o Formato de hora for hh:mm a , você deve inserir 20h
.
6. Em Formato de hora , insira o formato para exibir a hora, como hh:mm a , que é o padrão.
NOTA
Digite h ou hh para hora , m ou mm para minuto, s ou ss para segundos e a para am/pm.
Uma única letra, como h ou m , não tem zero à esquerda. Remova o a para exibir 24 horas.
Por exemplo, hh:mm a exibe 03:30 pm , h:mm a exibe 3:30 pm e hh:mm:ss . exibe 15:30 01 .
Para obter mais opções de formato, consulte Day.js .
7. Em Intervalo de tempo , insira os intervalos dentro de uma hora que o usuário pode selecionar na lista
suspensa de tempo. Por exemplo, insira 15 para períodos de 15 minutos dentro da hora, como 12:00,
12:15, 12:30, 12:45 e assim por diante. O intervalo padrão é 30 .
8. (Opcional) Na seção Opções avançadas , atualize os valores das seguintes propriedades:
• Tipo de dados : especifica como exibir a hora no Data JSON.

company
• Se definido como String , o Model Time Format é aplicado. String é o tipo de dados padrão.
• Se definido como Data , a hora é codificada como uma hora ISO 8601.
• Model Time Format : Especifica como a hora é formatada no Data JSON quando Data Type é definido
como String . O formato padrão é HH:mm:ss.sss'Z' . Para obter mais opções de formato, consulte
Day.js .
OmniScript .
Veja também
• Elemento de data/hora de OmniScripts
• Elemento de data de OmniScripts
Elemento de URL OmniScripts
Permita que os usuários insiram um endereço de site adicionando o elemento URL ao seu OmniScript. Por
exemplo, um usuário pode inserir salesforce.com ou www.salesforce.com e assim por diante.
1. Arraste um elemento de URL do painel Build para a tela.

4. (Opcional) No campo Texto de erro da seção Opções de validação , insira o texto para substituir a
mensagem padrão exibida quando o usuário não inserir a URL corretamente.
OmniScript .
Veja também
Criar um componente Web do Lightning personalizado para

OmniScript
Adicione HTML, JavaScript e CSS personalizados a um OmniScript criando um componente Web do Lightning
personalizado. Para obter informações sobre como usar a estrutura do Lightning Web Component, consulte
Configurar componentes da Web do Lightning .
NOTA
Antes de visualizar um OmniScript que usa componentes Web do Lightning personalizados, você
deve ativar o OmniScript. Se o OmniScript não estiver ativo, os componentes Web personalizados do
Lightning não serão renderizados na visualização. Se você implantar alterações em um componente
Web do Lightning personalizado presente em um Active OmniScript, o OmniScript exibirá as
alterações.
Requisitos
Para tornar o componente da Web personalizado do Lightning compatível com os componentes da Web do
Vlocity Lightning, você deve definir duas tags de metadados em seu arquivo de configuração XML:

company
• runtimeNamespace : você deve adicionar o namespace de seu pacote Vlocity ao arquivo de metadados XML
em seu componente usando a tag de metadados runtimeNamespace . Substitua a variável NS no exemplo
de código pelo namespace do seu pacote Vlocity. Para obter mais informações sobre como localizar o
namespace do seu pacote, consulte Visualizando o namespace e a versão do pacote OmniStudio Vlocity .
<runtimeNamespace>NS</runtimenamespace>
• Os componentes Web personalizados do Lightning criados fora do pacote não podem usar nenhum
componente Web do Salesforce Lightning que use recursos ou afete o componente em tempo de execução.
Para obter mais informações, consulte Módulos do Salesforce .
• isExposed : Defina a marca de metadados isExposed como true.
<isExposed>Verdadeiro</isExposed>
Para obter mais informações sobre como estender os componentes da Web do Vlocity Lightning, consulte
Estender os componentes da Web do Vlocity Lightning .
NOTA
Componentes Web do Lightning personalizados não gerarão erros, a menos que o Modo de
depuração esteja ativado.
Para obter mais informações, consulte Depurar componentes da Web do Lightning .
Componentes da Web do OmniScript Lightning personalizados

Para criar um componente Web do Lightning personalizado, revise estes tipos de componentes:
Tipo de componente Descrição Referência
Elemento OmniScript Personalize um elemento OmniScript estendendo o componente Estender um elemento OmniScript
Componente da Web do Web do Lightning do elemento. Os elementos compatíveis com Componente da Web do Lightning
Lightning LWC exibem um ícone do Lightning no painel Componentes
disponíveis de um OmniScript.
componente Habilite um componente personalizado para interagir com um Estender o OmniScriptBaseMixin

OmniScriptBaseMixin OmniScript estendendo o componente OmniScriptBaseMixin. Componente
Componente autônomo Um componente autônomo personalizado. O componente não Criar um personalizado autônomo
pode estender o componente OmniScriptBaseMixin ou um Componente da Web do Lightning
componente da Web do Lightning do elemento OmniScript.
Para obter informações sobre como adicionar um componente Web do Lightning personalizado a um
OmniScript, consulte Adicionar componentes Web do Lightning personalizados a um OmniScript .
Elemento LWC personalizado

Adicione um componente Web do Lightning personalizado que não estenda um componente de elemento
OmniScript para um OmniScript usando o elemento LWC personalizado. Para estender o componente de um
elemento OmniScript, consulte Estender o componente da Web do Lightning de um elemento OmniScript .
NOTA
Use elementos de LWC personalizados em uma etapa e um elemento de bloco não repetível que
não esteja aninhado.

company
Crie um LWC personalizado. O elemento LWC personalizado oferece suporte a esses dois tipos de componentes Web personalizados do Lightning:
• Componentes que estendem o componente OmniScriptBaseMixin . Para obter mais informações, consulte Estender o componente
OmniScriptBaseMixin .
• Componentes autônomos que são executados independentemente do OmniScript. Para obter mais informações, consulte Criar um componente
Web do Lightning personalizado autônomo .
1. Em um OmniScript, adicione o elemento Custom LWC.

2. Em Name and Field Label , insira um nome e um nome de exibição para o elemento Custom LWC.
3. No campo Nome do componente da Web do Lightning , insira o nome do seu componente da Web do
Lightning personalizado.
4. (Opcional) Verifique o LWC autônomo se seu componente personalizado não estender o componente
OmniScriptBaseMixin.
5. (Opcional) Passe valores de propriedade para o OmniScript inserindo valores nestes campos de
propriedade:
Nome da propriedade Insira um nome de propriedade usando o formato de atributo HTML para passá-lo para o componente customizado.
Por exemplo, a propriedade recordId é convertida no atributo HTML record -id.
Propriedade Insira um valor para passar na propriedade. Os valores podem usar a sintaxe do campo de mesclagem para passar um
Fonte nó JSON. Por exemplo, para passar o nó JSON ContextId, insira %ContextId%.
6. (Opcional) Ative e visualize o OmniScript para visualizar seu componente Web do Lightning personalizado.
Veja também
• Estender o componente OmniScriptBaseMixin
• Criar um componente Web do Lightning personalizado autônomo
Estender o componente da Web do Lightning de um elemento OmniScript

Adicione comportamento e estilo personalizados a um elemento OmniScript enquanto mantém sua
funcionalidade principal estendendo o componente da Web do Lightning de um elemento OmniScript.
Os componentes da Web do Lightning no OmniScript fornecem HTML, JavaScript e CSS para um elemento
OmniScript. Por exemplo, um elemento Text tem um componente extensível chamado OmniScriptText. Para
obter informações sobre como criar componentes da Web do Lightning personalizados que não estendem o
componente da Web do Lightning de um elemento OmniScript, consulte Criar um componente da Web do
Lightning personalizado para OmniScript .
NOTA
Os componentes Web personalizados do Lightning criados fora do pacote não podem usar nenhum
componente Web do Salesforce Lightning que use recursos do Salesforce ou afete o componente em
tempo de execução. Para obter mais informações, consulte Módulos do Salesforce .
Para estender o componente Web do Lightning de um elemento OmniScript:
1. Certifique-se de ter configurado o IDX Workbench ou o Salesforce DX localmente. Para obter informações
sobre como configurar o IDX Workbench ou o Salesforce DX, consulte Configurar componentes da Web
do Lightning .
2. Localize o nome do componente da Web do Lightning do elemento OmniScript. Informações sobre os
componentes da Web do Lightning do elemento OmniScript estão disponíveis na Referência do
OmniScript ReadMe .

company
NOTE
LWC compatible elements display a Lightning icon in the Available Components panel
of an OmniScript.
3. Crie um componente personalizado e estenda o componente da Web do Lightning do elemento

OmniScript.
4. Para tornar o componente da Web personalizado do Lightning compatível com os componentes da Web
do Vlocity Lightning, você deve definir duas tags de metadados em seu arquivo de configuração XML:
• runtimeNamespace : você deve adicionar o namespace de seu pacote Vlocity ao arquivo de metadados
XML em seu componente usando a tag de metadados runtimeNamespace . Substitua a variável NS no
exemplo de código pelo namespace do seu pacote Vlocity. Para obter mais informações sobre como
localizar o namespace do seu pacote, consulte Visualizando o namespace e a versão do pacote
OmniStudio Vlocity .
5. Quando as personalizações estiverem concluídas, implante o componente personalizado em sua
organização do Salesforce. Para obter mais informações sobre a implantação de componentes da Web do
Lightning, consulte Implantar componentes da Web do Lightning .
6. Adicione o componente personalizado a um OmniScript substituindo um elemento individual ou
mapeando todos os elementos de um tipo para o componente personalizado. Para obter mais
informações sobre como adicionar componentes da Web do Lightning personalizados a um OmniScript,
consulte Adicionar componentes da Web do Lightning personalizados a um OmniScript .
Exemplo
Neste exemplo de código, um componente Web personalizado do Lightning está estendendo o componente
OmniScriptText. Substitua a variável NS no exemplo de código pelo namespace do pacote Vlocity que você
está usando. Para obter mais informações sobre como localizar o namespace do seu pacote, consulte
Visualizando o namespace e a versão do pacote OmniStudio Vlocity .
importe OmniScriptText de 'NS/omniscriptText'; importar tmpl de

'./omniscriptTextCustom.html'; export default class
OmniscriptTextCustom extends OmniscriptText {
handleBlur(evt) {
this.applyCallResp(evt.target.value); }
render() { return tmpl;

}
}
Estender o componente OmniScriptBaseMixin

company
Habilite um componente Web do Lightning personalizado para interagir com um OmniScript estendendo o
componente OmniScriptBaseMixin. O OmniScriptBaseMixin inclui métodos para atualizar o JSON de dados de
um OmniScript, passar parâmetros e muito mais.
Requisitos
• Os componentes da Web do Lightning personalizados que estendem o componente OmniScriptBaseMixin
também não podem estender ou substituir um componente da Web do Lightning do elemento OmniScript.
Para obter mais informações sobre como estender o componente da Web do Lightning de um elemento
OmniScript, consulte Estender o componente da Web do Lightning de um elemento OmniScript .
• Os componentes Web personalizados do Lightning que estendem o OmniScriptBaseMixin devem usar o
elemento Custom LWC no OmniScript. Para obter mais informações sobre como usar o elemento LWC
personalizado, consulte Adicionar componentes Web personalizados do Lightning a um OmniScript .
• Para tornar o componente da Web personalizado do Lightning compatível com os componentes da Web do
Leia-me OmniScriptBaseMixin
Exiba todas as propriedades, atributos e métodos do componente no ReadMe. Consulte Referência Leia-me do
OmniScript .
Estendendo o componente
Neste exemplo de código, um componente Web do Lightning personalizado está estendendo o componente
OmniScriptBaseMixin para encapsular um elemento do Salesforce Lightning. Substitua a variável NS no
exemplo de código pelo namespace do pacote Vlocity que você está usando. Para obter mais informações
sobre como localizar o namespace do seu pacote, consulte Visualizando o namespace e a versão do pacote
importar tmpl de './customLightningElement.html';

import { LightningElement } de 'lwc';
import { OmniscriptBaseMixin } de 'NS/omniscriptBaseMixin';
exportar a classe padrão customLightningElementWithMixin estende

OmniscriptBaseMixin(LightningElement) {
handleBlur(evt) {
this.omniUpdateDataJson(evt.target.value); }

company
render() { return tmpl;
}
}
Validando o componente
Para adicionar validação a um componente personalizado, redefina a função checkValidity() em seu
componente.
Este exemplo de código contém uma função checkValidity() que retorna false quando a soma é menor que
zero. Substitua a variável NS no exemplo de código pelo namespace do pacote Vlocity que você está usando.
import { api } de 'lwc';

import { OmniscriptBaseMixin } de 'NS/omniscriptBaseMixin';
exportar classe padrão MyCustomLwc estende OmniscriptBaseMixin(LightningElement)
{ soma =
0;
// definindo condições de validação personalizadas

@api checkValidity() { return this.sum <
100;
}
}
Navegando para uma etapa

Permita que os usuários naveguem para diferentes etapas no OmniScript usando estes três mixins:
• omniNextStep() : Avança os usuários para a próxima etapa no OmniScript.

Exemplo de JS
nextButton(evt) { if
(evt) {
this.omniNextStep();
}
}
Exemplo HTML
<button onclick={nextButton}>Botão Próximo Personalizado </button>

• omniPrevStep() : Leva os usuários para a etapa anterior no OmniScript. Exemplo de JS
prevButton(evt) { if
(evt) {
this.omniPrevStep();
}
}
Exemplo HTML
<button onclick={prevButton}>Botão de visualização personalizada </button>

• omniNavigateTo(step) : leva os usuários a uma etapa específica no OmniScript passando um
argumento. O argumento passado para a função pode ser um número que se refere ao índice do Step

company
no OmniScript ou o nome do Elemento do Step passado como uma string codificada. O índice da etapa atual
é acessível usando a propriedade this.omniScriptHeaderDef.asIndex .
NOTA
O avanço automático para um passo mais de um passo à frente não é permitido.
Exemplo de JS
goToStep(evt) { if
(evt) {
this.omniNavigateTo(this.omniScriptHeaderDef.asIndex - 2);
}
}
Exemplo HTML
<button onclick={goToStep}>Botão de etapa personalizada </button>
Salvando dados dentro de um componente personalizado

Quando o componente personalizado não existe no DOM, armazene os dados em um estado. Para armazenar
dados em um estado, use a função omniSaveState() . A função omniSaveState aceita três argumentos: um
objeto de dados, uma chave e um booleano.
Método : omniSaveState(input,key,usePubSub=false) :
Argumentos :
• input : Os dados a serem salvos.
let mySaveState = {"meu":"dados"}; this.omniSaveState(mySaveState);

• (opcional) key : um valor de string para o qual o parâmetro obj mapeia como um par chave-valor. Se uma
chave não for enviada como parâmetro, o padrão da chave será o nome do componente.
let mySaveState = {"meu":"dados"}; let key =

'customLwcKey';
this.omniSaveState(mySaveState, chave);
• (opcional) usePubSub : Defina o booleano como true para armazenar dados para uso em um padrão
pubsub. Para obter mais informações sobre padrões pubsub, consulte eventos pubsub . Quando deixado em
branco ou definido como falso, os dados podem ser usados por eventos. Para obter mais informações sobre
eventos, consulte Eventos LWC . Quando omniSaveState está em um disabledCallback , usePubSub deve
ser definido como true para passar o evento no pubsub em vez de borbulhar o evento.
Opcionalmente, salve o estado em um retorno de chamada desconectado. Salvar o estado em um retorno de

chamada desconectado permite que o estado do elemento seja salvo quando os usuários saem do elemento
automaticamente. Em retornos de chamada desconectados, o argumento usePubSub deve ser definido como
true . Eventos em retornos de chamada desconectados só podem ser passados usando pubsub.
Exemplo de um omniSaveState sendo chamado em umconnectedCallback :
desconectadoCallback() {
let mySaveState = {"meu":"dados", "aqui": 8};

company
let key = 'customLwcKey'; deixe
usePubSub = true;
this.omniSaveState(mySaveState, chave, usePubSub); }
Recuperando dados de componentes personalizados de um OmniScript

Use a função omniGetSaveState() para recuperar dados de componentes personalizados de um OmniScript.
omniGetSaveState(key) : O omniGetSaveState aceita uma chave como um argumento opcional. Se uma chave
não for enviada, o padrão da chave será o nome do componente personalizado. A chave armazena os dados
da função omniSaveState() .
Exemplo com um argumento chave:
let key = 'customLwcKey'; const estado =

this.omniGetSaveState(chave);
Exemplo sem chave:

// assume que os dados estão dentro do mesmo componente personalizado const
state = this.omniGetSaveState()
Limpando um estado salvo de uma etapa anterior

Quando o estado salvo de um LWC personalizado depende de dados de uma etapa anterior, você pode limpar
condicionalmente o estado salvo do LWC personalizado sempre que um usuário navegar para uma etapa
anterior. Após a configuração, o elemento Step passa um sinalizador booleano para o LWC personalizado. O
código em seu LWC personalizado deve usar o booleano para determinar se deve instanciar um novo estado
salvo ou continuar usando o estado salvo existente.
Para configurar a funcionalidade de limpar estado salvo:
1. No OmniScript, determine a Etapa que limpa o estado salvo dos LWCs personalizados.
2. Nas propriedades da Etapa, clique em Editar como JSON .
3. Insira a propriedade "omniClearSaveState": [ ] .
4. Na propriedade omniClearSaveState , insira o nome de um ou mais elementos LWC personalizados
"omniClearSaveState": [ "CustomLWC1"] . A etapa envia dados para o LWC personalizado, permitindo
que o LWC personalizado determine se a etapa foi renderizada.
5. No código do seu LWC personalizado, recupere o estado atual.
estado const = this.omniGetSaveState()

6. No código do seu LWC personalizado, defina uma variável igual a
this.omniGetSaveState(this.omniJsonDef.name + '-$Vlocity.cleared' . A função avalia se a etapa anterior
contendo a propriedade omniClearSaveState foi renderizada e retorna um booleano.
let stateCleared = this.omniGetSaveState(this.omniJsonDef.name + '$Vlocity.cleared');

7. Modifique seu código usando o valor booleano para determinar se deve manter o estado salvo atual ou
instanciar um novo estado salvo.
Acessando o layout do OmniScript Base Mixin

Chame o Layout para seu LWC personalizado passando o parâmetro data-omni-layout
para o método getAttribute . this.getAttribute('data-omni-layout')
company
Fazendo chamadas remotas
Permita que os usuários façam chamadas remotas de um LWC personalizado usando o método
omniRemoteCall() .
Método : omniRemoteCall(params, boolean)
Argumentos :
• O primeiro argumento deve ser um objeto com as propriedades input, sClassName, sMethodName e
opções.
Os valores de cada uma das propriedades devem estar no tipo de dados String.
NOTA
Os métodos chamados dentro de um pacote devem ter o namespace prefixado com ${this._ns}.
Por exemplo, `${this._ns}IntegrationProcedureService` .
parâmetros const = {
entrada: JSON.stringify(this.omniJsonData),
sClassName: 'SomeApexClass', sMethodName:
'someApexMethod',
opções: '{}', };
• O segundo argumento para omniRemoteCall é um valor booleano opcional que vincula uma propriedade
rastreada chamada omniSpinnerEnabled . O HTML deve ter algum código para verificar o valor do
booleano. Exemplo HTML
<template if:true={omniSpinnerEnabled}>
<div class="slds-spinner-container__wrapper">
<c-spinner variant="brand" alternate-text="Carregando.."
tamanho="médio">
</c-spinner>
</div>
</template>
Após a execução de omniRemoteCall, o retorno de chamada de resposta retorna um objeto contendo as duas
propriedades result e error .
• result : A propriedade result contém uma resposta bruta do servidor.

• error : A propriedade error armazena um valor de erro da classe GenericInvoke2 do Vlocity.
Vlocity fornece propriedades que, quando passadas nas opções, permitem que os trabalhos sejam enfileirados,
futuros, encadeados e continuáveis.
Exemplos de casos de uso :
• Exemplo de chamada remota invocando uma classe do Apex.
entrada: this.omniJsonDataS, sClassName:
'SomeApexClass', sMethodName:
'someApexMethod',
opções: '{}', };

company
this.omniRemoteCall(params, true).then(resposta => { window.console.log(resposta, 'resposta');
}).catch(erro => {
window.console.log(erro, 'erro'); });
• Exemplo de chamada de Procedimento de Integração. Para obter informações sobre os procedimentos de
integração, consulte Procedimentos de integração do OmniStudio .
entrada: this.omniJsonDataStr,
sClassName: `${this._ns}IntegrationProcedureService`,
sMethodName: 'test_RemoteAction', isso precisará corresponder ao VIP ->
opções type_subtype:
'{}', };

}).catch(erro => {
• Exemplo de chamada de Procedimento de Integração encadeável passando a propriedade encadeável: true .
Use encadeável quando um Procedimento de Integração exceder o limite do Governador de CPU do
Salesforce.
opções const = { encadeável:

true,
};
sMethodName: 'test_RemoteAction', isso precisará corresponder ao VIP ->
tipo_subtipo
opções: JSON.stringify(opções), };

}).catch(erro => {
• Exemplo de chamada remota enfileirada passando a propriedade useQueueableApexRemoting: true . Para
obter mais informações sobre como o enfileiramento funciona, consulte Apex enfileirado .
opções const = {
entrada: this.omniJsonDataStr, vlcClass:
'SomeApexClass', vlcMethod: 'someApexMethod',
useQueueableApexRemoting: true, }; parâmetros
const = {
sClassName: `$
{this._ns}VFActionFunctionController.VFActionFunctionControllerOpen`,
sMethodName: 'runActionFunction', opções:
JSON.stringify(options), };

}).catch(erro => {

company
• Exemplo de chamada remota futura passando a propriedade useFuture: true . Para obter mais informações
sobre como os Métodos Futuros funcionam, consulte Métodos Futuros .
const options = { useFuture:

true,
}; parâmetros
const = {
entrada: this.omniJsonDataStr, sClassName:
'SomeApexClass', sMethodName:
'someApexMethod', opções:
JSON.stringify(options), };

}).catch(erro => {
• Exemplo de chamada remota de continuação passando o parâmetro useContinuation: true . Para obter mais
informações sobre como a continuação funciona, consulte Classe de continuação .
opções const = {
entrada: this.omniJsonDataStr, vlcClass:
'SomeApexClass', vlcMethod: 'someApexMethod',
useContinuation: true,
}; parâmetros
const = {
entrada: this.omniJsonDataStr, sClassName:
'SomeApexClass', sMethodName: 'someApexMethod',
opções: JSON.stringify(options), };

}).catch(erro => {
Atualizar o JSON de dados

Atualizar os dados do elemento LWC personalizado
Aplique a resposta de uma chamada de LWC personalizado ao elemento LWC personalizado usando o método
omniUpdateDataJson .
Método : omniUpdateDataJson(entrada, agregação = false)
Argumentos :
• input : O primeiro argumento, input, aceita dados em um objeto ou tipo de dados primitivo. Indefinido não
é aceito. Os dados de entrada substituem o valor atual ou são mesclados com os dados existentes,
dependendo da configuração do segundo argumento, agregadoOverride .
• agregadoOverride : o segundo argumento, agregadorOverride, controla como os dados são salvos no JSON
de dados. É um argumento opcional definido como false por padrão. Quando definido como false, os dados
de entrada são mesclados com os dados existentes. Se os dados não forem um objeto, eles não serão
mesclados no JSON de dados. Quando definido como true, os dados de entrada substituem quaisquer dados
existentes no elemento Custom LWC.

company
Exemplos :
• Um exemplo passando o argumento de entrada com o comportamento AggregateOverride padrão .
let myData = "myvalue" // qualquer tipo de dado que seja uma string, objeto, número, etc
this.omniUpdateDataJson(this.myData);
• Um exemplo passando o argumento de entrada com o argumento agregadoOverride definido como false .
// 1. primeira chamada para omniUpdateDataJson

// entrada para omniUpdateDataJson quando agregadoOverride = false
{
"prop1": "dados1"
}
// 2. saída de dados JSON após a primeira chamada

//
{
"Passo 1" : {
"PersonalizadoLWC1": {
"prop1": "dados1"
}
}
// 3. segunda chamada para omniUpdateDataJson

// entrada para omniUpdateDataJson quando agregadoOverride = false
{
"prop2": "dados2"
}
// 4. saída de dados JSON após a segunda chamada

// observe que o valor de CustomLWC1 contém prop1 e prop2
// porque os dados são mesclados em vez de substituídos quando agregadoOverride é
definido como falso
{
"Passo 1" : {
"PersonalizadoLWC1": {
"prop1": "dados1",
"prop2": "dados2"
}
}
Mapear respostas para o JSON de dados do OmniScript

Aplique respostas de ações personalizadas usando o método omniApplyCallResp() .
O método aceita um objeto que passa para o JSON de dados do OmniScript. Se o nome do nó de dados raiz na
resposta corresponder a um nome de elemento no OmniScript, esses dados preencherão previamente o
elemento e quaisquer elementos aninhados quando forem renderizados no OmniScript. Se o nome do nó raiz
não corresponder a um elemento nos dados

company
JSON, o nó é inserido no JSON de dados imediatamente. A aplicação da resposta funciona de forma
semelhante à propriedade Enviar/Resposta. Para obter informações, consulte Manipular JSON com as
propriedades de transformações de envio/resposta .
Método : omniApplyCallResp(resposta, usePubsub = false)
Argumentos :
• response : O primeiro argumento, response , é um objeto que se mescla ao JSON de dados.

• usePubSub : O segundo argumento, usePubSub, controla como a resposta passa para o cabeçalho
OmniScript para mesclar no JSON de dados. Este booleano é definido como false por padrão. Quando
definido como false , a resposta é enviada ao cabeçalho OmniScript por meio de eventos javascript. Quando
definido como true , a resposta é enviada ao cabeçalho OmniScript pelo módulo pubsub.
O argumento usePubSub permite que os usuários chamem omniApplyCallResp de forma assíncrona. Ao
executar de forma assíncrona, a interface do usuário não é bloqueada aguardando a resposta.
Opcionalmente, execute uma chamada remota usando o método omniNextStep() e chamando o método
omniApplyCallResp() de forma assíncrona.
Este exemplo demonstra como o método omniApplyCallResp() atualiza o Data JSON.
1. Visualize o JSON de dados atual antes de executar omniApplyCallResp().
{
"Passo 1" : {
"Moeda1": 12345,
"Texto1": "dados1"
},
"Passo 2" : {
"Texto3": "dados3"
}
}
2. Chame omniApplyCallResp e passe os dados como um argumento.
let meusDados = {
"Passo1": {
"CustomLWC1" : "newprop"
},
"Outro suporte" : {
"prop1" : "outro valor"
}
}
this.omniApplyCallResp(meusDados);
3. Visualize o JSON de dados atualizado.
{
"Passo 1" : {
"Moeda1": 12345,
"Texto1": "dados1",
"CustomLWC1" : "newprop"
},
"Passo 2" : {
company
"Texto3": "dados3"
},
"Outro suporte" : {
"prop1" : "outro valor"
}
}
Criar e mapear dados dentro do elemento LWC personalizado

Construa nós JSON de dados adicionais no elemento LWC personalizado e transmita valores do elemento para
os novos nós JSON usando o evento omniaggregate.Para obter mais informações sobre eventos, consulte
Criar e enviar eventos (documentação do Salesforce).
Evento : omniagregado
1. Crie uma função agregada personalizada e defina o evento omniaggregate como uma variável.
Exemplo:
customAggregate() {
const eventName = 'omniaggregate' }
2. Crie uma variável para armazenar os dados de entrada do elemento LWC.
Exemplo:
customAggregate() {
const eventName = 'omniaggregate'
const data = { anyKeyName :
'myElementData'
};
}
3. Construa um objeto mapeando os dados para os dados da chave e um nome de elemento para a chave
elementId .
customAggregate() {
dados const = {
anyKeyName: 'myElementData'
};
detalhe const = { dados:
dados,
elementId: 'elementName2'
};
}
4. (Opcional) No objeto de detalhes, inclua o par chave-valor agregadorOverride: verdadeiro para substituir
todos os dados existentes no elemento LWC personalizado.
customAggregate() {
dados const = {
};
dados,

company
elementId: 'elementName2', agregadorOverride: verdadeiro
};
}
5. Crie um novo objeto de evento que transmita o evento omniaggregate e um objeto contendo estas quatro
propriedades:
• bubbles : Um booleano que determina se o evento borbulha até o DOM.
• cancelable : Um booleano que determina se o evento é cancelável.
• composto : Um booleano que determina se o evento pode passar pelo limite da sombra.
• detalhe : Dados passados no evento. Exemplo:
omniAgregado() {
dados const = {
}; detalhe const = {
dados: dados,
};
const meuEvento = new CustomEvent(nomedoevento, {
bolhas: verdadeiro, cancelável:
verdadeiro, composto: verdadeiro,
detalhe: detalhe,
});
}
6. Chame this.dispatchEvent() e passe o objeto de evento como um parâmetro.
Exemplo de código Exemplo de resultado JSON de dados
// código para chamar omniAggregate() { "PersonalizadoLWC12": {

const eventName = 'omniaggregate' "elementName1": {
dados const = { "prop": "prop1"
anyKeyName: 'myElementData' },
}; "elementName2": {
detalhe const = { dados: dados, "anyKeyName": "myElementData"
elementId: 'elementName2' }
}; }
bolhas: verdadeiro, cancelável: verdadeiro,
composto: verdadeiro, detalhe: detalhe,
});
this.dispatchEvent(meuEvento);
}
Qual é o próximo
Adicionar um componente Web do Lightning personalizado a um elemento LWC personalizado
Veja também
• Criar um componente Web do Lightning personalizado autônomo
Criar um componente Web do Lightning personalizado autônomo
Habilite os componentes da Web do Lightning personalizados para agir independentemente de um
OmniScript, adicionando-o ao OmniScript como um componente autônomo. Para obter informações

company
sobre as diferentes maneiras de criar um componente Web do Lightning pe rsonalizado para OmniScript,
consulte Criar um componente Web do Lightning personalizado para OmniScript .
Requisitos
• O componente não pode estender o componente Web do Lightning de um elemento OmniScript.
• O componente não pode estender o componente OmniScriptBaseMixin.
• O componente só pode interagir com o OmniScript por meio do evento omniscriptaggregate.
• Para tornar o componente da Web personalizado do Lightning compatível com os componentes da Web do
<runtimeNamespace>NS</runtimeNamespace>
Criar e mapear dados dentro do elemento LWC personalizado

Construa nós JSON de dados adicionais no elemento LWC personalizado e transmita valores do elemento para
os novos nós JSON usando o evento omniaggregate.Para obter mais informações sobre eventos, consulte
Criar e enviar eventos (documentação do Salesforce).
Evento : omniagregado
1. Crie uma função agregada personalizada e defina o evento omniaggregate como uma variável.
Exemplo:
customAggregate() {
const eventName = 'omniaggregate' }
2. Crie uma variável para armazenar os dados de entrada do elemento LWC.
Exemplo:
customAggregate() {
const data = { anyKeyName :
'myElementData'
};
}
3. Construa um objeto mapeando os dados para os dados da chave e um nome de elemento para a chave
elementId .
customAggregate() {
company
dados const = {
};
dados,
};
}
4. (Opcional) No objeto de detalhes, inclua o par chave-valor agregadorOverride: verdadeiro para substituir
todos os dados existentes no elemento LWC personalizado.
customAggregate() {
dados const = {
};
dados,
elementId: 'elementName2', agregadorOverride: verdadeiro
};
}
5. Crie um novo objeto de evento que transmita o evento omniaggregate e um objeto contendo estas qu atro
propriedades:
• bubbles : Um booleano que determina se o evento borbulha até o DOM.
• cancelable : Um booleano que determina se o evento é cancelável.
• composto : Um booleano que determina se o evento pode passar pelo limite da sombra.
• detalhe : Dados passados no evento. Exemplo:
omniAgregado() {
dados const = {
};
dados,
};
detalhe: detalhe,
});
}
6. Chame this.dispatchEvent() e passe o objeto de evento como um parâmetro.
Exemplo de código Exemplo de resultado JSON de dados

company
// código para chamar omniAggregate() { "PersonalizadoLWC12": {
const eventName = 'omniaggregate' "elementName1": {
dados const = { "prop": "prop1"
anyKeyName: 'myElementData' },
}; "elementName2": {
detalhe const = { dados: dados, "anyKeyName": "myElementData"
elementId: 'elementName2' }
}; }
bolhas: verdadeiro, cancelável: verdadeiro,
composto: verdadeiro, detalhe: detalhe,
});
this.dispatchEvent(meuEvento);
}
Qual é o próximo
Adicionar um componente Web do Lightning personalizado a um elemento LWC personalizado
Veja também
• Comunicar-se com OmniScript a partir de um componente Web do Lightning
• Estender o componente OmniScriptBaseMixin
Comunicar-se com OmniScript a partir de um componente Web do Lightning

Envie dados de ações e etapas do OmniScript para outros LWCs usando a propriedade Pub/Sub.
A propriedade Pub/Sub permite que os elementos Action e Step enviem dados em pares de chave-valor para
outros LWCs. Os LWCs devem registrar o nome do evento do componente OmniScript e adicionar código para
manipular os dados enviados do evento.
Revise a documentação do Salesforce sobre o uso do PubSub. Consulte Comunicação entre componentes .
1. Em uma ação ou etapa do OmniScript, selecione o Messaging Framework e marque Pub/Sub .

2. Nos campos Chave e Valor, configure quais dados passar para outro LWC.
a. No campo Chave , insira um nome para armazenar o valor.
b. No campo Valor , insira os dados a serem transmitidos ao LWC. O campo aceita a sintaxe de
mesclagem.
Exemplo de ação Exemplo de etapa
Passe os dados da resposta da ação no campo de valor usando a sintaxe Passe dados de um elemento dentro da Etapa usando a
de mesclagem. Por exemplo, para passar o nó de resposta "accountId" , sintaxe de mesclagem. Por exemplo, para passar um
insira %accountId% no campo Valor . elemento Text chamado Text1 , insira %Text1% no campo
Valor .
3. Ative o OmniScript.

company
4. Em um LWC que recebe dados da Ação ou Etapa, importe o módulo pubsub. Usando este exemplo,
substitua ns pelo namespace do seu pacote Vlocity. Consulte Visualizando o namespace e a versão do
pacote OmniStudio Vlocity .
importar pubsub de 'ns/pubsub';

5. No LWC, registre o evento pubsub. O evento deve ser registrado após a renderização do componente.
Evento de ação pubsub Etapa do evento pubsub
pubsub.register('omniscript_action', { data: pubsub.register('omniscript_step', {

this.handleOmniAction.bind(th is), dados: this.handleOmniStepLoadData.bind( this),
}); });
6. No LWC, crie um manipulador de eventos pubsub.

Exemplo de manipulador de eventos de ação Exemplo de manipulador de eventos de etapa
handleOmniAction(dados) { handleOmniStepLoadData(dados) {
// executa a lógica para lidar com a ação // executa a lógica para lidar com os dados do pubsub de
dados de resposta o passo
} }
7. (Opcional) Se ações ou etapas diferentes exigirem uma lógica diferente no código, use uma instrução
switch para determinar como lidar com o evento. Para obter informações sobre instruções switch,
consulte switch .
Exemplo de ação Exemplo de etapa
Acesse o nome do elemento da ação usando data.name . Acesse o nome do elemento da etapa usando data.name .
handleOmniAction(data) { switch(data.name) { case handleOmniStepLoadData(dados) {

'SomeNameForAction': switch(data.name) { case
this.handleSomeNameForAction(d ata); 'FirstStep':
parar; case 'SomeNameForAction2':
this.handleSomeNameForAction2(d ata); this.handleOmniFirstStepLoadData(d ata);
parar; predefinição: parar; case 'Segunda Etapa':
}
this.handleOmniSecondStepLoadData(data);
}
handleSomeNameForAction(data) { // trata o caso padrão
Ação SomeNameForAction }
// que tem nome do elemento =
"SomeNameForAction" handleOmniFirstStepLoadData(d ata) {
// executa alguma lógica específica quando um
}
handleSomeNameForAction2(data) { // FirstStep é carregado
Ação SomeNameForAction2
// que tem nome do elemento = handleOmniSecondStepLoadData(data) {
// executa alguma lógica específica quando um
"SomeNameForAction2"
}
// SecondStep é carregado
}

company
Acesse o Tipo de Elemento da Ação usando data.type . n/D
handleOmniAction(data) { switch(data.type) { case 'Ação

do Procedimento de Integração':
this.handleIPActionPubsubEvents(data);
parar; case 'Ação Remota':
this.handleRemoteActionPubsubEvents(data);
}
}
handleIPActionPubsubEvents(dados) {
// executa alguma lógica específica para
}
handleRemoteActionPubsubEvents(dados) {
// executa alguma lógica específica para Remote
Ações
}
Veja também
• Mensagem com mensagens de postagem de janela e mensagens de armazenamento de sessão
Fazer chamadas remotas de componentes da Web do Lightning usando o OmniScript
Estrutura de ação
Os OmniScripts fazem chamadas remotas usando uma nova estrutura de ação criada com classes JavaScript. A
estrutura Action está disponível para todos os LWCs personalizados em sua organização do Salesforce. Habilite
um LWC para fazer chamadas remotas usando funcionalidades específicas importando a classe Common
Action Utility para o LWC.
NOTA
Os LWCs personalizados que estendem o OmniScript Base Mixin devem usar a função
omniRemoteCall() . Para obter mais informações, consulte Estender o componente
Diagrama de fluxo da estrutura genérica

O diagrama de fluxo da estrutura genérica ilustra a ordem em que os métodos do Common Action Utility são
executados.

company
Requisitos
Para tornar o componente da Web personalizado do Lightning compatível com os componentes da Web do
NOTA
Componentes Web do Lightning personalizados não gerarão erros, a menos que o Modo de
Melhor prática
Ao fazer chamadas remotas, inicie o fluxo com o método executeAction . Não inicie o fluxo com o método
invokeAction . Para padronizar o fluxo de ação e usar a lógica interna da estrutura de ação, a Vlocity
recomenda que todos os fluxos de ação comecem com executeAction .

company
NOTA
A finalidade do método invokeAction é fazer a chamada remota com parâmetros de solicitação
processados pelo método preProcess . O método preProcess , por padrão, suporta fluxos de
processo enfileirados e encadeados. O método postProcess padroniza a resposta em um formato
previsível.
Utilitário de ação comum

Faça chamadas remotas de qualquer LWC personalizado usando o Common Action Utility. O Common Action
Utility depende do Vlocity Action Framework para fazer chamadas remotas sem a dependência de uma
estrutura de dados OmniScript estrita.
Utilitário : omniscriptActionUtils
Nome da classe de utilitário : OmniscriptActionCommonUtil

Métodos definidos
Nome do método Descrição Argumento - Tipo de dados Devoluções
executeAção Inicia a execução de um fluxo de ação. • params - objeto promessa

• queueableId - string
• comp - componente
• carga útil - objeto
• vlcParams - objeto
handleActionEvent s Manipula eventos de ação quando a chamada remota obtém uma • comp - componente vazio
resposta. Ele pode ser configurado para enviar eventos para o • resp - objeto
console de depuração do OmniScript Designer. Configurado para • params - objeto
enviar eventos pubsub. • elemento - objeto
No LWC, se sendDataToDebugConsole estiver definido no

componente, os logs de eventos podem ser enviados para o Debug
Console no Omniscript Designer. Se o componente não estiver no
OmniScript, defina _debugLabel no componente para preencher o
nome do evento do log de depuração. Se for omniscript, o nome do
evento do log de depuração será preenchido a partir da propriedade
label no conjunto de propriedades do elemento.
invocarAção Método que invoca uma classe do Apex ou uma resolução de promessa • dados - objeto promessa
usando uma solicitação de ação transformada. • comp - componente
• (opcional) carga útil -objeto
pós-processo Pós-processa a resposta de chamada remota para chamadas remotas • resp - objeto objeto
bem-sucedidas e com falha e retorna uma resposta pós -processada. O • elemento - objeto
retorno contém um objeto com os nós principais: • comp - componente
• (opcional) falha -boolean
• resultado: armazena a resposta bruta da chamada remota
• erro: booleano
pré-processar Pré-processa os parâmetros de chamada remota antes de invocar uma • params - objeto objeto
ação. • queueableRespId -string
• comp - componente
• carga útil - objeto
• vlcParams - objeto
Variáveis Disponíveis
Nome variável Descrição
_ns Namespace em notação de ponto
_elemento (Opcional) Definição JSON do elemento Omniscript

company
Implementando o Common Action Utility
Para implementar o Common Action Utility:
1. Obtenha o formato de notação de ponto do namespace em seu LWC importando

getNamespaceDotNotation de omniscriptInternalUtils . Substitua NS na primeira linha de código pelo
namespace do seu pacote. Para obter informações sobre como localizar o namespace do seu pacote,
consulte Visualizando o namespace e a versão do pacote OmniStudio Vlocity .
NOTA
Chamadas remotas feitas para classes do Apex dentro de um pacote gerenciado vlocity
devem incluir o namespace no parâmetro sClassName enviado para executeAction .
import { getNamespaceDotNotation } de 'NS/omniscriptInternalUtils'; _ns =

getNamespaceDotNotation();
2. Importe OmniscriptActionCommonUtil para seu LWC da classe de utilitário omniscriptActionUtils .
Substitua NS na primeira linha de código pelo namespace do seu pacote. Para obter informações sobre
como localizar o namespace do seu pacote, consulte Visualizando o namespace e a versão do pacote
import { OmniscriptActionCommonUtil } de 'NS/omniscriptActionUtils';

3. Crie uma instância da classe javascript OmniscriptActionCommonUtil.
this._actionUtilClass = new OmniscriptActionCommonUtil();

4. Use os métodos OmniscriptActionCommonUtil para executar chamadas remotas para o servidor.
• O fluxo mais comum é usar o método executeAction . Esse método inicia o fluxo de chamada remota
e o retorno de chamada de resposta de executeAction retorna um objeto que possui estas
propriedades:
• resultado: Contém a resposta da chamada remota.
• erro: contém um booleano indicando o status de invocação de GenericInvoke2.
• Os parâmetros enviados para executeAction devem estar em um formato de objeto. O objeto deve
ter as seguintes chaves:
• entrada
• sClassName
• sMethodName
• opções
NOTA
Cada chave requer um valor de string.
• Se o LWC for exibido no Omniscript Designer, é possível enviar eventos para o Debug Console.Enviar
eventos para o Debug Console incluindo o método sendDataToDebugConsole em seu LWC. O
método fornece lógica no envio de eventos para o console de depuração.
sendDataToDebugConsole aceita estes argumentos:
• parâmetros
• resp
• etiqueta

company
Exemplos
Para usar o Common Action Utility, consulte estes exemplos:
• Exemplo de chamada remota usando executeAction :
conectadoCallback() {
this._actionUtilClass = new OmniscriptActionCommonUtil(); }
triggerRemote() { const params = {

input: '{}', sClassName: 'LwcTest',
sMethodName: 'lwctest', options: '{}',
};
this._actionUtilClass
.executeAction(params, null, this, null, null)
.then(resposta => {
janela.console.log(resposta);
})
.catch(erro => {
janela.console.log(erro);
});
}
• Exemplo de método sendDataToDebugConsole :
sendDataToDebugConsole(params, resp, label) { let sendParams =

JSON.parse(JSON.stringify(params));
if (sendParams && sendParams.options) { let optionNode =
JSON.parse(sendParams.options);
delete optionNode.options; delete
optionNode.input; sendParams.options =
optionNode;
}
let sendResp = JSON.parse(JSON.stringify(resp));
// para suporte enfileirado

if (sendResp && sendResp.responseResult) {
sendResp.responseResult = JSON.parse(sendResp.responseResult); }
// envia dados de ação para o console de depuração const debugEvent = new

CustomEvent('omniactiondebug', {
detalhe: {
params: sendParams, resposta: sendResp,
elemento: { label: label },
},
});
this.dispatchEvent(debugEvent); }
• Exemplo de chamada remota enfileirada usando executeAction :

company
triggerQueueable() { const options = { input: '{}',

vlcClass: 'LwcTest', vlcMethod: 'lwctest',
useQueueableApexRemoting: true,
}; const params = { input:
'{}', sClassName: `$
{this._ns}VFActionFunctionController.VFActionFunctionControllerOpen`,
sMethodName: 'runActionFunction', opções:
JSON.stringify(opções),
};
.then(resposta => {
})
.catch(erro => {
window.console.log(erro, 'erro');
});
}
• Exemplo de chamada remota de continuação usando executeAction :
triggerContinuation() { const
options = { input: '{}',
vlcClass: 'QeRemoteAction2',
vlcMethod: 'populateElements', useContinuation: true,
}; parâmetros const = {
entrada: JSON.stringify(this.omniJsonData), sClassName:
'QeRemoteAction2', sMethodName: 'populateElements',
opções: JSON.stringify(options),
};
.then(resposta => {
})
.catch(erro => {
});
}
• Exemplo de chamada remota futura usando executeAction :
triggerFuture() { const
options = { useFuture:
true,
company
}; const params = {
input: '{}',
sMethodName: 'Test_Chainable', opções:
JSON.stringify(options),
};
.then(resposta => {
})
.catch(erro => {
});
}
• Exemplo de chamada remota encadeável usando executeAction :
triggerChainable() { const options

= { chainable: true,
};
const params = { input: '{}',
sMethodName: 'Test_Chainable', opções: JSON.stringify(options),
};
.then(resposta => {
})
.catch(erro => {
});
}
Parâmetros de amostra para uma chamada remota de dentro de um pacote Vlocity:
const params = { input:

'{}',
sMethodName: 'Test_Chainable', opções:
'{chainable: true}', };
Adicionar validação a um componente Web do Lightning personalizado no OmniScript

Adicione validação a componentes Web do Lightning personalizados que estendem o componente de um
elemento OmniScript usando os métodos de validação integrados do Vlocity.
O componente omniscriptValidation fornece ao componente do elemento OmniScript as funções para habilitar

a validação. Para obter informações sobre como usar a validação em componentes personalizados que

company
não estendem o componente de um elemento OmniScript, consulte Estender o componente
Leia-me de validação do OmniScript

Veja exemplos de validação para componentes Web do Lightning personalizados no ReadMe de validação do
OmniScript. Consulte Referência Leia-me do OmniScript .
Personalizar o componente do gráfico de etapas
Adicione personalizações ao seu Step Chart estendendo os componentes Web do Step Chart Lightning, o
componente StepChart e o componente Step Items.
O componente da Web stepChartItems Lightning contém lógica que determina os diferentes status de etapas
que o gráfico de etapas e seus rótulos exibem. Para obter informações sobre como estender os componentes
da Web do OmniScript Lightning, consulte Estender o componente da Web do Lightning de um elemento
OmniScript .
1. Crie um componente Web Step Chart Lightning personalizado que estenda o componente Web stepChart
Lightning. Para obter mais informações, baixe a Referência ReadMe OmniScript ReadMe .
2. Estenda o componente web stepChartItems Lightning de duas maneiras:
• Personalize o LWC stepChartItems criando um componente personalizado adicional que estende o LWC
stepChartItems. Para obter mais informações, baixe a Referência ReadMe OmniScript ReadMe .
• Estenda o stepChartItems LWC diretamente em seu Step Chart LWC personalizado. O comportamento
e o estilo padrão do stepChartItems LWC serão exibidos em seu Step Chart LWC personalizado.
3. (Opcional) Se existir um LWC de itens do gráfico de etapas personalizado, estenda esse componente em
seu componente gráfico de etapas personalizado.
4. Depois de implantar LWCs personalizados no Salesforce, abra um OmniScript.
5. Nas propriedades de configuração de script do OmniScript, vá para Element Type To LWC Component
Mapping e clique em Add New Mapping .
6. No campo Tipo de elemento , insira StepChart .
7. No campo Componente da Web do Lightning , insira o nome do seu componente da Web do Lightning
personalizado.
Veja também
• Estender o componente da Web do Lightning de um elemento OmniScript
Estender e substituir um componente da Web do OmniScript Modal Lightning

Personalize modais no OmniScript estendendo e substituindo o Modal LWC.
Modal padrão Modal de erro padrão
1. Crie um LWC personalizado que estenda o LWC omniscriptModal e adicione-o à sua organização do
Salesforce. Consulte Estender o componente da Web do Lightning de um elemento OmniScript .

company
2. O LWC modal personalizado deve ter esses três slots para que o OmniScript insira conteúdo no modal:
<slot name="header></slot>
<slot name="content></slot>
<slot name="footer"></slot>
3. Em Configuração do OmniScript , role até a propriedade Tipo de elemento para mapeamento de
componente LWC .
4. No campo Tipo de elemento , insira Modal .
5. No campo Lightning Web Component , insira o nome do LWC personalizado.

6. Ative e visualize o OmniScript para visualizar suas alterações modais.
Veja também
• Personalizar o componente do gráfico de etapas
• Implantar componentes da Web do Lightning
Estender e substituir o Salvar para mais tarde Reconhecer o componente Web do

Lightning
Personalize o modal de mensagens Salvar para mais tarde no OmniScript estendendo e substituindo o Salvar
para mais tarde Reconhecer LWC.
Mensagem padrão Salvar para mais tarde Confirmar:
Para estender e substituir o LWC Salvar para confirmação posterior:
1. Crie um LWC personalizado que estenda o LWC omniscriptSaveForLaterAcknowledge e adicione-o à sua

organização do Salesforce. Consulte Estender o componente da Web do Lightning de um elemento
OmniScript .
2. Em OmniScript Setup, role até a propriedade Element Type to LWC Component Mapping .
3. No campo Tipo de elemento , insira SaveForLaterAcknowledge .
4. No campo Lightning Web Component , insira o nome do LWC personalizado.

5. Em Opções de salvamento , marque Permitir salvar para mais tarde .
6. Ative e visualize o OmniScript para ver o salvamento para substituição posterior.

company
Veja também
• Implantar componentes da Web do Lightning
Adicionar componentes Web do Lightning personalizados a um

OmniScript
Depois de criar um componente Web do Lightning personalizado para OmniScript , aplique o novo
comportamento do componente adicionando-o a um OmniScript.
Use o componente personalizado para substituir o componente de um elemento OmniScript individual,

substituir todos os componentes do elemento OmniScript de um tipo de elemento ou adicionar um
componente totalmente personalizado que não estende o componente de um elemento.
Opção de mapeamento Descrição
Substituir o componente da Web do Lightning de um elemento Substitui o LWC de um elemento individual.
Mapear um tipo de elemento para uma Web do Lightning Substitua o LWC para cada elemento de um elemento específico Tipo — por
personalizada exemplo, substitua o elemento Tipos Texto ou Moeda.
Componente
Adicionar um componente Web do Lightning personalizado a Adicione LWCs personalizados que não estendem um elemento OmniScript
um existente usando o elemento LWC personalizado.
Elemento LWC
NOTA
Antes de visualizar um OmniScript que usa componentes Web do Lightning personalizados, você deve
ativar o OmniScript. Se o OmniScript não estiver ativo, os componentes Web personalizados do
Lightning não serão renderizados na visualização. Se você implantar alterações em um componente
Web do Lightning personalizado presente em um Active OmniScript, o OmniScript exibirá as alterações.
Veja também
• Estilo OmniScripts
Substituir o componente da Web do Lightning de um elemento

Substituir o componente de um elemento usando a substituição de componente LWC do elemento
O LWC personalizado deve estender o componente do elemento porque o OmniScript transmite as

propriedades específicas do componente original que o componente personalizado está substituindo. Para
obter mais informações sobre como estender os componentes do elemento OmniScript, consulte Estender o
componente da Web do Lightning de um elemento OmniScript .
1. No painel de propriedades do elemento, no campo Substituição do componente LWC , insira o nome de
um componente Web personalizado do Lightning.
2. Salve e ative o OmniScript.
3. Ative o OmniScript e clique na guia Visualizar para visualizar o OmniScript.
Qual é o próximo
Implante seu OmniScript para visualizar o design e o comportamento do Custom LWC. Consulte Ativar e
implantar OmniScripts .
Veja também

company
• Adicionar componentes Web do Lightning personalizados a um OmniScript
Mapear um tipo de elemento para um componente Web personalizado do Lightning

Substitua todos os elementos de um tipo por um componente Web personalizado do Lightning mapeando o
tipo de elemento para o LWC personalizado.
O componente web Lightning personalizado deve estender o componente web Lighting do Tipo de elemento.
Por exemplo, para substituir todos os elementos Text no OmniScript, o componente personalizado deve
estender o componente OmniScriptText.
1. Na Script Configuration do OmniScript, localize a propriedade Element Type To LWC Component

Mapping e clique em New Mapping .
2. No campo Tipo de Elemento , insira o Tipo de Elemento que o componente personalizado substitui.
3. No campo Componente da Web do Lightning , insira o nome do componente personalizado que substitui
o tipo de elemento.
5. Clique em Visualizar para visualizar o OmniScript.
Qual é o próximo
Veja também
Adicionar um componente Web do Lightning personalizado a um elemento LWC

personalizado
Adicione componentes da Web do Lightning personalizados que não estendem o componente de um
elemento OmniScript usando o elemento LWC personalizado .
O elemento Custom LWC permite que componentes personalizados interajam com o OmniScript ou atuem
como um componente independente. Componentes autônomos não interagem com o OmniScript ou com o
JSON de dados do OmniScript.
Adicione um LWC personalizado que estende o mixin base do OmniScript
Para adicionar um componente Web do Lightning personalizado a um elemento LWC personalizado:
NOTA
Habilite componentes da Web do Lightning personalizados para interagir com o OmniScript
estendendo o
componente OmniScriptBaseMixin. Os componentes Web personalizados do Lightning que
estendem o OmniScriptBaseMixin não podem estender o componente de um elemento
OmniScript. Para obter mais informações sobre o OmniScriptBaseMixin, consulte Estender o
componente OmniScriptBaseMixin
1. Arraste um elemento LWC personalizado de Entradas para a tela.

2. No campo Nome do componente da Web do Lightning , insira o nome de um componente
que estende o OmnIScriptBaseMixin.
company
3. (Opcional) Expanda a seção Propriedades de componentes Web personalizados do Lightning e clique em
Adicionar nova opção .
4. (Opcional) No campo Nome da propriedade , insira o nome de uma propriedade definida no componente
Web personalizado do Lightning.
5. (Opcional) No campo Origem da propriedade , insira uma string ou um campo de mesclagem.
Adicionar um LWC personalizado autônomo

Para adicionar um componente Web do Lightning personalizado autônomo a um OmniScript:
NOTA
Os componentes Web do Lightning personalizados independentes não podem estender nenhum
componente de elemento OmniScript ou o componente OmniScriptBaseMixin. O componente
autônomo oferece suporte a funcionalidades personalizadas, mas não pode interagir com um
OmniScript. Para obter mais informações sobre os componentes autônomos, consulte Criar um
componente Web personalizado do Lightning autônomo .
1. Arraste um elemento LWC personalizado de Entradas para a tela.

2. No campo Nome do componente Web do Lightning , insira o nome de um componente da Web do
Lightning.
3. Marque a caixa de seleção Autônomo .
Qual é o próximo
Veja também
Estilo OmniScripts
Adicione estilos personalizados aos OmniScripts usando recursos estáticos, estendendo o componente da Web
do Lightning de um elemento, substituindo folhas de estilo globais ou usando tokens de design SLDS.
Visualize o comportamento de cada opção de personalização na tabela desta página e escolha a solução que
atende aos seus requisitos.
Opção de estilo Descrição Projeto Suportado
Sistemas
Aplicar estilo personalizado a OmniScripts Adicione estilos personalizados ao OmniScript usando uma folha de estilos SLDS, NDS
com recursos estáticos personalizada.
Estender um elemento OmniScript Crie um LWC personalizado que estenda um OmniScript para adicionar SLDS, NDS
Componente da Web do Lightning HTML, JS e CSS personalizados.

company
Aplique a marca global aos OmniScripts Substitua o Newport Design System por estilos personalizados para uma NDS
organização inteira do Salesforce.
Personalize tokens de design SLDS em Adicione personalizações aos tokens de design SLDS que existem no SLDS
OmniScript OmniScript.
Veja também
• Estender e substituir um componente da Web do OmniScript Modal Lightning
• Estender e substituir o Salvar para mais tarde Reconhecer o componente Web do Lightning
Aplicar estilo personalizado a OmniScripts com recursos estáticos

Aplique as alterações de CSS a um OmniScript usando o estilo SLDS ou Newport fazendo referência a um
recurso estático de arquivo CSS na seção Opções de estilo do OmniScript Designer. Por exemplo, uma planilha
CSS pode alterar a cor do texto de cada elemento Number em um OmniScript sem usar componentes Web
personalizados do Lightning para substituir o elemento Number.
NOTA
Multi-Language OmniScripts fornece suporte beta para idiomas da direita para a esquerda. Consulte
Criar OmniScripts em vários idiomas .
1. Escolha SLDS ou Newport como o tema OmniScript.

2. Visualize o CSS original do OmniScript inspecionando os elementos na página nas ferramentas do console ou baixando os arquivo s CSS para LWCs
no OmniScript. Baixe .
3. Crie uma folha de estilo CSS com CSS personalizado.
4. No Salesforce, adicione o arquivo CSS como um recurso estático. Consulte Usando recursos estáticos (documentação do Salesforce).
1. No OmniScript Designer, clique em Configuração e em Opções de estilo .

2. No campo Nome do arquivo de folha de estilo personalizado do Lightning ou Nome do arquivo de folha
de estilo personalizado do Newport , insira o nome desse Recurso estático que armazena seu estilo
personalizado do Lightning ou Newport.

company
3. (Opcional) Exiba estilos personalizados para idiomas da direita para a esquerda seguindo estas etapas:
a. Em Configuração , clique em Editar como JSON .
b. Adicione o nome do recurso estático como um valor para newportRtl ou lightningRtl para exibir o
estilo dos idiomas da direita para a esquerda. Se você estiver atualizando um OmniScript existente,
adicione newportRTL e lightningRtl manualmente.
"folha de estilo": {
"newport": "",
"relâmpago": "",
"newportRtl": "myRtlNewportStyles",
"relâmpagoRtl": ""
}
4. Ative e visualize o OmniScript para visualizar seu estilo personalizado.
Veja também
• Aplique a marca global aos OmniScripts
• Criar OmniScripts em vários idiomas
Nomes de folha de estilo de referência no JSON de um OmniScript

Aplique as alterações CSS a um OmniScript usando o estilo SLDS ou Newport fazendo referência a um
recurso estático de arquivo CSS nas propriedades JSON do OmniScript. Por exemplo, uma planilha CSS

company
pode alterar a cor do texto de cada elemento Number em um OmniScript sem usar componentes Web
personalizados do Lightning para substituir o elemento Number.
1. Escolha SLDS ou Newport como o tema OmniScript.
2. Visualize o CSS original do OmniScript inspecionando os elementos na página nas ferramentas do console ou baixando os arquivo s CSS para LWCs
no OmniScript. Baixe .
3. Crie uma folha de estilo CSS com CSS personalizado.
4. No Salesforce, adicione o arquivo CSS como um recurso estático. Consulte Usando recursos estáticos (documentação do Salesforce).
NOTA
Multi-Language OmniScripts fornece suporte beta para idiomas da direita para a esquerda.
1. No OmniScript, vá para Setup ou Script Configuration e clique em Edit as JSON .

2. Nas propriedades JSON, localize o nó chamado style sheet :
"newport": "",
"relâmpago": ""
}
3. Adicione o nome do recurso estático como um valor para newport ou lightning .
"newport": "",
"relâmpago": "myCustomOmniScriptStyles"
}
4. (Opcional) Adicione o nome do recurso estático como um valor para newportRtl ou lightningRtl para
exibir o estilo dos idiomas da direita para a esquerda. Se você estiver atualizando um OmniScript
existente, adicione newportRTL e lightningRtl manualmente.
"newport": "",
"relâmpago": "",
"newportRtl": "myRtlNewportStyles",
"relâmpagoRtl": ""
}
5. Ative e visualize o OmniScript para visualizar seu estilo personalizado.
Veja também
Personalizar tokens de design SLDS no OmniScript

Modifique a aparência de um OmniScript substituindo os tokens de design SLDS do Salesforce.
Os elementos OmniScript usam tokens de design SLDS para estilização. Substitua os tokens que têm acesso
global para modificar a aparência do seu OmniScript.

company
NOTA
Os tokens de design não são suportados em navegadores Safari e páginas da comunidade.
1. Visualize os Design Tokens que têm acesso global. Consulte Design de tokens .
2. Visualize e inspecione um OmniScript em um console de desenvolvedor para visualizar os tokens atuais presentes no
OmniScript.
1. Configuração do OmniScript , clique na seção Opções de estilo ou na seção Tokens de design do
Lightning Design System .
2. No campo Tokens de design do Lightning Design System , insira tokens aplicando estas alterações:
a. Remova os traços e aplique camelcase ao token. Por exemplo, o token $spacing-xxsmall deve ser
$spacingXxSmall .
b. Substitua o símbolo $ do token por --lwc- .
--lwc-spacingXxSmall
c. Defina o valor do token e termine a linha de cada token usando um ; .
company
--lwc-spacingXxSmall: 10rem;
--lwc-spacingSmall: 5rem;
--lwc-spacingMedium: 2rem;
Veja também
• Visão geral do OmniScript Designer
Usar imagens para botões no OmniScript

Use imagens como botões para opções de rádio e seleção múltipla no OmniScript.
1. Em um elemento, role para baixo até a seção Opções do elemento.

2. Selecione Imagem nos menus suspensos localizados em Modo de exibição e Origem da opção .
3. Clique no botão + Adicionar para escolher qual imagem exibir. Quando o usuário seleciona a imagem
enquanto preenche o OmniScript, o valor da opção é adicionado ao Data JSON.
Quebra de linha
O elemento Line Break cria uma quebra de linha no OmniScript onde quer que exista.
Os elementos colocados após uma quebra de linha começam na próxima linha, independentemente da largura
de um outro elemento. Coloque o elemento de quebra de linha diretamente acima do elemento que deve
começar em uma nova linha.
Para usar o elemento de quebra de linha:
1. Arraste o elemento para a tela OmniScript.

2. Ao editar as propriedades do elemento da quebra de linha , você pode adicionar preenchimento adicional
abaixo da quebra de linha inserindo um valor em Preenchimento adicional (px) .
Resultados
A quebra de linha garante que uma linha separe os elementos ao redor do elemento quebra de linha. Por
exemplo, esta imagem exibe um elemento de quebra de linha que separa o nome e o sobrenome de uma
pessoa de seu telefone e e-mail na interface do usuário.

company
Veja também
• Modificar o comportamento da interface do usuário do OmniScript
Aplique a marca global aos OmniScripts

Aplique alterações globais de estilo a OmniScripts usando o Newport Design System. O Newport Design System
permite que você baixe, edite e substitua o estilo CSS de Newport existente para aplicar suas alterações.
Se você não estiver familiarizado com o uso de interfaces de linha de comando, consulte Linha de comando 101
(documentação do git-torre).
Requisitos de sistema:
• Git (documentação do git-scm)

• nodeJS v12.0 ou superior (documentação do nó)
• CLI do Gulp: npm install --global gulp-cli
1. Certifique-se de que o Node e o NPM estejam instalados em seu computador local usando os comandos
que o NPM descreve em sua documentação https://www.npmjs.com/get-npm . Se você não tiver Node
ou NPM, baixe-os em https://nodejs.org/en/download/ .
2. Clone vlocityinc/newport-design-system de https://github.com/vlocityinc/newport-design-system
usando uma interface de linha de comando. Para ver quais componentes são fornecidos pelo Newport,
consulte o diretório UI/components .
3. Do GitHub página, execute as etapas mais recentes para instalar as dependências corretas.
4. Após a conclusão da instalação, inicie a visualização do Storybook.js emitindo o comando npm start .
5. Revise a documentação na visualização do Storybook.
6. Adicione personalizações ao seu tema. Consulte Personalizando OmniScripts e Cartões com o Vlocity
Newport Design System .
7. Aplique o OmniScript a OmniScripts individuais ou substitua o tema Newport para toda a organização.
Consulte Implantar e aplicar alterações globais de estilo usando o Newport Design System .
8. Visualize as alterações em sua organização do Salesforce usando o Newport Player no OmniScript
Designer Preview.
Veja também
• Aplicar estilo personalizado a OmniScripts com recursos estáticos
company
Personalizando OmniScripts e Cartões com Vlocity Newport Design System
Para personalizar a aparência de seus OmniScripts ou Cartões, edite os arquivos CSS e HTML no subdiretório UI
do diretório onde você clonou Newport.
Os temas são armazenados na pasta design-tokens . Para criar um novo tema para seus OmniScripts ou
Cartões, copie a pasta vlocity-newport-skin para uma nova pasta e edite os arquivos nela conforme necessário.
Para alterar o esquema de cores de um tema, edite os arquivos *color.yml da capa . Algumas cores são
especificadas usando códigos RGB hexadecimais, outras são especificadas usando tokens que resolvem para
cores RGB hexadecimais. Esses tokens são definidos no arquivo aliases/color.yml . Para alterar as cores de um
componente específico, examine sua definição para localizar a origem de suas propriedades de cor e rastreie-a
até a definição.
Quando você altera as cores, os componentes Newport são recompilados, portanto, há um pequeno atraso
antes que suas alterações sejam refletidas no Visualizador.
Exemplo Simples : Usando o Previewer, observe a definição do elemento de entrada , observando o

sublinhado laranja. Para alterar a cor da linha, edite design-tokens/vlocity-newport-skin/ background-
color.yml e altere a configuração de COLOR_BORDER_INPUT_ACTIVE para um token de cor diferente definido
em /aliases/color.yml . Para verificar sua mudança, visualize o componente de entrada usando o Previewer.
Para uma aparência ideal em todas as plataformas de visualização, defina a largura de controle como 6.
Larguras menores podem não renderizar bem em todas as plataformas.
Visualizando suas alterações

Para visualizar o efeito dos estilos Newport em um OmniScript, edite sua Configuração de script e cole o
caminho para o arquivo CSS de nível superior (por padrão, xxx.css) no campo CUSTOM HTML TEMPLATES.
O Newport Previewer permite visualizar a definição, a aparência e o comportamento dos componentes e

utilitários do Newport. Você pode ver como o componente será renderizado em desktops, tablets e
smartphones.
Para visualizar um elemento ou utilitário, escolha-o nas listas no painel esquerdo. Para visualizar o código por
trás dele, clique em </> .
A árvore de restrições exibe a hierarquia das definições dos elementos, desde a implementação base até todas
as derivadas. Para visualizar uma definição específica, clique no nó correspondente na árvore de restrição.
Implante e aplique alterações globais de estilo usando o Newport Design System
Aplique modificações ao sistema de design Newport adicionando um recurso estático que substitui o tema
Newport sempre que estiver disponível. Uma vez carregado, as alterações do Newport serão aplicadas a
qualquer OmniScript usando o Newport.
1. Baixe o Newport Design System. Consulte Aplicar marca global a OmniScripts .

2. Crie uma pasta de distribuição contendo suas alterações emitindo este comando: npm run-script dist
3. No Salesforce, carregue o arquivo zip como um recurso estático.
1. Na sua organização do Salesforce, vá para Configuração e, na caixa Busca rápida , insira Configuração de
interação Omni .
2. Clique em Gerenciar , clique em Novo e defina as seguintes configurações:
• Label : Você deve nomear este newportZipUrl para que as alterações sejam aplicadas.
• Nome : Digite qualquer nome.
company
• Valor : a URL relativa do recurso estático que contém seus estilos personalizados. Para obter a URL
relativa, vá para o Recurso Estático (consulte 4 na seção Antes de Começar), passe o mouse sobre o link
Visualizar Arquivo , clique com o botão direito do mouse e copie a URL. Insira a URL relativa
após o nome do domínio, removendo o ponto de interrogação no final. Por exemplo, o texto em
negrito seria copiado neste URL: https://salesforceorg-
test.na75.visual.force.com/resource/16679825000/vloc_customNewport ?
3. Visualize seu OmniScript e selecione a página Newport no menu suspenso no canto superior direito para
visualizar suas alterações.
Veja também
Modificar o comportamento da interface do usuário do OmniScript

Esta seção explica como modificar os comportamentos da interface do usuário em um OmniScript.
As opções de comportamento incluem:
• Ocultar ou mostrar elementos e erros condicionalmente

• Ocultar os botões Próximo e Anterior
• Acionar eventos
Elementos de exibição condicional usando a propriedade de exibição condicional

Cada etapa, bloco ou elemento oferece suporte à visualização condicional. As Visualizações Condicionais
permitem ocultar o elemento ou o grupo de elementos contidos em um bloco ou etapa com base em
determinadas condições.
Os elementos contêm até três opções de visualização condicional, dependendo do Tipo de elemento. Por
exemplo, uma ação fora de uma etapa não tem uma opção somente leitura, pois a ação não é visível.
Para configurar visualizações condicionais:

1. Na seção Propriedades do elemento, vá para a seção Vista Condicional .
2. Selecione um Tipo de Condição no menu suspenso.
Designer LWC OmniScript Descrição
Condições
Mostrar elemento se verdadeiro O elemento renderiza somente se a condicional for verdadeira. Se a condicional for falsa, o
elemento ficará oculto na interface do usuário.
Desabilitar somente leitura se verdadeiro Desabilita Read Only em um elemento se a condicional for verdadeira. Se o valor for false, o
elemento se torna Read Only.
Definir elemento como obrigatório se O elemento se torna necessário se a condição for verdadeira.
verdadeiro
3. Escolha o operador lógico para o grupo (AND ou OR). O operador AND requer que ambas as condições
sejam atendidas; o operador OR requer que uma das outras condições seja atendida.
4. Clique em Adicionar condição .
5. No operando esquerdo, insira o nome do elemento em texto simples.

company
NOTA
Se o elemento for repetível, insira o nome do elemento seguido por |x , onde x é o xº
elemento repetido. Por exemplo, se Age for repetido, Age|2 se refere à segunda instância do
elemento repetido.
6. No operando direito insira um destes tipos de sintaxe::

• Se o tipo de elemento for Texto, insira a string em texto simples.
• Se o tipo de elemento for Checkbox ou Disclosure , insira true ou false .

• Se o tipo de elemento for Number , insira um número.
• Se o tipo de elemento for Select ou Radio , digite o nome da opção em texto simples — por exemplo,
Yes ou No .
• Se o tipo de elemento for Multi-Select , insira uma string separada por ponto e vírgula — por exemplo
Ind;Small .
• Se o tipo de elemento for Date , Time ou Date/Time , o valor deverá estar no formato ISO :
• Data—2014-10-01T07:00:00.000Z (quarta-feira, 01 de outubro de 2014 00:00:00 GMT-0700 (PDT)
• Data/Hora—1970-01-02T06:19:00.000Z (Terça 17 de fevereiro de 2015 22:20:03 GMT-0800 (PST))
• Horário—2015-02-21T00:09:40.270Z (Qui 01 de janeiro de 1970 22:19:00 GMT-0800 (PST))
• O operando direito suporta campos de mesclagem. Por exemplo Nome = %contactLastName%
7. Na tela, clique na caixa de seleção Ocultar elementos condicionais para ocultar todos os elementos
condicionais no OmniScript. Os elementos condicionais são marcados com um ícone de olho amarelo.

company
Executando a validação com onChange
Os OmniScripts executam a validação quando um usuário clica fora de um campo usando a função onBlur.
1. Nas propriedades de configuração, clique em Editar como JSON .

2. Adicione a propriedade "commitOnChange": true .
3. Visualize o comportamento.
NOTA
Em LWC OmniScripts, o comportamento onChange é executado após um atraso de meio
segundo.
Veja também
• Ocultar elementos OmniScript
• Acesse o JSON de dados do OmniScript com campos de mesclagem
Ocultar elementos OmniScript

Oculte elementos e elementos filho usando a propriedade Ocultar disponível em Componentes de entrada do
OmniScript , Blocos , Etapas , Grupos, Fórmulas e Elementos agregados.
1. No painel de propriedades do elemento, clique em Editar como JSON .

2. Defina o valor da propriedade "hide" como "true" .
Veja também
• Criando formulários dinâmicos usando a propriedade de exibição condicional

• Preencher elementos OmniScript usando DataRaptor
Ocultar os botões Próximo e Anterior

Oculte os botões Próximo e Anterior de uma etapa ao usar opções de avanço automático ou quando não
quiser que o usuário navegue pelas etapas.
Para ocultar o botão Próximo ou Anterior de uma Etapa:
1. Nas propriedades da etapa, expanda a seção Propriedades do botão .

2. Arraste o controle deslizante de largura anterior ou seguinte para 0 .
3. Salve seu OmniScript e visualize o novo comportamento.
Exibir mensagens em OmniScripts

company
Exiba comentários, requisitos, sucesso e mensagens de aviso dependendo se a expressão de validação retorna
verdadeiro ou falso. Configure o elemento Messaging após Criar uma Fórmula ou Agregado em um OmniScript
, ou qualquer outro elemento, para exibir mensagens de validação no OmniScript. Campos de mesclagem são
suportados em mensagens.
Para adicionar um elemento Messaging a um OmniScript:
1. No OmniScript Designer, arraste um elemento Messaging para o painel de estrutura onde a mensagem
deve aparecer.
2. Para Validar Expressão, insira a expressão que deve ser validada. Você pode avaliar qualquer elemento ou
elementos, incluindo Fórmula e Agregado. Para obter mais informações sobre fórmulas, consulte Criar
campos de fórmula em um OmniScript . Para obter mais informações sobre como configurar expressões,
consulte Formulários dinâmicos usando a propriedade de exibição condicional .
3. Na seção Mensagens, selecione os tipos de mensagem para quando a expressão for avaliada como
verdadeira ou falsa e insira as mensagens. As mensagens True e False podem ser desativadas e as
mensagens são opcionais.
Em OmniScripts, a validação é executada quando um usuário clica fora de um campo usando a função onBlur.
Para permitir que o OmniScript execute a validação quando um usuário digitar:
1. Nas propriedades de configuração, clique em Editar como JSON .

2. Adicione a propriedade "commitOnChange": true .
3. Visualize o comportamento.
NOTA
Em LWC OmniScripts, o comportamento onChange é executado após um atraso de meio
segundo.
Exemplo de mensagem
Neste exemplo, uma mensagem de Requisito é exibida quando um usuário tem menos de dezoito anos:
• expressão de validação do elemento Messaging falha quando o campo Birthdate tem um valor e o
elemento AgeFormula é menor que dezoito:

company
• O elemento Formula usa a função AGE para retornar a idade do usuário com base na data inserida no
elemento Birthdate :
• A mensagem Requisito é exibida quando a validação falha:
Tipos de mensagem
As mensagens OmniScript usam estilo SLDS puro. Esta tabela fornece exemplos de mensagens OmniScript. As
mensagens permanecerão até que um usuário insira um valor válido.
Tipo de mensagem Exemplo de OmniScript Lightning Exemplo de OmniScript Newport
Sucesso
Requerimento

company
Aviso
Comente
Eventos do Fire Platform de OmniScripts

Dispare eventos da plataforma Salesforce a partir do contexto de um OmniScript.
1. Vá para Setup e, em Develop , clique em Platform Events .
2. Na página Eventos de Plataforma, clique em Novo Evento de Plataforma .
3. Na página Novo Evento de Plataforma, defina o evento de plataforma, especificando os campos para os
dados que você deseja associar ao evento.
4. Para disparar o evento, crie um DataRaptor Load que preencha os campos de evento da plataforma com
dados específicos do evento.
5. No OmniScript, componha o JSON de dados contendo os dados requeridos pelo DataRaptor Load.
6. Adicione uma ação DataRaptor Load ao OmniScript, especificando o DataRaptor que dispara o evento de
plataforma.
Para verificar se seu evento de plataforma foi acionado corretamente, use um dos métodos programáticos
descritos na documentação do desenvolvedor do Salesforce relacionada .
Definir erros em um OmniScript

Coloque mensagens de erro ou validação em um ou mais elementos em uma etapa anterior com base nas
condições de etapas futuras usando o elemento de ação Definir Erros. Usando campos obrigatórios e
elementos de Fórmula/Mensagens, você só pode definir requisitos e condições em elementos na etapa atual.
Por exemplo, em um aplicativo, um endereço de e-mail pode não ser necessário durante a etapa inicial de
registro e, em uma etapa futura, o usuário declara que deseja ser contatado por e-mail.
O elemento Set Errors é executado após a etapa e retorna o usuário à etapa inicial de registro com mensagens
de erro customizadas:

company
O elemento Definir erros:

company
1. No OmniScript, arraste o elemento “Definir Erros” para a tela.
2. Adicione uma condicional para controlar quando a mensagem Definir erros é exibida. Sem uma
condicional, o erro persistirá no OmniScript. Consulte Elementos de exibição condicional usando a
propriedade de exibição condicional .
3. No campo Nome do Elemento , insira o nome do seu elemento.
4. No campo Valor , insira a mensagem de erro exibida ao usuário.
NOTA
A ação Definir Erros não oferece suporte a estes elementos: Arquivo, Imagem, Mensagens e
Fórmula.
Implantar, iniciar e incorporar OmniScripts

Implante seu OmniScript e inicie-o em uma página da comunidade, página do Lightning, LWC personalizado ou
aplicativo fora da plataforma.

company
Gere o componente da Web Lightning do OmniScript implantando seu OmniScript. Adicione o LWC gerado a
páginas do Lightning, páginas da comunidade, aplicativos de terceiros e LWCs personalizados para iniciar seus
OmniScripts.
1. Implante seu OmniScript. Consulte Ativar e implantar OmniScripts .

2. Depois de implantar seu OmniScript, inicie seu OmniScript a partir de uma destas experiências:
Experiência Descrição Exemplo
Páginas da comunidade Inicie um OmniScript a partir de uma página da Comunidade usando o Adicionar um OmniScript a uma
LWC gerado pelo OmniScript ou o componente Vlocity LWC comunidade ou página do Lightning .
OmniScript Wrapper.
Incorporado dentro de um Inicie um OmniScript a partir de um componente Web do Lightning Incorporar um OmniScript Lightning
componente personalizado personalizado, incorporando o LWC do OmniScript. Componente da Web em uma Web do
Lightning
Componente
Fora da plataforma Execute OmniScripts fora da plataforma usando OmniOut. OmniOut
Páginas Lightning Inicie um OmniScript a partir de uma página do Lightning usando o Adicionar um OmniScript a uma
OmniScript Wrapper.
Ativar e implantar OmniScripts

Disponibilize OmniScripts para Comunidades, Páginas do Lightning, LWCs personalizados e guias do Lightning
ativando e implantando o OmniScript. Se ocorrer um erro durante a implantação, o OmniScript será
desativado.
1. No OmniScript, clique em Ativar para ativar o OmniScript e implantar o OmniScript automaticamente.

2. (Opcional) Clique em Desativar e em Ativar para reimplantar o OmniScript e aplicar as atualizações.
3. Depois de implantar seu OmniScript, inicie seu OmniScript a partir de uma destas experiências:
Páginas da comunidade Inicie um OmniScript a partir de uma página da Comunidade usando o Adicionar um OmniScript a uma
OmniScript Wrapper.
Incorporado dentro de um Inicie um OmniScript a partir de um componente Web do Lightning Incorporar um OmniScript Lightning
componente personalizado personalizado, incorporando o LWC do OmniScript. Componente da Web em uma Web do
Lightning
Componente
Fora da plataforma Execute OmniScripts fora da plataforma usando OmniOut. OmniOut
Páginas Lightning Inicie um OmniScript a partir de uma página do Lightning usando o Adicionar um OmniScript a uma
OmniScript Wrapper.
4. (Opcional) Se ocorrer um erro no carregamento inicial de um OmniScript, no OmniScript, clique em

Desativar e, em seguida, clique em Ativar . Isso reimplanta o OmniScript.
5. (Opcional) Mapeie os erros de implantação usando o Error Handling Framework. . Consulte Personalizar
mensagens de erro do OmniScript .
Exemplo de mapeamento de erros:
Erro original

company
Mensagem de erro ao mapear um caminho e valor para uma nova mensagem
Nova mensagem de erro
6. (Opcional) Clique na seta suspensa e clique em Baixar LWC para visualizar os metadados do OmniScript.
Qual é o próximo
Adicionar um OmniScript a uma comunidade ou página do Lightning
Veja também
• OmniOut
Como lançar
Uma vez ativado, habilite o acesso OmniScript de uma das três maneiras: autônomo, incorporado ou Vlocity
Aura Wrapper.
Estar sozinho
Uma vez ativado, o OmniScript é compilado e implantado como um componente Web do Lightning autônomo.
Acesse o LWC no Salesforce Lightning App Builder na seção Personalizado e arraste-o para a página.
Integrado
Uma vez ativado, você pode incorporar o componente em qualquer componente Aura ou LWC usando a tag de
componente. O atributo de componente "prefill" aceita string ou objeto javascript.

company
Exemplos
<c-type--sub-type-english prefill={prefill} layout="lightning"></c-type--subtype-english>
<c-type--sub-type-english prefill='\{"ContextId":"abc","otherParam":"FAQ"}' layout="newport"></c-type--

sub-type- inglês>
Vlocity Aura Wrapper

Uma vez ativado, o OmniScript pode ser acessado usando o componente Aura pré-construído do Vlocity.
Como os componentes da Web do Lightning ainda não são endereçáveis por URL, você pode usar esse método
para passar parâmetros adicionais para o OmniScript. Exemplo
this[NavigationMixin.Navigate]({ type:
'standard__component',
atributos: {
componentName: '__vlocityLWCOmniWrapper'
}, Estado: {
c__target: 'c:testSubTypeEnglish', c__layout: 'relâmpago', // ou
'newport'
c__tabIcon: 'custom:custom18'
}
})
Exemplo de URL do Lightning https://my_org.force.com/lightning/cmp/my_org__vlocityLWCOmniWrapper?

c__target=my_org:typeSubTypeEnglish&c__layout=lightning&c__tabIcon=custom:custom m18
Exemplo de URL de Newport
https://my_org.force.com/lightning/cmp/my_org__vlocityLWCOmniWrapper?
c__target=my_org:typeSubTypeEnglish&c__layout=newport&c__tabIcon=custom:custom1 8
Iniciar OmniScripts a partir do Lightning e das páginas da comunidade

Inicie OmniScripts em Comunidades e Páginas do Lightning usando o componente OmniScript gerado ou o
componente LWC OmniScript Wrapper.
Gerado OmniScript Lightning Web Component ou LWC OmniScript Wrapper?

Use esta tabela para determinar se o componente LWC OmniScript Wrapper ou um componente OmniScript
gerado atende aos seus requisitos.
Tipo de componente Capacidades Referência
OmniScript gerado • Passa automaticamente o RecordId da página para o Data JSON do Adicionar um
OmniScript no nó ContextId OmniScript
• Exibe um layout, Lightning ou Newport para um
• Não diretamente endereçável por URL Comunidade
• URL endereçável por meio da página da comunidade ou URL da ou
LightningPage Relâmpago
Página
• Não é possível aceitar parâmetros, pois não é diretamente endereçável
por URL

company
Vlocity LWC OmniScript Wrapper • Aceita parâmetros de URL adicionais Iniciar um
• Carrega em diferentes OmniScripts com base em parâmetros OmniScript
• Aceita informações de pré-preenchimento com LWC
• Compatível com a funcionalidade de pré-preenchimento LWC Save For OmniScript
Later Embrulho
Adicionar um OmniScript a uma comunidade ou página do Lightning

Adicione um OmniScript a uma página da Comunidade ou do Lightning adicionando o componente da Web do
Lightning gerado pelo OmniScript. O componente é gerado quando você ativa o OmniScript.
1. Implante um OmniScript para disponibilizá-lo em Community e Lightning App Builders. Para obter mais informações, consulte Ativar e implantar
OmniScripts .
2. Revise as opções para iniciar um OmniScript a partir de uma página do Lightning ou da comunidade. Consulte Iniciar OmniScripts a partir de
páginas do Lightning e da comunidade .
Adicione seu OmniScript a uma página da comunidade

Adicione seu OmniScript a uma página da Comunidade do Salesforce.
1. Em um Community Builder, clique na guia Componentes .
2. Procure o nome de seu OmniScript digitando o Tipo, Subtipo e Idioma exclusivos do OmniScript. Use a
sintaxe Tipo/Subtipo/Idioma para pesquisar, pois a pesquisa não ignora barras.
3. Arraste o componente para a página Comunidade.

4. (Opcional) Aplique o estilo Newport inserindo newport no campo de layout no painel de propriedades do
componente. O estilo do Lightning é o estilo padrão quando a propriedade de layout está em branco.

company
5. (Opcional) Configure as opções embutidas. Consulte Exibir OmniScripts Inline em páginas do Lightning e
da comunidade .
6. (Opcional) Controle como os idiomas da direita para a esquerda são exibidos. OmniScript fornece suporte
beta para idiomas da direita para a esquerda. No campo dir , selecione se o OmniScript exibe ltr ou rtl ..
7. (Opcional) Altere a visualização do dispositivo no Community Builder para telefone ou tablet para ver
como o OmniScript é exibido em um dispositivo móvel ou tablet.
Adicione seu OmniScript a uma página do Lightning

Adicione seu OmniScript a uma página do Salesforce Lightning.
1. No App Builder de uma página do Lightning, pesquise o nome do seu OmniScript inserindo o Tipo, o
subtipo e o idioma exclusivos do OmniScript. Use a sintaxe Tipo/Subtipo/Idioma para pesquisar, pois a
pesquisa não ignora barras.

company
2. Arraste o componente para a página do Lightning.
3. (Opcional) Aplique o estilo Newport inserindo newport no campo de layout no painel de propriedades do
componente. O estilo do Lightning é o estilo padrão quando a propriedade de layout está em branco.

company
4. (Opcional) Configure as opções embutidas. Consulte Exibir OmniScripts Inline em páginas do Lightning e
da comunidade .
5. (Opcional) Controle como os idiomas da direita para a esquerda são exibidos. OmniScript fornece suporte
beta para idiomas da direita para a esquerda. No campo dir , selecione se o OmniScript exibe ltr ou rtl .
6. (Opcional) Modifique a visibilidade do componente adicionando filtros. Para obter mais informações,
consulte Páginas dinâmicas .
7. (Opcional) Altere a visualização do dispositivo do App Builder para Telefone para ver como o OmniScript é
exibido em um dispositivo móvel.

company
Veja também
• Ativar e implantar OmniScripts

Iniciar um OmniScript com LWC OmniScript Wrapper

Inicie os Omniscripts nas páginas da Comunidade e do Lightning usando o componente Vlocity LWC OmniScript
Wrapper.
O componente wrapper torna o URL do OmniScript endereçável para permitir a passagem de parâmetros
adicionais para o OmniScript. O componente Vlocity LWC OmniScript Wrapper e o vlocityLWCOmniWrapper
são componentes do Aura que encapsulam um OmniScript para tornar o URL do OmniScript endereçável.
NOTA
Se o componente LWC OmniScript Wrapper existir em uma página de registro, a ID do registro passará
para o OmniScript como a ID do contexto automaticamente.
1. Implante um OmniScript para disponibilizá-lo em Community e Lightning App Builders. Para obter mais informações, consulte Ativar e implantar
OmniScripts .
2. Revise as opções para iniciar um OmniScript a partir de uma página do Lightning ou da comunidade. Consulte Iniciar OmniScripts a partir de
páginas do Lightning e da comunidade .
Iniciar OmniScripts em Comunidades a partir de URLs

Inicie qualquer OmniScript em uma página da comunidade enviando uma URL para o componente Vlocity LWC
OmniScript Wrapper na página.
Para adicionar o componente Vlocity LWC OmniScript Wrapper a uma página da comunidade:
1. Em uma página do Community Builder, clique na guia Componentes .
2. Procure o componente Vlocity LWC OmniScript Wrapper e arraste-o para a página.

3. Deixe os campos no componente em branco.

company
4. (Opcional) Para testar um OmniScript usando o LWC OmniScript Wrapper no Community Builder:
1. No LWC OmniScript Wrapper, marque a caixa de seleção Stand Alone Mode .
2. No campo Nome do OmniScript, insira o nome do componente do OmniScript com o prefixo c: . O
nome do componente do OmniScript é uma combinação do Tipo, Subtipo e Idioma do seu
OmniScript sem espaços.
c:customTestInglês
Para configurar a URL para acessar o componente Vlocity LWC OmniScript Wrapper:
1. Configure o URL da página da Comunidade em um campo de URL, como um URL em um Card Action ou
editor de texto.
URL de exemplo para uma comunidade chamada AccountCommunity que tem uma página chamada
AccountPage:

company
https://exampleURL.force.com/AccountCommunity/s/AccountPage?
2. Em seu OmniScript, clique no botão Como iniciar o script ativado .
3. No modal How to Launch, clique na guia LWC .
4. Na seção Vlocity Aura Wrapper da guia LWC, copie o texto que aparece após o ponto de interrogação.
https://exampleURL.na130.visual.force.com/lightning/cmp/ namespace__vlocityLWCOmniWrapper?
c__target=namespace:myLWCTestEnglish&c__layout=relâmpago
• O parâmetro c__target é definido para um componente indicado por c: . O componente é o Nome do

seu OmniScript combinado com o Tipo, Subtipo e Idioma. Esse componente passa para o campo Nome
do LWC OmniScript do Vlocity LWC OmniScript Wrapper.
• O parâmetro c__layout passa o layout para o campo Layout do Vlocity LWC OmniScript Wrapper.
5. No parâmetro c__target da URL, substitua o namespace por c .
c__target=c:myLWCTestEnglish&c__layout=relâmpago
6. Cole o texto copiado no final do URL da página da comunidade.
7. (Opcional) Passe parâmetros adicionais separando-os com um e comercial, & . Os parâmetros devem usar
o prefixo c__ . Por exemplo, para passar "AccountName": "Acme" no JSON de dados do OmniScript, a
sintaxe deve ser &c__AccountName=Acme .
8. (Opcional) Dispare eventos da ação Navigate passando um evento para o OmniScript no parâmetro de
URL c__vlocEvents . O elemento Navigate Action deve ter a propriedade checkbox LWC PubSub
Message? habilitado para disparar o evento.
Iniciando um OmniScript no Lightning

Para tornar um URL OmniScript endereçável usando o vlocityLWCOmniWrapper:
1. Em seu LWC OmniScript, clique no botão How to Launch Activated Script .

2. No modal How to Launch, clique na guia LWC .
3. Na seção Vlocity Aura Wrapper da guia LWC, copie o caminho relativo da URL.
https://exampleURL.na130.visual.force.com/lightning/cmp/ namespace__vlocityLWCOmniWrapper?
c__target=namespace:myLWCTestEnglish&c__layout=relâmpago
4. (Opcional) Inicie o OmniScript usando um layout Newport clicando em Newport e copiando o caminho
relativo.
5. (Opcional) Ao usar o caminho de URL em uma organização de produção, você deve substituir o
namespace do seu componente. No parâmetro c__target da URL, substitua o namespace por c .
6. (Opcional) Preencha um OmniScript atribuindo valores de pré-preenchimento com o prefixo &c__
colocado antes da chave. Por exemplo, para passar "AccountName": "Acme" em um JSON de dados do
OmniScript, adicione o parâmetro usando a sintaxe &c__AccountName=Acme . Para obter mais
informações sobre o preenchimento prévio de dados, consulte Carregar dados em elementos OmniScript
.
Lightning/cmp/NS__vlocityLWCOmniWrapper?
c__target=c:myTypeExampleEnglish&c__AccountName=Acme

company
7. (Opcional) Ao usar o wrapper em um aplicativo de console, adicione um ícone da guia do console e um
rótulo da guia do console definindo os parâmetros c__tabIcon e c__tabLabel . O c__tabIcon aceita um
ícone SLDS e c__tabLabel aceita texto simples. Por exemplo, &c__tabLabel=Personalizado
Label&c__tabIcon=standard:account renderiza a guia do console mostrada nesta imagem de exemplo.
8. (Opcional) Para visualizar parâmetros adicionais para o vlocityLWCOmniWrapper, consulte Iniciar URLs de
componentes da Web do Lightning com vlocityLWCWrapper .
9. (Opcional) Dispare eventos da ação Navigate passando um evento para o OmniScript no parâmetro de
URL c__vlocEvents . O elemento Navigate Action deve ter a propriedade checkbox LWC PubSub
Message? habilitado para disparar o evento.
10. Cole a URL onde você planeja invocar o OmniScript e visualize a funcionalidade.
Iniciando um OmniScript a partir de uma ação de layout

Para iniciar o OmniScript a partir de uma ação de layout:
1. Em Configuração , insira Gerenciador de objetos na pesquisa Busca rápida .

2. Selecione um Objeto e clique em Botões, Links e Ações .
3. Clique em Novo botão ou link .
4. Definir Tipo de Exibição para Página de Detalhes .
5. Defina a Origem do conteúdo como URL .
6. Configure o valor da URL para igualar o caminho relativo do vlocityLWCOmniWrapper. Para obter
informações sobre como obter o caminho relativo, consulte Iniciar um OmniScript no Lightning .
namespace__vlocityLWCOmniWrapper? c__target=c:myLWCTestEnglish&c__layout=relâmpago
Exibir OmniScripts Inline em páginas do Lightning e da comunidade

Habilite os OmniScripts para serem executados em linha sem sair do contexto de uma página.
Um OmniScript embutido é renderizado como um botão que, quando clicado, inicia o OmniScript embutido. O
ID de registro de uma página passa para um OmniScript embutido como um ID de contexto automaticamente.
Você pode renderizar mais de um OmniScript embutido em uma página.
Certifique-se de que seu OmniScript esteja ativo. Para obter mais

informações, consulte Ativar e implantar OmniScripts .

company
NOTA
A execução de OmniScripts no modo inline desativa o SEO
Enabled e Save For Later.
1. Na Comunidade ou no App Builder, adicione um OmniScript ativado a uma página. Para obter
informações sobre como adicionar OmniScripts a uma página do Lightning, consulte Adicionar um
OmniScript a uma comunidade ou página do Lightning .
2. No componente OmniScript, marque a caixa de seleção embutida .
3. No campo inlineLabel , insira o texto a ser exibido no botão.

4. (Opcional) Escolha um inlineVariant para alterar a aparência do botão.
5. (Opcional) Habilite o disparo de eventos habilitando as opções de cancelamento. Consulte Configurar
opções de cancelamento do OmniScript .
6. Clique em Salvar e visualize o OmniScript.
Veja também

Execute OmniScripts fora da plataforma com OmniOut

Implante e hospede OmniScripts em sites de terceiros adicionando OmniOut ao seu aplicativo.
O OmniOut permite que os OmniScripts criem, leiam, atualizem e excluam dados do Salesforce de um
site de terceiros.

company
Qual é o próximo
Configure OmniOut. Consulte OmniOut .
Implantar um OmniScript em um site externo do Salesforce

Depois de criar uma nova página do Visualforce OmniScript, você pode implantar em um site externo do
Salesforce. Uma vez incorporado na página, o script pode ser versionado, modificado e ativado sem a
necessidade de reconfigurar a página.
1. Em Configuração, clique em Desenvolver e, em seguida, clique em Sites e, em seguida, clique em Novo .

2. Insira valores para Rótulo do Site , Nome do Site e outros campos.
3. No campo Página inicial do site ativo , pesquise e selecione a página do Visualforce OmniScript criada
acima.
4. Registre o URL do site para referência futura.
5. Clique em Configurações de acesso público e, em seguida, clique em Editar e defina os seguintes valores:
• Permissões de objetos personalizados
• Vlocity OmniScripts : Leia
• Elementos : Leia
• Aplicações : Ler , Criar
• Segurança em nível de campo
• Vlocity OmniScript : Tornar todos os campos visíveis
• Elemento : Tornar todos os campos visíveis
• Aplicação : Tornar todos os campos visíveis
• Acesso de classe do Apex ativado
• [NameSpace] .ApplicationResource
6. Incorpore a URL da Etapa 4 no iFrame do site externo.
Incorporar um componente Web OmniScript Lightning em um componente Web

Lightning
Incorpore um OmniScript LWC em um componente da Web do Lightning copiando a tag do componente
OmniScript e adicionando-a diretamente em um componente.
NOTA
Ao passar dados de um LWC para uma propriedade de pré-preenchimento do LWC OmniScript
incorporado, os valores de string "true" e "false" serão convertidos em valores booleanos. Para
evitar esse problema, restrinja seus valores adicionando aspas adicionais com escape por barras
invertidas. Por exemplo, para converter este objeto de preenchimento prefill = { "Multi-
select1":"true"} a nova sintaxe deve ser prefill = { "Multi-select1":"\"true\""} .
Incorporar o componente
Copie a tag do componente OmniScript e incorpore-a em um componente.
1. No OmniScript Designer, clique no menu suspenso, clique em Como iniciar e copie a tag do componente.

company
2. No arquivo HTML do seu componente, insira a tag do componente para incorporar o componente
OmniScript.
<modelo>
<c-doc-example-english layout="lightning"></c-doc-example-english>
</template>
Detectar atualizações de dados JSON em um OmniScript incorporado

Detecte alterações no JSON de dados de um OmniScript incorporado usando o evento omniaggregate .
1. Adicione um ouvinte de eventos que aceite o evento omniaggregate como um argumento.
this.template.addEventListener( 'omniaggregate');
2. Crie uma função separada que lide com a resposta do evento e atribua o valor a uma variável.
omniUpdateHandler(evento) { if(evento.detalhe) {
this.omniDataJSON = event.detail; // faça algo com os
dados JSON
}
3. Adicione a função que trata a resposta como um argumento ao ouvinte de eventos para que ele seja
acionado sempre que o JSON de dados do OmniScript for atualizado.
this.template.addEventListener( 'omniaggregate', this.omniUpdateHandler.bind(this));
Incorporar um OmniScript em outro OmniScript

Um OmniScript pode ser reutilizado em um ou mais OmniScripts existentes. A reutilização de OmniScripts
permite que você crie uma variedade de scripts menores e, em seguida, junte -os em um ou mais scripts pai. Os
OmniScripts incorporados se comportam exatamente como outros elementos OmniScript.

company
NOTA
Um OmniScript reutilizável não pode conter outro OmniScript reutilizável. Além disso, nenhum
elemento em um OmniScript reutilizável pode ter o mesmo nome de um elemento no script pai. Os
OmniScripts reutilizáveis adotam a configuração de script do script pai.
1. No OmniScript que deseja reutilizar, clique em Configurar e marque a caixa de seleção Reutilizável .
2. Ative o OmniScript reutilizável.
3. Navegue até o OmniScript que hospedará o OmniScript reutilizável.
4. No painel Build do OmniScript, expanda a seção OmniScripts .
5. Localize o OmniScript reutilizável e arraste-o para a tela.
6. Visualize seu OmniScript para testar o comportamento.
Qual é o próximo
Ativar e desativar OmniScripts incorporados
Veja também
• Incorporar FlexCards em um OmniScript
Ativar e desativar OmniScripts incorporados

Quando você ativa ou desativa um script incorporado, o Vlocity atualiza todos os scripts pai ativados para
refletir a alteração.
Saiba como incorporar um OmniScript em outros OmniScripts. Consulte Incorporar um OmniScript em outro OmniScript
.
1. Na seção Configuração do script incorporado, clique em Ativar versão ou Desativar versão .
2. Verifique os OmniScripts afetados (qualquer OmniScript ativo no qual este formulário esteja incorporado)
e clique em Continuar .
3. Após a atualização dos scripts pai, clique em Concluído .
Veja também
• Incorporar FlexCards em um OmniScript
Adicionando um verificador de permissões de classe do Apex

Habilite o acesso específico a APIs de ação remota (classes Vlocity Open Interface Apex) por usuário ou
perfil. Configure um verificador de permissões de classe do Apex para exigir que o usuário tenha acesso

company
explícito à classe do Apex que administra a ação remota chamada de um Omniscript, FlexCard, Classic Card ou
API REST.
Por exemplo, após a criação de um site Force.com, as APIs publicamente disponíveis são habilitadas para o
perfil de usuário do site com base no acesso de classe Apex do perfil às classes RestResource Apex. Adicionar
um verificador de permissões de classe do Apex garante que usuários não autorizados, como um usuário
convidado , não possam acessar classes por meio da API Vlocity/V1/GenericInvoke/ .
1. Na sua organização, vá para Configuração .

2. Digite Configurações personalizadas na caixa de pesquisa Busca rápida e clique em Configurações
personalizadas .
3. Na página Configurações personalizadas, clique na configuração personalizada denominada
Configurações gerais .
4. Na página Configurações gerais, clique em Gerenciar .
5. Clique em Novo .
6. Insira ApexClassCheck no campo Nome .

7. Digite true na caixa Valor .
8. Clique em Salvar para concluir o processo.
Criar OmniScripts em vários idiomas

Habilite um único OmniScript para ser executado em vários idiomas usando rótulos personalizados do
Salesforce.
Os OmniScripts multilíngue fornecem suporte beta para idiomas da direita para a esquerda. Ao usar linguagens
RTL, alguns estilos podem resultar em limitações funcionais.
NOTA
Devido a um problema conhecido do Salesforce, os OmniScripts em vários idiomas não são exibidos
corretamente no Community Builder.

company
1. Habilite o suporte multilíngue para OmniScripts. Consulte Ativar suporte multilíngue OmniScript
2. Defina rótulos personalizados e traduções. Consulte Definir traduções de etiquetas personalizadas em
OmniScripts multilíngue .
3. Teste suas traduções OmniScript. Consulte Testar um OmniScript multilíngue .
4. Inicie o OmniScript multilíngue. Consulte Iniciar um OmniScript multilíngue .
5. Implante OmniScripts multilíngue em outras organizações usando DataPacks. Os DataPacks não incluem
rótulos personalizados. Você deve implantar rótulos personalizados manualmente de sua organização.
Veja também
• Acessar rótulos personalizados em um componente Web do Lightning personalizado do OmniScript
• Referência de rótulo personalizado OmniScript
Ativar suporte multilíngue OmniScript

Habilite o suporte OmniScript multilíngue modificando o objeto Vlocity OmniScript na Configuração do
Salesforce.
Veja as etapas necessárias para criar um OmniScript multilíngue. Consulte Criar OmniScripts
em vários idiomas .
NOTA
Começando com o Vlocity Insurance and Health Summer '20, o LWC
OmniScript Designer oferece suporte a OmniScripts em vários idiomas.
Para habilitar o suporte multilíngue para OmniScripts:

1. Configuração do Salesforce , em Criar , escolha Objetos .
2. Clique no link do objeto Vlocity OmniScript . A definição do objeto personalizado é exibida.
3. Na seção Campos e relacionamentos personalizados , edite a lista de opções Idioma e adicione
MultiLanguage à lista de valores. Clique em Salvar .
4. Em seu OmniScript, clique em Editar e defina Idioma para Vários idiomas .
Qual é o próximo
Definir traduções de etiquetas personalizadas em OmniScripts multilíngue
Veja também
• Referência de rótulo personalizado OmniScript
Definir traduções de etiquetas personalizadas em OmniScripts multilíngue

Defina traduções para rótulos personalizados em OmniScripts multilíngue usando o modal de tradução
do OmniScript.

company
O OmniScript fornece rótulos personalizados padrão que exigem traduções além dos rótulos personalizados do
Salesforce.
Ative OmniScripts multilíngue. Consulte Ativar suporte a OmniScript multilíngue .
1. Na seção de configuração de script de um OmniScript, defina Language como Multi-Language .

2. Ao lado do campo Idioma , clique em Editar .
3. No modal Edit Your OmniScript Translations , clique no ícone de engrenagem Configurações e selecione
um idioma.
4. Escolha um rótulo personalizado ou crie um novo rótulo personalizado. Para obter informações sobre
como criar rótulos personalizados no Salesforce, consulte Criação e edição de rótulos personalizados .
NOTA
Use convenções de nomenclatura ao criar rótulos personalizados em uma organização com
vários desenvolvedores para evitar duplicações e melhorar as consultas. Sintaxe de exemplo:
jSmithCustomTextLabel .
5. No campo Valor do rótulo personalizado , insira uma tradução.

company
NOTA
• Os rótulos personalizados devem ter valores. Se o valor de um rótulo personalizado
não existir, a seguinte mensagem de erro será exibida ao visualizar um OmniScript: Erro: O
campo $Label.<stepName> não existe. Verificar Ortografia
• Para elementos que suportam rich text (blocos de texto, instruções de etapas e rótulos de
título), você pode incluir marcação HTML no texto e nas traduções.
7. Repita o processo de tradução para cada idioma que requer traduções.
Qual é o próximo
Visualize as traduções obrigatórias de etiquetas personalizadas do OmniScript e aplique as traduções para
cada etiqueta. Consulte Referência de rótulo personalizado do OmniScript .
Veja também
• Traduzir rótulos personalizados para componentes de data e hora
Acessar rótulos personalizados em um componente Web do Lightning personalizado

do OmniScript
Forneça acesso de componentes Web do Lightning personalizados a rótulos personalizados do Salesforce em
seu OmniScript.
Os componentes da Web do Lightning personalizados que estendem o componente OmniScript Base Mixin ou
o componente da Web do Lightning de um elemento do OmniScript podem acessar rótulos personalizados d o
OmniScript e rótulos personalizados do Salesforce. Para obter informações sobre LWCs personalizados no
OmniScript, consulte Criar um componente Web do Lightning personalizado para OmniScript .
Visualize os rótulos personalizados padrão do OmniScript ou crie rótulos personalizados no Salesforce. Consulte Referência de rótulo personalizado do
OmniScript e Criar e editar rótulos personalizados .
1. Na configuração de script do OmniScript, clique em Editar como JSON .

2. No JSON, adicione o nó "moreCustomLabels": e defina o valor do nó igual a uma matriz dos rótulos
personalizados que não existem no SO.
"moreCustomLabels" : ["myCustomLabel1","orgCustomLabel2"]

company
3. No código do seu LWC personalizado, adicione uma linha de código para acessar um mapa de todos os
rótulos personalizados usando o atributo allCustomLabels . Cada tipo de componente requer um nome
de atributo diferente para acessar o atributo allCustomLabels.
Tipo de componente Sintaxe
Componente que estende o componente OmniScript Base Mixin this.omniScriptHeaderDef.allCustomL abels
Componente que estende o LWC de um elemento OmniScript this.scriptHeaderDef.allCustomLabels
4. Usando a notação de ponto, anexe o nome do atributo que o LWC personalizado requer para acessar o
rótulo.
Tipo de componente Sintaxe
Componente que estende o componente OmniScript Base this.omniScriptHeaderDef.allCustomL abels.myCusto mL abel

Mixin
Componente que estende um elemento OmniScript this.scriptHeaderDef.allCustomLabels.myCustomL abel

LWC
5. Implante os componentes personalizados do Lightning em uma organização do Salesforce. Consulte

Implantar componentes da Web do Lightning .
6. Ative e visualize o OmniScript para garantir que o rótulo seja exibido corretamente.
Veja também
• Definir traduções de etiquetas personalizadas em OmniScripts multilíngue
Traduzir texto de ajuda da dica de ferramenta em OmniScripts

Exiba o texto de ajuda da dica de ferramenta com várias traduções em OmniScripts multilíngue.
Você deve usar rótulos personalizados para adicionar texto de ajuda em OmniScripts multilíngue. Se um rótulo
personalizado não for definido para uma dica de ferramenta de texto de ajuda, um erro será renderizado.
Defina rótulos personalizados para seu texto de ajuda. Consulte Definir traduções de etiquetas personalizadas em
1. Em seu OmniScript, selecione um elemento que requer tradução de texto de ajuda.
2. Nas propriedades do elemento, clique em Opções de Ajuda .
3. Marque Ativar texto de ajuda .
4. No campo Texto de ajuda , insira o rótulo personalizado.
5. Visualize o OmniScript para renderizar os rótulos personalizados.

company
NOTA
Os rótulos personalizados não são renderizados no modo de design. Você deve visualizar o
OmniScript para renderizar os rótulos personalizados corretamente.
Veja também
• Testar um OmniScript multilíngue
Traduzir rótulos personalizados para componentes de data e hora

Defina traduções de rótulos personalizados para componentes de data e hora usando strings JSON e rótulos
personalizados OmniScript.
Saiba como traduzir rótulos personalizados no Salesforce. Consulte Traduzindo etiquetas

personalizadas .
1. Acesse Day.js , clique em Lista de localidades com suporte e escolha um arquivo de idioma.
2. No arquivo JavaScript do idioma, copie o objeto locale.
3. Abra um console de janela ou editor de JavaScript e cole no objeto de localidade.

company
4. Execute o JavaScript e execute JSON.stringify(locale) no console.
NOTA
Os rótulos personalizados aceitam apenas strings JSON válidas.
5. Copie a string JSON resultante.
6. Escolha um rótulo personalizado que atenda aos seus requisitos e abra-o no Salesforce.

company
Etiqueta personalizada Descrição
cmpDayJsLocaleFormats Aplica traduções para componentes de data Vlocity LWC e elementos de data OmniScript. o
O rótulo cmpDayJsLocaleFormats não aplica traduções ao OmniScript se o rótulo
OmniDayJSLocaleFormats tiver traduções definidas.
OmniDayJsLocaleFormats Aplica traduções apenas para elementos de data e hora do OmniScript. Substitui o rótulo
cmpDayJsLocaleFormats no OmniScript se ambos os rótulos personalizados tiverem traduções defin idas.
7. No rótulo personalizado, clique em Novo para adicionar uma nova tradução.

8. No campo Tradução , cole o JSON e remova as citações que cercam o objeto.
9. (Opcional) Use o JSON como exemplo e crie traduções personalizadas em um formato de string JSON.
10. Salve o rótulo personalizado e visualize seu componente.
Veja também
• Estender os componentes da Web do Vlocity Lightning
Criar elementos de seleção em vários idiomas

Para preencher os elementos Select, Multi-select e Radio para um OmniScript multilíngue, você tem as
seguintes opções:
• Configurar opções manualmente : no Salesforce, defina um conjunto de rótulos personalizados e configure

as traduções para eles. No OmniScript Designer, use os rótulos personalizados para especificar as opções
para os elementos Selecionar.
• Use uma lista de opções traduzida do Salesforce : no Salesforce, crie uma lista de opções e use o
Translation Workbench para definir as traduções para ela. No OmniScript Designer, defina um elemento
Select vinculado à lista de opções do Salesforce.
• Usar Apex : crie um método Apex que retorne um conjunto de opções que são traduzidas de acordo com o
código de idioma em vigor quando o método é chamado.
As seções a seguir descrevem essas abordagens em detalhes, usando o elemento Select. Use a mesma
abordagem para criar elementos de rádio e seleção múltipla em vários idiomas.
Configurar opções manualmente

Para compor manualmente um elemento Select multilíngue:

company
1. No SalesForce, defina um conjunto de rótulos personalizados e especifique as traduções para cada um.
2. No designer do OmniScript, adicione um elemento Select configurado da seguinte forma:
• Fonte da opção : Manual

• Opções :
• Valor: O valor a ser gravado no JSON de dados se esta opção for selecionada
• Rótulo: o nome do rótulo personalizado do Salesforce a partir do qual o texto da opção é lido.
Por exemplo, para uma lista de animais, você pode definir três rótulos personalizados com traduções no
Salesforce:
Etiqueta Valor padrão Tradução para o
personalizada espanhol
Animal_Urso Urso Oso
Animal_Cão Cão Perro
Animal_Gato Gato Gato
No OmniScript Designer, especifique as opções para o elemento Select, por exemplo:

Valor Etiqueta
1 Animal_Urso
2 Animal_Cão
Valor Etiqueta
3 Animal_Gato
Preencher as opções programaticamente

Para preencher as opções de um elemento Select usando o Apex:
1. Crie uma classe e um método que retorne um mapa de opções traduzidas de acordo com o código de
idioma em vigor quando o método for chamado. Veja o código de exemplo abaixo.
2. Adicione um elemento Select ao seu OmniScript, configurado da seguinte forma:
• Fonte da opção : Personalizado

• Source : A classe e o método que retornam opções

company
NOTA
Para elementos Select dependentes que são preenchidos programaticamente (personalizados),
configure um campo de controle especificando o nome de um elemento OmniScript que contém o
valor que determina as opções no elemento Select dependente. (Por exemplo, uma lista de cidades
pode depender de um estado especificado em outro elemento.) Para o elemento dependente,
especifique suas configurações de CONTROLLING FIELD da seguinte forma:
• Fonte da opção : Personalizado

• Fonte : Omitir
• Elemento : O elemento OmniScript que contém o valor que determina como esse elemento
dependente é preenchido.
O método do Apex que retorna os valores que preenchem o elemento Select deve conter uma
lógica que use o valor do elemento de controle e o código de idioma para determinar quais valores
retornar para preencher o elemento dependente.
Método de exemplo
classe global PicklistPopulation implementa VlocityOpenInterface { public

Boolean invokeMethod(String methodName, Map<String, Object> input, Map<String,
Opções de objeto> outMap, Map<String, Object>) { try { if
(methodName.equals('PopulatePicklist')) { PopulatePicklist(input, outMap, options); } else if
(methodName.equals('PopulateDependentPicklist'))
{ PopulateDependentPicklist(input, outMap, options); } } catch (Exceção e)
{ System.debug(LoggingLevel.ERROR, 'Exception: ' + e.getMessage() + ' ' +
e.getStackTraceString()); } return verdadeiro; } // Obter todos os contatos associados
a conta ContextId onde o Omniscript é lançado public void
PopulatePicklist(Map<String, Object> input, Map<String, Object> outMap, Map<String, Object> options) {
List<Map<String,String>> plOptions = new
List<Mapa<String, String>>(); String lang = (String)input.get('LanguageCode'); for(Integer i=0; i<2; i++) {
Map<String, String> tempMap = new Map<String,
Cadeia>(); tempMap.put('nome', 'teste'+ String.valueOf(i)); // Linguagem
Independente tempMap.put('value', 'testV'+ String.valueOf(i)); // Exibido em
IU da lista de opções if(lang == 'zh_CN') tempMap.put('value', 'testV' +
String.valueOf(i) + '中中'); plOptions.add(tempMap); }
outMap.put('options',plOptions); } // Preencher uma lista de opções dependentes com base no campo
ReportsToId de contatos selecionado no outro campo deste campo depende
em public void PopulateDependentPicklist(Map<String, Object> input,
Map<String, Object> outMap, Map<String, Object> options) { // Mapa da lista onde a chave é os valores
potenciais na outra lista de opções Map<String, List<Map<String, String>>> dependency = new
Mapa<String, Lista<Mapa<String,
Cadeia>>>(); String lang = (String)input.get('LanguageCode'); String elementName =
(String)input.get('controllingElement'); // em si
Logger.debug('hello1 ' + lang); Logger.debug('hello2 ' + elementName);
List<String> controlValList = new List<String>();
controlValList.add('Licenciamento e Permissão'); controlValList.add('Contrato'); for(Integer i=0; i<2; i++) {
List<Map<String, String>> optionList = new
List<Mapa<String, String>>(); for(Integer j=0; j<2; j++) { Map<String, String> tempMap = new Map<String,
String>(); tempMap.put('nome', controlValList[i] + 'Filho' + String.valueOf(j)); // Independente de

company
idioma tempMap.put('value', controlValList[i] + 'ChildV' + String.valueOf(j)); // Exibido na IU da lista de
opções if(lang == 'zh_CN') tempMap.put('value', controlValList[i] + 'ChildV' +
String.valueOf(j) + '中中' ); optionList.add(tempMap); } dependency.put(controlValList[i], optionList); }
outMap.put('dependency',dependency); } }
Use uma lista de opções traduzida do SalesForce

No OmniScript Designer, adicione um elemento Select e configure-o da seguinte forma:
• Fonte de opções : sObject

• Fonte : <sObjectName>.<fieldName>
Por exemplo, se você definir um objeto personalizado chamado "Multi_Language_Picklist" e definir um

campo de lista de opções chamado "Animal_Type", especifique a origem da seguinte forma:
Multi_Language_Picklist__c.Animal_Type__c
Para traduzir as opções da lista de opções no Salesforce:
1. Em Configuração, em Configuração de administração, selecione Translation Workbench .

2. Na tela Traduzir , escolha o idioma de destino.
3. Na lista Componente de configuração , escolha Valor da lista de opções .
4. Na lista Objeto , escolha o objeto em que o campo da lista de opções está definido. A lista de opções e
seus valores são exibidos como uma árvore.
5. Para cada opção. especifique o valor traduzido e salve suas alterações.
Testar um OmniScript multilíngue

Visualize traduções personalizadas usando a visualização do OmniScript Designer.
Habilite OmniScripts em vários idiomas e defina traduções de rótulos personalizados. Consulte Definir traduções de etiquetas personalizadas em
Para testar seu OmniScript multilíngue do OmniScript Designer:
1. Clique em Visualizar . Se o OmniScript contiver componentes Web do Lightning personalizados, ative o

OmniScript antes de visualizar.
2. Na visualização, selecione um idioma.
3. Visualize as traduções de rótulos personalizados para cada elemento OmniScript para garantir que sejam
exibidos corretamente.
4. Repita o processo de teste para cada idioma traduzido.
Qual é o próximo
Iniciar um OmniScript multilíngue
Veja também

company
• Implantar, iniciar e incorporar OmniScripts
Iniciar um OmniScript multilíngue

Defina o idioma em que um OmniScript multilíngue renderiza usando um parâmetro de código de idioma em
um URL.
Defina traduções para rótulos personalizados e ative o OmniScript multilíngue. Consulte Ativar suporte a OmniScript multilíngue .
1. No OmniScript, clique em Como iniciar o script ativado . O modal COMO LANÇAR é exibido.
2. Copie o URL que você deseja usar para iniciar seu script. Para obter informações sobre URLs de
OmniScript, consulte Iniciar um OmniScript com LWC OmniScript Wrapper .
3. Determine qual código de idioma usar no Salesforce. Ver Idiomas Suportados
4. Edite o URL para adicionar o parâmetro c__LanguageCode e defina o parâmetro igual ao código de
idioma do Salesforce.
c__target=c:docLWCTestEnglish&c__layout=lightning&c__LanguageCode=es
NOTA
Retome os OmniScripts salvos em outros idiomas usando um parâmetro de código de idioma
diferente.
Veja também
• Testar um OmniScript multilíngue
Referência de rótulo personalizado OmniScript

Esta página contém tabelas que listam as propriedades do elemento OmniScript para as quais você deve
definir rótulos personalizados e traduções para OmniScripts multilíngue. Para usar uma tradução padrão,
limpe a propriedade.
NOTA
Se você estiver convertendo um OmniScript de um para vários idiomas, especifique nomes de
rótulos personalizados válidos ou limpe todas as propriedades traduzíveis. Se houver texto literal na
propriedade e nenhum rótulo personalizado existir, um erro de rótulo ausente será exibido quando
você tentar visualizar o script.
Traduções necessárias para OmniScripts

Elemento Propriedades
Todos os elementos etiqueta
Ação de cálculo errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel,

inProgressMessage
Caixa de seleção checkLabel

company
Ação de extração do DataRaptor errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel,
inProgressMessage
Ação de postagem do DataRaptor errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel,

inProgressMessage
Ação de transformação do errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel,

DataRaptor inProgressMessage
Divulgação checkLabel
Ação de envelope do DocuSign errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel,

inProgressMessage
Ação de assinatura do DocuSign errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel,

inProgressMessage
Editar bloco newLabel, editLabel, deleteLabel
Ação de e-mail errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel,

inProgressMessage
Ação do Procedimento de errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel,

Integração inProgressMessage
Ação da Matriz errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel,

inProgressMessage
Seleção múltipla opções[i].valor
Ação PDF errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel,

inProgressMessage
Rádio opções[i].valor
Ação Remota errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel,

inProgressMessage
Ação de descanso errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel,

inProgressMessage
Cabeçalho do script consoleTabLabel
Selecionar opções[i].valor
Etapa cancelLabel, nextLabel, previousLabel, saveLabel, cancelMessage, saveMessage
Bloco de digitação à frente newItemLabel
Validação mensagens[i].texto
A tabela a seguir lista as propriedades para as quais o Vlocity fornece rótulos personalizados com traduções
padrão.
Propriedade Etiqueta personalizada
padrão
cancelar etiqueta OmnicancelLabel
cancelarMensagem Mensagem Omnicancel
consoleTabLabel OmniconsoleTabLabel
editarEtiqueta Omniedit Label
falhaGoBackLabel OmnifailureGoBackLabel
falhaPróximoEtiqueta OmnifailureNextLabel
inProgressMessage OmniinProgressMessage
newItemLabel OmninewItemLabel
novoEtiqueta OmninewLabel
próximoEtiqueta OmninextLabel
postar mensagem OmnipostMessage

company
etiqueta anterior Rótulo Omnianterior
mensagem de OmniremoteConfirmMsg
confirmação remota
salvarEtiqueta OmnisaveLabel
salvarMensagem Mensagem Omnisave
Veja também
Configuração avançada para elementos de formulário OmniScript

Esta seção informa como trabalhar com elementos que permitem que os usuários insiram informações,
pesquisem informações de registro, selecionem opções, criem registros, editem registros e excluam registros.
Para obter informações sobre todos os elementos OmniScript, consulte Referência de elementos OmniScript .
Adicionar opções para seleções, seleções múltiplas e botões de opção

Para adicionar opções para Select, Multi-Select e Radio Buttons, vá para a seção Option Source do elemento e
clique em +Add new option . Se nenhum valor for definido para um elemento Select, um Valor Indefinido será
retornado.
Cada opção tem um par Valor/Rótulo. O Valor são os dados independentes de linguagem que são passados
para dentro e para fora do OmniScript remotamente, seja por meio de ações DataRaptor ou Remote/Rest.
Também é referenciado ao configurar a Visualização Condicional.
O rótulo é exibido no formulário. O Valor e o Rótulo podem ser idênticos ou diferentes.
Por exemplo, o elemento ethernetLink mostrado na imagem abaixo tem quatro opções:
O valor de uma dessas opções é " EN " e seu rótulo é "Sem link para um dispositivo Ethernet". Se um usuário
clicar em No Link To An Ethernet Device , os dados retornados serão "EN".

company
Para elementos Multi-Select, se o usuário selecionar várias opções, uma lista de dados delimitada por ponto e
vírgula será retornada. Por exemplo, selecionar Sem link para um dispositivo Ethernet e falhas de hardware
retorna EN;HW .
NOTA
Se os valores mudarem com frequência, ative "Buscar valores da lista de opções no
carregamento do script" para garantir que os elementos OmniScript contenham o conjunto de
valores mais atualizado. As origens do Salesforce incluem listas de opções e classes
personalizadas.
Definir intervalos de data e hora

Os elementos Date, Date/Time e Time permitem que os usuários insiram datas e horas em um formulário
OmniScript. Cada elemento possui propriedades diferentes que permitem apresentar ao usuário um intervalo
de datas ou horas selecionáveis.
Período
Para criar um intervalo de datas selecionável para o elemento Data ou Data/Hora, configure as seguintes
propriedades:
• minDate : define a primeira data selecionável no intervalo.

• maxDate : define a última data selecionável no intervalo.
Os campos minDate e maxDate aceitam valores dinâmicos e estáticos.
Exemplos de sintaxe de valor dinâmico aceitável:
• hoje + 1 dia
• hoje - 5 dias
• hoje + 2 meses
• hoje - 1 mês
Exemplos de sintaxe de valor estático aceitável:
• 21/10/2018
• 21-10-2018
Período
NOTA
Os OmniScripts não permitem que o formato DateTime seja incluído nos campos minTime ou
maxTime.
Para criar um intervalo de tempo selecionável para o elemento Time, configure as seguintes propriedades:
• minTime : Define o primeiro tempo selecionável no intervalo.
• maxTime : Define o último tempo selecionável no intervalo.
Os campos minTime e maxTime aceitam valores estáticos que devem incluir quatro dígitos formatados como
HH:mm na sintaxe de relógio de 12 horas ou de 24 horas.
Exemplos de valores de relógio de 12 horas aceitáveis incluem:

company
• 01h00
• 13:00
• T07:30:00.000Z
Exemplos de valores de relógio de 24 horas aceitáveis incluem:
• 01:00
• 13:00
• T19:30:00.000Z
Vinculando uma lista de opções ao Salesforce

Usando o Vlocity OmniScript, você pode preencher dinamicamente um elemento Select, Multi-Select ou Radio
com valores de uma lista de opções em sua organização do Salesforce ou usando uma classe Apex
personalizada.
Por exemplo, anUpdate Case OmniScript requer que o elemento Status seja preenchido dinamicamente com
base nesses valores do campo Status no objeto Case:
Para fazer isso, selecione SObject como o tipo Option Source e digite Case.Status :

company
Agora o formulário irá recuperar e preencher dinamicamente a lista com valores de Case.Status:
NOTA
Se o nome do objeto ou do campo for personalizado, ele deverá ser precedido pelo NameSpace do
pacote — por exemplo, vlocity_cmt__Party__c.vlocity_cmt__Location__c ou
Case.vlocity_cmt__Amount__c .
Você também pode usar uma classe personalizada para preencher listas em OmniScripts. Consulte o código de
exemplo para obter instruções sobre a implementação.
Se os valores da lista forem dependentes de outro campo , adicione as informações desse campo na seção
Campo de controle. Siga as instruções acima para definir o campo de controle e também insira o nome
do elemento para o campo no formulário.
company
Preenchendo valores da lista de opções do Apex
Você pode preencher os elementos Select, Multi-select e Radio de uma implementação Vlocity Open Interface
Custom. Os valores do elemento são obtidos durante a ativação do OmniScript. Para obter informações sobre
como preencher listas de opções dependentes, consulte Preenchendo valores de listas de opções
dependentes com o Apex .
Para preencher as opções de um elemento, um List<Map<String, String>> é retornado da Implementação

Personalizada. As opções de mapa são 'Nome' a opção independente de idioma e 'Valor' o valor de exibição da
interface do usuário.
Apex Code para preencher a lista de opções:
classe global PicklistPopulation implementa VlocityOpenInterface { public Boolean

invokeMethod(String methodName, Map < String, Object > input, Map < String, Object > outMap,
Map < String, Object > options) {
if (methodName.equals('PopulatePicklist')) { PopulatePicklist(input, outMap, options);
}
retorne verdadeiro; }
// Obtém todos os tipos de relacionamento para a conta quando o Omniscript é compilado. public void
PopulatePicklist(Map < String, Object > input, Map < String,
Object > outMap, Map < String, Object > options) {
List < Map < String, String >> opções = new List < Map < String,
Cadeia >> ();
para (vlocity_namespace__PartyRelationshipType__c rel: [Selecione
vlocity_namespace__TargetRole__c, ID FROM vlocity_namespace__PartyRelationshipType__c onde
vlocity_namespace__SourcePartyType__c = 'Conta']) {
Mapa < String, String > tempMap = new Map < String, String > (); tempMap.put('nome', rel.Id);
// Independente de idioma
tempMap.put('valor', rel.vlocity_namespace__TargetRole__c);
// Exibido na lista de opções
UIoptions.add(tempMap);
}
outMap.put('opções', opções);
}
}
company
NOTA
Antes do Spring '17, havia dois campos Source no Designer ao criar
Listas de opções hierárquicas (Campo de controle). Qualquer configuração de OmniScripts anterior
ao Spring '17 ainda funcionará; os novos OmniScripts terão apenas um campo Origem nas Opções
que definirá a dependência das Listas de Seleção Hierárquicas conforme mostrado nas instruções
acima.
Preenchendo valores de lista de opções dependentes com o Apex

Você pode preencher os elementos Select, Multi-select e Radio de uma implementação Vlocity Open Interface
Custom. Os valores do elemento são obtidos durante a ativação do OmniScript.
Ao preencher uma Lista de opções dependente por meio do Apex, as opções de lista de opções retornadas são
Map<String, List<Map<String, String>> . As chaves para o Mapa inicial são as opções Language Independent
('name') do campo Controlling. As opções List<Map> são 'Nome', a Opção Independente de Idioma e 'Valor', o
valor de exibição da interface do usuário. Para obter informações sobre como preencher uma lista de opções
sem dependências, consulte Preenchendo valores da lista de opções do Apex .
Código Apex de exemplo:
classe global PicklistPopulation implementa VlocityOpenInterface { public Boolean

invokeMethod(String methodName, Map < String, Object > input, Map < String, Object > outMap,
Map < String, Object > options) { if (methodName.equals('PopulateDependentPicklist')) {
PopulateDependentPicklist(input, outMap, options);
}
retorne verdadeiro;
}
// Preencher uma lista de opções dependente com base no tipo de relacionamento de todas as partes
válido para um "Tipo de Parte de Origem" Selecionado em outro campo
public void PopulateDependentPicklist(Map < String, Object > input, Map <
String, Object > outMap, Map < String, Object > options) {
// Mapa da Lista onde a Chave são os Valores Potenciais no Outro
Lista de escolhas
Map < String, List < Map < String, String >>> dependency = new Map <
String, Lista < Mapa < String, String >>> ();
for (vlocity_namespace__PartyRelationshipType__c rel: [Selecione
vlocity_namespace__TargetRole__c, vlocity_namespace__SourcePartyType__c Id FROM

company
vlocity_namespace__PartyRelationshipType__c]) { if (!
dependency.containsKey(rel.vlocity_namespace__SourcePartyType__c)) {dependency.put,
new(rel.vlocity_namespace__SourcePartyParty_c))
{dependency.put(rel.vlocity_namespace__SourcePartyParty_c)
List < Map < String, String >> ());
}
Mapa < String, String > tempMap = new Map < String, String > ();
tempMap.put('nome', rel.Id);
// Independente de idioma
tempMap.put('valor', rel.vlocity_namespace__TargetRole__c);
// Exibido na lista de opções
UIdependency.get(rel.vlocity_namespace__SourcePartyType__c).add(tempMap);
}
outMap.put('dependência', dependência);
}
}
NOTA
O OmniScript não verifica se o valor da lista de opções dependente é válido quando passado.
Valores inválidos são descartados quando a lista de opções de controle é alterada.
Elemento de pesquisa
Execute uma consulta usando entrada de texto para recuperar dados do Salesforce usando o elemento
Lookup. Os dados recuperados são retornados em pares Valor/Rótulo e ficam disponíveis para seleção em
uma lista suspensa.
O elemento Lookup chama o serviço DataRaptor Output para consultar tabelas SFDC com base nos parâmetros
configurados na seção Propriedades. Para evitar problemas de desempenho, é recomendável manter o
número de resultados de valor abaixo de 150. Selecione o tipo Personalizado para executar uma classe
personalizada do Apex. Os elementos de pesquisa exibem valores do Salesforce com base em uma consulta
SOQL padrão criada usando os parâmetros dos elementos de pesquisa.
Tipo de objeto
Para consultar dados SObject:
1. Defina o Tipo de fonte de dados como SObject .

2. Em Parâmetros de entrada , configure estes campos:
• Fonte de dados : selecione um nome de elemento na lista suspensa para enviar o valor JSON desse
elemento na solicitação de pesquisa.
• Valor do filtro : insira um nome para o valor JSON a ser usado na configuração da consulta de pesquisa.
Esta imagem de exemplo define o caminho para o nó JSON CompanyName da primeira etapa e passa o
nome da empresa como um valor de filtro na consulta.

company
3. Configure a configuração da consulta de pesquisa:
a. Clique em + Adicionar nova configuração de pesquisa .
b. (Opcional) Em Prioridade de pesquisa , insira um número para definir a prioridade do pedido de
pesquisa se houver várias consultas.
c. Em Lookup Object , selecione um SObject.
d. Em Lookup Object Field , selecione um campo SObject para executar a consulta.
e. Clique em Filtrar Operador para selecionar um operador. Por exemplo, para retornar uma
correspondência exata, use o operador = ou, para selecionar correspondências semelhantes ao valor
do filtro, selecione o operador LIKE .
f. Em Filter Value , insira o nome de um Filter Value usado na seção Input Parameters. No exemplo
anterior, esse valor é Nome da Empresa .
g. Defina o caminho de retorno para os valores filtrados adicionando o Element Name do elemento
Lookup no caminho JSON .

company
4. Na seção Preencher elemento de pesquisa com resultados da consulta, defina um rótulo e um valor para
os resultados da pesquisa configurando estes campos:
• Rótulo : defina o rótulo da lista suspensa de um elemento de pesquisa para um valor JSON retornado
pela consulta. Como a consulta retorna os valores no Caminho JSON do Elemento de Pesquisa, você
deve definir o caminho completo. Por exemplo, para exibir um nome de conta como um rótulo em um
elemento de pesquisa chamado Company, o caminho completo é Company:Name .
• Valor : defina o valor para um campo de objeto que preenche o nó JSON do elemento de pesquisa
usando o caminho completo. Quando um usuário seleciona um rótulo, o valor preenche o nó JSON do
elemento Lookup. Por exemplo, para usar um Account Id para um valor JSON quando um usuário
seleciona um Account Name no elemento Lookup, o caminho completo é Company:Id .

company
5. Visualize o OmniScript para garantir que a consulta esteja funcionando e o valor esteja sendo definido
corretamente.
A consulta está estruturada neste formato:
SELECT Lookup Object WHERE Lookup Object.Field Name = Filter Value
Tipo personalizado
Use o tipo Custom para chamar uma classe Apex customizada que implementa NS .VlocityOpenInterface, onde
NS é o Name Space do pacote. A fonte é NS .ClassName.MethodName.
Para obter mais detalhes sobre configurações de consulta, consulte Trabalhando com configurações de
consulta de pesquisa .
Filtrar lista de opções por tipo de registro

Habilita a filtragem das opções da lista de opções por tipo de registro.
Antes de usar o filtro Tipo de registro, configure um Site remoto para habilitar as opções a serem carregadas
na página Visualforce de visualização do OmniScript.
1. Navegue até a página inicial do OmniScript Designer.

2. Copie o texto na barra de URL imediatamente antes de /apex .
https://doc-demo-vlocity.visualforce.com/apex/OmniScriptHome? sfdc.tabName=01rlu000001A3aC
3. Em Configuração , insira Site remoto na caixa de busca rápida e clique em Configurações do site remoto .
4. Clique em Novo Site Remoto .
5. Para o Nome do Site Remoto , insira vlocity .
6. Para a URL do site remoto , cole a URL da Etapa 2.
Para filtrar as opções:
1. Na propriedade Objeto e campo da lista de opções, insira a lista de opções no seguinte formato:
company
2. Filtre a lista de opções por tipo de registro inserindo o tipo de registro na propriedade tipo de registro .
Esta propriedade suporta %MergeFields%.
Trabalhando com configurações de consulta de pesquisa

Para saber mais sobre como pesquisar valores em um OmniScript, consulte Elemento de pesquisa .
Ao usar o Lookup Element no OmniScript, a filtragem dos resultados é realizada pela seção de propriedades
Lookup Query Configuration. Existem três tipos principais de consultas que podem ser criadas usando esta
seção de propriedades de configuração de consulta de pesquisa: junção AND, junção OR e consulta profunda.
E Junte-se
Para criar E Unir e filtrar resultados em dois ou mais campos, defina o valor do campo de sequência com o
mesmo valor dos campos que você deseja unir na consulta.
Figura 5. Exemplo E Junção
Neste exemplo, procuramos Leads que tenham País = "EUA" E Cidade = "San Francisco". Isso é feito
selecionando a mesma ordem de pesquisa e preenchendo o caminho JSON com o mesmo valor.
NOTA
O caminho JSON pode ser qualquer texto, mas uma prática recomendada é nomear o caminho
JSON ao objeto que está sendo referenciado.
Consulta profunda
Para criar uma consulta profunda, a ordem de pesquisa é colocada em ordem sequencial. O OmniScript cria
conjuntos de consultas menores em cada conjunto de pedidos.

company
Figura 6. Exemplo de consulta profunda
No exemplo de consulta profunda, procuramos Leads que tenham País = "EUA" E Cidade = "San Francisco".
A partir desse conjunto de dados, também exibimos apenas Leads que possuem Industry = "Governo". Como
estamos realizando uma consulta profunda, o nome do campo do caminho JSON precisa ser atualizado para
preencher de acordo.
NOTA
O caminho JSON na seção de propriedade Field Population deve corresponder ao texto usado no
JSON Path. Uma prática recomendada é separar o caminho JSON com dois pontos para indicar o
caminho JSON aninhado.
OU Junte-se
OU Joins não são suportados no editor OmniScript, portanto, uma solução alternativa deve ser usada para
realizar essa funcionalidade. Para executar uma associação OR, um campo de fórmula personalizado no objeto
pode ser implementado para realizar a parte OR da consulta de forma que a fórmula retorne um valor TRUE se
a consulta OR for atendida e FALSE se não.
Figura 7. Exemplo com uma junção OR
O exemplo de campo de fórmula Vlocity_Industry__c usa esta sintaxe:

company
E SE(
OU(
ISPICKVAL(Indústria, "Governo"),
ISPICKVAL(Indústria, "Seguros"),
ISPICKVAL(Indústria, "Comunicação")
),
"VERDADE",
"FALSO")
Isso permite efetivamente uma junção OR, mesmo que o elemento OmniScript não ofereça suporte a essa
funcionalidade diretamente.
NOTA
Em todas as instâncias, os valores de filtro devem ser texto e entre aspas duplas.
Controlando a propriedade do campo

A propriedade de campo de controle em um elemento de seleção pode exibir valores de campo de seleção
com base na seleção de outro valor de um campo de seleção de controle. Os campos de controle e
dependentes devem extrair seus valores de campo de um campo no Salesforce usando a propriedade sObject
e esses campos devem ter uma configuração de Dependência de campo entre si por meio do recurso
Dependência de campo do Salesforce. Para obter mais informações, consulte Definir lista de opções de
dependentes na Ajuda do Salesforce.
Figura 8. Exemplo de configuração de campo de controle

company
Figura 9. Configuração do campo de controle
Figura 10. Configuração do Campo Dependente

company
Figura 11. Dependência de campo definida no Salesforce
Usando a opção de origem personalizada

Ao usar Personalizado como uma fonte de opção, você pode definir uma classe do Apex que extrairá a fonte
de valores da Lista de opções. Para obter mais informações, consulte Preencher valores da lista de opções do
Apex .
Avaliando Elementos em Blocos Repetíveis
Se o elemento Fórmula estiver em um bloco repetível e avaliar um elemento também nesse bloco, use |n no
construtor de expressão para indicar que a fórmula deve avaliar apenas o elemento no bloco atual. Por
exemplo, o elemento de fórmula childAge converte o elemento childBirthday date (no mesmo bloco) em um
número usando a fórmula AGE(%childBirthday|n%) :
Quando o OmniScript é executado, o elemento de fórmula childAge avalia apenas o elemento childBirthday no
mesmo bloco:
Usando o Editor de Rich Text no Vlocity OmniScript Designer

company
As instruções do elemento Bloco de Texto e Divulgação usam um Editor de Rich Text para exibir HTML em um
OmniScript. Além dos recursos padrão do Editor de Rich Text, você pode:
• Carregue arquivos e imagens para documentos do Salesforce (até 1 MB). Os arquivos são carregados na
pasta pública VlocityDocument Uploads e são definidos como Disponível externamente.
• Link para arquivos e imagens de Documentos.
• Inserir links inteligentes para artigos do Salesforce Knowledge.
• JSON de dados de referência usando campos de mesclagem.
O exemplo de bloco de texto a seguir contém uma imagem, dois campos de mesclagem e uma URL.
Para usar o Editor de Rich Text, arraste um bloco de texto ou elemento de título para a estrutura do
OmniScript. Além disso, você pode usá-lo nas propriedades da etapa para editar o texto da instrução no modo
horizontal.
Dados OmniScript e integrações externas

O OmniScript lida com dados e integrações externas por meio de elementos de ação do OmniScript ,
elementos de grupo do OmniScript e elementos de entrada do OmniScript . O Elements usa OmniStudio
DataRaptors , Integration Procedures, HTTP Actions e Apex para carregar, transformar e postar dados.
company
Carregar dados em elementos OmniScript
Preencha os elementos OmniScript com dados para preencher previamente os elementos, criar opções
selecionáveis, exibir elementos dinamicamente e testar a funcionalidade. Carregue dados em seu OmniScript
usando DataRaptors, procedimentos de integração, ações HTTP, parâmetros de URL ou Apex.
Carregar dados do Salesforce no OmniScript usando o DataRaptor

Adicione dados do Salesforce em seu OmniScript usando uma ação de extração do DataRaptor.
Para obter dados do Salesforce em elementos OmniScript, crie uma extração do DataRaptor, conforme a
seguir.
1. Na página Vlocity DataRaptor, clique em Novo .

2. Escolha Extrair e especifique um Nome, Tipo e Subtipo.
Na guia Extrair , mapeie os dados de sObjects para uma estrutura intermediária chamada JSON da Etapa de
Extração. Para cada sObject do qual seu OmniScript requer dados, execute as seguintes etapas:
1. Clique em Adicionar etapa de extração e escolha o sObject de origem.

2. No campo Extract Output Path , especifique o nome do nó de nível superior no JSON da Etapa de
Extração onde você deseja que os dados residam.
3. Para filtrar os dados de entrada, especifique as configurações de filtro. Normalmente, você compara o ID
de contexto do sObject com um campo de mesclagem contendo o ID de contexto do OmniScript, por
exemplo, Id = %caseId%.
4. Na guia Fórmulas , você pode definir expressões que adicionam dados ao JSON da Etapa de Extração.
Para obter mais informações, consulte Operadores e funções do DataRaptor .
5. Na guia Saída , mapeie os dados do JSON da Etapa de Extração para a Saída JSON Atual, que é retornada
ao OmniScript. Para cada elemento OmniScript que você deseja preencher com dados, clique em + e
especifique a origem - o nó Extract Step JSON - e o caminho de saída para os dados. O nome do nó JSON
de saída deve corresponder ao elemento OmniScript que você deseja preencher usando os dados no nó.
Para facilitar o mapeamento, edite o OmniScript usando o OmniScript Designer e copie seu Data JSON para o
painel Saída JSON Esperada do DataRaptor Designer, que preenche o campo Tipo de Dados de Saída com uma
lista de campos de saída válidos.
Preencher elementos OmniScript usando DataRaptor

Se você iniciar um OmniScript a partir de uma página de detalhes, poderá usar o DataRaptor para preencher
previamente qualquer campo desse registro em um OmniScript. Por exemplo, se um OmniScript for iniciado a
partir de um registro de contato, o DataRaptor poderá preencher automaticamente o nome e o endereço do
contato no formulário.
Além disso, você pode usar o DataRaptor para extrair dados do Salesforce com base em dados já inseridos em
um OmniScript. Por exemplo, se você inserir o nome e o sobrenome de um contato, o DataRaptor poderá usar
essas informações para recuperar e preencher campos adicionais para esse contato.
1. Crie uma interface de extração do DataRaptor (JSON). Para obter mais informações, consulte Visão geral
da extração do DataRaptor .
2. Crie um ou mais mapeamentos de dados de extração para gerar um JSON da etapa de extração. Para
obter mais informações, consulte Carregar dados do Salesforce no OmniScript usando o DataRaptor .

company
3. Crie um ou mais mapeamentos de dados de transformação para mapear campos do JSON da etapa de
extração em elementos no script. Para obter mais informações, consulte Criar uma extração do
DataRaptor .
4. Visualize o OmniScript.
Por exemplo, talvez você queira criar um OmniScript para solucionar problemas comuns de clientes. Para este
OmniScript, você desejará preencher previamente seis elementos no OmniScript: AccountName, AccountId,
CaseNumber, CaseDescription, CaseStatus e CaseSubject. Como o formulário está sendo iniciado a partir de
um registro de caso, o ID do caso será passado para o elemento ContextId do OmniScript. Usando esse ID, o
DataRaptor consulta a tabela Caso e Conta para recuperar as linhas solicitadas.
Pré-preencher blocos repetíveis

Preencher blocos repetíveis com dados passando dados para o bloco em um formato de matriz.
O nome do nó raiz dos dados deve corresponder ao nome do elemento do bloco. Os campos em cada instância
de matriz do nó JSON de dados devem corresponder ao nome de um elemento dentro do bloco. Preencher
dados em blocos repetíveis com Ações retornando dados que correspondam ao nome do elemento do bloco e
do elemento dentro do bloco usando um formato de matriz.
Exemplo de formato de matriz JSON de dados:
"EditBlock1": [
{
"Nome": "João",
"Sobrenome": "Smith"
},
{
"Nome": "Jane",
}
]
Para mapear o JSON de dados para um bloco repetível com uma ação Definir valores:
1. Adicione um bloco ou bloco de edição ao OmniScript.

2. (Opcional) Ao usar um Bloco, marque a propriedade da caixa de seleção Repetir do Bloco .
NOTA
Blocos de edição são inerentemente repetíveis porque armazenam valores de entrada em um
formato de matriz.
3. Adicione elementos de entrada ao bloco.

4. Adicione uma ação Definir valores ao OmniScript.
5. Na ação Definir valores, clique em Adicionar novo valor .
6. No campo Nome do Elemento , insira o nome do seu elemento de bloco.
7. Clique em Editar como JSON no elemento Definir ação de valores para editar o JSON diretamente.
8. No nó JSON elementValueMap , localize o nó JSON do elemento de bloco e insira uma matriz de dados.
Por exemplo, para preencher previamente dois elementos Text input em um elemento Edit Block,
adicione uma matriz que mapeie para os elementos no bloco.
Editar configuração do elemento de bloco:
company
Matriz JSON:
"EditBlock1": [
{
"Nome": "João",
},
{
"Nome": "Jane",
}
]
9. Clique em Editar no Editor de propriedades para converter novamente para a exibição padrão da ação
Definir valores.
10. Visualize o OmniScript para visualizar os dados aninhados no JSON de dados do OmniScript.
Para obter mais informações sobre elementos de preenchimento prévio, consulte Preencher elementos
OmniScript usando DataRaptor .
company
Semear dados em um OmniScript
Preencha os campos OmniScript com dados ou adicione nós ocultos ao OmniScript Data JSON usando a
propriedade Seed Data JSON na seção Configuração do OmniScript.
A propriedade Seed Data JSON deve ser usada com valores estáticos que se propagam durante o
carregamento inicial do OmniScript. Para definir valores usando fórmulas ou com informações inseridas no
OmniScript após o carregamento inicial, consulte Definir valores em um OmniScript .
1. configuração do OmniScript , localize a seção Seed Data JSON e clique em +Add New Key/Value Pair .
2. Insira o nome do elemento a ser preenchido previamente no campo de texto à esquerda. Insira o valor
desejado do elemento no campo de texto à direita. Se o elemento tiver várias respostas, como uma
seleção múltipla, você poderá preencher mais de um valor separando as entradas com um ponto e
vírgula.
3. Quando o usuário inicia o script, os elementos especificados na seção Seed Data JSON contêm os valores
estáticos das Configurações de script.
4. Você também pode usar a propriedade Seed Data JSON para adicionar nós ocultos ao Data JSON do
OmniScript. Por exemplo, um OmniScript usado para solução de problemas pode criar um caso. Você
pode usar os valores padrão de nós ocultos para pré-preencher os valores. Por exemplo, você pode
querer que o OmniScript crie um Case com Tipo, Status e Origem definidos no Data JSON do OmniScript.
Usando esse método, você pode ter vários OmniScripts associados a uma interface DataRaptor que cria o
Case.
Veja também
• Preencher elementos OmniScript usando DataRaptor
Definir um valor padrão para um elemento

A propriedade Default Value permite que o valor JSON de um elemento seja definido como um valor estático
por padrão e
existe em certos Elementos. O valor padrão será substituído se o elemento for preenchido de uma resposta
DataRaptor ou JSON. Para obter mais informações sobre valores de pré-preenchimento dinâmico, consulte
Prefill OmniScript Elements using DataRaptor .
1. No painel Script Configuration do OmniScript, clique no elemento para abrir seu painel de propriedades.
2. No painel de propriedades do elemento, clique no campo Valor padrão e insira um valor. O campo de
valor padrão aceita a sintaxe do campo de mesclagem. Consulte Acessar o JSON de dados do OmniScript
com campos de mesclagem .
3. Visualize o OmniScript para visualizar o valor padrão no Data JSON.
Gerenciar dados OmniScript

Esta seção contém informações sobre como transformar, avaliar e definir dados no OmniScript. Os dados são
mantidos em uma estrutura intermediária chamada JSON de dados, que fica visível para você, o
desenvolvedor, conforme você define o OmniScript. O JSON de dados não é visível para usuários que
executam o OmniScript.
Acesse o JSON de dados do OmniScript com campos de mesclagem

Habilite elementos OmniScript e propriedades de elementos para acessar dados JSON usando
campos de mesclagem. Um campo de mesclagem é uma variável que faz referência ao valor de um

company
nó JSON. Por exemplo, se um nó JSON for "FirstName": "John" , o campo de mesclagem %FirstName%
retornará John .
Campos de mesclagem acessam dados JSON usando sintaxe para indicar a um elemento OmniScript que um
campo de mesclagem está presente. A sintaxe exige que você envolva um caminho JSON completo com um
sinal de porcentagem em ambas as extremidades.
NOTA
Apenas algumas propriedades de elemento suportam campos de mesclagem.
Casos de uso comuns

• Definir valores para renomear elementos, acessar nós JSON, executar fórmulas e preencher elementos. Para
obter mais informações, consulte Definir valores em um OmniScript
• Acesse dados armazenados em elementos OmniScript em uma fórmula ou em uma etapa futura.
• Dados de acesso retornados de uma ação. Por exemplo, uma Ação HTTP ou Ação DataRaptor retorna dados
do Salesforce ou de uma fonte externa. Para obter mais informações sobre ações, consulte Elementos de
ação do OmniScript .
• Dados de acesso passados como um parâmetro de uma página.
Acesse os dados JSON

Use o JSON de dados existente em uma propriedade de elemento indicando o uso de um campo de
mesclagem.
1. Localize o nome do nó JSON no JSON de dados do OmniScript.
2. Insira o nome do nó JSON e coloque o nome em sinais de porcentagem para indicar que é um campo de
mesclagem. Por exemplo, um campo de mesclagem acessando um nó JSON chamado firstName deve
usar a sintaxe %firstName% .
company
3. Visualize o OmniScript para garantir que o campo Merge funcione corretamente.
Sintaxe Adicional
Esta tabela fornece exemplos de sintaxe adicionais para JSON aninhado.
Nó JSON Exemplo de sintaxe de campo de mesclagem
"Informações de contato": { Use um símbolo de dois pontos : para acessar um nó JSON aninhado.
"Nome": "João"
} %ContactInfo:FirstName%
"Objeto Pai": { Use um símbolo de dois pontos : para acessar nós JSON aninhados e um símbolo de barra vertical |
"Mapa de Números": [ para acessar o índice do array desse valor.
1,
2, %ParentObject:NumberMap|3%
3
]
}
"ContactInfoStep": { Quando existe uma fórmula em um bloco repetível, use |n para acessar o nó no qual a fórmula existe.
"ContactInfoBlock": [ Dependendo de qual nó a fórmula existe, ela retornará o valor correlacionado. Para obter mais
{ informações, consulte Avaliação de elementos em blocos repetíveis .
"Nome": "João"
}, %ContactInfoStep:ContactInfoBlock|n:FirstN ame%
{
"Nome": "Adão"
},
{ "Primeiro nome":
"Steve"
}
]
}
Definir valores em um OmniScript

company
Defina valores de elemento em etapas futuras, renomeie nós JSON, crie valores dinâmicos e concatene dados
usando a ação Definir valores. Os elementos de ação são renderizados como um botão quando em uma etapa
ou executados remotamente entre as etapas. Definir valores depende do uso de campos de mesclagem para
acessar o JSON de dados do OmniScript. Para obter mais informações sobre campos de mesclagem, consulte
Acessar o JSON de dados do OmniScript com campos de mesclagem
Use a ação Definir valores para:
• Acesse e renomeie dados JSON usando campos de mesclagem

• Preencher Elementos com valores
• Concatenar valores
• Definir valores enviados para o JSON de dados de uma resposta ou parâmetro
• Crie valores determinados por funções OmniScript e operadores de fórmulas compatíveis
Baixe este pacote de dados e teste os comportamentos fornecidos pelos exemplos nesta página.
Renomear nós JSON de dados

Simplifique e renomeie nomes de nós JSON acessando os valores em um JSON de dados do OmniScript. Os
dados enviados para o JSON de dados do OmniScript a partir de um parâmetro, dos dados de resposta de uma
ação ou de um elemento podem ser acessados usando campos de mesclagem. Para obter mais informações,
consulte Acessar o JSON de dados do OmniScript com campos de mesclagem .
Para renomear um nó:
1. No OmniScript Designer, clique em Visualizar.

2. Insira algumas informações e visualize o JSON de dados do OmniScript.
3. Localize o nó JSON no JSON de dados do OmniScript.
5. Na ação Definir valores, clique em Adicionar novo valor.
6. No campo Nome do Elemento , insira o novo nome do nó JSON.
7. No campo Valor , insira o nome do nó JSON usando a sintaxe do campo de mesclagem para mapeá-lo
para o novo nó JSON.
8. Visualize o OmniScript e visualize o novo nome do nó JSON.
Preencher Elementos
Preencha elementos futuros com valores de dados JSON, operadores de fórmulas, funções, concatenações e
valores estáticos. Preencher um elemento diretamente de uma resposta DataRaptor ou Action sempre
que possível. Consulte Prefill OmniScript Elements usando DataRaptor para obter mais informações.

company
NOTA
Ao preencher um elemento usando Definir valores, os tipos de dados devem corresponder. Por
exemplo, você não pode definir um elemento Text com o valor de um elemento Number.
Para preencher um elemento:
1. Localize o nó JSON no JSON de dados do OmniScript.

4. No campo Nome do Elemento , insira o nome de um Elemento em uma Etapa que renderiza após a Ação
Definir Valores.
NOTA
Quando o Nome do Elemento é mapeado para um elemento existente no OmniScript, o
Tipo do elemento aparece entre o campo Nome do Elemento e o campo Valor.
5. No campo Valor , insira o nome do nó JSON usando a sintaxe de mesclagem para mapeá-lo para o novo
nó JSON.
6. Visualize o OmniScript para garantir que os campos sejam preenchidos corretamente

company
Concatenar valores
Crie valores dinâmicos concatenando nós JSON.

3. No campo Nome do Elemento, insira um nó JSON ou um nome de elemento.
4. No campo Valor, clique em fx e insira vários campos de mesclagem ou uma combinação de campos de
mesclagem e valores literais.
Exemplo de nome de elemento Exemplo de sintaxe de valor
Nome completo =%Nome% + " " + %Sobrenome%
Nome completo =%Nome% + " " + "Smith"
Bem-vindoSaudações =("Bem-vindo, %FirstName% %LastName%")
5. Visualize o OmniScript para testar a concatenação.
Definir dados com fórmulas e funções

Gere valores dinâmicos avaliando dados com Fórmulas e usando funções para retornar valores específicos.
Para obter mais informações, consulte Funções do OmniScript e operadores de fórmulas compatíveis .

4. No campo Valor , clique em fx para abrir o editor de fórmulas.
5. No painel de funções , selecione uma função e adicione quaisquer dados adicionais ao editor de fórmulas.
6. Visualize o OmniScript para testar a função.

company
Para usar um operador de fórmula:

4. No campo Valor , clique em fx para abrir o editor de fórmulas.
5. Adicione valores estáticos ou valores dinâmicos usando campos de mesclagem e adicione um operador.
NOTA
Deve haver um espaço em cada lado de um operador para que a operação seja executada
corretamente.
Nome do elemento Exemplo de sintaxe de fórmula de valor
MergeValues = %GrossIncome% - %NetIncome%
MergeAndLiteralValues = %Renda Bruta% - 5000
Valores Literais =2-2
6. Visualize o OmniScript para garantir que a operação seja executada corretamente.
Definir e acessar dados aninhados

Defina e acesse dados aninhados editando o JSON Set Values diretamente e usando uma sintaxe específica.

3. No campo Nome do Elemento , insira um novo nome de nó ou nome de elemento JSON.
4. Clique em Editar como JSON no elemento Definir ação de valores para editar o JSON diretamente.
5. No nó JSON elementValueMap , inclua um valor JSON válido no nome do nó criado no campo Nome do
Elemento .
6. Clique em Editar no Editor de propriedades para converter novamente para a exibição padrão da ação
Definir valores.
7. Visualize o OmniScript para visualizar os dados aninhados no JSON de dados do OmniScript.
Para acessar dados aninhados e defini-los como um nome de elemento ou nó JSON:

3. No campo Nome do Elemento , insira um novo nome de nó ou nome de elemento JSON.
4. No campo Valor , aplique a sintaxe do campo de mesclagem para acessar o valor apropriado. Para obter
mais informações, consulte Acessar o JSON de dados do OmniScript com campos de mesclagem .
5. Visualize o OmniScript para garantir que o valor seja mapeado para o novo nó JSON
corretamente.

company
Veja também
• Carregar dados em elementos OmniScript

Manipular JSON com as propriedades de transformação de envio/resposta

Especifique e transforme o JSON de entrada e saída de OmniScripts ou Procedimentos de Integração com as
propriedades de Transformação de Envio e Resposta. As propriedades Send transformam a entrada; as
propriedades Response transformam a saída.
A tabela a seguir descreve as diferentes opções de transformação:

Propósito Mandar/ Nó JSON de envio/resposta Caminho de Exemplo
Resposta exemplo Resultado
Caminho JSON
Reparentando o nó caminho nó {caminho:{a:b}} {nó: {a:b}}
Reparentando o nó e adicionando um caminho nó1: nó2 {caminho:{a:b}} {nó1:{nó2:

nó aninhado {a:b}}}
Reparentando o nó dinamicamente caminho %nodename% {caminho:{a:b}} {nó: {a:b}}

usando a sintaxe do campo de mesclagem
onde o valor de nodename é node
Removendo o nó pai de um objeto caminho VlocityNoRootNode {caminho:{a:b}} {a:b}
(Não suportado em Integração

Procedimentos)
Especificando o nó raiz para detalhar caminho {caminho:{a:b}} {caminho:{a:b}}

em vez de enviar o
JSON inteiro
Para reparentar o nó de um objeto JSON:
1. Defina o Caminho para o nó no qual você está fazendo drill down.

2. Insira o novo nome do nó no campo Nó JSON .
Para reparentar o nó e adicionar um nó aninhado:

2. Insira o novo nome do nó no campo Nó JSON e insira dois pontos ( : ).
3. Após os dois pontos, sem deixar um espaço, insira o segundo nome do nó JSON.
Para reparentar o nó usando a sintaxe do campo de mesclagem:

2. No campo Nó JSON , insira um campo de mesclagem que represente o novo nome, por e xemplo
%NewNode% .
3. Use uma ação SetValues ou um parâmetro de entrada na guia Visualizar para testar o campo de
mesclagem.
Por exemplo, na guia Visualização, insira uma Chave de NewNode e um Valor de MightyNode , clique em
Executar e procure por MightyNode no JSON de saída.
Para gravar em um item de lista usando a sintaxe de campo de mesclagem:

company
1. No campo Nó JSON de Resposta de uma etapa, insira o caminho para o nó da lista seguido por uma barra
vertical ( | ) e um campo de mesclagem que representa o número do item da lista, por exemplo,
ListNode|%item% .
2. Use uma ação SetValues ou um parâmetro de entrada na guia Visualizar para testar o campo de
mesclagem.
Por exemplo, na guia Visualização, insira uma Chave de item e um Valor de 2 , clique em Executar e
observe a saída da etapa aparecer como o segundo item na lista.
Se o nó de saída da etapa e o nó de item de lista existente corresponderem, o valor do item de lista será
substituído. Se eles não corresponderem, o nó de saída da etapa será adicionado como um par do nó de
item de lista existente.
Para remover o nó pai de um objeto:
1. Defina seu Caminho para o nó no qual você está fazendo drill down.
2. Defina o nó como VlocityNoRootNode .
Para especificar o nó raiz:

2. Deixe o campo Nó JSON em branco.
Para testar o resultado de sua transformação, abra o console de depuração:
1. Visualize o OmniScript no OmniScript Designer e insira a entrada que você precisa transformar.
2. Após a execução da ação que contém a transformação JSON, clique em Depurar para abrir o console de
depuração.
3. No console de depuração, expanda a ação que está enviando ou recebendo o JSON transformado.
4. Expanda a solicitação para ver o JSON que foi transformado pelo caminho JSON de envio e pelo nó JSON
de envio ou expanda a resposta para ver o JSON que foi transformado pelo caminho JSON de resposta e
pelo nó JSON de resposta .
Criar campos de fórmula em um OmniScript

Crie expressões para definir valores calculados e avaliar dados em vários campos usando um elemento
Fórmula ou Agregado. Por exemplo, se você estiver aceitando informações para um evento de vida
qualificado, talvez queira criar uma fórmula que determine se a data inserida para o evento de vida qualificado
está dentro de trinta dias da data de hoje.
Para obter uma lista de funções disponíveis, consulte Funções do OmniScript .
Os elementos Formula e Aggregate suportam as seguintes constantes e tipos:
• Elementos OmniScript e nós JSON, passados como campos de mesclagem, por exemplo, %Element1% ou
%JSONnode1%
• Números e números inteiros — por exemplo, 5 + 3,145
• Literais de string entre aspas — por exemplo, ' "ABC" + "DEF" '
• Booleanos—por exemplo, true || falso
• Matrizes — por exemplo, "[1,2, 3, 4, 5]"
• Nulo

company
Veja também
• Funções OmniScript
• Criar uma fórmula ou agregado em um OmniScript
Operadores de fórmula compatíveis

Os campos de fórmula no OmniScript são compatíveis com os seguintes operadores:
Operador Significado
+ Adição
- Subtração
* Multiplicação
/ Divisão
^ Poder
= É igual a
<> Não é igual
> Maior que
< Menor que
>= Melhor que ou igual a
<= Menos que ou igual a
&& E
|| Ou
() Parênteses
Para obter informações sobre funções suportadas no OmniScript, consulte Funções do OmniScript . Para obter
informações sobre como adicionar um campo Fórmula a um OmniScript, consulte Criar uma fórmula ou
agregar em um OmniScript .
Funções OmniScript
Você pode adicionar funções aos elementos Agregado e Fórmula. Para obter informações sobre como
adicionar elementos Fórmula ou Agregação ao OmniScript, consulte Criar uma fórmula ou agregação em um
OmniScript . Para exibir uma lista de operadores de fórmula com suporte que podem ser usados com o
elemento Fórmula, consulte Operadores de fórmula com suporte .
As tabelas abaixo detalham as diferentes funções disponíveis e como elas funcionam.

Tabela 1. Funções de conversão
Nome da função Exemplo Detalhes
ABS (número) ABS(%Amigos%) == 6,52534 Retorna o valor absoluto.
BOOLEAN(valor) Retorna verdadeiro ou falso.
MOEDA( valor ) Retorna o valor formatado para moeda. 12345 seria exibido como
12.345.
INTEIRO( valor ) INTEIRO(%Amigos%) == 6 Converte o número fornecido em um inteiro sem casas decimais. Não
arredonda o número. Também aceita uma string.
INTEIRO("12,5") == 12

company
NULO Torna o valor de um objeto nulo.
NÚMERO( valor ) NUMBER(%Friends%) == 128 Converte uma string em um número.
POW( número , expoente ) POW(%Amigos%, 3) == 274.625 Retorna o valor do expoente.
ALEATÓRIA() ALEATÓRIA() Retorna um número aleatório entre zero e um. Esta função é
comumente usada em testes A/B. A função RANDOM() não aceita
parâmetros.
ROUND( número , decimalPlaces ) ROUND(%Amigos%, 3) == 6,525 Arredonda o número para um determinado número definido de casas
decimais.
Tabela 2. Funções Condicionais

E(); IF((%reset%="Sim" AND( %reboot Operador lógico que executa uma função se todas as
%="Sim")), "Fechado", "Escalado") condições forem atendidas.
CONT.SE( valores , expressão_ou_valor ) CONT.SE(%MeuArray%, >10) Retorna uma contagem do número de elementos
repetidos se uma condição for atendida.
EQUALS( Field_Name , E SE( A função EQUALS é usada ao comparar um campo com

' Condição ') um valor específico ou outro campo.
EQUALS(%Departamento%,'401(k)'),
"Então Resultado",
"Outro resultado"
SE ( EXPRESSÃO , ENTÃO , SE NÃO ) SE((%reset%="Sim" || %reboot%="Sim"), Se EXPRESSION for avaliado como True, THEN será
"Fechado", "Escalado") retornado, caso contrário, ELSE será retornado.
OU() IF((%reset%="Sim" OU( %reboot

%="Sim")), "Fechado", "Escalado")
SUMIF( valores , expressão_ou_valor ) SUMIF(%MyArray%, >5) Retorna a soma de todos os elementos separados por
vírgula e valor se uma condição for atendida.
Tabela 3. Funções de Texto

CASO( valor , $CASE ) CASE(%Name%, UPPER) == "TONY JONES" Altera maiúsculas e minúsculas com
base no tipo $CASE. $CASE deve ser
CASE(%Name, LOWER) == "tony jones" INFERIOR,
SUPERIOR, SENTENÇA ou TÍTULO.
CASE(%Name%, SENTENCE) == "Tony Jones"
CASE(%Name%, TITLE) == "Tony Jones"
CONCATENAR( valor1 , valor2 , ..., valorN ) CONCATENAR(%Nome%, " ", %Sobrenome Concatena os elementos/strings
%) == "Tony Jones" juntos em uma única string.
CONTAINS (input_string , valor ) CONTAINS(%FirstName%, "Tony") == Verdadeiro Avalia se um valor está contido em
uma string.
SPLIT( texto , splitToken , limite ); SPLIT("Tony Jones", " ", 2) == "Tony", "Jones"
STRING( valor ) STRING(%Amigos%) == "6.5" Converte qualquer valor em uma

String.
SUBSTRING( text , startIndex , endIndex ) SUBSTRING("Substring!", 3, 9) == "string" Extrai os caracteres de uma string
entre dois índices especificados e
retorna o valor.

company
Tabela 4. Funções de Data
IDADE( data de nascimento ) IDADE(%data de nascimento%) == 7 Retorna uma idade (em anos) com a data de nascimento
especificada na data de hoje. Use o elemento Data.
AGEON( dataDeNascimento , data AGEON(%Data de nascimento%,"07-09-2024") A idade de alguém (em anos) com a data de nascimento em
futura ) == uma data futura. Use o elemento Data.
16
DATA( valor ) DATA(%DOB%) == qua 19 de julho de 1978 Use um elemento de data. Retorna o formato JavaScript
16:00:00 GMT-0700 (PDT) completo.
DATEDIFF( data1 , data2 ) DATEDIFF(%DOB%,%TODAY%) == A diferença entre 2 datas em dias. O valor será sempre um
13559 número inteiro positivo. Use o elemento Data.
DIA DE MÊS( data ) DAYOFMONTH(%TODAY%) == 2 Retorna o dia do mês. Use o elemento Data.
DIA DA SEMANA ( data ) DIA DA SEMANA(%TODAY%) == 4 Retorna o dia da semana como um número inteiro. Segunda-
feira é 1, domingo é 7.
HORA ( data ) Retorna a hora atual de acordo com a hora local.
MINUTO( data ) Retorna o minuto atual de acordo com a hora local.
MOMENTO() MOMENT(%policyStartDate%).add(1, Retorna o objeto moment de Moment.js

'ano').subtract(1, 'dia')
Isso pode ser usado para realizar formatação de data
complexa, cálculos, manipulação, comparações, etc. A função
MOMENT() deve conter parâmetros, por exemplo,
MOMENT(NOW()). Anexar .calendar() a esta função é uma
prática recomendada recomendada.
MÊS ( data ) MÊS(%TODAY%) == 9 O mês do ano como um número inteiro. Use o elemento Data.
AGORA() AGORA() == Qui, 27 de agosto de 2019 16:32:00 Retorna a data e hora atuais no formato JavaScript completo.
GMT-0700 (PDT) Milissegundos são sempre definidos como 0.
HOJE() TODAY() == Qui, 27 de agosto de 2019 00:00:00 Retorna a data de hoje. A hora é sempre definida para meia-
GMT-0700 (PDT) noite
ANO ( data ) ANO(%HOJE%) == 2019 Retorna o ano da data como um número inteiro. Use o
elemento Data.
Tabela 5. Funções agregadas

ARRAY( valor1 , valor2 , ..., valorN ) ARRAY(%Child1%,%Child2%, Retorna uma matriz do valor dos elementos.
%Criança3%,%Criança4%) == [4,3,1,2]
AVERAGE( matriz ) MÉDIA(%idade%) == 2,5 Agregado: retorna o valor médio médio dos números
fornecidos. Use um elemento de repetição.
AVERAGE( valor1 , valor2 , ..., valorN ) MÉDIA(%Criança1%,%Crianç a2%, Retorna o valor médio médio dos números fornecidos.
%Child3%,%Child4%) == 2,5
COUNT( matriz ) COUNT(%Idade%) == 4 Agregado: Retorna uma contagem do número de

elementos repetidos.
EXISTS( array_or_value , EXISTS([%FirstName%,%L astName Retorna true se o valor fornecido existir em um ou mais
expression_or_value ) %], "Tony") == verdadeiro elementos. Para Agregar, insira o nome de um elemento
repetido — por exemplo EXISTS(%FirstName %,"Tony"),
onde FirstName é repetível.
MAX( matriz ) MAX(%AGE%) == 4 Agregado: Retorna o maior valor nos números fornecidos.
Use um elemento de repetição.

company
MAX(( valor1 , valor2 , ..., valorN ) MAX(%Criança1%,%Criança2%, Retorna o maior valor no grupo de elementos fornecido.
%Child3%,%Child4%) == 4
MIN( matriz ) MIN(%AGE%) == 1 Agregado: retorna o menor valor nos números fornecidos.
Use um elemento de repetição.
MIN(( valor1 , valor2 , ..., valorN ) MIN(%Child1%,%Child2%, Retorna o menor valor no grupo de elementos fornecido.
SOMA( matriz ) SOMA(%AGE%) == 10 Agregado: retorna a soma de todos os valores no elemento

repetível.
SOMA( valor1 , valor2 , ..., valorN ) SOMA(%Filho1%,%Filho2%, Retorna a soma de todos os elementos e valores
separados por vírgula.
Criar uma fórmula ou agregado em um OmniScript

Execute funções nos dados do elemento com os elementos Fórmula e Agregado.
Os elementos se comportam de maneira semelhante em um OmniScript. No entanto, o elemento A ggregate

deve ser usado para fins de agregação, como elementos de média ou soma. Elementos de fórmula podem usar
Operadores de Fórmula Suportados e Funções OmniScript . Por exemplo, você pode querer determinar uma
data de término do contrato adicionando 365 dias a um elemento de data. Você pode fazer isso usando a
fórmula de exemplo abaixo:
DATE(YEAR(%DateElement%), MONTH(%DateElement%),DAYOFMONTH(%DateElement%) +365)
Se você quiser definir uma data uma semana a partir da data de hoje, poderá fazê-lo usando a fórmula de
exemplo abaixo:
DATA(ANO(TODAY()), MONTH(TODAY()), DAYOFMONTH(TODAY()) +7)
As instruções abaixo explicam como adicionar e configurar o elemento Fórmula ou Agregado ao seu
OmniScript.
1. No OmniScript Designer, arraste um elemento Fórmula ou Agregado para a estrutura do script.
2. Você pode adicionar Funções OmniScript clicando no nome da função; a função será pré-preenchida na
seção Expressão. Adicione os elementos OmniScript dentro da função usando a notação de campo de
mesclagem, colocando o elemento em sinais de porcentagem (%).

company
3. Se você planeja usar este elemento em um bloco repetível, consulte Avaliar elementos em blocos
repetíveis .
4. Se estiver usando um elemento Fórmula, você pode continuar a criar a fórmula usando Operadores de
Fórmula Suportados na caixa de texto Expressão.
5. Se o elemento não deve aparecer na interface do usuário do script, clique em Ocultar .
6. Você também pode criar elementos adicionais que dependem dos resultados da Fórmula. Por exemplo, a
etapa mostrada na imagem abaixo aparece quando a fórmula de Renda Total é menor que 1.000. Para
obter mais informações, consulte Criar formulários dinâmicos usando a propriedade de exibição
condicional e exibir mensagens em OmniScripts .
7. Você pode testar a Fórmula ou Agregado clicando no link Visualizar.

company
Veja também
• Criar campos de fórmula em um OmniScript

• Funções OmniScript
Criar e atualizar dados de OmniScripts

Os OmniScripts postam dados no Salesforce e em bancos de dados externos usando OmniScript Action
Elements que integram OmniStudio DataRaptors , OmniStudio Integration Procedures , chamadas externas e
Apex.
Postar dados do Salesforce de OmniScripts

Crie e atualize sObjects e objetos externos de um OmniScript usando o DataRaptor Post Action. Se várias ações
forem necessárias, use um Procedimento de Integração para hospedar a Ação Post do DataRaptor e manipular
as solicitações.
A Ação Post do DataRaptor envia dados do script para um DataRaptor Load que executa a atualização ou
upsert. (Quando várias chaves de upsert são usadas, o registro deve corresponder a todas as chaves para ser
considerado uma correspondência.) Ao definir o DataRaptor Load, você mapeia dados do JSON de saída do
OmniScript para campos em sObjects. Para obter detalhes, consulte Mapeamento de campo de objeto .
1. Saiba mais sobre as cargas do DataRaptor. Consulte Visão geral do

carregamento do DataRaptor .
2. Crie uma carga do DataRaptor. Consulte Criar uma carga do DataRaptor .
1. No OmniScript, clique em Visualizar.

2. Insira quaisquer dados que você planeja usar no OmniScript. Você pode preencher previamente os
elementos para teste usando a ação Definir valores, a propriedade do elemento Valor padrão ou a
funcionalidade JSON de dados de semente.
3. Copie o Data JSON do OmniScript.
4. Em seu DataRaptor, cole o JSON de dados do seu OmniScript no JSON de entrada do DataRaptor .
5. Mapeie seus nós JSON de dados para campos de objeto. Veja também
• DataRaptor ou Procedimento de Integração?

• Procedimentos de Integração OmniStudio
Preencher um PDF do OmniScript usando o DataRaptor

Você pode preencher um PDF usando elementos de um OmniScript.
Itens requeridos:
• Adobe Acrobat Pro

• Um formulário preenchível existente (não seguro ou você tem a senha)
Requisitos do PDF:
• O PDF deve ser um PDF Linearizado, Versão 1.5 ou superior. Você pode salvar um PDF como Linearized
Versão 1.7 clicando em Salvar como outro , em PDF de tamanho reduzido e em Acrobat 10.0 e posterior .

company
• O Vlocity não oferece suporte ao tipo de campo Formulário PDF de caixa de listagem (campos de seleção
múltipla) no PDF.
• Os valores do campo de formulário PDF para botões de opção e listas suspensas devem ser mapeáveis
logicamente. Por exemplo, um botão de opção em um formulário PDF pode não ter duas opções c om o
mesmo nome.
NOTA
Os navegadores Firefox e Safari não podem preencher alguns campos sem realizar etapas
adicionais. Para usar o Firefox e o Safari, consulte Configurando seu navegador para usar o plug-in
Adobe PDF .
• O PDF pode ser iniciado em um navegador Firefox, Safari ou Chrome.
1. Prepare seu PDF.

2. Carregue o PDF no Salesforce como um documento.
Qual é o próximo
Criar uma interface DataRaptor para mapear dados OmniScript para um PDF
Criar uma interface DataRaptor para mapear dados OmniScript para um PDF
Depois de criar o OmniScript e carregar seu PDF, você deve criar um DataRaptor para mapear as informações
do OmniScript para o PDF. Consulte OmniStudio DataRaptors .
1. No OmniScript, clique em Visualizar e preencha os dados de teste para preencher o JSON do OmniScript.
2. Copie os dados JSON do OmniScript.
3. Na guia DataRaptor, clique em Novo .
4. Para Tipo de Interface , selecione Transformar .
5. Insira um nome de interface.
6. No campo Tipo de entrada , selecione JSON .
7. No campo Tipo de saída , selecione PDF .
8. No campo PDF de destino , selecione um PDF existente e clique em Salvar .
Qual é o próximo
Campos de mapa do OmniScript para o PDF
Veja também
• Preencher um PDF do OmniScript usando o DataRaptor

• Adicionar uma ação de PDF ao OmniScript

company
Mapear campos OmniScript para um PDF
Preencha um PDF com dados OmniScript mapeando os dados OmniScript JSON para o PDF.
Criar uma interface DataRaptor para mapear dados OmniScript para um

PDF
1. Na interface do DataRaptor, clique em Transformações .
2. Clique em Input JSON e cole o JSON do seu OmniScript.
3. Clique em Quick Match e mapeie nós em seus campos Input JSON to PDF.
4. (Opcional) Adicione mapeamentos um de cada vez clicando no símbolo + e mapeando um caminho JSON
de entrada para um campo de saída PDF .
Qual é o próximo
Adicionar uma ação de PDF ao OmniScript
Veja também

Adicionar uma ação de PDF ao OmniScript

Preencha um PDF com dados OmniScript usando a ação PDF.
NOTA
A ação PDF não é compatível com navegadores IE 11.
Mapear campos OmniScript para um

PDF
1. No OmniScript Designer, arraste a Ação do PDF para o OmniScript.
2. No painel Propriedades, em Documento , selecione seu documento PDF.
3. (Opcional) Anexe o PDF a um registro pai seguindo estas etapas:
a. Preencha o campo Nome do Anexo para nomear o anexo.
b. Preencha o campo ID do pai do anexo com o ID do registro pai do anexo.
4. Na seção Enviar transformações, na lista de opções PreTransform DataRaptor Interface , selecione o
DataRaptor que você criou em Criar uma interface DataRaptor para mapear um OmniScript para um PDF .
5. Marque a caixa de seleção Somente leitura para tornar os PDFs preenchidos somente leitura.
6. Se necessário, altere os formatos de data e hora padrão.
NOTA
Usar moment.js formatação. Se deixado em branco, os padrões são Formato de hora: h : mma
, Formato de data: MM / DD / YYYY , Formato de data e hora: MM/DD / YYYY h : mma .
7. Inicie o formulário no modo de visualização e preencha cada campo que deve mapear para o PDF.
8. Verifique o PDF para confirmar se os mapeamentos estão corretos.

company
Veja também

Carregar arquivos e imagens em OmniScripts
Para fazer upload de arquivos em um OmniScript, adicione um elemento de entrada File. Para fazer upload de
uma imagem, adicione um elemento de entrada Image. Detalhes sobre uploads são adicionados ao nó
Arquivos do JSON de dados do OmniScript.
Por padrão, os arquivos são carregados diretamente nos documentos de conteúdo do Salesforce. Para associar
um ou mais objetos do Salesforce ao arquivo carregado, especifique uma lista separada por vírgulas de IDs de
objeto no campo Content Parent Id . No Salesforce, os arquivos carregados são listados na seção Conteúdo da
página de detalhes do sObject.
Para especificar uma Interface Aberta de Vlocity a ser executada após o upload do arquivo ou da imagem,
defina os campos Classe Remota e Método Remoto da seção Ação Remota. Como entrada, o método
especificado recebe uma lista Map<String, Object> contendo os dados do arquivo do Data JSON. As opções
contêm o remoteOptions e o filesMap, que contém os IDs de quaisquer documentos de conteúdo que foram
criados.
Por padrão, os elementos Arquivo e Imagem aceitam um tamanho de arquivo de até 2 GB.
Adicionar um arquivo ou imagem ao OmniScript

Adicione e configure um elemento File ou Image para permitir o upload de arquivos e imagens. Por padrão, os
elementos Arquivo e Imagem aceitam um tamanho de arquivo de até 2 GB.
NOTA
Os elementos Image e File não funcionam na visualização porque usam componentes SFDC.
Quando os elementos Image e File são necessários em uma etapa, a visualização não pode
avançar além da etapa. A Vlocity recomenda marcar os elementos File e Image como obrigatórios
somente antes de ativar o OmniScript.
1. No OmniScript, em Componentes Disponíveis, arraste o elemento Arquivo ou Imagem da seção Entradas

para uma Etapa no painel Estrutura.
2. No campo Content Parent Id , insira uma ID de objeto ou uma lista separada por vírgulas de IDs de
objeto, para anexar o Documento de Conteúdo a um registro pai. Quando deixado em branco, o
Documento de Conteúdo não é anexado a um registro pai.
3. (Opcional) Ao configurar o elemento Image, permita uploads de várias imagens marcando Permitir várias
imagens .
4. (Opcional) Use um dos nomes de nós JSON de Image e File para aplicar uma condição a outro elemento:
"yourFileElementName": [
{
"dados": "0693g000000T1ZFAA0",
"filename": "isolated-on-png.png",
"vId": "0683g000000T11iAAC",
"tamanho": 8234
}
]
company
Propriedades do arquivo
Esta página contém informações sobre Propriedades do elemento Arquivo.
ID pai do conteúdo Insira uma lista separada por vírgulas de IDs de objetos para anexar o Documento de Conteúdo aos Registros Pais. Quando
deixado em branco, o Documento de Conteúdo não é anexado a um registro pai. Observação: uploads de imagens e
arquivos não funcionam na visualização.
Carga extra Envia pares de chave/valor adicionais. Suporta sintaxe de campo de mesclagem.
Aula Remota Especifique uma classe de interface aberta Vlocity.
Método remoto Especifique um método de interface aberta Vlocity.
Opções remotas Pares de chave/valor que especificam opções de invocação de classe adicionais.
Veja também
• Carregar arquivos e imagens em OmniScripts

Propriedades da imagem
Esta página contém informações sobre Propriedades do elemento Image.
Permitir várias imagens Permite que os usuários carreguem várias imagens de uma só vez.
ID pai do conteúdo Insira uma lista separada por vírgulas de IDs de objetos para anexar o Documento de Conteúdo aos Registros Pais.
Quando deixado em branco, o Documento de Conteúdo não é anexado a um registro pai. Observação: uploads de
imagens e arquivos não funcionam na visualização.
Carga extra Envia pares de chave/valor adicionais. Suporta sintaxe de campo de mesclagem.
Aula Remota Especifique uma classe de interface aberta Vlocity.
Método remoto Especifique um método de interface aberta Vlocity.
Opções remotas Pares de chave/valor que especificam opções de invocação de classe adicionais.
Veja também
• Carregar arquivos e imagens em OmniScripts

Integrando DocuSign com OmniScript

Como usuário do DocuSign, você pode criar OmniScripts que preencham os modelos do DocuSign e permitir
que o usuário os assine diretamente do OmniScript (Ação de assinatura do DocuSign) ou envie por e -mail uma
cópia do documento para assinar conforme sua conveniência (Ação de envelope do DocuSign).
Esses recursos exigem uma conta ativa do DocuSign, mas não exigem o DocuSign para Salesforce ou o
DocuSign Connect. Para integração ideal entre DocuSign e Salesforce, a Vlocity recomenda um desses
produtos.
Preparando um modelo DocuSign para OmniScript
Você pode preencher um documento DocuSign usando elementos de um OmniScript. O documento DocuSign
pode então ser enviado por e-mail para um ou mais signatários usando a Ação de Envelope DocuSign. O
documento também pode ser assinado no OmniScript usando a ação de assinatura do DocuSign.
Para preparar um modelo DocuSign para OmniScript, você deve ter os seguintes itens:
• Conta DocuSign
• Conta do DocuSign para Salesforce
company
Vinculando sua organização do Salesforce à sua conta do DocuSign
1. Na guia Configuração do Vlocity DocuSign, clique em Modificar configuração do DocuSign .

2. Adicione seu Nome de conta , ID de conta e selecione o tipo de organização, Demo ou Produção .
4. Da Configuração | Segurança | Configurações do Site Remoto , adicione o endpoint DocuSign correto. Os
endpoints podem incluir:
• https://www.docusign.net
• https://na2.docusign.net
• Entre em contato com a DocuSign se esses endpoints estiverem incorretos para sua conta.
Preparando documentos do DocuSign

Configure documentos DocuSign para uso com OmniScript.
1. Na guia Administrador do DocuSign, clique em DocuSign .

O DocuSign é aberto em uma nova guia ou janela do navegador.
2. Clique em Modelos e, em seguida, clique em Novo modelo .
3. Adicione um documento e, em seguida, adicione um destinatário.
4. Selecione Placeholder como o tipo de destinatário e adicione uma Função para o Placeholder .
5. Selecione se o Placeholder precisa assinar, receber uma cópia ou visualizar o documento.
6. Adicione mais espaços reservados e defina uma ordem de assinatura, se necessário.
7. Edite o assunto e o corpo do e-mail padrão e clique em Avançar .
8. Prepare o formulário arrastando os campos da paleta para o formulário. O Vlocity oferece suporte a
campos de mapeamento de um OmniScript para campos de texto, botão de opção e caixa de seleção do
DocuSign.
9. Adicione um rótulo de dados a cada campo. Esse rótulo aparecerá no DataRaptor quando você criar os
mapeamentos de transformação do OmniScript para o documento DocuSign.
Vinculando um modelo do DocuSign ao Vlocity

Voltando ao Salesforce, na guia Configuração do Vlocity DocuSign, clique em Buscar modelos do DocuSign .
Todos os modelos salvos aparecem na lista de modelos do DocuSign.
Campos de mapeamento do OmniScript para o modelo DocuSign

Para preencher um modelo do DocuSign, defina o JSON de saída do OmniScript como entrada para uma
transformação DataRaptor, que usa esses dados para preencher o modelo. Para compor o JSON de saída,
mapeie os dados do JSON de dados para o JSON de saída da seguinte forma:
1. Clique em um elemento na tabela Mapeamentos de Dados.
2. Clique no campo Caminho de saída .
3. Selecione o nome do campo correspondente no modelo DocuSign.
4. Repita para todos os campos restantes a serem mapeados.
5. Quando terminar, inspecione a seção JSON de saída para certificar-se de que todos os campos do modelo
foram mapeados.
Depois de concluir esta etapa, você pode criar uma ação de envelope do DocuSign ou uma ação de assinatura
do DocuSign (somente v12) em seu OmniScript.

company
Preenchendo um modelo do DocuSign usando o DataRaptor Transform
Depois de criar um OmniScript que coleta os dados exigidos pelo seu modelo DocuSign, defina um DataRaptor
Transform que preenche o modelo, da seguinte forma:
1. Na guia Vlocity DataRaptor, clique em Novo .

2. Para Tipo de Interface , selecione Transformar .
3. Quando solicitado, especifique um nome exclusivo para a transformação e especifique as configurações
da seguinte forma:
• Tipo de Interface : Transformar
• Tipo de entrada : JSON
• Tipo de saída : DocuSign
• ID do modelo do DocuSign de saída de destino : escolha o modelo que seu OmniScript foi projetado
para preencher.
Salve suas configurações.
4. (Opcional) Para facilitar o mapeamento, copie o JSON de dados do OmniScript e cole-o no painel Input
JSON no DataRaptor Designer.
5. Na guia Saídas , mapeie os campos do JSON de saída de seu OmniScript para os campos de entrada do
modelo DocuSign.
NOTA
Se você atualizou seu modelo do DocuSign, deve buscar os modelos do DocuSign para
atualizar os campos de entrada. Para obter mais informações sobre como buscar modelos,
consulte Vinculando o modelo do DocuSign ao Vlocity .
Usando a ação de assinatura do DocuSign para assinar documentos de dentro de um

OmniScript
Depois de preparar o modelo do DocuSign e mapear os campos do OmniScript para o modelo usando o
DataRaptor, crie uma ação de assinatura do DocuSign no OmniScript. Quando a ação é executada, um modal é
aberto contendo o documento pré-preenchido. O usuário deve realizar uma ação no documento antes de
continuar o OmniScript. Eles podem assinar ou se recusar a assinar o documento.
NOTA
Para usar uma ação de assinatura do DocuSign com OmniScript em uma comunidade, adicione esta
permissão de página do Visualforce a qualquer perfil usando o OmniScript:
OmniScriptLwcDocuSignViewPdf .
Quando o modal é aberto, um nó é gravado no Data JSON do OmniScript neste formato:
"DocuSignElementName": [
{
"status": Recusado",
"envelopeId":"xyz123"
},
{
"status": Concluído",
"envelopeId":"xyz123"
}
]

company
Um novo status e envelopeId são gerados toda vez que o modal é iniciado. Os status incluem Concluído,
Recusado e Em processamento.
Para criar uma ação de assinatura do DocuSign:
1. No OmniScript Designer, arraste um elemento DocuSign Signature Action da seção Actions para uma
etapa ou bloco do formulário, onde ele é renderizado como um botão.
2. Nas propriedades do elemento, selecione um modelo do DocuSign.
3. Insira um nome de assinante, email e função de modelo. As funções de modelo são configuradas durante
a configuração do modelo. Campos de mesclagem de suporte de nome do signatário e email do
signatário. Por exemplo, %firstName% %lastName% mesclaria o conteúdo dos campos firstName e
lastName no campo Signer Name durante o tempo de execução.
4. Adicione um assunto de e-mail que os destinatários recebem após a assinatura.
5. (Opcional) Insira um URL de retorno do DocuSign que será exibido no modal após a conclusão da
assinatura.
6. Expanda a seção Send/Response Transformations e selecione a Interface DataRaptor que foi criada para
mapear os campos OmniScript para o DocuSign Template.
7. (Opcional) Os OmniScripts usam window.parent.postMessage para postar o status no Omniscript da
página de retorno do Docusign. Se você estiver substituindo OmniScriptDocuSignReturnPage em seu
OmniScript, poste o status de docusign de volta para OmniScript usando window.parent.postMessage.
Para obter mais informações, consulte Exemplo:
window.addEventListener('DOMContentLoaded', function(evento){
var domClass = '';
var searchStr = event.currentTarget.location.search; searchStr =
searchStr.substring(searchStr.indexOf('&event='), searchStr.length);
searchStr = searchStr.substring(searchStr.indexOf('=') + 1,searchStr.length);
if(searchStr === 'signing_complete') {

domClass = document.getElementById('signing_complete');
domClass.style.display = 'bloco';
} senão {
domClass = document.getElementById('signing_failed');
domClass.style.display = 'bloco';
}
_window.parent.postMessage(searchStr, '');_*
});
Usando a ação de envelope do DocuSign para enviar documentos por e-mail para
assinatura
Depois de terminar de preparar o modelo do DocuSign e mapear os campos do OmniScript para o modelo
usando o DataRaptor, você pode criar uma ação de envelope do DocuSign no OmniScript. Quando a ação é
executada, um DocuSign Envelope contendo o documento pré-preenchido é enviado por e-mail para um ou
mais destinatários para assinatura ou revisão.
Para criar uma ação de envelope do DocuSign:

company
1. No OmniScript Designer, arraste um elemento DocuSign Envelope Action da seção Actions para a paleta.
Para executar a ação automaticamente, coloque-a entre as etapas. Para executar a ação quando o
usuário clicar em um botão, coloque-o em uma etapa.
2. Nas propriedades do elemento, selecione um modelo do DocuSign.
3. Clique em Adicionar destinatário e insira um nome de assinante, email e função de modelo.
As funções de modelo são configuradas durante a configuração do modelo. As funções Nome do
Signatário e E-mail do Signatário oferecem suporte a campos de mesclagem. Por exemplo , %firstName%
%lastName% mesclaria o conteúdo dos campos firstName e lastName no campo Signer Name durante o
tempo de execução.
4. Se você tiver mais de um destinatário, poderá substituir a ordem de roteamento definida no modelo
inserindo um novo pedido no campo Ordem de roteamento . Deixe o campo em branco para usar a
ordem de roteamento padrão.
5. Adicione um assunto e corpo de e-mail que os destinatários recebem junto com o envelope.
6. Expanda a seção Send/Response Transformations e selecione a Interface DataRaptor que foi criada para
mapear os campos OmniScript para o DocuSign Template.
Gerenciando OmniScripts
Os tópicos a seguir explicam como gerenciar seus OmniScripts.
Exportar OmniScripts
Exporte OmniScripts em um DataPack para compartilhá-los com outras organizações do Salesforce.
Saiba mais sobre DataPacks. Consulte Migração de dados com OmniStudio

DataPacks .
1. Na guia inicial do OmniScripts ou diretamente no OmniScript, clique na seta suspensa do menu.
2. Clique em Exportar .
3. Clique em Avançar e siga as etapas que aparecerem. Um arquivo DataPack será baixado para o seu
computador.
Qual é o próximo
Importe seu OmniScript. Consulte Importar OmniScripts .
Veja também
• Criar um DataPack
• Importar um DataPack
Importar OmniScripts
Adicione OmniScripts existentes a uma organização importando-os com um DataPack.
1. Saiba mais sobre DataPacks. Consulte Migração de dados com OmniStudio

DataPacks .
2. Exporte OmniScripts de outra organização. Consulte Exportar OmniScripts .
1. Na guia inicial do OmniScripts, clique em Importar .

2. Clique em Procurar e selecione seu DataPack.
3. Clique em Concluído e siga as etapas exibidas.
4. Abra seus OmniScripts importados.
company
Veja também
• Criar um DataPack
• Importar um DataPack
Versão OmniScripts
Crie várias versões de um OmniScript para desenvolver e testar scripts no modo de visualização antes de ativar
scripts para implantação de produção. A Vlocity recomenda não fazer nenhuma alteração em um OmniScript
de produção. Sempre que você planejar alterar um script de produção, crie uma nova versão inativa e faça
todas as atualizações na versão mais recente antes de ativar.
1. No OmniScript, clique em Nova versão .

2. Digite seu novo OmniScript e comece a alterar sua nova versão do script.
Veja também
• Criar um OmniScript
• Acessar o Designer OmniScript
• Visão geral do OmniScript Designer
• Configurar um OmniScript
Enviando um OmniScript por e-mail
Para enviar por e-mail um link de um OmniScript para um contato, lead ou usuário, você cria um Procedimento
de integração que usa uma ação remota para enviar o e-mail e chamar o Procedimento de integração de um
OmniScript ou de um código Apex.
Por exemplo, um agente de seguros que exige detalhes sobre um cliente potencial pode enviar um link
OmniScript para o cliente potencial por e-mail. Quando o destinatário do e-mail clica no link, seu navegador
exibe o OmniScript, contendo todos os dados que o remetente inseriu. O destinatár io preenche as
informações necessárias, permitindo que o agente crie uma cotação para eles.
O destinatário não precisa ter uma conta do Salesforce para acessar o OmniScript, mas deve ter um registro de
contato, lead ou usuário contendo seu endereço de email e as permissões necessárias para visualizar o script.
O destinatário pode precisar fazer login para visualizar o e-mail.
Para implementar esse recurso, você cria os seguintes componentes:
• Um modelo de e-mail contendo os campos de mesclagem obrigatórios

• Um Procedimento de Integração contendo uma ação remota que invoca o método de envio de email,
passando os parâmetros necessários
• No OmniScript, uma ação de Procedimento de integração que chama o procedimento de integração de e -
mail As seções a seguir fornecem detalhes sobre como criar os componentes necessários.
Criando o procedimento de integração de e-mail

Para enviar o email, crie um Procedimento de Integração contendo uma ação remota com as seguintes
configurações:
• Classe Remota: PadrãoOmniScriptSendEmail

• Método remoto: emailOmniScriptLink
company
Na seção Opções remotas , defina os seguintes pares de chave/valor obrigatórios, além de quaisquer campos
de mesclagem exigidos pelo modelo de email:
• Idioma : linguagem OmniScript. Para OmniScripts em vários idiomas, defina como "Multi-Language" e
defina o parâmetro LanguageCode como o código de idioma do Salesforce .
• Tipo : tipo OmniScript.
• Subtipo : subtipo OmniScript.
• emailTargetObjectId : O Id do destinatário (contato, lead ou usuário).
• emailTemplateName : o nome do modelo exclusivo do Salesforce.
• saveAsActivity : Defina como true se desejar que um registro de atividade seja criado quando o email for
enviado.
• LanguageCode : para OmniScripts multilíngue, o código de idioma do Salesforce.
Essa ação remota cria um registro OmniScript com o Tipo, Subtipo e Idioma especificados. Antes que o
OmniScript seja salvo, todas as ações anteriores à primeira etapa são executadas, o que permite que você
preencha previamente as informações sobre o contato, lead ou usuário. A Ação Remota mescla os dados no
modelo de email e envia o email.
Para testar o Procedimento de Integração, vá para a guia Visualização e defina um parâmetro de entrada
denominado "contextId" que contenha a ID de um Contato, Lead ou Usuário válido que tenha um endereço de
e-mail válido. Quando estiver convencido de que o Procedimento de Integração funciona conforme d esejado,
ative-o.
Especificando a Ação do Procedimento de Integração

No OmniScript, no ponto em que você deseja que o email seja enviado, adicione uma ação de Procedimento
de Integração com as seguintes configurações:
• Chave de procedimento de integração: Email_Action

• Carga Extra:
• Chave: contextId
• Valor: o ID do contato para quem você deseja enviar o e-mail.
O OmniScript deve fornecer o ID do contato no nó contextId da carga JSON que é enviada para o Procedimento
de Integração.
Para verificar se você configurou todas as configurações corretamente, visualize o OmniScript e verifique o e -
mail resultante.
Criando o modelo de e-mail

Defina um modelo de e-mail contendo o texto desejado. O tipo de modelo de email deve ser Personalizado
(sem usar papel timbrado) . No modelo, especifique o URL que vincula ao OmniScript usando o seguinte
formato:
https://<instance>/apex/OmniScriptUniversalPage?layout=lightning#/OS/
%OmniScriptInstanceId%/scriptState/saveAndResume/true/true
No modelo de email, use campos de mesclagem no estilo Salesforce (formatados como {!object.field}) para
incorporar dados do Salesforce e campos de mesclagem no estilo Vlocity (formatados como %fieldname%)
para incorporar dados fornecidos pelo Procedimento de Integração.
Por exemplo:

company
Olá, {!Nome}:
Aqui está um link para o OmniScript que você solicitou:
https:///myorg.visual.force.com/apex/OmniScriptUniversalPage?
layout=newport&AccountId=%accId%&OmniScriptInstanceId=%instanceId
%&scriptMode=vertical&loadWithPage=false&LanguageCode=%LanguageCode%#/
Obrigado,
%SenderName% %Name%
Incorporar FlexCards em um OmniScript

Incorpore um componente Web FlexCard Lightning em um OmniScript usando o elemento LWC personalizado
. Os FlexCards podem receber dados do OmniScript e realizar qualquer ação disponível no FlexCard.
1. Certifique-se de que seu FlexCard inclui suporte OmniScript. Consulte Ativar suporte a OmniScript em um FlexCard .
2. (Opcional) Configure um FlexCard para receber dados do OmniScript. Consulte Passar dados de um LWC OmniScript para um FlexCard
incorporado .
1. Em um OmniScript, arraste o elemento Custom LWC para um Step .
2. Nome do componente da Web do Lightning LWC personalizado , insira o nome do componente FlexCard
e anexe cf ao início do nome. Por exemplo, um FlexCard chamado Account Card deve ser inserido como
cfAccountCard .
3. Em Property Name , insira uma propriedade que o FlexCard espera receber convertendo a propriedade
em um formato de atributo HTML. Três opções permitem que você passe dados para o FlexCard do seu
OmniScript. Cada opção de dados requer que você passe dados como um atributo HTML. Por exemplo, se
um FlexCard recebe a propriedade recordId , você deve inserir record-id no campo de nome da
propriedade para passar a propriedade corretamente.
Opção de nome Descrição Exemplo Configuração do FlexCard
de propriedade

company
ID de registro Passe um ID de registro para um FlexCard usando a Consulte Passar o RecordId de um
propriedade recordid . Os FlexCards usam ids de registro OmniScript para executar uma consulta
para realizar consultas de dados. em um
FlexCard
atributo pai Passe um objeto pai contendo atributos pai como Consulte Passar um objeto pai de um
Parent.id para o FlexCard. Use campos de mesclagem em LWC OmniScript para executar uma
consultas e campos FlexCard. consulta em um FlexCard
Opção de nome Descrição Exemplo Configuração do FlexCard

de propriedade
dados-pai Mapeie dados para campos FlexCard diretamente Veja os dados do mapa de um LWC
sem executar uma consulta. A propriedade parent- OmniScript para um incorporado
E data é um booleano que o FlexCards usa para FlexCard
determinar se deve executar uma consulta ou analisar
registros um conjunto de registros.
4. Em Origem da propriedade , usando a sintaxe do campo de mesclagem, insira uma destas opções com
base no nome da propriedade:
Nome da propriedade Origem da propriedade
ID de registro Insira um nó JSON que contenha. Por exemplo, para passar um ID de registro armazenado no nó ContextId, insira
%ContextId% .
atributo pai Insira um nó JSON contendo um objeto.
dados-pai Defina a fonte de propriedade dos dados dos pais como true .
E Defina registros iguais a um objeto contendo um registro ou uma matriz de registros. FlexCards analisa esses registros e
mapeia os nós para campos FlexCard.
registros
5. (Opcional) Renderize e atualize o estado de salvamento do FlexCards sempre que um usuário navegar
para a etapa executando estas ações:
a. No FlexCards Designer, desative o suporte a OmniScript.
b. No OmniScript Designer, abra o elemento Custom LWC e marque Standalone Mode . Para obter
informações sobre LWCs personalizados autônomos, consulte Criar um componente Web do
Lightning personalizado autônomo .
6. (Opcional) A partir do Summer '21, forneça itens selecionáveis em seu OmniScript usando FlexCards.
Consulte Selecionar itens em um FlexCard para atualizar um OmniScript .
7. Salve e ative o script.
8. Visualize o OmniScript.
NOTA
Os OmniScripts que usam componentes Web personalizados do Lightning devem estar ativos
para visualizar o OmniScript.
Veja também
• Passar dados de um LWC OmniScript para um FlexCard incorporado
• Passe o RecordId de um OmniScript para executar uma consulta em um FlexCard
Referência Leia-me do OmniScript

Esta página lista os ReadMes de componentes da Web do Lightning disponíveis para OmniScripts. Estenda os
componentes da Web do Lightning para adicionar estilo e comportamento personalizados. Para obter
informações sobre como personalizar LWCs do OmniScript, consulte Criar um componente Web do Lightning
personalizado para OmniScript . Para obter informações sobre como configurar elementos OmniScript,
consulte Referência de elementos OmniScript .

company
Faça download dos arquivos HTML, CSS e ReadMe para cada componente da Web do Lightning disponível em
um arquivo.
LeiaMes OmniScripts LWC
Download
ReadMes de componentes básicos

Os elementos LWC OmniScript estendem os componentes básicos nesta tabela.
LWC Descrição
Elemento Atômico OmniScript O componente base para elementos de entrada do

OmniScript.
Ação básica do OmniScript O componente base para elementos de ação do
OmniScript.
Elemento base OmniScript O componente base para o LWC OmniScript.
Elemento de grupo OmniScript O componente base para elementos do Grupo OmniScript.
Mixin ReadMes
LWC Descrição
Mistura de base OmniScript Permite que LWCs personalizados que não substituem o LWC de um elemento OmniScript interajam com o
OmniScript por meio do elemento LWC personalizado. Consulte Estender o componente OmniScriptBaseMixin .
Combinação de opções do Fornece lógica de opções para qualquer LWC no OmniScript.

OmniScript
Validação OmniScript Fornece opções de validação para qualquer LWC no OmniScript.

company
Crie componentes e aplicativos de interface do usuário específicos do setor e centrados no cliente na
plataforma Salesforce com OmniStudio FlexCards. Exiba informações de objetos do Salesforce junto com ações
OmniStudio FlexCards
distintas e clicáveis que mudam de acordo com o contexto em que aparecem e com base nas informações que
contêm.
Crie e projete FlexCards com o FlexCard Designer, uma ferramenta declarativa com uma interface de arrastar,
edição WYSIWYG e interfaces gráficas de usuário para estilizar elementos individuais. Consulte FlexCard
Designer .
Os FlexCards são criados com o modelo de programação do Lightning Web Components. Consulte
Componentes da Web do OmniStudio Lightning .
A criação de componentes de interface do usuário com FlexCards tem tudo a ver com fornecer os dados e
exibir e organizar as informações retornadas de maneira significativa.
Cartões
O componente FlexCard contém uma combinação de informações pertinentes e links para processos dentro de
um contexto específico com base na fonte de dados fornecida.
Por padrão, um FlexCard percorre os registros retornados de sua fonte de dados e exibe a lista de registros em
contêineres chamados cartões. Esses cartões renderizados são visíveis em tempo de execução no FlexCard
Designer na visualização e em um componente FlexCard ativo publicado em uma página do Lightning ou da
Comunidade.
Um cartão de conta, por exemplo, pode incluir informações de conta exclusivas, como:
• Status
• Prioridade ou acordo de nível de serviço
• Data de criação
• Logo da empresa
As ações em um cartão de conta podem incluir:
• Fechando um caso
• Abrindo um novo caso
• Criando uma tarefa
Cada ação pode iniciar um OmniScript. Dependendo do tipo de ação, uma ação também pode atualizar um
OmniScript, disparar um evento, abrir um endereço da Web ou aplicativo da Web, exibir um submenu ou
atualizar um valor de campo. Consulte Adicionar uma ação a um FlexCard .
Flyouts
Você pode criar um cartão para iniciar uma ação que, quando clicada, abre um cartão filho, um LWC
personalizado ou um OmniScript incorporado em um popover ou janela. Um submenu de cartão contém
informações e ações adicionais relacionadas ao cartão pai. Consulte Iniciar um Flyout de uma Ação em um
FlexCard .

company
Fontes de dados
Escolha entre várias opções de fonte de dados para recuperar dados para exibir dados de um objeto ou API do
Salesforce em seu FlexCard. Para obter uma lista de possíveis tipos de fonte de dados, consulte FlexCards Data
Source Reference .
Design e layout
Construa um FlexCard arrastando elementos para sua tela. Adicione campos de dados, ações, tabelas de
dados, gráficos, menus, ícones, imagens e muito mais. Consulte Adicionar elementos a um FlexCard .
Atualize a aparência de cada elemento com as interfaces gráficas do usuário disponíveis no painel Estilo
quando um elemento é clicado. Por exemplo, para atualizar o texto de um campo de dados, você pode inserir
o nome de uma fonte e alterar a cor do texto com uma interface do seletor de cores. Consulte Elementos de
estilo FlexCard .
Torne seu FlexCard responsivo definindo larguras para pontos de interrupção da janela de visualização
disponíveis. Consulte Criar elementos responsivos em um FlexCard .
Opções de publicação
Depois de ativar seu FlexCard, que gera um componente Web do Lightning para adicionar a uma página do
Lightning ou da Comunidade, você pode configurar as opções de publicação. Por exemplo, configure o ícone
do seu componente e onde seu componente pode ser publicado. Consulte Configurar opções de publicação
em um FlexCard .
Implantar FlexCards
Depois de ativar um FlexCard, você pode adicionar o LWC gerado a uma página do Lightning ou da
Comunidade. Consulte Adicionar um FlexCard a uma página do Lightning . Consulte Adicionar um FlexCard a
uma página da comunidade .
A partir do verão de 2121, implemente FlexCards fora da plataforma com OmniOut para FlexCards. Consulte
OmniOut .
Desenhista de FlexCard
O FlexCard Designer é uma ferramenta declarativa com uma interface de arrastar e edição WYSIWYG que
facilita a criação de componentes da Web do Lightning da interface do usuário (UI) sem código. Construa
interfaces ricas em informações e com ações relevantes para o contexto do seu cliente. Você também pode
criar a aparência do seu FlexCard estilizando elementos individuais de interfaces gráficas de usuário (GUIs)
incorporadas ao designer.

company
Cabeçalho (1), Tela (2), painel Construir (3), painel Propriedades (4), painel Estilo (5), painel Configuração (6),
Visualização (7), Ajuda no produto (8), Opções de publicação ( 9)
Destaques do FlexCard Designer

Com o FlexCard Designer, você pode:
• Construa seu FlexCard em uma tela ampla e ajustável.

• Arraste os elementos personalizáveis do painel Construir para a Tela.
• Ajuste a largura de qualquer elemento ao longo de uma grade horizontal de 12 colunas.
• Use o elemento Action para iniciar um OmniScript ou Flyout e acionar eventos personalizados ou Pubsub e
muito mais.
• No painel Estilo, personalize a aparência do seu FlexCard. Estilize elementos usando uma GUI para escolher
as cores de textos, bordas e planos de fundo, alterar o tamanho de fontes e elementos inteiros e tornar os
elementos responsivos.
• Crie um novo FlexCard e configure sua fonte de dados com um assistente passo a passo.
• Use a Ajuda no produto para aprender sobre uma propriedade ou um elemento sem sair do Designer.
• Defina as configurações de todo o FlexCard no painel de configuração, como permissões necessárias,
ouvintes de eventos, variáveis de sessão e muito mais.
• Configure os valores de metadados para o LWC gerado e atualize o ícone SVG do componente com o
recurso Opções de publicação .
• Faça download de LWCs FlexCard dentro e fora da plataforma.
• Depure seu FlexCard visualizando seus dados JSON e os logs de resposta e solicitação para suas ações e
eventos.
• Execute FlexCards fora do Salesforce com OmniOut para FlexCards.
Qual é o próximo
Explore o FlexCard Designer. Consulte Conheça o FlexCard Designer .
Conheça o FlexCard Designer
Conheça como as diferentes partes do FlexCard Designer funcionam para construir interfaces ricas relevantes
para o contexto do seu cliente. O FlexCard Designer é uma ferramenta declarativa com uma interface de
arrastar e edição WYSIWYG que facilita a criação de componentes da Web do Lightning da interface do
usuário (UI) sem código.

company
Consulte FlexCard Designer .
Cabeçalho (1), Tela (2), painel Construir (3), painel Propriedades (4), painel Estilo (5), painel Configuração (6),
Visualização (7), Ajuda no produto (8), Opções de publicação ( 9)
Cabeçalho (1)
No Cabeçalho, visualize os metadados básicos sobre seu FlexCard, como Autor, Versão Atual e Status.
Execute ações relacionadas ao seu FlexCard, como Visualizar, Clonar, Ativar, Exportar, Adicionar CSS
Personalizado, criar uma Nova Versão e acessar uma lista de recursos de um link de Ajuda. Quando o FlexCard
estiver ativo, desative e configure as opções de publicação. Além disso, baixe uma versão do FlexCard para
usar na plataforma (dentro do Salesforce) e fora da plataforma (fora do Salesforce).
As opções de publicação (9) permitem que você configure os valores de metadados do seu FlexCard LWC
gerado, como onde o componente pode ser publicado, versão da API, descrição e muito mais. Adicione
também seu próprio ícone SVG de componente personalizado para identificar seu LWC gerado nas páginas do
Criador de experiência para comunidades e do Criador de aplicativo Lightning para Lightning. Consulte
Configurar opções de publicação em um FlexCard .

company
Tela (2)
Construa seu cartão arrastando elementos do painel Build para um estado no Canvas. Reorganize, clone,
exclua e ajuste as larguras de seus elementos conforme necessário.
Teste a capacidade de resposta do seu FlexCard com o menu suspenso Viewport. Veja como os elementos são
posicionados em diferentes pontos de interrupção da viewport. Consulte Exibir um FlexCard em diferentes
pontos de interrupção da viewport .

company
Painel de construção (3)

company
Arraste os elementos do painel Build para o Canvas para construir o layout do seu FlexCard . Arraste todos os
campos disponíveis de uma fonte de dados configurada da lista Campos para um Estado. Você também pode
adicionar estados ao seu
FlexCard e incorpore LWCs personalizados e FlexCards filhos reutilizáveis . Consulte Adicionar elementos a um
FlexCard .

company
Painel de Propriedades (4)

company
Configure as propriedades do elemento no painel Propriedades quando um elemento for selecionado na Tela.
Por exemplo, quando um elemento Field é selecionado, você pode atualizar o Label, escolher o valor do
campo de dados a ser exibido, selecionar o tipo de campo e muito mais.

company
Estilo Painel (5)

company
company
seus elementos FlexCard no painel Estilo usando uma GUI que atualiza a aparência dos elementos em tempo
real . Configure planos de fundo, tamanhos, bordas, preenchimento, margens, altura, fontes e capacidade de
resposta. Consulte Elementos de estilo FlexCard .
Para necessidades de design personalizado, crie e aplique CSS personalizado. Crie classes CSS com um editor
de código no produto com recursos do Intellisense , como conclusão de código, prompts contextuais e um
seletor de cores. Aplique classes personalizadas criadas a partir do editor ou de qualquer folha de estilo
acessível ao FlexCard ou aplique estilos CSS embutidos. Consulte CSS personalizado de elementos FlexCard .
Salve as configurações de estilo em um elemento para usar em vários elementos no FlexCard . Consulte Criar
um estilo personalizado para um elemento FlexCard .
Adicione estilos condicionais com base no valor de um campo de dados. Consulte Adicionar estilos
condicionais a um elemento FlexCard .

company
Painel de Configuração (6)

company
Configure as opções globais no painel Configuração. Consulte Configurar um FlexCard no FlexCard Designer .
Atualize sua fonte de dados. Aplique permissões personalizadas para limitar o acesso ao seu FlexCard .
Rastreie dados personalizados em elementos com rastreamento ativado.
Habilite o suporte multilíngue e OmniScript , defina as variáveis de sessão, crie ouvintes de eventos e configure
as opções de repetição.
Visualização (7)
(A) Visualize seu FlexCard em tempo real para testar seu design e funcionalidade. Ver Visualização do FlexCard
Designer .
(B) Visualize como um FlexCard aparece em diferentes dispositivos, como celular, desktop e tablet com o
menu suspenso Viewport. Ver Ver um FlexCard no Diferente Pontos de interrupção da viewport .
(C) Adicione parâmetros de teste para visualizar seu FlexCard com diferentes parâmetros, como IDs de
registro e limites de paginação . Ver FlexCards Preview ' Add Test Params ' Properties .
(D) Depure seu FlexCard . Visualize o JSON de dados do seu FlexCard com o painel Data JSON . Depure
solicitações e respostas de ações e eventos com o Action Debugger . Consulte JSON de dados do FlexCard
Designer . Consulte Depurador de ações do FlexCard Designer .
Ajuda no produto (8)

company
Encontre ajuda contextual específica para um elemento ou propriedade usando o recurso de ajuda no produto
do FlexCard Designer.
(A) Acesse informações em linha sobre propriedades específicas passando o mouse sobre os ícones de dicas
de ferramentas.
(B) Visualize a documentação detalhada sobre a finalidade e a funcionalidade de um elemento ou recurso

com bandejas de ajuda deslizantes .
Qual é o próximo
Comece a construir FlexCards com o FlexCard Designer. Consulte Introdução aos FlexCards . Em seguida, crie
um novo FlexCard .
Comece com FlexCards

Os FlexCards fornecem um conjunto de componentes para a criação de componentes e aplicativos de interface
do usuário na plataforma Salesforce. Aqui estão alguns recursos importantes para ajudá-lo a navegar no
FlexCard Designer e orientá-lo em tarefas comuns.
• Desenhista de FlexCard
Use uma interface do usuário de arrastar com edição WYSIWYG para criar interfaces de usuário dinâmicas e
sensíveis ao contexto.
• Baixe os DataPacks de Amostra FlexCard
Baixe exemplos de DataPacks com elementos FlexCard configurados e implementações de recursos.
• FlexCards Contexto Variáveis
Forneça contexto para fontes de dados, ações e outros componentes em seu FlexCard com variáveis de
contexto globais e locais.
• Referência de configuração do FlexCard
Defina configurações opcionais para seu FlexCard no painel Setup do FlexCard Designer, como atualizar uma
fonte de dados, criar um ouvinte de eventos, adicionar variáveis de sessão e muito mais.
• Fonte de dados FlexCards Referência
Configure uma fonte de dados em seu FlexCard para recuperar dados de um objeto Salesforce ou de
um banco de dados externo.
company
• FlexCards Elementos Referência
Adicione elementos como ações, estados, campos de dados e muito mais para construir seu FlexCard .
• FlexCards Ações Referência
Adicione uma ação ao seu FlexCard para iniciar ou atualizar um OmniScript , navegar para uma página da
Web ou aplicativo, exibir um submenu, disparar um evento e muito mais.
• Estilo FlexCard Elementos
Configure a aparência do seu FlexCard estilizando elementos individuais e estados inteiros.
• do FlexCard Designer
Visualize seu FlexCard antes de publicar. Adicione parâmetros de teste. Use os painéis Data JSON e Action
Debugger para depurar.
• Configurar opções de publicação em um FlexCard
Defina valores de metadados e atualize o recurso SVG para seu LWC gerado no FlexCard Designer
• problemas de FlexCards Revise as dicas de solução de problemas para FlexCards .
Construa um FlexCard com o FlexCard Designer

Com o FlexCard Designer, crie, construa, projete, teste e ative um FlexCard antes de publicá-lo em uma página
do Lightning ou da Comunidade. Use uma interface de arrastar com edição WYSIWYG para visualizar enquanto
você cria interfaces de usuário dinâmicas específicas de contexto para interações com o cliente.

company
do FlexCard Designer
Criar um novo FlexCard

• Percorra um assistente de configuração de quatro etapas para criar um novo FlexCard . Ver Crie um novo
FlexCard .
• Defina as configurações básicas, como título, nome, autor, descrição e, opcionalmente, habilite a
capacidade de incorporar o FlexCard dentro de outro FlexCard .
• Selecione e configure uma fonte de dados e, quando aplicável, adicione dados de teste para preencher
campos e visualizar o FlexCard em tempo de execução.
Configurar opções de configuração
Configure opções em todo o cartão, como adicionar um ouvinte de eventos, adicionar variáveis de sessão,
desabilitar o loop de registro, limitar o acesso do usuário e atualizar as configurações da fonte de dados e
muito mais. Consulte Configurar um FlexCard no FlexCard Designer .

company
Adicionar, configurar e estilizar elementos
• Adicione e configure elementos, como campos, estados , ações e outros componentes em um FlexCard . Ver
Adicionar Elementos para um FlexCard .
• Adicione estilos para cada elemento, como cor de fundo e imagem, borda, preenchimento e margem.
Defina a altura do elemento. Atualize a aparência dos campos de texto com suporte adicionando classes
personalizadas. Crie e aplique classes personalizadas e estilos embutidos. E mais. Ver Estilo FlexCard
Elementos .
• Ative a largura de um elemento para alterar quando a janela de visualização for atualizada. Consulte Criar
elementos responsivos em um FlexCard .
Visualizar FlexCard
Visualize a aparência e a funcionalidade do seu FlexCard antes de publicá-lo em uma página do Lightning ou da
Comunidade. Consulte Visualizar um FlexCard .
Ativar FlexCard
Ative seu FlexCard para publicá-lo em uma página do Lightning ou da Comunidade. Consulte Ativar um
FlexCard .
Configurar opções de publicação

Defina valores de metadados e defina um ícone SVG de componente personalizado para o FlexCard LWC
gerado. Consulte Configurar opções de publicação em um FlexCard .
Qual é o próximo
Implante seu FlexCard LWC gerado do Lightning App Builder para uma página do Lightning ou do Experience
Builder para uma página da comunidade. Consulte Adicionar um FlexCard a uma página do Lightning . Consulte
Adicionar um FlexCard a uma página da comunidade .
Criar um novo FlexCard

Defina configurações básicas e opções de fonte de dados ao criar um novo FlexCard no FlexCard Designer.
Depois de criar um novo FlexCard , você pode atualizar opções adicionais e começar a construir sua
experiência de usuário.
Definir configurações básicas

1. Na guia FlexCards , clique em Novo .
2. Na etapa Novo FlexCard , insira o Nome do seu FlexCard seguindo as convenções de nomenclatura
exigidas. Ver FlexCard Nomeação Convenções .
3. Selecione um tema para o seu FlexCard . Selecione Lightning para usar SLDS (Salesforce Lightning Design
System) ou Newport para usar o Newport Design System.
NOTA
Você não pode alterar o tema uma vez definido. Você precisará clonar o FlexCard para alterar
o tema.
4. Atualize o Autor .

company
NOTA
Você não pode alterar o autor uma vez definido. Você precisará clonar o FlexCard para
alterar o autor.
5. (Opcional) Atualize o Título . O título é usado para encontrar seu FlexCard LWC gerado após a ativação no
Lightning App Builder e no Community Builder.
6. (Opcional) Habilite Is Child Card para incorporar o FlexCard dentro de outro FlexCard . Ver Incorporar
uma criança FlexCard Dentro de um FlexCard .
7. (Opcional) Incorpore a descrição visível na página inicial de FlexCards .
8. Clique em Avançar .
Configurar fonte de dados

1. Na etapa Selecionar tipo de fonte de dados, selecione um tipo de fonte de dados para recuperar dados
de um objeto do Salesforce ou de um banco de dados externo. Ver Fonte de dados FlexCards Referência .
3. Na etapa Selecionar Fonte de Dados , configure as propriedades da fonte de dados. Por exemplo, se você
selecionou um DataRaptor como seu tipo de fonte de dados, selecione um DataRaptor ativo , configure
parâmetros de entrada e opções adicionais. Ver Fonte de dados FlexCards Propriedades .
Insira os parâmetros de entrada de teste

1. Para inserir um parâmetro de teste como um par chave/valor:
• Se uma variável de tempo de execução tiver sido adicionada da etapa anterior Selecionar tipo de
fonte de dados , adicione o valor de teste .
• Para cada nova variável, clique em + Adicionar e insira estas propriedades:
a. Insira uma variável de tempo de execução , como recordId . Ver FlexCards Contexto Variáveis .
b. Insira um valor de teste , como um ID de registro de conta.
2. Para detalhar os dados JSON para passar um conjunto de dados específico para o FlexCard , insira o
caminho JSON no campo Caminho JSON do resultado . Por exemplo, insira Account.Cases para retornar
dados apenas do nó Cases.
3. Clique em Buscar .
4. Visualize uma tabela da resposta de teste retornada.
5. (Opcional) Clique em JSON para visualizar os resultados retornados como JSON.
O que vem a seguir
Configure opções adicionais. Consulte Referência de configuração do FlexCard .
Veja Também
• Adicionar Elementos para um FlexCard
• Visualizar um FlexCard
• Ativar um FlexCard
• Adicionar um FlexCard a uma página do Lightning
• Adicionar um FlexCard a uma página da comunidade
company
Adicionar uma ação a um FlexCard
Adicione uma ação a um FlexCard para iniciar ou atualizar um OmniScript , navegar para uma página da Web
ou aplicativo, exibir um submenu, disparar um evento ou atualizar valores de campo de dados. Por exemplo,
adicione uma ação que, quando clicada, exiba as informações de contato, em uma janela, para a página Conta
em que o FlexCard está.
Ver FlexCards Ações Referência .
1. No FlexCard Designer, arraste o elemento Action do painel Build para um estado na tela.
2. (Opcional) No painel Propriedades, atualize o nome do elemento no campo Nome do elemento .
3. Selecione o tipo de ação a ser executada na lista suspensa Tipo de ação . Por exemplo, para iniciar um
OmniScript , selecione OmniScript . Consulte Referência de Ações FlexCards .
4. Para definir configurações específicas para o tipo de ação selecionado, consulte Propriedades de ação
FlexCards .
5. Para desabilitar eventos de rastreamento por meio do OmniAnalytics , desmarque Ativar rastreamento .
6. (Opcional) Para atualizar o rótulo visível da ação, insira um novo rótulo no campo Rótulo .
NOTA
A partir do Summer '21, o Label oferece suporte a strings concatenadas. Combine texto
simples e campos de mesclagem suportados. Por exemplo , Atualizar { AccountName } .
7. (Opcional) Para atualizar o ícone de ação, no campo Ícone , execute uma destas tarefas:
• Digite o nome do ícone, como utility:arrowdown . Consulte Sistema de design Salesforce Lightning .
• Clique no ícone de pesquisa no campo de entrada e execute uma das seguintes tarefas:
• Clique para selecionar um ícone da lista disponível e clique em Salvar .
• Pesquise um ícone no campo de pesquisa, clique em um ícone para selecioná-lo e clique em Salvar .
8. (Opcional) Para mostrar um ícone sem texto, marque Mostrar somente ícone .
9. (Opcional) Para mostrar um rótulo sem ícone, marque Ocultar ícone .
10. (Opcional) Para exibir o link de ação como um botão:
a. Verificar Botão Exibir como .
b. Selecione uma opção de estilo na lista suspensa Variante . Para obter uma descrição de cada variante,
consulte Variações .
11. (Opcional) Para adicionar condições que devem ser atendidas para que o elemento seja exibido, consulte
Adicionar condições a um elemento FlexCard .
Qual é o próximo
(Opcional) Para estilizar seu elemento, clique em Estilo para abrir o painel Estilo e consulte Estilo de elementos
FlexCard .
Adicionar um evento de clique a um elemento FlexCard

Habilite um elemento em um FlexCard para executar uma ação quando clicado. Compatível Os elementos
incluem Imagem , Bloco , Ícone e Alternar .
1. No FlexCard Designer, selecione um elemento suportado na tela para adicionar uma ação. Ou arraste um
elemento suportado do painel Build para um estado na tela
2. No painel Propriedades, clique em + Adicionar ação .
3. Selecione o tipo de ação a ser executada na lista suspensa Tipo de ação . Por exemplo, para iniciar um
OmniScript , selecione OmniScript . Consulte Referência de Ações FlexCards .

company
4. Para definir configurações específicas para o tipo de ação selecionado, consulte Propriedades de ação
FlexCards .
O que vem a seguir

Visualize seu FlexCard . Consulte Visualizar um FlexCard .
ações FlexCards
Selecione entre várias maneiras de executar uma ação de um FlexCard . Crie uma ação para iniciar um
OmniScript , navegue até uma página da Web ou aplicativo, exiba um submenu, acione um evento e muito
mais.
Consulte Adicionar uma ação a um FlexCard .

Ação Modelo Descrição Referência
Nome
Cartão Execute ações no nível do cartão, como recarregar, atualizar • Adicionar uma ação para atualizar uma fonte de dados em um
a fonte de dados , definir valores, remover e selecionar FlexCard
cartões. • Adicionar uma ação para atualizar valores de campo em um
FlexCard
• Adicionar uma ação de recarga a um FlexCard
• Adicionar uma ação de remoção a um FlexCard
• Selecionar itens em um FlexCard para atualizar um OmniScript
Personalizado Evento Dispare um evento personalizado para notificar o Acionar um evento personalizado de uma ação em um FlexCard
FlexCard pai sobre a ocorrência de um evento.
Voar para fora Exiba informações adicionais de um cartão filho, Lançar um Flyout de uma Ação em um FlexCard
OmniScript ou LWC personalizado em uma janela ou
popover.
Navegar Adicione ações diretamente em um cartão selecionando Navegue de um FlexCard com a ação Navigate
um URL de destino ou um tipo de referência de página que
permite a navegação no Lightning Experience, nas
Comunidades ou para um endereço da Web externo
OmniScript Inicie um OmniScript a partir de um FlexCard . Iniciar um OmniScript a partir de um FlexCard
PubSub Evento Dispare um evento PubSub para notificar outro Acionar um evento Pubsub de uma ação em um FlexCard
componente em uma página ou aplicativo sobre a
ocorrência de um evento.
Atualizar Atualize um OmniScript de um FlexCard incorporado Atualizar um OmniScript de um FlexCard
OmniScript como um LWC personalizado em um OmniScript .
Veja Também
• FlexCards Ação Propriedades
• FlexCards Ação Estilo Propriedades
FlexCards Ação Propriedades

As propriedades do elemento de ação são configuráveis no painel Propriedades no FlexCard Designer quando
você seleciona um elemento de ação. Com o elemento Action, crie uma ação para iniciar um OmniScript ,
navegue até uma página da Web ou aplicativo, exiba um submenu, acione um evento e muito mais.
Consulte Referência de Ações FlexCards . Consulte Adicionar uma ação a um FlexCard .

company
NOTA
A partir do Summer '21, o elemento Action oferece suporte a strings concatenadas. Combine texto
simples e campos de mesclagem compatíveis, como { Parent.prodType } > {Name} , nos seguintes
campos:
• Ação > Rótulo

• Ação do cartão > Definir valores > Valor
• Ação do evento > Parâmetros de entrada > Valor
Propriedades do tipo de ação comum

Essas propriedades são compartilhadas por todos os tipos de ação.
Propriedade Descrição Referência
Ação Modelo Selecione o tipo de ação a ser executada. FlexCards Ações Referência .
Condições Adicione uma condição que deve ser atendida para que o elemento seja Adicionar condições a um FlexCard
exibido. Elemento
Botão Exibir como Marque para exibir a ação como um botão. n/D
Elemento Nome O nome do elemento como visto na tela. Usado para distinguir um FlexCard Nomeação Convenções
elemento do outro conforme você constrói seu FlexCard no designer. É
usado só dentro de o desenhista.
Ativar rastreamento Habilite o rastreamento de eventos baseado em cliques por meio do Ativar rastreamento em um FlexCard
OmniAnalytics . Acompanhe o evento de ação da interface do usuário.
Esconder Ícone Marque para ocultar o ícone e mostrar apenas o rótulo. n/D
Ícone Digite o nome do ícone, como utility:down , ou clique no campo para n/D
procurar um ícone.
Etiqueta Insira um rótulo visível para o elemento. n/D
Mostrar apenas ícone Selecione para mostrar um ícone sem rótulo. n/D
Variante Selecione entre os estilos SLDS predefinidos para alterar a aparência do n/D
elemento.
Ação do cartão
Essas propriedades são exclusivas da ação do cartão .
Campo selecionável Selecione um campo de dados com valor booleano (verdadeiro ou falso), que quando verdadeiro, pré -seleciona o
registro do cartão.
Selecionável Modo Selecione se um usuário pode selecionar um registro único ou vários registros.
Lista de Cartões Selecionados Insira o nome da matriz da qual adicionar ou remover os cartões selecionados.
Nome
Modelo Selecione o tipo de ação a ser iniciada.
Tipos de ação de cartão

Esta tabela lista as descrições dos tipos de ação de cartão disponíveis.
Modelo Descrição
recarregar Recarrega a FlexCard .
Remover Remove um cartão do componente FlexCard . Por exemplo, use para notificações e alertas.
Selecionar cartões Permite que os usuários atualizem um OmniScript de uma lista de itens selecionáveis em um FlexCard . Quando o usuário
clica em um
Select Cards, aciona o evento selectcards _ e o cartão selecionado é adicionado ou removido de um array.

company
Definir valores Campo de atualizações valores .
Atualizar fonte de dados Altera a fonte de dados ou atualiza os parâmetros de uma fonte de dados existente.
Ação do evento
Essas propriedades são exclusivas da ação de evento . Consulte Acionar um evento personalizado de uma ação
em um FlexCard . Consulte Acionar um evento Pubsub de uma ação em um FlexCard .
Bolhas Marque para permitir que o evento borbulhe através do DOM.
Canal Nome Insira um nome de canal para o evento pubsub .
Composto Marque para permitir que o evento passe pelo limite de sombra.
Evento Nome Insira o nome do evento personalizado.
Evento Modelo Selecionar um evento tipo .
Parâmetros de entrada Insira parâmetros para passar dados contextuais ao evento como pares de chave/valor.
Ação de Flyout
Essas propriedades são exclusivas da ação Flyout . Consulte Iniciar um Flyout de uma Ação em um FlexCard .
Atributos Defina os atributos disponíveis no componente do submenu. Por exemplo, se um OmniScript exigir que um
ContextId seja definido, insira ContextId como Key e { recordId } como Value .
Nó de dados Para passar dados pai para o FlexCard filho , selecione um nó de dados.
Voar para fora Selecione o componente a ser exibido no submenu.
Voar para fora Modelo Selecione o tipo de componente a ser exibido.
Tipo de layout Selecione um tema para o submenu.
Abrir submenu em Selecione o tipo de contêiner do submenu. Ao habilitar um submenu como um evento clicável em um elemento
como um elemento Bloco ou Menu, esse recurso assume o padrão modal e é desabilitado porque o
posicionamento do popover não pode ser controlado.
Pré-carregar Voar para fora Habilite o componente Flyout para carregar antes de ser clicado.
Componente
Redefinir componente Sobre Redefine o componente para seu estado de carregamento quando o submenu é fechado.
Perto
Ação de navegação
Essas propriedades são exclusivas da ação de navegação . Consulte Navegar de um FlexCard com a ação
Navegar . Ver Referência de página Tipos .
Propriedade Descrição Alvo
Ação Nome Digite o nome da ação. Aplicativo
API Nome Insira o nome da API do aplicativo. Aplicativo
Destino do aplicativo O aplicativo para o qual você está navegando. Passe o appId ou Aplicativo
appDeveloperName para o appTarget .
Tipo de aplicativo O aplicativo padrão ou personalizado disponível no Iniciador de aplicativos. Aplicativo
Artigo URL O valor do campo urlName no destino Conhecimento Artigo

KnowledgeArticleVersion . O urlName é o URL do artigo.
Nome da página da comunidade O nome exclusivo da página da comunidade do Lightning. O valor de name Página nomeada da comunidade
é o valor do nome da API para uma página com suporte.

company
Componente Nome O nome do componente do Lightning no formato namespace__ Componente
componentName .
Personalizado Aba Nome O nome exclusivo da guia personalizada. Item de navegação
Parâmetros de entrada Insira parâmetros para passar dados contextuais para a ação como pares Componente , Login,
de chave/valor. Item de navegação
Nome da API do objeto O nome da API do objeto padrão ou personalizado. Para objetos Objeto
personalizados que fazem parte de um pacote gerenciado, prefixe o
objeto personalizado com ns__ , em que ns é o namespace da sua
organização.
Abrir alvo em Selecione se deseja abrir a página de destino na janela atual ou em uma Tudo
nova guia/janela.
Nome da página O nome exclusivo da página. Página nomeada
RecordId Insira o ID do registro para o qual navegar. Aplicativo
Nome da API do objeto de registro O nome da API do objeto do registro. Registro
Relação API de objeto O nome da API do objeto que define o relacionamento. Registro de relacionamento
Nome
Alvo Selecionar a Referência de página tipo . Tudo
Ação alvo Insira um nome de ação válido para chamar. Login, objeto, registro,
Registro de relacionamento
Tipo de artigo de destino Insira o nome da API do tipo de artigo. Conhecimento Artigo
ID de destino Selecione um ContextId da fonte de dados. Gravar, Gravar Relacionamento
Relacionamento Alvo O nome da API do campo de relacionamento do objeto. Registro de relacionamento
URL O URL da página para a qual você está navegando. Página da Internet
OmniScript Ação
Essas propriedades são exclusivas da ação OmniScript . Consulte Iniciar um OmniScript de um FlexCard .
ID de contexto Selecione um campo de dados para usar como ContextId , como {' AccountId '} .
Parâmetros de entrada Insira parâmetros para passar dados contextuais para a ação como pares de chave/valor.
Tipo de layout Selecione um tema para o layout.
OmniScript Selecione o OmniScript para iniciar.
Abrir alvo em Selecione se deseja abrir a página de destino na janela atual ou em uma nova guia/janela.
Página do Visualforce Substitua a página padrão do Visualforce que exibe o OmniScript .
Atualizar ação do OmniScript

Essas propriedades são exclusivas da ação Atualizar OmniScript . Consulte Atualizar um OmniScript de um
FlexCard .
Parâmetros de entrada Insira os campos de dados OmniScript para atualizar.
Nó pai Aponte para um nó de dados específico no OmniScript JSON para atualizar. Selecione nos campos de mesclagem disponíveis
na fonte de dados ou insira um nó de dados manualmente.
Navegue de um FlexCard com a ação Navigate

Navegue para um endereço da Web externo ou no Lightning Experience, comunidades do Lightning ou no
aplicativo móvel Salesforce a partir de um elemento de ação de navegação em um FlexCard . Por exemplo,
permita que um usuário navegue para uma página de registro de Política clicando em um elemento de ação
em um FlexCard que lista as Políticas de Conta.

company
NOTA
Para criar um link de e-mail, consulte Criar um link de e-mail de uma ação de navegação FlexCard .
1. No FlexCard Designer, arraste um elemento Action para um estado.

2. Selecione Navegar na lista suspensa Tipo de ação .
3. Selecione um tipo de referência de página na lista suspensa Destino .
4. Para definir configurações e opções exclusivas para o destino selecionado , consulte Ação de navegação .
5. (Opcional) Para abrir a página de destino em uma nova guia ou janela, selecione Nova guia/janela na lista
suspensa Abrir destino em .
6. (Opcional) Para configurar outras opções comuns entre todas as propriedades de Ação, consulte
Propriedades de Ação de FlexCards .
Qual é o próximo
Para estilizar seu elemento de ação, clique em Estilo para abrir o painel Estilo e consulte Propriedades de estilo
de ação FlexCards .
Criar um link de e-mail a partir de uma ação de navegação FlexCard
Permita que seu usuário envie um e-mail a partir de um link. Crie um link de email com o elemento de ação
Navigate para abrir o programa de email padrão do usuário.

2. Selecione Navegar na lista suspensa Tipo de ação .
3. Selecione Página da Web no menu suspenso Destino .
4. Insira um link mailto no campo URL . Por exemplo, digite mailto:janedoe@acme.org . Veja Tudo sobre
mailto: Links .
5. Para definir configurações e opções exclusivas para o destino selecionado , consulte Ação de navegação .
Qual é o próximo
Lançar um Flyout de uma Ação em um FlexCard

Crie um submenu para exibir informações adicionais quando um usuário clicar em uma ação em um FlexCard .
Por exemplo, um FlexCard que exibe informações da conta pode exibir o nome e o endereço de e -mail do
contato principal em um submenu.
CUIDADO
Ao incorporar um componente, confirme se ele não é chamado várias vezes. Ver Fixar Cíclico
Redundância ao incorporar FlexCard Componentes .

2. Selecione Flyout na lista suspensa Tipo de ação .

company
3. Na lista suspensa Flyout Type , selecione Child Card , Custom LWC ou OmniScripts como o tipo de
componente a ser exibido dentro do flyout.
4. Clique no campo Flyout e selecione um componente para exibir em seu flyout.
NOTA
O componente deve estar ativo para selecioná-lo na lista de componentes disponíveis.
5. (Opcional) Para usar a fonte de dados do FlexCard pai , clique em Data Node e selecione quais dados
enviar para o filho.
Nó Descrição
{ registros } Mandar todos os dados.
{ registros [#]} Envie todos os dados de um registro específico. {records[0]} = primeiro registro. {records[1]} = segundo registro. E
assim em .
{ registro } Envie apenas os dados do registro atual, como quando Repetir registros está desabilitado no painel Configuração ou
apenas um registro é solicitado de uma consulta.
{ record.FieldName } Envie o objeto de registro que pertence ao Estado. Por exemplo, se { record.Product } for um objeto ou array com
dados adicionais, selecione-o. Mas, se você quiser enviar um campo de dados, use a propriedade Attributes .
{ registro.atributos } Envie todos os atributos para o registro atual.
6. (Opcional) Para definir os atributos disponíveis no componente do submenu para uso no componente
filho, clique em + Adicionar novo ao lado de Atributos .
a. Insira o nome de um atributo no campo Chave , como ContextId de um componente OmniScript
cujo ConetxtId deve ser passado para o FlexCard .
b. Clique no campo Valor e selecione um campo de mesclagem, como {Id} . Você também pode inserir
uma variável de contexto compatível ou texto simples.
c. Para acessar o atributo no componente filho, use a variável de contexto {Parent} nos campos
suportados. Por exemplo, insira { Parent.Id } no campo Input Map Value da fonte de dados do
componente filho para usar o Account Id do pai como contextId do filho .
NOTA
A partir do Summer '21, o Value oferece suporte a strings concatenadas. Combine texto
simples e campos de mesclagem suportados. Por exemplo , { Parent.type } > { Name } .
7. (Opcional) Selecione se deseja exibir o submenu como uma janela ou popover no menu suspenso Abrir
em flyout .
NOTA
Ao habilitar um submenu como um evento clicável em um elemento, esse recurso assume o
padrão Modal e é desabilitado porque o posicionamento do popover não pode ser controlado.
8. (Opcional) A partir do Summer '21, para redefinir o componente para seu estado de carregamento
quando o submenu for fechado, selecione Redefinir componente ao fechar .
9. (Opcional) A partir do Summer '21, habilite o carregamento do componente antes de ser clicado
marcando Preload Flyout Component .
Qual é o próximo

company
Iniciar um OmniScript a partir de um FlexCard
OmniScript Angular ou LWC a partir de um elemento OmniScript Action em um FlexCard . Por exemplo, inicie
um formulário que atualize as informações da conta com base no ID da conta passado do FlexCard para o
OmniScript .

2. Selecione OmniScript na lista suspensa Tipo de ação . Ver FlexCards Ações Referência .
3. Clique no OmniScript e selecione o OmniScript para iniciar.
4. (Opcional) Na lista suspensa Página do VisualForce , selecione uma página do VisualForce para exibir o
OmniScript . Por exemplo, se você tiver um modelo personalizado para seu OmniScript , selecione a
página personalizada que você criou.
5. (Opcional) Para atualizar o layout do OmniScript , selecione Lightning ou Newport na lista suspensa Tipo
de layout .
6. No campo Context ID , insira o context Id do sObject associado ao seu OmniScript . Por exemplo, se o
OmniScript atualizar as informações da conta, seu ID de contexto será uma variável de ID de registro de
conta da fonte de dados, como { AccountId } .
7. (Opcional) Se você selecionou um LWC OmniScript , no campo Rótulo da guia do console , insira o rótulo
visível da guia do console. Por exemplo , Atualizar conta .
8. (Opcional) Se você selecionou um LWC OmniScript , em Ícone da guia Console , selecione um ícone para
exibir na subguia de um console depois que o link OmniScript Action for clicado. Por exemplo, selecione
standard:account para um OmniScript que atualiza as informações da conta.
9. (Opcional) Para passar dados contextuais como um par de chave/valor, clique em + Adicionar novo ao
lado de Parâmetros de entrada e execute as seguintes tarefas:
a. Insira um nome de variável no campo Chave . Prefixe o nome da variável com c__ , como c__name .
b. Insira o valor da variável no campo Valor .

company
10. (Opcional) Selecione se deseja abrir o OmniScript na guia atual ou em uma nova guia, selecione na lista
Qual é o próximo
Iniciar um OmniScript a partir de uma ação OmniScript em um FlexCard no Lightning

Experience
Em uma página do Lightning Experience, inicie um OmniScript a partir de uma ação OmniScript em um
FlexCard . Lançar um LWC ou um OmniScript Angular .
1. Adicione e configure o elemento OmniScript Action em um FlexCard . Consulte Iniciar um OmniScript de

um FlexCard .
2. Adicione o FlexCard a uma página do Lightning. Consulte Adicionar um FlexCard a uma página do
Lightning .
Veja também
• Recarregue um FlexCard após atualizar um LWC OmniScript em um Flyout
Inicie um LWC OmniScript a partir de uma ação OmniScript em um FlexCard em um

Comunidade
Inicie um LWC OmniScript a partir de uma ação OmniScript em um FlexCard em uma comunidade.
Antes de começar
Adicione e configure o elemento OmniScript Action em um FlexCard . Consulte Iniciar um OmniScript de um FlexCard .
1. Crie uma página de comunidade com a URL / lwcos . Insira qualquer nome como o nome da página da
comunidade. Ver Criando Personalizado Páginas com o Construtor de Comunidades .

company
2. Adicione um componente Vlocity LWC OmniScript Wrapper à página da comunidade / lwcos . Ver Lançar
um OmniScript com LWC OmniScript Embrulho .
3. Adicione o cartão à página da comunidade que inicia a ação, como a página inicial ou a página de detalhes
do registro. Ver Adicionar um FlexCard para uma página da comunidade .
Atualizar um OmniScript de um FlexCard

Crie uma ação que atualize o JSON de dados de um OmniScript do FlexCard incorporado no OmniScript . Você
pode incorporar um FlexCard dentro de um OmniScript como um LWC personalizado.
Consulte Incorporar FlexCards em um OmniScript .
Exemplo 1. Exemplo: Suspender Plano de Dispositivo Móvel

Digamos que você queira criar um FlexCard que permita que um cliente inicie o processo de suspensão de seu
plano de dispositivo móvel.
Crie o FlexCard que exibe os dispositivos disponíveis do cliente. Adicione um elemento Toggle que permite
selecionar um dispositivo. Configure uma ação Atualizar OmniScript no elemento Toggle para passar o valor da
ação (true ou false) para o OmniScript .
Em seguida, crie o OmniScript que orienta o cliente no processo de seleção do dispositivo e do intervalo de
datas de suspensão, antes de enviar a solicitação.
Antes de começar
• Crie um OmniScript . Consulte Criar um OmniScript .

2. Selecione Atualizar OmniScript na lista suspensa Tipo de ação .
3. (Opcional) Para apontar para um nó de dados específico no OmniScript JSON, clique no campo Nó pai e
em um nó da lista de campos de mesclagem ou insira o nó de dados manualmente.
Por exemplo, no exemplo acima, insira dados para apontar para o nó pai listando todos os registros.

company
4. Para passar os dados para atualização, clique em + Adicionar novo ao lado de Parâmetros de entrada .
a. No campo Chave , insira o nome do campo a ser atualizado. Por exemplo, no exemplo acima, insira
registros.
b. No campo Valor , insira o novo valor da fonte de dados do FlexCard . Por exemplo, no exemplo
acima, insira a variável de contexto {records} para passar todos os registros de ativos. Ver FlexCards
Contexto Variáveis .
6. Para estilizar seu elemento de ação, clique em Estilo para abrir o painel Estilo e consulte Propriedades de
estilo de ação FlexCards .
7. Permitir OmniScript Suporte :
a. Clique em Configuração para abrir o painel Configuração.
b. Selecionar OmniScript Suporte .
Baixe um DataPack de Ação OmniScript de Atualização de Amostra

Faça download de um DataPack de amostra que preenche previamente os dados em um OmniScript quando
um usuário clica na Ação de atualização em um FlexCard incorporado ao OmniScript . Consulte Baixar um
DataPack de Ação OmniScript de Amostra de Atualização .
Qual é o próximo
Incorpore o FlexCard dentro de um LWC OmniScript . Consulte Incorporar FlexCards em um OmniScript .
Veja também
• Visualize um FlexCard
Baixe um DataPack de Ação OmniScript de Atualização de Amostra

Baixe um exemplo de atualização do OmniScript DataPack para importar para sua organização. Crie uma ação
que atualize o JSON de dados de um LWC OmniScript do FlexCard incorporado no OmniScript .
Consulte Atualizar um OmniScript de um FlexCard .
O DataPack de exemplo demonstra como preencher previamente os dados em um OmniScript quando um

usuário clica em uma ação Atualizar OmniScript de um FlexCard incorporado ao OmniScript . O elemento de
ação FlexCard passa dados para o OmniScript .
o que está incluído

• Um demoPrefillUpdateOSActionFlexCard FlexCard com uma ação Update OmniScript que passa valores de
fonte de dados para Id e Name para um OmniScript em um nó de dados .
• Um OmniScript LWC demoPrefillUpdateOmniScriptOS com o FlexCard incorporado e um bloco de texto com
campos de mesclagem para exibir os dados recebidos.
Baixe e Importar a Pacote de dados
1. Baixe o OmniStudio para Vlocity DataPack aqui: demoPrefillUpdateOmniScriptAction.zip .

company
NOTA
Baixe o DataPack for OmniStudio for Vlocity (anteriormente Digital Interaction Platform) para
uma organização com um Vlocity Pacote de Saúde e Seguros , Comunicação, Mídia e Energia
ou Setor Público instalado.
DataPacks com os objetos OmniStudio não podem ser importados para uma organização com
objetos OmniStudio for Vlocity .
Baixe o OmniStudio DataPack aqui: demoPrefillUpdateOmniScriptAction-OmniStudio.zip .
NOTA
Baixe o OmniStudio DataPack para uma organização com o pacote OmniStudio instalado.
Se você importar objetos DataPacks com OmniStudio for Vlocity (anteriormente Digital
Interaction Platform) para uma organização com o pacote OmniStudio , os objetos serão
convertidos em objetos OmniStudio .
2. Importe o DataPack . Consulte Importar um FlexCard .

3. Se você não ativou o FlexCard ou OmniScript durante o processo de importação:
1. Na guia inicial do FlexCards , clique no demoPrefillUpdateOSActionFlexCard FlexCard , marque a
caixa de seleção e clique em Ativar .
2. Na guia inicial do OmniScripts , clique no demoPrefillUpdateOmniScriptOS OmniScript para abrir o
LWC OmniScript Designer e clique em Ativar .
4. Clique em Visualizar no OmniScript Designer.
Veja Também

Selecionar itens em um FlexCard para atualizar um OmniScript

Permita que seus usuários selecionem um ou mais itens em seu FlexCard com a ação Selecionar Cartões.
Quando o usuário clica em uma ação Select Cards, ele dispara o evento selectcards _{ listname } e o cartão
selecionado é adicionado a uma matriz. O cartão é um item de registro exibido no FlexCard . Crie um ouvinte
de eventos que escute o evento e execute uma ação Atualizar OmniScript para atualizar o JSON de dados do
OmniScript com a lista de cartões selecionados.
Use a ação Selecionar Cartões para permitir que os usuários adicionem e removam objetos de uma lista. Por
exemplo, adicione e remova vários itens de e para um carrinho ou selecione e desmarque um ou mais casos de
uma lista.
Requeridos Versões
Disponível começando no verão de 21.
1. No FlexCard Designer, arraste um elemento Action do painel Build para um estado.

company
NOTA
Para usar um elemento de alternância para selecionar itens, arraste o elemento de
alternância para um estado e adicione uma ação ao elemento. Ver Adicionar um evento de
clique para um FlexCard Elemento .
2. Selecione Cartão na lista suspensa Tipo de ação .

3. Selecione Selecionar cartões no menu suspenso Tipo .
4. Em Nome da lista de cartões selecionados , insira um nome da matriz à qual adicionar os registros de
cartão selecionados.
NOTA
Ao criar um ouvinte de eventos para escutar o evento selectcards _ , o nome da lista deve
ser todo em minúsculas, alfanumérico e não ter espaços, como selectedcases . Ver passo 7.
5. No Modo Selecionável , selecione se os usuários podem selecionar um registro de cartão único ou vários
registros de cartão.
6. (Opcional) Para pré-selecionar um registro de cartão, clique no Campo Selecionável e selecione um
campo de dados. O campo de dados deve ter um valor booleano true ou false. Quando o valor desse
campo de dados for true, esse registro de cartão será selecionado por padrão.
Por exemplo, digamos que você queira enviar uma lista de registros de casos escalados para um
OmniScript . Para pré-selecionar Casos escalados, insira o caso IsEscalated no Campo Selecionável . Na
visualização, você vê que todos os registros de cartão em que IsEscalated é verdadeiro estão
selecionados.
7. Para criar o ouvinte de eventos personalizado que executa a ação Atualizar OmniScript que passa a matriz
de registros de cartão selecionada para o OmniScript , execute estas tarefas:
a. No painel Configuração, clique em + Adicionar novo ao lado de Ouvinte de eventos e selecione
Personalizado como o Tipo de evento . Ver Adicionar um Evento Ouvinte para um FlexCard .
b. No campo Nome do evento , insira o evento selectcards _ seguido pelo nome inserido em Nome da
lista de cartões selecionados . Por exemplo , selectcards_selectectedcaseslist .
c. Selecione Atualizar OmniScript como Tipo de ação . Consulte Atualizar um OmniScript de um
FlexCard .
d. Na seção Parâmetros de entrada , clique em + Adicionar novo . No campo Chave , insira um nome
do nó de dados a ser transmitido ao OmniScript . Por exemplo , selecionado .
e. Em Valor , insira o nome inserido em Nome da lista de cartões selecionados como um campo de
mesclagem. Por exemplo , { selectcaseslist } .

company
9. No painel Configuração, selecione Suporte OmniScript .
10. Para visualizar e testar sua ação antes de publicar o FlexCard , clique na guia Visualizar.
Ao clicar na ação selecionar cartão na tela, procure isSelected : true em _flex no objeto cards do Data
JSON .
Se você inseriu um campo de dados em Campo selecionável , consulte a Etapa 6.

11. Clique em Ativar .
12. Incorpore seu FlexCard em um OmniScript como um LWC personalizado. Consulte Incorporar FlexCards
em um OmniScript .

company
Qual é o próximo
Estilize seu elemento de ação. Consulte Propriedades do estilo de ação FlexCards .
Acionar um evento personalizado de uma ação em um FlexCard

Acione um evento personalizado de um elemento de ação em um FlexCard filho ou outro elemento para
notificar o FlexCard pai sobre a ocorrência do evento. Eventos personalizados são usados para comunicação
entre um filho e seu pai, seja entre um FlexCard filho e seu pai, ou entre um elemento e o FlexCard em que
está.
Por exemplo, adicione uma ação em um FlexCard filho incorporado que, quando clicado, atualiza um valor de
elemento Field no FlexCard pai . Ou adicione uma ação em um elemento Image que, quando clicado, atualiza
um valor de campo de mesclagem em um elemento Text.
Ver Comunicar com Eventos .

2. Selecione Evento na lista suspensa Tipo de ação .
3. Selecione Personalizado na lista suspensa Tipo de evento .
4. Insira o nome do evento no campo Nome do Evento .
IMPORTANTE
Não use esses nomes reservados: reload , updatedatasource , remove .
5. (Opcional) Para permitir que o evento passe pelo limite do shadow DOM, selecione Compose . Ver
Configurar evento Propagação .
6. (Opcional) Para permitir que o evento apareça no DOM, selecione Bolhas . Ver Configurar evento
Propagação .
a. Insira um nome de variável no campo Chave .

company
NOTA
A partir do Summer '21, você pode passar uma variável de sessão como um valor usando
o
variável de contexto { Session.var } . Consulte Adicionar variáveis de sessão a um FlexCard .
9. Configure o ouvinte de eventos que executa uma ação quando o evento é acionado. Ver Adicionar um
Evento Ouvinte para um FlexCard .
Baixe um DataPack de Evento Personalizado de Amostra

Baixe uma amostra de FlexCard DataPack com uma ação de evento personalizada configurada. Consulte Baixar
um DataPack de Evento Personalizado de Amostra .
Baixe um DataPack de Evento Personalizado de Amostra

Baixe um exemplo de Custom Event DataPack para importar para sua organização. Acione um evento
personalizado a partir de um elemento Action em um FlexCard filho ou em um elemento para notificar o
FlexCard pai sobre a ocorrência do evento.
Consulte Acionar um evento personalizado de uma ação em um FlexCard .
O DataPack de exemplo demonstra como atualizar um campo de dados em um FlexCard pai a partir de um
elemento Action em um FlexCard filho incorporado .
O que é Incluído
• Um FlexCard filho , demoChildFlexCardCustomEvent , com um elemento Action que aciona um evento

personalizado, chamado triggerparent , que passa um parâmetro para o FlexCard pai ouvindo o evento.
NOTA
Ative o FlexCard filho para vê-lo no pai.
• Um FlexCard pai , demoParentFlexCardCustomEvent , com os seguintes recursos:

• Um elemento Field preenchido de uma fonte de dados SOQL Query.
• Um Event Listener configurado no painel Setup escuta o evento personalizado triggerparent do FlexCard
filho .
Importar Pacote de dados
1. Baixe o OmniStudio para Vlocity DataPack aqui: demoParentChildCustomEvent.json .

company
NOTA
Baixe o OmniStudio DataPack aqui: demoParentChildCustomEvent-OmniStudio.json .
NOTA

3. Se você não ativou o demoChildFlexCardCustomEvent FlexCard durante o processo de importação, na
guia inicial do FlexCards , clique no nome do FlexCard , marque a caixa de seleção e clique em Ativar. O
FlexCard filho deve estar ativo para visualização dentro de um pai.
4. Clique no elemento de ação Trigger Parent no demoParentFlexCardCustomEvent FlexCard para ver o
Evento Personalizado em ação.
Veja Também

Acionar um evento Pubsub de uma ação em um FlexCard

Acione um evento de um elemento de ação para notificar outro componente em uma página ou aplicativo
sobre a ocorrência do evento. Por exemplo, atualize uma lista de produtos em um FlexCard de um filtro em
outro FlexCard .
Consulte Comunicar-se no DOM .
Exemplo 2. Exemplo: Atualizar Lista de Produtos

Digamos que você queira criar uma página do Lightning que exiba uma lista filtrável de produtos. Você vai
precisar de dois
FlexCards : um para exibir os produtos e possui um ouvinte de eventos, e outro para exibir os filtros que podem
atualizar as informações do produto e possui ações que enviam eventos. Sua lista de produtos O FlexCard exibe
informações do produto e possui um ouvinte de eventos que escuta as ações executadas no Cartão de Filtro. O
Filtro O FlexCard exibe os filtros e possui um botão Aplicar que ao ser clicado envia um evento.
Quando um usuário seleciona um filtro, como <$2000 , e clica no botão Aplicar no Filtro FlexCard , apenas
produtos que custam menos de US$ 2.000 são visíveis na Lista de produtos FlexCard .

company
2. Selecione Evento na lista suspensa Tipo de ação .
3. Selecione Pubsub na lista suspensa Tipo de evento .
4. Para atualizar o canal no qual o evento é postado, insira um nome de canal . Por padrão, o nome do canal
é o nome do FlexCard .
5. Insira o nome do evento no campo Nome do Evento .
IMPORTANTE
Não use esses nomes reservados: reload , updatedatasource , remove .
a. Insira um nome de variável no campo Chave .
8. Configure o ouvinte de eventos que executa uma ação quando o evento é acionado. Ver Adicionar um
Faça o download de um DataPack de Amostra do Evento Pubsub

Baixe uma amostra de FlexCard DataPack com elementos de ação configurados para acionar eventos pubsub e
um ouvinte de eventos para escutar os eventos. Consulte Baixar um DataPack de Amostra do Evento Pubsub .
Faça o download de um DataPack de Amostra do Evento Pubsub

Faça o download de um DataPack de eventos Pubsub de amostra para importar para sua organização. Acione
um evento de um elemento Action para notificar outro componente em uma página ou aplicativo sobre a
ocorrência de um evento.
Consulte Acionar um evento Pubsub de uma ação em um FlexCard .
O DataPack de exemplo demonstra como acionar eventos que atualizam os valores dos campos de dados.
O que é Incluído
• Um demoPubSubEvent FlexCard com os seguintes elementos e funcionalidades:

• Um elemento Action configurado para acionar um evento Pubsub chamado setvalue que passa um novo
valor do elemento Field para o FlexCard .
• Um elemento Icon configurado para acionar um evento Pubsub chamado setvalue que passa um novo
valor para o elemento Field para o FlexCard .
• Um Event Listener configurado no painel Setup que escuta o evento setvalue e atualiza o valor do Field
com base nos parâmetros passados do evento.
NOTA
O Índice de Registro é definido como 1 para que apenas o valor do Campo no segundo
registro retornado da fonte de dados personalizada seja atualizado.
1. Baixe o OmniStudio para Vlocity DataPack aqui: demoPubsubEvent.json .

company
NOTA
Baixe o OmniStudio DataPack aqui: demoPubsubEvent-OmniStudio.json .
NOTA

3. Na guia inicial do FlexCards , clique no demoPubSubEvent para abrir o FlexCard Designer e clique em
Preview . A partir de aqui vocês pode clicar em ações para teste eventos .
Veja Também

Adicionar uma ação para atualizar uma fonte de dados em um FlexCard

Com uma ação de cartão, crie uma ação que altere a fonte de dados ou atualize os parâmetros de uma fonte
de dados existente. Por exemplo, crie uma ação que atualize os limites de paginação em uma lista de registros
retornados.
3. Na lista suspensa Tipo , selecione Atualizar fonte de dados .
4. Selecione um tipo de fonte de dados na lista suspensa Tipo de fonte de dados .
IMPORTANTE
Se você selecionar Consulta SOQL e Pesquisa SOSL , não poderá alterar a fonte de dados por
motivos de segurança. No entanto , você pode atualizar o parâmetros .
5. Para configurar uma nova fonte de dados, consulte Configurar uma fonte de dados em um FlexCard .
6. Para atualizar parâmetros de uma fonte de dados existente, insira novos Parâmetros ou atualize valores.
Por exemplo, em uma consulta SOQL com um limite definido como { Params.limit } , atualize o valor de
Params.limit de 10 para um número menor para mostrar menos registros por vez.
Qual é o próximo
company
Adicionar uma ação para atualizar valores de campo em um FlexCard

Com uma ação de cartão, crie uma ação que atualize valores de campo específicos em um FlexCard . Por
exemplo, permita que seus representantes de atendimento ao cliente atualizem o status de um caso para
encerrado quando o caso for resolvido.

3. Na lista suspensa Tipo , selecione Definir valores .
4. Para adicionar os campos a serem atualizados, na seção Definir valores , clique em + Adicionar novo .
5. No campo Chave , insira o nome de um campo retornado de uma fonte de dados.
6. No campo Valor , insira um novo valor de campo como uma sequência ou campo de mesclagem, como
Novo valor ou {Nome} .
Qual é o próximo
Adicionar uma ação de recarga a um FlexCard

Com uma Card Action, crie uma ação que recarrega um FlexCard . Por exemplo, crie um FLexCard que escute
um evento de outro FlexCard e se recarregue quando o evento for acionado.
Consulte Adicionar um ouvinte de eventos a um FlexCard .

3. Na lista suspensa Tipo , selecione Recarregar .
Qual é o próximo
Adicionar uma ação de remoção a um FlexCard

Com uma ação de cartão, crie uma ação que remova um registro específico em um FlexCard ou remova todo o
FlexCard . O registro de dados é removido apenas do FlexCard e não do banco de dados do qual foi extraído. O
FlexCard é removido apenas da página em que é visualizado e não excluído permanentemente.

3. Na lista suspensa Tipo , selecione Remover .
4. Para remover um registro específico, crie um Event Listener e insira um Record Index . Ver Adicionar um

company
Qual é o próximo
Adicionar elementos a um FlexCard

Construa um FlexCard no FlexCard Designer arrastando campos de dados, estados, ações e outros elementos
do painel Build para a tela. Cada elemento pode ser estilizado e as propriedades configuradas no designer.

company
Figura 12. Estrutura do FlexCard dentro do FlexCard Designer
Antes de começar
1. Crie um FlexCard e defina as configurações básicas e uma fonte de dados. Ver Crie um novo FlexCard .
2. Configure as opções de configuração conforme necessário. Ver Referência de configuração do FlexCard .
3. Saiba como o dimensionamento de elementos e a capacidade de resposta funcionam no FlexCard Designer. Ver FlexCards Elemento Capacidade
de resposta .
Adicionar, configurar e estilizar um elemento
1. Na guia FlexCards , clique em uma versão de um FlexCard para abrir o FlexCard Designer.
2. (Opcional) Para ajustar a largura da tela ao construir seu FlexCard , selecione um tamanho na
lista suspensa de tamanho da tela. Ver FlexCards Elemento Capacidade de resposta .
company
3. Para adicionar um elemento a um estado do painel Build, execute uma destas tarefas:
a. Para adicionar um elemento de uma pesquisa:
i. No campo de pesquisa, insira o nome de um elemento, como Action , ou um elemento Field,
como Email .
ii. Arraste o elemento dos resultados da pesquisa para um estado na tela.
b. Para adicionar um elemento das listas de elementos disponíveis:
• Para adicionar campos de dados, execute uma destas tarefas:
• Clique em Campos , para revelar uma lista de campos de dados disponíveis na fonte de dados e
arraste um ou mais campos para um estado na tela.
• Na lista Elementos , arraste o elemento Campo para um estado na tela.
• Para adicionar outros componentes, como uma ação, tabela de dados, menu, ícone e um LWC
personalizado, arraste o elemento da lista Elementos para um estado na tela. Ver FlexCards
Elementos Referência .
NOTA
Quando você arrasta um elemento ao lado de outro elemento, ele ocupa o restante do
contêiner. Por exemplo, se você arrastar um elemento Icon próximo a um elemento Field cuja
largura é de 10 partes da grade de 12 colunas, o elemento Icon ocupa as 2 colunas restantes.
Ver FlexCards Elemento Capacidade de resposta .
4. Para configurar o elemento, clique no elemento para atualizar suas propriedades no painel Propriedades.

company
TIP
To easily distinguish between elements, update theElement Name. When you hover
over or click an element on the canvas, the element name is viewable in a blue tab
with white text.
Beginning with the Summer '21 release, hover over the element to see its name.
5. (Opcional) Para ajustar a largura do elemento, passe o mouse sobre a caixa quadrada na borda direita até
que o ícone do ponteiro do mouse se torne um ícone de arrastar. Clique e deslize a caixa quadrada para a
direita ou para a esquerda para aumentar ou diminuir a largura.
NOTA
Para tornar a largura do elemento responsiva à janela de visualização, consulte Criar
6. (Opcional) Para estilizar seu elemento, clique em Estilo para abrir o painel Estilo e consulte Estilo de
elementos FlexCard .
8. (Opcional) Para adicionar outro estado, arraste o elemento State da lista Elements do painel Build para a
tela e siga as etapas 4 a 7. Consulte Adicionar um estado para um FlexCard .

company
NOTA
Cada FlexCard tem um estado padrão que não pode ser excluído.
9. Para reorganizar, duplicar ou excluir elementos, consulte Organizar, duplicar e remover elementos em um
FlexCard .
Qual é o próximo
Veja também
• Definir valores de metadados do FlexCard Designer
• Adicionar um ícone SVG de componente personalizado a um FlexCard
elementos FlexCards
Selecione a partir de uma série de elementos para adicionar ao seu FlexCard para construir sua interface
interativa com o cliente. Adicione elementos como campos de dados, ações, estados, tabelas de dados e muito
mais. Ver Adicionar Elementos para um FlexCard .
Elemento Elemento Descrição Elemento Propriedades Referência
Nome
Ação Renderiza o texto ou um botão que executa uma ação quando clicado. Consulte FlexCards Ação Propriedades
Adicionar uma ação a um FlexCard .
Quadra Permite agrupar elementos dentro de um contêiner recolhível. Consulte Agrupar FlexCards Quadra Propriedades
elementos dentro de um bloco em um FlexCard .
Gráfico Exibe os dados como um gráfico. Consulte Adicionar um gráfico a um FlexCard . Propriedades do gráfico FlexCards
LWC personalizado Incorpora um LWC personalizado dentro de um estado FlexCard . Consulte FlexCards Propriedades personalizadas
Incorporar um LWC personalizado em um FlexCard . de LWC
Tabela de dados Cria uma estrutura tabular a partir dos dados fornecidos. Consulte Adicionar FlexCards Tabela de dados Propriedades
uma tabela de dados a um FlexCard .
Campo Exibe a saída de um campo de dados. Consulte Adicionar um campo a um FlexCard . Propriedades do campo FlexCards
FlexCard Incorpora um FlexCard dentro de um estado. Consulte Incorporar um FlexCard FlexCards Filho FlexCard Propriedades
filho dentro de um FlexCard .
Ícone Exibe um ícone SVG personalizado ou do Salesforce. O ícone pode ser vinculado a FlexCards Ícone Propriedades
uma ação. Ver Adicionar um Ícone para um FlexCard .
Imagem Exibe uma imagem personalizada de um determinado URL. Carregue uma FlexCards Imagem Propriedades
imagem, use uma imagem da biblioteca da sua organização ou use uma fonte
externa. A imagem pode ser vinculada a uma ação. Consulte Adicionar uma
imagem a um FlexCard .
Cardápio Exibe uma lista de ações como um menu suspenso. Consulte Adicionar um menu a Propriedades do Menu FlexCards
um FlexCard .
Estado Adiciona um estado a um FlexCard . Consulte Adicionar um estado a um FlexCard . FlexCards Estado Propriedades
Texto Renderiza texto e analisa campos de mesclagem com um editor de rich text. FlexCards Texto Elemento Propriedades
Consulte Adicionar um elemento de texto a um FlexCard .

company
Alternar Acione uma ação quando um usuário seleciona um elemento Toggle. O valor é FlexCards Alternar Propriedades
enviado como parâmetro para a ação como verdadeiro ou falso, ou separado
por vírgula
lista de opções selecionadas pelo usuário. Consulte Ações de gatilho com o
elemento de alternância em um FlexCard .
Agrupar elementos dentro de um bloco em um FlexCard
Combine grupos lógicos de elementos dentro de um container dobrável com o elemento Block em um
FlexCard . Por exemplo, agrupe as informações básicas de uma conta e, separadamente, agrupe as
informações de contato da conta.
Adicionar Quadra Elemento

1. No FlexCard Designer, arraste um elemento Block do painel Build para um estado na tela.
3. (Opcional) Para habilitar a capacidade de recolher o bloco, marque Colapsível .
• (Opcional) Para exibir um rótulo visível para o elemento de bloco dobrável, insira o texto no campo
Rótulo .
NOTA
• (Opcional) Para mostrar o bloco recolhido por padrão, clique em Recolhido por padrão .
4. (Opcional) Para ativar um evento de clique no bloco, clique em + Adicionar ação . Para configurar a ação
propriedades , consulte FlexCards Ação Propriedades .
Adicionar Elementos Lado de dentro a Quadra

1. Para adicionar um elemento do painel Construir, arraste um campo da lista Campos ou um elemento da
lista Elementos para o elemento de bloco.
Por exemplo, arraste os campos Account relacionados ao endereço para um elemento de bloco, como
BillingCity , BillingCountry .
NOTA
O Nome do Elemento de qualquer novo elemento adicionado a um bloco é prefixado com a
palavra Bloco até que você atualize o nome no painel Propriedades.
2. Para adicionar um elemento em um elemento de bloco de um estado, clique, segure e arraste o elemento
para o elemento de bloco.
Qual é o próximo
Veja também
• Propriedades do Bloco FlexCards
company
Bloco FlexCards
As propriedades do elemento de bloco são configuráveis no painel de propriedades quando você seleciona um
elemento de bloco no FlexCard Designer. Com o elemento Block, combine grupos lógicos de elementos em um
contêiner dobrável. Ver Grupo Elementos Dentro de um bloco em um FlexCard .
Adicionar Ação Torne o elemento uma ação clicável. Adicionar um evento de clique a um
FlexCard Elemento
Desabou Por Se selecionado, o elemento de bloco é recolhido por padrão. n/D

Predefinição
Dobrável Torna o bloco dobrável, ocultando seu conteúdo. n/D
Condições Adicione uma condição que deve ser atendida para que o elemento seja exibido. Adicionar condições a um FlexCard
Elemento
Elemento Nome O nome do elemento como visto na tela. Usado para distinguir um elemento do FlexCard Nomeação Convenções
outro conforme você constrói seu FlexCard no designer. É usado só dentro de o
desenhista.
Etiqueta Exibe um rótulo visível para o elemento de bloco dobrável. n/D
Veja Também
Adicionar um gráfico a um FlexCard

Exiba dados em um FlexCard como um gráfico com o elemento Chart. Selecione entre os tipos de gráfico de
barras, pizza, rosca, linha e radar.
Gráfico de barras configurado
2. Arraste um elemento Chart do painel Build para um estado na tela.
4. (Opcional) Para exibir um título na parte superior do gráfico, que está oculto por padrão, atualize estas
propriedades:
• No campo Título , insira um título.

company
• Desmarcar Ocultar cabeçalho .
5. Na lista suspensa Tipo , selecione o tipo de gráfico a ser exibido.
6. (Opcional) Para ajustar as proporções do gráfico, atualize a proporção . Ver Elemento de gráfico FlexCard
Aspecto Razão .
7. (Opcional) Para definir manualmente a altura, substituindo a proporção , insira um número no campo
Altura do gráfico . A altura está em pixels, como 300px . Você pode inserir apenas o número sem o sufixo
' px ', como 300 .
NOTA
Esse recurso fica visível quando o recurso Manter proporção de aspecto está desabilitado.
8. Na lista suspensa Nó de rótulo , selecione o campo cujos valores são usados para categorizar os dados,
como Nome para exibir nomes de contas.
9. Na lista suspensa Nó de valor , selecione o campo cujos valores são usados para preencher o gráfico,
como AnnualRevenue .
IMPORTANTE
Os valores devem ser números e ter a mesma contagem que o campo selecionado em Label
Node .
10. Selecione o esquema de cores para seu gráfico na lista suspensa Paleta de cores .
NOTA
Cada paleta de cores tem até 6 cores exclusivas. Se houver mais de 6 valores em seu gráfico,
as cores se repetem desde o início.
Qual é o próximo
Veja também
• Propriedades do gráfico FlexCards
Elemento do Gráfico FlexCard

Você pode ajustar as proporções de um elemento Gráfico com os recursos Proporção, Manter Proporção e
Altura do Gráfico no FlexCard Designer. Defina a proporção para ajustar a altura em relação à largura. Defina
proporções fixas. Ou substitua a proporção e defina uma altura fixa.
A relação de aspecto é a relação largura/altura do gráfico. Por padrão, a proporção é 1, como 1:1. A largura do
gráfico é sempre a largura máxima disponível de acordo com o número de colunas que abrange na grade de 12
colunas da tela no designer. A altura é proporcional à largura do gráfico. Ajustar a proporção ajusta a altura.

company
Proporção padrão em um gráfico de 7 colunas de largura
Para tornar o gráfico mais curto, dada a largura do elemento, aumente o número da proporção. Por exemplo,
se a proporção estiver no padrão 1, insira 2 para tornar a altura cerca de metade da altura padrão. Em outras
palavras, se a largura e a altura originais de um elemento Chart de 7 colunas forem 600px e 300px, e a
proporção for 2, a altura será 150px e a largura permanecerá a mesma.
Aspect Ratio 2 em um gráfico de 7 colunas de largura
Para tornar o gráfico mais alto, dada a largura do elemento, diminua o número da proporção. Por exemplo, se
a proporção estiver no padrão 1, diminua-a para 0,5 para tornar a altura duas vezes a altura padrão. Em outras
palavras, se a largura e a altura originais de um elemento Chart de 7 colunas forem 600px e 300px, e a
proporção for 0,5, a altura será 600px e a largura permanecerá a mesma.

company
Aspect Ratio 0,5 em um gráfico de 7 colunas de largura
Para definir proporções fixas, você pode ativar o recurso Manter proporção. Quando esse recurso está
habilitado, dada a largura, a altura se torna exatamente X vezes a largura. Por exemplo, se a proporção for 1, a
largura e a altura são exatamente as mesmas para que seu gráfico seja um quadrado. Se a proporção for 2, a
altura é metade da largura. Em outras palavras, se a largura de um elemento Chart de 7 colunas for 600px e a
proporção for 2, a altura será 300px.
Proporção mantida em um gráfico de 7 colunas de largura
Para substituir a proporção, defina manualmente a altura do gráfico com o recurso Altura do gráfico. Esse
recurso fica visível quando Manter proporção de aspecto está desabilitado. A altura está em pixels, como
300px.

company
Proporção desativada, altura fixa definida em um gráfico de 7 colunas de largura
Aqui está um resumo de como a largura e a altura são determinadas com cada recurso:
Característica Largura Altura Exemplos
Aspecto Largura total do contêiner do elemento X vezes a altura padrão. X é • 1 = Largura padrão (largura total do espaço que o
Razão (conforme determinado pelo número determinado pela razão elemento ocupa na tela) e altura proporcional
de colunas que o elemento ocupa na inserida. • 2 = Largura padrão e cerca de metade da altura
tela no designer) padrão
• .5 = Largura padrão e cerca de duas vezes a altura
padrão
Manter Largura total do contêiner do elemento X vezes a largura. X é • Se a proporção for 1, a largura e a altura são as
Aspecto (conforme determinado pelo número determinado pela razão mesmas.
Razão de colunas que o elemento ocupa na inserida. • Se o Aspect Ratio for 2, a altura será metade da
tela no designer) largura .
• Se o Aspect Ratio for 0,5, a altura será o dobro da
largura .
Gráfico Largura total do contêiner do elemento O número, em pixels, inserido 300 , ou 300px .
Altura (conforme determinado pelo número neste campo.
de colunas que o elemento ocupa na
tela no designer)
Veja Também
• Adicionar um gráfico a um FlexCard

• Propriedades do gráfico FlexCards
Propriedades do gráfico FlexCards

As propriedades do elemento gráfico são configuráveis no painel de propriedades quando você seleciona um
elemento gráfico no FlexCard Designer. Com o elemento Chart, exiba dados como um gráfico e permita que os
usuários executem ações dentro do gráfico. Ver Adicione um gráfico a um FlexCard .
Aspecto Razão Insira um número para definir a altura em relação à largura. Por exemplo, se a proporção for gráfico FlexCard
2 e a largura e a altura padrão forem 600px e 300px, a largura permanecerá a mesma e a Proporção da tela
altura será metade da altura padrão em 150px.
Altura do gráfico Defina manualmente a altura do gráfico, que substitui a proporção e fica visível quando o gráfico FlexCard
recurso Manter proporção está desativado. Proporção da tela
Paleta de cores Selecione um esquema de cores predefinido. n/D
Condições Adicione uma condição que deve ser atendida para que o elemento seja exibido. Adicionar condições a um
Elemento FlexCard

company
Recortar Insira o tamanho do furo do gráfico de rosca por porcentagem. n/D
Percentagem
Elemento Nome O nome do elemento como visto na tela. Usado para distinguir um elemento do outro FlexCard Nomeação
conforme você constrói seu FlexCard no designer. É usado só dentro de o desenhista. Convenções
Ocultar cabeçalho Mostre ou oculte o título do gráfico. n/D
Nó de rótulo Selecione o campo cujos valores são usados para categorizar os dados, como Nome das n/D
contas.
Manter Aspecto Mantenha a proporção de forma que a largura e a altura sejam uma proporção fixa. Por gráfico FlexCard
Razão exemplo, se a proporção for 2 e a largura for 600px, a altura será 300px. Proporção da tela
Título Exibe um título acima do gráfico quando Ocultar cabeçalho está desabilitado. n/D
Modelo Selecione o tipo de gráfico a ser exibido. n/D
Nó de valor Selecione os valores para preencher o gráfico, como AnnualRevenue for Accounts. n/D
Veja Também
Incorporar um FlexCard infantil dentro de um FlexCard

Incorpore um FlexCard reutilizável como filho dentro do estado de um FlexCard pai . O FlexCard filho pode ter
sua própria fonte de dados. Ou o pai pode substituir a fonte de dados do filho por sua própria fonte de dados.
O pai também pode passar dados específicos para o filho, como seu recordId para usar como contextId da
fonte de dados filho .
CUIDADO
Antes de começar
• Crie um FlexCard filho . Consulte Criar um novo FlexCard .
1. No FlexCard Designer, arraste o elemento FlexCard do painel Build para um estado na tela.
3. Clique no nome do cartão campo e selecione um FlexCard reutilizável para incorporar. Ou seja, um
FlexCard onde o cartão filho está habilitado.
IMPORTANTE
Se o seu FlexCard pai estiver habilitado para Suporte OmniScript , somente um FlexCard
filho habilitado para Suporte OmniScript poderá ser incorporado. Ver Permitir OmniScript
Apoiar em um FlexCard .
4. (Opcional) A partir do Summer '21, se o seu FlexCard for um FlexCard filho com dados hierárquicos, para
adicioná-lo a si mesmo recursivamente, selecione Is Recursive . Ver Adicionar uma criança FlexCard para
Em si Recursivamente .
5. (Opcional) Para usar a fonte de dados do FlexCard pai em vez da fonte de dados do filho, execute as
seguintes tarefas:
a. Confirme se os campos que você deseja preencher no FlexCard filho também estão disponíveis no
FlexCard pai fonte de dados .

company
Por exemplo, se o seu FlexCard filho exibir informações do caso, como Status e Prioridade, sua fonte
de dados pai deverá ter esses mesmos campos disponíveis para enviar ao filho.
b. Clique no campo Data Node e selecione um conjunto de dados para passar para o FlexCard filho .
Nó Descrição
{ registros } Mandar todos os dados.
{ registros [#]} Envie todos os dados de um registro específico. {records[0]} = primeiro registro. {records[1]} = segundo
registro. E assim em .
{ registro } Envie apenas os dados do registro atual, como quando Repetir registros está desabilitado no painel
Configuração ou apenas um registro é solicitado de uma consulta.
{ record.FieldName } Envie o objeto de registro que pertence ao Estado. Por exemplo, se { record.Product } for um objeto ou
array com dados adicionais, selecione -o. Mas, se você quiser enviar um campo de dados, use a propriedade
Attributes .
{ registro.atributos } Envie todos os atributos para o registro atual.
Exemplo 3. Exemplo: Exibir informações da conta e do caso

Você deseja exibir informações de conta em um FlexCard pai e informações de caso no FlexCard filho
usando um elemento Datatable .
No seu FlexCard filho , desmarque a propriedade Repeat Records no painel Setup para que apenas uma
tabela de dados exibe . Em seguida, arraste o elemento Datatable para a tela do painel Build. Para ver
como a tabela de dados se parece com dados reais, configure a fonte de dados para obter informações
do caso. Ative o FlexCard filho .
No FlexCard pai , configure a fonte de dados para obter informações básicas da conta do caso e
informações de todos os casos associados à conta. Por exemplo:
[
{
" PrimaryContactEmail ": "sean@edge.com",
"Receita": 139000000,
"Site": "http://edgecomm.com",
"Telefone": "(512) 757-6000",
"Nome": "Comunicação de Borda",
"Id": "0013g00000AeI9fAAF",
"Casos": [
{
"Tipo": "Mecânico",
" CaseId ": "5003g000007WQHRAA4",
"Criado": "2020-11-23T20:51:20.000Z",
"Prioridade": "Alta",
"Status": "Escalado",
"Assunto": "O watchamacallit está muito alto"
},
{
"Tipo": "Estrutural",
" CaseId ": "5003g000007WQHQAA4",
"Criado": "2020-11-23T20:50:32.000Z",
"Prioridade": "Médio",
"Estado": "Novo",
"Assunto": "O doodat não foi configurado corretamente",

company
" CaseId ": "5003g000007WQHQAA4"
}
]
}
]
Adicione o elemento FlexCard na tela. Em FlexChild Name , selecione o filho ativado. Em Data Node ,
selecione {records[0].Cases} .
dados filho é ignorada. A fonte de dados pai preenche o FlexCard filho tabela de dados .
6. (Opcional) Para passar atributos do FlexCard pai para um FlexCard filho , na seção Atributos : a.
Clique em + Adicionar novo .
b. No campo Atributo , insira um nome para o atributo a ser transmitido, como contactId .
c. Clique no campo Valor e selecione um campo de mesclagem, como { contactId } . Você também
pode inserir uma variável de contexto compatível ou texto simples.
NOTA
A partir do verão '21, passe strings concatenadas. Combine texto simples e campos de
mesclagem suportados. Por exemplo, passe um caminho de trilha como {
Parent.parentPath }>{ Parent.type }>{Name} .
d. Abra o FlexCard filho selecionado no campo FlexCard Name e insira o

contexto { Parent.attribute } em um campo compatível, como { Parent.contactId } .
Exemplo 4. Exemplo: passar ID de contato para Flexcard filho como um ContextId
Você tem um FlexCard que exibe as informações da conta no pai e as informações de contato
principal da conta em um FlexCard filho .
No FlexCard filho, use a fonte de dados SQL Query para obter informações básicas de contato. Por
exemplo:
Selecionar
Id,Nome,E-mail,Telefone,MailingStreet,MailingCity,MailingState,MailingPostal
Code,MailingCountry from Contact where Id = '{
Parent.contactId }'
Ative o FlexCard filho .
No FlexCard pai , configure a fonte de dados para obter informações básicas da conta, incluindo o ID
de contato principal.
Em seguida, passe o ID de contato principal como um atributo para o FlexCard filho , em que
Attribute = contactId e Value = {namespace__ PrimaryContactId __c} .

company
NOTA
Se o seu FlexCard filho exibir vários registros e você quiser mostrá-los lado a lado em vez de
empilhados, consulte Exibir registros lado a lado em um FlexCard .
Qual é o próximo
Veja também
• Propriedades do FlexCard filho FlexCards • Faça o download de uma
amostra do FlexCard filho Pacote de dados
• ???
Adicionar um FlexCard filho a si mesmo recursivamente

Quando um FlexCard filho possui dados hierárquicos, ele pode chamar a si mesmo recursivamente. Quando o
elemento FlexCard é incorporado em um FlexCard filho , use o recurso É Recursivo para exibir os filhos e netos
dos objetos pai. O FlexCard filho pode adicionar-se a si mesmo repetidamente, cada vez passando o mesmo
campo de dados filho (também chamado de nó de dados) disponível em cada nível do JSON de dados, até que
esse campo de dados não exista mais ou esteja vazio.
Por exemplo, digamos que seu JSON de dados hierárquicos tenha um campo de dados de produtos que lista os
produtos em um produto. Você pode exibir os produtos, seus produtos filhos e produtos netos incorporando o
FlexCard filho uma vez dentro de si mesmo e passando o campo de dados de produtos para ele mesmo. Os
recursos Is Recursive percorrem cada nó de produtos e exibem as informações do produto com base nos
elementos adicionados ao FlexCard . Ver a exemplo na Etapa 5 em isto página .
Requeridos Versões
1. Do OmniStudio Aba inicial do FlexCards , crie um FlexCard filho . Ver Incorporar uma criança FlexCard
Dentro de um FlexCard .
2. Adicione campos de dados e outros elementos ao FlexCard filho . Consulte Adicionar elementos a um
FlexCard .
3. No painel Build, arraste um elemento FlexCard para um estado na tela.
4. No painel Propriedades, selecione É Recursivo .
5. Passar dados para as crianças:
• Para passar atributos específicos, siga estas tarefas:
a. No campo Atributo , insira um nome para o atributo, como AccountId .
b. No campo Valor , selecione um campo de mesclagem de dados, como {Id}

company
c. Na fonte de dados, faça referência ao atributo como contextId . Por exemplo , { Parent.AccountId
}.

company
FlexCard filho exibe recursivamente os registros de contas cujo ID de conta pai é { Parent.AccountId } .
• Para retornar objetos em um conjunto de dados específico da fonte de dados, insira o nó filho repetido
no campo Nó de dados . Por exemplo, se sua fonte de dados tiver uma estrutura JSON semelhante à
vista neste exemplo de código, insira { record.Products } para exibir um cartão para cada objeto
Products .
[
{
"ID": "5123",
"Nome": "Saída das Comunicações",
"Número da conta": "QHT123456789",
"Telefone": "415-987-6543",
"Site": "http://www.exitcomm.org",
"Contato": "Melrose Oduke ",
"Telefone de contato": "415-333-1234",
"Produtos": [
{
"ID": "1",
"Nome": "Produto1",
"Produtos": [
{
"Id": "1_1",
"Nome": "Produto1_1"
},
{
"Id": "1_2",
"Nome": "Produto1_2",
"Produtos": [
{
"ID": "2",
"Nome": "Produto2",
"Produtos": [

company
{
"Id": "2_1",
},
{
"Id": "2_1_2",
"Nome": "Produto2_1_2"
}
]
}
]
}
]
}
]
}
]
d. Na fonte de dados, faça referência ao atributo como contextId . Por exemplo , { Parent.AccountId
}.

company
FlexCard filho exibe recursivamente os registros de contas cujo ID de conta pai é { Parent.AccountId } .
• Para retornar objetos em um conjunto de dados específico da fonte de dados, insira o nó filho repetido
no campo Nó de dados . Por exemplo, se sua fonte de dados tiver uma estrutura JSON semelhante à
vista neste exemplo de código, insira { record.Products } para exibir um cartão para cada objeto
Products .
[
{
"ID": "5123",
"Nome": "Saída das Comunicações",
"Número da conta": "QHT123456789",
"Telefone": "415-987-6543",
"Site": "http://www.exitcomm.org",
"Contato": "Melrose Oduke ",
"Telefone de contato": "415-333-1234",
"Produtos": [
{
"ID": "1",
"Nome": "Produto1",
"Produtos": [
{
"Id": "1_1",
},
{
"Id": "1_2",
"Nome": "Produto1_2",
"Produtos": [
{
"ID": "2",
"Nome": "Produto2",
"Produtos": [

company
{
"Id": "2_1",
},
{
"Id": "2_1_2",
"Nome": "Produto2_1_2"
}
]
}
]
}
]
}
]
}
]
FlexCard filho exibe recursivamente as informações do produto do nó Produtos de sua fonte de dados.
6. (Opcional) Para mostrar condicionalmente o FlexCard filho recursivo , clique em +Adicionar novo ao lado
de Condições no painel Propriedades. Ver Adicionar Condições para um FlexCard Elemento .
NOTA
As condições aplicadas a um FlexCard filho recursivo aplicam-se a todos os registros de
repetição recursiva. Se uma condição de registro retornar false, os registros aninhados não
serão exibidos.
7. (Opcional) Para visualizar o FlexCard em tempo de execução, clique em Visualizar .

IMPORTANTE
Ative o FlexCard filho para incorporá-lo em um FlexCard pai .
Veja também
• Propriedades do FlexCard filho de FlexCards
Baixe uma amostra de FlexCard infantil Pacote de dados

Baixe uma amostra de FlexCard filho DataPack . Incorpore um FlexCard reutilizável como filho dentro do
estado de um FlexCard pai para passar dados do pai para o filho.

company
Consulte Incorporar um FlexCard filho dentro de um FlexCard .
Passar Atributos Pais para o FlexCard Filho

Exibir informações da conta no FlexCard pai e informações de contato no filho incorporado
FlexCard passando o contextId do pai para o filho como um atributo, onde Key = AccountId e Value = {
recordId } . No FlexCard filho , use { Parent.AccountId } como o contextId da fonte de dados do FlexCard filho .
O FlexCard pai demoEmbedChildPFCpassAttribute no DataPack inclui os seguintes recursos:
• Uma fonte de dados SOQL Query obtém nomes de contas.

• Um FlexCard filho incorporado que passa o ID da conta do pai como um atributo chamado AccountId .
O FlexCard filho demoEmbedChildCFCpassAttribute no DataPack inclui os seguintes recursos:
• Uma lista de contatos com base no ID da conta do FlexCard pai no qual está incorporado.
• Uma fonte de dados que usa a variável de contexto { Parent.AccountId } como a ID de contexto para obter
a lista de contatos.
Passar todos os registros dos pais para o filho FlexCard

Exiba informações de conta no FlexCard pai e informações de contato no FlexCard filho incorporado passando
todos os registros do pai para o filho usando o campo de mesclagem {records} na propriedade Data Node .

company
O FlexCard pai demoEmbedChildPFCpassRecords no DataPack inclui os seguintes recursos:
• O recurso Repetir Registros está desabilitado no painel Configuração para usar o cartão pai apenas como
um recipiente para o cartão filho. Ver Desabilitar Record Looping em um FlexCard .
• Uma fonte de dados SOQL Query obtém uma lista dos casos de uma conta.
• Um elemento FlexCard passa todos os registros pai por meio de {records} Nó de dados para o FlexCard filho
.
O FlexCard filho demoEmbedChildFCpassRecords no DataPack inclui os seguintes recursos:
• Um elemento de texto exibe informações de caso como campos de mesclagem.

• O estado tem 6 colunas de largura para exibir casos lado a lado. Consulte Exibir registros lado a lado em um
FlexCard .
Baixe e Importar
1. Baixe o OmniStudio para Vlocity DataPack aqui: demoEmbedChildFlexCard-VMP.zip
NOTA
Baixe o OmniStudio DataPack aqui: demoEmbedChildFlexCard-OmniStudio.zip

company
NOTA
Veja Também
• FlexCards Filho FlexCard Propriedades
• Adicionar um FlexCard filho a si mesmo recursivamente
Propriedades de FlexCards Filhos de FlexCards

FlexCard são configuráveis no Painel de propriedades quando você seleciona um elemento FlexCard no
FlexCard Designer. Com o elemento FlexCard , incorpore um FlexCard reutilizável como filho dentro do estado
de outro FlexCard . Ver Incorporar uma criança FlexCard Dentro de um FlexCard .
Atributo Defina uma chave que representa um atributo. n/D
Atributos FlexCard pai para o filho criando um atributo e atribuindo-lhe um valor, como um campo de Incorporar um FlexCard
mesclagem de dados. infantil
Dentro de um FlexCard
Elemento FlexCard
Nó de dados Para usar a fonte de dados do FlexCard pai , selecione um nó de dados. n/D
Elemento Nome O nome do elemento como visto na tela. Usado para distinguir um elemento do outro n/D
conforme você constrói seu FlexCard no designer. É usado só dentro de o desenhista.
Ativar rastreamento Habilite o rastreamento de eventos por meio do OmniAnalytics . Acompanhe os eventos Card Ativar rastreamento em um
Load, Card Unload e State Load. FlexCard
FlexCard Nome Selecione o FlexCard filho a ser exibido. n/D
É Recursivo Se o seu FlexCard filho tiver dados hierárquicos, exiba os filhos e netos dos objetos pai Adicionar um FlexCard filho a
adicionando o FlexCard filho a si mesmo recursivamente. Passe um nó de dados que Recursivamente
aparece em vários níveis de dados, como produtos em uma lista de subprodutos.`
Selecionar Estado Visualize um estado do nome do FlexCard selecionado. n/D
Valor Selecione os dados a serem passados para o Atributo definido . n/D
Veja Também
• Adicionar condições a um elemento FlexCard
Incorporar um LWC personalizado dentro de um FlexCard

Incorpore um LWC OmniScript , um FlexCard LWC gerado ou um LWC personalizado dentro de um estado
FlexCard . Um wrapper envolve o elemento Custom LWC e é alimentado com dados da fonte de dados do seu
FlexCard .

company
Por exemplo, se você tiver um carrossel com estilo e funcionalidade personalizados, poderá incorporá-lo em
um estado FlexCard . Em seguida, configure os atributos personalizados do componente, como thumbnaillimit
e mode .
CUIDADO
Antes de começar
• Crie e ative um componente FlexCard , LWC OmniScript ou LWC personalizado para gerar um LWC a ser incorporado. Para
crio um LWC OmniScript , consulte Crio um OmniScript .
1. No FlexCard Designer, arraste um elemento Custom LWC do painel Build para um estado na tela.
3. Clique no nome do LWC personalizado campo e selecione um LWC personalizado para incorporar.
NOTA
O LWC personalizado é renderizado apenas na visualização.
NOTA
Os nomes dos LWCs personalizados criados no FlexCard Designer são anexados com cf . Por
exemplo, se o nome do seu FlexCard filho for AccountCases , o nome do LWC personalizado
será cfAccountCases .
4. Para definir o valor de um atributo disponível para o componente:

a. Ao lado do rótulo Atributos , clique em +Adicionar .
b. Insira o nome do atributo no campo Atributo , como thumbnaillimit .
IMPORTANTE
O Nome de um atributo LWC personalizado deve corresponder ao nome de marcação
do atributo LWC personalizado. Por exemplo, o atributo targetType do LWC
NavigateAction deve ser escrito como target-type .
c. Clique no campo Valor e selecione um campo de mesclagem, como {Number} . Você também pode
inserir uma variável de contexto compatível , como { Session.number } , ou texto, como 5 .
NOTA
A partir do verão '21, passe strings concatenadas. Combine texto simples e campos de
mesclagem suportados. Por exemplo, passe um caminho de trilha como {
Parent.parentPath }>{ Parent.type }>{Name} .
Qual é o próximo
company
Veja também
• Propriedades personalizadas de LWC FlexCards
personalizadas de LWC de FlexCards

As propriedades do elemento LWC personalizado são configuráveis no Painel de propriedades quando você
seleciona um elemento LWC personalizado no FlexCard Designer. Com o elemento Custom LWC, incorpore um
LWC OmniScript , um FlexCard LWC gerado ou um LWC personalizado, dentro de um estado FlexCard .
Consulte Incorporar um LWC personalizado em um FlexCard .

Atributo Insira o nome do atributo definido no LWC personalizado selecionado. n/D
Elemento FlexCard
LWC personalizado Selecione o LWC personalizado para incorporar. n/D

Nome
Valor Insira o valor do Atributo . n/D
Veja Também
• Ampliar Vlocity Componentes da Web do Lightning
Adicionar uma tabela de dados a um FlexCard

Exiba uma estrutura tabular dos dados obtidos de uma fonte de dados em um FlexCard . Por exemplo , exiba
os casos de conta como uma lista classificável mesa .
Configurado Tabela de dados
1. No FlexCard Designer, arraste um elemento Datatable do painel Build para um estado na tela.
3. (Opcional) Para adicionar um aria-label para usuários de acessibilidade, insira um nome no campo
Datatable Name . O texto não é visível na tela e apenas visível para tecnologias assistivas.
4. Para atualizar colunas, clique no ícone de lápis ao lado de Column para iniciar o modal Add
DataTable Columns .

company
• Para adicionar uma coluna de campo de dados disponível, clique em Adicionar coluna .
• Para excluir uma coluna de campo de dados, clique no ícone da lixeira do campo de dados a ser
removido.
• Para atualizar os rótulos das colunas do campo de dados, clique em um campo em Rótulo do campo .
• Para atualizar a capacidade de classificar uma coluna de campo de dados específica, altere o valor de É
Classificável para false ou true. É Ordenável deve ser selecionado em Atributos no painel
Propriedades.
• Para atualizar a capacidade de pesquisar um campo de dados específico, altere o valor de Is Searchable
para true ou false. É pesquisável deve ser selecionado em Atributos no painel Propriedades.
• Para atualizar o tipo de dados para uma coluna de campo de dados específica, como moeda, data,
número e em breve, atualize Type .
• Para atualizar a capacidade de editar o valor de um campo de dados, altere o valor de É editável para
verdadeiro ou falso. A Edição de Nível de Célula deve ser marcada em Atributos no painel
Propriedades.
• Para atualizar a capacidade de um usuário ocultar ou mostrar colunas de campos de dados específicos,
altere o valor de É selecionável pelo usuário para verdadeiro ou falso. A Coluna Selecionável pelo
Usuário deve ser marcada em Atributos no painel Propriedades.
• Para atualizar se um campo de dados está oculto ou mostrado por padrão, altere o valor de Is Visible
para true ou false. Se esta propriedade for configurada como false e Is User Selectable for configurada
como true, o usuário poderá tornar a coluna visível.
5. Clique em Salvar para salvar as atualizações e fechar o modal.
6. (Opcional) Para adicionar paginação à tabela de dados:
1. Para definir quantos registros por página serão exibidos, insira um número no campo Tamanho da
página .
2. Para definir um número máximo de links de paginação a serem exibidos, insira um número no campo
Limite de página .
7. (Opcional) Para habilitar a capacidade de excluir uma linha com base em um valor de campo de dados
retornando como false, insira o nome da coluna do campo de dados em Row Delete Dependent Column .
Por exemplo, digamos que sua tabela seja uma lista de casos de conta e tenha um campo de registro
IsEscalated cujo valor seja true ou false. Quando o valor IsEscalated de um registro é false, um usuário
pode excluir o registro. Se true, o ícone da lixeira é desabilitado e um usuário não pode excluir o registro.
IMPORTANTE
exclusão de linha deve estar habilitada e a coluna deve ter um valor booleano (verdadeiro ou
falso).
8. (Opcional) Para configurar atributos adicionais, consulte FlexCards Propriedades da tabela de dados .
9. (Opcional) Para agrupar uma tabela por tipo de campo de dados:
a. Insira o nome do campo de dados para agrupar registros no campo Agrupar por . Por exemplo, para
agrupar Casos de Conta pelo campo Dados de Status, insira Status .
b. ( Opcional ) Configure estes propriedades :
• Para classificar em todos os grupos, selecione Classificar entre grupos .
Por padrão, a classificação acontece dentro de cada grupo.
• Para remover o espaço abaixo e acima do nome do grupo, selecione Ocultar coluna extra .
• Para recolher ou expandir as linhas agrupadas por padrão, selecione Grupos Ativos .
• Para adicionar uma classe a cada grupo, insira uma classe definida no campo Classe Wrapper do
Grupo. Consulte Aplicar CSS personalizado a um elemento em um FlexCard .

company
• Para atualizar a ordem em que cada grupo é classificado, selecione na lista suspensa Ordem do
grupo .
11. (Opcional) Para estilizar seu elemento, clique em Estilo para abrir o painel Estilo e veja FlexCards
Propriedades do estilo da tabela de dados .
Faça o download de uma tabela de dados de exemplo Pacote de dados
Baixe uma amostra de FlexCard DataPack com um Datatable configurado . Consulte Baixar uma tabela de
dados de exemplo DataPack .
Qual é o próximo
Veja também
• FlexCards Propriedades da tabela de dados
FlexCards Propriedades da tabela de dados

Datatable são configuráveis no Property Panel quando você seleciona um elemento Datatable no FlexCard
Designer . Com o elemento Datatable , exiba uma estrutura tabular dos dados obtidos de uma fonte de dados.
Ver Adicionar uma tabela de dados para um FlexCard .
Coluna Atualize os campos de dados para preencher a tabela e definir opções para colunas, como n/D
type e selectability .
Elemento FlexCard
Tabela de dados Adiciona um rótulo de ária para usuários de acessibilidade. O texto não é visível na tela e n/D
Nome apenas visível para tecnologias assistivas.
Registros Especifique os dados de registro que preenchem a tabela. Padrões para { registros } . n/D
Atributos
Célula Nível Editar Habilite o suporte para edição em linha em nível de célula. Selecione quais colunas são editáveis na propriedade
Coluna .
Arrastável Ative a capacidade de reorganizar as linhas arrastando-as para cima ou para baixo.
Classe Extra Insira uma classe anexada ao contêiner do elemento. Selecione uma classe definida no recurso Adicionar CSS
personalizado do FlexCard Designer ou qualquer folha de estilo disponível para o FlexCard .
Evento de incêndio ao Ative para disparar um evento personalizado de exclusão quando uma linha for excluída.
excluir
confirme
Esconder Cabeçalho Ative para ocultar o cabeçalho da tabela.
da Tabela
É Pesquisável Ative a capacidade de pesquisar todos os valores de coluna. Limite quais colunas são pesquisáveis na propriedade
da coluna .
É Classificável Habilite o suporte para classificar todas as colunas. Limite quais colunas são classificáveis da propriedade da coluna
.

company
Limite de páginas Especifique o número de links de navegação de página a serem adicionados à paginação. O tamanho da página
propriedade deve ser ativado .
Tamanho da página Habilite a paginação especificando quantos registros serão exibidos em cada página. Se estiver usando Group By ,
o tamanho da página será determinado pelo número de grupos em vez do número de linhas.
Excluir linha Habilite a capacidade de excluir uma linha do FlexCard . O registro não é excluído no banco de dados.
Dependência de exclusão de Habilite a capacidade de excluir uma linha com base em um valor de campo de dados retornando como falso. O
linha campo deve ter um valor booleano (verdadeiro ou falso) e a Exclusão de Linha deve estar habilitada.
Coluna
Nível de linha Editar Habilite o suporte para edição em linha em nível de linha.
Mostrar modal de Ative para exibir uma janela de confirmação antes que uma linha seja excluída.
confirmação
Antes da exclusão da linha
Do utilizador Selecionável Permitir que os usuários selecionem quais colunas são visíveis. Selecione colunas específicas na propriedade Coluna
Coluna .
Do utilizador Linha Torne a linha selecionável adicionando uma caixa de seleção no início de cada linha.
selecionável
Grupo Atributos
Grupos ativos Ative para expandir todos os grupos.
Grupo Por Agrupe as linhas da tabela por um campo de dados.
Grupo Ordem Classifique os grupos em ordem crescente ou decrescente.
Grupo Embrulho Classe Adicione uma classe ao wrapper ao redor de cada nome de grupo.
Ocultar coluna extra Ative para remover o espaço abaixo e acima do nome do grupo.
Ordenar Através Grupos Classifica os grupos e as linhas dentro de cada grupo quando um cabeçalho de coluna é clicado. Por padrão, a
classificação ocorre dentro de cada grupo quando um cabeçalho de coluna é clicado. Visão funcionalidade na
visualização.
Coluna Propriedades
Essas propriedades ficam visíveis na janela Adicionar Colunas de DataTable quando você clica na propriedade
Coluna .
Etiqueta do campo Atualize o nome da coluna do campo. Por padrão, o rótulo do campo é o Nome do Campo .
Nome do campo Selecione a coluna de campo a ser exibida.
É Classificável Selecione quais campos são classificáveis. Ative É Ordenável em Atributos no painel Propriedades.
É Pesquisável Selecione quais campos são pesquisáveis no formulário de pesquisa. Ative É pesquisável em Atributos no painel
Propriedades.
Modelo Selecione o tipo de dados que a coluna de campo exibe. Por exemplo, se um nome de campo Conta for AnnualRevenue ,
selecione Moeda .
É Editável Selecione qual coluna de campo um usuário pode editar. Ative a Edição de nível de célula em Atributos no painel
Propriedades.
É Do utilizador Selecione quais colunas de campo um usuário pode ocultar ou mostrar. Ative a Coluna selecionável pelo usuário em
Selecionável Atributos no painel Propriedades.
É Visível Selecione quais colunas de campo estão ocultas ou visíveis por padrão. Use com É selecionável pelo usuário para permitir
que os usuários exibam colunas de campo ocultas.
Veja Também
• Faça o download de uma tabela de dados de exemplo Pacote de dados

company
Faça o download de uma tabela de dados de exemplo Pacote de dados
Faça o download de uma tabela de dados de exemplo DataPack para importar para sua organização. Um
elemento Datatable permite exibir uma estrutura tabular dos dados obtidos de uma fonte de dados em um
FlexCard . Consulte Adicionar uma tabela de dados a um FlexCard .
O DataPack de exemplo demonstra como configurar uma tabela de dados com configurações comuns, como
capacidade de pesquisa, capacidade de classificação e muito mais. A tabela de dados é preenchida
automaticamente com os dados da fonte de dados configurada assim que o elemento é arrastado para a tela.

Um FlexCard com um elemento Datatable com os seguintes recursos:
• Agrupados por um campo de dados.

• Pesquisável e classificável .
• Classificável através grupos .
• Grupos expandido .
• Edição em nível de linha e célula.
• Arrastável .
• excluível com confirmação após a exclusão.
• Paginação .
• Repetir registros no painel de configuração desativado.
• Fonte de dados personalizada .
1. Baixe o OmniStudio para Vlocity DataPack aqui: demoDatatable.json .

company
NOTA
Baixe o OmniStudio DataPack aqui: demoDatatable-OmniStudio.json
NOTA
Veja Também
• FlexCards Tabela de dados Propriedades
Adicionar um campo a um FlexCard

Exibe campos de dados retornados de uma fonte de dados em um FlexCard . Por exemplo, exiba as
informações de política de uma conta.
2. Para adicionar um campo de dados, no painel Build, execute uma destas tarefas:
• Clique em Campos para visualizar a lista de campos de dados disponíveis e arraste um campo de dados
para um estado na tela.
• Arraste o elemento Campo da lista Elementos para um estado na tela.
4. (Opcional) Insira um rótulo visível no campo Rótulo .
NOTA
simples e campos de mesclagem suportados. Por exemplo , { Label.AccountName }>{ Name } .
5. (Opcional) Adicione o texto do placeholder no campo Placeholder .

6. (Opcional) Para definir um tipo de dados, como texto e moeda, selecione um na lista suspensa Tipo de
campo . O padrão é Texto .

company
NOTA
Para configurar propriedades adicionais para o tipo de campo selecionado , consulte
Propriedades do campo FlexCards .
IMPORTANTE
Se você selecionar Data como um Tipo de campo e o elemento de campo for uma string
que representa uma data, certifique-se de que o valor da data corresponda ao formato de
localidade do usuário. Por exemplo, se seu valor de data vier de uma fonte de dados
personalizada como [{"DOB" : "28-03-2015"} e sua localidade for en_US , que tem um
formato M/D/AAAA, porque apenas meses vá até 12, o número 28 não será lido
corretamente. A data final é exibida incorretamente. Em vez disso, se seu aplicativo não
exigir localização, atualize o formato para corresponder à saída da string, como
DD/MM/YYYY . Ou selecionar Texto como um tipo de campo .
7. Se você arrastou o elemento Field do painel Build, no campo Output , clique no campo e selecione entre
os campos de dados disponíveis retornados da fonte de dados.
NOTA
A partir do Summer '21, Output oferece suporte a strings concatenadas, como {Name} +
{Id} .
8. (Opcional) Quando Data é selecionada para Tipo de campo, você pode habilitar Usar data absoluta para
evitar a conversão da data com base no fuso horário quando o formato for atualizado.
NOTA
Quando esse recurso não está ativado, a data pode ser exibida um dia antes ou depois, como
16/12/2020 ou 14/12/2020 em vez de 15/12/2020 se o fuso horário do usuário conectado não
for o mesmo como o fuso horário em que o registro foi criado.
IMPORTANTE
Não habilite se Data for o Tipo de campo e seu elemento de campo retornar uma data
como uma string, como dados de uma fonte de dados personalizada que se parece com
[{"DOB" :
"28-03-2015"} ] e não corresponde ao formato definido. Isso lança um erro. Veja o aviso na
Etapa 6.
9. (Opcional) Se o seu FlexCard for usado em um aplicativo acessível em diferentes localidades, habilite Usar
localidade do usuário para formatação para usar a localidade do usuário conectado para determinar o
formato de sua data, hora e moeda.
NOTA
Por padrão, a localidade do usuário do FlexCard Author determina o formato.

company
IMPORTANTE
Não habilite se Data for o Tipo de campo e seu elemento de campo retornar uma data
como uma string, como dados de uma fonte de dados personalizada que se parece com
[{"DOB" :
"28-03-2015"} ] e não corresponde ao formato definido. Isso lança um erro. Veja o aviso na
Etapa 6.
11. (Opcional) Para estilizar seu elemento, clique em Estilo para abrir o painel Estilo e consulte Propriedades
de estilo de campo FlexCards .
Qual é o próximo
campo FlexCards
As propriedades do elemento Field são configuráveis no Property Panel quando você seleciona um elemento
Field no FlexCard Designer. Com o elemento Field, exiba campos de dados retornados de uma fonte de dados
fornecida. Ver Adicionar um campo a um FlexCard .
Elemento FlexCard
Elemento Nome O nome do elemento como visto na tela. Usado para distinguir um elemento do outro conforme FlexCard Nomeação
você constrói seu FlexCard no designer. É usado só dentro de o desenhista. Convenções
Tipo de campo Selecione o tipo de elemento Field a ser exibido. Se você selecionar Data , certifique-se de que n/D
o valor da data, como 28/03/2015, corresponda ao formato da localidade do usuário, como
DD/MM/AAAA, caso contrário, a data será exibida incorretamente.
Resultado Selecione o campo de dados a ser exibido. n/D
Espaço reservado Digitar marcador de posição texto . n/D
Tipo de campo Propriedades

Esta tabela lista as propriedades adicionais disponíveis para cada tipo de campo .
Propriedade Descrição Tipo de campo Referência
Moeda Insira um código de moeda para atualizar a moeda suportada. Moeda Códigos de moeda
Formato Selecione um formato para a data ou data e hora se o Tipo de campo for Data, Data Data e hora
Data ou Data e hora . Por padrão, a localidade do usuário do FlexCard Tempo Formatos
Author determina o formato.
Localidade Insira um código de localidade para atualizar o idioma suportado. Moeda Compatível
línguas
mascarar Insira uma expressão de string para limitar a entrada do usuário. Número n/D
Usar Absoluto Ative para evitar a conversão da data com base no fuso horário . Encontro n/D
Encontro
Usar localidade do Se o seu FlexCard for usado em um aplicativo acessível em várias Tudo n/D
usuário localidades, ative para usar a localidade do usuário conectado para
Para formatação determinar o formato de sua data, hora, moeda e assim por diante.
Veja Também

company
Adicionar um ícone a um FlexCard
Exiba um ícone SVG em um FlexCard . Selecione um ícone do Salesforce SVG ou uma ação personalizada. Você
posso também ligar o ícone para um ação .
1. No FlexCard Designer, arraste um elemento Icon do painel Build para um estado na tela.
3. Na lista suspensa Tipo , selecione um tipo de ícone.
4. Para configurar um ícone personalizado , insira a origem do ícone no campo Origem .
5. Para configurar as propriedades do ícone do Salesforce SVG :
a. Para selecionar o ícone, no campo Ícone , execute uma das seguintes tarefas:
• Digite o nome do ícone, como utility:arrowdown . Consulte Sistema de design Salesforce
Lightning .
• Pesquise um ícone no campo de pesquisa, clique em um ícone para selecioná-lo e clique em
Salvar .
b. (Opcional) Selecione uma variante de estilo na lista suspensa Variante .
6. (Opcional) Para atualizar o tamanho do ícone, selecione um novo tamanho na lista suspensa Tamanho .
7. Para vincular o ícone a uma ação, clique em + Adicionar ação . Para configurar as propriedades da ação,
consulte Propriedades da ação FlexCards .
9. (Opcional) Para estilizar seu elemento de ícone, clique em Estilo para abrir o painel Estilo e consulte
Propriedades de estilo de ícone FlexCards .
Qual é o próximo
Veja também
• Propriedades do ícone FlexCards
ícone FlexCards
As propriedades do elemento Ícone são configuráveis no Painel de Propriedades quando você seleciona um
elemento Ícone no FlexCard Designer. Com o elemento Ícone, exiba um ícone SVG do Salesforce ou um ícone
personalizado em um FlexCard . Ver Adicionar um Ícone para um FlexCard .
FlexCard
Elemento
Elemento
desenhista.
Classe Extra Adicione uma classe adicional ao elemento. n/D
Ícone Insira o nome do ícone do Salesforce. n/D

company
Imagem Fonte Insira o URL de um ícone personalizado. n/D
Tamanho Selecione o tamanho do ícone. n/D
Modelo Selecione o tipo de ícone a ser exibido. n/D
Variante Selecione entre os estilos SLDS predefinidos para alterar a aparência do elemento. n/D
Veja Também
Adicionar uma imagem a um FlexCard

Adicione uma imagem a um FlexCard no FlexCard Designer. Com o elemento Image, carregue uma imagem do
seu computador, use uma imagem de uma biblioteca do Salesforce, insira um URL ou use um campo de
mesclagem de uma fonte de dados. Vincule a imagem a uma ação, adicione classes e ajuste o tamanho da
imagem em relação ao tamanho da tela.
NOTA
Todos os rótulos no painel Propriedades têm suporte a rótulo personalizado.
1. No FlexCard Designer, arraste um elemento Image do painel Build para um estado na tela.
3. Selecione a Origem da imagem de uma destas opções:
• Para exibir uma imagem de uma fonte externa, insira o URL absoluto da imagem
IMPORTANTE
Se sua imagem não for exibida, adicione o URL da imagem à lista de sites confiáveis do
CSP em sua organização. Se você estiver adicionando seu FlexCard a uma comunidade,
deverá adicionar o URL à lista de sites confiáveis do CSP. Ver Política de segurança de
conteúdo (CSP) .
• Para fazer upload de um arquivo do seu computador:

a. Clique no procurar ícone .
b. Clique em Carregar arquivos e selecione um arquivo de imagem do seu computador. Ou arraste
um arquivo do seu computador e solte-o onde diz Ou solte arquivos .
c. Clique em Salvar .
NOTA
Os arquivos carregados são salvos na biblioteca de documentos da sua organização para
reutilização.
• Para usar um arquivo de uma biblioteca em seu Salesforce CRM Content ou Salesforce Files:
a. Clique no procurar ícone .
b. Selecione uma imagem na lista suspensa Selecionar uma imagem do documento de
conteúdo . c. Clique em Salvar .
4. (Opcional) Para ajustar o tamanho da imagem em relação ao tamanho da tela, selecione uma opção na
lista suspensa Tamanho .

company
NOTA
Por padrão, Fit Content é selecionado, permitindo que a imagem preencha o container do
elemento Image, ou o container de um elemento Block que está dentro.
Na tela, ajuste o tamanho do elemento para ajustar sua imagem conforme necessário.
5. Para acessibilidade, no campo Texto alternativo , insira o texto que descreve a imagem.
6. (Opcional) Insira uma classe Newport, SLDS ou CSS customizada no campo Extra Class .
NOTA
Por padrão, slds -image --card slds - align_absolute -center preenche o campo.
7. (Opcional) Para exibir uma legenda de imagem, insira o texto no campo Título .
NOTA
A partir do Summer '21, o Title oferece suporte a strings concatenadas. Combine texto
simples e campos de mesclagem suportados. Por exemplo , { Label.AccountName }>{ Name } .
8. (Opcional) Para estilizar a legenda da imagem, insira uma classe no campo Classe de título .
9. (Opcional) Para iniciar uma ação ao clicar no elemento, consulte Adicionar um evento de clique a um
elemento FlexCard .
Qual é o próximo
Veja também
• Propriedades da Imagem FlexCards
imagem FlexCards
As propriedades do elemento de imagem são configuráveis no Painel de propriedades quando você seleciona
um elemento de imagem no FlexCard Designer. Com o elemento Image, exiba uma imagem em um FlexCard .
Ver Adicionar um Imagem para um FlexCard .
Adicionar Ação Torne o elemento uma ação clicável. Adicionar um evento de

clique a um
FlexCard Elemento
Alternativo Texto Para acessibilidade, insira o texto que descreve a imagem, que é exibida quando a imagem n/D
não está disponível.
Elemento FlexCard

company
Classe Extra Insira uma classe anexada ao contêiner do elemento. Selecione uma classe definida no n/D
recurso Adicionar CSS personalizado do FlexCard Designer ou qualquer folha de estilo
disponível para o FlexCard .
Altura Insira um valor disponível para a propriedade CSS height , como 100px , 4rem ou uma função n/D
calc() .
Imagem Fonte Insira a fonte da imagem para o ícone. Carregue o ícone aqui, selecione uma imagem das n/D
bibliotecas da sua organização ou insira um URL absoluto seguro de uma fonte externa.
Tamanho Atualize o tamanho da imagem em relação ao tamanho da tela. Por padrão, Ajustar conteúdo é n/D
selecionado, permitindo que a imagem preencha o contêiner do elemento Imagem.
Título Digitar um imagem legenda . n/D
Título Classe Insira uma classe para a legenda da imagem. n/D
Largura Insira um valor disponível para a propriedade CSS width , como 100px , 4rem ou uma função n/D
calc() .
Veja Também
Adicionar um menu a um FlexCard

Crie um menu de uma lista de ações em um FlexCard . Estilize o botão de menu e cada ação na lista suspensa
do menu. Adicione qualquer tipo de ação disponível no FlexCard De signer. Consulte Referência de Ações
FlexCards .
Adicionar e Configurar Menu

1. No FlexCard Designer, arraste um elemento Menu para um estado na tela.
3. Para adicionar uma ação ao menu, consulte Adicionar ações .
4. (Opcional) No campo Rótulo , insira o rótulo visível do botão de menu.
NOTA
5. (Opcional) Para alterar o ícone do botão de menu padrão, no campo Ícone , execute uma das seguintes
tarefas:
• Digite o nome do ícone, como utility:arrowdown . Consulte Sistema de design Salesforce Lightning .
• Pesquise um ícone no campo de pesquisa, clique em um ícone para selecioná-lo e clique em Salvar .
6. (Opcional) Para desabilitar a rolagem na lista suspensa quando houver mais de 5 itens de menu,
desmarque Ativar estouro .
7. (Opcional) Para alterar a posição do menu suspenso, selecione uma nova posição na lista suspensa
Posição da lista suspensa. O padrão é esquerda .
8. (Opcional) Para alterar o tamanho do menu suspenso, selecione um novo tamanho na lista
suspensa Tamanho da lista suspensa.

company
9. (Opcional) Para selecionar uma variante de estilo, selecione um novo estilo na lista suspensa Variante .
10. (Opcional) Para alterar a posição do ícone no botão de menu em relação ao rótulo, selecione uma nova
posição na lista suspensa Posição do ícone .
11. (Opcional) Para ajustar o tamanho do ícone no botão de menu, selecione um novo tamanho na lista
suspensa Tamanho do ícone .
12. (Opcional) Para adicionar condições que devem ser atendidas para que o elemento seja ex ibido, consulte
13. (Opcional) Para estilizar seu elemento de menu, clique em Estilo para abrir o painel Estilo e veja
Propriedades de estilo de menu FlexCards .
Adicionar ações
Para cada novo item de ação, execute estas tarefas:
1. Clique em + Adicionar nova ação .

2. Selecione um tipo de ação para executar na lista suspensa Tipo de ação .
3. Para configurar as propriedades da ação, consulte Propriedades da ação FlexCards .
4. Para atualizar a posição do ícone de ação em relação ao rótulo, selecione uma nova posição na lista
suspensa Posição do ícone .
5. Para permitir que os itens de menu reflitam as notificações de nível de status como Erro, Sucesso e Aviso,
selecione a classe na lista suspensa Status .
Qual é o próximo
Veja também
• Propriedades do Menu FlexCards
Menu FlexCards
As propriedades do elemento de menu são configuráveis no painel de propriedades quando você seleciona um
elemento de menu no FlexCard Designer. Com o elemento Menu, crie um menu a partir de uma lista de ações.
Ver Adicione um Menu a um FlexCard .
Adicionar nova ação Adicione ações para preencher o menu. n/D
Elemento
Posição suspensa Selecione a posição do menu suspenso em relação ao botão de menu. n/D
Suspenso Tamanho Selecione o tamanho da lista suspensa. n/D
desenhista.
Ativar estouro Para desativar a rolagem no menu suspenso quando houver mais de 5 itens de n/D
menu, desative esse recurso. Habilitado por padrão.
Ícone Selecione o ícone a ser exibido. n/D
Posição do ícone Selecione a posição do ícone em relação ao rótulo. n/D
Ícone Tamanho Selecione o tamanho do ícone. n/D

company
Status Selecione um estilo SLDS para seu item de menu. Configure a partir do modal ao
clicar na propriedade Add New
Action .
Variante Selecione entre os estilos SLDS predefinidos para alterar a aparência do elemento. n/D
Veja Também
Adicionar um elemento de texto a um FlexCard

Combine texto simples e campos de mesclagem dentro de um editor de rich text com o elemento Text no
FlexCard Designer. Insira um campo de mesclagem, como campos de dados ou variáveis de contexto, como
variáveis de sessão. Para variáveis de contexto disponíveis e seus campos de mesclagem correspondentes,
consulte FlexCards Context Variables .
O editor de rich text do elemento Text adiciona um div HTML para cada seção de texto para construir o layout
do elemento. Adicione classes SDLS e NDS e outras opções de formatação a cada div para estilizar seu texto.
Adicionar Texto
1. No FlexCard Designer, arraste o elemento Text do painel Build para um estado na tela.
2. Para atualizar o texto padrão, no painel Propriedades, clique no editor de rich text para substituir o
conteúdo.
3. (Opcional) Para adicionar um novo bloco de texto, clique em retornar para criar um novo div.
4. (Opcional) Para adicionar valores de campo de dados, selecione na lista Campos no editor de rich text.
Você também pode adicionar o campo manualmente inserindo o nome do campo entre chaves simples,
como {Type} .
5. (Opcional) Para adicionar rótulos personalizados, insira o campo de mesclagem { Label.customLabelName
} em qualquer lugar do editor de rich text. Por exemplo, para adicionar um rótulo personalizado p ara
AccountName , insira { Label.AccountName } . Consulte Adicionar etiquetas personalizadas aos campos
suportados em um FlexCard .
6. (Opcional) Para adicionar uma variável de contexto como um campo de mesclagem, insira-a em qualquer
div. Por exemplo, digite { User.userProfileName } para adicionar o nome do perfil do usuário conectado.
Ver FlexCards Contexto Variáveis .
NOTA
A variável de contexto global User renderizada é visível apenas em tempo de execução,
como na visualização ou quando o FlexCard é publicado em uma página.
7. (Opcional) Para desfazer uma alteração, clique no ícone Desfazer .

8. (Opcional) Para refazer uma alteração desfeita, clique no ícone Refazer .
Estilizar texto com o editor de rich text

1. Para adicionar classes NDS ou SLDS para alterar o estilo do texto:
a. Clique em um div no editor de rich text.

company
b. Para ajustar o tamanho ou o estilo do texto, clique no menu suspenso Parágrafo e selecione uma ou
mais classes na seção Cabeçalhos ou Corpo .
c. Para alterar a cor do texto, clique no menu suspenso Parágrafo e selecione uma classe na seção Cor .
d. Para remover uma turma, selecione a turma novamente.
Para descrições de classe SLDS, consulte a documentação de texto SLDS .
2. Para atualizar manualmente o tamanho, peso, estilo, fonte e cor do texto, selecione o texto e, em
seguida, selecione uma das opções de formatação do editor de rich text.
Por exemplo, para tornar o texto em negrito, selecione o texto e clique no ícone B.
3. Para criar uma lista, ajustar o alinhamento ou definir o recuo, clique em um div e selecione nas opções de
formatação de lista, alinhamento ou recuo.
Por exemplo, para adicionar recuo, selecione o texto e selecione o ícone Aumentar recuo .
4. Para limpar a formatação, selecione o texto e clique no ícone Limpar formatação .
Qual é o próximo
(Opcional) Para estilizar seu elemento, clique em Estilo para abrir o painel Estilo e consulte Estilo de elementos
FlexCard .
Veja Também
• FlexCards Texto Elemento Propriedades
FlexCards Texto Elemento Propriedades

As propriedades do elemento de texto são configuráveis no painel de propriedades quando você seleciona um
elemento de texto no FlexCard Designer. Com o elemento Texto, combine texto simples e campos de
mesclagem usando um Editor de Rich Text. Ver Adicionar um texto Elemento para um FlexCard .
Elemento FlexCard
Veja Também
Acionar ações com o elemento de alternância em um FlexCard

Acione uma ação quando um usuário clicar em um elemento de alternância em um FlexCard . Permita que um
usuário escolha entre dois estados, ative ou desative uma opção ou selecione várias opções. Quando o
elemento é clicado, seu valor é enviado como parâmetro para a ação como verdadeiro ou falso, ou uma lista
separada por vírgulas de opções selecionadas pelo usuário com o campo de mesclagem { element.value } .
Você também pode atualizar a fonte de dados com o valor selecionado do elemento Alternar para todos os
tipos de alternância, exceto Grupo de Caixas de Seleção e Botão Grupo de Caixas de Seleção.
Adicionar e configurar alternar Elemento
1. No FlexCard Designer, arraste um elemento Toggle do painel Build para um estado na tela.

company
3. Na lista suspensa Tipo de alternância , selecione o tipo de elemento de alternância a ser usado. Ver
FlexCard Alternar Elemento Modelo Referência .
4. Para configurar o tipo de alternância selecionado, consulte Propriedades de alternância FlexCards .
5. (Opcional) Para desabilitar o elemento, no campo Desabilitado , selecione uma das seguintes opções:
• Selecionar verdadeiro .
• Para desabilitar a alternância do elemento com base no valor booleano (verdadeiro ou falso) de um
campo de mesclagem, selecione o campo de mesclagem na lista suspensa.
Por exemplo, em um FlexCard cuja fonte de dados retorna Cases, você pode desabilitar um elemento
de alternância se o campo IsEscalated do registro estiver definido como true.
NOTA
O campo de mesclagem deve ter um valor booleano (verdadeiro ou falso). Se o valor for
uma string, Disabled retornará false.
6. Para configurar a ação acionada ao clicar no elemento, consulte Adicionar uma ação abaixo. 7.
8. (Opcional) Para adicionar uma classe ao contêiner do elemento, insira uma classe no campo Classe Extra .
NOTA
tipo de alternância selecionado for um botão de caixa de seleção , consulte Propriedades de
estilo de alternância FlexCards .
Adicionar uma ação

Para configurar a ação que é acionada quando o elemento é clicado:
1. Clique em Adicionar Ação .

2. Para configurar as propriedades da ação, consulte Propriedades da ação FlexCards .
3. Para passar o valor do elemento de alternância como parâmetro:
a. Clique em Parâmetros de entrada .
b. Digite qualquer nome no campo Chave .
c. Insira { element.value } no campo Valor .
NOTA
Para passar o valor para uma ação sem parâmetros de entrada, como uma ação Navegar
cujo destino é uma página da Web, insira o par chave/valor como parâmetros de URL. Por
exemplo , / apex?keyname ={ element.value } .
Faça o download de um DataPack de amostra de elemento de alternância

Baixe um DataPack de amostra com elementos Toggle configurados. Consulte Baixar um DataPack de
alternância de amostra .
Qual é o próximo
company
Referência do tipo de elemento de alternância FlexCard
Selecione como acionar uma ação quando um usuário clica em um elemento Toggle em um FlexCard . Permita
que um usuário escolha entre dois estados, ative ou desative uma opção ou selecione várias opções para
acionar uma ação. Consulte Ações de gatilho com o elemento de alternância em um FlexCard .
Alternar Modelo Descrição Exemplo
Botão da caixa de seleção Exibe uma caixa de seleção com estilo de ícone que permite alternar entre duas opções, onde cada
estado pode exibir um ícone exclusivo. As opções configuráveis incluem adicionar um rótulo visível
ao lado do elemento.
Caixa de seleção Grupo Exibe um grupo de caixas de seleção com rótulos.
Caixa de seleção Grupo Exibe um grupo de caixas de seleção estilizadas como botões textuais clicáveis.
Botão
Caixa de seleção Alternar Exibe uma caixa de seleção com o estilo de um botão liga/desliga que permite alternar entre desativado
e ativado. Configurável as opções incluem a exibição etiquetas para cada estado .
Estado duplo Exibe um botão de ícone que permite alternar entre duas opções. Cada Estado pode exibir um
Botão único ícone .
Botão com estado Exibe um botão de ícone que permite alternar entre as opções selecionadas e não selecionadas
quando clicado e um estado de foco em foco. As opções configuráveis incluem adicionar um rótulo e
ícones exclusivos para todos os três estados e adicionar uma variante de estilo, como Marca .
Stateful Ícone Exibe um botão de ícone que permite alternar entre duas opções. O mesmo ícone é exibido para
ambos estados .
Veja Também
• Baixar uma alternância de amostra Pacote de dados
• FlexCards Alternar Propriedades
• FlexCards Alternar Estilo Propriedades
Baixar uma alternância de amostra Pacote de dados

Faça o download de uma amostra FlexCard de elemento de alternância DataPack na importação para sua
organização. Acionar uma ação quando um usuário clicar em um elemento Toggle em um FlexCard . Consulte
Ações de gatilho com o elemento de alternância em um FlexCard .
O DataPack de exemplo demonstra a aparência dos diferentes tipos de alternância e como atualizar campos de
dados com novos valores passados dos elementos.

company
O demoToggleDisplayActionUpdate FlexCard no DataPack inclui os seguintes recursos:
• Exibe todos os tipos de alternância. Consulte Referência de tipo de elemento de alternância FlexCard .
• Habilita e configura os elementos Checkbox Group, Checkbox Button e Checkbox Toggle para atualizar a
fonte de dados com novos valores. Ver FlexCards Alternar Propriedades .
• Um elemento de alternância de botão de grupo de caixa de seleção com uma ação de cartão que atualiza
um valor de campo. Consulte Adicionar uma ação para atualizar valores de campo em um FlexCard .
1. Baixe o OmniStudio para Vlocity DataPack aqui: demoToggleDisplayActionUpdate.json . Ver
NOTA
Baixe o OmniStudio DataPack aqui: demoToggleDisplayActionUpdate-OmniStudio.json .

company
NOTA
Veja Também
• FlexCards Alternar Propriedades
FlexCards Alternar Propriedades

As propriedades do elemento de alternância são configuráveis no Painel de propriedades quando você
seleciona um elemento de alternância no FlexCard Designer. Acione uma ação quando um usuário seleciona
um elemento Toggle. Consulte Ações de gatilho com o elemento de alternância em um FlexCard .
Propriedades comuns do elemento de alternância

Essas propriedades são compartilhadas por todos os tipos de elemento Toggle.
Adicionar Ação Adicione uma ação que é acionada quando um usuário clica no elemento de alternância. Adicionar um evento de clique a
um
FlexCard Elemento
FlexCard
Elemento
Classe Extra Insira uma classe anexada ao contêiner do elemento. Selecione uma classe definida no n/D
recurso Adicionar CSS personalizado do FlexCard Designer ou qualquer folha de estilo
disponível para o FlexCard .
Alternar Modelo Defina o tipo de elemento de alternância a ser exibido. alternância FlexCard
Referência de tipo
Alternar Elemento Propriedades

Propriedade Descrição Modelo
Alinhamento Selecione se deseja alinhar cada caixa de seleção horizontalmente ou Caixa de seleção Grupo
verticalmente.
Alternativo Texto Digite o texto para acessibilidade, visível quando a imagem não estiver Stateful Ícone
presente.
Verificado Defina o elemento de alternância a ser verificado por padrão. Ícone com estado, botão de caixa de
seleção,
Alternar caixa de seleção, botão com
estado, botão com estado duplo
Verificado Ícone Selecione o ícone visível quando o elemento estiver marcado. Botão de caixa de seleção, botão com
Nome estado duplo,

company
Botão com estado
Verificado Etiqueta Selecione o rótulo visível quando o elemento estiver marcado. Botão com estado, botão com estado duplo,
Caixa de seleção Alternar
Desabilitado Desative o elemento de alternância. Ou desative o elemento de Ícone com estado, botão de caixa de
alternância com base no valor de um campo de dados cujo valor retorne seleção,
true ou false. O campo deve ter um valor booleano . Se o valor retornar Alternar caixa de seleção, botão com
uma string, Disabled será false. estado, botão com estado duplo
Texto de ajuda Adicione texto visível quando o usuário passar o mouse sobre o ícone de Ícone com estado, botão de caixa de
ajuda i . seleção,
Botão de grupo de caixa de seleção, caixa
de seleção
Grupo , caixa de seleção Alternar
Ícone Nome Selecionar a ícone . Stateful Ícone
Ícone Sobre Flutuar Selecione o ícone visível ao passar o mouse sobre o elemento. Botão com estado
Etiqueta Insira um rótulo visível para o elemento. Ícone com estado, botão de caixa de
seleção,
de seleção
Etiqueta Sobre Flutuar Selecione o rótulo visível ao passar o mouse sobre o elemento. Botão com estado
Opções Insira um par de chave/valor para cada opção de caixa de seleção. Grupo de caixas de seleção, Grupo de caixas
de seleção
Botão
Requeridos Torne o elemento de alternância um campo obrigatório. Adiciona um Alternar caixa de seleção, grupo de caixas
asterisco ao lado do elemento. de seleção
Botão, grupo de caixas de seleção
Requeridos Etiqueta Adicione texto ao lado do asterisco quando Exigir estiver ativado. Ícone com estado, botão de caixa de
seleção,
de seleção
Desmarcado Ícone Selecione o ícone visível quando o elemento estiver desmarcado Botão de caixa de seleção, botão com
Nome estado duplo,
Botão com estado
Desmarcado Etiqueta Selecione o rótulo visível quando o elemento estiver desmarcado. Botão com estado, botão com estado duplo,
Caixa de seleção Alternar
Atualizar dados Atualiza a fonte de dados com o valor do estado selecionado do Ícone com estado, botão de caixa de
Fonte elemento de alternância. seleção,
Alternar caixa de seleção, botão com
estado, botão com estado duplo
Propriedade Descrição Modelo
Valor Adicione o valor padrão. Por exemplo, defina um valor como verdadeiro ou Grupo de caixas de seleção, Grupo de caixas
insira uma lista de opções selecionadas separadas por vírgulas. de seleção
Botão
Variante Selecione entre os estilos SLDS predefinidos para alterar a aparência do Botão com estado
elemento.
Veja Também
• Baixar uma alternância de amostra Pacote de dados
Adicionar condições a um elemento FlexCard

Exiba ou oculte elementos FlexCard com base no valor dos campos de dados. Por exemplo, exiba um ícone de
alerta ou texto suplementar apenas para Casos cujo Status seja Escalado.

company
Para aplicar condições a um estado, consulte Adicionar condições a um estado FlexCard .
IMPORTANTE
As condições aplicadas são visíveis apenas na visualização.
2. Selecione um elemento ao qual adicionar condições, como um elemento Icon.
3. No painel Propriedades, clique em +Adicionar novo ao lado de Condições .
4. Clique + Adicionar Condição .
5. Para crio básico condições :
a. Clique em Campo de dados , na lista de campos de dados, selecione um campo de dados para filtrar.
Por exemplo , selecione Status para um registro de caso .
b. Para definir a relação entre o campo de dados e um valor, selecione o Operador na lista suspensa,
como = .
c. No campo Valor , insira o valor a ser verificado. Por exemplo , digite Escalado .
NOTA
Para verificar um valor vazio, insira undefined como Valor .
d. Se adicionar outra condição, clique em + Adicionar condição e selecione E ou OU na lista suspensa

entre as condições:
• Selecione E se todas as condições devem ser atendidas.
Por exemplo, o status é escalado e a prioridade é alta.
NOTA
Se houver apenas uma condição, essa condição deverá ser atendida para exibir os
cartões.
• Selecione OU se alguma condição puder ser atendida.

Por exemplo, o status é escalado ou a prioridade é alta.
NOTA
Se houver apenas uma condição, essa condição não precisa ser atendida para exibir
cartões.
6. Para construir aninhado condições :

a. Clique em + Adicionar grupo após criar uma condição.
b. Clique em + Adicionar condição e insira valores para todos os campos de cada condição.
c. Selecione E ou OU na lista suspensa entre as condições.
Condições FlexCards
As propriedades de condições são configuráveis para todos os elementos no painel Propriedades no FlexCard
Designer. Mostre ou oculte elementos FlexCard com base em condições especificadas. Consulte Adicionar
condições a um elemento FlexCard .

company
Adicionar Doença Adicione uma condição que deve ser atendida com base nos valores do campo de dados.
Adicionar Grupo Crie expressões complexas agrupando condições. Um grupo é semelhante a incluir uma série de testes entre parênteses em
uma linguagem de programação. Por exemplo, para adicionar uma condição para casos de alta prioridade que são escalados ou
têm um
conta cuja receita esteja acima de um determinado número, crie dois grupos de condições conectados por um operador OR ,
como
as [Priority = High AND IsEscalated = true] OR [Priority = High AND AnnualRevenue > 500000] .
Campo de dados Selecione o campo de dados para avaliar.
Operador Selecione o operador de igualdade ou relacional que avalia o campo de dados em relação ao valor, como = , != , > e assim por
diante.
Valor Insira o valor para verificar.
Propriedades do elemento comum de FlexCards

FlexCard possuem propriedades compartilhadas por todos os elementos FlexCard . Por exemplo, qualquer
elemento pode ser mostrado ou ocultado com base nas condições definidas com a propriedade Conditions.
Elemento
desenhista.
FlexCard
Elemento
Estados do FlexCard
FlexCards têm estados. Cada estado exibe uma lista de campos de uma fonte de dados e uma ou mais ações.
Você também pode associar um estado a um ou mais submenus , que mostram dados complementares
exibidos como um modal ou popover.
FlexCard permitem a apresentação de diferentes interações de CRM por estado. Por exemplo, casos
encerrados têm ações de reabertura, enquanto casos escalados têm estilos diferentes têm uma ação para
visualizar o caso. FlexCards com estados diferentes apresentam dados diferentes.
Além de adicionar elementos diferentes dependendo do estado, você também pode definir condições para
determinar se, quando e como os dados são exibidos em um FlexCard . O FlexCard seleciona o primeiro estado
com condições verdadeiras para exibição. Consulte Adicionar condições a um estado FlexCard .
Você pode habilitar um estado de cartão em branco para exibir informações quando nenhum dado for
retornado da fonte de dados configurada.
Você pode personalizar cada cartão por seu estado para exibir várias ações clicáveis, informações e dicas
visuais opcionais. Por exemplo :
• Se um Caso for escalado, o Case FlexCard (por meio de seu estado) poderá ser exibido com uma borda
vermelha, texto vermelho e uma ação , como Exibir Caso .
• Um FlexCard para um caso fechado pode exibir o texto em cinza e uma ação para Reabrir Caso .

company
Adicionar um estado a um FlexCard
Adicione um estado adicional a um FlexCard para apresentar diferentes interações e layouts com base em
condições especificadas. Cada FlexCard tem um estado padrão que não pode ser excluído. Adicione um
elemento State à tela de um FlexCard ou clone um estado que já esteja na tela.
Adicionar um estado Elemento
1. No FlexCard Designer, arraste um elemento State do painel Build para a tela.
2. (Opcional) Para criar um estado a ser exibido quando não houver registros disponíveis, marque a caixa de
seleção Estado do cartão em branco . Por exemplo, quando uma fonte de dados não retornar nenhum
registro do objeto Política, crie um estado com uma ação OmniScript para adicionar uma Política.
3. No campo Nome , insira o nome do estado, como Ativo .
NOTA
O estado Nome é para uso interno e não aparece no LWC gerado ou na Visualização.
4. Para adicionar campos de dados e outros elementos, consulte Adicionar elementos a um FlexCard .
5. Para adicionar condições que devem ser atendidas para que o estado seja exibido, consulte Adicionar
condições a um estado FlexCard .
6. (Opcional) Para estilizar seu estado, clique em Estilo para abrir o painel Estilo e consulte Estilo de
Clonar um estado
1. Clique no ícone de mais quadrado duplo em um estado selecionado. O estado clonado aparece abaixo do
estado original.

company
2. (Opcional) Para criar um estado a ser exibido quando não houver registros disponíveis, marque a caixa de
seleção Estado do cartão em branco . Por exemplo, quando uma fonte de dados não retornar nenhum
registro do objeto Política, crie um estado com uma ação OmniScript para adicionar uma Política.
3. No campo Nome , insira um nome descritivo para o estado, como Sem dados .
NOTA
O nome é apenas para referência e não aparece no LWC gerado ou na visualização.
4. Para adicionar campos de dados e outros elementos, consulte Adicionar elementos a um FlexCard .
5. Para adicionar condições que devem ser atendidas para que o estado seja exibido, consulte Adicionar
condições a um estado FlexCard .
Qual é o próximo
Estilize seu elemento. Consulte Elementos de estilo FlexCard .
Veja também
• Estados do FlexCard
• FlexCards Estado Propriedades
Adicionar condições a um estado FlexCard

FlexCard permitem a apresentação de diferentes interações de CRM para cada estado. Defina condições para
determinar se, quando e como os dados são exibidos em um FlexCard .
Exemplo 5. Exemplo: Informações da Política FlexCard

Um FlexCard exibe informações de política para uma conta. Se a política estiver atualizada, o estado padrão
exibirá campos de dados e uma ação para atualizar as informações da conta. Se a política estiver prestes a
expirar, a política terá uma borda vermelha, uma notificação de alerta e uma ação para renovar a política.
NOTA
Ao organizar a ordem de seus estados na tela, coloque os estados em uma ordem lógica, onde a
primeira condição é verificada em relação à próxima e assim por diante. Normalmente, estados
com condições complexas precedem estados com estados simples, seguidos por um estado sem
condições e, em seguida, um estado de cartão em branco. O FlexCard seleciona o primeiro estado
com condições verdadeiras para exibição.
Por exemplo, a ordem dos estados para o exemplo anterior seria:
1. Estado 1 - Condição: DaysToExpiration < 31 && DaysToExpiration != Null (vazio)

2. Estado 2 - Sem condições
3. Estado 3 - Estado do cartão em branco (nenhum registro retornado)

company
IMPORTANTE
As condições aplicadas são visíveis apenas na visualização.
2. Selecione um estado e clique no ícone de lápis ao lado de Condições no painel Propriedades.
3. Clique + Adicionar Condição .
4. Para crio básico condições :
a. Clique no campo de dados , na lista de campos de dados, selecione um campo de dados para filtrar,
como
DaysToExpiration .
b. Para definir a relação entre o campo de dados e um valor, selecione um operador na lista suspensa
Operador , como < .
c. No campo Valor , insira o valor a ser verificado em relação ao campo de dados, como 31 .
NOTA
A partir do verão de 21, se o seu FlexCard for um FlexCard infantil , use o
{ Parent.attributeName } para verificar o valor de um atributo passado para o filho do
FlexCard pai . Ver FlexCards Contexto Variáveis .
d. Se adicionar outra condição, clique em + Adicionar condição e selecione E ou OU na lista suspensa

entre as condições:
• Selecione E se todas as condições devem ser atendidas.
• Por exemplo, o status da apólice é comprado E a data de vencimento é inferior a 31 dias.
NOTA
Se houver apenas uma condição, essa condição deverá ser atendida para exibir os
cartões.
• Selecione OU se alguma condição puder ser atendida.

• Por exemplo, o status da política é fechado OU a data de expiração é inferior a 31 dias.
NOTA
Se houver apenas uma condição, essa condição não precisa ser atendida para exibir
cartões.
5. Para construir aninhado condições :

a. Clique em + Adicionar grupo após criar uma condição, como DaysToExpiration < 31 .
b. Clique em + Adicionar condição e insira valores para todos os campos de cada condição.
c. Selecione E ou OU na lista suspensa entre as condições.
Por exemplo, use o recurso de condições para construir a expressão condicional DaysToExpiration <
31 E ( PolicyType = Vida Universal OU PolicyType = Variável Universal
Life) para filtrar apólices prestes a expirar e cujo tipo de apólice seja Universal Life ou Universal Variable
Life.

company
Veja Também
• FlexCards Estado Propriedades
FlexCards Estado Propriedades

Esta página contém listas de propriedades de elementos de estado de FlexCards disponíveis. Adicione estados
adicionais a um FlexCard para apresentar diferentes interações e layouts com base em condições
especificadas. Ver Adicionar um estado para um FlexCard .
Estado do cartão em Exiba esse estado quando não houver dados retornados de uma fonte de dados. n/D
branco
Nome Insira um nome descritivo para o estado. O nome do estado é apenas para referência e não n/D
aparece no LWC gerado ou na visualização.
Condições Defina quando e como um estado é exibido com base nas condições especificadas. Adicionar condições a um
Estado do FlexCard
Veja Também
company
Configurar uma fonte de dados em um FlexCard

Configure uma fonte de dados em um FlexCard para recuperar dados de um objeto Salesforce ou de um banco
de dados externo. Um FlexCard filho pode ter uma fonte de dados independente do FlexCard pai ou usar a
fonte de dados do FlexCard pai .
Configure uma fonte de dados ao criar um FlexCard usando o assistente de configuração. Ou configure uma
fonte de dados no painel Configuração no FlexCard Designer. Ver Configure um FlexCard no _ _ Desenhista
FlexCard .
NOTA
Para flexibilidade ideal e implementação mais fácil, use um Procedimento de Integração como
fonte de dados para executar várias ações em uma única chamada de servidor. Consulte Configurar
uma fonte de dados do procedimento de integração em um FlexCard .
NOTA
Os administradores podem habilitar ou desabilitar fontes de dados para uma organização, perfil e
nível de usuário. Ver Permitir e Desabilite as fontes de dados .
Veja Também
• Fonte de dados FlexCards Referência
• Fonte de dados FlexCards Propriedades
• Incorporar um FlexCard infantil dentro de um FlexCard
Referência da fonte de dados FlexCards

Selecione entre vários tipos de fonte de dados para recuperar dados de um objeto do Salesforce ou de um
banco de dados externo. Selecione uma fonte de dados no painel Configuração no FlexCard Designer ou ao
criar um FlexCard .
Consulte Configurar uma fonte de dados em um FlexCard .

Fonte de dados Descrição Referência
Modelo
Apex Remoto Usa uma classe e um método remoto do Apex para retornar dados. Uma classe Apex Configurar um Apex Remote
Remote é uma classe Apex padrão que implementa o VlocityOpenInterface . Fonte de dados em um
FlexCard
Apex REST Usa um endpoint REST de uma classe do Apex para retornar dados de um servidor ou Configurar um REST do Apex
postar dados em um servidor. Fonte de dados em um
FlexCard
Personalizado Usa JSON de amostra para configurar um FlexCard com dados temporários, permitindo que Configurar dados
você incorpore JSON diretamente no layout sem depender de dados externos. personalizados
Fonte em um FlexCard
DataRaptor Usa uma interface DataRaptor Extract para retornar dados. A segurança em nível de campo Configurar um DataRaptor
é totalmente suportada. Ver OmniStudio DataRaptors . Fonte de dados em um
FlexCard

company
Integração Usa um Procedimento de Integração para retornar dados. Os Procedimentos de Integração Configurar uma fonte de
Procedimentos são processos declarativos do lado do servidor que executam várias ações em uma única dados do procedimento de
chamada de servidor. Ver OmniStudio Procedimentos de Integração . integração em um FlexCard
Evento de Usa a plataforma de mensagens corporativas Platform Events da Salesforce , que Configurar um evento de
plataforma combina PushTopic e Streaming Channel para permitir que os aplicativos se comuniquem plataforma
dentro e fora do Salesforce. Fonte de dados em um
FlexCard
PushTopic Usa uma consulta do Salesforce Object Query Language (SOQL) para retornar um resultado Configurar um PushTopic
que notifica os ouvintes sobre as alterações nos registros em uma organização do Fonte de dados em um
Salesforce. o FlexCard
PushTopic define um canal de API de streaming. Consulte API de streaming do Salesforce .
REST: Nomeado Usa a chamada padrão da API REST para postar dados em um servidor ou retornar dados da Configurar dados REST
Credencial URL de um endpoint de callout e seus parâmetros de autenticação necessários em uma Fonte usando nomeado
definição. Credenciais em um FlexCard
REST: Web Usa a chamada da API REST padrão para postar dados em um servidor ou retornar dados da Configurar uma Web REST
URL de um endpoint de chamada. Fonte de dados em um
FlexCard
SDK Usa um método de um SDK para obter dados para preencher campos em um FlexCard . Fonte de dados do SDK
FlexCard
Consulta SOQL Usa uma linguagem de consulta de objetos do Salesforce (SOQL) para pesquisar os dados Configurar uma consulta
do Salesforce de uma organização para obter informações específicas. Por exemplo , SOQL
SELECT Name , Id FROM Account LIMIT 5 . Fonte de dados em um
FlexCard
NOTA
Se a segurança for uma preocupação, use um DataRaptor em
vez de uma consulta SOQL, pois o DataRaptors oferece suporte
total à segurança em nível de campo.
Pesquisa SOSL Usa um Salesforce Object Search Language (SOSL) para construir consultas de pesquisa Configurar uma pesquisa
baseadas em texto em relação ao índice de pesquisa. SOSL
Fonte de dados em um
FlexCard
Transmissão Usa a API de streaming do Salesforce para enviar notificações de eventos gerais que não Configurar uma transmissão
Canal estão vinculados a alterações de dados do Salesforce. Fonte de dados do canal em
um
FlexCard
Veja Também
Fonte de dados FlexCards Propriedades

FlexCard Data Source são configuráveis para cada tipo de fonte de dados no painel Setup do FlexCard
Designer. Recupere dados de um objeto do Salesforce ou de um banco de dados externo. Consulte Referência
de fonte de dados FlexCards .
Propriedades comuns da fonte de dados
Essas propriedades são compartilhadas por todas as fontes de dados. Consulte Configurar uma fonte de dados
em um FlexCard .
Delay( ms ) disponível a partir do verão de 21.

Fonte de dados Modelo Selecione o tipo de fonte de dados.
Atraso ( ms ) Para evitar o agrupamento dessa chamada de fonte de dados com outras solicitações do servidor e enfatizar sua
prioridade, insira um tempo de atraso em milissegundos.

company
de busca ( ms ) Defina um valor de tempo limite apropriado para permitir que o aplicativo e os usuários reajam de acordo com longos
tempos de espera. O valor de tempo limite controla o tempo que a estrutura aguarda até que a fonte de dados
designada retorne uma resposta.
Mapa de entrada Quando necessário, passe as variáveis do FlexCard para a fonte de dados.
Chave Digite a variável para passar. Por exemplo, passe o contextId AccountId .
Ordem Por Ordene os registros por um campo especificado.
Atualizar Intervalo ( ms ) Defina um intervalo para habilitar atualizações recursivas de registros. A fonte de dados é atualizada continuamente no
intervalo determinado e verifica as alterações nos registros da fonte de dados. Se alterações são encontradas , o FlexCard
recarrega .
Caminho JSON do Para detalhar um conjunto de dados específico , insira um caminho JSON, como ['Cases'] . Se todo o seu JSON for uma
resultado matriz, como [{ "Cases": [{...},{...}]}] , insira o índice com o caminho. Por exemplo , digite [0] ['Casos'] .
Ordem Inversa Inverta a ordem dos registros retornados.
Parâmetros de teste Visualize um FlexCard usando dados reais adicionando variáveis de teste que a consulta pode usar para retornar dados ao
vivo.
Valor Insira o valor para a variável. Por exemplo, insira um campo de mesclagem, como { recordId } ou um valor estático, como
o ID de conta alfanumérico encontrado no URL de uma página de registro de conta.
Propriedades da fonte de dados remota do Apex

Essas propriedades são exclusivas da fonte de dados do Apex Remote. Consulte Configurar uma fonte de
dados remota do Apex em um FlexCard .
Assíncrono Chama a classe do Apex de forma assíncrona usando o método de sondagem longa.
Mapa de opções Envie pares de chave/valor adicionais para o Mapa de Entrada passado para o método remoto. Insira uma chave no primeiro
campo e seu valor no segundo campo. O valor suporta campo de mesclagem sintaxe como { Nome } . _
Votação Intervalo Especifica o intervalo de sondagem em milissegundos para verificar o status da resposta.
Aula Remota A classe remota do Apex a ser invocada.
Método remoto O método do Apex a ser chamado.
Propriedades da fonte de dados REST do Apex

Essas propriedades são exclusivas da fonte de dados REST do Apex. Consulte Configurar uma fonte de dados
REST do Apex em um FlexCard .
Ponto final do Apex A URL do ponto de extremidade REST do Apex.
Carga JSON Insira a resposta formatada em JSON.
Método Especifica que tipo de chamada fazer: GET ou POST.
fonte de dados do DataRaptor

Essas propriedades são exclusivas da fonte de dados DataRaptor . Consulte Configurar uma fonte de dados
DataRaptor em um FlexCard .
Nome da interface Selecione o DataRaptor para buscar os dados.
Propriedades da fonte de dados do procedimento de integração

Essas propriedades são exclusivas da origem de dados do Procedimento de Integração. Consulte Configurar
uma fonte de dados do procedimento de integração em um cartão Flex .
Nome Selecione o Procedimento de Integração para buscar os dados.
Propriedades da fonte de dados REST

company
Essas propriedades são exclusivas da origem de dados REST. Consulte Configurar uma fonte de dados da Web
REST em um FlexCard . Consulte Configurar uma fonte de dados REST usando credenciais nomeadas em um
FlexCard .
Ponto final Insira o caminho relativo para obter o que você precisa da API, como My_Payroll_System /paystubs?
formato = json .
Cabeçalhos Passe informações adicionais de uma solicitação ou resposta HTTP com um cabeçalho HTTP.
Carga JSON Insira a resposta formatada em JSON.
Método Selecione um método GET ou POST.
Nomeado Credencial Selecione uma credencial nomeada criada em Configuração > Credencial nomeada em sua organização.
tipo REST Selecione o tipo de terminal REST a ser acessado.
Propriedades do SDK
Essas propriedades são exclusivas da fonte de dados do SDK. A fonte de dados SDK está disponível a partir da
versão Summer '21. Ver Fonte de dados FlexCard SDK .
Editar como JSON Adicione ou modifique os parâmetros de entrada como JSON.
SDK Selecione na lista de SDKs disponíveis para buscar dados.
Método SDK Selecione a função SDK para fornecer dados para o FlexCard .
Propriedades da consulta SOQL

Essas propriedades são exclusivas da fonte de dados SOQL Query. Consulte Configurar uma fonte de dados de
consulta SOQL em um FlexCard .
Consulta Insira uma expressão SOQL para pesquisar informações específicas no banco de dados do Salesforce de uma organização. Por
exemplo, SELECT Id, FirstName, LastName Email, Phone, Title FROM Contact WHERE Phone != Null .
Propriedades da fonte de dados de pesquisa SOSL

Essas propriedades são exclusivas da fonte de dados SOSL Search. Consulte Configurar uma fonte de dados de
pesquisa SOSL em um FlexCard .
Dentro Selecione em quais campos pesquisar.
Limite para Limite o número máximo de linhas a serem retornadas.
Retornando sObject & Fields Selecione pelo menos um sObject e um campo para pesquisar.
Procurar por Insira o termo de pesquisa a ser pesquisado.
Propriedades da fonte de dados da API de streaming

Essas propriedades são exclusivas da fonte de dados da API de streaming. Consulte Fontes de dados da API de
streaming de Vlocity .
Canal Insira o URL do aplicativo que você criou.
Pegue Tudo Mensagens Selecione se deseja obter todas as mensagens das últimas 24 horas ou obter a atualização de dados mais recente.
Operações Selecione o tipo de operação a ser executada. Selecione Substituir para substituir o FlexCard por novos dados ou Anexar
para adicionar novos dados ao FlexCard .
Modelo Selecione um tipo de API de streaming.
Ativar e desativar fontes de dados

Habilite e desabilite tipos de fonte de dados para uma organização, perfil ou nível de usuário na
configuração personalizada Card Framework Configuration. Por exemplo, desative Apex REST, Apex
company
Remote e outras fontes de dados complexas para toda a sua organização ou impeça que administradores de
sistema com permissões limitadas usem essas fontes de dados.
Configurar uma fonte de dados DataRaptor em um FlexCard

Configure uma fonte de dados do DataRaptor para buscar dados de uma extração do DataRaptor . DataRaptor
é uma ferramenta de mapeamento que permite ler, transformar e gravar dados do Salesforce.
Ver Visão geral do DataRaptor .
NOTA
Para flexibilidade ideal e implementação mais fácil, use um Procedimento de Integração como fonte
de dados para executar várias ações em uma única chamada de servidor. Consulte Configurar uma
fonte de dados do procedimento de integração em um FlexCard .
Antes de começar
• Crie uma extração do DataRaptor . Consulte Criar uma extração do DataRaptor .
1. Para configurar a fonte de dados ao criar um FlexCard , navegue até a etapa Select Data Source Type ,
selecione DataRaptor e clique em Next .
2. Para configurar a fonte de dados a partir do painel SetUp no FlexCard Designer, clique em Setup e
selecione DataRaptor na lista suspensa Data Source Type .
3. Clique no nome da interface campo e selecione uma extração do DataRaptor .
4. Para passar uma variável para o DataRaptor , clique em + Adicionar Novo ao lado de Mapa de Entrada .
Exemplo 6. Passe a ContextId
Por exemplo, para usar o recordId variável de contexto para obter dinamicamente o ContextId de
FlexCard :
1. Em uma nova guia, vá para o Vlocity Na guia DataRaptor Designer, abra o DataRaptor Extract
selecionado em Interface Name e clique na guia Preview para visualizar os Input Parameters .
2. No campo Chave do Mapa de Entrada , insira a variável que representa o ContextId , como
AccountId .
3. No campo Valor do Mapa de Entrada , insira { recordId } como o valor.
5. (Opcional) Para configurar outras opções comuns entre todas as fontes de dados, consulte FlexCards Data
Source Properties .
6. Para testar as configurações da fonte de dados, adicione variáveis de teste que a consulta pode usar para
retornar dados ativos, consulte Testar configurações da fonte de dados em um FlexCard .
Qual é o próximo
Adicione elementos ao FlexCard . Consulte Adicionar elementos a um FlexCard .
Veja também
• Propriedades da fonte de dados FlexCards
Configurar uma fonte de dados do procedimento de integração em um FlexCard

Configure uma fonte de dados para usar um Procedimento de Integração de Vlocity para executar várias ações
em uma única chamada de servidor. Por exemplo, como administrador de sistemas, você deseja que
seus representantes de atendimento ao cliente visualizem a previsão do tempo dos segurados durante
company
uma ligação. Você pode usar um procedimento de integração com uma extração do DataRaptor que retorna o
CEP de uma conta e uma chamada da API REST que usa o CEP para obter a previsão atual para a região da
conta.
Ver OmniStudio Procedimentos de Integração .
NOTA
Um procedimento de integração não é compatível com as seguintes fontes de dados:
• Linguagem de pesquisa de objetos do Salesforce (SOSL)

• API de transmissão
• Fora da plataforma
Antes de começar
• Crie um Procedimento de Integração. Consulte Criar um procedimento de integração .
selecione Integration Procedures e clique em Next .
2. Para configurar a fonte de dados a partir do Painel de Configuração no FlexCard Designer , clique em
Configuração e selecione Procedimentos de Integração na lista suspensa Tipo de Fonte de Dados .
3. Clique no campo Nome e selecione um Procedimento de Integração a ser usado.
4. Para passar uma variável para o Procedimento de Integração, clique em + Adicionar Novo ao lado de
Mapa de Entrada .
Exemplo 7. Passe o ContextId

Por exemplo, para usar o recordId variável de contexto como um campo de mesclagem para obter
dinamicamente o ContextId de um FlexCard :
1. Em uma nova guia, vá para a guia Vlocity Integration Procedures, abra o Integration Procedure
selecionado em Name e clique na guia Preview para visualizar os Input Parameters .
2. No campo Chave do Mapa de Entrada , insira a variável que representa o ContextId , como
AccountId .
3. No campo Valor do Mapa de Entrada , insira { recordId } como o valor.
Source Properties .
Adicionar dados fictícios de um procedimento de integração

1. Em um procedimento de integração atual ou novo, inclua uma etapa de ação de resposta .

company
2. Use um dos dois métodos para adicionar dados JSON fictícios:
• Para um pequeno conjunto de dados :
a. Na guia Propriedades, clique em RESPOSTA DE SAÍDA ADICIONAL .
b. Para cada par de chave/valor, clique no botão Adicionar par de chave/valor e adicione
seus dados.

company
• Para um grande conjunto de dados :
a. Clique no link Editar como JSON no canto superior direito da guia Propriedades.
b. No nó AdditionalOutput , insira seus dados JSON completos como um objeto.

company
3. (Opcional) Se o Procedimento de Integração tiver outras fontes de dados, para retornar apenas os dados
fictícios, marque a caixa de seleção ao lado do rótulo Retornar Apenas Saída Adicional .
4. No painel de configuração do seu FlexCard , confirme se o Procedimento de Integração com os dados

fictícios está escolhido no campo Nome .
5. Para visualizar seus dados fictícios, clique em Salvar e buscar .
Qual é o próximo
company
Veja também
Configurar uma fonte de dados de consulta SOQL em um FlexCard

Configure uma fonte de dados para usar uma consulta do Salesforce Object Query Language (SOQL) para
pesquisar os dados de uma organização para obter informações específicas. As consultas SOQL são
criptografadas para que os FlexCards não exibam informações de consulta
do lado do cliente. Se a segurança for uma preocupação, use um DataRaptor em vez de uma consulta SOQL,
pois o DataRaptors fornece segurança em nível de campo.
NOTA
Ao mapear campos, apenas os campos no seletor de campo que possuem valores não nulos
para o registro específico na consulta de teste ficam visíveis. Use um registro de teste que você
sabe que tem valores não nulos para todos os campos que deseja mapear. Ou use campos
personalizados se o registro de teste não tiver os campos que você deseja mapear.
NOTA
selecione SOQL Query e clique em Next .
2. Para configurar a fonte de dados no painel SetUp no FlexCard Designer, clique em Setup e selecione
SOQL Query na lista suspensa Data Source Type .
3. Insira uma expressão SOQL no campo Consulta .
Por exemplo, digite o seguinte para obter campos do objeto Contato, limite-o a 10 e retorne apenas
registros que tenham um endereço de e-mail:
SELECT Id, Nome, Email, Telefone, Título FROM Contact WHERE Email != Null
LIMITE 10
Source Properties .
Qual é o próximo
Veja também
Configurar uma fonte de dados de pesquisa SOSL em um FlexCard

Construa consultas de pesquisa baseadas em texto em relação ao índice de pesquisa com o Salesforce Object
Search Language (SOSL). Você pode pesquisar campos de texto, email e telefone para vários objetos aos quais
tem acesso, incluindo objetos personalizados, em uma única consulta. As consultas SOSL são
criptografadas para que os FlexCards não exibam informações de consulta no lado do cliente.
company
Ver Referência SOSL e SOQL
selecione SOSL Search e clique em Next .
selecione SOSL Search na lista suspensa Data Source Type .
3. Insira o termo de pesquisa no campo Pesquisar por .
4. Selecione em quais campos pesquisar na lista suspensa Em .
5. Na seção Retornando sObject & Fields , selecione pelo menos um sObject para pesquisar:
a. Clique no campo sObject e selecione um objeto, como Conta.
b. Selecione um ou mais campos de dados na lista suspensa Campo .
c. (Opcional) Para adicionar objetos e campos adicionais, clique em + Adicionar sObject .
6. (Opcional) Para limitar o número máximo de linhas a serem retornadas, insira um número no campo
Limitar a .
Source Properties .
Qual é o próximo
Veja também
Configurar uma fonte de dados personalizada em um FlexCard

Incorpore dados JSON personalizados diretamente no FlexCard sem depender de nenhuma fonte de dados
externa. Configure a fonte de dados personalizada para teste com dados estáticos temporários. Por exemplo,
quando você está aguardando o acesso a uma API ou se deseja testar rapidamente um conceito.
selecione Custom e clique em Next .
selecione Custom na lista suspensa Data Source Type .
3. Insira JSON personalizado no campo JSON personalizado .
Exemplo 8. Exemplo de JSON personalizado

[
{
"atributos": {
"tipo": "Contato",
" url ": " /services/data/v49.0/sobjects /Contact/
0033700000TOF0eAAH"
},
"Nome": "Perry",
"Id": "0033700000TOF0eAAH",
"Telefone": "(734) 489-5851",
" AccountId ": "0013700000NVVLvAAP",

company
"E-mail": "perry@vlocity.com",
" Endereço de correspondência ": {
"cidade": "Concórdia",
"país": "EUA",
" geocodeAccuracy ": null,
"latitude": null,
"longitude": nulo,
" código postal": " 53813 ",
"state": "WI", "street": "856 4th Avenue #76"
},
" CriadoData ": "2017-06-14T18:53:11.000+0000"
},
{
"atributos": {
"tipo": "Contato",
0033700000TOB6mAAH"
},
"Nome": "Robert0 Taylor",
"Id": "0033700000TOB6mAAH",
"Telefone": "(888) 888-8888",
" AccountId ": "00137000007D63JAAS",
"cidade": "SF",
"país": "EUA",
"latitude": null,
"longitude": nulo,
" código postal ": "99999",
"estado": "CA",
"rua": "Rua Santa Rita 50"
},
" CriadoData ": "2017-06-13T21:08:25.000+0000"
},
{
"atributos": {
"tipo": "Contato",
0033700000TNvK0AAL"
},
"Nome": "c1",
"Id": "0033700000TNvK0AAL",
" AccountId ": "0013700000NVE4tAAH",
" MailingAddress ": null,
" CriadoData ": "2017-06-08T20:13:41.000+0000"
},
{
"atributos": {
"tipo": "Contato",
company
0033700000TNvKKAA1"
},
"Nome": "c2",
"Id": "0033700000TNvKKAA1",
" AccountId ": "0013700000NVE4tAAH",
" MailingAddress ": null,
" CriadoData ": "2017-06-08T20:13:50.000+0000"
},
{
"atributos": {
"tipo": "Contato",
0033700000Vs6RzAAJ"
},
"Nome": "Smith",
"Id": "0033700000Vs6RzAAJ",
"Telefone": "(300) 333-3763",
" AccountId ": "001370000098i8mAAA",
"cidade": "SF",
"país": "EUA",
"latitude": null,
"longitude": nulo,
" código postal ": "99999",
"estado": "CA",
"rua": "50 Fremont St"
},
" CriadoData ": "2017-08-16T20:26:07.000+0000"
}
]
Source Properties .
Qual é o próximo
Veja também
Configurar uma fonte de dados REST do Apex em um FlexCard

Configure uma fonte de dados para usar uma chamada REST do Apex para buscar dados para preencher
campos em um FlexCard com o método Get . Use o método Post para postar dados de volta no servidor.

company
NOTA
1. Para configurar a fonte de dados ao criar um FlexCard , navegue até a etapa Selecionar tipo de fonte de
dados , selecione Apex Rest e clique em Avançar .
2. Para configurar a fonte de dados no painel SetUp no FlexCard Designer, clique em Setup e selecione Apex
Rest na lista suspensa Data Source Type .
3. Insira a URL do endpoint no campo Endpoint . Por exemplo, /services/ apexrest /{namespace}/
CardTestApexRestResource /{ recordId }
4. Selecione um tipo de método no menu suspenso Método :
• Selecione GET para solicitar dados especificados pelos parâmetros da URL.
• Selecione POST para enviar dados JSON.
• Insira os dados JSON a serem enviados no campo JSON Payload .
NOTA
Você pode usar variáveis de contexto para passar valores herdados com qualquer um dos
métodos. Ver FlexCards Contexto Variáveis .
Source Properties .
Qual é o próximo
Veja também
Configurar uma fonte de dados remota do Apex em um FlexCard

Configure uma fonte de dados para invocar uma classe Apex e um método que busca dados para preencher
um FlexCard . As fontes de dados remotas do Apex podem ser executadas de forma assíncrona por meio do
Apex, o que aumenta o tempo de CPU, mas garante que as transações de longa duração não atinjam o tempo
limite.
NOTA
de dados para executar várias ações em uma única chamada de servidor. Consulte Configurar uma fonte
de dados do procedimento de integração em um FlexCard .
Antes de começar

company
1. Conheça a classe e o método remoto do Apex que você precisa invocar antes de configurar uma fonte de dados remota. Os pacotes gerenciados
podem incluir classes e métodos remotos do Apex.
Para ver as classes do Apex existentes:
a. Em sua organização, vá para Configuração e, na caixa Busca rápida , insira Apex .
b. Clique em Classes do Apex .
2. Adicione um verificador de permissões de classe do Apex para garantir que apenas usuários autorizados possam acessar classes
VlocityOpenInterface (APIs) de uma ação remota em um cartão. Ver Adicionando uma classe Apex Verificador de permissões .
dados , selecione Apex Remote e clique em Avançar .
2. Para configurar a fonte de dados no Painel de configuração no FlexCard Designer , clique em
Configuração e selecione Apex Remote na lista suspensa Tipo de fonte de dados .
3. Insira o nome da classe remota no campo Classe Remota .
IMPORTANTE
A Classe Apex deve implementar a Interface Aberta Vlocity , caso contrário, uma mensagem
de erro será exibida.
4. Insira o nome do método remoto no campo Método Remoto .

Por exemplo, você pode acessar o método getStories remoto do Apex da classe remota do Apex
StoryListHandler .
5. (Opcional) Para passar uma variável do FlexCard para o método de classe remota, clique em + Adicionar
novo ao lado de Mapa de entrada e execute as seguintes tarefas:
a. No campo Chave, insira a variável a ser transmitida. Por exemplo, passe o ContextId AccountId .
b. No campo Valor, insira o valor da variável. Por exemplo, insira um campo de mesclagem, como {
recordId } ou um valor estático, como o ID de conta alfanumérico encontrado no URL de uma página
de registro de conta.
6. (Opcional) Para enviar pares de chave/valor adicionais ao Mapa de entrada passado para o método
remoto, clique em +Adicionar novo ao lado de Mapa de opções . Insira uma chave no primeiro campo e
seu valor no segundo campo. O valor suporta campo de mesclagem sintaxe como { Nome } . _
NOTA
Por padrão , o objeto de continuação NS.IntegrationProcedureService é definido para você
usar chamadas assíncronas para fazer solicitações de longa duração de uma página do
Visualforce para um serviço Web externo e processar respostas em métodos de retorno de
chamada. NS representa o Namespace da sua organização, como vlocity_ins ou vlocity_cmt ,
como em vlocity_ins.IntegrationProcedureService .
7. (Opcional) Para executar de forma assíncrona por meio do Apex, selecione É assíncrono .
8. (Opcional) Para especificar o intervalo de sondagem para verificar o status da resposta, insira o tempo em
milissegundos no campo Intervalo de sondagem .
Source Properties .
Qual é o próximo
Veja também
company
Configurar uma fonte de dados REST usando credenciais nomeadas em um FlexCard

Use credenciais nomeadas para autenticar chamadas do Apex ao configurar uma fonte de dados REST. Uma
credencial nomeada especifica a URL de um ponto de extremidade de callout e seus parâmetros de
autenticação necessários em uma definição.
Para criar uma credencial nomeada, consulte Credenciais nomeadas como pontos de extremidade de
chamada .
NOTA
de dados para executar várias ações em uma única chamada de servidor. Consulte Configurar uma
fonte de dados do procedimento de integração em um FlexCard .
Antes de começar
• Crie uma credencial nomeada. Consulte Definir uma credencial nomeada .
selecione REST e clique em Next .
selecione REST na lista suspensa Data Source Type .
3. Selecione Credencial Nomeada na lista suspensa Tipo REST .
4. Na lista suspensa Credencial nomeada , selecione uma credencial nomeada criada em Configuração >
Credencial nomeada em sua organização.
5. Insira um caminho relativo no campo Endpoint para obter o que você precisa da API, como
My_Payroll_System / paystubs?format = json .
NOTA
7. (Opcional) Para adicionar qualquer cabeçalho de solicitação, clique em + Adicionar novo ao lado de
Cabeçalhos para adicionar qualquer cabeçalho de solicitação.
NOTA
A maioria das APIs de terceiros espera vários cabeçalhos, como tokens, chaves públicas e tipo
de conteúdo.
Source Properties .

company
Qual é o próximo
Veja também
Configurar uma fonte de dados da Web REST em um FlexCard

Configure uma fonte de dados da Web REST para obter ou postar dados de ou para uma API pública. Por
exemplo, obtenha dados meteorológicos de uma API meteorológica com base no código postal do titular da
apólice.
Para configurar uma fonte de dados REST com credenciais nomeadas para autenticar chamadas do Apex,
consulte Configurar uma fonte de dados REST usando credenciais nomeadas em um FlexCard .
NOTA
selecione REST e clique em Next .
selecione REST na lista suspensa Data Source Type .
3. Selecione Web na lista suspensa do tipo REST .
4. No campo Endpoint , insira a URL do endpoint REST. Por exemplo :
http://api.weatherstack.com/current?
access_key ={ Session.weatherAPIkey }&query={ BillingCity }
NOTA
6. (Opcional) Para adicionar qualquer cabeçalho de solicitação, clique em + Adicionar novo ao lado de
Cabeçalhos para adicionar qualquer cabeçalho de solicitação.

company
NOTA
A maioria das APIs de terceiros espera vários cabeçalhos, como tokens, chaves públicas e tipo
de conteúdo.
Source Properties .
Qual é o próximo
Veja também
Fontes de dados da API de streaming de Vlocity

A API de streaming permite enviar um fluxo de notificações do Salesforce para aplicativos clientes com base
em critérios definidos por você. Ele tem uma conexão persistente que continua a fornecer novos dados à
medida que se tornam disponíveis, em vez de usar a pesquisa do cliente.
A sondagem é a maneira mais tradicional de obter dados de uma fonte de dados que produz o fluxo de
eventos e atualizações. O cliente faz solicitações periodicamente e o servidor envia dados se houver uma
resposta. Caso não haja dados a serem enviados pelo servidor, uma resposta vazia é retornada.
A API de streaming usa a tecnologia push, que é um modelo de publicação e assinatura que transfere
informações iniciadas de um servidor para o cliente. A tecnologia push transfere informações iniciadas de um
servidor para o cliente. Esse tipo de comunicação é o oposto do polling, onde uma solicitação de informações
é feita de um cliente para o servidor. Os principais benefícios de usar a API de streaming são um número
reduzido de chamadas de API e desempenho aprimorado.
Para obter detalhes sobre a API de streaming, consulte Usar a API de streaming e Guia do desenvolvedor da
API de streaming .
Esta ilustração mostra a diferença entre a API de Polling e Streaming:

company
Tipos de API de streaming
Os tipos de API de streaming Vlocity incluem:
Modelo Descrição Exemplo
Canal de transmissão O tipo de API Streaming Channel usa a API Streaming para enviar notificações de Configurar uma fonte de
eventos gerais que não estão vinculados a alterações de dados do Salesforce. dados de canal de
streaming em um
FlexCard
PushTopic Um PushTopic é uma consulta SOQL que retorna um resultado que notifica os ouvintes Configurar um
sobre as alterações nos registros em uma organização do Salesforce. O PushTopic define Dados PushTopic
um canal de API de streaming . Fonte em um FlexCard
Modelo Descrição Exemplo
Evento de plataforma Eventos de plataforma fazem parte da plataforma de mensagens corporativas da Configure uma fonte de
Salesforce. A plataforma fornece uma arquitetura de mensagens orientada a eventos dados de evento de
para permitir que os aplicativos se comuniquem dentro e fora do Salesforce. Um plataforma em um
evento de plataforma combina PushTopic e Streaming Channel. Em vez de trabalhar FlexCard .
com um sObject , o Platform Events trabalha com objetos personalizados.
Fonte de dados PushTopic

O tipo de API Streaming Channel usa a API Streaming para enviar notificações de eventos gerais que não estão
vinculados a alterações de dados do Salesforce. Use a API Streaming Channel quando quiser enviar e receber
notificações com base em eventos personalizados que você especificar. Você pode usar a API do Streaming
Channel para qualquer aplicativo que envie notificações personalizadas, como um aplicativo de bate-papo.
A API de streaming é conhecida como streaming genérico no Salesforce. Consulte Transmissão genérica
.
company
Um PushTopic é uma consulta SOQL que retorna um resultado que notifica os ouvintes sobre alterações nos
registros em uma organização do Salesforce. O PushTopic define um canal de API de streaming. Por exemplo,
se você quiser ser notificado quando um caso for criado para um determinado tipo ou status ou ambos, use
um PushTopic .
O código de exemplo a seguir cria um PushTopic que envia dados se um caso do tipo Problema for criado:
Selecione Id, CaseNumber, Subject, ContactEmail de Case onde Type = 'Problem'
Se você também precisar de Status , basta adicionar outra condição:
Selecione Id, CaseNumber, Subject, ContactEmail de Case onde Type = 'Problem' AND
Estado = 'Novo'
Você não pode usar cláusulas GROUP BY ou ORDER BY em um PushTopic . Consulte Criando um PushTopic .
Para outro exemplo, você pode criar um aplicativo que notifique um usuário sempre que uma nova tarefa for
criada para esse usuário.
Qual é o próximo
Configure uma fonte de dados PushTopic em seu FlexCard . Consulte Configurar uma fonte de dados
PushTopic em um FlexCard .
Veja Também
• Fontes de dados da API de streaming de Vlocity

Configurar uma fonte de dados PushTopic em um FlexCard

Configure uma fonte de dados PushTopic para executar uma consulta SOQL que retorne um resultado que
notifique os ouvintes sobre alterações nos registros em uma organização do Salesforce. O PushTopic define
um canal de API de streaming. Por exemplo, seja notificado quando um caso for criado para um dete rminado
tipo ou status ou ambos.
Ver Fonte de dados PushTopic .

company
Antes de começar
• Crie um PushTopic . Consulte Criando um PushTopic .
1. Para configurar uma fonte de dados a partir do assistente de configuração FlexCard , navegue até a etapa
Select Data Source Type , selecione Streaming API e clique em Next .
2. Para configurar uma fonte de dados a partir do painel SetUp no FlexCard Designer, clique em Setup e
selecione Streaming API na lista suspensa Data Source Type .
3. Selecione PushTopic na lista suspensa Tipo .
4. No campo Canal , insira a URL do PushTopic que você criou.
5. Na lista de opções Operação , selecione Substituir ou Anexar .
• Selecione Substituir para substituir o Cartão por novos dados.
• Selecione Anexar para adicionar novos dados ao Cartão.
6. Na lista de opções Obter todas as mensagens , selecione Verdadeiro ou Falso .
• Selecione True para obter todos os dados das últimas 24 horas.
• Selecione False para obter a atualização de dados mais recente.
Source Properties .
Qual é o próximo
Veja Também
Fonte de dados do evento da plataforma

Eventos de plataforma fazem parte da plataforma de mensagens corporativas da Salesforce. Um evento de
plataforma combina PushTopic e Streaming Channel para permitir que os aplicativos se comuniquem dentro e
fora do Salesforce. Em vez de trabalhar com um sObject , o Platform Events trabalha com objetos
personalizados.
• Sistemas em modelos de comunicação solicitação-resposta fazem uma solicitação a um serviço web ou

banco de dados para obter informações sobre um determinado estado.
• Um modelo baseado em eventos obtém informações e pode reagir a elas quase em tempo real quando o
evento ocorre.
• Os produtores de eventos não conhecem os consumidores que recebem os eventos. Qualquer número de
consumidores pode receber e reagir aos mesmos eventos.
• A única dependência entre produtores e consumidores é a semântica do conteúdo da mensagem.
• Ao contrário de um sObject , você não pode atualizar ou excluir registros de eventos. Você também não
pode exibir registros de eventos na interface do usuário do Salesforce , e os eventos de plataforma não têm
layouts de página.
A arquitetura é adequada para grandes sistemas distribuídos porque desacopla produtores de eventos de
consumidores de eventos, simplificando o modelo de comunicação em sistemas conectados.

company
Para obter detalhes, consulte Entrega de notificações personalizadas com eventos de plataforma na Ajuda do
Salesforce.
Por exemplo, você pode criar um cartão que usa um evento de plataforma como fonte de dados para exibir o
nível de tinta atual de uma impressora. Para ver uma demonstração detalhada, consulte Exemplo de ponta a
ponta: automação de suprimentos de impressora na Ajuda do Salesforce.
Qual é o próximo
Configure uma fonte de dados do Platform Event em seu FlexCard . Consulte Configurar uma fonte de dados
de evento de plataforma em um FlexCard .
Veja Também

Configurar uma fonte de dados de evento de plataforma em um FlexCard

Configure uma fonte de dados do Platform Event para permitir que os aplicativos se comuniquem dentro e
fora do Salesforce. Eventos de plataforma fazem parte da plataforma de mensagens corporativas da
Salesforce. Um evento de plataforma combina PushTopic e Streaming Channel. Em vez de trabalhar com um
sObject , o Platform Events trabalha com objetos personalizados.
Consulte Fonte de dados de eventos de plataforma .

Antes de começar

company
• Crie um evento de plataforma. Consulte Entrega de notificações personalizadas com eventos de plataforma .
3. Selecione Evento de plataforma na lista suspensa Tipo .
4. No campo Canal , insira a URL do Evento de plataforma que você criou.
Source Properties .
Qual é o próximo
Veja também
Fonte de dados do canal de streaming

O tipo de API Streaming Channel usa a API Streaming para enviar notificações de eventos gerais que não estão
vinculados a alterações de dados do Salesforce. Use a API Streaming Channel quando quiser enviar e receber
notificações com base em eventos personalizados que você especificar. Você pode usar a API do Streaming
Channel para qualquer aplicativo que envie notificações personalizadas, como um aplicativo de bate-papo.
A API de streaming é conhecida como streaming genérico no Salesforce. Consulte Transmissão genérica .
Por exemplo, use a fonte de dados Streaming Channel para um aplicativo de bate -papo para os usuários em
sua organização.
Qual é o próximo
Configure uma fonte de dados do Streaming Channel em seu FlexCard . Consulte Configurar uma fonte de
dados de canal de streaming em um FlexCard .

company
Veja Também

Configurar uma fonte de dados de canal de streaming em um FlexCard

Habilite a fonte de dados Streaming Channel para enviar e receber notificações com base em eventos
personalizados que você especificar. O tipo de API Streaming Channel permite que a API Streaming envie
notificações de eventos gerais que não estão vinculados a alterações de dados do Salesforce.
Consulte Fonte de dados do canal de streaming .

Antes de começar
• Crie o aplicativo que envia e recebe notificações. Ver Transmissão genérica .
3. Selecione Canal de streaming no menu suspenso Tipo .
4. No campo Canal , insira a URL do aplicativo que você criou.
Source Properties .
Qual é o próximo
Veja também
Fonte de dados do SDK FlexCard

Você pode usar um SDK, como o SDK do Salesforce Industries Digital Commerce, que contém toda a lógica de
negócios necessária para seu aplicativo e reutilizar essa lógica de negócios em outros aplicativos. Isso permite
que você se concentre na criação da interface do usuário para um aplicativo sem precisar chamar uma API e
processar a resposta da API. Você só precisa chamar o método do SDK e o SDK chama a API. O SDK obtém a
resposta da API, analisa essa resposta e a devolve ao cliente. O cliente então consome a resposta do SDK na
interface do usuário para que você possa projetar seu FlexCard com base na resposta recebida.
Consulte a documentação do SDK de comércio digital da Salesforce Industries.

1. Crie e carregue o recurso estático para que o SDK apareça no FlexCard como uma opção de
fonte de dados. Consulte Criar o recurso estático para uma fonte de dados SDK em um FlexCard .

company
2. Configure a fonte de dados SDK para seu FlexCard no FlexCard Designer. Ver Configurar uma fonte de
dados do SDK em um FlexCard .
Crie o recurso estático para uma fonte de dados SDK em um FlexCard

Antes de configurar um SDK como fonte de dados para seu FlexCard , você precisa adicionar ou criar um
recurso estático chamado OmniStudioActionRegistry que contém a configuração do SDK que você deseja usar
como fonte de dados no FlexCard . O FlexCard procura um arquivo com esse nome no recurso estático.
Consulte Fonte de dados FlexCard SDK .
1. Para carregar o arquivo SDK em sua organização, consulte Criar um novo recurso estático .
Se você for um usuário iniciante , crie um arquivo chamado OmniStudioActionRegistry com o esquema
JSON abaixo e carregue-o no recurso estático.
[{
"tipo": "SDK",
"nome": "SDK",
"description" : "Este JS SDK destina-se a ser usado no lado do cliente para
interagindo com a API",
"valor": {
" sdkObject ": " fonte de dados ",
" sdkPath ": "/latest/ datasource /datasource.sdk.js",
" staticResourceName ": " vlocitysdk ",
" inputMap ": {},
" resultadoVar ": ""
},
" pedidoPor ": {
"nome": "",
" isReverse ": falso
},
" contextVariables ": []
},{
"tipo": "SDK",
"name": "SDK UPC JS",
interagindo com a API V3",
"valor": {

company
" sdkObject ": " productconsole ",
" sdkPath ": "/latest/ productconsole /productconsole.sdk.js",
" staticResourceName ": " vlocityupcsdk ",
" inputMap ": {},
},
" pedidoPor ": {
"nome": "",
},
},
{
"tipo": "SDK",
"name": " Digitalcommerce JS SDK",
interagindo com a API V3",
"valor": {
" sdkObject ": " comércio digital ",
" sdkPath ": "/latest/ digitalcommerce /digitalcommerce.sdk.js",
" staticResourceName ": " vlocitydcsdk ",
" inputMap ": {},
},
" pedidoPor ": {
"nome": "",
},
},
{
"tipo": "SDK",
"name": "b2b JS SDK",
"valor": {
" sdkObject ": "b2bexpress",
" sdkPath ": "/latest/b2bexpress/b2bexpress.sdk.js",
" staticResourceName ": "vlocityb2bexpresssdk",
" inputMap ": {},
},
" pedidoPor ": {
"nome": "",
},
},{
"tipo": "SDK",
"name": " SDK da fonte de dados",
company
"valor": {
" sdkObject ": " fonte de dados ",
" sdkPath ": "/latest/ datasource /datasource.sdk.js",
" staticResourceName ": " vlocitysdk ",
" inputMap ": {},
},
" pedidoPor ": {
"nome": "",
},
}
]
Você pode adicionar novas seções a este arquivo com uma matriz de objetos. Cada seção no arquivo
Registry.json aparece como uma opção disponível para o SDK na interface do usuário. Você pode alterar
o valor de qualquer um dos parâmetros em cada seção, como type , name e description . O parâmetro
value tem propriedades adicionais como sdkPath , sdkObject e staticResourceName . Esses parâmetros e
valores contêm informações sobre o SDK que você deseja expor. Depois que o SDK é carregado, ele expõe
o sdkObject como o ponto de acesso primário ao SDK.
2. Certifique -se de que o Controle de Cache esteja definido como Público .
O que vem a seguir

Armazene as configurações do SDK em sua organização. Consulte Configurar uma fonte de dados SDK em um
FlexCard .
Configurar uma fonte de dados SDK em um FlexCard

Configure uma fonte de dados para usar métodos de um SDK para fornecer os dados para um FlexCard . Um
SDK permite que você chame várias fontes de dados, reutilize a lógica de negócios e controle quais campos
aparecem em seu FlexCard .
Consulte Fonte de dados FlexCard SDK .

Requeridos Versões
Antes de começar
Crie o recurso estático para o SDK. Consulte Criar o recurso estático para uma fonte de dados SDK em um FlexCard .
dados , selecione SDK e clique em Avançar .
2. Para configurar a fonte de dados no painel SetUp no FlexCard Designer, clique em Setup e selecione SDK
na lista suspensa Data Source Type .
3. Na lista suspensa SDK , selecione o SDK na lista suspensa.
Este deve ser o nome do SDK fornecido no arquivo de recurso estático, como Digitalcommerce JS SDK .
Depois de selecionar esse nome, o campo Descrição é preenchido. O FlexCard encontra o nome do
recurso estático e carrega o arquivo especificado em sdkPath .
company
4. Na lista suspensa Método do SDK , selecione em uma lista de funções disponíveis no SDK escolhido, como
o método getOffers . Para obter uma lista de métodos do SDK do Digital Commerce, consulte a
documentação da estrutura e métodos de classe principal do SDK.
5. (Opcional) Para passar dados do FlexCard para o método SDK, na seção Parâmetros de entrada ,
selecione uma destas opções:
• Clique em + Adicionar novo :
a. No campo Chave insira o nome de uma variável para passar para o método. Ou, se uma lista de
parâmetros disponíveis aparecer quando você clicar no campo Chave, selecione um, como
catalogCode .
b. No campo Valor , insira o valor da variável como um campo de mesclagem, como Telefones .
• Clique em Editar como JSON para adicionar variáveis como JSON, como {" catalogCode ":"Phones"} .

company
6. (Opcional) Para configurar outras opções comuns entre todas as fontes de dados, consulte
FlexCards Data Source Properties .
company
7. (Opcional) Se um parâmetro de entrada tiver campos de mesclagem, como { recordId }, adicione variáveis
de teste na seção Parâmetros de teste para que a consulta retorne dados ativos. Ver Teste as
configurações da fonte de dados em um FlexCard .
8. Clique em Salvar + Buscar . O FlexCard Designer faz a chamada da API e retorna uma resposta. Você pode
testar a resposta no campo Test Response . Ver Teste as configurações da fonte de dados em um
FlexCard .
O que vem a seguir

Veja também
• Referência de fonte de dados FlexCards
Testar configurações de fonte de dados em um FlexCard

Visualize um FlexCard com dados reais adicionando variáveis de teste que a consulta pode usar para retornar
dados ao vivo. As variáveis preenchem os campos dinâmicos em uma fonte de dados, como um terminal REST
com parâmetros ou de um DataRaptor que obtém dados de um sObject .
1. Clique na guia inicial do FlexCards , clique em uma versão de um FlexCard para abrir o FlexCard Designer.
2. No painel Configuração, para configurar os parâmetros de teste, clique em + Adicionar novo na seção
Parâmetros de teste .
3. No campo Chave , insira um nome de variável de teste. Por exemplo, insira a variável do Mapa de Entrada
que representa um contextId como recordId . Ver FlexCards Contexto Variáveis .
4. No campo Valor , insira um valor de variável de teste. Por exemplo, insira um ID de registro, como o
encontrado na URL de uma página de conta.
5. (Opcional) Se os dados retornados tiverem várias matrizes, para retornar um conjunto de dados
específico, insira seu caminho JSON no JSON de resultados. Por exemplo, para retornar apenas o conjunto
de dados Cases, insira [0]['Cases'] se seu JSON for assim:
{
[
"Casos": [
{
"Prioridade": "Alta",
" IsEscalated ": false,
" CaseId ": "5006g00000FpEz5AAF",
"Criado": "2020-07-22T00:22:42.000Z",
"Type": "Mecânico", "Assunto": "O gerador não
inicia",
"Estado": "Novo",
"Origem": "Web",
"Descrição": "Apesar de ligar e desligar várias vezes, o
gerador não iniciaria",
" CaseNumber ": "00001028"
},
{
"Prioridade": "Médio",
" IsEscalated ": false,
" CaseId ": "5006g00000BsfKkAAJ",
company
"Criado": "2020-02-27T22:28:20.000Z",
"Tipo": "Mecânico",
"Assunto": "Desligando o gerador",
"Estado": "Fechado",
"Origem": "Web",
" CaseNumber ": "00001017"
}
],
"Conta": {
"Tipo": "Cliente - Direto",
"Nome": "Comunicação de Borda",
"Street": "312 Constitution Place\ nAustin , TX 78767\ nUSA ",
"Estado/Província": "TX",
"Cidade": "Austin",
" Receita ": 139000000
}
]
}
6. Clique em Salvar e buscar para ver os resultados do teste .
7. (Opcional) Clique em JSON para visualizar os resultados do teste como JSON.

8. (Opcional) Clique em Atualizar para ver os dados mais recentes.
Veja também
Configurar um FlexCard no FlexCard Designer

Defina as configurações opcionais para o seu FlexCard no painel Setup do FlexCard Designer. P or exemplo,
atualize uma fonte de dados, crie um ouvinte de eventos, adicione variáveis de sessão e assim por diante.
Antes de começar
• Crie um FlexCard . Consulte Criar um novo FlexCard .
1. No FlexCard Designer, clique em Configuração para abrir o painel Configuração.

2. Para configurar opções específicas, consulte a Referência de configuração do FlexCard .

company
Qual é o próximo
Construa seu FlexCard . Consulte Adicionar elementos a um FlexCard .
Veja Também
• Estilo FlexCard Elementos
Referência de configuração do FlexCard

O painel Setup no FlexCard Designer oferece várias opções de configuração que permitem ao usuário definir
melhor o comportamento do FlexCard . Por exemplo, atualize a fonte de dados e adicione variáveis de sessão.
Ver Configure um FlexCard no _ _ Desenhista FlexCard .
Autor (Desativado por padrão) O Autor do FlexCard . Para atualizar o Autor, clone o FlexCard Nomeação Convenções
FlexCard .
Fonte de dados Define uma fonte de dados para o FlexCard . Configurar uma fonte de dados em
um
FlexCard
Evento Ouvinte Adicione um listener para um evento PubSub ou personalizado que é acionado Adicionar um ouvinte de eventos a
quando um usuário executa uma ação. um
FlexCard
Multi Idiomas Ative para atualizar os rótulos personalizados e não os armazenar em cache. Habilite o suporte a vários idiomas
Apoiar em um FlexCard , adicione
personalizado
Rótulos para Campos Suportados em
um
FlexCard
Nome (Desativado por padrão) O nome da API do FlexCard . Para atualizar o Nome, clone o FlexCard Nomeação Convenções
FlexCard .
OmniScript Ative quando seu FlexCard interage com um LWC OmniScript , como ao Ative o suporte OmniScript em um
Apoiar incorporar um LWC personalizado no OmniScript Designer ou atualizando um FlexCard
OmniScript de um elemento FlexCard Action.
Chave de renderização Para renderizar novamente apenas o registro do cartão afetado quando o Melhorar o desempenho em
FlexCard for atualizado, insira uma chave exclusiva que identifique o registro. Repetindo registros em um
Selecione um campo de dados com um valor exclusivo, como Id . FlexCard
Repetir registros Desative para exibir conteúdo que não precisa ser repetido. Por exemplo, um Opções de repetição no FlexCard
elemento Chart ou Datatable que exibe dados para várias contas ou um LWC Projetista
personalizado usado como cabeçalho em uma página.
Requeridos Limita o acesso do usuário a um FlexCard inserindo uma lista separada por vírgulas Limitar o acesso do usuário a um
Permissão de permissões personalizadas. Se este campo for deixado em branco, qualquer FlexCard com permissões
usuário poderá ver o FlexCard . personalizadas
Sessão Defina atributos disponíveis de um componente ou armazene valores de fontes de Adicionar variáveis de sessão a um
Variáveis dados, sistemas externos ou codificados para acessar globalmente em um FlexCard FlexCard
.
Título O título exibido no Experience Builder (para comunidades) e no Lightning App Builder. n/D
Opções de repetição no FlexCard Designer

Por padrão, um FlexCard percorre os registros retornados de sua fonte de dados. O FlexCard exibe a lista de
registros em containers chamados cartões. Por exemplo, se uma fonte de dados retornar uma lista de Casos
ativos para uma Conta, cada cartão exibirá Status, Prioridade, Assunto e qualquer outro campo de
dados ou elemento adicionado a um estado.
company
Um FlexCard com vários elementos Field e um elemento Action. Repetir registros habilitados.
Melhore o desempenho em elementos renderizados quando um FlexCard com registros repetidos for
atualizado. Apenas renderize novamente o registro do cartão afetado no componente FlexCard inserindo uma
chave de renderização exclusiva que o identifica. O FlexCard LWC usa a chave para localizar qual elemento no
Document Object Model (DOM), o HTML renderizado, deve ser atualizado.
Para exibir dados que não precisam ser repetidos, desative o recurso Repetir Registros . Por exemplo, desative
o recurso para exibir um registro de conta, um elemento de gráfico que exibe dados de várias contas, um
elemento de tabela de dados que lista casos de conta, um elemento de LWC personalizado que serve como
cabeçalho para um aplicativo de console ou um FlexCard filho que tenha é sua própria fonte de dados em
loop.
Um FlexCard com um elemento Datatable. Repetir Registros desativado.
Modos repetíveis
Esta tabela exibe como o recurso Repetir Registros funciona para um Estado Ativo e um Estado de Cartão em
Branco quando os registros estão disponíveis e não estão disponíveis:
Habilitado? Registros Estado ativo Estado do cartão em branco
disponíveis?
Sim (padrão) Sim Mostre um cartão para cada registro disponível. Escondido
Sim (padrão) Sim Quando uma condição resulta em nenhum registro a Mostre um cartão, como para mostrar um
ser exibido, esse estado fica oculto. link de ação para criar um registro.
Sim (padrão) Não (ou nenhum dado Escondido Mostre um cartão, como para mostrar um
Fonte) link de ação para criar um registro.

company
Não Sim Mostre um cartão com todos os registros disponíveis Escondido
dentro dele. Por exemplo, para exibir uma tabela de
dados, uma lista, um gráfico ou um contêiner, como
um LWC personalizado ou um cartão flexível filho
que usa a fonte de dados fornecida por seu
contêiner.
Não Sim Quando uma condição resulta em nenhum registro a Mostre um cartão, como para mostrar um
ser exibido, esse estado fica oculto. link de ação para criar um registro.
Não Não (ou nenhum dado Escondido Mostre um cartão, como para mostrar um
Fonte) link de ação para criar um registro.
Desativar loop de registro em um FlexCard

Para exibir dados que não precisam ser repetidos, desative o recurso Repetir Registros . Por exemplo, desative
o recurso para exibir um registro de conta, um elemento de gráfico que exibe dados de várias contas, um
elemento de tabela de dados que lista casos de conta, um elemento de LWC personalizado que serve como
cabeçalho para um aplicativo de console ou um FlexCard filho que tenha é sua própria fonte de dados em
loop.
Um elemento Datatable listando casos de conta. Repetir Registros desativado.

2. Para desabilitar o loop sobre registros, desmarque Repetir Registros .
Veja também
• Opções de repetição no FlexCard Designer
Melhore o desempenho na repetição de registros em um FlexCard

Melhore o desempenho em elementos renderizados quando um FlexCard com registros repetidos for
atualizado. Apenas renderize novamente o registro do cartão afetado no componente FlexCard inserindo uma
chave de renderização exclusiva que o identifica. O FlexCard LWC usa a chave para localizar qual
elemento no Document Object Model (DOM), o HTML renderizado, deve ser atualizado.

company
Versões obrigatórias
Disponível a partir do verão de 21.
1. No painel Configuração, clique em Opções de repetição e confirme se Repetir registros está ativado.
2. No campo Render Key , insira um campo de dados com um valor exclusivo, como Id .
Veja também
• Opções de repetição no FlexCard Designer
Adicionar variáveis de sessão a um FlexCard

Defina atributos disponíveis de um componente ou armazene valores de fontes de dados ou sistemas externos
para acessar globalmente em um FlexCard. Por exemplo, defina uma chave de API ou rastreie a paginação. Use
o campo de mesclagem {Session.var} para analisar o valor.
Esta tabela lista os elementos que suportam variáveis de sessão:

Elemento Campos de entrada suportados
Ação (qualquer) Etiqueta
Ação de evento personalizada Começando o verão '21: Parâmetro de entrada > Valor
Campo Rótulo, espaço reservado e saída
Texto Dentro do editor de rich text

2. Clique em + Adicionar novo ao lado de Variáveis de sessão .
3. Insira uma chave , como APIkey .
4. Insira um Valor , como 123456dk489384A1sdjsk .
IMPORTANTE
Você não pode usar valores de fonte de dados como variáveis de sessão.
5. Aplique a variável de sessão como um campo de mesclagem a um campo de elemento. Por exemplo,
insira {Session.APIkey} para uma URL de endpoint de fonte de dados REST .
Veja também
Adicionar um ouvinte de eventos a um FlexCard

Adicione um ouvinte de eventos que escute um evento disparado de um componente e execute uma ação em
resposta. Com um evento Pubsub, ouça um evento de outro componente. Com um evento Custom, ouça um
evento disparado de um FlexCard filho ou de um elemento no cartão.
Exemplo 9. Exemplo: Atualizar Lista de Produtos

Digamos que você queira criar uma página do Lightning que exiba uma lista filtrável de produtos. Você
precisará de dois FlexCards: um para exibir os produtos e ter um ouvinte de eventos, e outro para exibir os
filtros que podem atualizar as informações do produto e ter ações que enviam eventos. Seu FlexCard de Lista
de Produtos exibe informações sobre o produto e possui um ouvinte de eventos que escuta as ações
executadas no Cartão de Filtro. O Filtro FlexCard exibe os filtros, e possui um botão Aplicar que ao ser
clicado envia um evento.

company
Quando um usuário seleciona um filtro, como <$2000 e clica no botão Aplicar no Filtro FlexCard, apenas os
produtos que custam menos de $2000 ficam visíveis na Lista de produtos FlexCard.
Crie o evento Custom ou Pubsub. Para criar o evento personalizado, consulte Acionar um evento personalizado de uma ação em um FlexCard . Para
criar o evento Pubsub, consulte Acionar um evento Pubsub de uma ação em um FlexCard .
Adicionar o ouvinte de eventos

2. Na seção Event Listener , clique em + Add New .
3. Selecione um personalizado ou Pubsub Tipo de evento .
4. Para configurar um evento personalizado, no campo Nome do evento , insira o nome do evento, como
reload .
5. Para configurar um evento PubSub:
a. No campo Nome do Evento , insira o nome do evento, como reload .
b. No campo Nome do Canal , insira o canal no qual o evento é postado.
c. Se o tipo de ação for Card e o tipo for remove , no campo Índice de registro , atualize o índice para
indicar qual registro remover. Por exemplo, digite 0 , para remover o primeiro registro ou 3 para
remover o quarto registro.
6. Para criar uma ação, consulte Criar a ação .
Crie a ação
1. Na seção Propriedades da ação , selecione um Tipo de ação na lista suspensa. Consulte Referência de
Ações FlexCards .
2. Para configurar o Tipo de Ação selecionado, consulte Propriedades de Ação FlexCards .
Baixe um DataPack de Ouvinte de Evento de Amostra

Faça download de um FlexCard DataPack de amostra com Event Listeners configurados. Consulte Baixar um
DataPack de Ouvinte de Evento de Amostra .
Veja também
• Propriedades do Ouvinte de Eventos FlexCards
Baixe um DataPack de Ouvinte de Evento de Amostra

Baixe um DataPack do Event Listener de amostra para importar para sua organização. Crie um ouvinte de
eventos que escute um evento acontecendo e execute uma ação em resposta. Consulte Adicionar um ouvinte
de eventos a um FlexCard .
O DataPack de exemplo demonstra como habilitar um FlexCard para escutar um evento de outro FlexCard e
escutar um evento de uma ação no mesmo FlexCard. Quando você clica em um elemento de ação, um evento
é acionado e os ouvintes de eventos executam outras ações com base no evento acionado, como recarregar o
FlexCard, atualizar a fonte de dados e atualizar os valores do campo de dados.
• Um FlexCard demoUpdateDataSourceEvent com duas ações que, quando clicadas, atualizam a fonte
de dados em outro FlexCard.
company
• Um FlexCard demoEventListener que escuta eventos e executa ações com base no evento. Este FlexCard
possui os seguintes elementos e propriedades:
• Mescle campos para exibir dados de uma fonte de dados de consulta SOQL.
• Mescle campos para exibir dados de uma fonte de dados DataRaptor Extract.
• Ouvintes de eventos que definem valores, atualizam a fonte de dados para uma fonte de dados SOQL
Query, atualizam a fonte de dados para um DataRaptor e recarregam o FlexCard.
NOTE
To save and f etch test data from the getAccountCases DataRaptor Extract, update the
value of the action.setId in the Test Parameters of thePubsubUpdateDS:dataraptor
event listener.
• Dois elementos de ação que, quando clicados, disparam um evento para atualizar valores com novos
dados.
• Um elemento de ação que, quando clicado, recarrega o FlexCard.
• Uma extração do DataRaptor getAccountCases para preencher campos de mesclagem quando o evento
relacionado for acionado.
NOTA
Para retornar dados, verifique se você tem registros de casos de conta em sua organização.
Baixe e importe o DataPack
1. Baixe o OmniStudio DataPack aqui: demoEventListener-OmniStudio.zip .

2. Importe o pacote de dados. Consulte Importar um FlexCard .
3. Se você não ativou os FlexCards durante o processo de importação, na guia inicial dos FlexCards, para
cada FlexCard, clique no nome do FlexCard, marque a caixa de seleção e clique em Ativar .
4. Adicione os dois FlexCards a uma página do Lightning para visualizar e testar o recurso de escuta de
eventos. Adicione o demoEventListener abaixo do demoUpdateDataSourceEvent . Consulte Adicionar
um FlexCard a uma página do Lightning .

company
Veja também
• Propriedades do ouvinte de eventos FlexCards

Propriedades do ouvinte de eventos FlexCards

As propriedades do Event Listener são configuráveis no painel Setup no FlexCard Designer. Adicione um
listener para um evento PubSub ou Custom que é acionado quando um usuário executa uma ação. Consulte
Adicionar um ouvinte de eventos a um FlexCard .
Tipo de evento Selecione um tipo de evento. n/D
Nome do evento Digite o nome do evento. n/D
nome do canal Digite o canal no qual o evento é postado. n/D
Índice de registro Se o tipo de ação for Card e o tipo for remove , insira o número do índice que indica n/D
qual registro remover. Por exemplo, digite 0 , para remover o primeiro registro ou 3
para remover o quarto registro.
Tipo de acão Selecione a ação que aciona o evento. Ação FlexCards

Propriedades
Habilitar suporte multilíngue em um FlexCard

Habilite o suporte multilíngue em um FlexCard do FlexCard Designer. Quando o recurso Suporte a vários
idiomas está ativado, todos os rótulos personalizados são atualizados e não armazenados em cache. Consulte
Etiquetas personalizadas .

2. Selecione Suporte multilíngue .

company
Qual é o próximo
Adicione rótulos personalizados aos campos compatíveis. Consulte Adicionar etiquetas personalizadas aos
campos suportados em um FlexCard .
Ativar suporte OmniScript em um FlexCard

Habilite o recurso Suporte OmniScript quando seu FlexCard interagir com um LWC OmniScript. Por exemplo,
renderize um FlexCard dentro de um OmniScript com o elemento Custom LWC do OmniScript Designer.
Consulte Incorporar FlexCards em um OmniScript . Ou atualize um OmniScript com o elemento de ação
Atualizar OmniScript. Consulte Atualizar um OmniScript de um FlexCard .

2. Selecione Suporte OmniScript .
Veja também
• Atualizar um OmniScript de um FlexCard
• Iniciar um OmniScript a partir de um FlexCard
Limitar o acesso do usuário a um FlexCard com permissões personalizadas

Limite o acesso do usuário a um FlexCard atribuindo permissões personalizadas . Insira uma lista de
permissões personalizadas no painel de configuração do seu FlexCard para especificar quais usuários podem
visualizar seu FlexCard.
Crie permissões personalizadas em Configuração > Permissões personalizadas. Consulte Criar permissões personalizadas .

2. Insira uma lista separada por vírgulas de permissões personalizadas no campo Permissões necessárias .
Por exemplo, se você criou permissões personalizadas chamadas Can_Edit_Policy e Can_View_Policy ,
insira-as como Can_Edit_Policy,Can_View_Policy .
NOTA
Se este campo for deixado em branco, qualquer usuário poderá ver o FlexCard.
3. Para o pacote gerenciado em sua organização, confirme se a Classe do Apex

VlocityRequiredPermissionCheck existe em Configuração > Classes do Apex. Se não existir, adicione-o da
seguinte forma: a. Em Configuração, no menu Busca rápida, insira apex .
b. Clique em Classes do Apex .
c. Clique em Novo
d. Insira o seguinte código do Apex na guia Classe do Apex:
classe global VlocityRequiredPermissionCheck implementa Callable

{
global Boolean call(String action, Map<String, Object> args)
{
if (ação == 'checkPermission')
{ Retorna

company
checkPermission((String)args.get('requiredPermission') );
}
retorna falso; }
private Boolean checkPermission(String requiredPermission)

{
Boolean hasCustomPermission = false;
List<> customPermissionsName =
requiredPermission.split(',' );
for (String permissionName : customPermissionsName)
{
Boolean hasPermission =
FeatureManagement.checkPermission(permissionName.normalizeSpace() );
if (temPermissão == true)
{
hasCustomPermission = true;
parar;
}
}
return hasCustomPermission;
}
}
e. Clique em Salvar .
Veja também
Elementos de estilo FlexCard

Configure a aparência de um FlexCard estilizando elementos individuais, campos dentro de elementos e
estados inteiros. No painel Estilo no FlexCard Designer, crie planos de fundo, texto e bordas; ajustar alturas,
larguras e espaçamento dentro e entre elementos; aplicar classes e estilos embutidos; tornar seu elemento
responsivo; e mais.
Salve as configurações de estilo em um elemento para usar em vários elementos no FlexCard. Crie classes
personalizadas a partir de um editor de código no FlexCard Designer e aplique-as a elementos individuais. Em
elementos suportados, adicione classes a campos específicos dentro do elemento, como o rótulo e o valor de
um elemento Text. Aplique estilos condicionalmente com base no valor de um campo de dados.
Opções de estilo disponíveis para todos os elementos

Painel de estilo Descrição Referência
Seção
Adicionar condicional Aplique estilos condicionalmente a um elemento. Altere os recursos de estilo, Adicionar estilos condicionais a um
Estilo como cor do texto e capacidade de resposta, quando uma condição baseada no Elemento FlexCard
valor de um campo de dados for atendida.
Alinhamento Atualize o preenchimento, a margem e o alinhamento do texto de um elemento. Alinhamento do Elemento FlexCards
Propriedades

company
Aparência Configure a cor, o plano de fundo e a borda de um elemento. Aparência do elemento FlexCards
Propriedades
Personalizado Crie e aplique classes personalizadas e adicione estilos embutidos a um elemento. Elementos FlexCard Personalizados
CSS
Estilos personalizados Salve as configurações de estilo em um elemento FlexCard como um estilo Crie um estilo personalizado para
personalizado para usar em vários elementos em um FlexCard. um
Elemento FlexCard
Dimensões Defina a altura e configure a capacidade de resposta de um elemento. Dimensões do elemento FlexCards
Opções de estilo disponíveis para elementos específicos

Seção do painel de estilo Referência
Ação Propriedades do estilo de ação dos FlexCards
Tabela de dados Propriedades do estilo da tabela de dados

FlexCards
Campo Propriedades de estilo de campo de FlexCards
Ícone Propriedades do estilo do ícone FlexCards
Cardápio Propriedades do estilo do menu FlexCards
Alternar Propriedades de estilo de alternância de FlexCards
Adicionar estilos condicionais a um elemento FlexCard

Aplique estilos condicionalmente a um elemento FlexCard. Altere os recursos de estilo, como cor do texto,
imagem de fundo e capacidade de resposta quando uma condição baseada no valor de um campo de dados
for atendida. Por exemplo, adicione uma borda vermelha ao redor de um FlexCard de cobrança quando o
status da fatura estiver vencido.
1. Selecione o elemento em um estado em seu FlexCard e clique em + Adicionar estilo condicional no painel
Estilo.
2. Em Nome do estilo condicional , insira um nome exclusivo para o rótulo visível do seu estilo condicional.
O nome deve ser diferente de qualquer outro nome de estilo condicional no mesmo elemento.
3. Para adicionar uma condição com base no valor de um campo de dados, clique em + Adicionar condição .
Consulte Adicionar condições a um elemento FlexCard para saber como configurar as condições.
5. Sua nova condição aparece abaixo do Padrão .
Quando você adiciona um estilo condicional, uma seção Padrão é adicionada à parte superior do painel
Estilo. Quando suas condições não são atendidas, os estilos padrão se aplicam.

company
6. (Opcional) Para determinar quais condições são aplicadas, passe o mouse sobre o ícone de dica de
ferramenta "i" ao lado do nome do estilo condicional.
7. (
) icon.
Opcional) Para editar um estilo condicional, clique em seu lápis (
8. (Opcional) Para alternar entre a aparência do seu elemento quando as condições são aplicadas e não
aplicadas, selecione o botão de alternância do estilo condicional ( ).
9. (Opcional) Para excluir um estilo condicional, clique no ícone da lixeira ( ).
Qual é o próximo
Visualize seu FlexCard. Consulte Visualizar um FlexCard .
Veja também
• Elementos de estilo FlexCard
Propriedades de estilo condicional de FlexCards

As propriedades de Adicionar Estilo Condicional são configuráveis no painel Estilo no FlexCard Designer
quando você seleciona um elemento. Aplique estilos condicionalmente a um elemento dependendo do valor
de um campo de dados.
Estilo condicional O nome do seu estilo condicional. N/D

Nome
Adicionar Adicione condições que estilizem elementos com base em valores de campo de dados. Adicionar condições
condições a um
Elemento FlexCard

company
Adicionar grupos Crie expressões complexas agrupando condições. Um grupo é semelhante a incluir uma série Adicionar condições
de testes entre parênteses em uma linguagem de programação. Por exemplo, para adicionar a um
uma condição para casos de alta prioridade que são escalados ou têm uma conta cujo Elemento FlexCard
a receita estiver acima de um determinado número, crie dois grupos de condições
conectados por um operador OR , como [Priority = High AND IsEscalated = true] OR [Priority
= High AND AnnualRevenue > 500000] .
Predefinição Os estilos padrão se aplicam quando nenhuma condição é atendida. N/D
Veja também
Dimensões do elemento FlexCards

Defina a altura e a largura e configure a capacidade de resposta de um elemento FlexCard no FlexCard
Designer. Além de ajustar a largura de um elemento clicando e movendo seus marcadores de arrastar para a
esquerda e para a direita na tela, use um controle deslizante no painel Estilo para ajustar a largura. Consulte
Ajustar a largura de um elemento em um FlexCard .
Configure a altura, altura mínima e altura máxima do elemento usando valores compatíveis com CSS. Consulte
Ajustar a altura de um elemento em um FlexCard .
Ative a capacidade de resposta em um ou mais elementos para definir a largura a ser alterada à medida que a
largura da área visível de uma página, chamada de janela de visualização, for alterada. Consulte Criar
O dimensionamento responsivo de elementos é mobile-first. O dimensionamento começa no menor ponto de

interrupção visível da viewport e é aplicado continuamente para cima até que o próximo ponto de interrupção
mais amplo o substitua. Quando a capacidade de resposta está habilitada, a largura padrão se torna a largura
do menor ponto de interrupção da janela de visualização. Consulte Capacidade de resposta do elemento
FlexCards .
Veja também
• Propriedades das dimensões do elemento FlexCards
• Criar elementos responsivos em um FlexCard
Propriedades das dimensões do elemento FlexCards

As propriedades de Dimensões de um elemento são configuráveis no painel Estilo no FlexCard Designer
quando um elemento é selecionado. Atualize a altura e a largura e configure a capacidade de resposta para
seu elemento.
Predefinição Defina a largura padrão do elemento quando o responsivo estiver desabilitado. Ajuste a largura de um
Elemento em um FlexCard
Altura Defina a altura do elemento. Insira qualquer valor permitido pela propriedade CSS height , n/D
como 10em , auto ou calc() . Se você inserir apenas um número, a unidade padrão usada
será px . A unidade de porcentagem ( % ) não é suportada.
Máximo Defina a altura máxima do elemento. Insira qualquer valor permitido pela propriedade n/D
Altura CSS maximum-height , como 10em , auto ou calc() . Se você inserir apenas um número, a
unidade padrão usada será px . A unidade de porcentagem ( % ) não é suportada.

company
Altura Mínima Defina a altura mínima do elemento. Insira qualquer valor permitido pela propriedade n/D
CSS de altura mínima , como 10em , auto ou calc() . Se você inserir apenas um número, a
unidade padrão usada será px . A unidade de porcentagem ( % ) não é suportada.
Responsivo Faça seu elemento se ajustar à largura da janela de visualização. Após habilitar, defina a Elemento FlexCards
largura de cada ponto de interrupção da viewport. Capacidade de resposta
Veja também
Ajustar a altura de um elemento em um FlexCard

Atualize a altura de um elemento em um FlexCard no painel Style no FlexCard Designer. Insira quaisquer
valores compatíveis com CSS, como unidades de comprimento ( px , cm e assim por diante), herdar , auto e
assim por diante. Ou insira uma função CSS, como calc(2em * 5) .
IMPORTANTE
A porcentagem (%) não é compatível com a altura.
1. No FlexCard Designer, clique em um elemento na tela e clique em Estilo para abrir o painel Estilo.
2. Para atualizar a altura do seu elemento, abra a seção Dimensões e insira um valor compatível com CSS
para uma ou mais das seguintes propriedades:
NOTA
Por exemplo, insira 20 , 150px ou calc(2em * 5) , auto e assim por diante. Se você inserir
apenas um número, a unidade de comprimento padrão será px .
• Para definir uma altura fixa, insira um valor compatível com CSS no campo Altura .
• Para definir uma altura mínima, insira um valor compatível com CSS no campo Altura mínima .
• Para definir uma altura máxima, insira um valor compatível com CSS no campo Altura máxima .
Qual é o próximo
Veja também
• Dimensões do elemento FlexCards
Ajustar a largura de um elemento em um FlexCard

Depois de arrastar um elemento do painel Build para um estado, ajuste sua largura ao longo de uma grade
horizontal de 12 colunas. A largura de um elemento é de 1 a 12 partes de uma grade de 12 colunas . Por
exemplo, um elemento de campo com 6 colunas de largura ocupa 50% do espaço horizontal disponível.
Quando um elemento é arrastado ao lado de outro elemento com menos de 12 colunas de largura, o novo
elemento ocupa a largura restante do espaço horizontal disponível. E quando a largura de um elemento é
ajustada de menos de 12 para 12 colunas, quaisquer elementos próximos a ele se moverão abaixo dele.
1. No FlexCard Designer, clique em um elemento em um estado.

company
2. Para ajustar a largura de um elemento dentro de um estado, execute estas tarefas:
a. Passe o mouse sobre a caixa quadrada na borda direita até que o ícone do ponteiro do mouse se
torne um ícone de arrastar.
b. Clique e deslize a caixa quadrada para a direita ou para a esquerda para tornar o elemento mais
estreito ou mais largo.
3. Para ajustar a largura do painel Estilo para qualquer elemento, incluindo um estado, execute estas
tarefas:
a. Clique em Estilo para abrir o painel Estilo
b. Na seção Dimensões , em Padrão , mova o controle deslizante para a esquerda ou direita para
ajustar a largura do elemento.
NOTA
Somente os FlexCards filhos permitem que você ajuste a largura de um elemento de
estado e somente a partir do painel Estilo. Quando você ajusta a largura do estado, se a
largura for menor que 6 colunas, os registros são exibidos lado a lado, imitando o
comportamento dos elementos dentro dos estados. Consulte Exibir registros lado a lado
em um FlexCard .
Veja também
• Ajustar a altura de um elemento em um FlexCard
Capacidade de resposta do elemento FlexCards

No FlexCard Designer, habilite a capacidade de resposta em um ou mais elementos para definir a largura a ser
alterada conforme a área visível de uma página, chamada viewport, muda. Por padrão, a largura de um
elemento é a mesma, independentemente da largura do dispositivo de viewport no qual o usuário visualiza o
FlexCard. A largura de um elemento é de 1 a 12 partes de uma grade de 12 colunas . Por exemplo, um
elemento de campo com 6 colunas de largura ocupa 50% do espaço horizontal disponível. Consulte Ajustar a
largura de um elemento em um FlexCard .
Quando o recurso Responsivo está habilitado no painel Estilo de um FlexCard, o dimensionamento

responsivo dos elementos é móvel primeiro. O dimensionamento começa no menor ponto de
company
interrupção da janela de visualização e é aplicado continuamente para cima até que o próximo ponto de
interrupção mais amplo o substitua. Quando a capacidade de resposta está habilitada, a largura padrão se
torna a largura do menor ponto de interrupção da janela de visualização.
TIP
Build with a mobile-first approach if most or all of your elements are responsive. Build your
FlexCard at the smallest canvas size by selecting Mobile L/Sf rom the Viewport
Dropdown. After setting widths for all breakpoints for each element from the Style panel,
view your layout at different viewports by toggling through the Viewport Dropdown. See
View a FlexCard at Different Viewport Breakpoints
Exemplo 10. Assunto responsivo de exemplo e elementos de campo CaseId

Um usuário deseja que o campo Subject e um elemento CaseId Field próximos um do outro nas viewports
Medium e Large , mas empilhados nas viewports Small e Small:
• Defina o campo Assunto como 12 para Menor e Pequeno e 10 para Médio e Grande.
• Defina o campo CaseId como 12 para Smaller e Small e 2 para Medium e Large.
Configurações de resposta de assunto e CaseId.

company
Campos Assunto e Caseid em viewports maiores e menores.
Pontos de interrupção disponíveis

Ponto de interrupção da janela de visualização Dispositivo
Grande (>=1024px) Notebook e desktop
Médio (>=768px) Tablet grande
Pequeno (>= 480px) Tablet pequeno ou médio e dispositivo móvel grande
Menor (< 480px) Dispositivo móvel pequeno ou médio
Veja também
Criar elementos responsivos em um FlexCard

Ative a largura de um elemento para alterar quando a janela de visualização for atualizada. Por exemplo, faça
com que as larguras dos campos de Nome e Sobrenome de um contato ocupem a largura total da página em
dispositivos menores, mas diminuam para 50% em dispositivos maiores, como laptops e desktops.
Por padrão, a largura de um elemento é a mesma, independentemente da largura da janela de visualização do

dispositivo que o usuário visualiza no FlexCard. Quando a capacidade de resposta está habilitada, a largura de
um elemento muda para a largura definida em cada ponto de interrupção da janela de visualização. A largura
padrão se torna a largura no menor ponto de interrupção da janela de visualização para uma abordagem mobile-
first. Consulte Capacidade de resposta do elemento FlexCards .

company
TIP
Build with a mobile-first approach if most or all of your elements are responsive. Build your
FlexCard at the smallest canvas size by selecting Mobile L/Sf rom the Viewport
Dropdown. After setting widths for all breakpoints for each element from the Style panel,
view your layout at different viewports by toggling through the Viewport Dropdown. See
View a FlexCard at Different Viewport Breakpoints
2. Na seção Dimensões , habilite Responsive .
NOTE
Easily identify responsive elements by selecting or hovering over the element. A
device icon displays next to the Component Name.
3. Para cada ponto de interrupção da janela de visualização, ajuste o controle deslizante para definir uma
largura.
Exemplo 11. Assunto responsivo de exemplo e elementos de campo CaseId
Um usuário deseja que o campo Subject e um elemento CaseId Field próximos um do outro nas
viewports Medium e Large , mas empilhados nas viewports Small e Small:
• Defina o campo Assunto como 12 para Menor e Pequeno e 10 para Médio e Grande.
• Defina o campo CaseId como 12 para Smaller e Small e 2 para Medium e Large.

company
Configurações de resposta de assunto e CaseId.
Campos Assunto e Caseid em viewports maiores e menores.

4. Para testar a capacidade de resposta de seus elementos, alterne entre as larguras da janela de
visualização no menu suspenso da janela de visualização. Consulte Exibir um FlexCard em diferentes
pontos de interrupção da viewport .
Qual é o próximo
Veja também

Aparência do elemento FlexCards

Atualize a aparência de seus elementos FlexCard com as propriedades Appearance no painel Style do FlexCard
Designer. Altere a cor do texto, o plano de fundo, a borda e defina um tema do Salesforce para seus
elementos.
Veja também
Propriedades de Aparência do Elemento FlexCards

As propriedades de aparência são configuráveis no painel Estilo do FlexCard Designer quando você seleciona
um elemento. Atualize o plano de fundo, a cor do texto, a borda e o tema dos seus elementos.
Cor de fundo Selecione uma cor de fundo. Insira um código de cor hexadecimal, como #ff0000. Ou clique na caixa colorida para
selecionar em um seletor de cores.

company
Imagem de fundo Insira o URL da imagem a ser exibida como plano de fundo do seu elemento. A imagem deve ser acessível.
URL
Posição de fundo Defina a posição da imagem de fundo. Insira qualquer valor permitido pela propriedade CSS background-position , como
right bottom , center , 10px 30px e assim por diante.
fundo de repetição Defina como a imagem de fundo se repete. Insira qualquer valor permitido pela propriedade CSS background-repeat ,
como no-repeat , repeat , repeat-x e assim por diante.
Tamanho do plano de Defina o tamanho da imagem de fundo. Insira um valor permitido pela propriedade CSS background-size , como cover ,
fundo container e assim por diante.
Cor da borda Selecione uma cor de borda. Insira um código de cor hexadecimal, como #ff0000. Ou clique na caixa colorida para
selecionar em um seletor de cores.
Raio da borda Para arredondar as bordas da borda do elemento, defina um raio da borda. Insira um valor permitido pela propriedade
CSS border-radius , como 25px , 25px 50px e assim por diante.
Estilo de borda Selecione o tipo de borda a ser exibida. Insira um valor permitido pela propriedade CSS de estilo de borda, como solid ,
dashed , inset e assim por diante. O padrão é sólido .
Tipo de borda Selecione um ou mais locais de borda, como superior , inferior , direito e esquerdo . Para remover um local de borda,
selecione-o novamente no menu suspenso.
Largura da borda Insira um número para a espessura da borda em pixels.
Tema do Salesforce Selecione um esquema de cores predefinido para o seu elemento.
Cor do texto Atualize a cor do texto do elemento. Insira um código de cor hexadecimal, como #ff0000. Ou clique na caixa colorida
para selecionar em um seletor de cores.
Veja também
Alinhamento do Elemento FlexCards

Com as propriedades de Alinhamento no painel Estilo do FlexCard Designer, você pode criar espaço dentro e
ao redor de seus elementos. Você também pode ajustar a posição do texto em relação ao contêiner do
elemento.
Veja também
Propriedades de alinhamento do elemento FlexCards

As propriedades de Alinhamento de um elemento são configuráveis no painel Estilo quando um elemento é
selecionado no FlexCard Designer. Configurando preenchimento, margem e alinhamento de texto.
Tamanho da Selecione o tamanho das margens.

margem
Tipo de margem Selecione onde adicionar margens ao seu elemento, como a parte inferior, os dois espaços verticais, as duas posições
horizontais, ao redor de todo o elemento e assim por diante.
Tamanho do Selecione o tamanho do preenchimento.

preenchimento
Tipo de Selecione onde adicionar preenchimento ao seu elemento, como a parte inferior, os dois espaços verticais, as duas posições
preenchimento horizontais, ao redor de todo o elemento e assim por diante.
Alinhamento de Selecione o alinhamento do texto, como center , para atualizar o alinhamento do conteúdo no contêiner do elemento.
texto
Veja também
• Adicionar espaço dentro de um elemento FlexCard

• Adicione espaço ao redor do seu elemento FlexCard
company
Adicionar espaço dentro de um elemento FlexCard

Crie espaço dentro do container de um elemento FlexCard. Adicione preenchimento para criar espaço entre o
limite de seu elemento e o conteúdo dentro de seu elemento.
1. No FlexCard Designer, clique em um elemento em um estado e clique em Estilo para abrir o painel Estilo.
2. Na lista suspensa Tipo de preenchimento , selecione onde adicionar seu preenchimento. Por exemplo,
para adicionar preenchimento em todos os lados do conteúdo, selecione Ao redor . Para adicionar
preenchimento à parte superior e inferior, selecione Horizontal .
3. Na lista suspensa Tamanho de preenchimento , selecione quanto preenchimento adicionar, como Médio
, x-Pequeno e assim por diante. Consulte Preenchimento SLDS .
4. Clique no ícone de adição.
5. Repita as etapas 1 a 3 para adicionar mais preenchimento.
Veja também
• Adicione espaço ao redor do seu elemento FlexCard

Adicione espaço ao redor do seu elemento FlexCard

Crie espaço ao redor do contêiner de um elemento FlexCard. Adicione margens entre elementos adjacentes
em seu FlexCard.
1. No FlexCard Designer, clique em um elemento em um estado e clique em Estilo para abrir o painel Estilo.
2. Na lista suspensa Tipo de margem , selecione onde adicionar sua margem. Por exemplo, para adicionar
espaço ao redor de todo o elemento, selecione Ao redor . Para adicionar espaço acima e abaixo do seu
elemento, selecione Horizontal .
3. Na lista suspensa Margin Size , selecione quanto espaçamento adicionar, como Medium , x-Small e assim
por diante. Consulte Preenchimento SLDS .
4. Clique no ícone de adição.
5. Repita as etapas 1 a 3 para adicionar mais margens.
Veja também
• Adicionar espaço dentro de um elemento FlexCard

CSS personalizado de elementos FlexCard

Crie, edite e aplique classes CSS personalizadas e estilos embutidos aos seus elementos FlexCard no FlexCard
Designer. Quando as opções de estilo disponíveis nas interfaces de design do painel Estilo não atendem às
suas necessidades de design, crie classes CSS personalizadas de um editor de código dentro do designer e
aplique-as aos campos com suporte. Ou adicione estilos embutidos a um elemento específico.
• Crie e aplique CSS personalizado no FlexCard Designer:
1. Crie CSS personalizado no FlexCard Designer

2. Aplicar CSS personalizado a um elemento FlexCard
• Adicionar estilos embutidos a um elemento FlexCard

company
Veja também
Propriedades CSS personalizadas de FlexCards

As propriedades CSS personalizadas são configuráveis no painel Estilo no FlexCard Designer quando você
seleciona um elemento. Quando as interfaces de design no painel Estilo não atendem às suas necessidades de
design, aplique uma classe de qualquer folha de estilo disponível ao FlexCard ou adicione estilos embutidos.
Classe de contêiner Adicione uma classe ao contêiner do seu elemento.
Classe personalizada Adicione uma classe diretamente ao elemento.
Estilos CSS embutidos Aplique estilos CSS embutidos ao seu elemento, como font-variant: small- caps; .
Veja também
• Adicionar estilos embutidos a um elemento FlexCard

• Crie CSS personalizado no FlexCard Designer .
Crie CSS personalizado no FlexCard Designer

Crie classes CSS personalizadas no FlexCard Designer para aplicar a elementos FlexCard ou campos suportados
dentro de elementos. Crie classes CSS personalizadas quando as interfaces de design no painel Estilo não
atenderem às suas necessidades de design. Consulte Elementos de estilo FlexCard .
O CSS personalizado é um anexo do Salesforce. Quando o FlexCard é salvo, o anexo é atualizado. Um

arquivo .css também é empacotado com o LWC gerado.
2. No submenu do FlexCard Designer, clique na seta para baixo ao lado de Ativar e selecione Adicionar CSS
personalizado .

company
NOTA
Seu FlexCard deve estar inativo para usar este recurso.
3. Insira suas classes personalizadas dentro do editor de código.
4. (Opcional) Habilite Carregar como CSS Global . Esses estilos personalizados são carregados como uma
folha de estilo no cabeçalho da página quando esse recurso está ativado. E quando não ativado, é
carregado como estilos internos apenas dentro do cabeçalho do FlexCard.
Qual é o próximo
Aplique classes CSS personalizadas aos elementos. Consulte Aplicar CSS personalizado a um elemento FlexCard
.
Veja também
Propriedades de 'Adicionar CSS personalizado' de FlexCards

Adicionar propriedades CSS personalizadas são configuráveis no submenu do FlexCard Designer. Crie classes
CSS personalizadas e adicione-as aos campos suportados nos painéis Propriedades e Estilo. Consulte Criar CSS
personalizado no FlexCard Designer .

company
Adicionar CSS Crie e edite classes CSS personalizadas. O CSS personalizado é um anexo do Salesforce. Quando o FlexCard é salvo, o
personalizado anexo é atualizado. Um .css também é empacotado com o LWC gerado.
Carregar como CSS global Habilite para aplicar suas classes CSS em tempo de execução, como na visualização.
Veja também
• CSS personalizado de elementos FlexCard

Aplicar CSS personalizado a um elemento FlexCard

Quando as interfaces de design disponíveis no painel Estilo do FlexCard Designer não atendem às suas
necessidades de design, aplique CSS personalizado aos seus elementos. Adicione CSS personalizado para editar
os componentes internos de um elemento ou elemento filho. Use esse recurso com moderação para otimizar
o desempenho.
Aplique classes de folhas de estilo disponíveis para o FlexCard, como as folhas de estilo globais SLDS e
Newport. Ou aplique classes que você cria dentro do FlexCard Designer com o recurso Add Custom CSS .
Consulte Criar CSS personalizado no FlexCard Designer .
Exemplo 12. Exemplo de elemento de tabela de dados agrupado com cores de fundo
alternadas
Você tem um elemento Datatable que exibe casos de conta agrupados por tipo de caso. Você deseja mostrar
cores de fundo alternadas para todas as linhas e definir uma cor de fundo diferente para o cabeçalho do
grupo. Não há opção no painel Estilo para alternar as cores de fundo das linhas. Mas você pode inserir uma
classe para o título do grupo. Use o recurso Adicionar CSS personalizado para criar duas classes. Uma classe
alt-table-rows para o elemento Datatable e uma classe alt-bg-group-wrapper para o cabeçalho do grupo.

company
Aplique a classe alt-table-rows ao elemento e a classe alt-bg-group-wrapper ao cabeçalho do grupo.
1. No FlexCard Designer, selecione um elemento na tela.

2. Para aplicar uma classe personalizada a um elemento, clique em Estilo para abrir o paine l Estilo. Na seção
CSS personalizado , conclua uma ou ambas as tarefas:
• Para anexar uma classe personalizada ao contêiner do elemento, insira o nome da classe no campo
Classe do contêiner , como branded-tables .
• Para anexar uma classe personalizada diretamente no elemento, insira o nome da classe no campo
Classe personalizada , como alt-table-rows do exemplo acima.
3. Para aplicar uma classe personalizada a um campo específico dentro de um elemento, no painel
Propriedades, insira uma classe em um campo que suporte classes.
Por exemplo, no exemplo de tabela de dados agrupada anterior, insira alt-bg-group-wrapper no campo
Classe de Wrapper de Grupo no painel Propriedades de um elemento Datatable.
Veja também
Propriedades de 'Adicionar CSS personalizado' de FlexCards

Adicionar propriedades CSS personalizadas são configuráveis no submenu do FlexCard Designer. Crie classes
CSS personalizadas e adicione-as aos campos suportados nos painéis Propriedades e Estilo. Consulte Criar CSS
personalizado no FlexCard Designer .

company
Adicionar CSS Crie e edite classes CSS personalizadas. O CSS personalizado é um anexo do Salesforce. Quando o FlexCard é salvo, o
personalizado anexo é atualizado. Um .css também é empacotado com o LWC gerado.
Carregar como CSS global Habilite para aplicar suas classes CSS em tempo de execução, como na visualização.
Veja também

Adicionar estilos embutidos a um elemento FlexCard

Quando as opções de estilo disponíveis nas interfaces de design no FlexCard Designer não atendem às suas
necessidades de design, adicione estilos CSS inline a um elemento em um FlexCard. Substitua classes e
direcione elementos específicos ou componentes de elementos.
GORJETA
Use esse recurso conforme necessário e com moderação para otimizar o desempenho.
2. No campo Estilos CSS Inline da seção Personalizado , insira as propriedades CSS e seus valores. Por
exemplo, font-variant: small-caps; espaçamento entre palavras: 30 px; .
Qual é o próximo
Veja também
Propriedades do estilo de ação dos FlexCards

Configure as propriedades de estilo específicas do elemento Action no painel Style no FlexCard Designer. Para
configurar propriedades de estilo adicionais comuns a todos os elementos, consulte Style FlexCard Elements .
Cor Insira um código de cor hexadecimal ou clique no quadrado colorido para selecionar uma cor no seletor de cores.
Família de fontes Insira uma ou mais fontes Web-safe , SLDS ou Newport Design System. Suporta as opções de propriedade CSS da família de
fontes. Por exemplo, insira uma fonte específica, como Courier New ; uma fonte geral, como serifa ; ou uma lista de reserva,
como Times New Roman, Courier New, serif .
Tamanho da fonte Selecione um tamanho de fonte. Insira qualquer valor permitido pela propriedade CSS font-size , como 1em , 6px , large ou
calc() . Se você inserir apenas um número, a unidade padrão usada será px .
Tamanho Selecione o tamanho de todo o elemento, como Médio .
Alinhamento de Selecione o alinhamento do texto, como centro . Para alinhar o texto de um conteúdo Flyout, selecione Text Align na seção
texto Alignment do painel Style.
Decoração de texto Defina a aparência das linhas decorativas no texto. Insira um valor permitido pela propriedade CSS de decoração de texto ,
como sublinhado e sobrelinhado .
Veja também

company
Propriedades do estilo da tabela de dados FlexCards
Configure as propriedades de estilo específicas do elemento Datatable no painel Style do FlexCard Designer.
Para configurar propriedades de estilo adicionais comuns a todos os elementos, consulte Style FlexCard
Elements .
Propriedade Descrição Aplica-se a
Cor de fundo Selecione uma cor de fundo. Insira um código de cor hexadecimal, como #ff0000. Ou Tabela, Células,
clique na caixa colorida para selecionar em um seletor de cores. Tabela
Cabeça, Linhas
Cor da borda Selecione uma cor de borda. Insira um código de cor hexadecimal, como #ff0000. Ou Tabela, Células
clique na caixa colorida para selecionar em um seletor de cores.
Tipo de borda Selecione um ou mais locais de borda, como superior , inferior , direito e esquerdo . Tabela, Células
Para remover um local de borda, selecione -o novamente no menu suspenso.
Largura da borda Insira um número para a espessura da borda em pixels. Tabela, Células
Sombra da caixa Adicione uma sombra de caixa às células. Insira um valor permitido pela propriedade Células
CSS box-shadow , como 2px 4px 3px #888888 .
Família de fontes Insira uma ou mais fontes Web-safe , SLDS ou Newport Design System. Suporta as Cabeçalho da Mesa
opções de propriedade CSS da família de fontes. Por exemplo, insira uma fonte
específica, como Courier New ; uma fonte geral, como serifa ; ou uma lista de reserva,
Espessura da fonte Insira um valor permitido pela propriedade CSS font-weight , como bold , light , 600 e Cabeçalho da Mesa
assim por diante.
Tamanho da margem Selecione o tamanho das margens para todas as células. Células
Tipo de margem Selecione onde adicionar margens às células, como a parte inferior, os dois espaços Células
verticais, as duas posições horizontais, ao redor de toda a célula e assim por diante.
Tamanho do Selecione o tamanho do preenchimento para todas as células. Células

preenchimento
Tipo de preenchimento Selecione onde adicionar preenchimento às células, como a parte inferior, os dois Células
espaços verticais, as duas posições horizontais ou ao redor de toda a célula e assim por
diante.
Decoração de texto Defina a aparência das linhas decorativas no texto. Insira um valor permitido pela Cabeçalho da Mesa
propriedade CSS de decoração de texto , como sublinhado e sobrelinhado .
Veja também
• Crie CSS personalizado no FlexCard Designer
Propriedades de estilo de campo de FlexCards

Configure as propriedades de estilo específicas do elemento Field no painel Style do FlexCard Designer. Para
Cor Insira um código de cor hexadecimal ou clique no quadrado colorido para selecionar uma cor no n/D
seletor de cores.
Família de fontes Insira uma ou mais fontes Web-safe , SLDS ou Newport Design System. Suporta as opções de n/D
propriedade CSS fontfamily. Por exemplo, insira uma fonte específica, como Courier New ; uma
fonte geral, como serifa ; ou uma lista de reserva, como Times New Roman, Courier New, serif .
Tamanho da fonte Selecione um tamanho de fonte. Insira qualquer valor permitido pela propriedade CSS font-size , n/D
como 1em , 6px , large ou calc() . Se você inserir apenas um número, a unidade padrão usada será
px .

company
Classe de rótulo Selecione uma classe para o rótulo do campo. Selecione a partir de uma classe definida no recurso Criar CSS
Add Custom CSS do FlexCard Designer ou qualquer folha de estilo disponível para o FlexCard. personalizado
Dentro do FlexCard
Projetista
Alinhamento de Selecione o alinhamento do texto, como centro . n/D
texto
Decoração de texto Defina a aparência das linhas decorativas no texto. Insira um valor permitido pela propriedade CSS n/D
textdecoration , como underline e overline .
Classe de valor Selecione uma classe para o valor do campo. Selecione uma classe definida no recurso Adicionar Criar CSS
CSS personalizado do FlexCard Designer ou qualquer folha de estilo disponível para o componente. personalizado
Dentro do FlexCard
Projetista
Veja também
Propriedades do estilo do ícone FlexCards

Configure as propriedades de estilo específicas do elemento Icon no painel Style do FlexCard Designer. Para
Aula extra Insira uma classe anexada ao contêiner do elemento. Selecione a partir de uma classe definida Criar CSS personalizado
no recurso Add Custom CSS do FlexCard Designer ou qualquer folha de estilo disponível para o Dentro do FlexCard
FlexCard. Projetista
Cor do ícone Insira um código de cor hexadecimal ou clique no quadrado colorido para selecionar uma cor no n/D
seletor de cores.
Veja também
Propriedades do estilo do menu FlexCards
Configure as propriedades de estilo específicas do elemento Menu no painel Estilo do FlexCard Designer. Para
Cor Insira um código de cor hexadecimal ou clique no quadrado colorido para selecionar uma cor no seletor de cores.
Tamanho Selecione o tamanho de todo o elemento, como Médio .
Veja também
Propriedades de estilo de alternância de FlexCards

Configure as propriedades de estilo específicas do elemento Toggle no painel Style no FlexCard Designer. Para
configurar propriedades de estilo adicionais comuns a todos os elementos, consulte Style FlexCard
Elements .

company
Propriedades de alternância de caixa de seleção, botão e grupo
Essas propriedades são exclusivas para os tipos de alternância de caixa de seleção, botão de caixa de seleção,
botão de grupo de caixa de seleção, alternância de grupo de caixa de seleção.
Alinhamento de Selecione o alinhamento do texto, como centro .
texto
IMPORTANTE
A propriedade Font Size não está disponível para os tipos de alternância Checkbox Toggle e
Checkbox Button na versão Vlocity Health and Insurance Spring '21.
Botão da caixa de seleção e propriedades de alternância

Essas propriedades são exclusivas dos tipos de alternância de caixa de seleção e botão de caixa de seleção.
Etiqueta marcada Selecione a cor de exibição do rótulo quando o elemento de alternância for selecionado. Insira um código de cor
hexadecimal ou clique na caixa colorida para selecionar uma cor no seletor de cores.
Rótulo desmarcado Selecione a cor de exibição do rótulo quando o elemento de alternância não estiver selecionado. Insira um código de cor
hexadecimal ou clique na caixa colorida para selecionar uma cor no seletor de cores.
Propriedades do botão da caixa de seleção

Essas propriedades são exclusivas do tipo de alternância Botão Caixa de Seleção.
Ícone verificado Selecione a cor de exibição quando o elemento de alternância for selecionado. Insira um código de cor hexadecimal ou clique
na caixa colorida para selecionar uma cor no seletor de cores.
Ícone desmarcado Selecione a cor de exibição quando o elemento de alternância não estiver selecionado. Insira um código de cor hexadecimal
ou clique na caixa colorida para selecionar uma cor no seletor de cores.
Propriedades do grupo de caixas de seleção

Essas propriedades são exclusivas dos tipos de alternância Botão do Grupo de Caixas de Seleção e Grupo de
Caixas de Seleção.
Cor Selecione uma cor de etiqueta. Insira um código de cor hexadecimal ou clique na caixa colorida para selecionar uma cor no sel etor
de cores.
Veja também
• Referência do tipo de elemento de alternância FlexCard
Criar um estilo personalizado para um elemento FlexCard

Salve as configurações de estilo em um elemento FlexCard como um estilo personalizado para usar em vários
elementos em seu FlexCard. Por exemplo, para aplicar a mesma cor de fonte, tamanho de fonte, cor de texto e
cor de fundo a vários elementos de campo em um FlexCard, crie um estilo personalizado chamado esquema
de campo azul em um elemento de campo. Em seguida, aplique o esquema de campo azul a outros
elementos de campo conforme necessário.
company
O recurso Estilo personalizado salva todas as configurações definidas no painel Estilo, incluindo classes, estilos
embutidos, larguras e capacidade de resposta.
Criar um estilo personalizado

1. No FlexCard Designer, selecione um elemento da tela e clique em Estilo para abrir o painel Estilo.
2. Estilize o elemento conforme necessário. Consulte Elementos de estilo FlexCard .
3. Para criar um novo estilo, na seção Estilos personalizados , clique na seta para baixo e selecione Salvar
como .
4. Digite um nome de estilo no campo Digite o nome do estilo .

Aplicar um estilo personalizado

1. No FlexCard Designer, selecione um elemento na tela e clique em Estilo para abrir o painel Estilo.
2. Clique no ícone de pesquisa Selecionar estilo salvo na seção Estilos personalizados .

company
3. No modal Selecionar estilos salvos , clique no nome de um estilo em Selecionar estilo .
4. Veja como seu estilo aplicado ficará na seção Visualização do modal.
Qual é o próximo
Veja também
• Crie elementos responsivos em um FlexCard
Propriedades de estilos personalizados FlexCards

estilos personalizados são configuráveis no painel Estilo quando você seleciona um elemento no FlexCard
Designer. Salve as configurações de estilo em um elemento FlexCard como um estilo personalizado para usar
em vários elementos em um FlexCard. Consulte Criar um estilo personalizado para um elemento FlexCard .
Limpar estilos Limpe todos os estilos configurados no painel Estilo, incluindo classes aplicadas e capacidade de resposta.
Criar novo estilo Crie um novo estilo personalizado com base no conjunto de estilos atual.
Digite o nome do estilo Insira o nome de um novo estilo personalizado.
Remover padrão Remove o estilo padrão para o tipo de elemento selecionado. Por exemplo, se o estilo atual para um elemento Action
selecionado for Red Action e você clicar em Remove Default , o estilo padrão para qualquer novo elemento Action
adicionado ao FlexCard não terá um estilo padrão.
Redefinir alterações Redefina as alterações para um estilo personalizado salvo. Remove todos os estilos aplicados a um elemento que não faz
parte do estilo personalizado aplicado. Por exemplo, se você adicionar uma imagem de plano de fundo a um elemento
Ação cujo Estilo personalizado seja Ação vermelha , clicar em Redefinir alterações remove a imagem de plano de fundo,
mas mantém todas as configurações que fazem parte do Estilo personalizado de ação vermelha .
Salvar como Salve as configurações de estilo atuais como um estilo personalizado.
Procurar estilo Pesquise na lista de estilos personalizados salvos.
Selecione o estilo salvo Aplique um estilo personalizado salvo ao elemento.
Definir como padrão Defina o Estilo personalizado atual como padrão para o tipo de elemento selecionado. Por exemplo, se o estilo atual para
um elemento Action selecionado for Red Action e você clicar em Set As Default , o estilo padrão para qualquer novo
elemento Action adicionado ao FlexCard será Red Action .
Veja também

company
Exibir registros lado a lado em um FlexCard
Exiba registros lado a lado em vez de empilhados uns sobre os outros incorporando um FlexCard filho e
ajustando as larguras de seus estados. Por padrão, os registros são exibidos um em cima do outro,
independentemente das larguras dos elementos individuais no FlexCard.
Para exibir registros um ao lado do outro, incorpore um FlexCard filho cuja largura tenha no máximo 6 colunas
(50%) de largura. Consulte Ajustar a largura de um elemento em um FlexCard .
Crie o FlexCard filho

1. Crie um FlexCard filho e adicione todos os elementos que deseja exibir em cada estado. Consulte
Incorporar um FlexCard filho dentro de um FlexCard
2. Clique em um estado e clique em Estilo para abrir o painel Estilo.
3. Na seção Dimensões , em Padrão , use o controle deslizante para ajustar a largura do estado para no
máximo 6.
Por exemplo, para exibir dois registros próximos um do outro, selecione 6. Para exibir 3 registros
próximos um do outro, selecione 4. Para exibir 4 registros próximos um do outro, selecione 3.
GORJETA
Considere habilitar a capacidade de resposta para que, quando seu FlexCard for visualizado
em dispositivos móveis, seu conteúdo tenha uma boa aparência. Por exemplo, torne os
registros de largura total em dispositivos móveis, mas com 6 colunas de largura e m tablets e 3
colunas de largura em desktops. Consulte Criar elementos responsivos em um FlexCard .
4. Repita as etapas 2 e 3 para cada estado em seu Child FlexCard.

Incorporar o filho FlexCard em um FlexCard

1. Crie um novo FlexCard. Consulte Criar um novo FlexCard . Ou abra um FlexCard existente na guia inicial
do FlexCards.
2. No painel Build, arraste um elemento FlexCard para um estado ativo.
3. Clique em Nome do cartão e selecione o nome do FlexCard filho que você criou nas etapas acima.

company
4. Se seus dados pai não precisarem ser repetidos, clique em Configurar e desmarque Repetir registros .
Isso exibirá apenas um registro no FlexCard pai. Consulte Desativar loop de registro em um FlexCard .
5. Clique em Visualizar para ver seus registros exibidos um ao lado do outro.
Qual é o próximo
Configure as opções de publicação para definir valores de metadados e adicionar um ícone SVG de
componente personalizado para seu LWC gerado. Consulte Configurar opções de publicação em um FlexCard .
Organizar, duplicar e remover elementos em um FlexCard

Organize, duplique e exclua elementos na tela de um FlexCard no FlexCard Designer. Arraste os elementos
para a tela e reorganize-os arrastando-os para baixo, para cima e ao lado de outros elementos. Duplique e
remova elementos com um clique.
1. Para reorganizar um elemento dentro de um estado ou mover um elemento entre estados, clique e
segure o elemento e arraste-o para a posição desejada. Aguarde até que o indicador de posição apareça
na posição desejada antes de soltar.

company
2. Para reorganizar um estado, clique e mantenha pressionado o estado e mova-o para cima ou para baixo
até a posição desejada.
3. Para duplicar um elemento, clique no elemento e clique no ícone de quadrado duplo.
Estado
Elemento (não um Estado)
4. Para excluir um elemento, clique no elemento e clique no ícone da lixeira.
Veja também
• Ajustar a largura de um elemento em um FlexCard
Passar Strings Concatenadas como Valores em FlexCards

Passe strings concatenadas como o valor para as propriedades de elemento FlexCard suportadas. Por exemplo,
passe um caminho de breadcrumbs como {Parent.parentPath}>{Parent.type}>{Name} na propriedade Value
de um Attribute de um FlexCard filho.
Elementos do FlexCard Propriedades compatíveis
FlexCard (filho FlexCard) , LWC personalizado , Flyout Action Atributos > Valor
Ação , Menu , Bloco (quando Recolhível está ativado) Etiqueta
Ação > Tipo de ação > Cartão Definir valores > Valor

company
Ação > Tipo de ação > Evento Parâmetros de entrada > Valor
Campo Etiqueta, Saída
Imagem Título
Ativar rastreamento em um FlexCard

Habilite o rastreamento de um FlexCard Action ou Child FlexCard . Os FlexCards pai e filho rastreiam os
eventos Card Load, Card Unload e State Load. A ação rastreia o evento de ação da interface do usuário.
Por padrão, o recurso Enable Tracking está habilitado em um FlexCard que não é um FlexCard filho. Por
exemplo, em um FlexCard pai que possui um FlexCard filho incorporado, o rastreamento é ativado no pai por
padrão.
Para rastrear eventos em um FlexCard filho, você deve habilitar o recurso Enable Tracking , que está
desabilitado por padrão. Para habilitar o rastreamento em todos os FlexCards filhos aninhados, você deve
habilitar o recurso de rastreamento em todos os FlexCards pais.
No elemento Action, o recurso Enable Tracking é ativado por padrão. Quando desabilitado, o evento UI Action
não é acionado. O rastreamento de cliques de ação é independente do rastreamento do Child FlexCard.
1. No FlexCard Designer, selecione uma ação na tela ou arraste um elemento suportado, como Ação, para
um estado na tela.
2. No painel Propriedades, se o recurso Ativar rastreamento estiver desativado, clique para ativar.
Veja também
• Acompanhamento de eventos da estrutura de cartões
• Ativar rastreamento para componentes do OmniStudio
Visualização do FlexCard Designer

Visualize a aparência do seu FlexCard e teste a funcionalidade antes de publicá-lo em uma página do Lightning
ou da Comunidade. Teste a aparência do seu FlexCard em vários dispositivos. Teste a funcionalidade de
elementos interativos, como ações. Depure a saída de dados, eventos e ações do seu FlexCard.
IMPORTANTE
Se você não vir seu conteúdo na tela de visualização, verifique se concedeu acesso aos domínios
de sua organização nas configurações do site remoto. Consulte Atualizar as configurações do site
remoto para visualizar seu FlexCard .
NOTA
As ações Navigate e OmniScript não funcionam na visualização. Adicione-os a uma página do
Lightning ou da Comunidade para visualizá-los.
• Adicionar parâmetros de teste

Insira variáveis de teste adicionais que sua consulta de fonte de dados pode usar para atualizar sua
visualização.
• Lista suspensa da janela de visualização
company
Ajuste o tamanho da tela do seu FlexCard para testar a capacidade de resposta. Use o menu suspenso
Viewport para imitar os tamanhos de um desktop, laptop e dispositivos móveis menores.
• JSON de dados do FlexCard Designer
Visualize o JSON de dados do seu FlexCard. Procure por possíveis problemas em como sua fonte de dados
preenche elementos em seu FlexCard antes de publicá-lo ou enviar dados para outro componente, como
um OmniScript. O painel Data JSON é atualizado quando você interage com o FlexCard.
• Depurador de ações do FlexCard Designer
Visualize as solicitações e respostas de ações e eventos do seu FlexCard no A ction Debugger. Clique em um
item acionável para exibir seu log e eventos associados.
Visualizar um FlexCard
Visualize a aparência e a funcionalidade do seu FlexCard antes de publicá-lo em uma página do Lightning ou da
Comunidade. Na visualização, teste a aparência do seu FlexCard em vários dispositivos e teste a funcionalidade
dos links de ação e outros elementos interativos.
NOTA
As ações Navigate e OmniScript não funcionam na visualização. Adicione-os a uma página do
Lightning ou da Comunidade para visualizá-los.

• Crie um FlexCard e configure sua fonte de dados. Consulte Criar um novo FlexCard .
• Adicione elementos ao seu FlexCard. Consulte Adicionar elementos a um FlexCard .
1. No submenu do FlexCard Designer, clique em Visualizar .
IMPORTANTE
Se você não vir seu conteúdo na tela de visualização, verifique se concedeu acesso aos
domínios de sua organização nas configurações do site remoto. Consulte Atualizar as
configurações do site remoto para visualizar seu FlexCard .
2. (Opcional) Para adicionar parâmetros de teste, clique em Adicionar parâmetros de teste e execute estas
tarefas:
• Em Key , insira uma variável para testar como e quais dados são exibidos em seu FlexCard. Por
exemplo, insira pagelimit para atualizar quantas páginas são exibidas para um elemento Datatable.
Consulte Variáveis de contexto FlexCards .
• Em Valor , insira um valor de teste. Por exemplo, se a chave for pagelimit , insira 2 para limitar o
número de páginas a serem exibidas em um elemento Datatable para 2.
• Clique em Adicionar para inserir outro parâmetro como um par chave/valor.
3. (Opcional) Para ver a aparência do seu FlexCard em diferentes dispositivos, selecione no menu suspenso
Viewport.
NOTA
Para permitir que os elementos alterem as larguras em resposta à largura da viewport,
consulte Criar elementos responsivos em um FlexCard .
4. (Opcional) A partir do Summer '21, visualize o JSON de dados do seu FlexCard no painel Data JSON .
Consulte Visualizar o JSON de dados de um FlexCard .
5. (Opcional) A partir do Summer '21, depure solicitações e respostas de ações e eventos do
painel Action Debugger . Consulte Depurar solicitações e respostas de ações e eventos do FlexCard .
company
6. (Opcional) A partir do Summer '21, para visualizar seu FlexCard em largura total , clique no ícone de
alternância ( ) para fechar o Painel de depuração.
Qual é o próximo
Ative seu FlexCard. Consulte Ativar um FlexCard .
Veja também
Propriedades de 'Adicionar parâmetros de teste' da visualização FlexCards

FlexCards Add Test Params As propriedades estão disponíveis ao visualizar um FlexCard no FlexCard
Desenhista. Visualize a aparência e a funcionalidade do FlexCard antes de publicá-lo em uma página do
Lightning ou da Comunidade. Insira variáveis de teste adicionais que sua consulta de fonte de dados pode usar
para atualizar sua visualização.
Consulte Visualizar um FlexCard .

Chave Insira uma variável para testar como e quais dados são exibidos em seu FlexCard. Por exemplo, insira pagelimit para atualizar
quantas páginas são exibidas para uma tabela de dados.
Valor Insira um valor de teste. Por exemplo, se a chave for pagelimit , insira 2 para limitar o número de páginas a serem exibidas em uma
tabela de dados para 2.
JSON de dados do FlexCard Designer

Use o recurso Data JSON na guia Visualização do FlexCard Designer para ver como sua fonte de dados
preenche os elementos nos cartões renderizados do seu componente FlexCard. Detecte possíveis problemas
em tempo de execução. O painel Data JSON é atualizado quando você interage com o FlexCard, como ao
inserir dados em um campo de entrada ou clicar em um item acionável.
A tabela a seguir lista os objetos disponíveis do Data JSON e as informações que cada objeto fornece:

company
Objeto Descrição
cartas Exibe informações sobre cartões renderizados com base nos dados exibidos e nas condições de estado aplicadas. Por exemplo, se
o seu FlexCard exibir informações sobre uma conta e a fonte de dados retornar 3 contas sem condições aplicadas, o objeto de
cartões mostrará 3 objetos de cartão. Cada objeto de cartão exibe o nome do estado do cartão, campos de dados, atributos e
FlexCards filho. O uniqueKey distingue os objetos de cartão uns dos outros.
NOTA
Se o seu FlexCard tiver um FlexCard filho, apenas seu nome aparecerá no painel Data JSON.
fonte de dados Exibe a matriz de registros retornados da fonte de dados e as configurações definidas no painel Configuração, como o tipo de
fonte de dados e o tempo de atraso. Exibe configurações adicionais dependendo do tipo de fonte de dados. Consulte Configurar
uma fonte de dados em um FlexCard .
Etiqueta Exibe etiquetas personalizadas buscadas para o FlexCard. Consulte Adicionar etiquetas personalizadas aos campos suportados em
um FlexCard .
Parâmetros Exibe parâmetros de página do Salesforce, como namespace.
ID do registro Exibe o ID da página FlexCard como visto na URL quando você está no FlexCard Designer.
Sessão Exibe as Variáveis de Sessão definidas no painel Configuração. Consulte Adicionar variáveis de sessão a um FlexCard .
Objeto Descrição
TestParams Exibe os parâmetros de teste definidos no recurso Adicionar parâmetros de teste . Consulte Propriedades de 'Adicionar
parâmetros de teste' da visualização FlexCards .
tema Exibe o tema FlexCard conforme selecionado quando o FlexCard foi criado.
título Exibe o nome do FlexCard conforme definido quando o FlexCard foi criado.
Do utilizador Exibe informações do usuário conectado. Consulte Variáveis de contexto FlexCard .
Veja também
• Depurar solicitações e respostas de ações e eventos do FlexCard
Visualizar o JSON de dados de um FlexCard

Visualize o JSON de dados do seu FlexCard na guia Preview do FlexCard Designer. Procure por possíveis
problemas em como sua fonte de dados preenche os elementos antes de publicar seu FlexCard ou enviar
dados para outro componente. O painel Data JSON é atualizado quando você interage com o FlexCard, como
ao inserir dados em um campo de entrada ou clicar em uma ação.
NOTA
Se o seu FlexCard tiver um FlexCard filho, apenas seu nome aparecerá no painel Data JSON.
1. No FlexCard Designer, clique em Visualizar.

2. Na guia Data JSON , visualize os dados aplicáveis ao seu FlexCard visíveis na Visualização. Clique na seta
ao lado de qualquer nó de objeto para ver seus nós filhos.
3. Para confirmar que os registros retornam conforme o esperado, clique no objeto de registros no objeto
dataSource .
4. Para confirmar que o Data JSON é atualizado quando você interage com o FlexCard:
a. Na tela, clique em uma ação que atualiza os dados.

company
b. Em Data JSON , clique em um objeto de cartão renderizado no objeto de cartões para ver os dados
atualizados.
c. Se uma ação atualizar a fonte de dados, clique em um objeto no dataSource config ou objetos de
registros para visualizar as atualizações.
5. Para visualizar o estado do cartão renderizado, consulte StateName em cada objeto de cartão .
6. Para visualizar as variáveis de sessão criadas no Painel de Configuração, clique no objeto Sessão .
Consulte Adicionar variáveis de sessão a um FlexCard .
Veja também
• JSON de dados do FlexCard Designer
• Depurar solicitações e respostas de ações e eventos do FlexCard
Depurador de ações do FlexCard Designer

Depure as ações e eventos do cliente e do servidor do FlexCard com o Action Debugger na guia Visualização do
FlexCard Designer. Visualize solicitações e respostas para ver quando e onde ocorrem erros para determinar
como corrigi-los.
Visualize a configuração, o status e as respostas das fontes de dados pai e filho. Visualize o tipo de fonte de
dados e as configurações relevantes, como o tempo de atraso da propriedade de configuração . Veja se a
fonte de dados retorna dados com sucesso no campo de status . Visualize os dados retornados no campo de
resposta .
Visualize a resposta de cada ação ou evento executado em seu FlexCard. Por exemplo, digamos que seu
FlexCard tenha um evento pubsub que passa dados com o evento disparado. Um ouvinte de eventos no
mesmo FlexCard atualiza um campo de dados com o valor passado para ele do evento pubsub. Clicar no link
de ação Pubsub Event em seu FlexCard na visualização exibe a ação Pubsub Event e os logs de ação Set Values
no Action Debugger.
Os logs de ação exibem dados relevantes para o tipo de ação. Por exemplo, um log de ações do Pubsub Event
exibe channel , event e inputMap . Um log de ação Definir valores exibe campos e respostas .
Veja também

company
• Visualizar o JSON de dados de um FlexCard
Depurar solicitações e respostas de ações e eventos do FlexCard
Visualize as solicitações e respostas de ações e eventos do seu FlexCard no Action Debugger na guia
Visualização do FlexCard Designer . Clique em um item acionável para exibir seu log de depuração e eventos
associados. Depure antes de publicar seu FlexCard em uma página do Salesforce ou aplicativo de terceiros.
1. No FlexCard Designer, clique em Visualizar.

2. Clique na guia Depurador de Ações .
3. Clique na seta ao lado de uma fonte de dados para visualizar seu log.
4. Clique na seta ao lado de um rótulo de ação ou evento para visualizar seu log.
5. (Opcional) Para pesquisar um evento ou ação específica, insira uma palavra-chave no campo de entrada
Pesquisar.
6. (Opcional) Para copiar um log, como a configuração em Datasource ou o inputMap em uma ação Pubsub
Event, clique no ícone da área de transferência ao lado do nome da propriedade.
7. (Opcional) Para limpar todos os logs, clique em Clear Logs .
Veja também
• Depurador de ações do FlexCard Designer
• Visualizar o JSON de dados de um FlexCard
Visualizar um FlexCard em diferentes pontos de interrupção da

viewport
Ajuste o tamanho da tela do seu FlexCard para testar a capacidade de resposta. Use o menu suspenso
Viewport no FlexCard Designer para imitar os tamanhos de um desktop, laptop e dispositivos móveis menores.
O tamanho da janela de visualização é salvo quando alterado. Depois de sair do FlexCard Designer, alternar
entre a visualização Design e a Visualização ou recarregar a página, o tamanho da janela de visualização
permanece o mesmo até que você o altere.
1. Na guia FlexCards, clique em uma versão de um FlexCard para abrir o FlexCard Designer.
2. Para testar a capacidade de resposta no modo Design, selecione um ponto de interrupção no menu
suspenso Viewport.

company
3. Para testar a capacidade de resposta na Visualização, clique na guia Visualização e selecione um ponto de
interrupção no menu suspenso Viewport.
Qual é o próximo
Ative os elementos para responder a diferentes larguras de janela de visualização. Consulte Criar elementos
responsivos em um FlexCard .
Veja também
Ativar um FlexCard
Ative um FlexCard para gerar um LWC e publique-o em uma página do Lightning ou da Comunidade. Ativar um
FlexCard desativa os recursos de edição. Você não pode adicionar ou editar elementos em um FlexCard ativo.
Antes do seu começo
Visualize a aparência do seu FlexCard e teste a funcionalidade antes de ativá-lo. Consulte Visualizar um FlexCard .
Ativar a partir do FlexCard Designer

2. Clique em Ativar no submenu para iniciar o assistente de ativação.
3. Clique em Concluído .
company
Ativar a partir do FlexCards Home
1. Na guia inicial do FlexCards em sua organização, clique em um FlexCard para ver as versões disponíveis.
2. Marque a caixa de seleção ao lado do FlexCard inativo que você deseja ativar.
Qual é o próximo
Configure as opções de publicação para definir valores de metadados e adicionar um ícone SVG de
componente personalizado para seu LWC gerado. Consulte Configurar opções de publicação em um FlexCard .
Veja também
Configurar opções de publicação em um FlexCard

Defina os valores de metadados e atualize o ícone SVG do componente para seu FlexCard LWC gerado antes de
publicar seu componente em uma página Lighting ou Community. Por exemplo, para visualizar seu FlexCard
em uma página da comunidade, você pode habilitar a página da comunidade em Destinos em Opções de
publicação. Consulte Adicionar um FlexCard a uma página da comunidade .
• Você deve ativar seu FlexCard para configurar as opções de publicação. Consulte Ativar um FlexCard .
2. No submenu do FlexCard Designer, clique na seta para baixo ao lado de Ativar e clique em Opções de
publicação .
3. Para configurar valores de metadados, consulte Definir valores de metadados do FlexCard Designer .
4. Para atualizar o recurso SVG com um ícone personalizado, consulte Adicionar um ícone SVG de
componente personalizado a um FlexCard .
Qual é o próximo
Publique seu FlexCard em uma página do Lightning ou da Comunidade. Consulte Adicionar um FlexCard a uma
página do Lightning . Consulte Adicionar um FlexCard a uma página da comunidade .
Propriedades das opções de publicação de FlexCards
As propriedades das opções de publicação do FlexCard são configuráveis após a ativação de um FlexCard.
Defina valores de metadados e atualize o ícone SVG para seu FlexCard LWC gerado no FlexCard Designer.
Consulte Configurar opções de publicação em um FlexCard .
Etiqueta principal Atualize o nome visível do LWC gerado como você deseja que ele apareça no Lightning App Tags do arquivo de
Builder e no Community Builder. O padrão é o Nome que você usou para criar o FlexCard e, configuração
que é visível no painel Configuração.
Descrição Insira uma descrição para o LWC gerado. Tags do arquivo de

configuração
Versão da API Define a versão da API do seu LWC gerado. O padrão é a versão da API usada ao criar o FlexCard. Tags do arquivo de
Ao criar um novo FlexCard, o valor padrão é a versão atual da API. configuração

company
Tempo de execução (Somente leitura) Define o namespace do pacote Vlocity. Tags do arquivo de
Namespace configuração
Está exposto Quando ativado, seu componente de cartão é público. Por padrão, esse recurso está ativado. Tags do arquivo de
configuração
Alvos Selecione onde seu LWC gerado é acessível. Por padrão, a página inicial, Tags do arquivo de
RecordPage e AppPage são selecionados para permitir o uso em uma página inicial configuração
personalizada, uma página de registro e uma página inicial de aplicativo.
Para habilitar o uso de seu LWC em uma Community Page, selecione CommunityPage. Para
ativar o uso de seu LWC gerado em uma página da comunidade com propriedades
configuráveis, selecione CommunityDefault.
editor Configure manualmente os valores de metadados. Por exemplo, adicione propriedades a um Tags do arquivo de
Destino. configuração
Adicionar SVG Adicione um recurso SVG como um ícone personalizado para seu LWC gerado para Adicionar um
Recurso identificá-lo facilmente nas páginas do Experience Builder para Comunidades e do Lightning personalizado
App Builder para Lightning. Ícone SVG de
componente para um
FlexCard
Veja também
Definir valores de metadados do FlexCard Designer

Defina os valores de metadados para o FlexCard LWC gerado. Com o recurso Publish Options no FlexCard
Designer, configure os valores de metadados para seu LWC gerado a partir de uma GUI ou editor de código.
Consulte Tags do arquivo de configuração .
• Você deve ativar seu FlexCard para visualizar o recurso Opções de publicação. Consulte Ativar um FlexCard .
publicação .
3. Insira ou atualize valores para estas propriedades:
Etiqueta principal Atualize o nome visível do LWC gerado como você deseja que ele apareça no Lightning App Builder e no Community
Builder. O padrão é o Nome que você usou para criar o FlexCard e, que é visível no painel Configuração.
Descrição Insira uma descrição para o LWC gerado.
Versão da API Define a versão da API do seu LWC gerado. O padrão é a versão da API usada ao criar o FlexCard. Ao criar um novo
FlexCard, o valor padrão é a versão atual da API.
Tempo de execução (Somente leitura) Define o namespace do pacote Vlocity.

Namespace
Está exposto Quando ativado, seu componente de cartão é público. Por padrão, esse recurso está ativado.
Alvos Selecione onde seu LWC gerado é acessível. Por padrão, HomePage, RecordPage e AppPage são selecionados para
permitir o uso em uma página inicial personalizada, uma página de registro e uma página inicial de aplicativo.
Para habilitar o uso de seu LWC em uma Community Page, selecione CommunityPage. Para ativar o uso de seu LWC
gerado em uma página da comunidade com propriedades configuráveis , selecione CommunityDefault.
Adicionar propriedades a um destino

Editor de opções de publicação .

company
Qual é o próximo
Adicione um ícone SVG de componente personalizado ao seu FlexCard LWC gerado. Consulte Adicionar um
ícone SVG de componente personalizado a um FlexCard .
Veja também
Adicionar um ícone SVG de componente personalizado a um FlexCard

Adicione um recurso SVG como o ícone personalizado para seu LWC gerado para identificá-lo facilmente nas
páginas do Criador de experiências para comunidades e do Criador de aplicativos Lightning para Lightning. Use
o recurso Opções de publicação em um FlexCard ativado para atualizar o ícone padrão com um recurso SVG
personalizado.
• Você deve ativar seu FlexCard para visualizar o recurso Opções de publicação. Consulte Ativar um FlexCard .
publicação .
3. Para carregar um recurso SVG personalizado, em Adicionar recurso SVG / Solte-o aqui , clique em
Escolher arquivo ou arraste um arquivo do seu computador para dentro da caixa tracejada.

company
Qual é o próximo
Configure os valores de metadados para seu FlexCard LWC gerado. Consulte Definir valores de metadados do
FlexCard Designer .
Veja também
Adicionar etiquetas personalizadas aos campos suportados em um

FlexCard
Adicione rótulos personalizados aos campos de elemento FlexCard suportados. Por exemplo, adicione
etiquetas personalizadas se o seu FlexCard suportar vários idiomas. Rótulos personalizados são valores de
texto personalizados que podem ser acessados de classes do Apex, páginas do Visualforce ou componentes do
Lightning. Os valores podem ser traduzidos para qualquer idioma compatível com o Salesforce. Consulte
Etiquetas personalizadas .
Os FlexCards são compatíveis com o campo de mesclagem {Label} nos seguintes elementos:
Element Supported Fields
Field Label, Placeholder
Text Inside the Rich Text Editor
Elemento Campos suportados
Etiqueta de aç ão
1. Visualize os campos do elemento FlexCard que suportam rótulos personalizados. Veja ??? .
2. Confirme os rótulos personalizados disponíveis em sua organização em Configuração > Rótulos personalizados. Consulte Etiquetas
personalizadas .
2. Selecione um elemento suportado , como o elemento Field.
3. No painel Propriedades, insira {Label.customLabelName} em um campo suportado. Por exemplo, para
exibir o rótulo personalizado AccountName como o rótulo de um elemento Field que exibe o nome de
uma conta, insira {Label.AccountName} .
Qual é o próximo
Ative o suporte a vários idiomas. Consulte Ativar suporte a vários idiomas em um FlexCard .

company
Passar dados de um LWC OmniScript para um FlexCard incorporado
Para preencher campos de dados e executar ações em um FlexCard incorporado em um LWC OmniScript, você
pode passar dados de um JSON de dados de um OmniScript para o FlexCard. Incorpore um FlexCard em um
LWC OmniScript com o elemento Custom Lighting Web Component. Consulte Incorporar FlexCards em um
OmniScript .
Existem três maneiras de passar dados do LWC OmniScript para o FlexCard incorporado:
Opções Descrição Referência
Passar um conjunto Use os registros variável de contexto global para mapear dados do LWC Mapear dados de um LWC OmniScript
de registros OmniScript para um FlexCard incorporado. para um FlexCard incorporado
Passe o recordId Passe o recordId variável de contexto global do LWC OmniScript para o Passe o RecordId de um
FlexCard. OmniScript para executar uma consulta
em um
FlexCard
Passar um objeto pai Passe um objeto Pai contendo atributos pai para o FlexCard do LWC Passar um objeto pai de um LWC
OmniScript. O OmniScript é o pai do FlexCard incorporado. O Pai variável OmniScript para executar uma consulta
de contexto global , como {Parent.Id} , deve ser usada no FlexCard onde o em um
campo de mesclagem é suportado. FlexCard
Baixe um DataPack de Amostra

Faça download de um DataPack de amostra que demonstra como passar um recordId, um objeto Parent e um
conjunto de registros do LWC OmniScript para um FlexCard incorporado. Consulte Baixar um DataPack de
Amostra que Passa Dados de um LWC OmniScript para um FlexCard .
Mapear dados de um LWC OmniScript para um FlexCard incorporado

Depois de incorporar um FlexCard dentro de um LWC OmniScript, mapeie os registros do OmniScript para os
campos de dados no FlexCard. Por exemplo, preencha uma lista de FlexCards de uma matriz em um
OmniScript. Nesse cenário, o FlexCard usa dados do OmniScript em vez de sua própria fonte de dados.
Os campos de dados no LWC OmniScript devem existir no FlexCard mesmo se os valores estiverem vazios. Por
exemplo, se o JSON de dados do OmniScript tiver os campos Id, Name, Email e Phone, esses nomes de campo
devem existir mesmo se o valor de Email ou qualquer outro campo estiver vazio na fonte de dados do FlexCard
incorporado.
1. Em sua organização, vá para a guia FlexCards e clique em uma versão de um FlexCard para abrir o
FlexCard Designer. Ou crie um novo FlexCard. Consulte Criar um novo FlexCard .
2. No painel Configuração, selecione e configure a fonte de dados com os campos de dados que você deseja
que o OmniScript mapeie.
Por exemplo, se sua fonte de dados for um DataRaptor que obtém uma lista de contas, confirme se os
campos de saída do DataRaptor selecionados incluem aqueles para os quais seus dados JSON do
OmniScript são mapeados. Se o JSON de dados do OmniScript tiver um campo Nome, a Saída do
DataRaptor também deve ter e assim por diante.
3. Clique em Salvar e buscar .
4. No painel Build, adicione elementos como Fields, Datatables e assim por diante na tela. Consulte
Adicionar elementos a um FlexCard .
5. No painel Configuração, verifique Suporte OmniScript .
7. Incorpore seu FlexCard em um LWC OmniScript com o elemento Custom LWC no LWC OmniScript
Designer. Consulte Incorporar FlexCards em um OmniScript .

company
8. Na seção Propriedades do componente Web personalizado do Lightning do painel Propriedades,
adicione dados parentais como o Nome da propriedade e defina o valor Origem da propriedade como
true .
9. Clique em + Adicionar nova propriedade .
10. Insira registros como o Nome da propriedade e, no campo Origem da propriedade , insira o objeto no
JSON de dados que lista os registros que são mapeados para aqueles em seu FlexCard. Insira o objeto
como um campo de mesclagem usando a sintaxe de campo de mesclagem do OmniScript, como
%objectname% .
Por exemplo, se sua lista de registros estiver armazenada em um objeto JSON chamado accounts , insira
%accounts% .
12. Clique em Visualizar para visualizar o FlexCard dentro do LWC OmniScript.
Veja também
Passe o RecordId de um OmniScript para executar uma consulta em um FlexCard

Passe a variável de contexto recordId de um LWC OmniScript para um FlexCard incorporado para executar
uma consulta no FlexCard. A consulta retorna os dados que preenchem os campos de dados e ações do
FlexCard.
Por exemplo, se o seu FlexCard possui um DataRaptor que obtém casos de conta, os campos e ações são
atualizados com base no valor do recordId definido no JSON de dados do LWC OmniScript. Se você usar o
campo de mesclagem {recordId} em seu FlexCard, como em uma consulta SOQL ou um elemento de texto, os
dados que dependem desse campo de mesclagem também serão atualizados com base no recordId
proveniente do JSON de dados do LWC OmniScript.
2. Configure sua fonte de dados, caso ainda não tenha feito isso. Consulte Configurar uma fonte de dados
em um FlexCard .
3. Adicione elementos de dados, como Campos, Ações e assim por diante, do painel Construir na tela.
Consulte Adicionar elementos a um FlexCard .
adicione recordid como o Nome da propriedade .
NOTA
Como o Nome da Propriedade é um atributo HTML, ele deve ser escrito em maiúsculas e
minúsculas, com palavras separadas por um traço. Consulte Nomes de Propriedades e
Atributos .
8. Defina a Origem da propriedade como um nó JSON que contém um recordId. Use a sintaxe do campo de
mesclagem OmniScript, como %nodename% , para inserir o nó como um campo de mesclagem.
Por exemplo, se seu recordId estiver armazenado em um nó JSON chamado ContextId, insira
%ContextId% .

company
10. Clique em Visualizar para visualizar o FlexCard dentro do OmniScript.
Veja também
Passar um objeto pai de um LWC OmniScript para executar uma consulta em um

FlexCard
Passe um objeto Pai do LWC OmniScript para o FlexCard. O LWC OmniScript é o pai do FlexCard incorporado. A
variável de contexto Parent deve ser usada no FlexCard onde os campos de mesclagem são suportados, como
{Parent.Id} . Consulte Variáveis de contexto FlexCards .
O objeto pai no JSON de dados do OmniScript pode ter qualquer nome , desde que seja um objeto com campos
que correspondam ao nome do atributo pai que você deseja que o OmniScript procure no FlexCard. Por
exemplo, o nome do objeto JSON pode ser pai ou conta , como "parent" : {"Id" : "1234567"} ou "account" :
{"Id" : "1234567"} .
2. Configure sua fonte de dados se ainda não o fez na Etapa 1. Consulte Configurar uma fonte de dados em
um FlexCard .
3. Adicione elementos de dados, como Campos, Tabelas de dados e assim por diante, do painel Construir
para a Tela. Consulte Adicionar elementos a um FlexCard .
4. Adicione um campo de mesclagem {Parent} , como {Parent.Id} , em seu FlexCard onde os campos de
mesclagem são suportados, como em uma consulta SOQL, um elemento de texto, um parâmetro de
entrada e assim por diante.
adicione parentattribute como o Nome da propriedade e defina a Origem da propriedade para o objeto
JSON pai que contém os atributos pai. Use a sintaxe do campo de mesclagem OmniScript, como
%objectname% , para inserir o nó como um campo de mesclagem.
Por exemplo, se seu objeto pai estiver armazenado em um objeto JSON chamado account, insira
%account% .
10. Clique em Visualizar para visualizar o FlexCard dentro do OmniScript.
Veja também
Baixe um DataPack de Amostra que Passa Dados de um LWC OmniScript para um

FlexCard
Baixe um DataPack de amostra que demonstra como passar dados de um LWC OmniScript para um FlexCard.
Importe o DataPack para sua organização. Consulte Passar dados de um LWC OmniScript para um
FlexCard incorporado .
company
O DataPack de exemplo demonstra como passar um recordId, um objeto Parent e um conjunto de registros do
LWC OmniScript para os FlexCards incorporados. Após configurar e ativar os FlexCards e o OmniScript, visualize
o OmniScript para ver como quatro FlexCards diferentes (incorporados como LWCs personalizados) passam
dados para o OmniScript.

• Um FlexCard demoPassDataParentAttributeFC exibe dados da conta, cuja fonte de dados SOQL Query usa o
campo de mesclagem {Parent.Id} para determinar o contextId.
• Um FlexCard demoPassDataRecordIdFC exibe dados da conta, cuja fonte de dados SOQL Query usa o campo
de mesclagem {recordId} para determinar o contextId.
• Um FlexCard demoPassDataRecordIdDRFC exibe dados do caso de conta, cuja fonte de dados DataRaptor
usa o campo de mesclagem {recordId} para determinar o contextId.
• Um FlexCard demoPassDataParentDataRecordsFC exibe uma lista de contas como uma tabela de dados. A
fonte de dados é uma consulta SOQL básica.
• Um OmniScript LWC demoPassDataLWCOStoFC com os seguintes recursos:
• Uma Ação Definir Valores com três valores de elemento: um que define um ContextId; um que define um
objeto Parent; e um que exibe uma lista de registros.
• Um Step com 4 elementos LWC personalizados que exibem 4 FlexCards.
• Um getCases DataRaptor obtém uma lista de casos de conta.
Baixe e importe o DataPack

1. Baixe o OmniStudio for Vlocity DataPack aqui: demoPassDataLWCOStoFC.zip .
NOTA
uma organização com um pacote Vlocity Health and Insurance , Communication, Media and
Energy ou Public Sector instalado.
objetos OmniStudio for Vlocity.
Baixe o OmniStudio DataPack aqui: demoPassDataLWCOStoFC-OmniStudio.json .
NOTA
Interaction Platform) para uma organização com o pacote OmniStudio, os objetos serão
convertidos em objetos OmniStudio.
2. Importe o DataPack. Consulte Importar um FlexCard .

company
IMPORTANTE
Não ative ainda.
3. Abra o FlexCard demoPassDataParentAttributeFC, clique em Setup e atualize o Parent.Id em Test

Parameters com o ID de um registro de conta em sua organização.
4. Abra os FlexCards demoPassDataRecordIdDRFC e demoPassDataRecordIdFC , clique em Setup e atualize
o recordId em Test Parameters com o ID de um registro de conta em sua organização.
5. Abra o OmniScript demoPassDataLWCOStoFC, clique em SetValues1 , clique em Properties e clique em
Edit Properties as JSON . Substitua os valores de ContextId e parentObj:Id por registros de IDs de conta
em sua organização.
6. Ative todos os quatro FlexCards.
7. Para visualizar os FlexCards no LWC OmniScript, ative o LWC OmniScript e clique em Visualizar.
Veja também
• Propriedades da ação FlexCards
Recarregue um FlexCard após atualizar um LWC OmniScript em um

flyout
Atualize as informações em um FlexCard após salvar as alterações em um LWC OmniScript incorporado em um
submenu. Adicione uma ação de Flyout em um FlexCard que acione um evento e crie um ouvinte de evento no
cartão para atualizar. Quando o cartão que você deseja atualizar "ouve" o evento, ele executa uma ação de
recarregamento do cartão.
1. Crie um LWC OmniScript, para incorporar em seu flyout FlexCard. Consulte Criar um OmniScript .
2. Adicione uma Navigation Action e selecione Pub/Sub na seção Messaging Framework do painel Properties.
1. Vá para a guia inicial do FlexCards em sua organização e abra um FlexCard no FlexCard Designer. Ou para
criar um novo, consulte Criar um novo FlexCard .
2. Para incorporar o LWC OmniScript em um submenu, arraste um elemento Action do painel Build para a
tela.
3. Selecione Flyout como o Tipo de ação .
4. Clique em + Adicionar novo ao lado de Atributos e insira os valores para essas configurações da seguinte
maneira:
• Chave : vlocEvents
• Valor: Insira o nome do canal pubusb. Este é normalmente o FlexCard que você deseja atualizar. Por
exemplo, se o nome do FlexCard a ser atualizado for AccountPolicy , insira-o aqui.
5. Se o FlexCard que você deseja atualizar for diferente deste FlexCard, abra esse FlexCard na guia inicial do
FlexCards.
6. No painel Configuração, clique em + Adicionar novo ao lado de Ouvinte de evento e insira os valores
para as configurações da seguinte maneira:
• Tipo de evento : Pubsub
• Nome do canal : insira o mesmo atributo vlocEvents inserido na etapa 5. Por exemplo, se o valor de
vlocEvents for AccountPolicy , insira-o aqui.

company
• Nome do evento : dados
• Tipo de ação : cartão
• Tipo : Recarregar
Adicionar um FlexCard a uma página do Lightning

Depois de criar e ativar seu FlexCard, publique seu componente gerado em uma página do Lightning com o
Lightning App Builder. Consulte Criador de aplicativo Lightning .
1. Em sua organização, vá para Configuração > Criador de aplicativo Lightning e clique em Editar para um
aplicativo Lightning existente para abrir o Criador de aplicativo Lightning. Ou, em uma página de registro
do Lightning, no menu Configuração, clique em Editar página .
2. No painel Componentes, localize seu componente Web FlexCard Lightning gerado na lista de
componentes personalizados e arraste-o para a área da tela.
IMPORTANTE
Se você não vir seu componente listado, confirme se o destino apropriado está marcado em
Opções de publicação. Consulte Definir valores de metadados do FlexCard Designer
3. (Opcional) No painel de propriedades, defina Component Visibility . Consulte Páginas dinâmicas do

Lightning .
4. Para configurar as opções de ativação, clique em Ativação . Consulte Ativar sua página do aplicativo
Lightning .
Adicionar um FlexCard a uma página da comunidade

Adicione seu FlexCard a uma página da comunidade. Depois de ativar seu FlexCard, publique o FlexCard LWC
gerado no Experience Builder.
Consulte Visão geral do Criador de experiências .

Ative seu FlexCard. Consulte Ativar um FlexCard .
1. Para acessar o Experience Builder, consulte Navigate Experience Builder .

2. Clique no ícone de raio azul e branco à esquerda para abrir o painel Componentes.
3. Na lista de componentes personalizados no painel Componentes, localize o nome do seu FlexCard LWC
gerado e arraste-o para a área da tela.
IMPORTANTE
Se você não vir seu FlexCard, confirme se ele está ativo e disponível nas páginas da
Comunidade. Consulte Definir valores de metadados do FlexCard Designer .
4. (Opcional) No painel de propriedades, defina Component Visibility . Consulte Páginas dinâmicas do

Lightning .
5. Clique em Visualizar . Consulte Visualizar seu site do Experience Builder .
6. Clique em Publicar .
Execute FlexCards fora do Salesforce com OmniOut

Execute FlexCards fora da plataforma em sites de terceiros com OmniOut para FlexCards. Exiba
FlexCards e conecte-se ao Salesforce a partir de um site externo de um sistema de gerenciamento de
company
conteúdo (CMS). Execute um FlexCard em seu site externo adicionando o componente ao projeto OmniOut,
integrando OmniOut em seu aplicativo e implantando seu aplicativo em seu CMS.
Consulte OmniOut .
Acesse o ContextId de um FlexCard em uma página da comunidade

Em uma página da comunidade , para visualizar dados de registro em um FlexCard que usa a variável de
contexto {recordId} em um mapa de entrada para passar um ContextId para uma fonte de dados do Apex
Remote, DataRaptor ou Procedimento de Integração, você deve adicionar e configurar uma propriedade
recordId. Adicione a propriedade recordId no arquivo de configuração do seu FlexCard e configure a
propriedade na página Comunidade.
1. A partir de um FlexCard ativo no FlexCard Designer, clique na seta para baixo ao lado de Ativar no
submenu e clique em Opções de publicação .
2. Em Destinos , marque a caixa de seleção CommunityDefault .
3. Clique na guia Editor .
4. Dentro da tag targetConfig , adicione uma tag de propriedade com o nome recordId e o tipo Cadeia de
caracteres .
<targetConfig targets="lightningCommunity__Default">
<property name="recordId" type="String" ></property>
</targetConfig>
5. Adicione seu FlexCard à sua página da Comunidade. Consulte Adicionar um FlexCard a uma página da
comunidade .
6. No campo de propriedade recordId , insira {!recordId} .

company
Configurar perfis da comunidade para FlexCards
Certifique-se de que seus usuários vejam os FlexCards nas páginas da Comunidade definindo as configurações
do perfil do usuário. Ative a interface apropriada primeiro. Em seguida, configure as permissões de objeto
personalizado e o acesso à classe do Apex.
1. Certifique-se de estar usando a Interface de perfil original desativando a Interface de usuário de perfil
aprimorada. Consulte Desativar a interface de usuário de perfil aprimorado .
2. Conclua as seguintes tarefas em qualquer ordem:
• Conceda acesso aos objetos personalizados necessários. Consulte Configurar permissões de objetos
personalizados para perfis da comunidade .
• Conceda acesso às classes Apex necessárias. Consulte Conceder acesso de classe do Apex a um perfil
da comunidade .
Desativar interface de usuário de perfil aprimorado
Habilite a interface apropriada antes de definir as configurações do perfil da comunidade que garantem que
seus usuários vejam os FlexCards nas páginas da comunidade. Use a Interface de Perfil Original.
Consulte Configurar perfis da comunidade para FlexCards .
1. Em Configuração, digite Usuário na caixa Busca rápida e clique em Configurações de gerenciamento de

usuários .
2. Defina a opção Interface de usuário de perfil avançado como Desativado .
Qual é o próximo
• Configurar permissões de objetos personalizados para perfis da comunidade
• Conceder acesso de classe do Apex a um perfil da comunidade
Configure a permissão de objeto personalizado para garantir que seus usuários vejam os FlexCards nas páginas
da comunidade. Dê acesso aos objetos necessários.

• Certifique-se de estar usando a Interface de perfil original. Consulte Desativar a interface de usuário de perfil aprimorado .
1. Em Configuração, digite Usuários na caixa Busca rápida e clique em Perfis .

2. Encontre o perfil dos usuários que acessarão o site da Comunidade e clique em Editar .
3. Role até a seção Permissões de objetos personalizados.
4. Marque Exibir tudo para os seguintes objetos:
• OmniUiCard
NOTA
Você não pode alterar as permissões de objeto personalizado para nenhum dos perfis padrão.
Para esses perfis, as caixas de seleção nesta seção não são selecionáveis.
Qual é o próximo
Se ainda não o fez, conceda acesso de classe do Apex a um perfil da comunidade .

company
Conceder acesso de classe do Apex a um perfil da comunidade
Configure o acesso à classe do Apex para garantir que seus usuários vejam os FlexCards nas páginas da
comunidade. Dê acesso às classes Apex necessárias.

• Certifique-se de estar usando a Interface de perfil original. Consulte Desativar a interface de usuário de perfil aprimorado .
1. Em Configuração, digite Usuários na caixa Busca rápida e clique em Perfis .

2. Encontre o perfil dos usuários que acessarão o site da Comunidade e clique no nome do perfil.
Se você clicar em Editar , não verá as configurações de Acesso de classe do Apex ativado.
3. Role até a seção Acesso de classe do Apex ativado e clique em Editar .
4. Se o namespace .CardCanvasController não estiver na lista Classes do Apex habilitadas, selecione-o na
lista de Classes do Apex disponíveis e clique em Adicionar .
Para namespace , consulte Visualizando o namespace e a versão do pacote OmniStudio Vlocity .
Qual é o próximo
Se você ainda não o fez, Configure Custom Object Permissions for Community Profiles .
Versionamento e clonagem de FlexCards

FlexCards suporta versionamento e clonagem. Você pode criar uma cópia idêntica de um FlexCard com base
em como deseja usar a nova versão.
Propósito Versão ou clone?
Para atualizar um FlexCard já publicado nas páginas Lighting ou Community e em outros lugares. Versão
Para fazer pequenas modificações em um FlexCard existente para testar o comportamento e o layout. Versão
Para criar um novo FlexCard, mas copiar sobre layout, configurações ou ambos. Clone

company
Versionamento vs Clonagem
Versionamento de FlexCards
FlexCards suporta versionamento. Você pode criar uma cópia idêntica de um FlexCard criando uma nova
versão e mantendo outras versões com o mesmo nome e autor, mas com um novo número de versão. Crie
uma nova versão quando quiser fazer pequenas modificações em um FlexCard já publicado nas páginas
Lighting ou Community e em outros lugares.
A combinação de nome, autor e versão deve ser exclusiva para cada componente em uma organização.
Apenas uma versão de um componente pode estar ativa por vez. Quando você cria uma nova versão de um
FlexCard no FlexCard Designer, o número da versão aumenta em 1 e o Status fica inativo. Consulte Criar uma
nova versão de um FlexCard .
Fluxo de trabalho de controle de versão
Quando você cria uma nova versão de um FlexCard no FlexCard Designer, uma nova versão é criada
dinamicamente. Você não pode escolher o autor ou o nome da nova versão. Para criar um novo

company
FlexCard baseado em um FlexCard atual e atualizar o Autor e/ou Nome, você deve clonar seu FlexCard.
Consulte Clonar um FlexCard .
A tabela a seguir descreve os campos envolvidos no processo de versão:

Campo Descrição
Nome Os FlexCards são solicitados pelo nome.
Autor Especifica a organização do usuário que criou o FlexCard. Use nomes de autores que descrevam a equipe que cria o conteúdo.
Versão Um número inteiro que aumenta em um a cada nova versão.
Ativo Indica se um registro está ativo para uso em tempo de execução. Um registro ativo por nome é permitido em uma organização. A
ativação de um componente desativa todas as outras versões do componente com o mesmo nome. Somente registros ativos são
exportados quando um DataPack é criado.
Veja também
• Versionamento e clonagem de FlexCards
• Clonagem de FlexCards
• Convenções de Nomenclatura FlexCard
Criar uma nova versão de um FlexCard

Crie uma nova versão de um FlexCard no FlexCard Designer quando quiser fazer pequenas modificações em
um atual. A criação de uma versão de um FlexCard faz uma cópia exata com um número de versão igual ao
número da versão mais recente mais um. Por exemplo, se você já tiver duas versões, o número da nova versão
será 3.
NOTA
Para criar uma cópia de um FlexCard com um novo Nome, Autor ou ambos, você deve clonar o
FlexCard. Consulte Clonar um FlexCard .
2. Clique em Nova Versão no submenu.
3. A nova versão do seu FlexCard é aberta em uma nova guia e a Versão Atual é atualizada para o número
da versão anterior mais um.
Esquerda: FlexCard original. Direita: Nova versão do FlexCard.
Veja também
• Versionamento de FlexCards
Clonagem de FlexCards
FlexCards suporta clonagem. Você pode criar um novo FlexCard clonando um atual para atualizar o
Autor e/ou Nome e copiar o layout e/ou configurações. Consulte Clonar um FlexCard .
company
A combinação de nome, autor e versão deve ser exclusiva para cada componente em uma organização.
Fluxo de trabalho de clonagem
Se você precisar criar uma nova versão de um FlexCard com o mesmo Nome e Autor e quiser fazer pequenas
modificações para testar o comportamento e o layout entre as versões, faça a versão do FlexCard. Consulte
Criar uma nova versão de um FlexCard .
Veja também
• Versionamento e clonagem de FlexCards
• Versionamento de FlexCards
• Convenções de Nomenclatura FlexCard
Clonar um FlexCard
Crie uma cópia idêntica de um FlexCard com o recurso Clone no FlexCard Designer. A clonagem de um
FlexCard existente cria um novo FlexCard com um novo Nome, Autor ou ambos. O Nome e o Autor devem ser
únicos. Consulte Clonagem de FlexCards .

company
NOTA
Para criar uma nova versão de um FlexCard com o mesmo nome e autor, fazer pequenas
modificações e comparar as versões, consulte Criar uma nova versão de um FlexCard .
2. Clique em Clonar no submenu.
3. Se você não estiver alterando o autor, insira um novo Nome . Ou o Nome, ou Autor, ou ambos devem ser
alterados.
4. Se você não estiver alterando o nome, insira um novo autor . Ou o Nome, ou Autor, ou ambos devem ser
alterados.
5. (Opcional) Atualize as seguintes propriedades:
• Atualize o tema para Lightning (SLDS) ou Newport.
• Atualize o título do componente renderizado visível nas listas de componentes no Lightning App
Builder e no Community Builder.
• Se desabilitado, habilite o Cartão Filho para incorporá-lo em outro FlexCard.
• Atualize a Descrição exibida na guia FlexCards.
6. Clique em Clonar .
Veja também
• Propriedades do clone FlexCards
Propriedades do clone de FlexCards

Esta página lista as propriedades do Cartão Clone FlexCards disponíveis ao clonar um FlexCard no FlexCard
Designer.
Crie uma cópia idêntica de um FlexCard com o recurso Clone no FlexCard Designer. Consulte Clonar um
FlexCard .
Nome do cartão Digite o nome do seu FlexCard. Nomeação do FlexCard

Convenções
Título do cartão Insira um título para o seu FlexCard. O título é usado para encontrar seu FlexCard gerado n/D
LWC após a ativação no Lightning App Builder e no Community Builder
Tema Selecione um tema para determinar o design padrão do seu FlexCard. n/D
Autor do cartão Insira o autor do FlexCard, como o nome de um departamento em sua organização. n/D
Cartão filho Habilite para incorporar este FlexCard dentro de outro FlexCard. Incorporar um FlexCard infantil
Dentro de um FlexCard
Descrição Insira uma descrição do seu FlexCard. n/D
Convenções de Nomenclatura FlexCard

Siga os requisitos ao nomear FlexCards e elementos FlexCard para evitar erros ao trabalhar com o FlexCard
Designer e importar FlexCards como pacotes de dados. Por exemplo, você pode ter problemas ao importar um
FlexCard com o mesmo nome de um que já existe em sua organização.
Requisitos de nomenclatura do FlexCard

company
Requisitos Exemplos
A combinação do nome e do autor do cartão deve ser única em sua organização. Por exemplo, ao • Nome = AccountActive , Autor =
importar um FlexCard com o mesmo nome e autor de um FlexCard atual, você será perguntado se CustomerSales
deseja substituir o FlexCard atual em sua organização. • Nome = AccountClosed , Author =
CustomerSales
O nome e o autor devem conter apenas sublinhados e caracteres alfanuméricos. Deve ser único, Não aceitável:
começar com uma letra, não incluir espaços, não terminar com sublinhado e não conter dois
sublinhados consecutivos. • conta$cartão!
• 2conta__cartão
• $$conta__cartão_
• cartão de conta
Se você tiver várias versões de um FlexCard, apenas uma versão pode estar ativa por vez. Consulte N/D
Controle de versão de FlexCards .
Os nomes de FlexCard não podem ser alterados. Você deve clonar um FlexCard para alterar o nome. N/D
Consulte Clonar um FlexCard .
Requisitos do nome do elemento FlexCard

Requerimento Exemplos
• Os nomes dos elementos não podem conter espaços e devem ser Aceitável:
exclusivos em um FlexCard. Ele pode conter qualquer combinação
de caracteres alfanuméricos e especiais. • bloco_endereço
• View_Account
• $account_revenue!
Não aceitável:
• bloco de
endereço
• Visualizar
Conta
• $ receita da
conta!
Veja também
• Versionamento e Clonagem de FlexCards
Excluir um FlexCard
Exclua um FlexCard da guia inicial do FlexCards em sua organização. Uma vez excluído, não pode ser
recuperado.
• Desative o FlexCard que deseja excluir clicando no link Desativar no submenu do FlexCard Designer ou na guia inicial do FlexCards.
1. Na guia inicial do FlexCards, clique em um FlexCard para exibir as versões disponíveis.

2. Clique na caixa de seleção ao lado da versão a ser excluída.

company
NOTE
You can delete an inactive version of a FlexCard added to a Lightning or Community
page if there is more than one version.
3. Click the trash icon.
NOTA
Se o ícone da lixeira estiver desabilitado, verifique se o FlexCard está desabilitado.
Importar um FlexCard
Importe um FlexCard como um DataPack de outro ambiente para sua organização.
NOTA
objetos OmniStudio for Vlocity (anteriormente Digital Interaction Platform). No entanto, se você
importar DataPacks com objetos OmniStudio for Vlocity para uma organização com o pacote
OmniStudio, os objetos serão convertidos em objetos OmniStudio.

Exporte um FlexCard .
1. Na guia inicial do FlexCards, clique em Importar .

2. Clique em Carregar Arquivos e selecione um DataPack do seu computador para carregar. Ou arraste o
arquivo do computador para a seção Ou solte os arquivos .
4. Selecione os itens a serem importados.
6. Revise os itens a serem importados.
8. Para ativar itens do FlexCard importado:
a. Clique em Ativar agora .
b. Selecione os itens para ativar.
c. Clique em Avançar .
d. Clique em Concluído .
9. Para ativar os itens do FlexCard importado posteriormente, clique em Ativar mais tarde .
Veja também

company
• Migração de dados com OmniStudio DataPacks
Baixe os DataPacks de Amostra FlexCard

Baixe exemplos de FlexCard DataPacks com elementos e configurações FlexCard configurados para importar
para sua organização. Por exemplo, baixe um FlexCard DataPack que mostra como passar dados de um
FlexCard pai para um FlexCard filho.
NOTA
importar DataPacks com objetos OmniStudio for Vlocity para uma organização com o pacote
OmniStudio, os objetos serão convertidos em objetos OmniStudio.
Característica Descrição Referência

Passar dados de um Um LWC OmniScript que passa dados para FlexCards incorporados de três Baixe um DataPack de Amostra
LWC OmniScript para maneiras: passando um nó de objeto com um conjunto de dados; passando o que Passa Dados de um LWC
um Embedded recordId; e passando um objeto Parent. OmniScript para um
FlexCard FlexCard
Ação de evento Um FlexCard com um Event Listener que escuta um evento personalizado de Baixe uma amostra personalizada
personalizada seu filho FlexCard incorporado . A ação Custom Event do FlexCard filho atualiza Pacote de dados do evento
um valor de campo de dados no pai quando clicado.
Tabela de dados Um FlexCard que exibe um elemento Datatable agrupado, pesquisável e Baixe uma amostra
classificável. Datatable DataPack
Ouvinte de eventos Adicione um ouvinte de eventos que escute um evento e execute uma ação em Baixar um evento de amostra
resposta. Pacote de dados do ouvinte
Passar dados para uma Incorpore um FlexCard reutilizável como filho dentro do estado de um FlexCard Baixar um filho de amostra
criança pai e passe os dados do pai para o filho. Pacote de dados FlexCard
FlexCard
Ação do evento Pubsub Um FlexCard com três elementos de ação que acionam eventos que atualizam Baixe uma amostra do Pubsub
os valores dos campos de dados. Pacote de dados do evento
Característica Descrição Referência
Alternar elemento Um FlexCard exibindo todos os tipos de elementos Toggle, com Update Data Baixar uma alternância de
Source habilitado em dois elementos e um Set Values Card Action configurado amostra
em um elemento. Pacote de dados
Atualizar OmniScript Preencher um OmniScript quando um usuário clicar em uma ação Atualizar Baixe uma atualização de amostra
Ação OmniScript de um FlexCard incorporado ao OmniScript. Inclui o FlexCard e o Pacote de dados de ação
OmniScript. OmniScript
Veja também
• Migração de dados com OmniStudio DataPacks
Exportar um FlexCard
Exporte um FlexCard como DataPack para importar para outros ambientes. Você pode exportar um ou mais
FlexCards da guia inicial de FlexCards ou de dentro do FlexCard Designer.

company
NOTA
importar DataPacks com objetos OmniStudio for Vlocity para uma organização com o pac ote
OmniStudio , os objetos serão convertidos em objetos OmniStudio .
1. Para exportar da guia inicial do FlexCards :

a. Clique em um FlexCard e marque a caixa de seleção da versão a ser exportada.
b. Clique em Exportar .
2. Para exportar do FlexCard Designer:
a. Na guia inicial do FlexCards , clique em um FlexCard e clique em uma versão para abrir no FlexCard
Designer.
b. Clique na seta para baixo no submenu e selecione Exportar .
3. Selecione os itens a serem exportados.
5. Revise os itens a serem exportados.
7. ( Opcional ) Atualize o Nome .
8. ( Opcional ) Atualize o Descrição .
9. Para armazenar o DataPack e acessá-lo posteriormente a partir do Vlocity Na guia DataPacks , selecione
Adicionar à Biblioteca .
10. Para baixar o DataPack para o seu computador, deixe Download selecionado.
O que vem a seguir

Importe um FlexCard para outro ambiente. Consulte Importar um FlexCard .
Veja também
• Migração de dados com OmniStudio Pacotes de dados
Baixe um FlexCard LWC do FlexCard Designer

Baixe seu FlexCard LWC do FlexCard Designer. Baixe seu LWC para depurar e inspecionar problemas.
AVISO
Não reimplemente o LWC de volta em sua organização.
NOTA
Para fazer download de uma versão fora da plataforma do seu FlexCard LWC, consulte Fazer
download de um FlexCard LWC fora da plataforma do FlexCard Designer . A partir do verão de 21,
execute FlexCards offplatform em sites de terceiros com OmniOut for FlexCards . Ver OmniOut .
Antes de começar

company
• Você deve ativar seu FlexCard para baixar seu LWC.
2. do FlexCard Designer, clique na seta para baixo ao lado de Ativar e clique em Baixar LWC .
Veja Também
• Estender Vlocity Componentes da Web do Lightning
Baixe um FlexCard LWC fora da plataforma do FlexCard Designer

Baixe um FlexCard LWC fora da plataforma do FlexCard Designer. Baixe seu LWC para inspecionar código .
AVISO
Não reimplemente o LWC de volta em uma organização.
NOTA
A partir do verão de 2121, execute FlexCards fora da plataforma em sites de terceiros com
OmniOut para FlexCards . Ver OmniOut .
Antes de começar
• Você deve ativar seu FlexCard para baixar o LWC gerado.
2. do FlexCard Designer, clique na seta para baixo ao lado de Activate e clique em Download Off-Platform
LWC .
Veja Também
• Estender Vlocity Componentes da Web do Lightning
FlexCards Contexto Variáveis

Variáveis de contexto global e local estão disponíveis para um FlexCard para fornecer contexto a fontes de
dados, ações e outros componentes. Tudo variáveis diferenciam maiúsculas de minúsculas .
Variáveis Globais
Nome Descrição Mesclar campo
Etiqueta Rótulos personalizados do Salesforce. Consulte Adicionar etiquetas { Label.mylabel }

personalizadas aos campos suportados em um FlexCard .
Por exemplo, { Label.AccountName } obtém um rótulo
personalizado chamado AccountName .
Parâmetros Os parâmetros de página passados para o URL. { Params.fieldName }
Por exemplo, { Params.Id } obtém o ID de contexto.

Recomendamos usar { recordId } para obter o ContextId
de um registro.

company
Pai Atributos de referência do FlexCard pai no FlexCard filho com esta { Parent.attributeName }
variável. Os atributos são definidos em tempo de design no FlexCard pai
. Ver Incorporar uma criança FlexCard Dentro de um FlexCard . Por exemplo, Parent.Id obtém o atributo {Id} definido no
FlexCard pai .
ID do registro Obtém a ID de contexto do registro de dados de um objeto do { recordId }

Salesforce. Use os parâmetros de teste para verificar na visualização.
Ver Teste as configurações da fonte de dados em um FlexCard . Por exemplo, se estiver usando um DataRaptor para obter
uma lista de
Casos de Conta, no Mapa de Entrada , insira
AccountId como chave e { recordId } como o
Valor . Em seguida, adicione um parâmetro de teste cuja
chave seja recordId e valor seja 138238279r9ff para
preencher seu FlexCard com dados reais.
registros O objeto de registros do FlexCard , que pode ser passado para os {registros}
parâmetros Child FlexCard , Custom LWC e Flyout.
Por exemplo, {records} obtém todos os registros,
enquanto {records [0]} obtém o primeiro registro
disponível.
Sessão Variáveis usadas para armazenar valores de fontes de dados, sistemas { Session.sessionkey }
externos e valores codificados permanentemente. As propriedades
são definidas em tempo de design no FlexCard . Consulte Adicionar Por exemplo, { Session.pageLimit } obtém uma variável
variáveis de sessão a um FlexCard . de sessão chamada pageLimit .
Do utilizador Propriedades de usuário e contato para o usuário conectado. { User.property }
NOTA Por exemplo, { User.userName } obtém o nome de

A variável de contexto do usuário usuário do usuário conectado.
renderizado é visível apenas em tempo de
execução. Ver em Pré-visualização.
Propriedades disponíveis:
• userId : ID do Salesforce do usuário .

• userAnLocale : User's pessoal localidade .
• userSfLocale : organizações do Salesforce localidade .
• userCurrency : a moeda padrão do usuário .
• userLangudge : idioma padrão do usuário .
• userTimeZone : do usuário fuso horário .
• nome_do_usuário : do usuário nome de usuário .
• userType : do usuário licença tipo .
• userRole : Função do usuário .
• userProfileName : nome do perfil da pesquisa de perfil.
• userProfileId : ID do Salesforce da pesquisa de perfil.
• userAccountId : ID do Salesforce da pesquisa de conta.
• userContactId : ID do Salesforce da pesquisa de contato.
Variáveis locais
ação Os parâmetros recebidos por um ouvinte de eventos e enviados para { ação.parâmetro }

uma ação.
Por exemplo, se seu evento estiver enviando a você um
contextId parâmetro e, em seguida, use { action.contextId } .
elemento Os valores definidos pelo elemento de alternância e vinculados a uma { element.value } , { element.checked }
ação.
• Caixa de seleção Alternar tipo : element.checked

company
• Todos os outros tipos de alternância: element.value
registro O objeto de registro que pertence ao Estado e passado para os {record} , { record.FieldName }
parâmetros Child FlexCard , Custom LWC e Flyout.
Por exemplo, {record} obtém o registro inteiro, enquanto
{ record.Name } obtém o campo Nome do registro.
problemas de FlexCards
Ao trabalhar no FlexCard Designer, você pode se deparar com problemas que exigem alguma solução de
problemas para serem resolvidos. Antes de entrar em contato suporte , considere estes artigos de solução de
problemas .
• Atualize as configurações do site remoto para visualizar seu FlexCard

Conceda acesso aos domínios da sua organização para habilitar recursos do LWC, como o Preview. Ao girar
uma nova organização ou nova instalação, as chamadas da API de ferramentas necessárias para o LWC
podem falhar se a página Configurações do site remoto em sua organização não incluir os URLs necessários.
• Atualize a página Lightning Record do objeto de cartão para acessar o FlexCard Designer
Quando você clica em um FlexCard no OmniStudio FlexCards guia inicial e ver uma página de detalhes
do registro em vez do FlexCard Designer, você deve atualizar a página de registro do Lightning do objeto
Omni UI Card para o Vlocity Card Designer .
• Corrija a redundância cíclica ao incorporar componentes FlexCard
Ao incorporar componentes, como submenus, LWCs personalizados e cartões filho, verifique se os
componentes não são chamados várias vezes.
Atualize as configurações do site remoto para visualizar seu FlexCard

Conceda acesso aos domínios da sua organização para habilitar recursos do LWC, como o Preview. Ao girar
uma nova organização ou nova instalação, as chamadas da API de ferramentas necessárias para o LWC podem
falhar se a página Configurações do site remoto em sua organização não incluir os URLs necessários. Os URLs
obrigatórios são o URL lightning.force.com da sua organização e o URL visualforce.com da página do
Visualforce que contém o FlexCard Designer.
Atualizar manualmente as configurações do site remoto (URLs fornecidos)

Se você vir um botão Avisos no OmniStudio Guia inicial do FlexCards , adicione URLs ausentes às configurações
do site remoto.
1. Clique no botão Avisos no OmniStudio guia inicial do FlexCards e copie o URL visualforce.com .
2. Em uma nova guia do navegador, vá para Configuração > Segurança > Configurações do site
remoto.
company
4. Insira um Nome de site remoto sem espaços para o domínio visualforce.com. Por exemplo , digite
LWC_VF .
5. Insira a URL copiada do visualforce.com na URL do site remoto . Por exemplo, insira https:// whitmanco -
-vlocity-ins.visualforce.com .
6. Confirme se a caixa de seleção Ativo está habilitada.
8. Na guia original do navegador, copie a URL Lightning.force.com do pop-up Avisos no OmniStudio Aba
inicial dos FlexCards .
9. Vá para Configuração > Segurança > Configurações do site remoto e clique em Novo site remoto .
10. Insira um nome de site remoto sem espaços para o domínio lightning.force.com. Por exemplo , digite
LWC_LF .
11. Insira o URL copiado de lightning.force.com. Por exemplo, insira https:// whitmanco.lightning.force.com
.
12. Repetir passos 6 e 7.
Atualize a página Lightning Record do objeto de cartão para acessar o FlexCard

Designer
Quando você clica em um FlexCard no OmniStudio Guia inicial do FlexCards e ver uma página de detalhes do
registro em vez do FlexCard Designer, você deve atualizar a página de registro do Lightning do objeto Omni UI
Card . Defina a página de registro do Lightning como Vlocity Card Designer .
Exemplo 13. Exemplo

Quando você clica no link para um FlexCard chamado EmployerApplication na guia inicial do FlexCards , ele
exibe a página de detalhes do registro, como a da imagem a seguir, em vez do FlexCard Designer.
Solução
1. Na sua organização, vá para Configuração > Gerenciador de objetos

2. Na Busca rápida, insira Omni UI Card e clique no rótulo Omni UI Card
3. Clique em Páginas de registros do Lightning .
4. Confirme se o Vlocity Card Designer é o padrão da organização. Caso contrário, siga estas
etapas: a. Clique em Vlocity Card Designer .
b. Clique em Exibir para abrir o Criador de aplicativo Lightning.
c. Clique em Ativação .
d. Clique em Atribuir como padrão da organização .
e. Selecione os fatores de forma, clique em Avançar e clique em Salvar .
Consulte Ativar páginas de registro do Lightning Experience .
Corrija a redundância cíclica ao incorporar componentes FlexCard

Ao incorporar componentes, como submenus, LWCs personalizados e FlexCards filho , verifique se os
componentes não são chamados várias vezes. Se você adicionar componentes que chamam a si mesmos ou
chamar outros componentes incorporados dentro de componentes, você pode criar redundância cíclica

company
fazendo com que os eventos sejam disparados continuamente em seu navegador, excedendo sua pilha de
tamanho máximo de chamadas.
OmniOut
Exemplo 14. Exemplo
Seu FlexCard tem um FlexCard filho que chama um OmniScript que também chama o mesmo FlexCard pai de
um submenu.
Solução
Confirme quais componentes são chamados dentro de um componente incorporado antes de adicioná-lo a um FlexCard . Atualize o componentes este
pode causar cíclico redundância .
Execute OmniScripts e FlexCards fora da plataforma em sites de terceiros com OmniOut para OmniScripts e
OmniOut para FlexCards . Exiba OmniScripts e FlexCards e conecte-se ao Salesforce a partir de um site externo
de um sistema de gerenciamento de conteúdo (CMS). Execute um OmniScript ou FlexCard em seu site externo
adicionando o componente ao projeto OmniOut , integrando OmniOut em seu aplicativo e implantando seu
aplicativo em seu CMS.
Requeridos Versões
• OmniOut para FlexCards está

disponível a partir do verão de 2021.
NOTA
configuração do CMS é separada do
OmniOut . Conclua a configuração do
CMS antes de usar o OmniOut .
Antes de começar
1. Certifique-se de ter um sistema de

gerenciamento de conteúdo
construído.
2. Instale o Node e o npm . Consulte
Instalando o Nó .
3. Baixe o código do Visual Studio.
Consulte Código do Visual Studio .
1. Baixe o recurso estático OmniOut do Salesforce e abra-o no Visual Studio Code. Ver Baixe o OmniOut
Estático Recurso .
2. Instale dependências para o projeto OmniOut . Ver Instalar OmniOut Dependências .
3. (Opcional apenas para OmniScripts ) Adicione quaisquer LWCs personalizados aninhados que existam em
seu OmniScript antes de adicionar um OmniScript a OmniOut . Ver Incluir aninhado Personalizado LWCs
em seu OmniOut OmniScript .
4. Baixe e adicione seu componente ao projeto OmniOut . Para adicionar um OmniScript , consulte Adicionar
um OmniScript Lightning Web Component ao OmniOut . Para adicionar um FlexCard , consulte Adicionar
um FlexCard LWC ao OmniOut .
5. Crie um aplicativo conectado para habilitar uma conexão de API do Salesforce. Consulte Criar um
aplicativo conectado para OmniOut .
6. (Opcional apenas para OmniScripts ) Configure o OmniOut para usar OmniScripts multilíngue . Ver
Configurar vários idiomas no OmniOut para OmniScripts .
7. Execute o OmniOut no modo de desenvolvimento para visualizar e testar seu componente. Ver Corre
OmniOut em Desenvolvimento Modo .
8. (Opcional) Controle para onde seu componente direciona os usuários usando a ação
Navigate em um FlexCard ou OmniScript . Para OmniScripts , consulte Navegar para um URL de um
company
OmniScript em um aplicativo OmniOut . Para FlexCards , consulte Navegar para um URL de um FlexCard
em um aplicativo OmniOut .
9. Implante seu aplicativo OmniOut executando uma das seguintes tarefas:
• Se você não estiver implantando no Adobe Experience Manager, consulte Mover OmniOut para seu
aplicativo .
• ( Somente OmniScripts ) Para adicionar OmniOut for OmniScripts a um aplicativo Adobe Experience
Manager , consulte Adicione OmniScripts ao Adobe Experience Manager .
10. (Opcional) Inclua folhas de estilo personalizadas em seu projeto OmniOut . Consulte Adicionar folhas de
estilo personalizadas ao seu aplicativo OmniOut .
11. Crie uma conexão em seu aplicativo. Consulte Conecte seu aplicativo OmniOut .
Baixe o recurso estático OmniOut

Baixe o recurso estático OmniOut da sua organização do Salesforce. O recurso estático OmniOut inclui JS,
HTML, CSS e outros arquivos necessários para que OmniScripts e FlexCards sejam executados fora do
Salesforce.
1. Na sua organização do Salesforce, navegue até Configuração e, na caixa de busca rápida, insira Recursos
estáticos .
2. Na página Recursos Estáticos , localize e selecione o recurso vlocityomnioutlwc .
3. Clique em Exibir arquivo para baixar o recurso estático.
4. Abra o arquivo baixado descompactado no Visual Studio Code .
Qual é o próximo
Instalar dependências OmniOut
Veja também
• OmniOut
• Criar um aplicativo conectado para OmniOut
Instalar dependências OmniOut

Configure e instale as dependências do OmniOut usando uma ferramenta de linha de comando. Instale as
ferramentas necessárias para construir seu aplicativo OmniOut e visualize-o localmente.
Antes de começar
1. Baixe o recurso estático LWC OmniOut . Consulte Baixar o recurso estático OmniOut .
2. Solicite uma chave de acesso ao repositório NPM de seu representante de cliente Vlocity .
3. Entenda como executar comandos em um terminal. Consulte Linha de comando 101 (documentação do git-
tower).
4. Instale o npm . Veja npm ( documentação do npm ).
1. Descompacte o recurso estático baixado.
2. Na pasta descompactada, abra o arquivo . npmrc e defina _auth igual à sua chave de acesso ao
repositório NPM.
_ auth = Authentication_Key
3. Em um novo shell de terminal, instale os pacotes npm executando o comando npm install .
4. Execute o comando npm run watch no console do terminal para executar o servidor de desenvolvimento.
5. Acesse o servidor de desenvolvimento local em localhost:4002 para visualizar o aplicativo de
demonstração.

company
Qual é o próximo
Para OmniScripts , adicione um componente Web OmniScript Lightning ao OmniOut
Para FlexCards , adicione um FlexCard LWC ao OmniOut
Veja Também
• OmniOut
• ( Somente para OmniScripts ) Incluir LWCs personalizados aninhados em seu OmniOut OmniScript
• ( Somente para OmniScripts ) Configurar vários idiomas no OmniOut para OmniScripts
Incluir LWCs personalizados aninhados em seu OmniOut OmniScript

Mapeie componentes da Web do Lightning personalizados aninhados em seu OmniScript para incluí-los em
seu projeto OmniOut . Os componentes da Web do Lightning que substituem ou mapeiam para um elemento
OmniScript são baixados automaticamente com o OmniScript LWC fora da plataforma.
componentes da Web do Lightning personalizados aninhados referenciados por um componente da Web do

Lightning personalizado no OmniScript não são incluídos por padrão. Para incluir LWCs personalizados
aninhados, mapeie-os para um elemento fictício na seção Tipo de elemento para mapeamento de
componente LWC.
1. Do OmniScript Configuração , role até a seção Tipo de elemento para mapeamento de componentes
LWC.
2. No campo Tipo de elemento , insira um tipo de elemento falso. Por exemplo , nestedElement .
3. No campo Componente da Web do Lightning , insira o nome do seu componente da Web do Lightning
personalizado aninhado. Por exemplo , nestedElement .
4. Salve e ative seu OmniScript .
Qual é o próximo
Adicionar um componente Web OmniScript Lightning ao OmniOut
Veja Também
• OmniOut
• Navegue até um URL de um OmniScript em um aplicativo OmniOut

company
Adicionar um componente Web OmniScript Lightning ao OmniOut
Baixe e configure um OmniScript para usá-lo fora da plataforma no OmniOut . Baixe seu OmniScript LWC do
LWC OmniScript Designer, adicione a pasta de componentes ao projeto OmniOut e configure arquivos para
HTML e CSS.
Antes de começar
1. Instale as dependências necessárias do OmniOut . Consulte Instalar dependências do OmniOut

2. (Opcional) Configure o OmniScript para incluir componentes da Web do Lightning personalizados aninhados no OmniOut . Ver Incluir aninhado
Personalizado LWCs em seu OmniOut OmniScript .
1. Abra um OmniScript em sua organização do Salesforce e clique em Ativar .

2. Clique no botão Download Off Platform LWC e descompacte o arquivo baixado.
NOTA
Se o OmniScript incluir LWCs personalizados de um pacote gerenciado, os LWCs
personalizados podem não funcionar. Os LWCs personalizados que existem em um pacote
gerenciado só funcionam se forem compatíveis fora da plataforma.
3. Copie o componente na pasta lwc do seu componente baixado para a pasta ./src /modules/
vlocityomniscript do seu projeto OmniOut LWC .
4. No OmniScript Designer, clique no menu suspenso, clique em Como iniciar e copie a tag do componente .

company
5. No Visual Studio Code, abra o arquivo ./src/index.html e substitua a marca do componente pela marca
do componente OmniScript .
6. Edite sua tag de componente substituindo c-- por vlocityomniscript - e salve o arquivo.
7. Abra o arquivo ./src /index.js e siga estas etapas para importar e definir seu componente:
a. Substitua a importação do componente de amostra pelo caminho do arquivo do seu componente.
importar VlocApp de ' vlocityomniscript / typeExampleSubtypeExampleEnglish ';
b. Substitua a tag de componente de amostra pela tag de componente modificada e remova a tag de
fechamento e os colchetes angulares.
customElements.define('vlocityomniscript-type-example-subtype-exampleenglish',
buildCustomElementConstructor ( VlocApp ) );

company
8. (Opcional) Na tag do componente OmniScript , remova o atributo run-mode=" localScriptDef " para
verificar se o OmniScript está ativo no Salesforce.
NOTA
Ao executar um OmniScript multilíngue , o atributo run-mode=" localScriptDef " força o
OmniScript a usar os rótulos personalizados definidos localmente. Se o modo de execução não
estiver presente, uma conexão será feita para recuperar os rótulos personalizados.
9. (Opcional) Na tag do componente OmniScript , adicione dir =" rtl " para forçar os estilos OmniScript a
serem carregados da direita para a esquerda, independentemente da linguagem OmniScript . Sem esse
atributo, os idiomas da direita para a esquerda ainda são carregados com o estilo da direita para a
esquerda. OmniScript fornece suporte beta para a direita para a esquerda estilo .
< vlocityomniscript -type-example-subtype-exampleenglish runmode =" localScriptDef " dir

=" rtl "> </ vlocityomniscript -type- examplesubtype -exampleenglish >
10. (Opcional) Em Index.html , remova o comentário das folhas de estilo Newport para aplicar o estilo
Newport.
<link rel ="stylesheet" type="text/ css " href ="/ newport /assets/styles/ vlocity-newport-design-
system.min.css">
11. Em Index.html , remova o comentário do arquivo Script apropriado para cada um destes elementos que
existem em seu OmniScript :
Elemento Arquivo de script
Ação PDF <script src ="/ vlocityresources / javascript /VlocityPdf.js"></script>
Digite o bloco à frente Remova o comentário deste arquivo e, no parâmetro key , insira sua chave de API.
usando o Google Maps
<script type="text/ javascript " src ="https://maps.googleapis.com/
maps/ api / js?key ={YOUR_API_KEY_HERE}&libraries=places">
</script>
12. Em Index.html , inclua os estilos SLDS mesmo ao usar estilos Newport, se esses elementos existirem em
seu OmniScript :
Elemento Estilo Lençóis Observação
Arquivo  LWC OmniOut suporta uploads

<link rel ="stylesheet" type="text/ css " href ="/ slds /assets/ de arquivos de até 30 MB.
styles/salesforce-lightning-design-system.css"> <link rel ="stylesheet"
type="text/ css " href ="/ vlocityresources / slds
/styles/OmniLwcUtilsCss.css">
Imagem  LWC OmniOut suporta
<link rel ="stylesheet" type="text/ css " href ="/ slds /assets/ uploads de imagens de até 30
styles/salesforce-lightning-design-system.css"> <link rel ="stylesheet" MB.
13. Salvar seu arquivo.
14. Execute o comando npm run watch em seu console de terminal para reiniciar o servidor e
visualizar seu OmniScript .

company
Qual é o próximo
Criar um aplicativo conectado para OmniOut
Veja Também
• OmniOut
• Corre OmniOut em Desenvolvimento Modo
• Configurar vários idiomas no OmniOut para OmniScripts
Adicione um FlexCard LWC ao OmniOut

Baixe e configure um FlexCard para usá-lo fora da plataforma em seu projeto OmniOut . Baixe seu FlexCard
LWC do FlexCard Designer, adicione a pasta de componentes ao projeto OmniOut e configure arquivos para
HTML e CSS.
Antes de começar
1. Instale as dependências necessárias do OmniOut . Consulte Instalar dependências do

OmniOut
1. Abra um FlexCard do OmniStudio guia inicial FlexCards em sua organização do Salesforce e clique em
Ativar no submenu.
2. Clique na seta para baixo ao lado de Ativar e clique em Baixar LWC fora da plataforma .
4. Copie o componente na pasta c do arquivo baixado para a pasta ./src /modules do seu projeto OmniOut
ou subdiretório como ./src / modules / flexcards .
5. No Visual Studio Code, abra o arquivo ./src/index.html e adicione a tag do componente FlexCard . Por
exemplo, se o nome da pasta do seu componente for flexaccountproducts e for colocado dentro do
diretório ./src /modules/ flexcards , sua tag de componente pode se parecer com < flexcards-
accountproducts runmode =" localScriptDef "></ flexcards-accountproducts > .
6. Abra o arquivo ./src /index.js e siga estas etapas para importar e definir seu componente:
a. Importe seu componente do caminho de arquivo do seu componente.
importar FlexCardProducts de ' flexcards / accountproducts ';

b. Configure o FlexCard para HTML definindo um elemento personalizado e conectando-o ao seu
componente.
customElements.define (' flexcards-accountproducts ', buildCustomElementConstructor (

FlexCardProducts ) );
7. (Opcional) Na tag do componente FlexCard , remova o atributo run-mode=" localScriptDef " para
verificar se o FlexCard está ativo no Salesforce.
NOTA
Se o modo de execução não estiver presente, uma conexão será feita para recuperar os
rótulos personalizados.
8. (Opcional) Em Index.html , remova o comentário das folhas de estilo Newport para aplicar o estilo
Newport.
<link rel ="stylesheet" type="text/ css " href ="/ newport /assets/styles/ vlocity-newport-design-
system.min.css">
9. Em Index.html , inclua os estilos SLDS mesmo ao usar estilos Newport, se o elemento Image
existir em seu FlexCard .
company
Elemento Estilo Lençóis Observação
Imagem Estilos SLDS --> OmniOut suporta uploads de

<link rel ="stylesheet" type="text/ css " href ="/ slds /assets/ imagens de até 30 MB.
styles/salesforce-lightning-design-system.css"> <link rel ="stylesheet"

11. Execute o comando npm run watch em seu console de terminal para reiniciar o servidor e visualizar seu
FlexCard localmente.
Criar um aplicativo conectado para OmniOut

Habilite a conexão externa para interagir com o Salesforce configurando um aplicativo conectado no
Salesforce. Crie um aplicativo conectado para fazer chamadas externas do OmniOut . Os aplicativos
conectados fornecem ao OmniOut um token de acesso que permite que proxies e autenticação de login
funcionem.
Ver Aplicativos conectados .

Antes de começar
• Para OmniScripts , adicione um OmniScript LWC ao seu projeto OmniOut . Consulte Adicionar um componente Web OmniScript Lightning ao
OmniOut .
• Para FlexCards , adicione um FlexCard LWC ao seu projeto OmniOut . Consulte Adicionar um FlexCard LWC ao OmniOut .
1. Em Configuração do Salesforce, pesquise Aplicativos na caixa Busca rápida e clique em Gerenciador de
aplicativos .
2. Clique em Novo aplicativo conectado .
3. No campo Nome do aplicativo conectado , insira um nome para seu aplicativo conectado.
4. Insira um nome de API que seja usado para se referir ao Aplicativo Conectado do seu programa.
5. Insira um contato e-mail .
6. Verificar Permitir Configurações OAuth .
7. Insira um URL de retorno. A URL de retorno é a URL do site público do aplicativo.
8. Mova o escopo Fullaccess (full) ou Access e gerencie seus dados ( api ) para Selected OAuth Scopes .
9. Salvar sua Aplicativo conectado .
10. Na página do aplicativo conectado, clique em Editar políticas .
11. No campo Usuários permitidos , selecione Todos os usuários podem autoautorizar e salve o aplicativo
conectado.
12. Copie a Chave do Consumidor e o Segredo do Consumidor . Esses valores preenchem client_id e
client_secret .
13. Abra o projeto OmniOut no Visual Studio Code e, no terminal, execute estas tarefas:
a. Digite este comando sem executá-lo.
curl -d "username=USERNAME" -d "password=PASSWORD" -d

" client _id =CLIENTID" -d " client_secret =CLIENTSECRET" -v -d " grant_type =password"
https://test.salesforce.com/services/oauth2/token
b. No comando, substitua estes valores:
Valor Descrição
NOME DE USUÁRIO Substitua pelo seu nome de usuário do Salesforce.
SENHA Substitua por sua senha do Salesforce.
ID DO CLIENTE Substitua pela chave do consumidor do seu aplicativo

conectado .

company
SEGREDO DO CLIENTE Substitua pelo Segredo do consumidor do seu aplicativo
conectado .
c. (Opcional) No comando, insira o URL apropriado para seu ambiente do Salesforce. Por padrão, a URL
é configurada para uma organização Sandbox.
Meio Ambiente URL
Organização do https://login.salesforce.com/services/oauth2/token
desenvolvedor
Organização https://test.salesforce.com/services/oauth2/token
Sandbox
d. Execute o comando e copie o token de acesso e a URL da instância .
Qual é o próximo
Execute o OmniOut no modo de desenvolvimento
Veja Também
• OmniOut
• (Para OmniScripts ) Configurar Multi-Language no OmniOut para OmniScripts
Configurar vários idiomas no OmniOut para OmniScripts

Exiba OmniScripts em vários idiomas no OmniOut usando rótulos personalizados. Acesse rótulos
personalizados em seu OmniScript diretamente do Salesforce ou use rótulos personalizados definidos em
arquivos locais. Controle qual idioma é exibido usando um código de idioma.
O código de idioma pesquisa arquivos de idioma definidos localmente ou uma conexão do Salesforce para
acessar os rótulos personalizados de um idioma. Se o atributo run-mode da tag do componente OmniScript
estiver presente e definido como localScriptDef , o OmniScript usará os rótulos personalizados definidos
localmente. Se o modo de execução não estiver presente, o OmniScript acessará os rótulos personalizados por
meio de uma conexão do Salesforce.
Antes de começar
1. Crie um OmniScript multilíngue . Consulte Criar OmniScripts em vários idiomas .

2. Adicione seu OmniScript multilíngue a um OmniOut LWC. Consulte Adicionar um componente Web OmniScript Lightning ao OmniOut .
3. Visualize os códigos de idioma do Salesforce. Consulte Traduções (documentação do Salesforce).
1. Depois de adicionar seu OmniScript multilíngue ao OmniOut , na linha de comando do VSCode , digite
este comando e substitua LANGCODE por um código de idioma do Salesforce:
npm corre rótulos personalizados LANGCODE

2. Veja estes dois arquivos gerados:
• LANGCODE.translations.js : contém todos os rótulos personalizados, definidos pelo usuário e prontos
para uso, em um único arquivo. O código de idioma substitui a propriedade LANGCODE usada neste
nome de arquivo de exemplo.
• translations.js : contém as exportações de todas as traduções diferentes para todos os rótulos
personalizados.
3. Em translations.js , remova o comentário das linhas de exportação para incluí-las quando o OmniScript
estiver em execução.
exportar * de "./es.translations.js ";

4. Passe o código do idioma usando uma combinação destas duas opções:

company
NOTA
Se ambas as opções estiverem presentes, a propriedade da tag do componente substituirá o
parâmetro URL.
Linguagem Código Descrição Exemplo
Opção
Componente Marcação Passa o código de idioma na tag de componente do <myomniscript prefill='\
Propriedade OmniScript como uma propriedade de pré-preenchimento. {" LanguageCode ":" iw "}'> </my-
omniscrito >
Linguagem Código Descrição Exemplo
Opção
Parâmetro de URL Anexe o parâmetro LanguageCode ao seu endpoint de localhost:4002/ myOmniScript ? LanguageCode =
URL e insira um código de idioma do Salesforce. en_US
5. (Opcional) Na tag do componente OmniScript , adicione o atributo run-mode=" localScriptDef " para
forçar o OmniScript a usar os rótulos personalizados definidos localmente. Se o modo de execução não
estiver presente, uma conexão será feita para recuperar os rótulos personalizados do Salesforce.
6. (Opcional) Se estiver usando run-mode=" localScriptDef " em sua tag de componente OmniScript , você
deverá definir traduções personalizadas para cada idioma manualmente.
Para definir seus rótulos personalizados:
a. No OmniOut , selecione um arquivo LANGCODE.translations.js .
b. Em seu arquivo, localize um par chave-valor e, no campo de valor, insira a tradução desse rótulo
personalizado. Repetir isto processo para cada personalizadas rótulo .
exportar const es = {
"Novo": "Novo"
}
7. (Opcional) Teste o OmniScript multilíngue Na linha de comando:
a. Na linha de comando, digite e execute o comando npm run watch .
b. Clique no link localhost que aparece na linha de comando.
c. No seu navegador, edite o URL para incluir um código de idioma.
localhost:4002/ myOmniScript?LanguageCode = en_US
Qual é o próximo
Veja também
• OmniOut

Visualize e teste seu OmniScript e FlexCard antes de adicioná-lo ao seu aplicativo executando-o no modo de
desenvolvimento. Use uma conexão jsForce para solicitar dados de sua organização.
Ver jsForce no GitHub .

company
Antes de começar
1. Baixe seu componente web do Lightning e adicione -o ao OmniOut . Para OmniScripts , consulte Adicionar um componente Web OmniScript
Lightning ao OmniOut . Para FlexCards , consulte Adicione um FlexCard LWC a OmniOut .
2. Crie um aplicativo conectado ao Salesforce para habilitar uma conexão de API do Salesforce a partir do seu aplicativo. Ver Crie um aplicativo
conectado para OmniOut .
1. No . arquivo index.html da pasta src , localize a função JSForceConnectionExample () .
2. No objeto de conexão const , insira o token de acesso do Salesforce Connected App e o URL da instância.
Ver Token de acesso .
const connection = new jsforce.Connection ({ // Defina sua configuração jsForce aqui accessToken
: '', instanceUrl : ''
});
3. Defina this.namespace igual ao namespace do seu namespace de pacote. Para encontrar seu namespace,
consulte Visualizando o namespace e a versão do OmniStudio Pacote Vlocity .
5. No terminal, digite e execute o comando npm run watch .

company
Qual é o próximo
Mova OmniOut para seu aplicativo
Veja Também
• OmniOut
• Conecte seu Aplicativo OmniOut
Navegue até um URL de um OmniScript em um aplicativo OmniOut

Direcione os usuários para diferentes URLs de um OmniScript em um aplicativo OmniOut usando a ação
Navigate. Configure endpoints na ação de navegação e crie redirecionamentos para os URLs em seu aplicativo
OmniOut . OmniOut suporta todos os tipos de ação de navegação, incluindo geração de URL e atualizaç ões de
localização do navegador. Os autores do aplicativo devem decidir como lidar com os URLs gerados com base
nos requisitos exclusivos do projeto.
Antes de começar
Configure uma ação de navegação. Consulte Ação de

Navegação .
1. Visualize o formato de URL gerado para cada um desses tipos de referência de página de ação de
navegação:
Página Formato Exemplo de URL
Referência
Modelo
Aplicativo /{ appName }/{ pageReference } / vlocity -digital -studio/omni-script-

casa
Conhecimento /{ artigoTipo }/{ artigoURL } / vlocity -in-knowledge/new-test

Artigo
Relâmpago / cmp /{ componentName }? / cmp / exemploComponente ?

Componente {... targetParameters } c__ exemploParâmetro =ABC123
Página de login /Conecte-se /Conecte-se
OU
/sair
Página nomeada /{ pageName }?{... targetParameters } /casa
Navegação Itens de navegação, como guias, transformam o nome do / meu-guia personalizada

Item item em kebab-case.
Página do objeto /o/{ sObjectApiName }/home? /o/case/home

{... targetParameters }
Registro /r/{ sObjectApiName }?id={ objectId } /r/ conta?id =0012E00001qF0l2QAC

Página {... targetParameters }
Página Formato Exemplo de URL

Referência
Modelo
Registro /r/{ sObjectApiName }? /r/caso?

Relação id={ objectId }& rel ={ relacionamentoApiName } id=0012E00001qF0l2QAC&rel= CaseComments
Página
Vlocity / vlocityomniscript / / vlocityomniscript / demoNavigateActionInglês

OmniScript { OmniScriptComponentName }

company
Página da Internet Um URL da web. A ação de navegação não formata URLs <https://trailhead.salesforce.com>
de páginas da Web.
2. (Opcional) Se seu aplicativo tiver uma estrutura de URL predeterminada que não corresponde ao URL
gerado, siga estas etapas para redirecionar os URLs:
a. No projeto OmniOut , crie este arquivo ./src / modules / vlocityoverride /redirects.js
b. Em redirect.js, adicione um objeto de mapa para conter seus mapeamentos de redirecionamento.
redirecionamentos const = new Map([
] );
redirecionamentos padrão ;
c. No objeto de redirecionamentos, adicione uma chave que mapeie a URL gerada e um valor que
represente a URL transformada. Cada chave e valor deve começar com / . Por exemplo, mapeie
qualquer ação Navigate que gere a URL /home para /my-custom-home .
redirecionamentos const = new Map([ ['/home','/my-custom-home']

]);
exportar redirecionamentos padrão ;

d. (Opcional) Inclua curingas em seu URL para redirecionar todas as páginas de objeto para uma única
página. Por exemplo, redirecione o objeto de caso e o registro de caso navegue pelas ações para
uma única página com o endpoint /case . Cada um desses URLs gerados: /o/case/home , /r/ case?id
=0012E00001qF0l2QAC e /r/case? id=0012E00001qF0l2QAC&rel= CaseComments apontaria para
/case . Os parâmetros de URL para cada URL gerado é preservado .
const redirecionamentos = new Map([

['/home','/my-custom-home'], ['/*/case', '/case']
]);
Qual é o próximo
Se você estiver implantando seu aplicativo OmniOut no aplicativo Adobe Experience Manager, consulte
Adicionar OmniScripts ao Adobe Experience Manager .
Se você não estiver implantando no Adobe Experience Manager, consulte Mover OmniOut para seu aplicativo .
Veja Também
• OmniOut
• Adicione folhas de estilo personalizadas ao seu aplicativo OmniOut
Navegue até um URL de um FlexCard em um aplicativo OmniOut

Direcione os usuários para diferentes URLs de um FlexCard em um aplicativo OmniOut usando o tipo de ação
Navigate. OmniOut para FlexCards suporta apenas o tipo de destino de página da Web. Os autores do
aplicativo devem decidir como lidar com os URLs gerados com base nos requisitos exclusivos do projeto.

company
NOTA
Para navegar para um URL de um OmniScript em um aplicativo OmniOut , consulte Navegar para
um URL de um OmniScript em um aplicativo OmniOut .

2. Selecione Navegar como o Tipo de ação .
3. Selecione Página da Web como o Tipo de destino . Ver Referência de página Tipos .
4. Insira a URL no campo URL .
Qual é o próximo
Veja Também
• Navegue de um FlexCard com a ação Navigate
• OmniOut

Gere uma pasta dist compilada para mover o OmniOut para seu projeto de aplicativo antes de implantar seu
aplicativo em um sistema de gerenciamento de conteúdo.
Antes de começar
• Para OmniScripts , adicione um componente Web OmniScript Lightning ao OmniOut

.
• Para FlexCards , adicione um FlexCard LWC ao OmniOut .
1. Em seu projeto OmniOut , execute o comando npm run build no terminal do Visual Studio Code. O
comando compila OmniOut em uma pasta dist .
npm executar compilação

company
company
2. Na pasta dist , copie os arquivos OmniScript e FlexCard necessários do projeto OmniOut para seu
aplicativo.
Pasta de arquivo Obrigatório ? Descrição
app.js , incluindo arquivos app.js numerados, como Sim Os arquivos JavaScript necessários para seu FlexCard ou
0.app.js OmniScript .
vlocityresources Sim Os recursos estáticos necessários para seu FlexCard ou OmniScript

.
index.html Opcional Um arquivo index.html de amostra que mostra como executar o

projeto OmniOut LWC.
newport Opcional Este arquivo é necessário se você estiver usando o tema padrão de
Newport. Se seu OmniScript tiver um elemento Image ou File , ou
seu FlexCard contiver um elemento Image , você também deverá
copiar sobre a pasta slds .
slds Opcional Esse arquivo é necessário se você estiver usando o tema do

Lightning. Se seu OmniScript contém um elemento Image ou File ,
ou seu FlexCard contém um elemento Image , você deve copiar
sobre a pasta slds .
OmniScriptDocuSignReturnPage .html Opcional Esse arquivo é necessário se houver uma ação do DocuSign no
OmniScript .
OmniScriptLwcDocuSignViewPdf.html Opcional Esse arquivo é necessário se houver uma ação do DocuSign no

OmniScript .
3. No arquivo index.html , selecione e copie as tags de script que fazem referência aos arquivos app.js no
arquivo index.html do seu aplicativo.
4. No arquivo index.html , selecione e copie sua tag de componente OmniScript ou FlexCard no arquivo
index.html do seu aplicativo.
< vlocityomniscript -doc-exampleenglish run-mode=" localScriptDef "></ vlocityomniscript -doc-

exampleenglish >
< flexcards-accountproducts run-mode=" localScriptDef "></ flexcards -

produtos de conta >
Qual é o próximo
Conecte seu aplicativo OmniOut
Veja Também
• OmniOut

company
Adicionar OmniScripts ao Adobe Experience Manager

Adicione OmniScripts ao Adobe Experience Manager usando OmniOut . Os OmniScripts hospedados no AEM
exigem uma conexão do Salesforce para enviar dados entre servidores.
Antes de começar
1. Saiba mais sobre OmniOut . Consulte OmniOut .

2. Teste seus OmniScripts no modo de desenvolvimento do OmniOut . Consulte Executar OmniOut no modo
de desenvolvimento .
1. Crie uma conexão do Salesforce no AEM. Consulte Integrar o Salesforce Cloud Services ao Adobe
Experience Manager .
2. Defina caminhos de recursos no OmniOut para carregar estilos Lightning e Newport em seu aplicativo. Ver
Defina o OmniOut Caminho do recurso .
3. Implante o OmniOut no AEM. Consulte Implantar OmniOut no Adobe Experience Manager .
4. Adicione o componente OmniOut a uma página AEM. Consulte Adicionar o componente Vlocity LWC
OmniOut ao Adobe Experience Manager .
Integrar o Salesforce Cloud Services ao Adobe Experience Manager

Crie uma conexão do Salesforce no AEM. A configuração da conexão não faz parte do pacote Vlocity .
Antes de começar
1. Veja a documentação do Salesforce Cloud Connection do AEM. Consulte Configurando o AEM para integração com o Salesforce (documentação
do AEM).
2. Crie seu aplicativo conectado. Consulte Criar um aplicativo conectado para OmniOut .
1. Abra sua instância do AEM e clique no logotipo principal no canto superior esquerdo.
2. Clique nas Ferramentas ícone e selecione Implantação .
3. Selecione o cartão Cloud Services e role para baixo até a seção Salesforce. Clique em Mostrar
configurações .
4. Clique no link [+] próximo a Configurações Disponíveis e insira as informações necessárias e clique em
Criar . Isso abre uma nova página e modal para a Configuração de Serviços de Nuvem .
5. Para criar consistência entre plataformas, insira o nome do aplicativo conectado que você criou no
Salesforce nos campos Título e Nome do modal de configuração do AEM. Sair o modal aberto.
6. Navegue de volta para a página do aplicativo conectado no Salesforce.
7. Em URL de retorno , insira a URL do AEM com acesso de administrador: http://localhost:4502/etc/
cloudservices /salesforce/ testsalesforceconnect.html em que testsalesforceconnect é o título da sua
conexão de serviços de nuvem.
8. Navegue de volta para a página do aplicativo conectado e cole o URL no campo URL de retorno de
chamada .
10. Na página de registro do aplicativo conectado, copie a chave do consumidor.
11. Retorne ao modal AEM e cole a Chave do consumidor no campo Chave do cliente .
12. Na página de registro do aplicativo conectado, copie o segredo do consumidor.
13. Retorne ao modal AEM e cole o Segredo do Consumidor no campo Segredo do Cliente .
14. Clique em Conectar-se ao Salesforce . Isso leva você a uma tela de login para o Salesforce. Faça login na
organização apropriada e clique em Permitir . Uma janela modal aparecerá indicando que a conexão foi
bem-sucedida. Se você receber um erro, aguarde 10 minutos e tente se conectar novamente.
15. Clique em Ok para salvar as configurações.
Qual é o próximo
company
Implante o OmniOut no Adobe Experience Manager
Veja Também
• Adicionar o componente Vlocity LWC OmniOut ao Adobe Experience Manager
• OmniOut
Defina o OmniOut Caminho do recurso

Carregue seus recursos de estilo personalizado no aplicativo Adobe Experience Manager definindo os
caminhos de recursos corretos.
Antes de começar
1. Certifique-se de ter executado o OmniOut no modo de desenvolvimento. Consulte Executar OmniOut no modo de
desenvolvimento .
2. Crie uma conexão do Salesforce no AEM. Integre o Salesforce Cloud Services ao Adobe Experience Manager .
1. No VisualStudio , localize e abra o OmniOut's ./src/index.js arquivo . _
2. No arquivo ./src/index.js , descomente esta linha:
import { setSldsResourcesUrl , setNewportResourcesUrl } de 'c/ salesforceUtils '

3. No mesmo arquivo ./src /index.js , localize a função setSldsResourcesUrl e a função
setNewportResourcesUrl e descomente cada função.
O que vem a seguir

Veja Também
• OmniOut
• Adicionar OmniScripts ao Adobe Experience Manager

Adicione suas credenciais do AEM ao OmniOut e implante-o em seu servidor AEM. A implantação adiciona um
componente Vlocity LWC OmniOut ao AEM. O componente Vlocity LWC OmniOut permite que você adicione
seus OmniScripts a uma página AEM.
Antes de começar
1. Crie um aplicativo conectado. Consulte Criar um aplicativo conectado para OmniOut

2. Crie uma conexão do Salesforce no AEM. Consulte Integrar o Salesforce Cloud Services ao Adobe Experience Manager .
3. Defina seu caminho de recursos CSS. Consulte Definir o caminho do recurso OmniOut .
4. Localize e copie seu nome de usuário, senha, host e porta do servidor AEM.
1. No VisualStudio , abra o recurso OmniOut e localize o arquivo ./aem.ui.apps/pom.xml .
2. No arquivo ./aem.ui.apps/pom.xml , insira seu nome de usuário, senha, host e porta do servidor AEM
nestas tags :
• < crx.host ></ crx.host > : insira o host do servidor AEM.
• < crx.port ></ crx.port > : insira a porta do servidor AEM.
• < crx.username ></ crx.username > : Digite seu servidor AEM nome de usuário .
• < crx.password ></ crx.password > : digite a senha do servidor AEM.
• < publish.crx.host ></ publish.crx.host > : insira o host do servidor AEM.
• < publsh.crx.port ></ publish.crx.port > : insira a porta do servidor AEM.
• < publish.crx.username ></ publish.crx.username > : Digite seu servidor AEM nome de usuário .

company
• < publish.crx.password ></ publish.crx.password > : digite a senha do servidor AEM. Exemplo Sintaxe :
< crx.port >4502</ crx.port >
3. Implante o aplicativo executando este comando:
npm execute deploy:aem:clean:full
Qual é o próximo
Adicionar o componente Vlocity LWC OmniOut ao Adobe Experience Manager
Veja Também
• OmniOut
• Integrar o Salesforce Cloud Services ao Adobe Experience Manager
Adicionar o componente Vlocity LWC OmniOut ao Adobe Experience Manager

Inicie OmniScripts de uma página AEM adicionando o componente Vlocity LWC OmniOut . O componente
Vlocity LWC OmniOut hospeda o OmniScript e usa a configuração do Salesforce Cloud Services para fazer
chamadas para o Salesforce.
Antes de começar
1. Defina o caminho do recurso OmniOut .

2. Integre o Salesforce Cloud Services ao Adobe Experience Manager .
3. Implante o OmniOut no Adobe Experience Manager .
1. Em uma página do AEM, clique no símbolo + para adicionar um componente. Isso abre um modal com
uma lista de componentes.
2. Selecione o componente Vlocity LWC OmniOut .
3. No componente, clique no ícone de configuração, um símbolo de chave inglesa, para abrir a caixa de
diálogo Editar do componente.
4. Do Vlocity LWC OmniOut Editar caixa de diálogo , configure estas opções do componente Vlocity LWC
OmniOut :
a. Em Configuração , selecione a conexão de nuvem do Salesforce que conecta seu aplicativo
Salesforce Connected.
b. Em Namespace , insira o namespace do seu pacote Vlocity . Consulte Visualizando o namespace e a
c. Em LWC Element Name , insira o nome do OmniScript usando o nome da tag do componente sem
colchetes.
Por exemplo, se seu OmniScript tiver estas propriedades:
• Tipo : documento
• Subtipo : Teste
• Idioma : Inglês
A sintaxe correta a ser usada é vlocityomniscript -doc-test- english .
d. Em Layout , selecione o sistema de design Lightning ou Newport.
e. (Opcional) Em Prefill Attribute , insira dados JSON serializados para preencher os elementos.
f. (Opcional) Em Chave de API do Google Maps , insira uma Chave de API do Google Maps se uma for
usada em seu OmniScript .
g. (Opcional) Marque Usar proxy se seu aplicativo estiver usando um proxy para se conectar à sua
instância do Salesforce.
h. (Opcional) Em URL do proxy , insira o URL do proxy.

company
i. (Opcional) Marque Usar definição local para usar a definição de OmniScript local . O componente
não verificará se o OmniScript está ativo em sua organização do Salesforce.
j. (Opcional) Marque Carregar recursos SLDS para carregar estilos, imagens e ícones SLDS em seu
OmniScript . Esta opção é necessária se você usar Arquivo ou Imagem em seu OmniScript .
k. (Opcional) Marque Load Newport Resources para carregar estilos Newport em seu OmniScript .
l. (Opcional) Marque Carregar recursos de PDF se estiver usando uma ação de PDF em seu OmniScript
.
5. Salve seu componente e publique seu aplicativo AEM.
6. Teste seu aplicativo AEM e execute o OmniScript .
Veja Também
• OmniOut
• Corre OmniOut em Desenvolvimento Modo
Adicione folhas de estilo personalizadas ao seu aplicativo OmniOut

Inclua estilos personalizados em seu projeto OmniOut usando folhas de estilo. As folhas de estilo
personalizadas não estão incluídas nos metadados de download fora da plataforma OmniScript ou FlexCard .
Você deve adicioná-los ao seu aplicativo após criar a pasta dist .
O estilo personalizado feito no OmniScript Designer para um LWC personalizado ou no FlexCard designer em
qualquer elemento está incluído no LWC fora da plataforma baixado.
Antes de começar
1. Para OmniScripts , crie e adicione uma folha de estilo personalizada ao seu OmniScript . Ver Aplicar Personalizado Estilo para OmniScripts com
Estático Recursos .
2. Construir um OmniOut dist e mova o conteúdo da pasta para o seu aplicativo. Ver Mover OmniOut em Seu aplicativo .
1. Na caixa Busca rápida da Configuração do Salesforce, insira Recursos estáticos e clique em Recursos
estáticos .
2. Localize e clique no recurso estático que contém sua folha de estilo CSS.
3. Clique em Exibir arquivo para baixar o recurso estático.
4. Copie o arquivo baixado para a pasta de estilos principal do seu aplicativo.
5. Adicione uma referência a esse arquivo no arquivo index.html do seu aplicativo para carregar a folha de
estilo personalizada.
Exemplo
<link rel ="stylesheet" type="text/ css " href =".../styles/my-customstyles.css">
Qual é o próximo
Veja Também
• OmniOut

company
OmniOut conecta seu CMS ao Salesforce por meio de um proxy ou diretamente. Configure um objeto de
conexão para se conectar ao Salesforce Connected App. As conexões são exclusivas para os requisitos do seu
aplicativo e devem ser configuradas fora do escopo do OmniOut .
Veja o modelo de objeto de conexão e os aplicativos de exemplo nesta seção para ver exemplos de como
configurar uma conexão.
Antes de começar
1. Adicione seu OmniScript ou FlexCard ao OmniOut . Para OmniScripts , consulte Adicionar um componente Web OmniScript Lightning ao OmniOut .
Para FlexCards , consulte Adicione um FlexCard LWC a OmniOut .
2. Criar um aplicativo conectado para OmniOut
1. (Opcional) Baixe, execute e modifique aplicativos OmniOut de amostra . Ver Exemplos de aplicativos
OmniOut .
2. Criar um objeto de conexão no OmniOut
Exemplos de aplicativos OmniOut

Baixe, configure e execute aplicativos de amostra OmniOut para ver exemplos de conexão de aplicativos
OmniOut . Depois de executar o aplicativo de exemplo, modifique-o para hospedar seus OmniScripts e
FlexCards .
Antes de começar
Adicione http://localhost:3000 à lista de permissões do Salesforce CORS . Consulte Executar solicitações de

origem cruzada .
1. Selecione um aplicativo de amostra da tabela nesta página para baixar e executar o exemplo de conexão.
Aplicativo de Descrição Exemplo produtos
amostra
React , jsForce e Um aplicativo de reação que demonstra a Baixe e execute o OmniOut OmniScripts
OAuth2 _ funcionalidade de login usando OAuth2 e jsForce . Aplicativo de exemplo React-jsForce-OAuth2
LWC Um aplicativo de página única criado usando apenas Baixe e execute o OmniOut OmniScripts
componentes da Web do Lightning. Aplicativo de amostra LWC
LWC Um aplicativo de página única criado usando apenas Baixe e execute o OmniOut para FlexCards
componentes da Web do Lightning. FlexCards LWC
Reagir , Expressar Um aplicativo de reação que demonstra como executar Baixe e execute o React- OmniScripts
Procuração um aplicativo usando um proxy. Aplicativo de amostra de proxy expresso
2. ( Somente para OmniScripts ) Modificar uma amostra de OmniOut para OmniScripts React App .
Qual é o próximo
Crie um objeto de conexão no OmniOut . Se o seu projeto OmniOut tiver apenas FlexCards , consulte Criar um
objeto de conexão no OmniOut para FlexCards .
Baixe e execute o aplicativo de exemplo OmniOut React-jsForce-OAuth2

A amostra OAuth2 é um aplicativo de reação que demonstra um OmniScript com autenticação de login usando
OAuth2 e jsForce .
Antes de começar
Estabeleça uma conexão com o Salesforce. Consulte Criar um aplicativo conectado para
OmniOut .
1. Baixe o aplicativo de exemplo clicando aqui .
2. Abra o arquivo no Visual Studio Code.

company
3. No terminal do Visual Studio Code, execute este comando para instalar as dependências do npm :
npm instalar
4. Abra ./src /App.js e, no objeto jsforce.browser.init , localize essas chaves e defina-as iguais aos valores
apropriados:
Chave Valor
ID do Cliente A chave do consumidor do aplicativo conectado. Consulte Criar um aplicativo conectado

para OmniOut .
redirecionar Uri O URL de redirecionamento do aplicativo conectado. Consulte Criar um aplicativo
conectado para OmniOut .
5. Abra ./src /connection.js , localize a chave do namespace e insira o namespace do pacote como o valor.
Para obter informações sobre como localizar seu namespace, consulte Visualizando o namespace e a
6. No terminal do Visual Studio Code, execute este comando para executar o aplicativo de exemplo em
localhost:3000 :
npm início
7. Na barra de navegação, clique no botão Login , insira suas credenciais e clique em Permitir para fazer
login na organização.
8. Após efetuar login, na barra de navegação, clique no link Quote para visualizar um exemplo de
OmniScript .
9. Na barra de navegação, clique no link Contato para ver um exemplo de OmniScript embutido .
Qual é o próximo
Modificar um aplicativo OmniOut para OmniScripts React de amostra

company
Veja Também
• OmniOut
Baixe e execute o aplicativo de exemplo OmniOut LWC

Veja um exemplo de OmniOut que usa apenas componentes da Web do Lightning para executar um aplicativo
de página única fora da plataforma.
Antes de começar
OmniOut .
1. Em Configuração do Salesforce, insira Recursos estáticos na caixa Busca rápida e clique em Recursos
estáticos .
2. Em Recursos Estáticos, clique em vlocityomnioutlwcsample .
3. Clique em Exibir arquivo para baixar o aplicativo de exemplo.
4. Descompacte o arquivo baixado e abra-o no Visual Studio Code .
5. Localize o arquivo README.MD , clique nele e siga as instruções do README.
Baixe e execute o aplicativo de exemplo OmniOut for FlexCards LWC
Veja uma amostra de OmniOut com um FlexCard que usa apenas componentes da Web do Lightning para
executar um aplicativo de página única fora da plataforma.
Para obter um exemplo de OmniOut com um OmniScript , consulte Baixar e executar o aplicativo de exemplo
OmniOut LWC .
Antes de começar
OmniOut .
1. Em Configuração do Salesforce, insira Recursos estáticos na caixa Busca rápida e clique em Recursos
estáticos .
2. Em Recursos Estáticos, clique em vlocityomnioutflexcardslwcsample .
3. Clique em Exibir arquivo para baixar o aplicativo de exemplo.
4. Descompacte o arquivo baixado e abra-o no Visual Studio Code .
5. Localize o arquivo README.MD , clique nele e siga as instruções do README.
Baixe e execute o aplicativo de amostra React-Express Proxy

O aplicativo de exemplo React Express demonstra como usar um aplicativo como back-end para fazer
solicitações e encaminhá-las ao Salesforce.
O aplicativo React atua como o front-end do seu site, enquanto o aplicativo expresso lida com as chamadas de
back-end. Cada aplicativo de exemplo tem dependências separadas que você precisa instalar para executá-los
juntos.
Antes de começar
OmniOut .
Baixe, configure e execute o aplicativo expresso (1)

Baixe o aplicativo de exemplo, instale as dependências e execute o aplicativo expresso.
1. Baixe os aplicativos Express e React clicando aqui .

2. Abra a pasta no Visual Studio Code.
company
3. No terminal do Visual Studio Code, cd na pasta express-proxy e execute este comando para instalar as
dependências do npm :
npm instalar
4. Abra o arquivo ./app.js , localize essas chaves e defina-as iguais aos valores apropriados:
Chave Valor
namespace O namespace do seu pacote gerenciado Vlocity . Consulte Visualizando o namespace e a versão do OmniStudio Pacote
Vlocity .
URL da instância O instanceUrl recuperado de seu aplicativo conectado. Consulte Criar um aplicativo conectado para OmniOut .
accessToken O accessToken recuperado de seu aplicativo conectado. Consulte Criar um aplicativo conectado para OmniOut .
5. No terminal do Visual Studio Code, execute este comando para iniciar o aplicativo:
npm início
6. Em um navegador, acesse localhost:3001 para visualizar o aplicativo.
Configure e execute o aplicativo React (2)

Instale as dependências do aplicativo react, configure o arquivo connection.js e execute o aplicativo.
1. Abra uma nova janela de terminal no terminal do Visual Studio Code.

company
2. Na nova janela do terminal, cd na pasta react -express-proxy-sample e execute este comando para
instalar as dependências do npm :
npm instalar
3. Abra o arquivo ./src /connection.js , localize essas chaves e defina-as iguais aos valores apropriados:
Chave Valor
_ proxyUrl http://localhost:3001/api . Este é o URL onde seu back-end expresso está localizado.
URL da instância O instanceUrl recuperado de seu aplicativo conectado. Consulte Criar um aplicativo conectado para OmniOut .
namespace O namespace do seu pacote gerenciado Vlocity . Consulte Visualizando o namespace e a versão do OmniStudio Pacote
Vlocity .
4. No terminal do Visual Studio Code, execute este comando para iniciar o aplicativo:
npm início
5. Em um navegador, acesse localhost:3000 para visualizar o aplicativo.
6. Na barra de navegação, clique no link Citação para visualizar um exemplo de OmniScript .

7. Na barra de navegação, clique no link Contato para ver um exemplo de OmniScript embutido .
Qual é o próximo
Veja Também
• OmniOut

Hospede OmniScripts em seu aplicativo de amostra movendo arquivos de um projeto OmniOut compilado
para seu aplicativo de amostra.

company
NOTA
As instruções nesta página não se aplicam ao aplicativo de exemplo LWC porque o LWC
O aplicativo de amostra é um aplicativo independente. Consulte Baixar e executar o aplicativo de
exemplo OmniOut LWC .
Antes de começar
1. Baixe um dos aplicativos de amostra do react. Ver Exemplos de aplicativos OmniOut .

2. Baixe o recurso estático OmniOut do Salesforce e abra-o no Visual Studio Code. Ver Baixe o OmniOut Estático Recurso .
3. Instale dependências para o projeto OmniOut . Ver Instalar OmniOut Dependências .

4. (Opcional apenas para OmniScripts ) Adicione quaisquer LWCs personalizados aninhados que existam em seu OmniScript antes de a dicionar um
OmniScript a OmniOut . Ver Incluir aninhado Personalizado LWCs em seu OmniOut OmniScript .
5. Baixe e adicione seu componente ao projeto OmniOut . Para adicionar um OmniScript , consulte Adicionar um OmniScript Lightning Web
Component ao OmniOut . Para adicionar um FlexCard , consulte Adicionar um FlexCard LWC ao OmniOut .
6. (Opcional apenas para OmniScripts ) Configure o OmniOut para usar OmniScripts multilíngue . Ver Configurar vários idiomas no OmniOut para
OmniScripts .
1. Em seu projeto OmniOut , execute o comando npm run build no terminal do Visual Studio Code. O
comando compila OmniOut em uma pasta dist .
npm executar compilação

company
company
2. Na pasta dist , copie os arquivos que seu OmniScript requer para ser executado do projeto OmniOut para
a pasta ./public do aplicativo de amostra .
Pasta de arquivo Obrigatório ? Descrição
app.js , incluindo arquivos app.js numerados, como Sim Os arquivos JavaScript necessários para seu FlexCard ou
0.app.js OmniScript .
vlocityresources Sim Os recursos estáticos necessários para seu FlexCard ou OmniScript

.
index.html Opcional Um arquivo index.html de amostra que mostra como executar o

projeto OmniOut LWC.
newport Opcional Este arquivo é necessário se você estiver usando o tema padrão de
Newport. Se seu OmniScript tiver um elemento Image ou File , ou
seu FlexCard contiver um elemento Image , você também deverá
copiar sobre a pasta slds .
slds Opcional Esse arquivo é necessário se você estiver usando o tema do

Lightning. Se seu OmniScript contém um elemento Image ou File ,
ou seu FlexCard contém um elemento Image , você deve copiar
sobre a pasta slds .
OmniScriptDocuSignReturnPage .html Opcional Esse arquivo é necessário se houver uma ação do DocuSign no
OmniScript .
OmniScriptLwcDocuSignViewPdf.html Opcional Esse arquivo é necessário se houver uma ação do DocuSign no

OmniScript .
3. No arquivo index.html da pasta dist , selecione e copie as tags de script que fazem referência aos
arquivos app.js no arquivo ./public/index.html do aplicativo de amostra .
4. No arquivo index.html da pasta dist , copie a tag do componente OmniScript .
< vlocityomniscript -doc-exampleenglish run-mode=" localScriptDef "></ vlocityomniscript -doc-

exampleenglish >
5. Nos arquivos ./src /pages/Quote.js ou ./src /pages/Contact.js do aplicativo de amostra , substitua a tag
de componente de amostra existente pela tag de componente OmniScript .

company
6. No terminal, digite este comando para executar o aplicativo em localhost:3000 :
npm início
Veja Também
• Criar um objeto de conexão no OmniOut
• OmniOut
Criar um objeto de conexão no OmniOut

Envie e receba dados de e para o Salesforce criando um objeto de conexão. Um objeto de conexão deve estar
presente para cada tipo de conexão, inclusive quando um proxy estiver presente. O objeto de conexão expõe a
URL da instância, o namespace e a função de solicitação.
Se o seu projeto OmniOut tiver OmniScripts nele, você deve criar um manipulador de eventos para passar o
objeto de conexão depois de receber o OmniOut evento omnioutcomponentready . Siga as instruções nesta
página.
Se o seu projeto OmniOut tiver apenas FlexCards , use o método initializeDatasourceSdk para conectar seu
aplicativo. Consulte Criar um objeto de conexão no OmniOut for FlexCards .
Os modelos nesta página são exemplos que os desenvolvedores podem usar como material de referência ao
criar uma conexão.
NOTA
O processo de conexão é exclusivo para cada aplicativo e deve ser feito fora do escopo do
OmniOut .
Antes de começar
Adicione o projeto OmniOut ao seu aplicativo. Consulte Mover OmniOut para seu
aplicativo .
1. Crie um manipulador de eventos. Manipulador de eventos de exemplo
/**
* Uma vez que o componente está pronto, um evento é despachado para informar ao DOM que uma
conexão é esperada.
**/
document.addEventListener (' omnioutcomponentready ', evt => { if ( evt.detail &&
evt.detail.omnioutcomponent ) { evt.srcElement.connection = new
YourOmniOutConnection ( );
}

company
});
2. Crie um objeto de conexão .
Objeto de conexão de exemplo
função Exemplo de Conexão Base () {

/**
* Expor a solicitar método
**/
this.request = request ;
/**
* @ type {string} O namespace do pacote
**/
this.namespace = '';
/**
* @ type {string} O URL da instância de sua organização
**/
this.instanceUrl = ' ';
/** * Uma função que executa as solicitações HTTP.

* @ type {string} O URL de destino.
* @ type {Object} Os dados que são enviados para a URL de destino.
* @ retorna {Promise} Uma promessa com o
**/
pedido de função ( url , dados) {
return connection.requestPost ( url , data );
}
}
3. Configure opções de conexão adicionais fora do OmniOut .
Veja Também
• OmniOut
Criar um objeto de conexão no OmniOut for FlexCards
Envie e receba dados de e para o Salesforce criando um objeto de conexão. Um objeto de conexão deve estar
presente para cada tipo de conexão, inclusive quando um proxy estiver presente. O objeto de conexão expõe a
URL da instância, o namespace e a função de solicitação.
Se o seu projeto OmniOut tiver apenas OmniScripts , ou OmniScripts e FlexCards , crie um manipulador de
eventos para passar o objeto de conexão após receber o OmniOut evento omnioutcomponentready .
Consulte Criar um objeto de conexão no OmniOut .
Se seu projeto OmniOut tiver FlexCards , você deve usar o método initializeDatasourceSdk para conectar seu
aplicativo. Siga as instruções nesta página.
O modelo nesta página é um exemplo que os desenvolvedores podem usar como material de referência
ao criar uma conexão.
company
NOTA
O processo de conexão é exclusivo para cada aplicativo e deve ser feito fora do escopo do
OmniOut .
Antes de começar
Adicione o projeto OmniOut ao seu aplicativo. Consulte Mover OmniOut para seu
aplicativo .
1. No arquivo ./src /index.js , crie um objeto de
conexão: Exemplo de objeto de conexão
setConnection (); função setConnection () {
const connection = new jsforce.Connection ({ instanceUrl :

'https://login.salesforce.com', proxyUrl : 'https://acme-
proxy.herokuapp.com/proxy',
});
const username = 'username@website.com'; const senha =
'senha987 ';
connection.login (nome de usuário, senha, (err, userInfo ) => {
se (erro) {
return console.error (err );
} });
connection.namespace = "acme ";
initializeDatasourceSdk ({ jsforceConnection : connection,
instanceUrl : "https://login.salesforce.com",
namespace: "acme" } );
}
2. Configure opções de conexão adicionais fora do OmniOut .
Veja Também
• OmniOut

company
Um DataRaptor é uma ferramenta de mapeamento que permite ler, transformar e gravar dados do Salesforce.
Existem quatro tipos de DataRaptor : Turbo Extract, Extract, Transform e Load.
OmniStudio DataRaptors
• Extração Turbo : leia dados de um único tipo de objeto do Salesforce, com suporte para campos de objetos
relacionados. Em seguida, selecione os campos a serem incluídos. Fórmulas e mapeamentos de campos
complexos não são suportados. Ver Visão geral do DataRaptor Turbo Extract .
• Extrair : leia dados de objetos do Salesforce e produza JSON ou XML com mapeamentos de campos
complexos. Fórmulas são suportadas . Ver DataRaptor Extrair Visão Geral .
• Transformar : execute transformações de dados intermediárias sem ler ou gravar no Salesforce. Fórmulas
são suportadas . Ver DataRaptor Visão geral da transformação .
• Carregar : atualize os dados do Salesforce a partir da entrada JSON ou XML. Fórmulas são suportadas.
Consulte Visão geral do carregamento do DataRaptor .
Os DataRaptors normalmente fornecem dados para OmniScripts , Integration Procedures e Cards e gravam
atualizações de OmniScripts , Integration Procedures e Cards para o Salesforce. Um fluxo de dados típico é o
seguinte:
1. O OmniScript chama o DataRaptor Extract para ler dados do Salesforce.

2. O OmniScript interage com o usuário para capturar dados novos e alterados.
3. O OmniScript chama o DataRaptor Load para gravar dados de volta no Salesforce.
Ambos Extract e Load DataRaptors podem lidar com formatos de dados personalizados . DataRaptors podem
acessar objetos externos e metadados personalizados, bem como sObjects . Nenhum especial sintaxe ou
adicional configuração é necessário .
NOTA
Embora as classes do Apex possam ler, gravar e transformar dados, elas demoram mais para serem
criadas e são mais difíceis de manter do que DataRaptors . Portanto , o uso de DataRaptors é o
melhor prática .
Visão geral do DataRaptor Turbo Extract

Um DataRaptor Turbo Extract recupera dados de um único tipo de objeto do Salesforce, com suporte para
campos de objetos relacionados. Você pode filtrar os dados e selecionar os campos a serem retornados. Ao
contrário de um DataRaptor Extract padrão, um DataRaptor Turbo Extract não suporta fórmulas. Não há guia
Saída, portanto, você não pode usar mapeamentos para estruturar a saída. JSON personalizado, valores
padrão e traduções não são compatíveis.
Um DataRaptor Turbo Extract tem duas vantagens sobre um DataRaptor Extract padrão:
• Mais simples configuração

• Melhor desempenho em tempo de execução
Criar uma extração do DataRaptor Turbo
Para criar um DataRaptor Turbo Extract, especifique seu nome, tipos de entrada e saída e permissões.
1. Acesse o OmniStudio guia DataRaptor e clique em Novo . A caixa de diálogo Criar interface
do DataRaptor é exibida.

company
2. Especifique as definições de configuração da seguinte forma:
• DataRaptor Interface Name : Nome descritivo, exibido no OmniStudio Lista de DataRaptors da guia
DataRaptor .
• Tipo de Interface : Extração Turbo
• Tipo de entrada : JSON (para OmniScripts ), XML ou personalizado
• Tipo de saída : JSON (para OmniScripts ) ou personalizado
• Permissão necessária (opcional) : especifica uma lista opcional separada por vírgulas de
Nomes de permissão. Para executar este DataRaptor , um usuário deve ter uma dessas permissões. Se
essa configuração estiver em branco, qualquer usuário poderá executar este DataRaptor , a menos que
um DefaultRequiredPermission seja definido.
Se especificada, essa configuração substitui a configuração DefaultRequiredPermission , que fornece
um padrão se nenhum valor de Permissões necessárias for definido. Consulte Segurança para
DataRaptors e procedimentos de integração . Permissões personalizadas para usuários são definidas
em Perfis do Salesforce ou conjuntos de permissões .
• Descrição : Visão geral opcional de alto nível do DataRaptor .
3. Clique em Salvar . A página do designer é exibida.
Configurar uma extração do DataRaptor Turbo

Para configurar um DataRaptor Turbo Extract, especifique o tipo de objeto, filtros, campos a serem extraídos e
opções.
1. Na guia Extrair, no campo superior, selecione o tipo de objeto do Salesforce de origem, por exemplo,
Contato.
2. No próximo campo, especifique o Caminho de Saída da Extração .
Esse valor geralmente é o mesmo que o nome do objeto de origem. Ele especifica o nó JSON de nível
superior na saída.
3. Especifique pelo menos um Filter , que determina os dados a serem lidos. O item à esquerda é um campo
do tipo de objeto de origem. O item no meio é um operador de comparação. O item à direita pode ser um
valor literal citado, um parâmetro de entrada ou outro campo do mesmo objeto de origem. Para filtrar
valores nulos, use a variável $ Vlocity.NULL .
Você pode usar campos em objetos relacionados em filtros, como Parent.Name , mas precisa inseri-los
manualmente. Para obter detalhes sobre a notação, consulte Notação de relacionamento versus várias
etapas de extração . O filtro mais básico é Id = Id , que define o Id do objeto para um parâmetro de
entrada chamado Id.
Os operadores INCLUDES e EXCLUDES aplicam-se apenas a campos de lista de opções de seleção múltipla.
Consulte Consultar listas de opções de seleção múltipla na Ajuda do Salesforce.
Turbo têm uma opção de operador que nenhum outro DataRaptors tem: IN. O operador IN permite que
você corresponda valores a itens em uma matriz. Por exemplo, se o filtro for LastName IN Names e a
entrada JSON for {"Names": ["Miller", "Torres"]} , os registros com Miller ou Torres em seus campos
LastName serão recuperados.
Para baixar um DataPack deste exemplo, clique aqui .
4. Defina as configurações de filtro adicionais opcionais clicando na seta para baixo à direita do primeiro
filtro:
• AND - Adicione outro filtro e especifique que ambos os filtros devem ser verdadeiros.
• OU - Adicione outro filtro e especifique que qualquer um dos filtros pode ser verdadeiro.
• LIMIT - Especifique o número máximo de registros retornados. Permitido os valores são de 1 a 2000.

company
Para obter mais informações, consulte Solução alternativa para limite de deslocamento 2000 na
consulta SOQL na base de conhecimento do Salesforce.
• OFFSET - Use com LIMIT para especificar o primeiro registro em uma página em uma recuperação de
várias páginas. Por exemplo, um LIMIT de 5 requer valores OFFSET de 0, 5, 10 e assim por diante.
• ORDER BY - Ordenar os resultados pelo campo especificado. Para classificar por vários campos,
especifique uma lista separada por vírgulas de nomes de campo em ordem de precedência, por
exemplo LastName,FirstName .
Opcionalmente, você pode especificar ASC ou DESC para uma classificação crescente ou decrescente.
Você pode opcionalmente especificar NULLS FIRST ou NULLS LAST para colocar valores em branco no
início ou no final. Por exemplo, você pode classificar as contas pelo número de funcionários, listando as
empresas de tamanho desconhecido primeiro e os maiores empregadores por último. Especificamos a
ORDENAR POR valor NumberOfEmployees ASC NULLS FIRST .
5. Selecione os campos a serem extraídos movendo-os da lista da esquerda para a lista da direita. Você
pode inserir um valor de pesquisa para filtrar a lista à esquerda. O campo Id é sempre incluído na saída.
Para selecionar campos em objetos relacionados, consulte a próxima seção.
6. Defina as configurações adicionais opcionais na guia Opções:
• Check Field Level Security : Verifica as permissões de acesso do usuário para os campos antes de
executar o DataRaptor . A ativação dessa configuração desativa o Cache da organização, mas não o
Cache de sessão.
• Tempo de vida em minutos : Se o cache de dados estiver ativado, determina quanto tempo os dados
permanecem no cache. O mínimo valor é 5.
• Tipo de cache da plataforma Salesforce : habilita o armazenamento em cache de dados. Defina como
Cache de sessão para dados relacionados a usuários e suas sessões de login ou como Cache de
organização para todos os outros tipos de dados. Ver Cache para DataRaptors e Procedimentos de
Integração .
7. Para observar os efeitos do cache ao testar o DataRaptor Turbo Extract, vá para a guia Preview e
desmarque a caixa de seleção Ignore Cache . Ver Cache para DataRaptors e Procedimentos de Integração
.
Campos de objetos relacionados em extrações do DataRaptor Turbo

Embora um DataRaptor Turbo Extract seja recuperado de um único tipo de objeto, você pode selecionar
campos específicos em objetos relacionados.
Para obter mais informações sobre nomes de relacionamento e outros tópicos relevantes, consulte Consultas
de relacionamento na Ajuda do Salesforce. Os DataRaptors suportam apenas consultas de relacionamento
filho-pai.
Quando você clica na lista suspensa Objetos Relacionados, os relacionamentos com outros objetos aparecem,
por exemplo:

company
Se você selecionar um desses relacionamentos e clicar na lista novamente, os relacionamentos de segundo
nível com outros objetos serão exibidos, por exemplo:
Você pode percorrer até cinco níveis de relacionamento.
Para fazer backup de um nível, clique na lista e selecione o nível anterior, por exemplo:
Depois de selecionar um relacionamento com outro objeto, os campos desse objeto aparecem na lista de
seleção de campo à esquerda. Você pode inserir um valor de pesquisa e mover os campos para a lista à direita
como faria com os campos do objeto base.

company
Testar uma extração do DataRaptor Turbo
Você pode testar a entrada e a saída de um DataRaptor Turbo Extract na guia Preview.
1. Vá para a guia Visualizar.

2. Especifique os pares de chave/valor no painel Parâmetros de entrada.
Como alternativa, você pode clicar em Editar como JSON e especificar a entrada no formato JSON.
3. Para observar os efeitos do armazenamento em cache ao testar o DataRaptor Turbo Extract, desmarque a
caixa de seleção Ignore Cache . Ver Cache para DataRaptors e Procedimentos de Integração .
4. Clique em Executar .
O painel Resposta exibe os dados resultantes e o painel Log de depuração exibe os resultados das consultas do
Salesforce emitidas pelo DataRaptor .
Por exemplo, se o DataRaptor filtrar contas com base em um ID, um par de chave/valor como esse permite
testar o DataRaptor usando um ID de conta específico.
Criar um exemplo de extração do DataRaptor Turbo

Um DataRaptor Turbo Extract recupera os contatos de uma conta com o ID especificado.
Para crio isto exemplo :

1. No OmniStudio guia DataRaptor , clique em Novo .
2. Especifique um nome de interface do DataRaptor .
3. Especifique um tipo de interface de Turbo Extract .

company
4. Clique em Salvar . A página do designer é exibida.
5. Especifique Contato como o objeto do Salesforce e o Caminho de saída da extração .
6. Para o Filtro, especifique AccountId = AccountId .
7. Insira Nome no campo de pesquisa e mova FirstName e LastName para a lista à direita.
8. Vá para a guia Visualizar. Se você vir um link Editar como parâmetros , clique nele.

company
9. Clique em Adicionar novo par de chave/valor . Especifique AccountId como a chave e um ID de conta de
sua organização como o valor .
10. Clique em Executar . Observe que FirstName, LastName e Id são recuperados para cada contato.
Visão geral da extração do DataRaptor

As extrações do DataRaptor leem dados do Salesforce e retornam resultados em JSON, XML ou formatos
personalizados. Você pode filtrar os dados e selecionar os campos a serem retornados. Fórmulas, valores
padrão e traduções são suportados.
normalmente fornecem OmniScripts , Procedimentos de Integração e Cartões com os dados de que
necessitam.
Para definir um DataRaptor extrair :
1. Crie a extração do DataRaptor . Consulte Criando uma extração do DataRaptor

2. Configure a extração inicial. Consulte Definir a extração inicial .
3. Determine se você precisa de várias etapas de extração ou notação de relacionamento. Consulte Quando
usar várias etapas de extração e notação de relacionamento versus várias etapas de extração .
4. (Opcional) Adicione dados usando fórmulas. Consulte Usar Fórmulas em DataRaptors .
5. Componha a saída. Consulte Definindo a saída de uma extração .
6. Teste o DataRaptor . Consulte Testar uma extração do DataRaptor .
Criar uma extração do DataRaptor

Para criar uma extração do DataRaptor , especifique seu nome, tipos de entrada e saída e permissões.
1. Acesse o OmniStudio guia DataRaptor e clique em Novo . A caixa de diálogo Criar: Interface do
DataRaptor é exibida.
2. Especificamos configurações de configuração:
DataRaptor .
• Tipo de interface : Extrair
• Tipo de saída : JSON (para OmniScripts ), XML ou personalizado
• Permissão necessária : especifica uma lista opcional separada por vírgulas de nomes de permissões
personalizadas. Para executar este DataRaptor , um usuário deve ter uma dessas permissões. Se essa
configuração estiver em branco, qualquer usuário poderá executar este DataRaptor , a menos que um
DefaultRequiredPermission seja definido.

company
DataRaptors e procedimentos de integração .
Permissões personalizadas para usuários são definidas em Perfis ou Conjuntos de permissões do
Salesforce .
Quando um procedimento de integração chama um DataRaptor , a configuração de permissão
necessária do procedimento de integração substitui a configuração de permissão necessária do
DataRaptor .
3. Clique em Salvar . A guia Extrair da página do designer é exibida.
Qual é o próximo
Definir a extração inicial
Definir a extração inicial

Na guia Extrair , você especifica os objetos do Salesforce a serem consultados e os filtros que determinam os
dados a serem retornados do objeto. Você também pode especificar um limite e deslocamento para paginação
ou um campo no qual classificar.
Para cada fonte objeto :
1. Clique em Adicionar etapa de extração e escolha o objeto de origem na lista suspensa de objetos.
2. Defina as configurações para o objeto de origem:
• Extract Output Path : o nó de nível superior na etapa de extração JSON onde você deseja que os dados
residam.
Prática recomendada : quando possível, nomeie o Caminho de saída da extração para o objeto do
Salesforce que é sua fonte de dados. Isso define o primeiro nó dos valores do campo Extract JSON Path
na guia Output.
• Filtro : A comparação usada para determinar quais dados devem ser lidos. O item à esquerda é um
campo do objeto de origem. O item no meio é um operador de comparação. O item à direita pode ser
um valor literal citado, um parâmetro de entrada, outro campo do mesmo objeto de origem ou um
campo de um objeto de origem em uma etapa de extração anterior. Para filtrar valores nulos, use a
variável $ Vlocity.NULL . Você pode usar campos em objetos relacionados em filtros, como
Parent.Name , mas precisa inseri-los manualmente. Para obter detalhes sobre a notação, consulte
Notação de relacionamento versus várias etapas de extração .
O filtro mais básico é Id = Id , que define o Id do objeto para um parâmetro de entrada chamado Id.
Os operadores INCLUDES e EXCLUDES aplicam-se apenas a campos de lista de opções de seleção
múltipla. Ver Consulta Seleção múltipla Listas de opções na ajuda do Salesforce.
3. Defina as configurações de filtro adicionais opcionais clicando na seta para baixo à direita do primeiro
filtro:
• AND : Adicione um filtro adicional e especifique que ambos os filtros devem ser verdadeiros.
• OU : Adicione um filtro adicional e especifique que qualquer um dos filtros pode ser verdadeiro.
• LIMIT : Especifique o número máximo de registros retornados. Permitido os valores são de 1 a 2000.
Para obter mais informações, consulte Solução alternativa para limite de deslocamento 2000 na
consulta SOQL na base de conhecimento do Salesforce.
• OFFSET : Use com LIMIT para especificar o primeiro registro em uma página em uma recuperação de
várias páginas. Por exemplo, se o LIMIT for 5, os valores OFFSET para páginas sucessivas seriam 0, 5, 10
e assim por diante.

company
• ORDER BY : Ordenar os resultados pelo campo especificado. Para classificar por vários campos,
especifique uma lista separada por vírgulas de nomes de campo em ordem de precedência, por
exemplo LastName,FirstName .
Opcionalmente, você pode especificar ASC ou DESC para uma classificação crescente ou decrescente.
Você pode opcionalmente especificar NULLS FIRST ou NULLS LAST para colocar valores em branco no
início ou no final. Por exemplo, para classificar Contas pelo número de funcionários, listando as
empresas de tamanho desconhecido primeiro e os maiores empregadores por último, especifique o
valor ORDER BY NumberOfEmployees ASC NULLS FIRST .
NOTA
Se você precisar implementar a lógica de paginação para seu aplicativo, poderá usar a
configuração de filtro OFFSET para especificar onde a recuperação do registro começa. Escolha
OFFSET na lista suspensa e especifique o nome de um nó na carga útil de entrada onde o
chamador mantém o deslocamento. O deslocamento deve ser um número inteiro. Observe que
o Salesforce impõe um
Limite de 2.000 registros em consultas. Para obter detalhes, consulte a documentação do
Salesforce OFFSET.
Qual é o próximo
Quando usar várias etapas de extração
Quando usar várias etapas de extração

A quantidade de etapas de extração necessárias depende de como os tipos de objeto dos quais você está
extraindo estão relacionados. Existem três cenários básicos: único, único com notação de relacionamento e
múltiplo.
1. A extração de dados de um único tipo de objeto, por exemplo, Casos, requer apenas uma etapa de
extração.
2. A extração de dados de um objeto primário e um ou mais objetos pai também requer apenas uma etapa
de extração. Um exemplo é extrair casos com alguns dados de conta para cada caso. Ver Relação Notação
versus Múltiplo Extrair Passos .
3. A extração de dados de um objeto primário e um ou mais objetos filho requer pelo menos duas etapas de
extração, uma para cada tipo de objeto. Um exemplo é extrair uma conta e todos os casos associados a
essa conta.
Por exemplo, para encontrar Casos por Número de Caso, você pode usar um filtro como CaseNumber =
Number na etapa de extração:
Os objetos são consultados na ordem em que você os especifica nas etapas de extração, o que é importante
para o terceiro cenário, quando você precisa usar dados de um objeto lido anteriormente para filtrar um
objeto subsequente.
Por exemplo, para encontrar todos os casos associados a uma conta específica, você pode ler a conta
com um filtro básico como Id = Id na primeira etapa de extração e ler os casos com um filtro como

company
AccountId = Acct:Id no segunda etapa de extração. (O AccountId é um campo Case; o Acct:Id é uma referência
ao campo Id da conta.)
Esses dados são lidos no JSON da etapa de extração e o painel JSON da etapa de extração à direita mostra a
hierarquia de nível superior definida pelos caminhos de saída que você especifica nesta guia.
Por padrão, se um valor for nulo, nenhum nó será criado para o campo no JSON de saída. Para garantir que um
nó seja criado, independentemente de o campo ser nulo, vá para a guia Options e marque Overwrite Target
For All Null Inputs .
Qual é o próximo
Notação de relacionamento versus várias etapas de extração
Notação de relacionamento versus várias etapas de extração

O uso de notação de relacionamento melhora o desempenho de DataRaptors que recuperam dados de um pai
do sObject primário . Você usa essa notação nos caminhos JSON de extração para os campos do sObject pai
em vez de adicionar um segundo sObject na guia Extrair do DataRaptor . Dois exemplos ilustram como usar a
notação de relacionamento.
notação de relacionamento no DataRaptors é baseada em consultas de relacionamento no Salesforce. Para

obter mais informações sobre nomes de relacionamento e outros tópicos relevantes, consulte Consultas de
relacionamento na ajuda do Salesforce. Os DataRaptors suportam apenas consultas de relacionamento filho-
pai.
Suponha que você queira recuperar dados de contato que incluam o nome da conta à qual o contato está
associado. (Account é um objeto pai de Contact.) Você pode usar várias etapas de extração ou notação de
relacionamento.
Para usar várias etapas de extração, primeiro defina as etapas de extração para os objetos Contato e Conta na
guia Extrair do DataRaptor .

company
Em seguida, defina Extract JSON Paths para os campos Contact e Account na guia Output do DataRaptor .
Para usar a notação de relacionamento, primeiro defina uma etapa de extração para o objeto Contact na guia
Extrair do DataRaptor .
Em seguida, defina os caminhos JSON de extração para os campos Contato e Conta na guia Saída do
DataRaptor .

company
Para baixar DataPacks desses exemplos, clique aqui e aqui .
Observe que o Extract JSON Path para o campo Name do objeto Account é Account.Name . Conta é o nome do
relacionamento que o objeto Contato tem com o objeto Conta pai. O nome do relacionamento é diferente do
nome do campo que faz referência ao objeto pai, que é AccountId . A maioria dos nomes de relacionamento
para objetos padrão segue essa convenção e omite o sufixo Id.
Se você fornecer um ID de contato na guia Visualização, obterá a mesma resposta para esse contato para
ambos os DataRaptors :
{
" CompanyName ": "Acme",
" Sobrenome ": "Tomlin",
"Nome": "Leanne"
}
No entanto, se você olhar no Debug Log, verá duas consultas SOQL para o DataRaptor que usa várias etapas de
extração:
SELECT id, accountid , firstname , lastname , name FROM Contact WHERE (Id =
'0031U00000HUob9QAD')
SELECT id, nome FROM Account WHERE (Id = '0011U00000KbYZAQA3')
Você vê apenas uma consulta SOQL para o DataRaptor que usa notação de relacionamento:
SELECT id, firstname , lastname , account.name FROM Contact WHERE (Id =

'0031U00000HUob9QAD')
IMPORTANTE
A execução de apenas uma consulta SOQL por objeto primário é sempre notavelmente mais rápida
do que a execução de duas. Um DataRaptor executa etapas de processamento para cada consulta
SOQL executada, e o Salesforce também contribui com sobrecarga para cada consulta SOQL. Com
uma consulta em vez de duas, você tem metade da sobrecarga.
Qual é o próximo
Definindo a saída de uma extração do DataRaptor
extração do DataRaptor
Para mapear dados do JSON da etapa de extração para o JSON de saída, acesse a guia Saída . Você também
pode manipular valores nulos, atributos, traduções, permissões em nível de campo, armazenamento em cache
e transformações de lista.
1. Clique em + . Um mapeamento vazio é adicionado à lista.

2. No campo Extract JSON Path , escolha o campo de origem da etapa de extração JSON.
3. No campo Caminho JSON de Saída , especifique o caminho de saída desejado.
O painel Saída JSON Atual exibe a estrutura que seus mapeamentos de saída especificam.
Prática recomendada : quando possível, nomeie o Caminho de saída da extração na guia Extrair para o objeto
do Salesforce que é sua fonte de dados. Isso define o primeiro nó dos valores do campo Extract JSON
Path .
company
Você pode melhorar o desempenho do DataRaptor para alguns casos de uso usando a notação de
relacionamento no campo Extract JSON Path . Consulte Notação de relacionamento versus várias etapas de
extração .
Você também pode usar fórmulas para adicionar dados de saída. Para obter detalhes, consulte Usar Fórmulas
no DataRaptors e Referência de Função .
Correspondência rápida para mapas de saída

Para fazer a correspondência em massa, clique no botão Quick Match . Na caixa de diálogo Quick Match , você
pode mapear campos da seguinte forma:
• Arrastar e soltar: Arraste o campo sObject de origem da coluna esquerda para o campo de saída de destino
na coluna do meio ou vice-versa. Para uma saída que não tenha um campo sObject de origem , arraste o
mapeamento de saída para a coluna Mapeamentos correspondentes .
• Pair: Selecione um campo de entrada e um campo de saída e clique em Pair .
• Correspondência automática: clique em Correspondência automática . Os campos com nomes
correspondentes são correspondidos automaticamente.
coluna Mapeamentos correspondentes à direita .
Para redefinir valores depois de lidos no Salesforce, vá para Transform Map Values seção e adicione pares de
chave/valor que especificam os valores de entrada e saída. Por exemplo, para transformar um valor de
entrada de TRUE em um valor de saída de Y (para sim), especifique KEY = TRUE e VALUE = Y.
GORJETA
Para facilitar o mapeamento de um grande número de campos, cole o JSON de dados do
OmniScript ou do Procedimento de Integração de chamada no painel Saída JSON Esperada , que
preenche a lista de caminhos no campo Caminho JSON de Saída.
Valores Nulos
Para especificar um valor a ser gerado quando o campo for nulo, defina a propriedade Valor Padrão . Para
substituir o tipo de dados padrão, especifique Tipo de dados de saída . Para evitar a perda de dados, escolha
tipos de dados compatíveis.
Por exemplo, se um valor de texto sempre contiver dados numéricos, um tipo de saída numérico será
adequado. Se ele pode conter caracteres alfabéticos, você deve escolher um tipo de dados de saída textual.
Se o DataRaptor Extract não recuperar nenhum registro, um JSON vazio, {} , será retornado.
Dados JSON em campos

Alguns campos contêm dados JSON. Para mapear esses dados, use a notação padrão no Extract JSON Path ,
por exemplo:
Objeto:JsonField __ c:JsonNode:ChildJsonNode
Traduções

company
Para configurar o DataRaptor para recuperar os dados do Produto traduzidos, vá para a guia Opções e marque
Usar traduções .
Quando esta opção está habilitada, o DataRaptor retorna as traduções de strings para a localidade do usuário.
Se nenhuma tradução de string for definida para a localidade, os dados do produto definidos no idioma base
serão retornados. Por exemplo, se os dados do produto base forem inseridos em inglês e nenhuma tradução
de string em francês for definida, os usuários com localidade em francês verão os dados do produto em inglês.
Permissões, cache e outras opções

Você pode definir configurações opcionais adicionais na guia Opções.
• Check Field Level Security : Verifica as permissões de acesso do usuário para os campos antes de executar o
DataRaptor . A ativação dessa configuração desativa o Cache da organização, mas não o Cache de sessão.
• Substituir destino para todas as entradas nulas : Garante que um nó de saída seja criado
independentemente de um campo ser nulo.
• Use Translations : configura um DataRaptor para recuperar os dados do produto traduzidos.
• Tipo de cache da plataforma Salesforce : habilita o armazenamento em cache de dados. Defina como Cache
de sessão para dados relacionados a usuários e suas sessões de login ou como Cache de organização para
todos os outros tipos de dados. Ver Cache para DataRaptors e Procedimentos de Integração .
Listar mapas
Para mapear dados em uma lista na saída, use o comando listname | # sintaxe.
O nome da lista especifica a chave do nó de saída e o # especifica a posição na lista onde a saída reside.
Observe o separador de símbolo de barra vertical ( | ). O exemplo a seguir ilustra como mapear um conjunto
simples de nós de entrada para uma lista de saída.
Insira JSON Mapeamentos JSON de saída
{ Thing1中 Thinglist|1 { " Lista de coisas

"Coisa1": "1", Thing2中 Thinglist|2 ":
"Coisa2": "2", "Coisa3": Thing3中 Thinglist|3 [ "1", "2", "3" ]
"3" }
}
Para obter mais informações sobre listas no DataRaptors , consulte List Input for DataRaptors .
Qual é o próximo
Testar uma extração do DataRaptor
Testar uma extração do DataRaptor

Você pode testar a entrada e a saída de uma extração do DataRaptor na guia Visualizar.

2. Especifique os pares de chave/valor no painel Parâmetros de entrada.
Como alternativa, você pode clicar em Editar como JSON e especificar a entrada no formato JSON.
3. Para observar os efeitos do armazenamento em cache ao testar o DataRaptor Extract, desmarque a caixa
de seleção Ignore Cache . Ver Cache para DataRaptors e Procedimentos de Integração .

company
O painel Resposta exibe os dados resultantes e o painel Log de depuração exibe os resultados das consultas do
Salesforce emitidas pelo DataRaptor .
Por exemplo, se o DataRaptor filtrar contas com base em um ID fornecido por um OmniScript , um par de
chave/valor como o seguinte permitirá que você teste o DataRaptor usando um ID de conta específico.
Exemplos de extração do DataRaptor

do DataRaptor demonstram relacionamentos de objetos, paginação com valores de dados, paginação com
deslocamentos e notação de relacionamento.
Para obter exemplos adicionais que mostram como você pode melhorar o desempenho do DataRaptor para
alguns casos de uso usando notação de relacionamento, consulte Notação de relacionamento versus várias
etapas de extração .
Criar um exemplo básico de extração do DataRaptor

Uma extração do DataRaptor aceita um parâmetro de ID de conta e retorna o nome da conta.
1. Na guia Extrair, clique em Adicionar etapa de extração .

2. Na lista de objetos do Salesforce, escolha Conta .
3. Defina o caminho de saída de extração como Account e o filtro como Id = InputId .
4. Na guia Saída, clique em + .
5. Defina o caminho JSON de extração para Account:Name .
6. Defina o caminho JSON de saída para Account:Name .
8. No painel Parâmetros de entrada, clique em Adicionar novo par de chave/valor .
9. Defina a chave como InputId e o valor como um ID de objeto de conta do Salesforce válido (que se
parece com isso: 0016100001OBpRi ).
11. Verifique se o painel Resposta exibe uma estrutura JSON contendo a saída desejada. Por exemplo :
{
" Conta ": {
" Nome " "Smith Incorporated "
}
}
Extrair dados de três objetos relacionados

Crie uma extração do DataRaptor para uso por um OmniScript de manipulação de casos . Os agentes que lidam
com Casos podem pesquisar uma conta, listar todos os casos para a conta e localizar o contato de cada caso.

company
NOTA
Neste exemplo, é especialmente importante especificar a hierarquia de objetos completa nos
valores Extract Output Path , filter e Extract JSON Path . Contas e Contatos estão diretamente
relacionados e relacionados por meio de Casos. Este exemplo usa o último relacionamento. A
hierarquia de objetos informa ao DataRaptor qual relacionamento usar.
Para criar esta extração do DataRaptor :
1. Vá para o OmniStudio guia DataRaptor e clique em Novo . A caixa de diálogo Criar é exibida.
2. Especifique um nome para o DataRaptor e defina suas configurações:
• Tipo de interface — Extrair
• Tipo de entrada — JSON
• Tipo de saída — JSON
3. Clique em Salvar . A página Interface do DataRaptor é exibida.
4. Na guia Extrair, adicione três etapas de extração:
Objeto Extrair caminho de saída Filtro
Conta Conta Id = AccountId
Caso Conta: Caso AccountId = Conta:Id
Contato Conta: Caso: Contato Id = Conta:Caso:ContactId
5. Na guia Saída, mapeie os campos do JSON da Etapa de Extração para o JSON de Saída. Para adicionar um
mapeamento, clique no botão + . Adicione quatro mapeamentos:
Extrair caminho JSON Caminho JSON de saída
Nome da conta Nome da conta
Account:Case:CaseNumber Account:Case:CaseNumber
Conta: Caso: Assunto Conta: Caso: Assunto
Conta:Caso:Contato:Nome Conta:Caso:Contato:Nome
6. Verifique se a estrutura exibida no painel Saída JSON Atual tem esta aparência:
{
"Conta": {
"Caso": {
" CaseNumber ": "Texto",
"Contato": {
"Nome": "Texto"
},
"Assunto": "Texto"
},
"Nome": "Texto"
}
}
A ordem dos campos não é importante, mas a estrutura é.

8. No painel Parâmetros de entrada, especifique uma Chave de AccountId e um Valor de um ID,
como 0015e000003XlkMAAS .
company
9. Clique em Executar . Supondo que a conta tenha casos associados, a resposta será assim:
{
"Conta": {
"Caso": [
{
"Contato": {
"Nome": "Edward Stamos"
},
"Assunto": "Não é possível rastrear nosso pedido",
" CaseNumber ": "00001004"
},
{
"Contato": {
"Nome": "Leanne Tomlin"
},
"Assunto": "Widgets de tamanho errado",
" CaseNumber ": "00001003"
},
{
"Contato": {
"Nome": "Jeff Hunt"
},
"Assunto": "Atualizar número de telefone da conta",
" CaseNumber ": "00001005"
},
{
"Contato": {
"Nome": "Edward Stamos"
},
"Assunto": "Status do faturamento",
" CaseNumber ": "00001006"
}
],
"Nome": "Acme"
}
}
Página por meio de dados classificados usando valores de dados

Se for esperado que uma extração do DataRaptor recupere muitos registros, você poderá usar a paginação
para recuperar alguns de cada vez com base nos valores do campo. Por exemplo, você pode percorrer Contas
por ID.
Para configurar a paginação com base em valores de campo:
• Use a configuração ORDER BY para classificar os dados com base em um campo específico.
• Use a configuração LIMIT para especificar quantos registros serão recuperados por vez.
• Depois de recuperar cada conjunto de registros, use o valor do campo de classificação do último
registro recuperado para recuperar o próximo conjunto.
company
2. Especifique um nome para o DataRaptor e defina suas configurações da seguinte forma:
• Tipo de saída : JSON
4. Na guia Extrair, especifique Account como o objeto e Id > lastAccountId como o filtro. Use a seta para
baixo à direita para adicionar Id como o campo ORDER BY e um valor LIMIT de 2.
5. Na guia Saída, mapeie os campos Id e Name conforme mostrado.
7. No painel Parâmetros de entrada, clique em Adicionar novo par de chave/valor . Insira lastAccountId
como a Chave e 001000000000000 como o Valor . Clique em Executar .
A primeira página dos registros da conta é recuperada.

8. Copie o valor de Id do segundo registro no campo Resposta ao Valor no painel Parâmetros de Entrada e
clique em Executar novamente.

company
A segunda página dos registros da conta é recuperada. Repita esta etapa para recuperar a próxima
página.
Página por meio de dados classificados usando deslocamentos

Se for esperado que uma extração do DataRaptor recupere muitos registros, você pode usar a paginação para
recuperar alguns de cada vez com base nos valores OFFSET. Por exemplo, você pode percorrer os Contatos
pelo sobrenome.
Para configurar a paginação com base nos valores OFFSET:
• Use a configuração LIMIT para especificar quantos registros serão recuperados por vez.
• Use a configuração OFFSET para especificar um múltiplo do valor LIMIT.
• Opcional, mas recomendado para resultados previsíveis: use a configuração ORDER BY para classificar os
dados com base em um campo específico.
4. Na guia Extrair, especifique Contato como o objeto e DoNotCall = "false" como o filtro. Use a seta para
baixo à direita para adicionar LastName como o campo ORDER BY, um valor LIMIT de 3 e um valor OFFSET
de AfterRecord .

company
5. Na guia Saída, mapeie os campos de nome e telefone conforme mostrado.
7. No painel Parâmetros de entrada, clique em Adicionar novo par de chave/valor . Insira AfterRecord
como a chave e 0 (zero) como o valor . Clique em Executar .

company
A primeira página dos registros de contato é recuperada.
8. Altere o valor AfterRecord para 3 e clique em Executar novamente.
A segunda página dos registros de contato é recuperada. Repita esta etapa, incrementando o
AfterRecord valor por 3 de cada vez, para recuperar as páginas restantes.

company
Extrair vários níveis de relacionamento e valores de campo personalizados
Suponha que você queira recuperar os dados do contrato que incluem a versão (pai) e o nome do usuário
(avô) que criou o contrato. Você pode usar a notação de relacionamento com campos personalizados.
Você pode percorrer até cinco níveis de relacionamentos usando a notação de relacionamento. Por exemplo, a
sintaxe para subir dois níveis é parent . avô . campo , e para três níveis, pai . avô . bisavô . campo .
Para campos personalizados, o nome do relacionamento corresponde ao nome do campo que faz referência
ao objeto pai, exceto que o nome do relacionamento termina com __r em vez de __c .
Para usar relacionamento notação :
1. Defina uma etapa de extração para o objeto Contrato na guia Extrair do DataRaptor da seguinte forma:
2. Defina os caminhos JSON de extração para os campos Número do contrato, Nome da versão do contrato
ativo e Criado por nome na guia Saída do DataRaptor da seguinte maneira:
Observe que o caminho JSON de extração para o campo Nome do objeto vlocity_ cmt __ ContractVersion
__c é vlocity_ cmt __ ActiveContractVersionId __ r.Name . O nome do relacionamento que o
O objeto de contrato tem com o pai vlocity_ cmt __ ContractVersion _ _c o objeto é vlocity_ cmt __
ActiveContractVersionId __r . O nome do relacionamento de segundo nível é CreatedBy . Dependendo
do seu setor, o namespace pode ser vlocity_cmt , vlocity_ins ou vlocity_ps .
3. Forneça um número de contrato na guia Visualizar. Você recebe uma resposta como esta:
{
"Criador": " Vlocity Admin",
"Versão": "Versão 1",
" Número ": "00000105"
}
4. Consulte a consulta SOQL no log de depuração. Parece com isto :
SELECT id, contractnumber , vlocity_cmt__activecontractversionid__r.name,

vlocity_cmt__activecontractversionid__r.createdby.name FROM Contract WHERE ( ContractNumber
= '00000105')
company
Visão geral da transformação do DataRaptor
O DataRaptor Transforms permite realizar transformações de dados intermediárias sem ler ou gravar no
Salesforce. Fórmulas são suportadas .
• Converter entrada JSON em saída XML e vice-versa

• Reestruturar dados de entrada e renomear campos
• Substituir valores em campos (todos os DataRaptors podem substituir valores)
• Converter dados em formato PDF, DocuSign ou modelo de documento
DataRaptor são essenciais para OmniScripts que devem preencher um modelo DocuSign (consulte Criando
uma interface DataRaptor para mapear um OmniScript para DocuSign ) ou preencher campos em um
documento PDF (consulte Criando uma interface DataRaptor para mapear um OmniScript para um PDF ).
Você também pode transformar dados de várias maneiras usando os componentes Definir valores em
Procedimentos de integração. Consulte Definir valores para procedimentos de integração .
Criar uma transformação do DataRaptor

Para criar um DataRaptor Transform, especifique seu nome, tipos de entrada e saída e permissões.
1. Acesse o OmniStudio guia DataRaptor e clique em Novo . A caixa de diálogo Criar: Interface do
2. Especifique as definições de configuração da seguinte forma:
DataRaptor .
• Tipo de saída : JSON (para OmniScripts ), XML, PDF, DocuSign, modelo de documento ou personalizado
Permissões personalizadas para usuários são definidas em Perfis do Salesforce ou conjuntos de
permissões .
DataRaptor .
3. Clique em Salvar . A guia Transformações da página do designer é exibida.
Qual é o próximo
Mapeamentos de dados de transformação do DataRaptor
Mapeamentos de dados de transformação do DataRaptor

Para mapear dados da entrada para a saída, vá para a guia Saída. Você também pode manipular valores
nulos, tipos de dados, armazenamento em cache e transformações de lista.
company
Você pode mapear dados na guia Transformações de duas maneiras:
• Se os nomes de entrada e saída corresponderem, use a correspondência rápida para mapear dados .
• Especificamos cada mapeamento individualmente .
Ambas as formas se aplicam à entrada e saída JSON e a outros tipos de entrada e saída.
Para especifique mapeamentos individuais:
1. Clique em + . Um mapeamento vazio é adicionado à lista.

2. No campo Caminho JSON de Entrada , especifique o caminho de entrada.
3. No campo Caminho JSON de Saída , especifique o caminho de saída desejado.
Use dois pontos para separar os níveis de caminho, por exemplo Contact:LastName .
Reestruturação e renomeação de dados

Todos os tipos de DataRaptors podem reestruturar dados e renomear campos usando mapeamentos. Para
reestruturar e/ou renomear um campo, mapeie o caminho de entrada para o caminho de saída desejado.
O exemplo a seguir mostra a entrada JSON sendo mapeada para a saída XML. Todos os campos de entrada são
renomeados.
Os campos de maiúsculas e minúsculas de entrada, que são todos campos de nível superior, são reparentados
em um nó XML denominado XCASEDETAILS. A lista de contatos permanece inalterada. Observe a diferença
entre a representação de uma lista em JSON e em XML. Para obter detalhes sobre a conversão entre JSON e
XML, consulte XML em DataRaptors .
Para os tipos de saída PDF, DocuSign e Modelo de documento, os mapeamentos de saída são gerados com
base nos campos no arquivo de saída de destino que você selecionou quando criou a Transformação
DataRaptor .
Valor de entrada para mapeamentos de valor de saída

Para verificar se seus mapeamentos criam a estrutura desejada, vá para a guia Visualizar, cole a entrada de
amostra no painel Entrada no lado esquerdo da tela e clique em Executar . Os resultados são exibidos no
painel Resposta.
Para substituir um valor por outro, abra o mapeamento e crie entradas na lista Transform Map Values. Por
exemplo, se o campo de entrada contiver VERDADEIRO ou FALSO e seu OmniScript exigir um valor S ou
N, crie as seguintes entradas:

company
Tipos de dados de saída
Na guia Saída, você pode especificar o tipo de dados dos dados de saída. Se você alterar o tipo, certifique-se de
escolher um tipo de saída compatível. (Por exemplo, alterar um tipo numérico para uma string é bom, mas
alterar uma string para um numérico é arriscado, porque uma string pode conter caracteres não numéricos.)
Consulte Tipos de dados de saída do DataRaptor .
Cache de dados
Você pode definir as configurações de cache opcionais na guia Opções:
• Tipo de cache da plataforma Salesforce : habilita o armazenamento em cache de dados. Defina como Cache
de sessão para dados relacionados a usuários e suas sessões de login ou como Cache de organização para
todos os outros tipos de dados. Ver Cache para DataRaptors e Procedimentos de Integração .
O que vem a seguir

Testar um DataRaptor Transformar
Use a correspondência rápida para mapear dados

O Quick Match é uma maneira prática de mapear dados de entrada e saída em um DataRaptor Transform
quando os nomes correspondem.
NOTA
Algumas transformações são muito complexas para Quick Match . Por exemplo, consulte Listar
entrada para DataRaptors .
1. Expanda o painel JSON de entrada e cole a estrutura de dados de entrada nele.

2. Expanda o painel Saída JSON Esperada e cole a estrutura de saída desejada nele.
3. Clique em Correspondência Rápida . A janela Quick Match é aberta.
4. Clique em Auto Match ou arraste cada Mapeamento de Entrada para o Mapeamento de Saída desejado.
Outra opção é selecionar um Mapeamento de Entrada e um Mapeamento de Saída e clicar em Par .
5. Clique em Salvar . A janela Quick Match fecha e a guia Transforms mostra os mapeamentos individuais.
6. Observe a estrutura no painel Saída JSON Atual . Certifique-se de que corresponda à estrutura no painel
Saída JSON Esperada .
XML em DataRaptors
Além do JSON, os DataRaptors podem ter entrada e saída XML. O formato XML em DataRaptors é uma
chave/valor não ordenado, estrutura semelhante a JSON.

company
Para especificar a ordem na qual os elementos da saída XML são serializados, preencha o painel Saída XML
Esperada com uma estrutura XML composta na ordem desejada. O exemplo a seguir compara estruturas
equivalentes em JSON e XML.
JSON
{
"Raiz": {
"#texto": " rootValue ",
"@attribute1": "attVal1",
"#ns": "http://namespace1",
"# ns#a ": "http://namespace2",
"Filho": [{
"@attribute2": "attval2"
},
{
"#texto": " childValue "
}
]
}
}
XML
<Root attribute1="attVal1" xmlns ="http://namespace1" xmlns:a ="http://

namespace2">
rootValue
<Child attribute2="attval2"></Child>
<Child> childValue </Child>
</Raiz>
DataRaptors que transformam XML em JSON usam as seguintes convenções para lidar com as diferenças entre
os formatos.
Descrição XML JSON
Os valores em um nó XML de entrada são convertidos <Root> rootValue </Root> {

em JSON de saída com a chave #text . "Raiz": {
"# texto ": " rootValue "
}
}
Os valores em um nó XML de entrada são <Root attribute1="attVal1"></ {
convertidos em JSON de saída com uma chave que é Raiz> "Raiz": {
precedida por uma arroba ( @ ). "@attribute1": "attVal1"
}
}
Os namespaces em um nó XML de entrada são <Raiz xmlns ="http:// namespace1" xmlns:a {
prefixados com #ns no JSON de saída. ="http:// "Raiz": {
namespace2"> "# ns":"http ://namespace1",
</Raiz> "# ns#a ":"http://namespace2,
}
}

company
Dois pontos, que são caracteres reservados em < Raiz:Dados >dados</ Raiz:Dados > {
DataRaptor , são substituídos por # . " Raiz#Dados ": {
"# texto ":"dados",
}
}
Testar um DataRaptor Transformar

Você pode testar a entrada e a saída de um DataRaptor Transform na guia Visualizar.

2. Especifique a entrada JSON ou XML no painel Entrada.
3. Para observar os efeitos do armazenamento em cache ao testar o DataRaptor Transform, desmarque a
caixa de seleção Ignore Cache . Ver Cache para DataRaptors e Procedimentos de Integração .
4. Clique em Executar . O painel Resposta exibe os dados resultantes.
Exemplos de transformação do DataRaptor

DataRaptor Transform demonstram como converter um único item em uma lista com um item e como
converter uma lista de objetos em uma lista de valores.
Para obter exemplos adicionais do DataRaptor Transform, consulte List Input for DataRaptors e Create a
DataRaptor Example with a Formula .
Converter um único item em uma lista com um item

Em alguns casos, a saída de um componente que não está em formato de lista deve passar para outro
componente que aceite apenas uma lista. Você pode usar a configuração Output Data Type em um
DataRaptor Transform para realizar essa conversão.
Para criar um DataRaptor Transform que coloca um item em uma lista:
• Tipo de Interface — Transformar
3. Clique em Salvar . A guia Transformações da página Interface do DataRaptor é exibida.
4. Expanda o painel Input JSON e cole os seguintes dados JSON nele:
{
"Contato": {
"Id": "0036100000423z8AAA",
"Nome": "Amy",
" Sobrenome ": "Smith"
}
}
5. Clique no ícone + e adicione o seguinte mapeamento:
• Caminho JSON de entrada — contato
• Caminho JSON de saída — Contatos
• Tipo de dados de saída — List<Map>
Observe que você só precisa criar um mapeamento para o nó de nível superior.
company
6. Expanda o painel Saída JSON Atual. Seu conteúdo deve ficar assim:
{
" Contatos ": [
{}
]
}
7. Vá para a guia Visualizar e clique em Executar . A resposta deve ficar assim:
{
"Contatos": [
{
" Sobrenome ": "Smith",
"Nome": "Amy",
"Id": "0036100000423z8AAA"
}
]
}
Converter uma lista de objetos em uma lista de valores

Você pode converter uma lista de objetos JSON (pares chave-valor entre chaves) em uma lista de valores
únicos, independentemente do comprimento da lista. O truque é usar uma fórmula para remover o segundo
nível da hierarquia.
Para criar um DataRaptor Transform que converte uma lista de objetos em uma lista de valores:
• Tipo de Interface — Transformar
3. Clique em Salvar . A guia Transformações da página Interface do DataRaptor é exibida.
4. Vá para a guia Fórmulas. No campo Fórmula , insira ObjectList:Property . No _ Fórmula Caminho do
resultado campo , digite Lista de Fórmulas .
5. Vá para a guia Transformações. Expanda o painel Input JSON e cole os seguintes dados JSON nele:
{
" ObjectList ": [
{
" Propriedade ": "P9034"
}
]
}
6. Expanda o painel Saída JSON Esperada e cole os seguintes dados JSON nele:
{
" PropertyValueList ": [
"P9034"

company
]
}
7. Clique no ícone + e adicione o seguinte mapeamento:
• Caminho JSON de entrada — FormulaList
• Caminho JSON de saída — PropertyValueList
Observe que você só precisa criar um mapeamento entre os nós de nível superior.
8. Expanda o painel Saída JSON Atual . Seu conteúdo deve ficar assim:
{
" PropertyValueList ": " Texto "
}
9. Vá para a guia Visualizar e cole os seguintes dados JSON no painel de entrada :
{
" ObjectList ": [
{
"Propriedade": "P9034"
},
{
},
{
},
{
},
{
},
{
" Propriedade ": "P7654"
}
]
}
10. Clique em Executar . A resposta deve ficar assim:
{
" PropertyValueList ": [
"P9034",
"P6538",
"P1234",
"P5678",
"P2345",
"P7654"
]
}
11. Adicione ou subtraia itens de lista nos dados JSON no painel de entrada e clique em Executar
novamente. Observe que a saída muda em conformidade .
company
DataRaptor Visão geral da carga
do DataRaptor aceitam dados em JSON, XML ou formatos de entrada personalizados e gravam os dados em
objetos do Salesforce. Fórmulas e atributos são suportados.
Por exemplo, quando um usuário executando um OmniScript de manipulação de casos termina de inserir os
dados e clica em Salvar , o script chama um DataRaptor Load para registrar os dados inseridos.
Um DataRaptor Load pode obter seus dados de entrada das seguintes maneiras:
• OmniScript ou Procedimento de Integração: Durante a execução, um OmniScript ou Procedimento de

Integração cria um Data JSON que é preenchido com os dados necessários para o caso de uso de negócios.
Quando o script invoca o DataRaptor Load, o Data JSON é enviado como entrada.
• REST da API DataRaptor : se o DataRaptor for invocado usando uma ação POST, o Data JSON poderá ser
incluído na carga útil da chamada.
• Apex code: especifique o Data JSON como um parâmetro na chamada para o DataRaptor Load.
Para modificar os dados de entrada, você pode definir fórmulas, transformar valores e alterar o tipo de dados
de saída. (Consulte Usar fórmulas em DataRaptors .) Para especificar como os dados resultantes devem ser
gravados em objetos do Salesforce, mapeie campos do JSON de saída para campos em objetos do Salesforce.
(Consulte Mapeamento de campo de objeto .) Quando chamado, o DataRaptor Load aplica seus mapeamentos
e fórmulas aos dados de entrada para criar os dados de saída. Em seguida, ele carrega os dados de saída em
objetos do Salesforce de acordo com os mapeamentos.
Criar uma carga do DataRaptor
Para criar um DataRaptor Load, especifique seu nome, tipos de entrada e saída, permissões e opções.
1. Acesse o OmniStudio guia DataRaptor .

2. Clique em Novo .
3. Na caixa de diálogo Criar , especifique as seguintes configurações e clique em Salvar :
• Nome da interface do DataRaptor : nome descritivo de sua escolha
• Tamanho do Lote : Número de registros processados por transação em lote, entre 1 e 2000
• Tipo de interface : carga
• Tipo de entrada : escolha JSON ou Personalizado. Se a carga do DataRaptor for chamada de um
OmniScript , escolha
JSON. Para obter detalhes sobre a serialização de dados personalizados, consulte Custom Input and
Output for DataRaptors .)
• Tipo de saída : SObject
Salesforce .
DataRaptor .
4. Na guia Objetos , especifique os objetos do Salesforce que você deseja atualizar.
company
5. Na guia Fórmulas , defina as transformações que deseja aplicar aos dados de entrada para adicionar
dados aos dados de saída. Para obter detalhes sobre as funções que você pode usar em fórmulas para
definir transformações, consulte Usar fórmulas em DataRaptors .
6. Na guia Campos , mapeie os dados de entrada para os campos do objeto Salesforce que você deseja
atualizar. Para obter mais informações , consulte Mapeamento de campo de objeto .
7. Na guia Opções estão as propriedades opcionais que você pode definir.
As opções a seguir estão disponíveis apenas se o Tipo de entrada for SObject :
• Tamanho do Lote : O número de registros processados por transação em lote, entre 1 e 2000.
• Process Now Threshold : O número de registros processados imediatamente, entre 0 e 199.
• Nome da classe do pré -processador : a classe do Apex do adaptador que implementa a interface do
Apex IDRPreprocess .
• Excluir em caso de sucesso : exclua automaticamente registros em massa após o carregamento em
massa de dados com êxito.
• Processar em massa : processe trabalhos grandes distribuídos em vários trabalhos em lote do
Salesforce Apex sem exceder os limites do administrador do Salesforce.
• Is Default for Interface : Especifique este DataRaptor como o pacote padrão para o objeto de interface
especificado.
As seguintes opções estão disponíveis para todas as cargas do DataRaptor :
• Ignore Errors : Execute o DataRaptor mesmo que ocorram erros, pulando apenas as etapas com erros.
Essa opção é útil quando você sabe que um registro falhará com dados limitados e as etapas futuras
não dependem das etapas anteriores.
• Rollback on Error : Não crie ou atualize os sObjects se ocorrerem erros. Para obter mais informações,
consulte Transações do Apex e Controle de transações na documentação do Salesforce.
• Usar regras de atribuição : use regras de atribuição para sObjects , como casos que possuem campos
de atribuição de usuário. Para obter mais informações, consulte Configurar regras de atribuição na
documentação do Salesforce.
Se os emails estiverem configurados nas regras de atribuição de casos, marcar essa opção enviará
emails automaticamente aos usuários quando os casos forem atribuídos.
• Substituir destino para todas as entradas nulas : se uma entrada não tiver um valor, defina o valor de
saída correspondente como NULL.
Qual é o próximo
Mapeamento de campo de objeto
Mapeamento de campo de objeto

Você deve mapear dados do JSON de entrada DataRaptor Load para o objeto e campo de destino do
Salesforce. Você posso também lidar com tipos de dados e valores padrão .
1. Vá para a guia Campos.

2. Clique em + . Um novo mapeamento é adicionado à lista.
3. Configure o seguintes configurações:
• Caminho JSON de entrada : a chave do nó JSON que contém os dados que você deseja gravar no
Salesforce.
• Campo do objeto de domínio : o campo no sObject que você deseja atualizar.
Alguns campos contêm dados JSON. Para mapear esses dados, use a notação padrão, por exemplo:
Objeto:JsonField __ c:JsonNode:ChildJsonNode
company
4. Repita essas etapas para cada campo.
Se você estiver atualizando vários objetos do Salesforce, o designer exibirá uma guia separada para os
mapeamentos de cada objeto de destino. Consulte Múltiplos Carregamentos de Objetos Relacionados
(Mapeamentos de Link) .
Opções de mapeamento
Para controlar como a atualização é realizada, você pode definir as seguintes configurações opcionais:
• Is Disabled : Impede que o campo seja carregado.

• Chave Upsert : especifica que o campo é uma chave para o objeto Salesforce que está sendo carregado. O
DataRaptor usa o valor para determinar se atualiza um registro existente ou insere um novo. Se a
propriedade Upsert estiver habilitada para vários mapeamentos de campo, o resultado será uma chave
upsert de vários campos . O DataRaptor usa essa chave para verificar o objeto quanto a valores exclusivos
para determinar se deve criar um novo objeto ou atualizar um existente.
• É Necessário para Upsert : Impede que um registro de objeto seja atualizado se este campo for nulo.
• Is Lookup : usa o valor do campo para consultar os dados especificados do Salesforce e grava o resultado no
campo de saída.
• Tipo de dados de saída : Deve ser compatível com o tipo de dados do campo de destino.
A configuração do Tipo de dados de saída deve ser compatível com o campo de destino no Salesforce. Se
você configurar tipos incompatíveis, a operação de carregamento poderá falhar. Para obter uma lista de
tipos de saída válidos, consulte Tipos de dados de saída do DataRaptor .
• Valor padrão : Valor a ser carregado se o campo no JSON de saída do DataRaptor for nulo. Para especificar
uma string vazia para campos de string que são nulos, insira um par de aspas duplas (""). Omitir E se É
Obrigatório para Upsert é ativado .
O que vem a seguir

Testar um DataRaptor Carregar
Múltiplos Carregamentos de Objetos Relacionados (Mapeamentos de Link)

Ao carregar dados em uma sequência de objetos, você pode propagar dados diretamente de um objeto para
outro objeto relacionado. Por exemplo, você pode usar um DataRaptor Load para oferecer suporte a um
OmniScript que cria uma conta e um contato para a conta.
Para vincular a Conta ao seu Contato, o DataRaptor deve realizar a seguinte sequência de operações:
1. Crio a Conta .
2. Crio a Contato .
3. Vincule os registros de conta e contato preenchendo o campo AccountId do registro de contato com o ID
do registro de conta.
Para lidar com esse tipo de relacionamento, vincule os objetos no DataRaptor Designer da seguinte forma:
1. Na guia Objetos , navegue até o objeto de origem (Contato no exemplo anterior) e clique em Adicionar
Link .
2. Para cada campo que você deseja vincular, defina as configurações da seguinte maneira:
• objeto de domínio : o campo de origem deste objeto ( AccountId no exemplo anterior).
• Objeto vinculado : outro objeto na sequência (conta no exemplo anterior).
• Lista de campos : o campo de destino no objeto vinculado (Id no exemplo anterior).
company
Por exemplo, para criar um Caso com uma nova Conta e Contato associados, vincule os objetos conforme
mostrado na figura a seguir. O contato é associado à conta por AccountId e o caso é associado ao contato por
ContactId .
Para obter um exemplo que usa mapeamento de link, consulte Criar um contato para uma conta existente .
Testar uma carga do DataRaptor

Você pode testar os resultados de uma carga do DataRaptor na guia Visualizar.

2. Especifique a entrada JSON no painel Entrada.
O painel Objetos criados lista os objetos resultantes, que são salvos permanentemente. O painel Debug Log
exibe os resultados das consultas do Salesforce emitidas pelo DataRaptor .
Exemplos de carregamento do DataRaptor

do DataRaptor demonstram fórmulas e relacionamentos de objetos.
Criar um contato e usar uma fórmula

Um DataRaptor Load cria um registro no objeto Salesforce Contact. Uma fórmula verifica se o contato tem
mais de 18 anos: em caso afirmativo, um campo Autorizado personalizado é definido como verdadeiro.
O JSON de entrada para este DataRaptor Load contém os detalhes do contato, por exemplo:
{
" ContatoDetalhes ": {
"Data de nascimento": "10/10/1954",
" LastName ": "Singh",
"Telefone": "5106345789",
"Nome": "Sanjay"
}
}

company
Para criar este exemplo de carga do DataRaptor :
1. Se o objeto Contato da sua organização não tiver um campo Autorizado, adicione um (caixa de seleção).
No exemplo a seguir, o campo autorizado é chamado Authorized__c . Dependendo do seu setor, talvez
seja necessário adicionar um prefixo de namespace vlocity_cmt __, vlocity_ins __ ou vlocity_ps __.
2. Navegue até o OmniStudio guia DataRaptor e clique em Novo . A caixa de diálogo Criar: Interface do
3. Insira as configurações da seguinte maneira e clique em Salvar :
• DataRaptor Interface Name : Um nome descritivo de sua escolha
4. Na guia Objetos, clique em Adicionar Objeto e escolha Contato .
5. Na guia Campos, mapeie os campos da entrada JSON para os campos no objeto Contato do Salesforce,
conforme mostrado na tabela a seguir.
Insira o caminho JSON Campo de objeto de domínio
Detalhes de contato: Autorizado Autorizado__c
Dependendo do seu setor, talvez seja necessário adicionar um prefixo de namespace vlocity_cmt __,
vlocity_ins __ ou vlocity_ps __.
Detalhes de contato: Data de Data de nascimento

nascimento
Detalhes do contato: FirstName Primeiro nome
Detalhes do contato: sobrenome Sobrenome
Detalhes de contato:Telefone Telefone
6. Na guia Fórmulas, clique em Adicionar Fórmula e insira uma Fórmula de

IF(AGE( ContactDetails:Birthdate ) > 18, "true", "false") e um caminho de resultado da fórmula de
ContactDetails:Authorized conforme mostrado na figura a seguir.

8. Cole os seguintes dados de teste no painel de entrada à esquerda.
{
" ContatoDetalhes ": {
"Data de nascimento": "10/10/1954",
" Sobrenome ": " MeuSobrenome ",
"Telefone": "5106345789",
" FirstName ": " MyFirstName "
}
}
company
9. Clique em Executar . Se o carregamento for bem-sucedido, um link para o objeto será exibido no painel
Objetos criados, conforme mostrado na figura a seguir.
10. Clique no link e verifique se a caixa de seleção Autorizado está marcada somente se o contato for maior
de 18 anos .
Criar um contato para uma conta existente

O exemplo a seguir de um DataRaptor Load cria um registro no objeto Salesforce Contact. Um link para um
registro de objeto Conta com um ID específico garante que o novo contato esteja relacionado a essa conta.
O JSON de entrada para este DataRaptor Load contém o ID da conta e o nome do contato, por exemplo:
{
" AccountId ": "0016100001BKL4uAAH",
"Nome": {
"Primeiro": "Jane",
"Último": "Doe"
}
}
Para criar este exemplo de carga do DataRaptor :
1. Navegue até o OmniStudio guia DataRaptor e clique em Novo . A caixa de diálogo Criar: Interface do
2. Insira as configurações da seguinte maneira e clique em Salvar :
• DataRaptor Interface Name : Um nome descritivo de sua escolha
3. Na guia Objetos, clique em Adicionar Objeto e escolha Conta .
4. Clique em Adicionar objeto novamente e escolha Contato .
5. Clique em Adicionar link e insira as configurações da seguinte forma:
• Campo do objeto de domínio : AccountId
• Vinculado Objeto : 1 - Conta
• Campo de objeto vinculado (após o ponto): Id
6. Vá para a guia Campos e a subguia Conta. Clique no ícone + e adicione o seguinte mapeamento:
• Caminho JSON de entrada : AccountId
• Campo do objeto de domínio : ID
• Chave Upsert : marcada
7. Vá para a subguia Contato. Adicione os seguintes mapeamentos de nome:

company
O mapeamento AccountId já está presente.
8. Na guia Visualizar, teste o DataRaptor usando entrada com a mesma estrutura da entrada de exemplo
acima, substituindo um ID de conta de sua organização e um nome de sua e scolha.
Práticas recomendadas do DataRaptor

Para maximizar os benefícios do DataRaptors , siga as melhores práticas sempre que possível.
• Crie DataRaptors direcionados que extraiam ou carreguem apenas os dados necessários para uma
operação.
• Use notação de relacionamento (consultas) sempre que possível para extrair dados de outros SObjects .
Para mais informações , consulte Relação Notação versus Múltiplo Extrair Passos .
• Tente manter o número de SObjects em três ou menos.
• Certifique-se de que todas as operações de filtragem e classificação (ORDER BY) estejam em campos
indexados. Os campos Id e Name são sempre indexados. Para obter mais informações, consulte Índices na
Ajuda do Salesforce.
• Use o cache para armazenar dados acessados com frequência e atualizados com pouca frequência. Ver
Cache para DataRaptors e Procedimentos de Integração .
Para determinar se um DataRaptor ou um Procedimento de Integração é o melhor para seu caso de uso,
consulte DataRaptor ou Procedimento de Integração? .
Listar entrada para DataRaptors

DataRaptors podem realizar transformações de lista. Para mapear entrada para saída, os DataRaptors exigem
entrada de lista na qual cada valor é emparelhado com uma chave.
Por exemplo, as listas a seguir são válidas e cada uma pode ser convertida na outra.
Lista 1:
{
"Mais antigo": "Huey",
"Meio": "Dewey",
"O mais novo": "Louie"
}

company
Lista 2:
{
"Sobrinhos": [
{
"Nome": "Huey"
},
{
"Nome": "Dewey"
},
{
"Nome": "Louie"
}
]
}
A lista 1 não possui um nó JSON para a lista como um todo e cada valor tem uma chave diferente. A Lista 2 tem
seu próprio nó JSON e cada item da lista tem a mesma chave.
NOTA
Os componentes do Bloco de Loop nos Procedimentos de Integração requerem uma entrada
estruturada como a Lista 2. A própria chave de item de lista pode conter pares de valores-chave.
Para exemplos , consulte Processo Matrizes Usando Blocos de Loop .
Para converter a Lista 1 em Lista 2, use os mapeamentos a seguir na guia Transformações de uma
Transformação do DataRaptor . Os |1 , | 2 e |3 são índices de posição da lista .
Insira o caminho JSON Caminho JSON de saída
Mais antigo Sobrinhos|1:Nome
Meio Sobrinhos|2:Nome
mais novo Sobrinhos|3:Nome
Para converter a Lista 2 em Lista 1, use os mapeamentos reversos.
Para baixar DataPacks de DataRaptor Transforms para esses mapeamentos, clique nestes links:
• Lista 1 a Exemplo de lista 2

• Lista 2 a Exemplo de lista 1
Na lista a seguir, os valores não têm chaves.
Lista 3:
{
"Sobrinhos": [
"Hue",
"Dewey",
"Lui"
company
]
}
Você pode converter a Lista 1 em Lista 3 usando os seguintes mapeamentos:

Insira o caminho JSON Caminho JSON de saída
Mais antigo Sobrinhos|1
Meio Sobrinhos|2
mais novo Sobrinhos|3
No entanto, você não pode converter a Lista 3 em Lista 1 ou Lista 2.
Para converter a Lista 2 em Lista 3 e realizar essas conversões de listas de qualquer tamanho, consulte
Converter uma lista de objetos em uma lista de valores .
Veja Também
• Funções AVG, FILTER, IF, LIST, LISTMERGE, LISTMERGEPRIMARY, LISTSIZE, MAX, MIN, SORTBY e SUM na
referência de função
• Arrays de processo usando blocos de loop em procedimentos de integração
• Listar Ação para Procedimentos de Integração em Procedimentos de Integração
• Ação do Procedimento de Integração para Procedimentos de Integração em Procedimentos de Integração
(o exemplo transforma uma lista)
Usar fórmulas em DataRaptors

Para adicionar dados à saída de um DataRaptor , você pode definir fórmulas . Todos os tipos de DataRaptor
(Turbo Extract, Extract, Transform e Load) suportam fórmulas. Ao definir uma fórmula, você mapeia sua saída
para o JSON de saída (para extrações e transformações) ou para o campo de objeto do Salesforce (para
cargas).
Para obter detalhes sobre os operadores e funções que você pode usar em fórmulas, consulte Referência de
funções .
Para crie uma fórmula :
1. Na página Interface do DataRaptor , vá para a guia Fórmulas .

2. Clique em Adicionar Fórmula . Uma fórmula vazia é adicionada à lista.
3. No campo Fórmula , especifique a lógica desejada. Por exemplo, para determinar o preço total dos itens
comprados por um cliente, insira uma fórmula como: SUM( Produtos:Preço )
Você também pode usar a notação de relacionamento em fórmulas para fazer referência a campos em
um objeto pai. Ver Relação Notação versus Múltiplo Extrair Passos .
4. No campo Caminho do Resultado da Fórmula , especifique um nó JSON no qual armazenar o resultado
da fórmula.
5. Mapeie o resultado para a saída final da seguinte forma:
• Extrair: Vá para a guia Saída e mapeie o resultado da fórmula para a estrutura de saída. Use dois
pontos (:) para delimitar os níveis nos caminhos de entrada e saída nos mapeamentos.
• Transformar: Vá para a guia Transformações e mapeie o resultado da fórmula para a estrutura de
saída. Use dois pontos (:) para delimitar os níveis nos caminhos de entrada e saída nos mapeamentos.
company
• Load: Para cada sObject que você deseja atualizar, vá para seus Campos guia e mapeie o resultado da
fórmula para o campo específico que você deseja atualizar.
NOTA
Se um nome de variável contiver espaços ou caracteres não alfanuméricos, coloque o nome da
variável entre aspas duplas e preceda-o com var: nas fórmulas. Por exemplo, se o nome do nó
JSON for Primary Guardian , especifique-o nas fórmulas como var:"Primary Guardian" .
Se o nome de um campo personalizado incluir caracteres especiais, às vezes você não poderá fazer
referência ao campo em uma fórmula.
Veja Também
• Criar um exemplo do DataRaptor com uma fórmula
Criar um exemplo do DataRaptor com uma fórmula

O exemplo a seguir aceita uma lista de preços e usa uma fórmula para calcular o preço total.
Para criar este DataRaptor Transform, execute as seguintes etapas:
1. Vá para o OmniStudio guia DataRaptor Designer e clique em Novo . A caixa de diálogo Criar é exibida.
4. Vá para a guia Fórmulas e clique em Adicionar Fórmula .
5. No campo Fórmula , insira SUM( Produtos:Preço ) .
6. No campo Caminho do Resultado da Fórmula , insira TotalPrice .
7. Na guia Transforms, expanda o painel Input JSON e cole esta estrutura JSON nele:
{
" CustomerName ": "Bob Smith",
"Produtos": [
{
"Nome": "iPhone",
"Preço": 600
},
{
"Nome": "Capa para iPhone",
"Preço": 30
},
{
"Nome": "Fones de ouvido",
"Preço": 200
}

company
]
}
8. Expanda o painel Saída JSON Esperada e cole esta estrutura JSON nele:
{
" Preço Total ": 830,
"Produtos": [
{
"Nome": "iPhone",
"Preço": 600
},
{
"Preço": 30
},
{
"Preço": 200
}
]
}
9. Clique em Correspondência Rápida . Na janela Quick Match, clique em Auto Match e, em seguida, clique
em Save .
10. Na guia Visualizar, clique em Executar .
Se você criou o exemplo corretamente, a estrutura JSON no painel Resposta corresponde à Saída JSON
Esperada, exceto pela ordem dos nós de nível superior.
11. No painel Entrada, altere um ou mais preços e clique em Executar novamente. Observe como a Preço
total valor mudanças .
Veja Também
• Use Fórmulas em DataRaptors
Tipos de dados de saída do DataRaptor

Muitos tipos de dados podem ser atribuídos a dados no JSON de saída, incluindo boolean , currency, string,
vários tipos de número e lista e formatos de data.
• boleano
• Moeda: converte em moeda usando o código de moeda da organização do Salesforce.
• CurrencyRounded : converte em moeda, arredonda o número e remove os decimais.
• Dobro
• inteiro
• JSON: serializar como JSON. Omita se o tipo de saída de transformação for JSON, a menos que você precise
incorporar JSON em
JSON ( improvável )
• Lista <Duplo>
• Lista < Inteiro >
• List<Map>: Converte Map< String,Object > em List<Map<String, Object>>
company
• Lista < Sequência >
• Número
• Number(3): Converte em um número com decimais onde a precisão decimal é especificada entre
parênteses.
Por exemplo, o tipo de saída Number(3) produziria um número com três casas decimais.
• Object: desserializa uma String como Map<String, Object> ou List<Object>
• Corda
• Seleção múltipla: Converter em string de seleção múltipla do Salesforce (lista delimitada por ponto e
vírgula)
• Data: Detalhes na tabela a seguir.
NOTA
Se você converter uma lista de valores para um tipo primitivo como Double, Integer, String ou
Boolean, somente o primeiro elemento da lista será gerado.
Para formatar valores de data e hora de saída, use os modelos de data e hora suportados pelo Oracle Java . O
formato da data de entrada deve ser compatível com ISO (AAAA-MM-DD hh:mm:ss ) e a hora deve ser GMT.
Especifique o formato como um argumento de string para o tipo de dados de saída DATE(), por exemplo:
Date("EEE, d MMM aaaa HH:mm:ss Z")
Aqui estão exemplos de formatos de saída diferentes para o mesmo valor de data e hora.
Formato Resultado
Data(MM/dd/AAAA) (padrão) 07/04/2001
Date("aaaa.MMMMM.dd GGG hh:mm aa ") 2001.Julho.04 AD 12:08 PM
Date("EEE, d MMM aaaa HH:mm:ss Z") qua , 4 de julho de 2001 12:08:56

+0000
DataRaptor Desenvolvedor Características

Você pode chamar DataRaptors usando Apex ou uma API REST. Você também pode usar variáveis de entrada e
saída personalizadas e de ambiente em DataRaptors .
API REST do DataRaptor

Você pode invocar qualquer tipo de DataRaptor usando a API REST do DataRaptor . Para atualizar objetos do
Salesforce usando um carregamento do DataRaptor , emita uma solicitação POST que inclua um payload JSON
formatado para estar em conformidade com a entrada que o carregamento do DataRaptor espera. Para
recuperar dados do Salesforce, emita uma chamada GET para um DataRaptor Extract, especificando o Id ou os
parâmetros que identificam os dados a serem recuperados. Os dados são retornados na resposta no formato
JSON.
NOTA
O Salesforce Workbench REST Explorer é uma ferramenta de teste útil.
Exemplo
Dados de postagem

company
" bundleName " : " AccountUpload ",
" listadeobjetos ": {
"Informações da agência": {
"Nome da Agência": " Vlocity ",
"Endereço da Agência": "50 Fremont",
"Agência Cidade": "São Francisco",
"Estado da Agência": "CA",
"CEP da agência": "94110",
}
},
" bulkUpload " : false
}
Resultado
{
" createObjectsByOrder ": {
"Conta aberta": {
"1": [
"a10o00000022xVEAAY" ]
}
},
" createObjectsByType ": {
"Conta aberta": {
"Conta": [
"a10o00000022xVEAAY" ]
}
},
"erros": {},
" returnResultsData ": []
}
do DataRaptor usando GET

Para recuperar dados do Salesforce usando uma chamada REST, emita uma instrução GET que invoca uma
extração do DataRaptor . Para identificar os dados a serem recuperados, você pode especificar o ID do objeto
ou um ou mais parâmetros a serem correspondidos. Os dados são retornados na resposta no formato JSON de
saída que o DataRaptor Extract cria.
Use um ID para recuperar dados

Para recuperar dados do Salesforce especificando o Id, emita uma solicitação GET que invoca um DataRaptor
Extract, usando um URL formatado da seguinte forma:
/services/apexrest/ myOrgNamespace /v2/DataRaptor/ DataRaptorName / Id
Solicitação de exemplo
A solicitação a seguir usa a ID de um contato para recuperar todos os casos abertos para o contato. Observe
que a codificação de URL HTML %20 representa um espaço no nome do DataRaptor .
GET /services/apexrest/vlocity_cmt/v2/DataRaptor/Open%20Cases/a10o00000022xVE

company
Resultado de exemplo
{
"Contato": {
"Nome do contato" : "Dennis Reynolds",
"Informações do caso": [
{
"Title": "Widget errado enviado..."},
{
"Title": "Cobrado em excesso por aparelho..."},
{
"Title": "Item danificado..."}
]
}
}
Use parâmetros para recuperar dados

Para recuperar dados do Salesforce passando parâmetros para uma extração do DataRaptor , emita uma
solicitação GET usando um URL formatado da seguinte forma:
GET /services/apexrest/<myOrgNamespace>/v2/DataRaptor/<DataRaptorName>/?$
{Param1}=${Val1}&${Param2}=${Val2}...
Solicitação de exemplo
A solicitação a seguir passa o nome e o sobrenome de um contato como parâmetros de entrada para uma
extração do DataRaptor , que os usa para consultar os casos abertos pelo contato.
GET /services/ apexrest / vlocity_cmt /v2/ DataRaptor / Open_Cases /?

FirstName= Dennis&LastName =Reynolds
do DataRaptor usando POST

Para atualizar os dados do Salesforce, emita uma solicitação POST com um URL formatado da seguinte forma:
/services/ apexrest / vlocityNamespace /v2/ DataRaptor /
Nos dados POST, especifique os seguintes parâmetros:
• bundleName : Nome do DataRaptor Load a ser invocado

• objectList : dados JSON a serem carregados. Deve corresponder ao formato esperado pelo DataRaptor Load.
• filesList : (Opcional) Mapa de chaves para arquivos codificados em base 64.
• bulkUpload : TRUE para usar o Apex em lote.
Chamadas do DataRaptor do Apex

Para chamar um DataRaptor do Apex , chame o método vlocity_ins.DRGlobal.processObjectsJSON () ,
especificando o nome do DataRaptor e os dados de entrada necessários.
Especifique a entrada da seguinte forma:

• Para um objeto JSON, use Map<String, Object> . Defina a String para a chave JSON e o Object para o valor
JSON.

company
• Para uma matriz de objetos JSON, use List<Map<String, Object>> . Defina a String para a chave JSON e o
Object para o valor JSON.
• Como alternativa, você pode especificar a entrada como uma string contendo a entrada JSON exigida pelo
DataRaptor .
Para obter detalhes sobre os métodos da classe DRGlobal , que oferecem várias maneiras de chamar
DataRaptors , consulte DRGlobal Class and Methods .
Para processar os resultados retornados por uma extração ou transformação do DataRaptor no Apex, use o
método toJsonList () para desserializar a saída para um Map<String, Object> ou List<Map<String, Object>> .
Para determinar qual tipo usar, verifique o tipo de dados da resposta.
extração ou transformação do DataRaptor

/* Especifique a extração ou transformação do DataRaptor para chamar */
String DRName = ' DataRaptorName ';
/* Preencher o JSON de entrada */
Map<String, Object> myTransformData = new Map<String,
Objeto>{' MinhaChave '=>' MeuValor ' };
/* Chama o DataRaptor */ vlocity_ins.DRProcessResult result =
vlocity_ins.DRGlobal.process ( myTransformData , DRName );
/* Desserializar a saída do DataRaptor para processamento no Apex */
List<Map<String, Object>> myTransformResult = (List<Map<String,
Object>>) result.toJsonList ( );
do DataRaptor retornam JSON contendo dados sobre os objetos do Salesforce que foram criados ou
atualizados pela operação. Para processar os resultados retornados por uma carga do DataRaptor , desserialize
a saída para um mapa. A partir do mapa resultante, você pode extrair dados sobre os objetos que foram
criados e quaisquer erros ocorridos. O exemplo de carregamento do DataRaptor abaixo mostra como acessar
esses dados do mapa de resultados.
Exemplo de carregamento do DataRaptor

String dataJson = '{" accountName ":" Vlocity ", "contractCode":"SKS9181"} ';
vlocity_ins.DRProcessResult resultado =
vlocity_ins.DRGlobal.processObjectsJSON ( dataJson , 'Criar Contratos' );
Map<String, Object> resultMap = result.convertToMap ( );
System.debug ( JSON.serialize ( resultMap ) );
/*
Processe os resultados do carregamento: esses métodos retornam detalhes sobre objetos
afetado pela carga do DataRaptor , além de quaisquer erros que ocorreram
*/
Map<String, Object> createdObjectsByType = (Map<String,
Object>) resultMap.get (' createdObjectsByType ' );
Map<String, Object> createdObjectsByTypeForBundle = (Map<String, Object>) createdObjectsByType.get
('Criar Contratos' );
Map<String, Object> createdObjectsByOrder = (Map<String,
Object>) resultMap.get (' createdObjectsByOrder ' );
Erros de Map<String, Object> = (Map<String, Object>) resultMap.get ('errors' );
Map<String, Object> errorsByField = (Map<String,
Object>) resultMap.get (' errorsByField ' );

company
Map<String, Object> errorsAsJson = (Map<String,
Object>) resultMap.get (' errorsAsJson '); // Retorna o JSON de entrada mais erros por nó
DataRaptor com o parâmetro bulkUpload

Use o método processPost se precisar passar o parâmetro bulkUpload para um DataRaptor Load.
String objectList = '[{" ProductCode __c": 11050665},{" ProductCode __c":

11070100}]'; // substitua isso pela entrada para seu DR Load
String bundleName = ' DRLoadPrice '; // substitua isso pelo seu nome de DR
String bulkUpload = 'true ';
Map< String,Object > bodyData = new Map< String,Object >( );
bodyData.put (' bundleName ', bundleName ); bodyData.put (' bulkUpload ', bulkUpload );
bodyData.put (' objectList ', objectList ); vlocity_cmt.DRGlobal.processPost ( bodyData );
Classe e Métodos DRGlobal

A classe DRGlobal fornece vários métodos para chamar Vlocity DataRaptors da Apex.
Em todas as assinaturas de método mostradas abaixo, o namespace é vlocity_cmt , vlocity_ins ou vlocity_ps .

O bundleName é o nome do DataRaptor .
Para obter o código de exemplo, consulte Chamadas do DataRaptor do Apex .
Nomes de métodos
processObjectsJSON
Assinatura:
namespace estático .DRProcessResult processObjectsJSON (String objectList , String bundleName )
A objectList deve ser uma string JSON.
processObjects
Assinaturas:
namespace estático .DRProcessResult processObjects (List< SObject > objectList ) namespace estático
.DRProcessResult processObjects (List< SObject > objectList , String bundleName )
namespace estático .DRProcessResult processObjects (List< SObject > objectList ,
String bundleName , Map<String, Object> AdditionalInfo )
namespace estático .DRProcessResult processObjects (List< SObject > objectList , String bundleName ,
Map<String, Object> AdditionalInfo , Map<String, Object> filesMap )
A primeira assinatura, que não requer um DRName , é apenas para um DataRaptor Load.
O AdditionalInfo é um Map que se aplica a todo SObject , como dados extras para processamento.
pprocessString
Assinatura:
namespace estático .DRProcessResult processString (String input, String bundleName )
A entrada deve ser uma String XML.

company
processFromApex
Assinaturas:
namespace estático .DRProcessResult processFromApex (List<Map<String, Object>> objectList , String

bundleName , String locale)
namespace estático .DRProcessResult processFromApex (Map<String, Object> objectList , String
bundleName , String locale)
Esses métodos ignoram as regras de compartilhamento, o que garante que o DataRaptor que está sendo
invocado seja privado. Consulte as regras de compartilhamento na ajuda do Salesforce.
processo
Assinaturas:
namespace estático .DRProcessResult process(List<Map<String, Object>> objectList ,

String bundleName , String locale)
namespace estático .DRProcessResult process(Map<String, Object> objectList , String
bundleName , String locale) processPost
Assinatura:
global estático Map<String, Object> processPost (Map<String, Object> bodyData )
Este método só pode chamar um DataRaptor Load. Nenhum outro método do Apex pode passar o bulkUpload
parâmetro para um DataRaptor . Consulte Chamadas do DataRaptor do Apex .
clearCacheForDataRaptor , clearCacheForAllDataRaptor
Para obter detalhes sobre esses métodos, consulte Cache para DataRaptors e procedimentos de integração .
Variáveis de ambiente em DataRaptors e procedimentos de integração

Você pode usar variáveis de ambiente para definir valores padrão e valores de filtro e em fórmulas.
Por exemplo, o filtro a seguir extrai os Casos criados nos últimos 30 dias.
Se você estiver usando uma variável de ambiente como um valor de Filtro, deverá colocá-la entre aspas
duplas.
Meio Ambiente Variável Descrição
$ Vlocity.HOJE de hoje
$ Vlocity.AMANHÃ data de amanhã
$ Vlocity.AGORA Data e hora atuais

company
$ Vlocity.N_DAYS_FROM_NOW :{N} A data do número especificado de dias a partir de agora
$ Vlocity.N_DAYS_AGO :{N} A data do número especificado de dias atrás
$ Vlocity.NULL Nulo
$ Vlocity.StandardPricebookId ID do catálogo de preços padrão
$ Vlocity.DocumentsFolderId ID da pasta de documentos
$ Vlocity.true ou $ Vlocity.TRUE Booleano TRUE
$ Vlocity.false ou $ Vlocity.FALSE Boolean FALSE
$ Vlocity.UserId Atual ID do usuário
$ Vlocity.Percent Porcentagem de caractere. Útil para escapar caracteres % em URLs para que não sejam confundidos com
a sintaxe do campo de mesclagem.
$ Vlocity.CpuTotal Valor da CPU do Apex
$ Vlocity.DMLStatementsTotal Número de instruções de linguagem de manipulação de dados
$ Vlocity.DMLrowsTotal Número de linhas da linguagem de manipulação de dados
$ Vlocity.HeapSizeTotal Pilha Tamanho valor
$ Vlocity.QueriesTotal Número de consultas executadas
$ Vlocity.QueryRowsTotal Número de linhas de consulta buscadas
$ Vlocity.SoslQueriesTotal Número de consultas SOSL executadas
Entrada e saída personalizadas para DataRaptors

Por padrão, os DataRaptors lidam com dados JSON e XML. Para lidar com outros formatos de dados, você pode
configurar um DataRaptor para usar uma entrada ou saída personalizada que você implementa como uma
classe personalizada. Por exemplo, você pode definir um DataRaptor Transform que aceita dados formatados
em CSV e os gera como JSON.
As opções são as seguintes:

• DataRaptor Load: entrada personalizada (a saída é sempre um objeto do Salesforce)
• DataRaptor : entrada e saída personalizadas
• DataRaptor : entrada e saída personalizadas
Para configurar um DataRaptor para usar uma entrada ou saída personalizada, defina seu tipo como Custom e
especifique a classe que contém os métodos serialize e/ou desserialize que executam a operação. A figura a
seguir mostra um DataRaptor Transform configurado com uma entrada e uma saída personalizadas.

company
Para facilitar o mapeamento, você pode colar a entrada de amostra nos campos Entrada esperada e Saída
esperada .
Implementação de classe personalizada

Para criar a lógica necessária para entrada e saída personalizadas, você deve definir uma classe personalizada
que implemente VlocityOpenInterface2 . Para saída personalizada, implemente o método serialize . Para
entrada personalizada, implemente o método desserialize . Você não pode renomear os parâmetros de
entrada e saída.
O exemplo a seguir mostra a estrutura básica de uma classe de serialização/desserialização do cliente.
global com a classe de compartilhamento VlocityPreprocessorClassExample implementa

VlocityOpenInterface2 {
global Object invokeMethod (String methodName , Map< String,Object > input,
Map< String,Object > output, Map< String,Object > options) {
if ( methodName == 'serialize') { return serialize(input,
output );
}
else if ( methodName == 'desserialize') {
return desserialize(entrada, saída );
}
retornar falso;
}
/*
Serializa objetos do Apex em conteúdo JSON. return String json
*/
global Boolean serialize(Map<String, Object> input, Map<String, Object>
resultado) {
String jsonString = ' ';
// código

company
output.put ('saída', jsonString ); // Sequência JSON
retorne verdadeiro;
}
/*
Desserializa a string JSON especificada em coleções de primitivos
tipos de dados. return Objeto ((Mapa<String, Objeto>))
*/
global Boolean desserialize(Map<String, Object> input, Map<String, Object>
resultado) {
Map<String, Object> returnMap = new Map<String, Object>( );
// código
output.put ('saída', returnMap ); // ---> coleções de dados primitivos
tipos Map<String, Object>, List<Map<String, Object>>()
retorne verdadeiro;
}
}
O exemplo a seguir serializa e desserializa dados CSV.
global com a classe de compartilhamento que VlocityPreprocessorClass implementa

VlocityOpenInterface2
{
global Object invokeMethod (String methodName , Map< String,Object > input,
Map< String,Object > output, Map< String,Object > options)
{
if ( methodName == 'serialize')
{
return serialize(entrada, saída );
}
else if ( methodName == 'desserializar')
{
return desserialize(entrada, saída );
}
retornar falso;
}
/*
Serializa objetos do Apex em conteúdo JSON. return String json Exemplo de entrada:
[
{
"Column1Test": "valor1.0",
"Column2Test": "valor0"
},
{
"Column1Test": "valor1.1sl",
"Column2Test": "valor0.1"
}
]
Saída de exemplo: 'Column2,Column1\nvalue0,value1.0\nvalue0.1,value1.1 ';
*/
global Boolean serialize(Map<String, Object> input, Map<String, Object>
company
resultado)
{
Objeto inputValue = input.get ('input' );
String valorretorno = ''; if ( inputValue ==
null)
{
retornar falso;
}
if ( inputValue InstanceOf Map<String, Object>)
{
inputValue = new List<Object>{ inputValue };
}
if ( inputValue InstanceOf List<Object> &&
((List<Object>) inputValue ). está Vazio ())
{
List<Object> linhas = (List<Object>) inputValue ;
if (! linhas.está vazia ())
{
Set<String> colunas = ((Map<String,
Objeto>)linhas[0]). conjunto de chaves ( );
for (String col: colunas)
{
if ( String.isNotBlank ( returnValue ))
{
valorretorno = valorretorno + ',' + col;
} senão
{
valorretorno = valorretorno + col;
}
}
if (! columns.isVazio ())
{
valorretorno = valorretorno + '\n ';
}
for (Integer i = 0; i < linhas.size (); i ++)
{
for (String col: ((Mapa<String,
Object>)linhas[ i ]). conjunto de chaves ())
{ if ( String.isNotBlank ( returnValue ) && !
( returnValue.length ()-1 == returnValue.lastIndexOf ('\n')))
{
returnValue = returnValue + ',' + ((Map<String,
Object>)rows[ i ]).get(col );
} senão
{
valorderetorno = valorderetorno + ((Mapa<String,
Object>)rows[ i ]).get(col );
}
}
valorretorno = valorretorno + '\n ';
company
}
output.put ('output', returnValue );
retorne verdadeiro;
}
}
retornar falso;
}
/*
Desserializa a string JSON especificada em coleções de dados primitivos
tipos. return Object ((Map<String, Object>)) Entrada:
'Column2,Column1\nvalue0,value1.0\nvalue0.1,value1.1'; Resultado:
[
{
"Column1Test": "valor1.0",
"Column2Test": "valor0"
},
{
"Column1Test": "valor1.1sl",
"Column2Test": "valor0.1"
}
]
*/
global Boolean desserialize(Map<String, Object> input, Map<String, Object>
resultado)
{
Objeto inputValue = input.get ('input' );
if ( inputValue != null && inputValue InstanceOf String)
{
List<String> valueSet = ((String) inputValue ).split('\n' );
List<Map<String, String>> csvList = new List<Map<String, String>>( );
List<String> colunas = new List<String>(); for (Integer i = 0; i < valueSet.size
(); i ++)
{
Valor da string = valueSet [ i ]; if ( String.isBlank (valor))
{
Prosseguir;
}
se ( i == 0)
{
List<> valSet = value.split (','); for (Integer y = 0; y < valSet.size (); y++)
{
column.add ( valSet [y] );
}
} senão
{
List<> valSet = value.split (','); if ( column.size () >= valSet.size ())
{
Map<String, String> linhas = new Map<String, String>( );
for (Inteiro z = 0; z < valSet.size (); z++)
{
company
rows.put (colunas[z], valSet [z] );
}
csvList.add (linhas );
}
}
}
output.put ('saída', csvList );
retorne verdadeiro;
}
retornar falso;
}
}
Cache para DataRaptors e procedimentos de integração

uso de um cache para armazenar dados do DataRaptor e do Procedimento de Integração acessados com
frequência e pouco atualizados economiza idas e voltas ao banco de dados e melhora o desempenho.
Você pode usar o cache com DataRaptors de três maneiras:
• do DataRaptor são armazenados em cache automaticamente, a menos que você desative o Scale Cache.
• Você pode configurar o cache de dados na guia Opções do DataRaptor Extracts, Turbo Extracts e Transforms
.
• Se você chamar um DataRaptor de um Procedimento de Integração que usa armazenamento em cache, os
dados do DataRaptor serão armazenados em cache junto com os dados do Procedimento de Integração.
Você pode usar o cache com os Procedimentos de Integração de três maneiras:
• Você pode armazenar em cache metadados para todo o Procedimento de Integração.

• Você pode armazenar em cache a resposta de todo o Procedimento de Integração, chamado de dados de
nível superior. Ver Cache para nível superior Dados do Procedimento de Integração .
• Você pode armazenar em cache o resultado de um conjunto específico de etapas colocando as etapas
dentro de um Bloco de Cache. Consulte Melhorar o desempenho usando blocos de cache .
Use Blocos de Cache se algumas partes do Procedimento de Integração atualizarem dados ou se você
precisar que dados em cache diferentes expirem em momentos diferentes. Por exemplo, os dados
climáticos atuais mudam com mais frequência do que os dados da sessão do usuário.
Você também pode executar uma verificação de segurança em nível de registro para dados armazenados em
cache. Consulte Segurança para DataRaptors e procedimentos de integração .
Cache de metadados para DataRaptors e procedimentos de integração

Os metadados do Procedimento de Integração são armazenados em cache por padrão e os metadados do
DataRaptor são armazenados em cache automaticamente.
Para desabilitar o cache de metadados para um Procedimento de Integração, vá para a Configuração do

Procedimento e marque a caixa de seleção Desabilitar Cache de Definição .

company
GORJETA
Para testar o benefício de desempenho do cache de metadados, execute o Procedimento de
Integração na guia Visualizar com Desativar Cache de Definição marcado e desmarcado.
Compare os valores de CPU do navegador, servidor e Apex .
Atrás dessa caixa de seleção está o campo booleano DisableDefinitionCache __c , cujo padrão é false.
Métodos para limpar metadados de qualquer cache

Se você precisar limpar os metadados do DataRaptor do cache, siga as instruções neste tópico , mas execute
uma destas linhas de código:
namespace .DRGlobal.clearCacheForDataRaptor (' DataRaptorName ');
vlocity.cmt.DRGlobal.clearCacheForAllDataRaptor ( );
Você pode limpar os metadados do Procedimento de Integração do cache. Siga as instruções neste tópico ,
mas execute esta linha de código, especificando o Tipo e o Subtipo do Procedimento de Integração:
IntegrationProcedureService.clearMetadataCache (' Tipo _ Subtipo ' );
Você pode limpar todos os dados armazenados em cache para um Procedimento de Integração, incluindo
dados de cache de sessão, dados de cache da organização e metadados. Siga as instruções neste tópico , mas
execute esta linha de código, especificando o Tipo e o Subtipo do Procedimento de Integração:
IntegrationProcedureService.clearAllCache (' Tipo _ Subtipo ' );
Métodos para limpar dados do cache de escala

OmniStudio DataRaptors e Procedimentos de Integração usam o Scale Cache e não o Platform Cache. Para
limpar o Scale Cache, você pode usar os métodos anteriores ou o seguinte ScaleCacheService método.
Se você precisar limpar os dados do DataRaptor do Scale Cache, siga as instruções neste tópico , mas execute
uma linha de código neste formulário:
namespace .ScaleCacheService.invalidateCacheValue (novo Map<String,

String>{' DataRaptorId ' =>
DataRaptor_Name } );
Por exemplo, para limpar dados de um DataRaptor chamado ExtractContactName , use esta linha de código:
omnistudio.ScaleCacheService.invalidateCacheValue (novo Map<String,


company
' ExtractContactName '} );
Se você precisar limpar os dados do Procedimento de Integração do Cache de Escala, siga as instruções neste
tópico , mas execute uma linha de código neste formulário:

String>{' VIPId ' =>
Type_SubType } );
Por exemplo, para limpar dados de um Procedimento de Integração com um Type_SubType de

LoopList_ContactNames , use esta linha de código:

' LoopList_ContactNames '} );
Veja também
• Desligue o Cache de Escala
Segurança para DataRaptors e Procedimentos de Integração

Você pode controlar o acesso ao DataRaptors e aos Procedimentos de Integração usando configurações que
fazem referência a Configurações de Compartilhamento e Conjuntos de Compartilhamento ou Perfis e
Conjuntos de Permissões.
IMPORTANTE
Usuários convidados , também chamados de usuários anônimos, não podem acessar nenhum
registro por padrão. As regras de compartilhamento baseadas em critérios concedem a eles acesso
somente leitura. Isso afeta todas as organizações do Salesforce. Para obter detalhes, consulte
Práticas recomendadas de desenvolvimento de acesso a registros de usuários convidados .
Vlocity permite que usuários convidados criem e atualizem os registros aos quais as Regras de
Compartilhamento garantir acesso. Sem adicional configuração é necessário para isso expandido
acesso .
configurações de compartilhamento do Salesforce para proteger o acesso ao DataRaptors e aos
Procedimentos de Integração. Se você usar o cache , deverá definir CheckCachedMetadataRecordSecurity
como true conforme descrito aqui.
Você pode permitir o acesso a um DataRaptor ou a um Procedimento de Integração com base nas Permissões
Personalizadas habilitadas nos Perfis ou Conjuntos de Permissões do Salesforce de um usuário . Uma classe do
Apex adicionada à sua organização do Salesforce permite que o pacote gerenciado Vlocity verifique as
permissões personalizadas do usuário. As configurações personalizadas descritas aqui estão relacionadas a
essa abordagem. A Vlocity recomenda o uso de Permissões Personalizadas em Perfis ou Conjuntos de
Permissões para facilidade de uso e melhor desempenho.
Para noções básicas de acesso ao Salesforce, consulte Controlar quem vê o quê , Quem vê o quê — Vídeo de
visão geral e Modelo de segurança de dados do Salesforce — Explicado visualmente .
Configurações de Compartilhamento, Conjuntos de Compartilhamento, Perfis e Conjuntos de

Permissões controlam o acesso a DataRaptors e Procedimentos de Integração como registros de
company
objetos. Para reforçar a segurança em nível de campo nos dados que DataRaptors acessam, vá para a guia
Opções do DataRaptor e selecione Check Field Level Security .
IMPORTANTE
O acesso de um usuário a um DataRaptor ou Procedimento de Integração inclui mais do que a
capacidade de executá-lo diretamente. O acesso também se aplica se um aplicativo que o usuário
estiver usando chamar o DataRaptor ou o Procedimento de Integração.
Se um usuário tiver acesso a um Procedimento de Integração pai, o pai poderá invocar o filho
Procedimentos de Integração e DataRaptors aos quais o usuário não tem acesso direto.
Definir configurações de segurança do DataRaptor e do procedimento de integração

Você pode alterar as configurações de segurança do DataRaptor e do Procedimento de Integração em
Configuração.
Para obter uma lista de configurações, consulte DataRaptor e Configurações de segurança do procedimento
de integração .
1. Vá para Configuração.
• No Lightning Experience, clique no ícone de engrenagem e selecione Configuração no menu.
• No Salesforce Classic, clique no menu do usuário e selecione Configuração no menu.
2. Na caixa Busca rápida , digite omni e selecione Omni Interaction Configuration .
3. Clique em Nova configuração de interação Omni .
4. No campo Rótulo , digite o nome da configuração.
5. No campo Valor , digite um valor válido para a configuração.
DataRaptor e do procedimento de integração

Essas configurações afetam a segurança do DataRaptor e do Procedimento de Integração.
Para definir essas configurações, consulte Definir configurações de segurança do DataRaptor e do

procedimento de integração .
Contexto Descrição Tipo de Predefinição
dados Valor
DefaultRequiredPermission Especifica a Permissão Personalizada que um usuário deve ter para Corda ( nenhum )
executar DataRaptors e Procedimentos de Integração.
A configuração Required Permission, que você pode especificar

opcionalmente ao criar um DataRaptor ou Integration Procedure,
substitui essa configuração.
Se esta configuração estiver ausente ou em branco, todos os usuários

podem executar qualquer
DataRaptors ou Procedimentos de Integração que não possuem valores
de Permissão Necessária.
Permissões personalizadas para usuários são definidas em Perfis ou

Conjuntos de permissões do Salesforce .
Para que esta configuração funcione, o

VlocityRequiredPermissionCheck deve ser
implementado. Consulte Implementar o

company
Classe VlocityRequiredPermissionCheck .
CheckCachedMetadataRecordSecurity Por padrão, os dados armazenados em cache não são protegidos Verdadeiro Falso
quando você usa as configurações de compartilhamento do /
Salesforce ou conjuntos de compartilhamento para garantir o Falso
acesso. Se True, essa configuração executa uma verificação de
segurança em nível de registro para dados armazenados em cache.
Isso diminui um pouco o benefício de desempenho do cache de
metadados. Essa configuração não é necessária se você usar
Permissões Personalizadas para proteger o acesso.
Implemento a VlocityRequiredPermissionCheck Classe

Para que a configuração DefaultRequiredPermission funcione, você deve implementar a
VlocityRequiredPermissionCheck manualmente porque o Salesforce lida com classes em pacotes gerenciados
e não gerenciados de forma diferente. Esta classe não funciona corretamente se estiver incluída no pacote
gerenciado Vlocity .
Para obter detalhes de DefaultRequiredPermission , consulte DataRaptor e Configurações de segurança do

1. Em Configuração, na caixa Busca rápida , digite apex .

2. Clique em Classes do Apex .
3. Clique em Novo .
4. Insira o seguinte código do Apex na guia Classe do Apex:

{
global Boolean call(String action, Map<String, Object> args )
{
if (ação == ' checkPermission ')
{
return checkPermission ((String) args.get (' requiredPermission ') );
}
company
retorna falso; }
OmniStudio Integration Procedures

private Boolean checkPermission (String requiredPermission )
{
List<> customPermissionsName = requiredPermission.split (',' );
for (String permissionName : customPermissionsName )
{
if ( hasPermissão == true)
{
parar;
}
}
return hasCustomPermission ;
}
}
do OmniStudio são processos declarativos do lado do servidor que executam várias ações em uma única
chamada de servidor. Os procedimentos de integração podem ler e gravar dados do Salesforce e de sistemas
externos (usando chamadas REST) e podem chamar o código Apex. Um Procedimento de Integração pode ser
chamado de um método OmniScript , API ou Apex e pode ser uma fonte de dados para um FlexCard .
Os Procedimentos de Integração são ideais quando você precisa acessar e transformar dados de fontes de
terceiros e nenhuma interação do usuário é necessária, e é desejável mover a carga de trabalho do cliente
para o servidor.
Os Procedimentos de Integração podem fazer algumas coisas que os OmniScripts não podem, sendo a mais
importante o processamento de listas com Blocos de Loop e Ações de Lista. Os Procedimentos de Integração
podem executar mais etapas de processamento de dados do que os DataRaptors e são mais flexíveis do que os
Procedimentos de Cálculo.
GORJETA
Você pode assistir a um vídeo que mostra como criar um Procedimento de Integração.
O diagrama a seguir mostra o relacionamento entre um OmniScript e um Procedimento de Integração que ele
chama.

company
Veja Também
• DataRaptor ou Procedimento de Integração ?
• OmniScript Ação Elementos Referência
Crio um Procedimento de Integração

Para criar um procedimento de integração do OmniStudio , você deve nomeá-lo, configurá-lo, definir sua
lógica e visualizar como ele é executado. Você também pode exibir informações de depuração e definir opções
que se aplicam apenas a visualizações.
Para obter detalhes passo a passo de como criar exemplos de procedimentos de integração, consulte os
tópicos de bloco e ação em Etapas do procedimento de integração de grupo usando blocos e ações do
GORJETA
1. Vá para a guia Procedimentos de integração do OmniStudio .

2. Clique em Novo . A tela Novo Procedimento de Integração é exibida.
3. Na seção Configuração do procedimento , especifique as seguintes configurações:
• Nome do Procedimento de Integração: O nome exibido na guia Procedimentos de Integração de Vlocity
quando você expande o nó Tipo/ Subtipo .
• Tipo e Subtipo : o nó de nível superior na guia Procedimentos de Integração de Vlocity sob o qual você
deseja que o Procedimento de Integração seja listado.

company
Depois de fornecer um Nome, Tipo e Subtipo , você deve clicar em Salvar .
• Descrição: Uma descrição geral do Procedimento de Integração.
• Rastreamento de dados personalizados: pares de chave/valor a serem registrados quando o
procedimento de integração for executado, se o rastreamento está ativado.
• Incluir todas as ações na resposta: grave os resultados de cada ação no nível raiz do Data JSON . Por
padrão, os resultados são gravados no Data JSON em um nó com o mesmo nome da ação.
• Rollback on Error: Se ocorrer um erro, reverta as instruções de linguagem de manipulação de dados
(DML).
• Permissão necessária: especifica uma lista opcional separada por vírgulas de nomes de permissões
personalizadas. Para executar este Procedimento de Integração, um usuário deve ter uma dessas
permissões. Se essa configuração estiver em branco, qualquer usuário poderá executar este
Procedimento de Integração, a menos que uma DefaultRequiredPermission seja definida.
Salesforce .
Quando um Procedimento de Integração chama um DataRaptor ou outro Procedimento de Integração,
a configuração de Permissão Necessária do Procedimento de Integração de chamada substitui a
configuração de Permissão Necessária do DataRaptor ou Procedimento de Integração que está sendo
chamado.
• Limites encadeáveis e enfileirados: essas configurações controlam como os procedimentos de longa
duração são executados quando há risco de atingir os limites do administrador do Salesforce. Para
detalhes , consulte Configurações para LongRunning Procedimentos de Integração .
• Configuração de cache: essas configurações controlam o armazenamento em cache de metadados do
Procedimento de Integração e JSONdata . Ver Cache para DataRaptors e Procedimentos de Integração .
4. Para definir a lógica do Procedimento de Integração, arraste blocos e ações da paleta para o painel
Estrutura no painel Propriedades . Para obter detalhes sobre blocos, consulte Etapas do procedimento de
integração de grupo usando blocos . Para detalhes cerca de ações , consulte Ações do Procedimento de
Integração .
Quando uma etapa é executada, seus resultados são gravados no Data JSON em um nó com o mesmo
nome da etapa. As etapas subsequentes podem acessar os dados que foram gravados no Data JSON pelas
etapas anteriores.
5. Para testar o Procedimento de Integração, clique em Visualizar . No painel Parâmetro de entrada,
especifique os parâmetros que devem ser fornecidos pelos chamadores e clique em Executar . Verifique
se os resultados JSON são compostos corretamente de acordo com os requisitos do chamador.
6. Para visualizar as informações de depuração no modo de Visualização, exiba a área de janela Erro/Saída
de Depuração no lado direito do Integration Procedure Designer. Este painel contém a Segue subpainéis :
• Log de depuração: saída da execução de cada etapa do procedimento.
• Erros: Quaisquer erros que ocorreram durante a execução.
• Opções: JSON contendo sinalizadores booleanos que você pode definir para habilitar ou desabilitar as
opções de tempo de execução para depuração . Essas opções são apenas para depuração e, por
padrão, não estão em vigor quando o Procedimento de Integração é chamado de um OmniScript .
• isDebug : Habilita ou desabilita a exibição de informações de depuração.
• encadeável: ative ou desative o encadeamento durante a execução, para evitar que um procedimento
de longa execução exceda os limites do administrador do Salesforce . Para obter detalhes sobre
encadeamento, consulte Configurações para procedimentos de integração de longa duração .

company
• resetCache e ignoreCache : ative ou desative os recursos de cache. Para obter detalhes sobre
armazenamento em cache, consulte Cache para DataRaptors e procedimentos de integração .
Acessar dados de procedimento de integração JSON com campos de

mesclagem
Habilite os elementos do Procedimento de Integração e as propriedades do elemento para acessar dados
JSON usando campos de mesclagem. Um campo de mesclagem é uma variável que faz referência ao valor de
um nó JSON. Por exemplo, se um nó JSON for "FirstName": "John" , o campo de mesclagem %FirstName%
retornará John .
Os campos de mesclagem acessam o JSON de dados usando a sintaxe para indicar a um elemento do
Procedimento de Integração que um campo de mesclagem está presente. A sintaxe exige que você envolva um
caminho JSON completo com um sinal de porcentagem em ambas as extremidades.
NOTA
Casos de uso comuns

• Definir valores para renomear elementos, acessar nós JSON, executar fórmulas e preencher elementos. Ver
Definir valores para procedimentos de integração .
• Acesse os dados armazenados nos elementos do Procedimento de Integração em uma fórmula ou em uma
etapa futura.
• Dados de acesso retornados de uma ação. Por exemplo, uma Ação do DataRaptor ou uma Ação HTTP
retorna dados do Salesforce ou de uma fonte externa. Ver Ações do Procedimento de Integração .

mesclagem.
1. Localize o nome do nó JSON no JSON de dados do Procedimento de Integração.

mesclagem. Por exemplo, um campo de mesclagem acessando um nó JSON chamado firstName deve usar
a sintaxe % firstName % .
3. Visualize o Procedimento de Integração para garantir que o campo de mesclagem funcione corretamente.
Sintaxe Adicional
Nó JSON Sintaxe do campo de mesclagem Exemplo
" Informações de contato ": { Use um símbolo de dois pontos : para acessar um nó JSON aninhado.
" Nome ": "João"
} % ContactInfo:FirstName %

company
" Informações de contato ": { Use |n para acessar um nó específico em uma lista. Este campo de mesclagem retorna Steve :
" ContactInfoList ": [
{ %ContactInfo:ContactInfoList|3:FirstName%
"Nome": "João"
},
{
"Nome": "Adão"
},
{ " Nome ":
"Steve"
}
]
}
Etapas do procedimento de integração do grupo usando blocos

Em um procedimento de integração do OmniStudio , você pode executar um grupo de etapas relacionadas
como uma unidade dentro de um bloco para executá-las condicionalmente, armazená-las em cache, repeti-las
para cada item em uma lista ou retornar um erro se falharem.
Os Procedimentos de Integração fornecem estes tipos de bloco:
• Bloco Condicional — Executa o bloco se uma condição especificada for verdadeira ou trata as etapas dentro
dele como uma série de alternativas mutuamente exclusivas. este é a a maioria básico quadra tipo .
• Bloco de cache — Salva a saída das etapas dentro dele em uma sessão ou cache da organização para
recuperação rápida.
• Loop Block — Repete as etapas dentro dele para cada item em uma matriz.
• Bloco Try-Catch — Retorna a saída especificada ou chama uma classe do Apex se uma etapa dentro dela
falhar.
Você pode aninhar blocos dentro de outros blocos. Por exemplo, você pode aninhar um Loop Block em um
Try-Catch Block ou um Cache Block.
Todos os blocos têm uma propriedade em comum: Fórmula Condicional de Execução . Se esta fórmula for
avaliada como verdadeira ou não estiver definida, o bloco será executado. Se for avaliado como falso, o bloco
será ignorado.
Definir lógica de execução usando blocos condicionais

Um Bloco Condicional é executado em sua totalidade se uma expressão for verdadeira, executar uma de um
conjunto de condições mutuamente exclusivas definidas nas etapas que contém ou ambas.
Para controlar se uma ação individual é executada, defina sua Fórmula Condicional de Execução para uma
expressão que pode ser avaliada como Verdadeiro ou Falso. Se a expressão for avaliada como True em tempo
de execução, a etapa será executada.
Para condicionar a execução de um grupo de ações, coloque-as dentro de qualquer bloco e defina a Fórmula
Condicional de Execução do bloco. Se a fórmula for avaliada como True em tempo de execução, as ações no
bloco serão executadas. Se uma ação em um bloco tiver sua própria Fórmula Condicional de Execução , ela
será executada somente se sua fórmula for avaliada como True em tempo de execução.
O Bloco Condicional é o tipo de bloco mais simples. A menos que você marque Is If Else Block , ele não tem
lógica interna. Ou executa ou não de acordo com sua Fórmula Condicional de Execução .
Como compor IF - ELSEIF - ELSE Logic

company
Para definir um conjunto de condições mutuamente exclusivas, use um Bloco Condicional e marque Is If Else
Block . Para cada ação no bloco, especifique uma condição exclusiva em sua Fórmula Condicional de Execução
. A seqüência de ações é importante: Quando o bloco é executado, a primeira ação que possui uma Fórmula
Condicional de Execução que avalia como Verdadeira é executada, então a execução é retomada com a etapa
seguinte ao Bloco Condicional. Nenhuma outra ação no bloco é executada. Para configurar uma etapa que
será executada se nenhuma das etapas anteriores for executada, deixe a Fórmula Condicional de Execução da
última etapa em branco. A figura a seguir ilustra o uso dessa lógica para realizar uma ação diferente,
dependendo do tipo de dispositivo. O próprio Bloco Condicional é executado apenas quando o dispositivo que
está sendo processado vem da Apple, e o bloco contém ações que são executadas apenas para um tipo
específico de dispositivo. Para executar várias ações para uma condição, você pode aninhar blocos
condicionais.
Veja Também
• Condicional Quadra Propriedades
• Criar um exemplo de bloco condicional com a lógica If-Elseif-Else
Propriedades do bloco condicional

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nos Blocos Condicionais. Um Bloco
Condicional é executado em sua totalidade se uma expressão for verdadeira, executar uma de um conjunto de
condições mutuamente exclusivas definidas nas etapas que contém ou ambas.
Execução Condicional Especifica que todo o Bloco Condicional é executado somente se esta fórmula for avaliada como verdadeira.
Fórmula
É Se Mais Bloquear Especifica que todas as ações dentro do bloco, exceto opcionalmente a última, têm valores de Fórmula Condicional de
Execução mutuamente exclusivos. Se a última ação tiver uma Fórmula Condicional de Execução em branco , ela será
executada somente se os valores da Fórmula Condicional de Execução de todas as outras ações forem avaliados como
falso.
Veja Também
• Etapas do procedimento de integração do grupo usando blocos

Criar um exemplo de bloco condicional com a lógica If-Elseif-Else
Com base em um preço e um código de estado, um Procedimento de Integração calcula o imposto sobre
vendas e relata o preço total. Para resumir, apenas quatro códigos de estado estão incluídos: WA, OR, CA e
NV.
O Procedimento de Integração tem estes componentes:

company
• Um condicional Bloco , nomeado Impostos estaduais sobre vendas
• Componentes Definir valores dentro do bloco condicional, denominados IfCA , IfOR , IfWA , IfNV e
IfOtherState
• Componentes Set Values seguindo o Bloco Condicional, denominado CalculateTax e AssembleOutput
• Uma ação de resposta, chamada ResponseThe Structure panel tem esta aparência:
Para construir este Procedimento de Integração:
1. Na guia Procedimentos de integração do OmniStudio , clique em Novo .

2. Forneça um Nome de Procedimento de Integração , um Tipo e um Subtipo e clique em Salvar .
3. Arraste um Bloco Condicional para o painel Estrutura, defina seu Nome de elemento como
StateSalesTaxes e marque Is If Else Block .
4. Arraste um componente Set Values para o Conditional Block e defina as seguintes configurações:
a. Defina o nome do elemento como IfCA .
b. Em Mapa de valores do elemento, clique em Adicionar valor . Defina o nome do elemento como
CASalesTax e o valor como 0,0866 .
c. Defina o caminho JSON de resposta como CASalesTax .
d. Defina o nó JSON de resposta como SalesTax .
Essas configurações de resposta copiam o valor CASalesTax para um nó JSON de nível superior chamado
Imposto sobre vendas . Um nó de nível superior não está vinculado a uma etapa específica. Isso
permite que qualquer etapa defina seu valor. Ele também permite que qualquer etapa acesse seu
valor usando o mesmo caminho, independentemente de qual etapa definiu seu valor.
e. Defina a Fórmula Condicional de Execução para State == "CA" .
5. Repita a etapa anterior para configurar mais quatro componentes Set Values dentro do Bloco
Condicional com as seguintes configurações:

company
Propriedade SeOR IfWA Se NV IfOtherState
Elemento Nome SeOR IfWA Se NV IfOtherState
Mapa de valor do elemento, nome do elemento ORSalesTax WASales Tax NVSalesTax Imposto sobre
vendas padrão
Elemento Mapa de valor , valor 0 0,0921 0,0832 0,07
Caminho JSON de resposta ORSalesTax WASales Tax NVSalesTax Imposto sobre

vendas padrão
Nó JSON de resposta Imposto sobre vendas Imposto sobre vendas Imposto sobre Imposto sobre
vendas vendas
Execução Condicional Fórmula Estado == "OU" Estado == "WA" Estado == "NV" ( deixar em branco )
6. Arraste um componente Definir Valores após o Bloco Condicional e defina seu Nome do Elemento como
CalculateTax . Em Element Value Map, dê as seguintes configurações:
Elemento Nome Valor
Imposto =(% Preço % * % Imposto sobre Vendas %)
Taxa de imposto =(% Imposto sobre vendas % * 100)
Total =(% Preço % + (% Preço % * % SalesTax %))
7. Arraste um componente Set Values após o anterior e defina seu Element Name como AssembleOutput .
Clique em Editar como JSON e edite o nó ElementValueMap da seguinte maneira:
" elementValueMap ": {

"Resultado": {
"Preço": "%Preço%",
"Estado": "%Estado%",
" Imposto ": "% CalcularImposto:Imposto %",
" TaxRate ": "% CalcularTax:TaxRate %",
"Total": "% CalcularImposto:Total %"
}
},
8. Arraste uma ação de resposta após o componente anterior e defina as seguintes configurações:
a. Defina o nome do elemento como Response .
b. Defina o Send JSON Path para AssembleOutput:Output .
c. Defina o nó de envio JSON como saída .
9. Vá para a guia Visualizar e clique em Editar como JSON .
10. Cole a seguinte entrada no painel Parâmetros de entrada:
{
" Preço ": "250",
" Estado ": "CA"
}
11. Clique em Executar . Os dados de saída têm a seguinte estrutura:
{
"Resultado": {
"Preço": "250",
"Estado": "CA",
"Imposto": 21,65,
" Taxa de imposto ": 8,66,
"Total": 271,65
}
company
}
12. Altere os valores de Preço e Estado , clique em Executar e veja como os valores de Saída mudam.
Veja Também
• Definir lógica de execução usando blocos condicionais
Melhore o desempenho usando blocos de cache

Usar um cache para armazenar dados acessados com frequência e atualizados com pouca frequência
economiza viagens de ida e volta ao banco de dados e melhora o desempenho. Use Blocos de Cache se
algumas partes do Procedimento de Integração atualizarem dados ou se você precisar que dados em cache
diferentes expirem em momentos diferentes. Por exemplo, os dados climáticos atuais mudam com mais
frequência do que os dados da sessão do usuário.
É importante entender como o cache do Procedimento de Integração de nível superior interage com os Blocos
de Cache. Consulte Cache para DataRaptors e procedimentos de integração .
Um bloco de cache salva a saída das etapas dentro dele em um cache de sessão ou organização na partição de
cache VlocityAPIResponse para recuperação rápida.
Aqui está um exemplo de configuração de bloco de cache:

Opções de teste para cache de bloco de cache na visualização
Ao testar um Procedimento de Integração que inclui um Bloco de Cache na guia Visualização, você pode usar
duas configurações de cache na seção Opções JSON. Essas configurações também afetam o cache de nível
superior, mas não têm efeito no cache de metadados.
• ignoreCache — Não limpa nem salva dados no cache. O valor padrão é true . Use esta configuração para
testar as etapas do Procedimento de Integração sem a possível interferência de efeitos de armazenamento
em cache.
• resetCache — Força os dados a serem salvos no cache. O valor padrão é false . Use esta configuração
como parte do testando cache próprio .
company
NOTA
Para testar o cache, certifique-se de definir ignoreCache como false . Consulte Criar um exemplo
de bloco de cache .
O painel Opções na guia Visualizar se parece com isso:
Você pode passar ignoreCache e resetCache como parâmetros ao invocar um Procedimento de Integração que
usa cache usando uma API REST. Por exemplo, você pode incluir ? resetCache =true na URL para forçar o
cache. Consulte Invocação do procedimento de integração usando POST .
Nós JSON do bloco de cache

Um procedimento de integração ativo que usa um bloco de cache pode incluir os seguintes nós JSON em sua
saída de log de depuração, que é visível na guia Visualização:
• vlcCacheKey — Chave para quaisquer dados armazenados no cache

• vlcCacheResult — Incluído e definido como verdadeiro se os dados forem recuperados do cache
• vlcCacheEnabled — Incluído e definido como false se a configuração ignoreCache desabilitar o cache
• vlcCacheException — Qualquer cache erros
Esses nós estão sob o nó Info do Bloco de Cache. Por exemplo, se o Cache Block for denominado CacheBlock1,
esses nós estarão sob o nó CacheBlock1Info . Por exemplo :

company
Métodos do Apex para limpar os dados do bloco de cache
Se você precisar limpar os dados do Cache Block do cache, siga as instruções neste tópico , mas execute uma
destas linhas de código:
IntegrationProcedureService.clearSessionCache (' Tipo _ Subtipo ', ' blockName ', novo

Map<String, Object>{' key ' => ' value '} );
IntegrationProcedureService.clearOrgCache (' Tipo _ Subtipo ', ' blockName ', novo

IntegrationProcedureService.clearSessionCache (' vlcCacheKey ' );
IntegrationProcedureService.clearOrgCache (' vlcCacheKey ' );
Por exemplo, execute o seguinte código se:
• Você deseja limpar uma chave de bloqueio de cache no cache da organização

• O parâmetro Type_Subtype para o Procedimento de Integração é LastNames_Cached
• O bloco de cache é denominado CacheContacts
• A chave de cache que você deseja limpar é ContactLastName
• A chave valor é Smith
IntegrationProcedureService.clearOrgCache (' LastNames_Cached ', ' CacheContacts ',

new Map<String, Object>{' ContactLastName ' => 'Smith'} );
O exemplo a seguir limpa o cache da sessão usando um valor vlcCacheKey :
IntegrationProcedureService.clearSessionCache('2032076016a1745801061oc');
Veja Também
• Bloqueio de cache Propriedades
company
• Criar um bloco de cache Exemplo
Bloqueio de cache Propriedades

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nos Blocos de Cache. Use Blocos de
Cache se algumas partes do Procedimento de Integração atualizarem dados e, portanto, não devem ser
armazenadas em cache, ou se diferentes dados armazenados em cache expirarem em momentos diferentes.
Plataforma Salesforce Especifica o tipo de cache :

Tipo de cache
• Cache de sessão — Para dados relacionados a usuários e suas sessões de login
• Cache da organização — Para todos os outros tipos de dados
Hora de morar Determina por quanto tempo os dados permanecem no cache. O valor mínimo é 5. Os valores padrão e máximo
Minutos dependem do tipo de cache:
• Cache de sessão — O valor padrão é 5. O valor máximo é 480, equivalente a 8 horas. No entanto, o cache é limpo
quando a sessão do usuário expira.
• Cache da organização — O valor padrão é 5. O valor máximo é 2880, equivalente a 48 horas.
O cache de nível superior substitui o cache do bloco de cache pela duração do valor de tempo de vida em minutos de
nível superior .
Chaves de cache Pares configuráveis de chave/valor a serem armazenados no cache. Insira uma chave e defina o valor para a resposta de
uma ação dentro do bloco de cache. O valor pode usar a sintaxe do campo de mesclagem, sinais de porcentagem em
ambos os lados do nome do nó, para acessar e ssa resposta. As chaves de cache estão disponíveis, ou com escopo
definido, apenas dentro do Bloco de Cache.
Saída do bloco de cache Pares de Chave/Valor configuráveis a serem disponibilizados para as etapas subsequentes do Procedimento de
Integração. Insira uma chave e defina o valor para a resposta de uma ação dentro do bloco de cache. O valor pode usar
a sintaxe do campo de mesclagem, sinais de porcentagem em ambos os lados do nome do nó, para acessar essa
resposta.
Atualizar cache Se a fórmula for avaliada como verdadeira, força os dados a serem salvos no cache.
Condicional Fórmula
Ignorar cache Se a fórmula for avaliada como verdadeira, não limpará nem salvará os dados no cache.
Adicionar ao cache Se a fórmula for avaliada como verdadeira, salva os dados no cache. Se false, não armazena dados em cache.
Fórmula condicional
Falhou Sobre Etapa Erro Se esta caixa estiver marcada em uma etapa do Bloco de Cache e essa etapa falhar, nenhum dado será armazenado em
cache.
Veja Também
• Melhore o desempenho usando blocos de cache
Criar um bloco de cache Exemplo

Um procedimento de integração aceita uma lista de nomes ou sobrenomes e recupera os contatos com esses
nomes. Um bloco de cache melhora o desempenho de recuperação de contatos.
Este Procedimento de Integração também inclui um Loop Block; consulte Processar arrays usando blocos de
loop .
Este Procedimento de Integração tem estes componentes:
• bloco de cache , chamado CacheBlock1

• Um Loop Block dentro do Cache Block, chamado LoopBlock1
• Uma ação de extração do DataRaptor dentro do bloco de loop, chamada ExtractContact
• Uma Ação de Resposta, chamada ResponseActionO painel Estrutura tem esta aparência:
company

3. Arraste um Bloco de Cache para o painel Estrutura e defina as seguintes configurações:
Propriedade Valor
Tipo de cache da plataforma Salesforce Cache da organização
Tempo para viver em minutos 5
Chaves de cache contactId definido como % ExtractContact:Contact:Id % contactName

definido como % ExtractContact:Contact:Name %
Saída do bloco de cache LoopBlock1 definido como %LoopBlock1%
4. Arraste um Loop Block dentro do CacheBlock e dê as seguintes configurações:

Propriedade Valor
Lista de loops nomes
Saída de Loop Adicional ExtractContact definido como % ExtrairContato %
5. Crie a extração do DataRaptor que a ação de extração do DataRaptor chama, nomeie-a como
ExtractContactName e forneça as seguintes configurações:
Aba Definições
Extrair Uma etapa de extração de contato definida como nome de contato LIKE nome
Resultado Um mapeamento de Contact:Id para Contact:Id
Um mapeamento de Contact:Name para Contact:Name
Se você não tiver certeza de como criar uma extração do DataRaptor , consulte os exemplos em Exemplos
de extração do DataRaptor .
6. Arraste uma Ação de Extração do DataRaptor dentro do Bloco de Loop e defina as seguintes
configurações:
Propriedade Valor
Elemento Nome Extrair contato

company
Interface do DataRaptor ExtrairNomeContato
Fonte de dados nomes: nome
Filtro Valor nome
7. Arraste uma Ação de Resposta abaixo do Bloco de Loop e defina as seguintes configurações:
Propriedade Valor
Enviar caminho JSON CacheBlock1
8. Para testar este procedimento de integração, na guia Visualização, clique em Editar como JSON e forneça
a entrada com a seguinte estrutura:
{
"nomes": [
{
"nome": "Miller"
},
{
"nome": "Torres"
}
]
}
Para demonstrar o desempenho de forma mais eficaz, especifique nomes comuns e/ou muitos.
9. Clique em Executar e observe os valores resultantes do navegador, servidor e CPU do Apex.
10. Abra o painel Opções e altere o valor ignoreCache para false .
11. Clique em Executar novamente. Esta etapa preenche o cache, portanto, os valores resultantes do
navegador, servidor e CPU do Apex devem ser semelhantes aos valores anteriores.
12. Clique em Executar uma terceira vez. Esta etapa usa os valores armazenados em cache, portanto, os
valores resultantes do navegador, servidor e CPU do Apex devem ser notavelmente menores do que os
valores anteriores.
13. Para ver os nós vlcCacheKey e vlcCacheResult , abra o Debug Log e role até o nó CacheBlock1Info .

company
Veja Também

Processo Matrizes Usando blocos de loop

Um Loop Block itera sobre os itens em uma matriz de dados, permitindo que as ações dentro dele se repitam
para cada item. Por exemplo, em Vlocity Communications, Media e Energy, sem um Loop Block, adicionar
quatro produtos a um carrinho exigiria a execução de quatro ações remotas separadas. Mas uma ação remota
dentro de um bloco de loop pode adicionar todos os quatro produtos.
A entrada do array para o Loop Block é processada de forma que cada iteração receba apenas um item no
array. Por exemplo, suponha que a entrada do array tenha esta aparência:
{
"Produtos": {
"Identificações": [
{
"ID": 1
},
{
"ID": 2
}
]
}
}
Cada iteração do Loop Block receberia uma entrada parecida com esta:
{
"Produtos": {
"IDs": {
"ID": 1
}
}
}
A entrada de iteração são os dados aos quais as Ações dentro do Bloco de Loop têm acesso.

company
Para configurar um Bloco de Loop:
1. Arraste um Loop Block para o painel de estrutura.

2. No campo de propriedade Loop Block rotulado Loop List , insira o nome de um nó JSON que contém uma
matriz de dados. Por exemplo, inserir Products:Ids fornece uma lista de IDs para a ação. O nome do nó
JSON não precisa ser inserido com a sintaxe do campo de mesclagem.
3. Adicione qualquer ação que precise iterar sobre a matriz e passe o caminho completo da matriz para a
ação.
Por exemplo, se a Loop List for definida como uma matriz chamada Products:Ids que contém pares de
valores-chave de Ids, o caminho completo na ação seria Products:Ids:Id .
Para obter mais informações sobre Ações, consulte Ações do procedimento de integração .
NOTA
O Procedimento de Integração para de ser executado e retorna uma resposta de { "Success":
"False" } se uma Ação que tem Falha na Etapa de Erro marcada falhar.
4. No campo de propriedade Loop Block rotulado Loop Output , clique em Add Key/Value Pair para
adicionar pares de chave-valor para definir a resposta. O campo de valor usa a sintaxe do campo de
mesclagem, ou seja, o nome do nó da resposta definido entre dois sinais de porcentagem, por exemplo,
% ResponseData:Names % .
5. (Opcional) Adicione Lógica Condicional para definir quando o Bloco de Loop é executado. Para obter mais
informações sobre lógica condicional, consulte Definir lógica de execução usando blocos condicionais .
Para obter exemplos de bloco de loop adicionais, consulte Ação do procedimento de integração para
procedimentos de integração , Melhorar o desempenho usando blocos de cache e Cache para dados do
procedimento de integração de nível superior .
Veja Também
• Bloco de loop Propriedades
• Criar um exemplo de bloco de loop que recupera nomes
• Criar um exemplo de bloco de loop que cria contatos
• Criar um exemplo de bloco de loop que concatene itens de lista
Propriedades do Bloco de Loop

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nos Loop Blocks. Um Loop Block itera
sobre os itens em uma matriz de dados, permitindo que as ações dentro dele se repitam para cada item.
Lista de loops Aceita um nó JSON contendo uma matriz.
Saída de loop Pares de Chave/Valor configuráveis a serem disponibilizados para as etapas subsequentes do Procedimento de Integração.
Insira uma chave e defina o valor para a resposta de uma ação dentro do bloco de loop. O valor pode usar a sintaxe do
campo de mesclagem, sinais de porcentagem em ambos os lados do nome do nó, para acessar essa resposta. Por padrão, se
nenhum par de chave/valor for especificado, uma resposta de { "success": "OK" } será retornada para cada item processado
na matriz.
Use esta propriedade com cuidado. Ele retorna os dados que você solicita para cada iteração. Se o Loop Block iterar 1.000
vezes, ele retornará 1.000 respostas. Essa propriedade é mais útil para depurar ou retornar um conjunto de dados limitado.

company
Execução Controla se o Loop Block é executado com base em uma expressão avaliada como verdadeira ou falsa.
Condicional
Fórmula
Veja Também
• Processo Matrizes Usando blocos de loop
Criar um exemplo de bloco de loop que recupera nomes

Um Procedimento de Integração aceita sobrenomes e retorna os nomes completos de todos os Contatos com
os sobrenomes especificados.
• Um componente opcional Set Values, chamado SetValues1

• Um componente Loop Block, chamado LoopBlock1
• Um componente DataRaptor Extract Action dentro do Loop Block, chamado DataRaptorExtractAction1
• Uma extração do DataRaptor que usa o operador LIKE para localizar nomes semelhantes aos da entrada,
denominadosExtractFirstNames
• Uma ação de resposta, chamada ResponseAction1O painel Estrutura tem esta aparência:

3. Forneça entrada com a seguinte estrutura, usando sobrenomes de sua escolha:
{
"nomes": [
{
"Nome": "Miller"
},
company
{
"Nome": "Torres"
}
]
}
Você pode fornecer essa entrada para o Procedimento de Integração de duas maneiras:
• Na guia Visualizar. Clique em Editar como JSON e cole-o na área Parâmetros de entrada.
• Em um componente SetValues que você arrasta para o painel Estrutura. Clique em Editar como JSON e
cole-o no nó elementValueMap , substituindo o valor de nó padrão de {} .
4. Arraste um Loop Block para o painel Structure e defina as seguintes configurações:
Lista de loops Defina esse valor como nomes se a entrada estiver na guia Visualização ou como SetValues1:names se a entrada
estiver em um componente SetValues .
Loop Adicional Defina a Chave como DataRaptorExtractAc tion1 e o Valor como %DataRaptorExtractAction1% para retornar todas as
Resultado iterações de dados gerados pelo componente DataRaptor Extract Action.
ExtractFirstName e forneça as seguintes configurações:
Aba Definições
Extrair Uma etapa de extração de contato definida como Contact LastName LIKE Name
Resultado Um mapeamento de Contact:FirstName para Name:First
Um mapeamento de Contact:LastName para Name:Last
6. Arraste um componente DataRaptor Extract Action dentro do Loop Block e dê a ele as seguintes
configurações:
Interface do DataRaptor Defina esse valor como ExtractFirstName .
Parâmetros de entrada : Configure esse valor para names:Name se a entrada estiver na guia Visualização ou para SetValues1:names:Name
se a entrada estiver em um componente SetValues .
Fonte de dados
Parâmetros de entrada : Defina esse valor como Nome .
Filtro Valor
7. Arraste uma Response Action abaixo do Loop Block e marque Return Full Data JSON .
8. Clique em Executar na guia Visualizar. A saída deve ser algo como isto:
{
"resposta": {},
"ResponseAction1Status": verdadeiro,
"LoopBlock1": [
{
"DataRaptorExtractAction1": {
"Nome": [
{
"Último": "Miller",
"Primeiro": "Tom"
},
{

company
"Primeiro": "Sally"
}
]
},
"DataRaptorExtractAction1Status": verdadeiro,
" LoopBlockIterationStatus ": true,
" LoopBlockIterationIndex ": 1
},
{
"Nome": [
{
"Último": "Torres",
"Primeiro": "Maria"
},
{
"Primeiro": “Ricardo”
}
]
},
}
],
"LoopBlock1Status": verdadeiro,
"opções": {
"encadeável": falso
},
"nomes": [
{
"Nome": "Miller"
},
{
"Nome": "Torres"
}
]
}
Veja Também

Criar um exemplo de bloco de loop que cria contatos

company
Um procedimento de integração aceita um ID de conta e uma matriz de nomes e sobrenomes e cria novos
contatos para a conta especificada. Ele também inclui uma etapa que exclui esses contatos, que você pode
desativar opcionalmente.

• Um componente DataRaptor Post Action dentro do Loop Block, chamado CreateContact
• Uma carga do DataRaptor que cria um novo contato para uma conta existente, chamada
NewContactForAccount
• Um componente Delete Action dentro do Loop Block, chamado DeleteContact

3. Forneça a entrada com a seguinte estrutura, usando nomes de sua escolha:
{
"Contatos": [
{
"Nome": {
"Primeiro": "João",
"Último": "Doe"
}
},

company
{
"Nome": {
"Primeiro": "Junho",
"Último": "Doe"
}
}
]
}
Lista de loops Defina esse valor para Contatos se a entrada estiver na guia Visualizar ou para SetValues1:Contacts se a entrada
Loop Adicional Defina a Chave como CreateContact e o Valor como % CreateContact % para retornar todas as iterações de dados
Resultado gerados pelo componente DataRaptor Post Action.
5. Para criar o DataRaptor Load que o DataRaptor Post Action chama, crie o segundo exemplo em
DataRaptor Load Examples e denomine-o NewContactForAccount .
6. Arraste um componente DataRaptor Post Action dentro do Loop Block e defina as seguintes
configurações:
Nome Defina esse valor como CreateContact .
DataRaptor Defina esse valor como NewContactForAccount .

Interface
Entrada Adicional Defina a primeira chave como AccountId e seu valor como % AccountId % ou como %SetValues1:AccountId% se a
entrada estiver em um componente SetValues .
Defina a segunda Chave como Nome e seu valor como % Contacts:Name % ou como %SetValues1:Contacts:Name%
7. Arraste um componente Delete Action dentro do Loop Block e dê a ele as seguintes configurações:
Nome Defina esse valor como DeleteContact .
Excluir SObject : Defina esse valor como Contato .
Modelo
Excluir SObject : Defina este valor como %CreateContact:Contact_1:Id% .
Caminho para o ID
{
"resposta": {},
"LoopBlock1": [
{
" CriarContato ": {
" Hora Real ": 793,
" CpuTime ": 537,
company
"Contato_2": [
{
" UpsertSuccess ": verdadeiro,
"Id": "0034N00001qh5hVQAQ",
" LastName ": "Doe",
"Nome": "João"
}
],
"Conta_1": [
{
"Id": "0016100001BKL4uAAH"
}
],
"erro": "OK",
" responseType ": " SObject "
},
" DeleteContactStatus ": verdadeiro,
" CreateContactStatus ": verdadeiro,
},
{
" CriarContato ": {
" Hora Real ": 1262,
" CpuTime ": 799,
"Contato_2": [
{
"Id": "0034N00001qh5hWQAQ",
"Nome": "Junho"
}
],
"Conta_1": [
{
"Id": "0016100001BKL4uAAH"
}
],
"erro": "OK",
},
}
company
],
"SetValues1": {
"Contatos": [
{
"Nome": {
"Último": "Doe",
"Primeiro": "João"
}
},
{
"Nome": {
"Último": "Doe",
"Primeiro": "Junho"
}
}
],
" AccountId ": "0016100001BKL4uAAH"
},
"SetValues1Status": verdadeiro,
" opções ": {
" encadeável ": falso
}
}
Veja Também
Criar um exemplo de bloco de loop que concatene itens de lista
Um Procedimento de Integração concatena os valores dos itens em uma lista. Nesse caso, ele cria uma String
separada por sublinhado de QuoteLineItem Ids.
Para assistir a um vídeo que mostra como criar este Procedimento de Integração, clique aqui .
A entrada fica assim:
{
" QuoteLineItems ": {
{
"Id": "0QL3h000000VF04GAG"
},
{
"Id": "0QL3h000000VEvlGAG"
}
]
company
}
}
A saída fica assim:
{
"Saída": "0QL3h000000VF04GAG_0QL3h000000VEvlGAG"
}
• Um componente Set Values antes do Loop Block, chamado InitString

• Um Loop Block , chamado LoopBlock1
• Um componente Set Values dentro do Loop Block, chamado ConcatListItem
• Um componente Set Values após o Loop Block, chamado TrimUnderscore
• Uma ação de resposta , chamada ResponseAction1
O painel Estrutura tem esta aparência:

3. Arraste um componente Definir valores para o painel Estrutura e defina as seguintes configurações:
Elemento Nome Defina esse valor como InitString .
Mapa de valor do elemento, nome do elemento Clique em Adicionar novo valor e atribua um nome de elemento em branco .
Elemento Mapa de valor , valor Sair isto propriedade em branco .

company
Caminho JSON de resposta Defina esse valor como Em branco .
Nó JSON de resposta Defina esse valor como ConcatString .
Esse componente cria um nó JSON de nível superior inicialmente vazio chamado ConcatString . Um nó de
nível superior não está vinculado a uma etapa específica. Isso permite que qualquer etapa defina seu
valor. Ele também permite que qualquer etapa acesse seu valor usando o mesmo caminho,
independentemente de qual etapa definiu seu valor.
4. Arraste um Loop Block para o painel Structure e dê a ele um valor Loop List de QuoteLineItems:Ids .
5. Arraste um componente Set Values para o Loop Block e defina as seguintes configurações:
Elemento Nome Defina esse valor como ConcatListItem .
Mapa de valor do elemento, Clique em Add New Value e atribua um Element Name de Concat .
Nome do elemento
Elemento Mapa de valores , Atribua o seguinte valor :

Valor
=% ConcatString % + "_" + % QuoteLineItems:Ids:Id %
ConcatString de nível superior e o valor da lista atual.
Caminho JSON de resposta Defina este valor para Concat .
Em combinação com a fórmula Value , isso adiciona o valor da lista atual ao nó ConcatString de nível
superior.
6. Arraste um componente Set Values abaixo do Loop Block e dê a ele as seguintes configurações:
Elemento Nome Defina esse valor como TrimUnderscore .
Mapa de valor do elemento, nome do elemento Clique em Add New Value e atribua um nome de elemento de Trim .
Elemento Mapa de valor , valor Atribua um valor =SUBSTRING(ConcatString,1) .
7. Arraste uma ação de resposta abaixo do último componente Definir valores e defina as seguintes
configurações:
Enviar caminho JSON Defina esse valor como TrimUnderscore:Trim .
Enviar nó JSON Defina este valor para Saída .

9. No painel Parâmetros de entrada, forneça a entrada com a seguinte estrutura:
{
{
"Id": "0QL3h000000VF04GAG"
},
{
}
]
}
}
10. Clique em Executar . A saída deve ser algo como isto:
company
{
}
Veja Também
Lidar com erros usando blocos Try-Catch

Um bloco Try-Catch permite que você "tente" executar as etapas dentro dele e, em seguida, "capture" o erro
se uma etapa falhar.
Para configurar um bloco Try-Catch:
1. Arraste um bloco Try-Catch para o painel Estrutura e certifique-se de que a caixa de seleção Fail on Block
Error esteja marcada.
2. Configure o comportamento "catch" — o que o bloco Try-Catch fará se ocorrer uma falha. Você posso
escolher 1 ou Ambas do esses opções :
• Em Resposta de Falha , especifique um par chave-valor para retornar como resposta. O valor pode ser
uma fórmula. Nas versões Spring '20 e posteriores, o valor pode incluir campos de mesclagem.
• Em Resposta de falha personalizada , especifique uma classe remota e um método remoto para
executar uma classe do Apex. A classe Apex deve implementar VlocityOpenInterface .
3. Arraste as subetapas para o bloco Try-Catch e certifique-se de que a caixa de seleção Fail on Step Error
esteja marcada para cada etapa que deve acionar o comportamento "catch" se falhar.
Opcionalmente, você pode especificar uma Fórmula de condição de falha , que é avaliada como TRUE se
uma etapa específica não foi executada com êxito.
Veja Também
• Tente -Catch Block Propriedades
• Criar um exemplo de bloco Try-Catch
• Criar um exemplo de bloco Try-Catch com uma fórmula
Propriedades do bloco Try-Catch

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nos Blocos Try-Catch. Um bloco Try-
Catch permite que você "tente" executar as etapas dentro dele e, em seguida, "capture" o erro se uma etapa
falhar.
Falhou sobre Quadra Erro Especifica que, se o Bloco Try-Catch falhar, todo o Procedimento de Integração falhará.
Resposta de falha Uma resposta para retornar se o bloco Try-Catch falhar. O valor pode ser uma fórmula.
Um bloco Try-Catch pode ter uma resposta de falha e uma resposta de falha personalizada.
Personalizado Falha Uma classe remota e um método remoto de uma classe do Apex a ser executado se o bloco Try-Catch falhar. A classe
Resposta Apex deve implementar VlocityOpenInterface .
Veja Também
• Lidar com erros usando blocos Try-Catch

company
Criar um exemplo de bloco Try-Catch
sobrenome especificado e retorna uma mensagem de erro se o sobrenome estiver em branco.
• Um bloco Try-Catch, chamado TryCatchBlock1

• Uma ação de postagem do DataRaptor , chamada DataRaptorPostAction1
• Uma ação de exclusão, chamada DeleteAction1• Uma ação de resposta, chamada ResponseAction1 O
painel Estrutura tem esta aparência:

3. Arraste um bloco Try-Catch para o painel Estrutura e defina as seguintes configurações:
a. Em Resposta de falha, clique em Adicionar par de chave/valor . Defina a Chave como
failureResponse e o Valor como Você deve fornecer um sobrenome.
b. Certifique-se de que a caixa de seleção Fail on Block Error esteja marcada.
4. Crie o DataRaptor Load que o componente DataRaptor Post Action chama:
a. Dê a ele um nome de interface DataRaptor de CreateContact e um tipo de interface de carga .
b. Na guia Objetos, clique em Adicionar Objeto e selecione Contato .
c. Na guia Campos, clique no ícone + e insira LastName como Input JSON Path e Domain Object Field .
Se você não tiver certeza de como criar uma carga do DataRaptor , consulte os exemplos em Exemplos de
carga do DataRaptor .
5. Arraste um componente DataRaptor Post Action para o bloco Try-Catch e defina as seguintes
configurações:
a. Defina a Interface DataRaptor como CreateContact .
company
b. Certifique-se de que a caixa de seleção Fail on Step Error esteja marcada.
6. Arraste um componente Delete Action após o bloco Try-Catch. Em Delete SObject , defina o Type como
Contact e o Path To Id como %DataRaptorPostAction1:Contact_1:Id% .
7. Arraste uma Ação de Resposta para o painel Estrutura como o último componente e marque a caixa de
seleção Retornar JSON de Dados Completos .
8. Acesse a guia Visualizar e teste o Procedimento de Integração:
a. Em Parâmetros de entrada, clique em Adicionar novo par de chave/valor .
b. Defina a chave como sobrenome e o valor para qualquer nome que desejar.
c. Clique em Executar .
A saída deve ser algo como isto:
{
"resposta": {},
"ExcluirAção1": [
{
"erros": [],
"sucesso": verdadeiro,
"id": "0034N00001rNgqqQAC"
}
],
"DeleteAction1Status": verdadeiro,
"TryCatchBlock1": null,
"TryCatchBlock1Status": verdadeiro,
"DataRaptorPostAction1": {
" Hora Real ": 626,
" CpuTime ": 345,
"Contato_1": [
{
"Id": "0034N00001rNgqqQAC",
" LastName ": "Aristóteles"
}
],
"erro": "OK",
},
"DataRaptorPostAction1Status": true,
"opções": {
" queueableChainable ": false,
" ignoreCache ": verdadeiro,
" resetCache ": false,
},
}
9. Deixe o Valor em branco e clique em Executar novamente. A saída deve ser algo como isto:

company
"resultado": {
" failureResponse ": "Você deve fornecer um sobrenome."
},
" sucesso ": falso
}
Veja Também
Criar um exemplo de bloco Try-Catch com uma fórmula

Um Procedimento de Integração localiza Contatos com o Nome especificado e retorna uma mensagem de erro
se nenhum for encontrado. Como não retornar nenhum registro normalmente não é considerado uma falha, a
Ação de Extração do DataRaptor dentro do Bloco Try-Catch inclui uma Fórmula de Condição de Falha.

• Uma ação de extração do DataRaptor , chamada DataRaptorExtractAction1

failureResponse e o Valor como Nome %Name% não encontrado.

company
4. Crie o DataRaptor Extract que o componente DataRaptor Extract Action chama:
a. Dê a ele um nome de interface DataRaptor de GetContactName e um tipo de interface de extração
.
b. Na guia Extrair, clique em Adicionar etapa de extração e selecione Contato . Especifique o caminho
e filtre Contact Name LIKE Name .
c. Na guia Saída, clique no ícone + e insira Contact:Name como Extract JSON Path e ContactName
como Output JSON Path .
5. Arraste um componente DataRaptor Extract Action dentro do bloco Try-Catch e dê a ele as seguintes
configurações:
a. Defina a Interface DataRaptor como GetContactName .
c. Especifique ISBLANK(DataRaptorExtractAction1) como a Fórmula de condição de falha .
6. Arraste uma ação de resposta após o bloco Try-Catch e marque a caixa de seleção Return Full Data JSON .
b. Defina a Chave para Nome e o Valor para qualquer nome ou sobrenome que desejar.
Se pelo menos um contato com esse nome for encontrado, a saída deve ser semelhante a esta:
{
"resposta": {},
"DataRaptorExtractAction1": [
{
" ContactName ": "Amy Argent"
},
{
" ContactName ": "Amy Smith"
}
],
"opções": {
},
"Nome": "Amy"
}
8. Altere o valor para um nome incomum (ou deixe-o em branco) e clique em Executar novamente. A saída
deve ser algo como isto:
{
"resultado": {
company
" failureResponse ": "Nome Murgatroyd não encontrado."
},
" sucesso ": falso
}
Veja Também

Para compor um Procedimento de Integração, você adiciona ações que são executadas sequencialmente.
Essas ações podem definir valores de dados, executar funções, chamar DataRaptors , invocar classes do Apex,
enviar e-mails, invocar endpoints REST, executar outros procedimentos de integração e muito mais.
Para adicionar uma ação, arraste-a da paleta para o painel Estrutura e configure suas propriedades. Você pode
editar, renomear, mover e excluir ações. Você também pode usar blocos para agrupar ações para execução
condicional, armazenamento em cache, processamento de lista e tratamento de erros.
Para obter detalhes sobre ações específicas do Procedimento de Integração, consulte os tópicos das ações.
Veja Também
• Crio um Procedimento de Integração
Propriedades da ação do procedimento de integração comum

Para compor um Procedimento de Integração, você adiciona uma sequência de ações. Para configurar uma
ação, você define as propriedades da ação. As propriedades padrão que existem na maioria ou em todas as
ações estão listadas aqui. Todas as propriedades são do tipo de dados String, salvo indicação em contrário.
Para obter detalhes sobre as propriedades de ações específicas, consulte os tópicos das ações.
Elemento Nome Etiqueta do elemento script
Enviar caminho JSON Apara o JSON de entrada para o caminho especificado antes que a ação seja executada. Ver Manipular JSON com a
Enviar nó JSON Reparenta o JSON de entrada no nó especificado. Consulte Manipular JSON com as propriedades de transformações de
envio/resposta .
Resposta JSON Depois que a ação for executada, apara o JSON de saída para o caminho especificado. Ver Manipular JSON com a
Caminho Transformações de envio /resposta Propriedades .
Resposta JSON Reparenta o JSON de saída no nó especificado. Para delimitar o caminho, use dois pontos; por exemplo
Nó level1:level2:level3. Ver Manipular JSON com a Transformações de envio /resposta Propriedades .
Enviar apenas adicionais Se marcada, aceita apenas os dados na propriedade Entrada Adicional.
Entrada
Entrada Adicional Pares de chave/valor adicionais a serem incluídos no JSON de dados de entrada. Valores pode incluir fórmulas e mesclar
campos .
Somente devolução Se marcada, retorna apenas os dados na propriedade Saída Adicional.

Saída Adicional

company
Saída Adicional Pares de chave/valor adicionais a serem retornados no JSON de dados de saída. Valores pode incluir fórmulas e mesclar
campos .
Falha de envio apenas Se marcado, retorna apenas a Resposta de Falha se a ação falhar.
Resposta
Resposta de falha Pares de chave/valor a serem retornados no JSON de dados de saída se a ação falhar. Valores pode incluir fórmulas e
mesclar campos .
Execução Especifica uma fórmula que é executada antes que a etapa seja executada. Se a fórmula retornar TRUE, a etapa será
Condicional Fórmula executada. Se a fórmula retornar FALSE, a etapa não será executada. Se nenhuma fórmula é especificado , o degrau é
executado .
Falha Condicional Especifica uma condição de falha personalizada que é executada após a execução da etapa.
Fórmula
Por exemplo, se uma Ação de Extração do DataRaptor não encontrar nenhum registro, isso normalmente não é
considerado um erro, mas você pode usar uma Fórmula Condicional de Falha para especificar essa condição. Veja o
segundo exemplo em Manipular Erros Usando Blocos Try-Catch .
Se a fórmula retornar TRUE, a execução da etapa falhou e todos os pares de chave/valor configurados na lista de
Respostas a falhas são adicionados ao JSON de dados. Por exemplo, se o seguinte JSON for retornado:
{
"Resultado": {
" ErrorCode ": "ERR-123",
"Sucesso": "FALSO"
}
}
...as configurações a seguir capturam o erro e adicionam o código de erro ao JSON de dados:
• Fórmula Condicional de Falha: Resultado:Sucesso == 'FALSO'

• Resposta de falha :
• Chave: ErrorCode
• Valor : % StepName:Result:ErrorCode %
Falhou Sobre Etapa Erro Se definido como TRUE, o Procedimento de Integração termina se esta etapa falhar.
Corrente ligada Etapa Permite que a ação seja executada em sua própria transação do Salesforce. Isso pode diminuir o desempenho, mas
diminuirá a probabilidade de exceder os limites do administrador do Salesforce. Para obter mais informações, consulte
Configurações para procedimentos de integração de longa duração .
Adicional Encadeável Especifica um par de valores-chave que é enviado na resposta. O campo de valor aceita a sintaxe do campo de
Resposta mesclagem.
Ação Mensagem Envia uma mensagem ao usuário se esta for a primeira Mensagem de Ação no Procedimento de Integração ou se esta
ação estiver encadeada. Útil para ações de longa duração .
Notas internas Texto descritivo que apenas alguém que está visualizando o Procedimento de Integração no aplicativo Procedimento de
Integração Vlocity vê.
Definir valores para procedimentos de integração

A ação Definir Valores define valores no JSON de dados de um Procedimento de Integração literalmente,
usando campos de mesclagem ou fórmulas. Esta ação tem muitos usos. O exemplo inclui os usos mais comuns.
Exemplo de usos de ações de valores definidos

O Procedimento de Integração que demonstra Definir Valores usa reestrutura, concatena e executa cálculos
simples nos dados de entrada. Todos os seus componentes são ações de Definir Valores, exceto o último, que
é uma Ação de Resposta.
Este exemplo de Procedimento de Integração tem a seguinte estrutura:

company
Para criar o Procedimento de Integração, vá para a guia Procedimentos de Integração do OmniStudio e clique
em Novo . Forneça um Nome de Procedimento de Integração , um Tipo e um Subtipo e clique em Salvar .
Para criar cada componente, arraste uma instância Definir valores para o painel Estrutura e edite sua primeira
propriedade Nome do elemento . Para o último componente, arraste em uma ação de resposta.
Os dados de entrada têm a seguinte estrutura:
{
"Nome": {
"Nome": "João",
},
"Finanças": {
" Renda Bruta ": "100.000",
"Despesas": "60000"
}
}
Entradas: renomear nós nos dados de entrada

Esse componente reduz e simplifica os nós JSON de entrada. Defina seu Mapa de Valor de Elemento da
seguinte forma:

company
Elemento Nome Valor
Primeiro nome % Nome: Nome %
Sobrenome % Nome: Sobrenome %
Renda Bruta % Finanças: % de Renda Bruta
Despesas % Finanças: Despesas %
LocationData : adicionar valores literais

Este componente adiciona valores literais, que são úteis para testar ou especificar dados que não mudam .
Defina seu Mapa de Valor de Elemento da seguinte maneira:
Elemento Nome Valor
Localização São Francisco
Código 2345
TextWithCode : concatenar valores literais e mesclar campos

Este componente mostra como concatenar uma string literal com um campo de mesclagem. Defina seu
elemento Mapa de valores da seguinte forma:
Elemento Nome Valor
Código de localização Código é % LocationData:Code %
Observe que o campo de mesclagem % LocationData:Code % recupera dados do componente anterior,

LocationData .
DeptArray : Defina uma matriz

Este componente define uma matriz ou lista de valores. Um componente posterior recuperará um valor da
matriz. Para configurar uma matriz, clique em Editar como JSON e edite o nó ElementValueMap da seguinte
forma:

"Departamentos": [
"Vendas",
"Desenvolvimento",
"Apoiar",
"Treinamento"
]
},
AfterTax e CalculateNet : faça cálculos simples usando fórmulas

Esses componentes calculam o lucro após os impostos usando a multiplicação e o lucro líquido usando a
subtração. Observe que cada operador tem espaços antes e depois dele. Defina o Elemento Mapa de valor de
AfterTax da seguinte forma:
Elemento Nome Valor

company
AfterTax Income =% de entradas:GrossIncome % * 0,7
Defina o Mapa de Valor do Elemento de CalculateNet da seguinte

forma:
Elemento Nome Valor
Resultado líquido =% AfterTax:AfterTaxIncome % - % Entradas:Despesas %
ConcatName : Concatenar Dois campos de mesclagem

Este componente combina nomes e sobrenomes para formar nomes completos. Defina seu elemento Mapa de
valores da seguinte forma:
Elemento Nome Valor
Nome completo =% Entradas:Nome % + " " + % Entradas:Sobrenome %
Observe como um espaço literal é incluído.
RetrieveDept : usar uma função e recuperar um valor de matriz

Este componente usa a função SE. Ele também usa listnode | notação listnumber para recuperar valores de
matriz. Defina seu elemento Mapa de valores da seguinte forma:
Elemento Nome Valor
Departamento =IF(% Inputs:FirstName % = "John",%DeptArray:Departments|2%,%DeptArray:Depart ments|3%)
Este componente atribui um valor de Departamento de Desenvolvimento a qualquer pessoa chamada John e
um valor de Departamento de Suporte a qualquer pessoa que não seja John. Observe que o segundo sinal de
igual tem espaços antes e depois dele.
CalcFirstOfThisMonth : Execute um cálculo de data complexo

Este componente usa quatro funções de data aninhadas para retornar o primeiro dia do mês atual. Defina seu
Elemento Nome Valor
Primeiro deste mês =DIA ADICIONAL(EOM(MÊS ADICIONAL(HOJE(),-1)),1)
AssembleOutput : crie a estrutura dos dados de saída

Este componente cria uma estrutura JSON para os dados transformados. Para configurar a estrutura, clique em
Editar como JSON e edite o nó ElementValueMap da seguinte forma:

"Resultado": {
" FullName ": "% ConcatName:FullName %",
"Departamento": "% RetrieveDept:Departamento %",
" AfterTaxIncome ": "% AfterTax:AfterTaxIncome %",
" NetIncome ": "% CalcularNet:NetIncome %",
"Location": "% LocationData:Location %",
" LocationCode ": "% TextWithCode:LocationCode %",
" FirstOfThisMonth ": "% CalcFirstOfThisMonth:FirstOfThisMonth %"
}
},

company
Resposta: retorne os dados de saída
Este componente retorna os dados de saída para a entidade que chamou o Procedimento de Integração.
Definir um propriedade da seguinte forma:
Enviar caminho JSON Nó JSON de resposta
AssembleOutput Resultado
O que vem a seguir

Teste o procedimento de integração que define valores
Veja também
• Definir Propriedades de Valores para Procedimentos de Integração
Definir propriedades de valores para procedimentos de integração

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nas ações Definir valores. A ação Definir
Valores define valores no JSON de dados de um Procedimento de Integração literalmente, usando campos de
mesclagem ou fórmulas.
Mapa de valor do elemento: nome do O nó JSON para o qual o valor deve ser definido.
elemento
Elemento Mapa de valor : valor O valor a ser atribuído ao nó JSON. Opções :

• Valor literal
• Resultados do fórmulas e funções
Veja Também
• Definir valores para procedimentos de integração
• Ação do Procedimento de Integração Comum Propriedades

Depois de criar o Procedimento de Integração que demonstra os usos da ação Definir Valores, a etapa final é
testá-lo.

2. Clique em Editar como JSON .
{
"Nome": {
"Nome": "João",
},
" Finanças ": {
" Renda Bruta ": "100.000",
" Despesas ": "60000"
}
}

company
{
"Resultado": {
" FullName ": "John Smith",
"Departamento": "Desenvolvimento",
" AfterTaxIncome ": 70.000,
" Renda Líquida ": 10.000,
"Localização": "São Francisco",
" LocationCode ": "O código é 2345",
" FirstOfThisMonth ": "2020-02-01"
}
}
Veja também
Afirmar Ação para Procedimentos de Integração

A Ação de Asserção compara os resultados esperados e reais de um Procedimento de Teste usando uma
expressão que é avaliada como verdadeira ou falsa. Você pode usar variáveis de ambiente na Fórmula
Condicional de Asserção para testar o desempenho.
Veja Também
• Propriedades da ação de declaração para procedimentos de integração
• Procedimentos de Teste: Procedimentos de Integração para Teste de Unidade
• Variáveis de ambiente em DataRaptors e procedimentos de integração
Propriedades da ação de declaração para procedimentos de integração

Essas propriedades são exclusivas ou funcionam de maneira exclusiva em Assert Actions. A Ação de Asserção
compara os resultados esperados e reais de um Procedimento de Teste usando uma expressão que é avaliada
como verdadeira ou falsa.
Afirmar Condicional Expressão que testa os resultados das etapas anteriores e avalia como verdadeiro ou falso. Se o resultado for false,
Fórmula assertResult para a ação Assert será definido como false . Isso define o testResult para o procedimento de teste como
com falha .
Afirmar Falha Mensagem que explica por que o teste falhou.

Mensagem
Falha no teste ativado Se marcado, o Procedimento de Teste para e retorna o resultado da transação se a Fórmula Condicional de Asserção
Afirmar for avaliada como falsa.
Se não estiver marcado, o Procedimento de Teste continua em execução mesmo se a Fórmula Condicional Assert for
avaliada como falsa.
Veja Também
• Afirmar Ação para Procedimentos de Integração
Ação do Chatter para procedimentos de integração

A ação do Chatter cria uma postagem do Chatter e a envia para um feed do Chatter.
company
Veja Também
• Propriedades de ação do Chatter para procedimentos de integração
• Encontrar o ID de uma comunidade
• Fluxo de trabalho para o Chatter Ação Exemplo
Propriedades de ação do Chatter para procedimentos de integração

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nas ações do Chatter. Todas as
propriedades, exceto o Tipo de Marcação , suportam campos de mesclagem. A ação do Chatter cria uma
postagem do Chatter e a envia para um feed do Chatter.
Para obter o Id para a propriedade Mentioned User Id , Subject Id , Image Id ou File Id , vá para a página de
registro do objeto e selecione o Id na URL.
ID da comunidade ID da Comunidade na qual postar.
Mencionado ID do ID de usuário para mencionar no post. Pode ser um valor único ou uma lista JSON.
usuário
Tipo de marcação Deixe em branco ou selecione Negrito , Itálico ou Sublinhado para determinar o estilo da propriedade Texto .
ID do assunto (Obrigatório) ID do objeto que tem o feed do Chatter. Pode ser qualquer objeto compatível com feeds do Chatter, como
Conta, Contato, Usuário ou Grupo.
ID da imagem Id de um objeto File a ser usado como imagem para o post. Pode ser um valor único ou uma lista JSON.
ID do arquivo Id de um objeto File a ser incluído como anexo à postagem. Posso ser um único valor ou uma lista JSON .
Texto Texto da postagem. Pode incluir campos de mesclagem e marcação HTML.
Veja Também
• Conversa Ação para Procedimentos de Integração
Encontrar o ID de uma comunidade

Para encontrar o ID de uma comunidade, você deve executar uma consulta no Developer Console.
1. No Lightning Experience, clique no ícone de engrenagem. No Salesforce Classic, clique no menu do

usuário. Em qualquer um dos casos, selecione Console do desenvolvedor a partir de o cardápio.
2. Clique na guia Editor de consultas na parte inferior da janela do Developer Console.
3. Insira a seguinte consulta no painel Editor de Consultas: SELECT Id,Name FROM Network
Os IDs e nomes de todas as comunidades na organização são listados.

4. Encontre o nome da comunidade e copie seu ID.
Fluxo de trabalho para exemplo de ação do Chatter

Um procedimento de integração envia uma postagem do Chatter para um usuário. Esta postagem inclui texto,
uma imagem e menções de outros dois usuários.
Para construir isso exemplo :
1. Colete IDs para a postagem do Chatter .

company
2. Crie o Procedimento de Integração com a Ação do Chatter .
Veja Também
Colete IDs para a postagem do Chatter

Antes de criar o exemplo do Procedimento de Integração com a Ação do Chatter, você deve coletar os IDs
necessários para montar a postagem do Chatter.
1. Vá para a guia Pessoas.

2. Vá para as páginas de registro de três usuários e obtenha seus IDs do URL do navegador.
Cada Id se parece com isso: 00561000000hjm3AAA .
3. Escolha qual usuário receberá a postagem do Chatter.
O ID desse usuário será o ID do assunto da ação do Chatter do procedimento de integração. Você
retornará à página de registro deste usuário posteriormente para verificar se o usuário recebeu a
postagem do Chatter.
4. Vá para a guia Arquivos, clique em Fazer upload de arquivos e faça upload de um arquivo de imagem de
sua escolha.
5. Selecione Exibir detalhes do arquivo no menu de seta para baixo desse arquivo.
6. Enquanto estiver na página de detalhes do arquivo, obtenha o ID do URL do navegador.
Qual é o próximo
Crie o procedimento de integração com a ação do Chatter
Veja Também

Depois de coletar os IDs necessários para montar uma postagem do Chatter, você pode criar um Procedimento
de integração que envia uma postagem do Chatter a um usuário. A postagem de exemplo inclui texto, uma
imagem e menções de dois outros usuários.
1. Vá para a guia Procedimentos de integração do OmniStudio . Clique em Novo .

2. Forneça um Name , Type e SubType para o Procedimento de Integração. Clique em Salvar .
3. Arraste uma ação do Chatter para o painel Estrutura. Atribuir esses propriedades :
Propriedade Valor
ID do assunto % SubjectId %
Mencionado ID do usuário % UserIdList %
ID da imagem % ImageId %
Tipo de marcação itálico
Texto Aqui está a imagem que mencionei. Tem o Id % ImageId %.
4. Arraste uma Ação de Resposta para o painel Estrutura e marque Retornar JSON de Dados Completos .
5. Vá para a guia Visualizar. Clique em Editar como JSON .
6. Cole JSON com esta estrutura no painel Parâmetros de entrada, substituindo os IDs que você
coletou no primeiro conjunto de etapas:
company
{
" ImageId ": "06961000005R9q1AAC",
" UserIdList ": [
"0054N0000041jEvQAI",
"0054N0000041qUlQAI"
],
" SubjectId ": "00561000000hjm3AAA"
}
8. Volte para a guia Pessoas e, em seguida, para a página de registro do usuário que você escolheu para
receber a postagem do Chatter.
9. Role para baixo até o painel do Chatter e clique no ícone Atualizar para ver a postagem mais recente do
Chatter.
Veja Também
DataRaptor para procedimentos de integração
A Ação de extração do DataRaptor chama a extração do DataRaptor especificada para ler os dados do
Salesforce e os retorna ao Procedimento de integração.
Para exemplos de procedimentos de integração que incluem pelo menos uma ação de extração do
DataRaptor, consulte Processar matrizes usando blocos de loop e lidar com erros usando blocos Try-Catch .
Veja Também
• DataRaptor para procedimentos de integração

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nas ações de extração do DataRaptor . o
DataRaptor chama a extração do DataRaptor especificada para ler os dados do Salesforce e os retorna ao
Procedimento de integração.
Interface do DataRaptor Nome da extração do DataRaptor a ser executada
do DataRaptor : fonte de dados Nome do nó JSON de dados que contém o valor a ser
filtrado
Parâmetros de entrada do DataRaptor : valor do Valor a ser correspondido para se qualificar como um
filtro parâmetro de entrada
Ignorar cache Desabilita o cache na extração do DataRaptor .
Veja Também
DataRaptor Post Action para Procedimentos de Integração

A ação de postagem do DataRaptor chama uma carga do DataRaptor (postagem) para gravar dados no
Salesforce.

company
Para exemplos de procedimentos de integração que incluem pelo menos uma ação posterior do DataRaptor ,
consulte Processar matrizes usando blocos de loop e lidar com erros usando blocos Try-Catch .
Embora uma ação de postagem do DataRaptor crie ou atualize principalmente sObjects , ela também produz
saída JSON, que você pode visualizar no log de depuração na guia Visualizar. Isso é importante quando as
etapas subsequentes do Procedimento de Integração precisam fazer referência aos sObjects .
Na resposta JSON retornada por uma postagem do DataRaptor , os nomes dos nós são anexados com o
número de sequência da etapa do DataRaptor que os criou. Por exemplo:
{
"Contato_1": [{
"Id": "0036A000002PeaAQAS",
" UpsertSuccess ": verdadeiro
}],
"Anexo_2": [{
"Id": "00P6A000000EJ3RUAW",
"Nome": "angular-route.min.js",
" ParentId ": "0036A000002PeaAQAS",
}]
}
Se o nome do DataRaptor for CreateContact , você poderá fazer referência ao Id de Contact_1 no exemplo
usando o campo de mesclagem %CreateContact:Contact_1:Id% .
Veja Também

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nas ações de postagem do DataRaptor .
Salesforce.
Interface do DataRaptor Nome da postagem do DataRaptor a

ser executada.
Veja Também
• DataRaptor Post Action para Procedimentos de Integração

Uma Ação de Transformação DataRaptor chama a Transformação DataRaptor especificada para executar
transformações no Data JSON e retorna os dados transformados.
Veja Também
• DataRaptor para Procedimentos de Integração
• Criar um exemplo de ação de transformação do DataRaptor
company
• DataRaptor Visão geral da transformação
• Tipos de dados de saída do DataRaptor
DataRaptor para Procedimentos de Integração

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nas ações de transformação do
DataRaptor . Uma Ação de Transformação DataRaptor chama a Transformação DataRaptor especificada para
executar transformações no Data JSON e retorna os dados transformados.
Interface do DataRaptor Nome da transformação DataRaptor a ser

executada.
Ignorar cache Desabilita o cache no DataRaptor Transform.
Veja Também
Criar um exemplo de ação de transformação do DataRaptor

Um Procedimento de Integração chama um DataRaptor Transform que calcula uma soma e a retorna.
1. Crie o exemplo DataRaptor Transform descrito em Usar Fórmulas em DataRaptors e nomeie-o

DRFormula1 .
4. Arraste um componente DataRaptor Transform Action para o painel Structure e defina as seguintes
configurações:
Propriedade Valor
Interface do DataRaptor DR Fórmula1
Enviar caminho JSON Entrada
5. Arraste um componente Response Action para o painel Structure abaixo da DataRaptor Transform Action
e dê a ele as seguintes configurações:
Propriedade Valor
Enviar caminho JSON DataRaptorTransformAction1:TotalPrice
Observe que a saída do DataRaptor Transform é encapsulada em um nó DataRaptorTransformAction1 , do qual

apenas o subnó TotalPrice é selecionado.
Enviar nó JSON Preço total

{
"Entrada": {
"Produtos": [
{

company
"Nome": "iPhone",
"Preço": 600
},
{
"Preço": 30
},
{
"Preço": 200
}
]
}
}
Observe que isso é o mesmo que a entrada para o DataRaptor Transform, exceto que toda a estrutura é
encapsulada em um nó de entrada , que corresponde ao valor Send JSON Path da DataRaptor Transform
Action.
8. Clique em Executar . A saída deve ficar assim:
{
" Preço Total ": 830
}
9. No painel Entrada, altere um ou mais preços e clique em Executar novamente. Observe como
a Preço total valor mudanças .
Veja Também
• Ação de Transformação do DataRaptor para Procedimentos de Integração
DataRaptor Turbo Action para procedimentos de integração

Um DataRaptor Turbo Action chama o DataRaptor Turbo Extract especificado para ler dados do Salesforce e os
retorna ao Procedimento de Integração.
O DataRaptor Turbo Action é exatamente o mesmo que o DataRaptor Extract Action em como ele funciona. A
única diferença é o tipo de DataRaptors que a propriedade da Interface DataRaptor lista. Para exemplos de
procedimentos de integração que incluem pelo menos uma ação de extração do DataRaptor , consulte
Processar matrizes usando blocos de loop e lidar com erros usando blocos Try-Catch .
Veja Também

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nas ações de extração do DataRaptor .
Interface do DataRaptor Nome do DataRaptor Turbo Extract a ser executado

company
filtrado
Ignorar cache Desativa o cache no DataRaptor Turbo Extract.
Veja Também
• DataRaptor Turbo Action para procedimentos de integração
Excluir ação
Permita que os usuários excluam um ou mais registros sObject usando a ação Excluir. Use o ID de registro de
um objeto para determinar qual registro excluir. A Vlocity recomenda usar um campo de mesclagem no campo
Path to Id que se refere a um ID ou a uma lista de IDs no JSON de dados.
1. Visualize o OmniScript e identifique o caminho JSON para o registro. Por exemplo, este JSON de dados
contém uma lista de contas:

4. No campo Path to Id , insira o caminho JSON para o ID do registro usando a sintaxe do campo de
mesclagem. Usando o exemplo de conta, o caminho para excluir a matriz de IDs de conta é: %
Account:accId % .
Para exemplos de procedimentos de integração que incluem uma ação de exclusão, consulte Processar
matrizes usando blocos de loop e lidar com erros usando blocos Try-Catch .

Caminho para o ID Caminho para o nó JSON que contém o ID ou a lista de IDs dos registros a serem excluídos. Suporta sintaxe de
mesclagem .
Confirmação Diálogo Mensagem O texto da mensagem do Modal de Confirmação. O texto da mensagem padrão é Tem certeza? este ação não
podes ser desfeito .

company
Ação de Envelope DocuSign para Procedimentos de Integração

A ação de envelope do DocuSign envia por e-mail um conjunto de documentos para assinatura.
Veja Também
• Propriedades de Ação de Envelope DocuSign para Procedimentos de Integração
• Usando a ação de envelope do DocuSign para enviar documentos por e -mail para assinatura
Propriedades de Ação de Envelope DocuSign para Procedimentos de Integração

Essas propriedades são exclusivas ou funcionam de maneira exclusiva no DocuSign Envelope Actions. A ação
de envelope do DocuSign envia por e-mail um conjunto de documentos para assinatura.
DocuSign Modelos Modelos para os documentos que você deseja assinar. Consulte Preparando um modelo do DocuSign para OmniScript
.
Destinatários Depois de adicionar um modelo, especifique o nome do signatário, o email do signatário e a função do modelo para
cada destinatário.
Campos de mesclagem de suporte de nome do signatário e email do signatário. As funções de modelo são
configuradas durante a configuração do modelo.
Formatos de data e hora Especifique o formato para exibição dos valores de data e hora. ( Mais informações )
Veja Também
• Ação de Envelope DocuSign para Procedimentos de Integração
E-mail Ação para Procedimentos de Integração

Uma ação de email envia o email especificado. Você pode especificar todos os valores do campo de email ou
usar um modelo de email do Salesforce.
Veja Também
• Propriedades de ação de email para procedimentos de integração
• Criar um exemplo de ação de email com campos especificados
• Fluxo de trabalho para exemplo de ação de email com modelo
Propriedades de ação de email para procedimentos de integração
Essas propriedades são exclusivas ou funcionam de maneira exclusiva nas ações de email. Uma ação de email
envia o email especificado. Você pode especificar todos os valores do campo de email ou usar um modelo de
email do Salesforce.
Muitas das propriedades suportam valores literais ou campos de mesclagem, que permitem passar uma
entrada ou um valor de outra etapa.

company
Usar modelo Se marcado, usa um modelo de email do Salesforce. Também determina quais outras propriedades estão disponíveis.
Para E-mail Endereço Lista Especifica os destinatários no campo PARA do email. Clique em Adicionar destinatário para adicionar cada endereço de
e-mail. Pode aceitar uma matriz de até 100 endereços.
mail CC Endereço Lista Especifica os destinatários no campo CC do email. Clique em Adicionar destinatário para adicionar cada endereço de e-
mail. Pode aceitar uma matriz de até 25 endereços.
mail CCO Endereço Especifica os destinatários no campo CCO do email. Clique em Adicionar destinatário para adicionar cada endereço de
Lista e-mail. Pode aceitar uma matriz de até 25 endereços.
Definir corpo HTML Determina se o corpo do email deve ser lido como texto simples (não marcado) ou HTML (marcado).
Disponível se Usar modelo não estiver marcado.
Toda a organização E-mail Especifica o remetente no campo DE do email. Presume -se que seja um e-mail que representa toda a organização. Se
Endereço não for especificado, o remetente padrão é o usuário que invocou o Procedimento de Integração. Consulte os
ID do objeto de destino de e- Especifica a ID de um contato, usuário ou lead com um endereço de e -mail.

mail

Anexos
Veja Também
• E-mail Ação para Procedimentos de Integração
Criar um exemplo de ação de email com campos especificados

Um Procedimento de Integração aceita os parâmetros de entrada email , subject e message e os usa
para compor e enviar um email.
company

3. Arraste um componente de ação de email para o painel Estrutura.
4. Na ação de email, remova a verificação da configuração Usar modelo .
5. Dê à ação de email as seguintes configurações. Clique em Adicionar destinatário para adicionar à lista de
endereços.
Propriedade Valor
PARA A LISTA DE ENDEREÇOS DE E-MAIL % e-mail %
E-mail Sujeito % assunto %
Corpo do e- mail % mensagem %
6. Vá para a guia Visualizar e clique em Adicionar novo par de chave/valor três vezes. Especificamos a
seguintes parâmetros de entrada :
Chave Valor
o email ( seu o email endereço )
sujeito mail de teste
mensagem este é um teste.
Se preferir especificar a entrada JSON, clique em Editar como JSON e cole este código, substituindo seu e-
mail:
{
"email": "kim@example.com",
"assunto": "E-mail de teste",
"message": "Este é um teste."
}
7. Clique em Executar . Você deve receber um e-mail de teste da sua organização em alguns minutos.
Veja Também
Fluxo de trabalho para exemplo de ação de email com modelo

Um procedimento de integração usa um modelo de email e inclui o email enviado na lista de atividades do
destinatário. Nenhum modelo de email existe por padrão, portanto, este exemplo inclui etapas para criar um.
1. Crio a E-mail Modelo .

company
2. Selecionar um E-mail Destinatário .
3. Crie o Procedimento de Integração com a Ação de Email .
4. Teste o procedimento de integração com a ação de email .
Veja Também
Criar o modelo de e-mail

Crie o modelo de email que o exemplo de ação de email usa.
1. Vá para a guia Modelos de email e clique em Novo modelo de email .

2. No campo Nome do modelo de email , digite Modelo de email simples .
3. Digite qualquer texto que desejar nos campos Assunto e Valor HTML .
Por exemplo, o Assunto pode ser Olá e o Valor HTML pode ser Apenas dizendo olá .
4. Clique em Salvar . A página do modelo de e-mail é aberta.
5. Enquanto estiver na página do modelo de e-mail, copie o ID do URL, por exemplo
00X4N000000aCE5UAM .
Qual é o próximo
Selecione um destinatário de e-mail
Veja Também

Selecione a ID do contato para quem o email no exemplo de ação de email é enviado.
1. Vá para a guia Contatos.
2. Encontre um contato que tenha um endereço de e-mail ou adicione um endereço de e-mail a um contato.
3. Enquanto estiver na página do contato, copie o ID do URL, por exemplo 0036100000423z8AAA .
Qual é o próximo
Crie o procedimento de integração com a ação de email
Veja Também

Depois de criar o modelo de email e selecionar o destinatário, você pode criar um Procedimento de Integração
que envia um email para um contato.

company
1. Vá para a guia Procedimentos de integração do OmniStudio e clique em Novo .
4. Certifique-se de que a caixa Usar modelo esteja marcada.
5. Copie a ID do modelo de email no campo Selecionar modelo de email .
6. Uma lista suspensa aparece com um item parecido com este: Simple_Email_Template_1580943234381 .
Selecione o item da lista. O item da lista substitui o Id no campo.
7. No campo ID do objeto de destino de email , digite %contact% .
8. Marque a caixa Salvar como atividade .
Qual é o próximo
Teste o procedimento de integração com a ação de e-mail
Veja Também


Depois de criar o Procedimento de Integração com a Ação de Email, sua tarefa final é testá-lo.
1. Vá para a guia Visualizar e clique em Adicionar novo par de chave/valor .

2. Especifique o contato como a Chave e o ID do contato que você copiou anteriormente como o Valor .
3. Clique em Executar . Isso envia o e-mail.
4. Volte para a guia Contatos. Selecione o contato para quem você enviou o e -mail para abrir a página.
Se a página de registro de contato incluir um componente de Atividades , você deverá ver o email na lista
de atividades depois de clicar em Atualizar . Por exemplo :

company
5. Se a página de registro de contato não incluir um componente de atividades , você poderá adicionar um:
a. Se estiver usando o Salesforce Classic, clique em Alternar para o Lightning Experience .
b. Clique no ícone de engrenagem e selecione Editar página .
c. Arraste um componente Atividades da lista à esquerda para a tela da página.
d. Clique em Salvar e em Voltar para retornar à página do contato.
O componente Atividades aparece na página do Contato e lista o email que você enviou.
Veja Também

Ação HTTP para procedimentos de integração

A Ação HTTP executa uma chamada REST e retorna seus resultados ao Procedimento de Integração.
Veja Também
• Propriedades de ação HTTP para procedimentos de integração
• Fluxo de trabalho para ação HTTP Exemplo
Propriedades de ação HTTP para procedimentos de integração
Essas propriedades são exclusivas ou funcionam de maneira exclusiva em Ações HTTP. A Ação HTTP executa
uma chamada REST e retorna seus resultados ao Procedimento de Integração.

company
Você pode passar sinais de porcentagem na URL substituindo o sinal de porcentagem no Caminho pela variável $
Vlocity.Percent .
Método HTTP GET, POST, PUT ou DELETE
Nomeado Credencial Credencial nomeada do Salesforce necessária para endpoint
Opções REST : Cabeçalho Configurações de cabeçalho HTML especificadas como pares de chave/valor
Opções REST : Parâmetros Parâmetros de URL especificados como pares de chave/valor
Codificar URI Ative para codificar em HTML o URL
Enviar corpo Habilitar para enviar o conteúdo do corpo para uma ação POST
Tempo esgotado Quanto tempo em milissegundos para esperar por uma resposta
Cliente Certificado Nome Para autenticação de dois fatores, o nome do certificado do cliente a ser usado.
Registro de depuração: painel Saída de depuração da guia Visualização antes ou depois da tentativa de ação. Você pode registrar valores
de PropertySetMap e os seguintes campos de mesclagem:
Registro de pré-ação e
Postar ação Exploração • Pré-ação: %endpoint% e %body%
madeireira
• Pós-ação: % stepName + 'Info'% e % stepName + ' Info:Content-Type '%
Por exemplo :
% stepName + 'Status'%
Repetir Contar Número de vezes para repetir a ação quando ela falha
Resposta de Escape XML Habilite para remover escapes XML de uma resposta XML.
Veja Também
Fluxo de trabalho para ação HTTP Exemplo

Um procedimento de integração recupera a imagem astronômica do dia da NASA usando a API REST disponível
publicamente da NASA.
1. Adicione a NASA como um local remoto .

2. Obtenha uma chave de API da NASA .
3. Crie o Procedimento de Integração com a Ação HTTP .
Veja Também
Adicionar NASA como um site remoto

Para poder invocar as APIs REST da NASA de sua organização, você deve adicionar a NASA como um site
remoto.
1. Em Configuração, na caixa Busca rápida, digite remote e clique em Configurações do site

remoto .
company
3. Para o Nome do Local Remoto , digite NASA .
4. Para a URL do site remoto , insira https://api.nasa.gov .
O que vem a seguir

Obtenha uma chave de API da NASA
Veja Também

Você deve especificar uma chave de API sempre que invocar uma API REST da NASA. Você posso pegue isto
chave da NASA.
1. Acesse https://api.nasa.gov .
2. Digite seu nome , sobrenome e e- mail e clique em Inscrever -se .
3. Copie a resposta e salve-a em um arquivo de texto. Parece algo assim:
Sua chave de API para me@example.com é:

YbbMNWeWX2BqxoPKXEiWWcKMgNlUHhHXgqWG5XBt
Você pode limpar os metadados do Procedimento de Integração do cache. Siga as instruções neste tópico ,
mas execute esta linha de código, especificando o Tipo e o Subtipo do Procedimento de Integração:
IntegrationProcedureService.clearMetadataCache (' Tipo _ Subtipo ' );
Métodos para limpar dados do cache de escala

OmniStudio DataRaptors e Procedimentos de Integração usam o Scale Cache e não o Platform Cache. Para
limpar o Scale Cache, você pode usar os métodos anteriores ou o seguinte ScaleCacheService método.
Se você precisar limpar os dados do DataRaptor do Scale Cache, siga as instruções neste tópico , mas execute
uma linha de código neste formulário:

DataRaptor_Name } );
Por exemplo, para limpar dados de um DataRaptor chamado ExtractContactName , use esta linha de código:

company
' ExtractContactName '} );
Se você precisar limpar os dados do Procedimento de Integração do Cache de Escala, siga as instruções neste
tópico , mas execute uma linha de código neste formulário:

Type_SubType } );
Por exemplo, para limpar dados de um Procedimento de Integração com um Type_SubType de

LoopList_ContactNames , use esta linha de código:

' LoopList_ContactNames '} );
Veja também
• Desligue o Cache de Escala

IMPORTANTE
Compartilhamento garantir acesso. Sem adicional configuração é necessário para isso expandido
acesso .
Você pode permitir o acesso a um DataRaptor ou a um Procedimento de Integração com base nas Permissões
Personalizadas habilitadas nos Perfis ou Conjuntos de Permissões do Salesforce de um usuário . Uma classe do

company
Configurações de Compartilhamento, Conjuntos de Compartilhamento, Perfis e Conjuntos de Permissões
controlam o acesso a DataRaptors e Procedimentos de Integração como registros de objetos. Para reforçar a
segurança em nível de campo nos dados que DataRaptors acessam, vá para a guia Opções do DataRaptor e
selecione Check Field Level Security .
IMPORTANTE

Configuração.
de integração .


dados Valor

company







7. Clique em Novo .

{
{
{
company
}
retorna falso; }
OmniStudio Integration Procedures

{
{
{
parar;
}
}
}
}
do OmniStudio são processos declarativos do lado do servidor que executam várias ações em uma única
chamada de servidor. Os procedimentos de integração podem ler e gravar dados do Salesforce e de sistemas
externos (usando chamadas REST) e podem chamar o código Apex. Um Procedimento de Integração pode ser
chamado de um método OmniScript , API ou Apex e pode ser uma fonte de dados para um FlexCard .
Os Procedimentos de Integração são ideais quando você precisa acessar e transformar dados de fontes de
terceiros e nenhuma interação do usuário é necessária, e é desejável mover a carga de trabalho do cliente
para o servidor.
Os Procedimentos de Integração podem fazer algumas coisas que os OmniScripts não podem, sendo a mais
importante o processamento de listas com Blocos de Loop e Ações de Lista. Os Procedimentos de Integração
podem executar mais etapas de processamento de dados do que os DataRaptors e são mais flexíveis do que os
Procedimentos de Cálculo.
GORJETA
O diagrama a seguir mostra o relacionamento entre um OmniScript e um Procedimento de Integração que ele
chama.

company
Veja Também
• DataRaptor ou Procedimento de Integração ?
• OmniScript Ação Elementos Referência
Crio um Procedimento de Integração

Para criar um procedimento de integração do OmniStudio , você deve nomeá-lo, configurá-lo, definir sua
lógica e visualizar como ele é executado. Você também pode exibir informações de depuração e definir opções
que se aplicam apenas a visualizações.
Para obter detalhes passo a passo de como criar exemplos de procedimentos de integração, consulte os
tópicos de bloco e ação em Etapas do procedimento de integração de grupo usando blocos e ações do
GORJETA
7. Vá para a guia Procedimentos de integração do OmniStudio .

8. Clique em Novo . A tela Novo Procedimento de Integração é exibida.
9. Na seção Configuração do procedimento , especifique as seguintes configurações:
• Nome do Procedimento de Integração: O nome exibido na guia Procedimentos de Integração de Vlocity
quando você expande o nó Tipo/ Subtipo .
• Tipo e Subtipo : o nó de nível superior na guia Procedimentos de Integração de Vlocity sob o qual você
deseja que o Procedimento de Integração seja listado.

company
Depois de fornecer um Nome, Tipo e Subtipo , você deve clicar em Salvar .
• Descrição: Uma descrição geral do Procedimento de Integração.
• Rastreamento de dados personalizados: pares de chave/valor a serem registrados quando o
procedimento de integração for executado, se o rastreamento está ativado.
• Incluir todas as ações na resposta: grave os resultados de cada ação no nível raiz do Data JSON . Por
padrão, os resultados são gravados no Data JSON em um nó com o mesmo nome da ação.
• Rollback on Error: Se ocorrer um erro, reverta as instruções de linguagem de manipulação de dados
(DML).
• Permissão necessária: especifica uma lista opcional separada por vírgulas de nomes de permissões
personalizadas. Para executar este Procedimento de Integração, um usuário deve ter uma dessas
permissões. Se essa configuração estiver em branco, qualquer usuário poderá executar este
Procedimento de Integração, a menos que uma DefaultRequiredPermission seja definida.
Salesforce .
Quando um Procedimento de Integração chama um DataRaptor ou outro Procedimento de Integração,
a configuração de Permissão Necessária do Procedimento de Integração de chamada substitui a
configuração de Permissão Necessária do DataRaptor ou Procedimento de Integração que está sendo
chamado.
• Limites encadeáveis e enfileirados: essas configurações controlam como os procedimentos de longa
duração são executados quando há risco de atingir os limites do administrador do Salesforce. Para
detalhes , consulte Configurações para LongRunning Procedimentos de Integração .
• Configuração de cache: essas configurações controlam o armazenamento em cache de metadados do
Procedimento de Integração e JSONdata . Ver Cache para DataRaptors e Procedimentos de Integração .
10. Para definir a lógica do Procedimento de Integração, arraste blocos e ações da paleta para o painel
Estrutura no painel Propriedades . Para obter detalhes sobre blocos, consulte Etapas do procedimento de
integração de grupo usando blocos . Para detalhes cerca de ações , consulte Ações do Procedimento de
Integração .
Quando uma etapa é executada, seus resultados são gravados no Data JSON em um nó com o mesmo
nome da etapa. As etapas subsequentes podem acessar os dados que foram gravados no Data JSON pelas
etapas anteriores.
11. Para testar o Procedimento de Integração, clique em Visualizar . No painel Parâmetro de entrada,
especifique os parâmetros que devem ser fornecidos pelos chamadores e clique em Executar . Verifique
se os resultados JSON são compostos corretamente de acordo com os requisitos do chamador.
12. Para visualizar as informações de depuração no modo de Visualização, exiba a área de janela Erro/Saída
de Depuração no lado direito do Integration Procedure Designer. Este painel contém a Segue subpainéis :
• Log de depuração: saída da execução de cada etapa do procedimento.
• Erros: Quaisquer erros que ocorreram durante a execução.
• Opções: JSON contendo sinalizadores booleanos que você pode definir para habilitar ou desabilitar as
opções de tempo de execução para depuração . Essas opções são apenas para depuração e, por
padrão, não estão em vigor quando o Procedimento de Integração é chamado de um OmniScript .
• isDebug : Habilita ou desabilita a exibição de informações de depuração.
• encadeável: ative ou desative o encadeamento durante a execução, para evitar que um procedimento
de longa execução exceda os limites do administrador do Salesforce . Para obter detalhes sobre
encadeamento, consulte Configurações para procedimentos de integração de longa duração .

company
• resetCache e ignoreCache : ative ou desative os recursos de cache. Para obter detalhes sobre
armazenamento em cache, consulte Cache para DataRaptors e procedimentos de integração .
Acessar dados de procedimento de integração JSON com campos de

mesclagem
Habilite os elementos do Procedimento de Integração e as propriedades do elemento para acessar dados
JSON usando campos de mesclagem. Um campo de mesclagem é uma variável que faz referência ao valor de
um nó JSON. Por exemplo, se um nó JSON for "FirstName": "John" , o campo de mesclagem %FirstName%
retornará John .
Os campos de mesclagem acessam o JSON de dados usando a sintaxe para indicar a um elemento do
Procedimento de Integração que um campo de mesclagem está presente. A sintaxe exige que você envolva um
caminho JSON completo com um sinal de porcentagem em ambas as extremidades.
NOTA
Casos de uso comuns

• Definir valores para renomear elementos, acessar nós JSON, executar fórmulas e preencher elementos. Ver
Definir valores para procedimentos de integração .
• Acesse os dados armazenados nos elementos do Procedimento de Integração em uma fórmula ou em uma
etapa futura.
• Dados de acesso retornados de uma ação. Por exemplo, uma Ação do DataRaptor ou uma Ação HTTP
retorna dados do Salesforce ou de uma fonte externa. Ver Ações do Procedimento de Integração .

mesclagem.
4. Localize o nome do nó JSON no JSON de dados do Procedimento de Integração.

mesclagem. Por exemplo, um campo de mesclagem acessando um nó JSON chamado firstName deve usar
a sintaxe % firstName % .
6. Visualize o Procedimento de Integração para garantir que o campo de mesclagem funcione corretamente.
Sintaxe Adicional
" Informações de contato ": { Use um símbolo de dois pontos : para acessar um nó JSON aninhado.
" Nome ": "João"
} % ContactInfo:FirstName %

company
" Informações de contato ": { Use |n para acessar um nó específico em uma lista. Este campo de mesclagem retorna Steve :
" ContactInfoList ": [
{ %ContactInfo:ContactInfoList|3:FirstName%
"Nome": "João"
},
{
"Nome": "Adão"
},
{ " Nome ":
"Steve"
}
]
}
Etapas do procedimento de integração do grupo usando blocos

Em um procedimento de integração do OmniStudio , você pode executar um grupo de etapas relacionadas
como uma unidade dentro de um bloco para executá-las condicionalmente, armazená-las em cache, repeti-las
para cada item em uma lista ou retornar um erro se falharem.
Os Procedimentos de Integração fornecem estes tipos de bloco:
• Bloco Condicional — Executa o bloco se uma condição especificada for verdadeira ou trata as etapas dentro
dele como uma série de alternativas mutuamente exclusivas. este é a a maioria básico quadra tipo .
• Bloco de cache — Salva a saída das etapas dentro dele em uma sessão ou cache da organização para
recuperação rápida.
• Loop Block — Repete as etapas dentro dele para cada item em uma matriz.
• Bloco Try-Catch — Retorna a saída especificada ou chama uma classe do Apex se uma etapa dentro dela
falhar.
Você pode aninhar blocos dentro de outros blocos. Por exemplo, você pode aninhar um Loop Block em um
Try-Catch Block ou um Cache Block.
Todos os blocos têm uma propriedade em comum: Fórmula Condicional de Execução . Se esta fórmula for
avaliada como verdadeira ou não estiver definida, o bloco será executado. Se for avaliado como falso, o bloco
será ignorado.
Definir lógica de execução usando blocos condicionais

Um Bloco Condicional é executado em sua totalidade se uma expressão for verdadeira, executar uma de um
conjunto de condições mutuamente exclusivas definidas nas etapas que contém ou ambas.
Para controlar se uma ação individual é executada, defina sua Fórmula Condicional de Execução para uma
expressão que pode ser avaliada como Verdadeiro ou Falso. Se a expressão for avaliada como True em tempo
de execução, a etapa será executada.
Para condicionar a execução de um grupo de ações, coloque-as dentro de qualquer bloco e defina a Fórmula
Condicional de Execução do bloco. Se a fórmula for avaliada como True em tempo de execução, as ações no
bloco serão executadas. Se uma ação em um bloco tiver sua própria Fórmula Condicional de Execução , ela
será executada somente se sua fórmula for avaliada como True em tempo de execução.
O Bloco Condicional é o tipo de bloco mais simples. A menos que você marque Is If Else Block , ele não tem
lógica interna. Ou executa ou não de acordo com sua Fórmula Condicional de Execução .
Como compor IF - ELSEIF - ELSE Logic

company
Para definir um conjunto de condições mutuamente exclusivas, use um Bloco Condicional e marque Is If Else
Block . Para cada ação no bloco, especifique uma condição exclusiva em sua Fórmula Condicional de Execução
. A seqüência de ações é importante: Quando o bloco é executado, a primeira ação que possui uma Fórmula
Condicional de Execução que avalia como Verdadeira é executada, então a execução é retomada com a etapa
seguinte ao Bloco Condicional. Nenhuma outra ação no bloco é executada. Para configurar uma etapa que
será executada se nenhuma das etapas anteriores for executada, deixe a Fórmula Condicional de Execução da
última etapa em branco. A figura a seguir ilustra o uso dessa lógica para realizar uma ação diferente,
dependendo do tipo de dispositivo. O próprio Bloco Condicional é executado apenas quando o dispositivo que
está sendo processado vem da Apple, e o bloco contém ações que são executadas apenas para um tipo
específico de dispositivo. Para executar várias ações para uma condição, você pode aninhar blocos
condicionais.
Veja Também
Propriedades do bloco condicional

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nos Blocos Condicionais. Um Bloco
Condicional é executado em sua totalidade se uma expressão for verdadeira, executar uma de um conjunto de
condições mutuamente exclusivas definidas nas etapas que contém ou ambas.
Execução Condicional Especifica que todo o Bloco Condicional é executado somente se esta fórmula for avaliada como verdadeira.
Fórmula
É Se Mais Bloquear Especifica que todas as ações dentro do bloco, exceto opcionalmente a última, têm valores de Fórmula Condicional de
Execução mutuamente exclusivos. Se a última ação tiver uma Fórmula Condicional de Execução em branco , ela será
executada somente se os valores da Fórmula Condicional de Execução de todas as outras ações forem avaliados como
falso.
Veja Também

Criar um exemplo de bloco condicional com a lógica If-Elseif-Else
Com base em um preço e um código de estado, um Procedimento de Integração calcula o imposto sobre
vendas e relata o preço total. Para resumir, apenas quatro códigos de estado estão incluídos: WA, OR, CA e
NV.

company
• Um condicional Bloco , nomeado Impostos estaduais sobre vendas
• Componentes Definir valores dentro do bloco condicional, denominados IfCA , IfOR , IfWA , IfNV e
IfOtherState
• Componentes Set Values seguindo o Bloco Condicional, denominado CalculateTax e AssembleOutput
• Uma ação de resposta, chamada ResponseThe Structure panel tem esta aparência:

15. Arraste um Bloco Condicional para o painel Estrutura, defina seu Nome de elemento como
StateSalesTaxes e marque Is If Else Block .
16. Arraste um componente Set Values para o Conditional Block e defina as seguintes configurações:
a. Defina o nome do elemento como IfCA .
b. Em Mapa de valores do elemento, clique em Adicionar valor . Defina o nome do elemento como
CASalesTax e o valor como 0,0866 .
c. Defina o caminho JSON de resposta como CASalesTax .
d. Defina o nó JSON de resposta como SalesTax .
Essas configurações de resposta copiam o valor CASalesTax para um nó JSON de nível superior chamado
Imposto sobre vendas . Um nó de nível superior não está vinculado a uma etapa específica. Isso
permite que qualquer etapa defina seu valor. Ele também permite que qualquer etapa acesse seu
valor usando o mesmo caminho, independentemente de qual etapa definiu seu valor.
e. Defina a Fórmula Condicional de Execução para State == "CA" .
17. Repita a etapa anterior para configurar mais quatro componentes Set Values dentro do Bloco
Condicional com as seguintes configurações:

company
Propriedade SeOR IfWA Se NV IfOtherState
Elemento Nome SeOR IfWA Se NV IfOtherState
Mapa de valor do elemento, nome do elemento ORSalesTax WASales Tax NVSalesTax Imposto sobre
vendas padrão
Elemento Mapa de valor , valor 0 0,0921 0,0832 0,07
Caminho JSON de resposta ORSalesTax WASales Tax NVSalesTax Imposto sobre

vendas padrão
Nó JSON de resposta Imposto sobre vendas Imposto sobre vendas Imposto sobre Imposto sobre
vendas vendas
Execução Condicional Fórmula Estado == "OU" Estado == "WA" Estado == "NV" ( deixar em branco )
18. Arraste um componente Definir Valores após o Bloco Condicional e defina seu Nome do Elemento como
CalculateTax . Em Element Value Map, dê as seguintes configurações:
Elemento Nome Valor
Imposto =(% Preço % * % Imposto sobre Vendas %)
Taxa de imposto =(% Imposto sobre vendas % * 100)
Total =(% Preço % + (% Preço % * % SalesTax %))
19. Arraste um componente Set Values após o anterior e defina seu Element Name como AssembleOutput .
Clique em Editar como JSON e edite o nó ElementValueMap da seguinte maneira:

"Resultado": {
"Preço": "%Preço%",
"Estado": "%Estado%",
" Imposto ": "% CalcularImposto:Imposto %",
" TaxRate ": "% CalcularTax:TaxRate %",
"Total": "% CalcularImposto:Total %"
}
},
20. Arraste uma ação de resposta após o componente anterior e defina as seguintes configurações:
a. Defina o nome do elemento como Response .
b. Defina o Send JSON Path para AssembleOutput:Output .
c. Defina o nó de envio JSON como saída .
{
" Preço ": "250",
" Estado ": "CA"
}
{
"Resultado": {
"Preço": "250",
"Estado": "CA",
"Imposto": 21,65,
" Taxa de imposto ": 8,66,
"Total": 271,65
}
company
}
24. Altere os valores de Preço e Estado , clique em Executar e veja como os valores de Saída mudam.
Veja Também
• Definir lógica de execução usando blocos condicionais
Melhore o desempenho usando blocos de cache

Usar um cache para armazenar dados acessados com frequência e atualizados com pouca frequência
economiza viagens de ida e volta ao banco de dados e melhora o desempenho. Use Blocos de Cache se
algumas partes do Procedimento de Integração atualizarem dados ou se você precisar que dados em cache
diferentes expirem em momentos diferentes. Por exemplo, os dados climáticos atuais mudam com mais
frequência do que os dados da sessão do usuário.
É importante entender como o cache do Procedimento de Integração de nível superior interage com os Blocos
de Cache. Consulte Cache para DataRaptors e procedimentos de integração .
Um bloco de cache salva a saída das etapas dentro dele em um cache de sessão ou organização na partição de
cache VlocityAPIResponse para recuperação rápida.
Aqui está um exemplo de configuração de bloco de cache:

Opções de teste para cache de bloco de cache na visualização
Ao testar um Procedimento de Integração que inclui um Bloco de Cache na guia Visualização, você pode usar
duas configurações de cache na seção Opções JSON. Essas configurações também afetam o cache de nível
superior, mas não têm efeito no cache de metadados.
em cache.
• resetCache — Força os dados a serem salvos no cache. O valor padrão é false . Use esta configuração
como parte do testando cache próprio .
company
NOTA
Para testar o cache, certifique-se de definir ignoreCache como false . Consulte Criar um exemplo
de bloco de cache .
Nós JSON do bloco de cache

Um procedimento de integração ativo que usa um bloco de cache pode incluir os seguintes nós JSON em sua
saída de log de depuração, que é visível na guia Visualização:

Esses nós estão sob o nó Info do Bloco de Cache. Por exemplo, se o Cache Block for denominado CacheBlock1,
esses nós estarão sob o nó CacheBlock1Info . Por exemplo :

company
Métodos do Apex para limpar os dados do bloco de cache
Se você precisar limpar os dados do Cache Block do cache, siga as instruções neste tópico , mas execute uma
destas linhas de código:
IntegrationProcedureService.clearSessionCache (' Tipo _ Subtipo ', ' blockName ', novo

IntegrationProcedureService.clearOrgCache (' Tipo _ Subtipo ', ' blockName ', novo

• Você deseja limpar uma chave de bloqueio de cache no cache da organização

• O bloco de cache é denominado CacheContacts
• A chave de cache que você deseja limpar é ContactLastName
IntegrationProcedureService.clearOrgCache (' LastNames_Cached ', ' CacheContacts ',

new Map<String, Object>{' ContactLastName ' => 'Smith'} );
IntegrationProcedureService.clearSessionCache('2032076016a1745801061oc');
Veja Também
company
Bloqueio de cache Propriedades

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nos Blocos de Cache. Use Blocos de
Cache se algumas partes do Procedimento de Integração atualizarem dados e, portanto, não devem ser
armazenadas em cache, ou se diferentes dados armazenados em cache expirarem em momentos diferentes.
Plataforma Salesforce Especifica o tipo de cache :

Tipo de cache
Hora de morar Determina por quanto tempo os dados permanecem no cache. O valor mínimo é 5. Os valores padrão e máximo
Minutos dependem do tipo de cache:
• Cache de sessão — O valor padrão é 5. O valor máximo é 480, equivalente a 8 horas. No entanto, o cache é limpo
quando a sessão do usuário expira.
• Cache da organização — O valor padrão é 5. O valor máximo é 2880, equivalente a 48 horas.
O cache de nível superior substitui o cache do bloco de cache pela duração do valor de tempo de vida em minutos de
nível superior .
Chaves de cache Pares configuráveis de chave/valor a serem armazenados no cache. Insira uma chave e defina o valor para a resposta de
uma ação dentro do bloco de cache. O valor pode usar a sintaxe do campo de mesclagem, sinais de porcentagem em
ambos os lados do nome do nó, para acessar e ssa resposta. As chaves de cache estão disponíveis, ou com escopo
definido, apenas dentro do Bloco de Cache.
Saída do bloco de cache Pares de Chave/Valor configuráveis a serem disponibilizados para as etapas subsequentes do Procedimento de
Integração. Insira uma chave e defina o valor para a resposta de uma ação dentro do bloco de cache. O valor pode usar
a sintaxe do campo de mesclagem, sinais de porcentagem em ambos os lados do nome do nó, para acessar essa
resposta.
Atualizar cache Se a fórmula for avaliada como verdadeira, força os dados a serem salvos no cache.
Ignorar cache Se a fórmula for avaliada como verdadeira, não limpará nem salvará os dados no cache.
Adicionar ao cache Se a fórmula for avaliada como verdadeira, salva os dados no cache. Se false, não armazena dados em cache.
Fórmula condicional
Falhou Sobre Etapa Erro Se esta caixa estiver marcada em uma etapa do Bloco de Cache e essa etapa falhar, nenhum dado será armazenado em
cache.
Veja Também
Criar um bloco de cache Exemplo

nomes. Um bloco de cache melhora o desempenho de recuperação de contatos.
loop .
• bloco de cache , chamado CacheBlock1

• Um Loop Block dentro do Cache Block, chamado LoopBlock1
company

11. Arraste um Bloco de Cache para o painel Estrutura e defina as seguintes configurações:
Propriedade Valor
Tipo de cache da plataforma Salesforce Cache da organização
Tempo para viver em minutos 5
Chaves de cache contactId definido como % ExtractContact:Contact:Id % contactName

definido como % ExtractContact:Contact:Name %
Saída do bloco de cache LoopBlock1 definido como %LoopBlock1%
12. Arraste um Loop Block dentro do CacheBlock e dê as seguintes configurações:

Propriedade Valor
Aba Definições
configurações:
Propriedade Valor

company
Filtro Valor nome
15. Arraste uma Ação de Resposta abaixo do Bloco de Loop e defina as seguintes configurações:
Propriedade Valor
Enviar caminho JSON CacheBlock1
16. Para testar este procedimento de integração, na guia Visualização, clique em Editar como JSON e forneça
a entrada com a seguinte estrutura:
{
"nomes": [
{
"nome": "Miller"
},
{
"nome": "Torres"
}
]
}
Para demonstrar o desempenho de forma mais eficaz, especifique nomes comuns e/ou muitos.
navegador, servidor e CPU do Apex devem ser semelhantes aos valores anteriores.
valores resultantes do navegador, servidor e CPU do Apex devem ser notavelmente menores do que os
valores anteriores.
18. Para ver os nós vlcCacheKey e vlcCacheResult , abra o Debug Log e role até o nó CacheBlock1Info .

company
Veja Também

Processo Matrizes Usando blocos de loop

Um Loop Block itera sobre os itens em uma matriz de dados, permitindo que as ações dentro dele se repitam
para cada item. Por exemplo, em Vlocity Communications, Media e Energy, sem um Loop Block, adicionar
quatro produtos a um carrinho exigiria a execução de quatro ações remotas separadas. Mas uma ação remota
dentro de um bloco de loop pode adicionar todos os quatro produtos.
A entrada do array para o Loop Block é processada de forma que cada iteração receba apenas um item no
array. Por exemplo, suponha que a entrada do array tenha esta aparência:
{
"Produtos": {
{
"ID": 1
},
{
"ID": 2
}
]
}
}
Cada iteração do Loop Block receberia uma entrada parecida com esta:
{
"Produtos": {
"IDs": {
"ID": 1
}
}
}
A entrada de iteração são os dados aos quais as Ações dentro do Bloco de Loop têm acesso.

company
Para configurar um Bloco de Loop:
6. Arraste um Loop Block para o painel de estrutura.

7. No campo de propriedade Loop Block rotulado Loop List , insira o nome de um nó JSON que contém uma
matriz de dados. Por exemplo, inserir Products:Ids fornece uma lista de IDs para a ação. O nome do nó
JSON não precisa ser inserido com a sintaxe do campo de mesclagem.
8. Adicione qualquer ação que precise iterar sobre a matriz e passe o caminho completo da matriz para a
ação.
Por exemplo, se a Loop List for definida como uma matriz chamada Products:Ids que contém pares de
valores-chave de Ids, o caminho completo na ação seria Products:Ids:Id .
Para obter mais informações sobre Ações, consulte Ações do procedimento de integração .
NOTA
O Procedimento de Integração para de ser executado e retorna uma resposta de { "Success":
"False" } se uma Ação que tem Falha na Etapa de Erro marcada falhar.
9. No campo de propriedade Loop Block rotulado Loop Output , clique em Add Key/Value Pair para
adicionar pares de chave-valor para definir a resposta. O campo de valor usa a sintaxe do campo de
mesclagem, ou seja, o nome do nó da resposta definido entre dois sinais de porcentagem, por exemplo,
% ResponseData:Names % .
10. (Opcional) Adicione Lógica Condicional para definir quando o Bloco de Loop é executado. Para obter mais
informações sobre lógica condicional, consulte Definir lógica de execução usando blocos condicionais .
Para obter exemplos de bloco de loop adicionais, consulte Ação do procedimento de integração para
procedimentos de integração , Melhorar o desempenho usando blocos de cache e Cache para dados do
procedimento de integração de nível superior .
Veja Também
Propriedades do Bloco de Loop

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nos Loop Blocks. Um Loop Block itera
sobre os itens em uma matriz de dados, permitindo que as ações dentro dele se repitam para cada item.
Lista de loops Aceita um nó JSON contendo uma matriz.
Saída de loop Pares de Chave/Valor configuráveis a serem disponibilizados para as etapas subsequentes do Procedimento de Integração.
Insira uma chave e defina o valor para a resposta de uma ação dentro do bloco de loop. O valor pode usar a sintaxe do
campo de mesclagem, sinais de porcentagem em ambos os lados do nome do nó, para acessar essa resposta. Por padrão, se
nenhum par de chave/valor for especificado, uma resposta de { "success": "OK" } será retornada para cada item processado
na matriz.
Use esta propriedade com cuidado. Ele retorna os dados que você solicita para cada iteração. Se o Loop Block iterar 1.000
vezes, ele retornará 1.000 respostas. Essa propriedade é mais útil para depurar ou retornar um conjunto de dados limitado.

company
Execução Controla se o Loop Block é executado com base em uma expressão avaliada como verdadeira ou falsa.
Condicional
Fórmula
Veja Também
Criar um exemplo de bloco de loop que recupera nomes

Um Procedimento de Integração aceita sobrenomes e retorna os nomes completos de todos os Contatos com
os sobrenomes especificados.

• Um componente DataRaptor Extract Action dentro do Loop Block, chamado DataRaptorExtractAction1
• Uma extração do DataRaptor que usa o operador LIKE para localizar nomes semelhantes aos da entrada,
denominadosExtractFirstNames

6. Forneça entrada com a seguinte estrutura, usando sobrenomes de sua escolha:
{
"nomes": [
{
"Nome": "Miller"
},
company
{
"Nome": "Torres"
}
]
}
Lista de loops Defina esse valor como nomes se a entrada estiver na guia Visualização ou como SetValues1:names se a entrada
Loop Adicional Defina a Chave como DataRaptorExtractAc tion1 e o Valor como %DataRaptorExtractAction1% para retornar todas as
Resultado iterações de dados gerados pelo componente DataRaptor Extract Action.
ExtractFirstName e forneça as seguintes configurações:
Aba Definições
Extrair Uma etapa de extração de contato definida como Contact LastName LIKE Name
Resultado Um mapeamento de Contact:FirstName para Name:First
Um mapeamento de Contact:LastName para Name:Last
11. Arraste um componente DataRaptor Extract Action dentro do Loop Block e dê a ele as seguintes
configurações:
Interface do DataRaptor Defina esse valor como ExtractFirstName .
Parâmetros de entrada : Configure esse valor para names:Name se a entrada estiver na guia Visualização ou para SetValues1:names:Name
Fonte de dados
Parâmetros de entrada : Defina esse valor como Nome .
Filtro Valor
{
"resposta": {},
"LoopBlock1": [
{
"Nome": [
{
"Primeiro": "Tom"
},
{

company
"Primeiro": "Sally"
}
]
},
},
{
"Nome": [
{
"Primeiro": "Maria"
},
{
"Primeiro": “Ricardo”
}
]
},
}
],
"opções": {
},
"nomes": [
{
"Nome": "Miller"
},
{
"Nome": "Torres"
}
]
}
Veja Também

Criar um exemplo de bloco de loop que cria contatos

company
Um procedimento de integração aceita um ID de conta e uma matriz de nomes e sobrenomes e cria novos
contatos para a conta especificada. Ele também inclui uma etapa que exclui esses contatos, que você pode
desativar opcionalmente.

• Um componente DataRaptor Post Action dentro do Loop Block, chamado CreateContact
• Uma carga do DataRaptor que cria um novo contato para uma conta existente, chamada
NewContactForAccount
• Um componente Delete Action dentro do Loop Block, chamado DeleteContact

6. Forneça a entrada com a seguinte estrutura, usando nomes de sua escolha:
{
"Contatos": [
{
"Nome": {
"Primeiro": "João",
"Último": "Doe"
}
},

company
{
"Nome": {
"Primeiro": "Junho",
"Último": "Doe"
}
}
]
}
Lista de loops Defina esse valor para Contatos se a entrada estiver na guia Visualizar ou para SetValues1:Contacts se a entrada
Loop Adicional Defina a Chave como CreateContact e o Valor como % CreateContact % para retornar todas as iterações de dados
Resultado gerados pelo componente DataRaptor Post Action.
11. Para criar o DataRaptor Load que o DataRaptor Post Action chama, crie o segundo exemplo em
DataRaptor Load Examples e denomine-o NewContactForAccount .
12. Arraste um componente DataRaptor Post Action dentro do Loop Block e defina as seguintes
configurações:
Nome Defina esse valor como CreateContact .
DataRaptor Defina esse valor como NewContactForAccount .

Interface
Entrada Adicional Defina a primeira chave como AccountId e seu valor como % AccountId % ou como %SetValues1:AccountId% se a
entrada estiver em um componente SetValues .
Defina a segunda Chave como Nome e seu valor como % Contacts:Name % ou como %SetValues1:Contacts:Name%
13. Arraste um componente Delete Action dentro do Loop Block e dê a ele as seguintes configurações:
Nome Defina esse valor como DeleteContact .
Excluir SObject : Defina esse valor como Contato .
Modelo
Excluir SObject : Defina este valor como %CreateContact:Contact_1:Id% .
Caminho para o ID
{
"resposta": {},
"LoopBlock1": [
{
" CriarContato ": {
" Hora Real ": 793,
" CpuTime ": 537,
company
"Contato_2": [
{
"Id": "0034N00001qh5hVQAQ",
"Nome": "João"
}
],
"Conta_1": [
{
"Id": "0016100001BKL4uAAH"
}
],
"erro": "OK",
},
},
{
" CriarContato ": {
" Hora Real ": 1262,
" CpuTime ": 799,
"Contato_2": [
{
"Id": "0034N00001qh5hWQAQ",
"Nome": "Junho"
}
],
"Conta_1": [
{
"Id": "0016100001BKL4uAAH"
}
],
"erro": "OK",
},
}
company
],
"SetValues1": {
"Contatos": [
{
"Nome": {
"Último": "Doe",
"Primeiro": "João"
}
},
{
"Nome": {
"Último": "Doe",
"Primeiro": "Junho"
}
}
],
" AccountId ": "0016100001BKL4uAAH"
},
"SetValues1Status": verdadeiro,
" opções ": {
" encadeável ": falso
}
}
Veja Também
Criar um exemplo de bloco de loop que concatene itens de lista
Um Procedimento de Integração concatena os valores dos itens em uma lista. Nesse caso, ele cria uma String
separada por sublinhado de QuoteLineItem Ids.
Para assistir a um vídeo que mostra como criar este Procedimento de Integração, clique aqui .
A entrada fica assim:
{
{
"Id": "0QL3h000000VF04GAG"
},
{
}

company
]
}
}
A saída fica assim:
{
}
• Um componente Set Values antes do Loop Block, chamado InitString

• Um componente Set Values dentro do Loop Block, chamado ConcatL istItem
• Um componente Set Values após o Loop Block, chamado TrimUnderscore

Elemento Nome Defina esse valor como InitString .
Mapa de valor do elemento, nome do elemento Clique em Adicionar novo valor e atribua um nome de elemento em branco .

company
Elemento Mapa de valor , valor Sair isto propriedade em branco .
Caminho JSON de resposta Defina esse valor como Em branco .
Esse componente cria um nó JSON de nível superior inicialmente vazio chamado ConcatString . Um nó de
nível superior não está vinculado a uma etapa específica. Isso permite que qualquer etapa defina seu
valor. Ele também permite que qualquer etapa acesse seu valor usando o mesmo caminho,
independentemente de qual etapa definiu seu valor.
13. Arraste um Loop Block para o painel Structure e dê a ele um valor Loop List de QuoteLineItems:Ids .
14. Arraste um componente Set Values para o Loop Block e defina as seguintes configurações:
Elemento Nome Defina esse valor como ConcatListItem .
Mapa de valor do elemento, Clique em Add New Value e atribua um Element Name de Concat .
Nome do elemento
Elemento Mapa de valores , Atribua o seguinte valor :

Valor
=% ConcatString % + "_" + % QuoteLineItems:Ids:Id %
ConcatString de nível superior e o valor da lista atual.
Caminho JSON de resposta Defina este valor para Concat .
Em combinação com a fórmula Value , isso adiciona o valor da lista atual ao nó ConcatString de nível
superior.
15. Arraste um componente Set Values abaixo do Loop Block e dê a ele as seguintes configurações:
Elemento Nome Defina esse valor como TrimUnderscore .
Mapa de valor do elemento, nome do elemento Clique em Add New Value e atribua um nome de elemento de Trim .
Elemento Mapa de valor , valor Atribua um valor =SUBSTRING(ConcatString,1) .
16. Arraste uma ação de resposta abaixo do último componente Definir valores e defina as seguintes
configurações:
Enviar caminho JSON Defina esse valor como TrimUnderscore:Trim .
Enviar nó JSON Defina este valor para Saída .

18. No painel Parâmetros de entrada, forneça a entrada com a seguinte estrutura:
{
{
"Id": "0QL3h000000VF04GAG"
},
{
}
]
}
}
company
10. Clique em Executar . A saída deve ser algo como isto:
{
}
Veja Também

Lidar com erros usando blocos Try-Catch

Um bloco Try-Catch permite que você "tente" executar as etapas dentro dele e, em seguida, "capture" o erro
se uma etapa falhar.
Para configurar um bloco Try-Catch:
4. Arraste um bloco Try-Catch para o painel Estrutura e certifique-se de que a caixa de seleção Fail on Block
Error esteja marcada.
5. Configure o comportamento "catch" — o que o bloco Try-Catch fará se ocorrer uma falha. Você posso
escolher 1 ou Ambas do esses opções :
• Em Resposta de Falha , especifique um par chave-valor para retornar como resposta. O valor pode ser
uma fórmula. Nas versões Spring '20 e posteriores, o valor pode incluir campos de mesclagem.
• Em Resposta de falha personalizada , especifique uma classe remota e um método remoto para
executar uma classe do Apex. A classe Apex deve implementar VlocityOpenInterface .
6. Arraste as subetapas para o bloco Try-Catch e certifique-se de que a caixa de seleção Fail on Step Error
esteja marcada para cada etapa que deve acionar o comportamento "catch" se falhar.
Opcionalmente, você pode especificar uma Fórmula de condição de falha , que é avaliada como TRUE se
uma etapa específica não foi executada com êxito.
Veja Também
Propriedades do bloco Try-Catch

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nos Blocos Try-Catch. Um bloco Try-
Catch permite que você "tente" executar as etapas dentro dele e, em seguida, "capture" o erro se uma etapa
falhar.
Falhou sobre Quadra Erro Especifica que, se o Bloco Try-Catch falhar, todo o Procedimento de Integração falhará.

company
Resposta de falha Uma resposta para retornar se o bloco Try-Catch falhar. O valor pode ser uma fórmula.
Um bloco Try-Catch pode ter uma resposta de falha e uma resposta de falha personalizada.
Personalizado Falha Uma classe remota e um método remoto de uma classe do Apex a ser executado se o bloco Try-Catch falhar. A classe
Resposta Apex deve implementar VlocityOpenInterface .
Veja Também

Criar um exemplo de bloco Try-Catch
sobrenome especificado e retorna uma mensagem de erro se o sobrenome estiver em branco.

• Uma ação de postagem do DataRaptor , chamada DataRaptorPostAction1
• Uma ação de exclusão, chamada DeleteAction1• Uma ação de resposta, chamada ResponseAction1 O
painel Estrutura tem esta aparência:

failureResponse e o Valor como Você deve fornecer um sobrenome.
12. Crie o DataRaptor Load que o componente DataRaptor Post Action chama:

company
a. Dê a ele um nome de interface DataRaptor de CreateContact e um tipo de interface de carga .
b. Na guia Objetos, clique em Adicionar Objeto e selecione Contato .
c. Na guia Campos, clique no ícone + e insira LastName como Input JSON Path e Domain Object Field .
Se você não tiver certeza de como criar uma carga do DataRaptor , consulte os exemplos em Exemplos de
carga do DataRaptor .
13. Arraste um componente DataRaptor Post Action para o bloco Try-Catch e defina as seguintes
configurações:
a. Defina a Interface DataRaptor como CreateContact .
14. Arraste um componente Delete Action após o bloco Try-Catch. Em Delete SObject , defina o Type como
Contact e o Path To Id como %DataRaptorPostAction1:Contact_1:Id% .
15. Arraste uma Ação de Resposta para o painel Estrutura como o último componente e marque a caixa de
seleção Retornar JSON de Dados Completos .
b. Defina a chave como sobrenome e o valor para qualquer nome que desejar.
A saída deve ser algo como isto:
{
"resposta": {},
"ExcluirAção1": [
{
"erros": [],
"sucesso": verdadeiro,
"id": "0034N00001rNgqqQAC"
}
],
"DeleteAction1Status": verdadeiro,
"DataRaptorPostAction1": {
" Hora Real ": 626,
" CpuTime ": 345,
"Contato_1": [
{
"Id": "0034N00001rNgqqQAC",
}
],
"erro": "OK",
},
"DataRaptorPostAction1Status": true,
"opções": {

company
},
}
9. Deixe o Valor em branco e clique em Executar novamente. A saída deve ser algo como isto:
{
"resultado": {
" failureResponse ": "Você deve fornecer um sobrenome."
},
" sucesso ": falso
}
Veja Também
Criar um exemplo de bloco Try-Catch com uma fórmula

Um Procedimento de Integração localiza Contatos com o Nome especificado e retorna uma mensagem de erro
se nenhum for encontrado. Como não retornar nenhum registro normalmente não é considerado uma falha, a
Ação de Extração do DataRaptor dentro do Bloco Try-Catch inclui uma Fórmula de Condição de Falha.

• Uma ação de extração do DataRaptor , chamada DataRaptorExtractAction1

company

failureResponse e o Valor como Nome %Name% não encontrado.
11. Crie o DataRaptor Extract que o componente DataRaptor Extract Action chama:
a. Dê a ele um nome de interface DataRaptor de GetContactName e um tipo de interface de extração
.
b. Na guia Extrair, clique em Adicionar etapa de extração e selecione Contato . Especifique o caminho
e filtre Contact Name LIKE Name .
c. Na guia Saída, clique no ícone + e insira Contact:Name como Extract JSON Path e ContactName
como Output JSON Path .
12. Arraste um componente DataRaptor Extract Action dentro do bloco Try-Catch e dê a ele as seguintes
configurações:
a. Defina a Interface DataRaptor como GetContactName .
c. Especifique ISBLANK(DataRaptorExtractAction1) como a Fórmula de condição de falha .
13. Arraste uma ação de resposta após o bloco Try-Catch e marque a caixa de seleção Return Full Data JSON .
b. Defina a Chave para Nome e o Valor para qualquer nome ou sobrenome que desejar.
Se pelo menos um contato com esse nome for encontrado, a saída deve ser semelhante a esta:
{
"resposta": {},

company
{
" ContactName ": "Amy Argent"
},
{
" ContactName ": "Amy Smith"
}
],
"opções": {
},
"Nome": "Amy"
}
8. Altere o valor para um nome incomum (ou deixe-o em branco) e clique em Executar novamente. A saída
deve ser algo como isto:
{
"resultado": {
" failureResponse ": "Nome Murgatroyd não encontrado."
},
" sucesso ": falso
}
Veja Também

Para compor um Procedimento de Integração, você adiciona ações que são executadas sequencialmente.
Essas ações podem definir valores de dados, executar funções, chamar DataRaptors , invocar classes do Apex,
enviar e-mails, invocar endpoints REST, executar outros procedimentos de integração e muito mais.
Para adicionar uma ação, arraste-a da paleta para o painel Estrutura e configure suas propriedades. Você pode
editar, renomear, mover e excluir ações. Você também pode usar blocos para agrupar ações para execução
condicional, armazenamento em cache, processamento de lista e tratamento de erros.
Para obter detalhes sobre ações específicas do Procedimento de Integração, consulte os tópicos das ações.
Veja Também
• Crio um Procedimento de Integração

company
Propriedades da ação do procedimento de integração comum
Para compor um Procedimento de Integração, você adiciona uma sequência de ações. Para configurar uma
ação, você define as propriedades da ação. As propriedades padrão que existem na maioria ou em todas as
ações estão listadas aqui. Todas as propriedades são do tipo de dados String, salvo indicação em contrário.
Para obter detalhes sobre as propriedades de ações específicas, consulte os tópicos das ações.
Elemento Nome Etiqueta do elemento script
Enviar caminho JSON Apara o JSON de entrada para o caminho especificado antes que a ação seja executada. Ver Manipular JSON com a
Enviar nó JSON Reparenta o JSON de entrada no nó especificado. Consulte Manipular JSON com as propriedades de transformações de
envio/resposta .
Resposta JSON Depois que a ação for executada, apara o JSON de saída para o caminho especificado. Ver Manipular JSON com a
Caminho Transformações de envio /resposta Propriedades .
Resposta JSON Reparenta o JSON de saída no nó especificado. Para delimitar o caminho, use dois pontos; por exemplo
Nó level1:level2:level3. Ver Manipular JSON com a Transformações de envio /resposta Propriedades .
Enviar apenas adicionais Se marcada, aceita apenas os dados na propriedade Entrada Adicional.
Entrada
Entrada Adicional Pares de chave/valor adicionais a serem incluídos no JSON de dados de entrada. Valores pode incluir fórmulas e mesclar
campos .
Somente devolução Se marcada, retorna apenas os dados na propriedade Saída Adicional.

Saída Adicional
Saída Adicional Pares de chave/valor adicionais a serem retornados no JSON de dados de saída. Valores pode incluir fórmulas e mesclar
campos .
Falha de envio apenas Se marcado, retorna apenas a Resposta de Falha se a ação falhar.
Resposta
Resposta de falha Pares de chave/valor a serem retornados no JSON de dados de saída se a ação falhar. Valores pode incluir fórmulas e
mesclar campos .
Execução Especifica uma fórmula que é executada antes que a etapa seja executada. Se a fórmula retornar TRUE, a etapa será
Condicional Fórmula executada. Se a fórmula retornar FALSE, a etapa não será executada. Se nenhuma fórmula é especificado , o degrau é
executado .
Falha Condicional Especifica uma condição de falha personalizada que é executada após a execução da etapa.
Fórmula
Por exemplo, se uma Ação de Extração do DataRaptor não encontrar nenhum registro, isso normalmente não é
considerado um erro, mas você pode usar uma Fórmula Condicional de Falha para especificar essa condição. Veja o
segundo exemplo em Manipular Erros Usando Blocos Try-Catch .
Se a fórmula retornar TRUE, a execução da etapa falhou e todos os pares de chave/valor configurados na lista de
Respostas a falhas são adicionados ao JSON de dados. Por exemplo, se o seguinte JSON for retornado:
{
"Resultado": {
" ErrorCode ": "ERR-123",
"Sucesso": "FALSO"
}
}
...as configurações a seguir capturam o erro e adicionam o código de erro ao JSON de dados:
• Fórmula Condicional de Falha: Resultado:Sucesso == 'FALSO'

• Resposta de falha :
• Chave: ErrorCode
• Valor : % StepName:Result:ErrorCode %

company
Falhou Sobre Etapa Erro Se definido como TRUE, o Procedimento de Integração termina se esta etapa falhar.
Corrente ligada Etapa Permite que a ação seja executada em sua própria transação do Salesforce. Isso pode diminuir o desempenho, mas
diminuirá a probabilidade de exceder os limites do administrador do Salesforce. Para obter mais informações, consulte
Configurações para procedimentos de integração de longa duração .
Adicional Encadeável Especifica um par de valores-chave que é enviado na resposta. O campo de valor aceita a sintaxe do campo de
Resposta mesclagem.
Ação Mensagem Envia uma mensagem ao usuário se esta for a primeira Mensagem de Ação no Procedimento de Integração ou se esta
ação estiver encadeada. Útil para ações de longa duração .
Notas internas Texto descritivo que apenas alguém que está visualizando o Procedimento de Integração no aplicativo Procedimento de
Integração Vlocity vê.
Definir valores para procedimentos de integração

A ação Definir Valores define valores no JSON de dados de um Procedimento de Integração literalmente,
usando campos de mesclagem ou fórmulas. Esta ação tem muitos usos. O exemplo inclui os usos mais comuns.
Exemplo de usos de ações de valores definidos

O Procedimento de Integração que demonstra Definir Valores usa reestrutura, concatena e executa cálculos
simples nos dados de entrada. Todos os seus componentes são ações de Definir Valores, exceto o último, que
é uma Ação de Resposta.
Este exemplo de Procedimento de Integração tem a seguinte estrutura:

company
Para criar o Procedimento de Integração, vá para a guia Procedimentos de Integração do OmniStudio e clique
em Novo . Forneça um Nome de Procedimento de Integração , um Tipo e um Subtipo e clique em Salvar .
Para criar cada componente, arraste uma instância Definir valores para o painel Estrutura e edite sua primeira
propriedade Nome do elemento . Para o último componente, arraste em uma ação de resposta.
Os dados de entrada têm a seguinte estrutura:
{
"Nome": {
"Nome": "João",
},
"Finanças": {
" Renda Bruta ": "100.000",
"Despesas": "60000"
}
}
Entradas: renomear nós nos dados de entrada

Esse componente reduz e simplifica os nós JSON de entrada. Defina seu Mapa de Valor de Elemento da
seguinte forma:
Elemento Nome Valor
Primeiro nome % Nome: Nome %
Sobrenome % Nome: Sobrenome %
Renda Bruta % Finanças: % de Renda Bruta
Despesas % Finanças: Despesas %
LocationData : adicionar valores literais

Este componente adiciona valores literais, que são úteis para testar ou especificar dados que não mudam .
Defina seu Mapa de Valor de Elemento da seguinte maneira:
Elemento Nome Valor
Localização São Francisco
Código 2345
TextWithCode : concatenar valores literais e mesclar campos

Este componente mostra como concatenar uma string literal com um campo de mesclagem. Defina seu
Elemento Nome Valor
Código de localização Código é % LocationData:Code %
Observe que o campo de mesclagem % LocationData:Code % recupera dados do componente anterior,

LocationData .

company
DeptArray : Defina uma matriz
Este componente define uma matriz ou lista de valores. Um componente posterior recuperará um valor da
matriz. Para configurar uma matriz, clique em Editar como JSON e edite o nó ElementValueMap da seguinte
forma:

"Departamentos": [
"Vendas",
"Desenvolvimento",
"Apoiar",
"Treinamento"
]
},
AfterTax e CalculateNet : faça cálculos simples usando fórmulas

Esses componentes calculam o lucro após os impostos usando a multiplicação e o lucro líquido usando a
subtração. Observe que cada operador tem espaços antes e depois dele. Defina o Elemento Mapa de valor de
AfterTax da seguinte forma:
Elemento Nome Valor
AfterTax Income =% de entradas:GrossIncome % * 0,7
Defina o Mapa de Valor do Elemento de CalculateNet da seguinte

forma:
Elemento Nome Valor
Resultado líquido =% AfterTax:AfterTaxIncome % - % Entradas:Despesas %
ConcatName : Concatenar Dois campos de mesclagem

Este componente combina nomes e sobrenomes para formar nomes completos. Defina seu elemento Mapa de
valores da seguinte forma:
Elemento Nome Valor
Nome completo =% Entradas:Nome % + " " + % Entradas:Sobrenome %
Observe como um espaço literal é incluído.
RetrieveDept : usar uma função e recuperar um valor de matriz

Este componente usa a função SE. Ele também usa listnode | notação listnumber para recuperar valores de
matriz. Defina seu elemento Mapa de valores da seguinte forma:
Elemento Nome Valor
Departamento =IF(% Inputs:FirstName % = "John",%DeptArray:Departments|2%,%DeptArray:Depart ments|3%)
Este componente atribui um valor de Departamento de Desenvolvimento a qualquer pessoa chamada John e
um valor de Departamento de Suporte a qualquer pessoa que não seja John. Observe que o segundo sinal de
igual tem espaços antes e depois dele.
CalcFirstOfThisMonth : Execute um cálculo de data complexo

Este componente usa quatro funções de data aninhadas para retornar o primeiro dia do mês atual. Defina seu

company
Elemento Nome Valor
Primeiro deste mês =DIA ADICIONAL(EOM(MÊS ADICIONAL(HOJE(),-1)),1)
AssembleOutput : crie a estrutura dos dados de saída

Este componente cria uma estrutura JSON para os dados transformados. Para configurar a estrutura, clique em
Editar como JSON e edite o nó ElementValueMap da seguinte forma:

"Resultado": {
" FullName ": "% ConcatName:FullName %",
"Departamento": "% RetrieveDept:Departamento %",
" AfterTaxIncome ": "% AfterTax:AfterTaxIncome %",
" NetIncome ": "% CalcularNet:NetIncome %",
"Location": "% LocationData:Location %",
" LocationCode ": "% TextWithCode:LocationCode %",
" FirstOfThisMonth ": "% CalcFirstOfThisMonth:FirstOfThisMonth %"
}
},
Resposta: retorne os dados de saída

Este componente retorna os dados de saída para a entidade que chamou o Procedimento de Integração.
Definir um propriedade da seguinte forma:
Enviar caminho JSON Nó JSON de resposta
AssembleOutput Resultado
O que vem a seguir

Veja também
• Definir Propriedades de Valores para Procedimentos de Integração
Definir propriedades de valores para procedimentos de integração

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nas ações Definir valores. A ação Definir
Valores define valores no JSON de dados de um Procedimento de Integração literalmente, usando campos de
mesclagem ou fórmulas.
Mapa de valor do elemento: nome do O nó JSON para o qual o valor deve ser definido.
elemento
Elemento Mapa de valor : valor O valor a ser atribuído ao nó JSON. Opções :

• Valor literal
• Resultados do fórmulas e funções
Veja Também

company
Depois de criar o Procedimento de Integração que demonstra os usos da ação Definir Valores, a etapa final é
testá-lo.

6. Clique em Editar como JSON .
{
"Nome": {
"Nome": "João",
},
" Finanças ": {
" Renda Bruta ": "100.000",
" Despesas ": "60000"
}
}
{
"Resultado": {
" FullName ": "John Smith",
"Departamento": "Desenvolvimento",
" AfterTaxIncome ": 70.000,
" Renda Líquida ": 10.000,
"Localização": "São Francisco",
" LocationCode ": "O código é 2345",
" FirstOfThisMonth ": "2020-02-01"
}
}
Veja também
Afirmar Ação para Procedimentos de Integração

A Ação de Asserção compara os resultados esperados e reais de um Procedimento de Teste usando uma
expressão que é avaliada como verdadeira ou falsa. Você pode usar variáveis de ambiente na Fórmula
Condicional de Asserção para testar o desempenho.
Veja Também
Propriedades da ação de declaração para procedimentos de integração

company
Essas propriedades são exclusivas ou funcionam de maneira exclusiva em Assert Actions. A Ação de Asserção
compara os resultados esperados e reais de um Procedimento de Teste usando uma expressão que é avaliada
como verdadeira ou falsa.
Afirmar Condicional Expressão que testa os resultados das etapas anteriores e avalia como verdadeiro ou falso. Se o resultado for false,
Fórmula assertResult para a ação Assert será definido como false . Isso define o testResult para o procedimento de teste como
com falha .
Afirmar Falha Mensagem que explica por que o teste falhou.

Mensagem
Falha no teste ativado Se marcado, o Procedimento de Teste para e retorna o resultado da transação se a Fórmula Condicional de Asserção
Afirmar for avaliada como falsa.
Se não estiver marcado, o Procedimento de Teste continua em execução mesmo se a Fórmula Condicional Assert for
avaliada como falsa.
Veja Também
Ação do Chatter para procedimentos de integração

A ação do Chatter cria uma postagem do Chatter e a envia para um feed do Chatter.
Veja Também
Propriedades de ação do Chatter para procedimentos de integração

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nas ações do Chatter. Todas as
propriedades, exceto o Tipo de Marcação , suportam campos de mesclagem. A ação do Chatter cria uma
postagem do Chatter e a envia para um feed do Chatter.
Para obter o Id para a propriedade Mentioned User Id , Subject Id , Image Id ou File Id , vá para a página de
registro do objeto e selecione o Id na URL.
ID da comunidade ID da Comunidade na qual postar.
Mencionado ID do ID de usuário para mencionar no post. Pode ser um valor único ou uma lista JSON.
usuário
Tipo de marcação Deixe em branco ou selecione Negrito , Itálico ou Sublinhado para determinar o estilo da propriedade Texto .
ID do assunto (Obrigatório) ID do objeto que tem o feed do Chatter. Pode ser qualquer objeto compatível com feeds do Chatter, como
Conta, Contato, Usuário ou Grupo.
ID da imagem Id de um objeto File a ser usado como imagem para o post. Pode ser um valor único ou uma lista JSON.
ID do arquivo Id de um objeto File a ser incluído como anexo à postagem. Posso ser um único valor ou uma lista JSON .

company
Texto Texto da postagem. Pode incluir campos de mesclagem e marcação HTML.
Veja Também
Encontrar o ID de uma comunidade

Para encontrar o ID de uma comunidade, você deve executar uma consulta no Developer Console.
5. No Lightning Experience, clique no ícone de engrenagem. No Salesforce Classic, clique no menu do

usuário. Em qualquer um dos casos, selecione Console do desenvolvedor a partir de o cardápio.
6. Clique na guia Editor de consultas na parte inferior da janela do Developer Console.
7. Insira a seguinte consulta no painel Editor de Consultas: SELECT Id,Name FROM Network
Os IDs e nomes de todas as comunidades na organização são listados.

8. Encontre o nome da comunidade e copie seu ID.
Fluxo de trabalho para exemplo de ação do Chatter

Um procedimento de integração envia uma postagem do Chatter para um usuário. Esta postagem inclui texto,
uma imagem e menções de outros dois usuários.
3. Colete IDs para a postagem do Chatter .

4. Crie o Procedimento de Integração com a Ação do Chatter .
Veja Também
Colete IDs para a postagem do Chatter

Antes de criar o exemplo do Procedimento de Integração com a Ação do Chatter, você deve coletar os IDs
necessários para montar a postagem do Chatter.
7. Vá para a guia Pessoas.

8. Vá para as páginas de registro de três usuários e obtenha seus IDs do URL do navegador.
Cada Id se parece com isso: 00561000000hjm3AAA .
9. Escolha qual usuário receberá a postagem do Chatter.
O ID desse usuário será o ID do assunto da ação do Chatter do procedimento de integração. Você
retornará à página de registro deste usuário posteriormente para verificar se o usuário recebeu a
postagem do Chatter.
10. Vá para a guia Arquivos, clique em Fazer upload de arquivos e faça upload de um arquivo de imagem de
sua escolha.
11. Selecione Exibir detalhes do arquivo no menu de seta para baixo desse arquivo.

company
12. Enquanto estiver na página de detalhes do arquivo, obtenha o ID do URL do navegador.
Qual é o próximo
Veja Também

Depois de coletar os IDs necessários para montar uma postagem do Chatter, você pode criar um Procedimento
de integração que envia uma postagem do Chatter a um usuário. A postagem de exemplo inclui texto, uma
imagem e menções de dois outros usuários.
10. Vá para a guia Procedimentos de integração do OmniStudio . Clique em Novo .

11. Forneça um Name , Type e SubType para o Procedimento de Integração. Clique em Salvar .
12. Arraste uma ação do Chatter para o painel Estrutura. Atribuir esses propriedades :
Propriedade Valor
ID do assunto % SubjectId %
Mencionado ID do usuário % UserIdList %
ID da imagem % ImageId %
Tipo de marcação itálico
Texto Aqui está a imagem que mencionei. Tem o Id % ImageId %.
13. Arraste uma Ação de Resposta para o painel Estrutura e marque Retornar JSON de Dados Completos .
14. Vá para a guia Visualizar. Clique em Editar como JSON .
15. Cole JSON com esta estrutura no painel Parâmetros de entrada, substituindo os IDs que você coletou no
primeiro conjunto de etapas:
{
" ImageId ": "06961000005R9q1AAC",
" UserIdList ": [
"0054N0000041jEvQAI",
"0054N0000041qUlQAI"
],
" SubjectId ": "00561000000hjm3AAA"
}
17. Volte para a guia Pessoas e, em seguida, para a página de registro do usuário que você escolheu para
receber a postagem do Chatter.
18. Role para baixo até o painel do Chatter e clique no ícone Atualizar para ver a postagem mais recente do
Chatter.
Veja Também
company
A Ação de extração do DataRaptor chama a extração do DataRaptor especificada para ler os dados do
Salesforce e os retorna ao Procedimento de integração.
Para exemplos de procedimentos de integração que incluem pelo menos uma ação de extração do DataRaptor
, consulte Processar matrizes usando blocos de loop e lidar com erros usando blocos Try-Catch .
Veja Também

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nas ações de extração do DataRaptor . o
DataRaptor chama a extração do DataRaptor especificada para ler os dados do Salesforce e os retorna ao
Procedimento de integração.
Interface do DataRaptor Nome da extração do DataRaptor a ser executada
filtrado
Ignorar cache Desabilita o cache na extração do DataRaptor .
Veja Também
DataRaptor Post Action para Procedimentos de Integração

Salesforce.
Para exemplos de procedimentos de integração que incluem pelo menos uma ação posterior do DataRaptor ,
consulte Processar matrizes usando blocos de loop e lidar com erros usando blocos Try-Catch .
Embora uma ação de postagem do DataRaptor crie ou atualize principalmente sObjects , ela também produz
saída JSON, que você pode visualizar no log de depuração na guia Visualizar. Isso é importante quando as
etapas subsequentes do Procedimento de Integração precisam fazer referência aos sObjects .
Na resposta JSON retornada por uma postagem do DataRaptor , os nomes dos nós são anexados com o
número de sequência da etapa do DataRaptor que os criou. Por exemplo:
{
"Contato_1": [{
"Id": "0036A000002PeaAQAS",
}],
"Anexo_2": [{
"Id": "00P6A000000EJ3RUAW",

company
"Nome": "angular-route.min.js",
" ParentId ": "0036A000002PeaAQAS",
}]
}
Se o nome do DataRaptor for CreateContact , você poderá fazer referência ao Id de Contact_1 no exemplo
usando o campo de mesclagem %CreateContact:Contact_1:Id% .
Veja Também

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nas ações de postagem do DataRaptor .
Salesforce.
Interface do DataRaptor Nome da postagem do DataRaptor a

ser executada.
Veja Também
• DataRaptor Post Action para Procedimentos de Integração

Uma Ação de Transformação DataRaptor chama a Transformação DataRaptor especificada para executar
transformações no Data JSON e retorna os dados transformados.
Veja Também
• Criar um exemplo de ação de transformação do DataRaptor
• DataRaptor Visão geral da transformação
• Tipos de dados de saída do DataRaptor

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nas ações de transformação do
DataRaptor . Uma Ação de Transformação DataRaptor chama a Transformação DataRaptor especificada para
executar transformações no Data JSON e retorna os dados transformados.
Interface do DataRaptor Nome da transformação DataRaptor a ser

executada.
Ignorar cache Desabilita o cache no DataRaptor Transform.
Veja Também

company
Criar um exemplo de ação de transformação do DataRaptor

Um Procedimento de Integração chama um DataRaptor Transform que calcula uma soma e a retorna.
8. Crie o exemplo DataRaptor Transform descrito em Usar Fórmulas em DataRaptors e nomeie-o

DRFormula1 .
11. Arraste um componente DataRaptor Transform Action para o painel Structure e defina as seguintes
configurações:
Propriedade Valor
Interface do DataRaptor DR Fórmula1
Enviar caminho JSON Entrada
12. Arraste um componente Response Action para o painel Structure abaixo da DataRaptor Transform Action
e dê a ele as seguintes configurações:
Propriedade Valor
Enviar caminho JSON DataRaptorTransformAction1:TotalPrice
Observe que a saída do DataRaptor Transform é encapsulada em um nó DataRaptorTransformAction1 , do qual

apenas o subnó TotalPrice é selecionado.
Enviar nó JSON Preço total

{
"Entrada": {
"Produtos": [
{
"Nome": "iPhone",
"Preço": 600
},
{
"Preço": 30
},
{
"Preço": 200
}
]
}
}

company
Observe que isso é o mesmo que a entrada para o DataRaptor Transform, exceto que toda a estrutura é
encapsulada em um nó de entrada , que corresponde ao valor Send JSON Path da DataRaptor Transform
Action.
10. Clique em Executar . A saída deve ficar assim:
{
" Preço Total ": 830
}
11. No painel Entrada, altere um ou mais preços e clique em Executar novamente. Observe como
a Preço total valor mudanças .
Veja Também
• Ação de Transformação do DataRaptor para Procedimentos de Integração
DataRaptor Turbo Action para procedimentos de integração

O DataRaptor Turbo Action é exatamente o mesmo que o DataRaptor Extract Action em como ele funciona. A
única diferença é o tipo de DataRaptors que a propriedade da Interface DataRaptor lista. Para exemplos de
procedimentos de integração que incluem pelo menos uma ação de extração do DataRaptor , consulte
Processar matrizes usando blocos de loop e lidar com erros usando blocos Try-Catch .
Veja Também

Essas propriedades são exclusivas ou funcionam de maneira exclusiva nas ações de extração do DataRaptor .
Interface do DataRaptor Nome do DataRaptor Turbo Extract a ser executado
filtrado
Ignorar cache Desativa o cache no DataRaptor Turbo Extract.
Veja Também
• DataRaptor Turbo Action para procedimentos de integração
Excluir ação

company
Permita que os usuários excluam um ou mais registros sObject usando a ação Excluir. Use o ID de registro de
um objeto para determinar qual registro excluir. A Vlocity recomenda usar um campo de mesclagem no campo
Path to Id que se refere a um ID ou a uma lista de IDs no JSON de dados.
6. Visualize o OmniScript e identifique o caminho JSON para o registro. Por exemplo, este JSON de dados
contém uma lista de contas:

9. No campo Path to Id , insira o caminho JSON para o ID do registro usando a sintaxe do campo de
mesclagem. Usando o exemplo de conta, o caminho para excluir a matriz de IDs de conta é: %
Account:accId % .
Para exemplos de procedimentos de integração que incluem uma ação de exclusão, consulte Processar
matrizes usando blocos de loop e lidar com erros usando blocos Try-Catch .

Caminho para o ID Caminho para o nó JSON que contém o ID ou a lista de IDs dos registros a serem excluídos. Suporta sintaxe de
mesclagem .
Confirmação Diálogo Mensagem O texto da mensagem do Modal de Confirmação. O texto da mensagem padrão é Tem certeza? este ação não
podes ser desfeito .
Ação de Envelope DocuSign para Procedimentos de Integração

A ação de envelope do DocuSign envia por e-mail um conjunto de documentos para assinatura.
Veja Também
• Propriedades de Ação de Envelope DocuSign para Procedimentos de Integração

company
• Usando a ação de envelope do DocuSign para enviar documentos por e -mail para assinatura
Propriedades de Ação de Envelope DocuSign para Procedimentos de Integração

Essas propriedades são exclusivas ou funcionam de maneira exclusiva no DocuSign Envelope Actions. A ação
de envelope do DocuSign envia por e-mail um conjunto de documentos para assinatura.
DocuSign Modelos Modelos para os documentos que você deseja assinar. Consulte Preparando um modelo do DocuSign para OmniScript
.
Destinatários Depois de adicionar um modelo, especifique o nome do signatário, o email do signatário e a função do modelo para
cada destinatário.
Campos de mesclagem de suporte de nome do signatário e email do signatário. As funções de modelo são
configuradas durante a configuração do modelo.
Formatos de data e hora Especifique o formato para exibição dos valores de data e hora. ( Mais informações )
Veja Também
• Ação de Envelope DocuSign para Procedimentos de Integração
E-mail Ação para Procedimentos de Integração

Uma ação de email envia o email especificado. Você pode especificar todos os valores do campo de email ou
usar um modelo de email do Salesforce.
Veja Também
Propriedades de ação de email para procedimentos de integração
Essas propriedades são exclusivas ou funcionam de maneira exclusiva nas ações de email. Uma ação de email
envia o email especificado. Você pode especificar todos os valores do campo de email ou usar um modelo de
email do Salesforce.
Muitas das propriedades suportam valores literais ou campos de mesclagem, que permitem passar uma
entrada ou um valor de outra etapa.
Usar modelo Se marcado, usa um modelo de email do Salesforce. Também determina quais outras propriedades estão disponíveis.
Para E-mail Endereço Lista Especifica os destinatários no campo PARA do email. Clique em Adicionar destinatário para adicionar cada endereço de
e-mail. Pode aceitar uma matriz de até 100 endereços.
mail CC Endereço Lista Especifica os destinatários no campo CC do email. Clique em Adicionar destinatário para adicionar cada endereço de e-
mail. Pode aceitar uma matriz de até 25 endereços.

company
mail CCO Endereço Especifica os destinatários no campo CCO do email. Clique em Adicionar destinatário para adicionar cada endereço de
Lista e-mail. Pode aceitar uma matriz de até 25 endereços.
Definir corpo HTML Determina se o corpo do email deve ser lido como texto simples (não marcado) ou HTML (marcado).
Disponível se Usar modelo não estiver marcado.
Toda a organização E-mail Especifica o remetente no campo DE do email. Presume -se que seja um e-mail que representa toda a organização. Se
Endereço não for especificado, o remetente padrão é o usuário que invocou o Procedimento de Integração. Consulte os
ID do objeto de destino de e- Especifica a ID de um contato, usuário ou lead com um endereço de e -mail.

mail

Anexos
Veja Também

Criar um exemplo de ação de email com campos especificados

Um Procedimento de Integração aceita os parâmetros de entrada email , subject e message e os usa para
compor e enviar um email.

9. Forneça um Nome de Procedimento de Integração , um Tipo e um Subtipo e clique em
Salvar .
company
11. Na ação de email, remova a verificação da configuração Usar modelo .
12. Dê à ação de email as seguintes configurações. Clique em Adicionar destinatário para adicionar à lista de
endereços.
Propriedade Valor
PARA A LISTA DE ENDEREÇOS DE E-MAIL % e-mail %
E-mail Sujeito % assunto %
Corpo do e- mail % mensagem %
13. Vá para a guia Visualizar e clique em Adicionar novo par de chave/valor três vezes. Especificamos a
seguintes parâmetros de entrada :
Chave Valor
o email ( seu o email endereço )
sujeito mail de teste
mensagem este é um teste.
Se preferir especificar a entrada JSON, clique em Editar como JSON e cole este código, substituindo seu e-
mail:
{
"email": "kim@example.com",
"assunto": "E-mail de teste",
"message": "Este é um teste."
}
14. Clique em Executar . Você deve receber um e-mail de teste da sua organização em alguns minutos.
Veja Também
Fluxo de trabalho para exemplo de ação de email com modelo

Um procedimento de integração usa um modelo de email e inclui o email enviado na lista de atividades do
destinatário. Nenhum modelo de email existe por padrão, portanto, este exemplo inclui etapas para criar um.
5. Crio a E-mail Modelo .

6. Selecionar um E-mail Destinatário .
7. Crie o Procedimento de Integração com a Ação de Email .
8. Teste o procedimento de integração com a ação de email .

company
Veja Também
Criar o modelo de e-mail

Crie o modelo de email que o exemplo de ação de email usa.
6. Vá para a guia Modelos de email e clique em Novo modelo de email .

7. No campo Nome do modelo de email , digite Modelo de email simples .
8. Digite qualquer texto que desejar nos campos Assunto e Valor HTML .
Por exemplo, o Assunto pode ser Olá e o Valor HTML pode ser Apenas dizendo olá .
9. Clique em Salvar . A página do modelo de e-mail é aberta.
10. Enquanto estiver na página do modelo de e-mail, copie o ID do URL, por exemplo
00X4N000000aCE5UAM .
Qual é o próximo
Veja Também

Selecione a ID do contato para quem o email no exemplo de ação de email é enviado.
4. Vá para a guia Contatos.
5. Encontre um contato que tenha um endereço de e-mail ou adicione um endereço de e-mail a um contato.
6. Enquanto estiver na página do contato, copie o ID do URL, por exemplo 0036100000423z8AAA .
Qual é o próximo
Veja Também


Depois de criar o modelo de email e selecionar o destinatário, você pode criar um Procedimento de Integração
que envia um email para um contato.
9. Vá para a guia Procedimentos de integração do OmniStudio e clique em Novo .

10. Forneça um Nome de Procedimento de Integração , um Tipo e um Subtipo e clique em
Salvar .

company
12. Certifique-se de que a caixa Usar modelo esteja marcada.
13. Copie a ID do modelo de email no campo Selecionar modelo de email .
14. Uma lista suspensa aparece com um item parecido com este: Simple_Email_Template_1580943234381 .
Selecione o item da lista. O item da lista substitui o Id no campo.
15. No campo ID do objeto de destino de email , digite %contact% .
16. Marque a caixa Salvar como atividade .
Qual é o próximo
Veja Também

Depois de criar o Procedimento de Integração com a Ação de Email, sua tarefa final é testá-lo.
6. Vá para a guia Visualizar e clique em Adicionar novo par de chave/valor .

7. Especifique o contato como a Chave e o ID do contato que você copiou anteriormente como o Valor .
8. Clique em Executar . Isso envia o e-mail.
9. Volte para a guia Contatos. Selecione o contato para quem você enviou o e -mail para abrir a página.
Se a página de registro de contato incluir um componente de Atividades , você deverá ver o email na lista
de atividades depois de clicar em Atualizar . Por exemplo :

company
10. Se a página de registro de contato não incluir um componente de atividades , você poderá adicionar um:
a. Se estiver usando o Salesforce Classic, clique em Alternar para o Lightning Experience .
b. Clique no ícone de engrenagem e selecione Editar página .
c. Arraste um componente Atividades da lista à esquerda para a tela da página.
d. Clique em Salvar e em Voltar para retornar à página do contato.
O componente Atividades aparece na página do Contato e lista o email que você enviou.
Veja Também

Ação HTTP para procedimentos de integração

A Ação HTTP executa uma chamada REST e retorna seus resultados ao Procedimento de Integração.
Veja Também
Propriedades de ação HTTP para procedimentos de integração
Essas propriedades são exclusivas ou funcionam de maneira exclusiva em Ações HTTP. A Ação HTTP executa
uma chamada REST e retorna seus resultados ao Procedimento de Integração.
Você pode passar sinais de porcentagem na URL substituindo o sinal de porcentagem no Caminho pela variável $
Vlocity.Percent .
Método HTTP GET, POST, PUT ou DELETE
Nomeado Credencial Credencial nomeada do Salesforce necessária para endpoint
Opções REST : Cabeçalho Configurações de cabeçalho HTML especificadas como pares de chave/valor
Opções REST : Parâmetros Parâmetros de URL especificados como pares de chave/valor
Codificar URI Ative para codificar em HTML o URL
Enviar corpo Habilitar para enviar o conteúdo do corpo para uma ação POST
Tempo esgotado Quanto tempo em milissegundos para esperar por uma resposta
Cliente Certificado Nome Para autenticação de dois fatores, o nome do certificado do cliente a ser usado.
Registro de depuração: painel Saída de depuração da guia Visualização antes ou depois da tentativa de ação. Você pode registrar valores
de PropertySetMap e os seguintes campos de mesclagem:
Registro de pré-ação e
Postar ação Exploração • Pré-ação: %endpoint% e %body%
madeireira
• Pós-ação: % stepName + 'Info'% e % stepName + ' Info:Content-Type '%
Por exemplo :
% stepName + 'Status'%
Repetir Contar Número de vezes para repetir a ação quando ela falha
Resposta de Escape XML Habilite para remover escapes XML de uma resposta XML.

company
Veja Também
Fluxo de trabalho para ação HTTP Exemplo

Um procedimento de integração recupera a imagem astronômica do dia da NASA usando a API REST disponível
publicamente da NASA.
4. Adicione a NASA como um local remoto .

5. Obtenha uma chave de API da NASA .
6. Crie o Procedimento de Integração com a Ação HTTP .
Veja Também
Adicionar NASA como um site remoto

Para poder invocar as APIs REST da NASA de sua organização, você deve adicionar a NASA como um site
remoto.
6. Em Configuração, na caixa Busca rápida, digite remote e clique em Configurações do site remoto .
8. Para o Nome do Local Remoto , digite NASA .
9. Para a URL do site remoto , insira https://api.nasa.gov .
O que vem a seguir

Veja Também

Você deve especificar uma chave de API sempre que invocar uma API REST da NASA. Você posso pegue isto
chave da NASA.
4. Acesse https://api.nasa.gov .
5. Digite seu nome , sobrenome e e- mail e clique em Inscrever -se .
6. Copie a resposta e salve-a em um arquivo de texto. Parece algo assim:
Sua chave de API para me@example.com é:

YbbMNWeWX2BqxoPKXEiWWcKMgNlUHhHXgqWG5XBt
company
Opções na visualização para armazenamento em cache de nível superior
Ao testar um Procedimento de Integração que usa o cache de nível superior na guia Visualização, você pode
usar duas configurações de cache na seção Options JSON. Essas configurações controlam os dados de nível
superior e não têm efeito no cache de metadados.
em cache.
• resetCache — Força os dados a serem salvos no cache. O valor padrão é false . Use esta configuração como
parte do testando cache próprio .
NOTA
Para testar o cache, certifique-se de definir ignoreCache como false . Consulte Criar um exemplo de
cache de nível superior .
Nós JSON de cache de nível superior e cabeçalhos REST

Se o cache de nível superior estiver configurado e o Procedimento de Integração estiver ativo, o JSON do
Procedimento de Integração poderá incluir os seguintes nós no nó raiz:

Esses nós são retornados como cabeçalhos se você invocar um Procedimento de Integração que usa
armazenamento em cache de nível superior usando uma API REST. Consulte Invocação do
procedimento de integração usando POST .
company
Métodos para limpar dados de nível superior
Se você precisar limpar os dados do Procedimento de Integração de nível superior do cache, siga as instruções
neste tópico , mas execute uma destas linhas de código:
IntegrationProcedureService.clearSessionCache (' Type _ Subtype ', new Map<String,

Objeto>{' chave ' => ' valor '} );
IntegrationProcedureService.clearOrgCache (' Type _ Subtype ', new Map<String,

Objeto>{' chave ' => ' valor '} );
• Você deseja limpar os dados no cache da organização

• A chave que você deseja limpar é ContactLastName
IntegrationProcedureService.clearOrgCache (' LastNames_Cached ', novo Map<String,

Object>{' ContactLastName ' => 'Smith'} );

IntegrationProcedureService.clearSessionCache('2032076016a1745801061oc' );
Configurar o cache de nível superior para um procedimento de integração

Para configurar o cache de nível superior para um Procedimento de integração, vá para a Configuração do
procedimento e defina as propriedades Tipo de cache da plataforma Salesforce e Minutos de vida útil.
1. Vá para a configuração do procedimento.

2. Na seção Configuração de cache, defina o Tipo de cache da plataforma Salesforce para um dos seguintes:
• branco — Sem cache

company
Atrás dessa lista suspensa está a lista de opções IsCacheable __c.
3. Especifique um valor para Tempo de vida em minutos . Essa configuração determina por quanto tempo
os dados permanecem no cache. O valor mínimo é 5. Os valores padrão e máximo dependem do tipo de
cache:
• Cache de sessão — O valor padrão é 5. O valor máximo é 480, equivalente a 8 horas. O cache é limpo
quando a sessão do usuário expira, independentemente desse valor.
• Cache da organização — O valor padrão é 1440, equivalente a 24 horas. O valor máximo é 2880,
equivalente a 48 horas.
O cache de nível superior substitui o cache do bloco de cache pela duração do valor de tempo de vida em
minutos de nível superior . Os dados de nível superior e do bloco de cache são limpos quando o
procedimento de integração é desativado, independentemente desse valor.
4. Clique em Ativar versão . O armazenamento em cache de nível superior ocorre apenas se o
Procedimento de Integração estiver ativo.
Veja Também
• Cache para dados do procedimento de integração de nível superior
Criar um exemplo de cache de nível superior

nomes. O armazenamento em cache de nível superior para a partição VlocityAPIResponse melhora o
desempenho de recuperação de contatos.
loop .



company

3. Na Configuração do procedimento, defina o Tipo de cache da plataforma Salesforce como Cache
organizacional .
4. Arraste um componente Loop Block para o painel Structure. Dê ao Loop Block as seguintes configurações:
Propriedade Valor
Aba Definições
configurações:
Propriedade Valor
Filtro Valor nome
7. Crie a Ação de Resposta abaixo do Bloco de Loop e defina as seguintes configurações:

Propriedade Valor
Enviar caminho JSON LoopBlock1:ExtrairContato
Nó JSON de resposta Contato
8. Na Configuração do Procedimento, clique em Ativar Versão .

9. Na guia Visualizar, clique em Editar como JSON e forneça a entrada com a seguinte estrutura:
{
"nomes": [
{
"nome": "Miller"
},
{
"nome": "Torres"
}
]
}
company
Para demonstrar o desempenho de forma mais eficaz, especifique nomes comuns ou muitos nomes.
navegador, servidor e CPU do Apex provavelmente serão semelhantes aos valores anteriore s.
valores resultantes do navegador, servidor e CPU do Apex provavelmente serão notavelmente menores
do que os valores anteriores. Além disso, Resposta em cache: true aparece após as métricas de
desempenho.
Desative o cache de escala

Para desativar o Scale Cache que DataRaptors e Integration Procedures usam, vá para Setup e adicione a
configuração TurnOffScaleCache à Omni Interaction Configuration.
4. No campo Rótulo , digite TurnOffScaleCache .
5. No campo Valor , digite true .
Veja Também
• Cache para DataRaptors e Procedimentos de Integração
Tratamento de Erros em Procedimentos de Integração

Você pode configurar as condições de sucesso ou falha de uma ação ou grupo de ações do
Procedimento de Integração.

company
Em cada etapa, você pode definir as seguintes propriedades:
• Fórmula Condicional de Falha : Especifique uma fórmula que seja avaliada como TRUE se a etapa não for
executada com êxito. Veja o segundo exemplo em Manipular Erros Usando Blocos Try-Catch .
• Erro de falha na etapa : ative esta opção para encerrar o procedimento de integração se a fórmula
condicional determinar que a etapa falhou.
NOTA
Uma ação que retorna uma lista não pode usar dados retornados em sua Fórmula Condicional de
Falha.
Para configurar condições e comportamento para o sucesso e falha de um grupo de ações, você pode usar um
bloco TryCatch . Consulte Lidar com erros usando blocos Try-Catch .
Para adicionar informações de depuração ao JSON de dados, use Ações de resposta. Para obter detalhes,
consulte Ação de resposta para procedimentos de integração .
As ações HTTP adicionam detalhes sobre os resultados da chamada ao nó Data JSON ElementNameInfo da
seguinte forma:
• Cabeçalhos de resposta, por exemplo, Content-Type

• Status de a resposta
• Código de status , por exemplo , 200
Variáveis de ambiente em DataRaptors e procedimentos de

integração
Você pode usar variáveis de ambiente para definir valores padrão e valores de filtro e em fórmulas.
Por exemplo, o filtro a seguir extrai os Casos criados nos últimos 30 dias.
Se você estiver usando uma variável de ambiente como um valor de Filtro, deverá colocá-la entre aspas
duplas.
$ Vlocity.HOJE de hoje
$ Vlocity.AMANHÃ data de amanhã
$ Vlocity.AGORA Data e hora atuais

company
$ Vlocity.N_DAYS_FROM_NOW :{N} A data do número especificado de dias a partir de agora
$ Vlocity.N_DAYS_AGO :{N} A data do número especificado de dias atrás
$ Vlocity.NULL Nulo
$ Vlocity.StandardPricebookId ID do catálogo de preços padrão
$ Vlocity.DocumentsFolderId ID da pasta de documentos
$ Vlocity.true ou $ Vlocity.TRUE Booleano TRUE
$ Vlocity.false ou $ Vlocity.FALSE Boolean FALSE
$ Vlocity.UserId Atual ID do usuário
$ Vlocity.Percent Porcentagem de caractere. Útil para escapar caracteres % em URLs para que não sejam confundidos com
a sintaxe do campo de mesclagem.
$ Vlocity.CpuTotal Valor da CPU do Apex
$ Vlocity.DMLStatementsTotal Número de instruções de linguagem de manipulação de dados
$ Vlocity.DMLrowsTotal Número de linhas da linguagem de manipulação de dados
$ Vlocity.HeapSizeTotal Pilha Tamanho valor
$ Vlocity.QueriesTotal Número de consultas executadas
$ Vlocity.QueryRowsTotal Número de linhas de consulta buscadas
$ Vlocity.SoslQueriesTotal Número de consultas SOSL executadas
Objetos Externos em Procedimentos de Integração

Os procedimentos de integração oferecem suporte a objetos externos do Salesforce. Os dados externos
podem vir de qualquer fonte que possa ser acessada usando um endpoint REST. Os dados retornados podem
ser renderizados como JSON ou XML.
Aqui está como funciona : _
1. No Salesforce, você executa uma operação no objeto externo Vlocity , por exemplo, no código Apex, em
um relatório ou emitindo uma consulta SOQL.
2. O manipulador de objetos externos Vlocity chama o Procedimento de Integração que implementa o
objeto externo, passando uma carga JSON que contém detalhes sobre a solicitação.
3. Com base no conteúdo da carga JSON, o Procedimento de Integração acessa os dados externos usando,
por exemplo, terminais REST ou chamadas DataRaptor e retorna resultados JSON ou XML.
4. O Procedimento de Integração retorna seus resultados ao manipulador de objetos externos Vlocity em um
formato intermediário.
5. O manipulador Vlocity transforma os resultados em uma carga JSON e os retorna ao chamador.
O diagrama a seguir ilustra o processo.

company
A vantagem dessa abordagem para acessar dados externos é que ela é completamente declarativa, sem
necessidade de código. Observe que, embora o objeto externo funcione como um único objeto, seu
Procedimento de Integração pode recrutar dados de várias fontes.
Lógica de Tratamento de Consultas no Procedimento de Integração

Para indicar o tipo de operação que está sendo solicitada do Procedimento de Integração, o manipulador
Vlocity define um
Entrada "Contexto" no JSON de entrada. Para definir as ações para tratar cada tipo de consulta em seu
Procedimento de Integração, defina o campo Fórmula Condicional de Execução das ações (por exemplo:
Context = " QueryAll "). A lista a seguir descreve os valores passados no nó Contexto para cada tipo de
solicitação, com exemplos SOQL e a carga útil JSON correspondente enviada ao Procedimento de Integração.
QueryAll : SELECT retornando todas as linhas (sem cláusula WHERE)
Exemplo de consulta: SELECT ExternalId FROM myExternalObject ;
Entrada JSON correspondente: {"Context":" QueryAll "}
Consulta : SELECT com cláusula WHERE
Exemplo de consulta: SELECT ExternalId FROM vlocity_dev__ ContactsList __x WHERE ExternalId =
'59f0f91a51280e0012c90584 ';
Entrada JSON correspondente: {"Input":

[{"ExternalId":"59f0f91a51280e0012c90584"}]," Context":"Consulta "}
Upsert : Atualize uma linha (se ExternalId for especificado) ou crie uma linha (se ExternalId for omitido).
Exemplo de consulta (UPDATE): INSERT INTO myExternalObject (Name, Mobile...) VALUES ("Davidov Spruth
", "415-607-9865"...)
Entrada JSON correspondente: {"Input":[{" Name":"Davidov

Spruth","Celular":"415-607-9865","CreateDate":"2017-10-25T20:50:34.188Z","Trabalho":
"415-232-6365","ExternalId":"59f0f91a51280e0012c90584","Email":"davs@gmail.com"
}],"Contexto":" Upsert "}
Excluir : Excluir linhas especificadas.
Exemplo de consulta: DELETE FROM myExternalObject WHERE ExternalId =

'"'59f0f91a51280e0012c90584'" ';
Entrada JSON correspondente: {"Input":
[{"ExternalId":"59f0f91a51280e0012c90584"}]," Context":"Consulta "}
Para acessar os dados externos para manipular a consulta, defina as ações HTTP que chamam os terminais
REST que executam as operações necessárias. Se os resultados retornados do endpoint exigirem
processamento adicional, crie e chame DataRaptor Transforms que executam as transformações necessárias.
Formato do resultado da consulta

Para retornar resultados do Procedimento de Integração para a consulta, estruture o JSON de saída da
seguinte forma:

company
Consultas SELECT : Retorna uma matriz de nós com nomes que correspondem às colunas da tabela definidas
para o objeto externo. Por exemplo:
[{
"Trabalho": "415-232-6365",
"Celular": "415-607-9865",
"E-mail": "davs@gmail.com",
" CreateDate ": "2017-10-25T20:50:34.188Z",
"Nome": "Davidov Spruth ",
" ExternalId ": "59f0f91a51280e0012c90584",
" Pesquisa Externa ": "59f0f91a51280e0012c90584",
" AccountIndirectLookup ": "123"
},
{
"E-mail": "mw@gmail.com",
" CreateDate ": "2017-10-25T21:49:41.633Z",
"Nome": "Mike Wormwood",
" ExternalId ": "59f106f5e928870012f2b0a0",
},
{
"Trabalho": "33-555-1212",
"Celular": "33-879-0610",
" CreateDate ": "2017-10-25T20:59:18.657Z",
" Nome ": "Tom Sor ",
" ExternalId ": "59f0fb26e928870012f2b09e",
}
]
Consultas UPDATE e DELETE : Retornam o ID externo do objeto afetado em um nó chamado " ExternalID "; por
exemplo:
{
" ExternalId ": "59efa135ba8e960012a3e8a5"
}
Se a consulta não for bem-sucedida , retorne um nó chamado " errorMessage " contendo detalhes sobre o
problema ocorrido.
Veja também
• Implementar um Objeto Externo em um Procedimento de Integração
Implementar um objeto externo em um procedimento de integração

Para acessar dados externos, você pode definir um Procedimento de Integração que implemente um
Objeto Externo do Salesforce.
company
1. Crie um Procedimento de Integração. Para Tipo, especifique VlocityExternalObject . Para Subtipo,
especifique o nome desejado para o objeto externo.
2. Na seção Configuração do Procedimento, defina as configurações de tabela e coluna. Essas são as
mesmas configurações que você pode definir na guia Objeto Externo do Salesforce. Para obter
informações detalhadas, consulte a documentação do Salesforce: Definir objetos externos e Relações de
Objetos Externos .
4. No Salesforce, vá para a guia Fonte de dados externa e navegue até a fonte de dados
VlocityExternalObject . Clique em Validar e Sincronizar .
Se a operação for bem-sucedida, seu novo objeto externo estará listado na página.
Veja também
• Objetos Externos em Procedimentos de Integração
Procedimentos de Teste: Procedimentos de Integração para Teste de

Unidade
Um Procedimento de Integração que executa um teste de unidade é um Procedimento de Teste . Você pode
usar um procedimento de teste para testar quase qualquer coisa que um procedimento de integração possa
invocar, como um DataRaptor , uma matriz de cálculo, uma classe do Apex ou outro procedimento de
integração.
Usando os procedimentos de teste e a estrutura de teste, você pode:
• Adicionar dados de depuração ao acompanhamento de eventos do procedimento de teste .

• Forneça entrada de amostra para a entidade que está sendo testada usando um componente Definir
valores para procedimentos de integração .
• Respostas simuladas de etapas específicas se a entidade que está sendo testada for um Procedimento de
Integração.
• Compare os resultados esperados e reais usando um componente Assert Action for Integration Procedures .
• Use o aplicativo de desktop IDX Workbench para executar procedimentos de teste .
• Revise os dados de Rastreamento de Eventos do Procedimento de Integração gerados como resultado dos
testes.
Após a conclusão de um procedimento de teste, sua transação é revertida. Isso permite executar testes que
criam sObjects sem afetar o banco de dados.
Como você organiza seus procedimentos de teste é com você. Por exemplo, você pode te star o mesmo
DataRaptor várias vezes usando entradas diferentes ou pode testar vários DataRaptors diferentes usando o
mesmo procedimento de teste.
Quando zombar dos componentes do procedimento de integração

Ao usar um Procedimento de Teste para testar outro Procedimento de Integração, você pode simular ou
simular as respostas de alguns dos componentes no Procedimento de Integração de teste ou no Procedimento
de Integração que está sendo testado. Por exemplo, você pode simular um componente que normalmente
recuperaria uma pontuação de crédito, usando uma pontuação codificada para teste. Isso não afeta como o
Procedimento de Integração normalmente é executado quando não está sendo testado.

company
Configuração do procedimento e especifique um par de chave/valor em Mapa de respostas simuladas. A Chave
deve ser o Nome de um componente e o Valor pode ser um texto literal ou um campo de mesclagem.
Para simular um componente com uma resposta mais complexa, acesse a Configuração do procedimento e
clique em Editar como JSON e edite o nó mockResponseMap . Por exemplo, o código JSON a seguir simula um
componente Set Values chamado IfOtherState que define um valor DefaultSalesTax :
" mockResponseMap ": {

" IfOtherState ": {
" DefaultSalesTax ": 0,06
}
}
Os seguintes tipos de componentes devem ser simulados no Procedimento de Integração de teste ou no

Procedimento de Integração que está sendo testado. Zombando outro componente tipos é permitido mas não
necessário .
Componente Motivo da zombaria
Ação de Envelope DocuSign para Procedimentos de Integração A resposta ao e-mail entregue não está disponível.
Ação de e-mail para procedimentos de integração A resposta ao e-mail entregue não está disponível.
Ação HTTP para procedimentos de integração Salesforce tem requisitos específicos para testar chamadas HTTP .
Chamadas HTTP em classes Apex chamadas

Se um Procedimento de Teste ou um Procedimento de Integração que está sendo testado incluir uma Ação
Remota e a classe do Apex que a Ação Remota invoca incluir uma chamada HTTP, você deverá garantir que a
chamada HTTP não faça parte do teste. Para fazer isso, edite a classe do Apex e coloque o callout HTTP em um
if
( IntegrationProcedureService.isTest == false) , por exemplo:
if ( IntegrationProcedureService.isTest == false) {
Solicitação de HttpRequest = new HttpRequest ( );
request.setMethod ('GET' );
request.setEndpoint ('http://example.com' );
Http httpCall = new Http( );

Resposta HttpResponse = httpCall.send (request );
}
Fluxo de trabalho para exemplo de procedimento de teste
Um Procedimento de Teste testa um cálculo realizado por outro Procedimento de Integração.
1. Habilite o Serviço de Rastreamento de Vlocity para Procedimentos de Integração. Consulte Ativar

rastreamento para componentes do OmniStudio e Adicionar dados de depuração ao rastreamento de
eventos de procedimento de teste .
2. Crie o Procedimento de Integração a ser testado. Consulte Criar um exemplo de bloco condicional com a
lógica If- ElseifElse .
3. Simule uma resposta no procedimento de integração testado .
4. Crie um procedimento de teste de exemplo .
5. Execute o procedimento de teste do IDX Workbench. Ver Executar procedimentos de teste .
company
As etapas de alto nível 3 e 4 são descritas aqui.
Veja Também
• Procedimento de Integração Ação para Procedimentos de Integração
• Propriedades da Ação do Procedimento de Integração para Procedimentos de Integração
Simule uma resposta no procedimento de integração testado

Antes de criar o procedimento de teste de exemplo, adicione um mapa de resposta simulado ao procedimento
de integração a ser testado.
1. Vá para a guia Procedimentos de integração do OmniStudio e abra o Procedimento de integração a ser

testado.
2. Se o Procedimento de Integração estiver ativo, clique em Desativar Versão para poder editá-lo.
3. Na Configuração do Procedimento, clique em Editar como JSON .
4. Edite o nó mockResponseMap da seguinte forma:
" mockResponseMap ": {

" IfOtherState ": {
" DefaultSalesTax ": 0,06
}
}
5. Clique em Editar no Editor de propriedades .
6. Clique em Ativar versão . O Procedimento de Integração a ser testado deve estar ativo.
Veja Também
• exemplo de procedimento de teste
Criar um procedimento de teste de exemplo
Depois de simular uma resposta no Procedimento de Integração a ser testada, crie o Procedimento de Teste
que testa um cálculo que ele executa.
O Procedimento de Teste tem estes componentes:
• Um componente Set Values, chamado IPInput

• Um componente de Ação do Procedimento de Integração, chamado TestIP
• Um Afirmar Ação , nomeada AssertTotal
• ação de resposta , chamada TesteResposta
Uma Ação de Resposta não é necessária, mas é útil para testar o Procedimento de Teste. Depois de verificar se
o Procedimento de teste funciona, você pode desativá-lo ou excluí-lo.

company
Para criar o Procedimento de Teste:

3. Role até a parte inferior da Configuração do procedimento e marque É o procedimento de teste .
Propriedade Valor
Elemento Nome Entrada IP
Elemento Mapa de valores : preço 250
Elemento Mapa de valores : estado Nova Iorque
Propriedade Valor
Nó JSON de resposta Entrada IP
5. Arraste um componente Ação do Procedimento de Integração para o painel Estrutura e defina as

seguintes configurações:
Propriedade Valor
Elemento Nome TestIP
Procedimento de Nome que você deu ao Procedimento de Integração a ser testado, descrito em Definir lógica de execução usando
Integração blocos condicionais .
Enviar caminho JSON Entrada IP
6. Arraste um componente Assert Action para o painel Structure e defina as seguintes configurações:
Propriedade Valor
Elemento Nome AssertTotal
Afirmar Condicional Fórmula TestIP:Saída:Total == 265

company
Afirmar Falha Mensagem Cálculo é incorreto .
7. Arraste um componente Ação de resposta para o painel Estrutura e defina as seguintes configurações:
Propriedade Valor
Elemento Nome TesteResposta
Retornar JSON de dados completos ( verificado )
Depois de verificar se o procedimento de teste funciona, você pode desativar este componente.
8. Vá para a guia Visualizar e clique em Executar . A saída deve ficar assim:
{
"resposta": {
" testResult ": "sucesso"
},
" TestResponseStatus ": verdadeiro,
" AssertTotal ": {
" assertFailureMessage ": "Cálculo incorreto.",
" variávelData ": {
" TestIP:Saída:Total ": 265
},
" assertConditionalFormula ": " TestIP:Output:Total == 265",
" assertResult ": verdadeiro
},
" AssertTotalStatus ": verdadeiro,
" TestIP ": {
" testResult ": "sucesso",
"Resultado": {
"Preço": 250,
"Estado": "NY",
"Imposto": 15,
" Taxa de imposto ": 6,
"Total": 265
}
},
" TestIPStatus ": verdadeiro,
" IPInput ": {
"Preço": 250,
"Estado": "NY"
},
" IPInputStatus ": verdadeiro,
"opções": {
" useQueueableApexRemoting ": false,
}
}

company
9. (Opcional) No componente IPInput , altere o Preço ou altere o Estado para WA, OR, NV ou CA.
Em seguida, retorne à guia Visualizar e clique em Executar novamente. Observe como a saída muda.
10. Para se preparar para executar o procedimento de teste :
a. No componente TestResponse , clique em Ativo para remover a verificação.
b. Na Configuração do Procedimento, clique em Ativar Versão . O IDX Workbench executa apenas
procedimentos de teste ativos.
Veja Também
• exemplo de procedimento de teste
Invocação do Procedimento de Integração

Você pode invocar os Procedimentos de Integração de outras ferramentas do OmniStudio , como OmniScripts
e Cartões. Você também pode invocar procedimentos de integração de classes do Apex, trabalhos em lote,
APIs REST ou fluxos do Salesforce.
Invocação do Procedimento de Integração do Apex

Você pode invocar um Procedimento de Integração do código Apex de duas
maneiras usando a classe IntegrationProcedureService no pacote gerenciado
Vlocity . Exemplo de Chamada de Procedimento de Integração 1
class IntegrationProcedureService {
/*
procedureAPIName - o Type_SubType do procedimento ou a entrada OmniScript __ c.Id - A carga
útil/dados iniciais no DataJSON para o procedimento
*/
Public static Object runIntegrationService (String procedureAPIName ,
Map<String, Object> input, Map<String, Object> options );
/*
Implementação de VlocityOpenInterface2: methodName - o Type_SubType do procedimento
ou o OmniScript __ c.Id -
procedimentoAPIName acima
input - A carga útil / dados iniciais no DataJSON para a saída do procedimento - retornará Response
em output.put ('resultado', RESPONSE)
*/
public Object invokeMethod (String methodName , Map<String, Object> input,
Saída Map<String, Object>, opções Map<String, Object> );
}
Exemplo de Chamada de Procedimento de Integração 2

/* Inicializa as variáveis */
String procedureName = ' Type_SubType ';
Map<String, Object> ipInput = new Map<String, Object> ( );
Map<String, Object> ipOutput = new Map<String, Object> ( );
Map<String, Object> ipOptions = new Map<String, Object> ( );
/* Preenchendo o mapa de entrada para um Procedimento de Integração.

company
Siga qualquer estrutura que seu VIP espera */
String orderId = '80100000000abcd'; ipInput.put (' orderId ', orderId );
/* Chama o IP via runIntegrationService e salva a saída

em ipOutput */ ipOutput = (Map<String, Object>)
vlocity_cmt.IntegrationProcedureService.runIntegrationService(procedureName, ipInput , ipOptions );
System.debug ('Saída IP: ' + ipOutput );
Teste de Unidade de Procedimento de Integração do Apex

Você pode configurar uma classe de teste no Apex e usá-la para chamar e testar um Procedimento de
Integração. Você deve simular respostas de ação HTTP.
Veja a seguir um teste de unidade de exemplo de um Procedimento de Integração:

@isTest(seeAllData=true)
global com classe de compartilhamento TestVlocityIntergationProcedure
{
static testMethod void testVip ()
{
Map<String, Object> resposta = (Map<String,
Object>) namespace .IntegrationProcedureService.runIntegrationService(' Type _ Subty pe ',
new Map<String, Object>{
' AccountName ' => ' Vlocity '
}, new Map<String, Object>() );
System.assertEquals ('joe@vlocity.com', response.get (' ContactEmail ') );
}
}
Observe estes recursos do exemplo:
• Você deve usar a propriedade seeAllData do Salesforce na anotação @isTest . Isso garante que o teste de
unidade veja o Vlocity Dados SObject no org.
• O método que executa o Procedimento de Integração é
IntegrationProcedureService.runIntegrationService .
• O namespace é vlocity_cmt , vlocity_ins ou vlocity_ps .
• O parâmetro Type _ Subtype especifica o Procedimento de Integração a ser testado.
Salesforce tem requisitos específicos para testar chamadas HTTP . Portanto, as ações HTTP requerem
tratamento especial.
Você pode definir a resposta HTTP simulada de um Procedimento de Integração usando o seguinte método
global Vlocity :
IntegrationProcedureServiceTest.setMockHttpResponse ( resposta HttpResponse )
Isso é necessário porque quando um Procedimento de Integração é executado, o Pacote Gerenciado Vlocity
faz o callout HTTP internamente.
Veja a seguir um teste de unidade de exemplo de um Procedimento de Integração que inclui uma Ação HTTP:

company
global com classe de compartilhamento TestVlocityIntergationProcedure
{
static testMethod void testVipWithHttpCallout ()
{
HttpResponse res = new HttpResponse (); res.setHeader ('Content-Type', 'application/ json ');
res.setBody ('{" ContactEmail ":"joe@vlocity.com"}' );
res.setStatusCode (200 );
namespace .IntegrationProcedureServiceTest.setMockHttpResponse(res );

}, new Map<String, Object>()); System.assertEquals ('joe@vlocity.com', response.get (' ContactEmail ') );
}
}
Nas versões Winter '20 e posteriores, se um Procedimento de Integração incluir mais de uma Ação HTTP, você
poderá definir as respostas HTTP simuladas usando o seguinte método global Vlocity :
IntegrationProcedureServiceTest.setMockHttpResponseByUrlOrActionName()
Usar o nome do elemento da ação HTTP geralmente é mais fácil. No entanto, para algumas ações HTTP, como
uma dentro de um bloco de loop, talvez seja necessário especificar a URL. Se você especificar a URL, ela deverá
ser a URL exata que você está chamando. Se for um NamedCredential , ele seguirá o callout padrão :
NamedCredentialName .
Veja a seguir um teste de unidade de exemplo de um procedimento de integração que inclui duas ações HTTP:
global com classe de compartilhamento TestMockHttpIP
{
static testMethod void testVipWithHttpCallout ()
{
HttpResponse res1 = new HttpResponse (); res1.setHeader('Content-Type', 'application/ json ' );
res1.setBody('{" ContactEmail ":"joe@vlocity.com"}'); res1.setStatusCode(200 );
namespace .IntegrationProcedureServiceTest.setMockHttpResponseByUrlOrActionName(
' GetContactsHttp ', res1 );
HttpResponse res2 = new HttpResponse ( );

res2.setHeader('Content-Type', 'application/ json ' );
res2.setBody('{"ContactEmail":"joe2@vlocity.com"}'); res2.setStatusCode(200 );
namespace .IntegrationProcedureServiceTest.setMockHttpResponseByUrlOrActionName(
'callout:MyContactInfo2', res2 );

company
}, new Map<String, Object>()); System.assertEquals ('joe@vlocity.com', response.get (' ContactEmail ') );
System.assertEquals ('joe2@vlocity.com',
response.get ('Ação2Resposta') );
}
}
Invocação de procedimento de integração de APIs REST

Você pode usar uma chamada GET ou POST para executar um Procedimento de Integração e recuperar o
resultado. A única diferença é que uma chamada GET não pode incluir um corpo de solicitação JSON.
Para obter um exemplo, consulte Invocar um procedimento de integração encadeável com chamadas REST .
NOTA
Em JSON, as chaves são literais, mas na notação REST, as chaves representam variáveis.
Invocação do procedimento de integração usando GET

Para obter dados JSON para um Procedimento de Integração, emita uma chamada GET. Você pode incluir
valores embutidos e parâmetros de consulta, mas não pode passar dados JSON.
Use um URL formatado da seguinte forma:
/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/
Especifique o Tipo e o Subtipo do Procedimento de Integração. Você também pode enviar cabeçalhos HTTP
como opções.
Para passar dados de entrada em uma chamada GET, você pode especificar parâmetros de URL. Você não
pode especificar um corpo de solicitação JSON. Se você precisar especificar um corpo de solicitação JSON, use
uma chamada POST.
No exemplo a seguir, um Procedimento de Integração que cria casos requer um nome de contato e retorna a
ID do caso recém-criado. O nome do contato é especificado na URL. Observe que o código HTML %20
representa o espaço entre o nome e o sobrenome.
PEGUE
/services/apexrest/vlocity_ins/v1/integrationprocedure/Create_Cases/?
Contact=Dennis%20Reynolds
Exemplo de resultado:
{
"Caso": {
"Id": "0036100001HDn3QAAT"
}
}

company
Existem duas maneiras de passar parâmetros para o Procedimento de Integração na URL:
• Parâmetro / valor pares

• Valores embutidos no caminho do URL
A sintaxe é a seguinte:
{inlinevalue1}/{inlinevalue2}/?{Param1}={Value1}
Por exemplo, o seguinte URL:
/services/apexrest/vlocity_cmt/v1/integrationprocedure/IP_Rest/Apple/Phones/? produto= iPhoneX
...envia esta entrada para o Procedimento de Integração:
{
"opções": {
"Caminho1": "Maçã",
"Caminho2": "Telefones",
"produto": " iPhoneX ",
" isDebug ": "true"
}
}
Os valores passados no caminho são adicionados no nó de opções , com chaves denominadas Path N .
Você também pode definir opções de Procedimento de Integração, como chainable ou queueableChainable,
usando uma API REST. Por exemplo:
/services/apexrest/vlocity_ins/v1/integrationprocedure/Create_Cases/? encadeável = verdadeiro
Invocação do procedimento de integração usando POST

Para postar dados JSON em um Procedimento de Integração, emita uma chamada POST. Você também pode
incluir valores embutidos, parâmetros de consulta e um corpo de solicitação JSON.
Use um URL formatado da seguinte forma:
Especifique o Tipo e o Subtipo do Procedimento de Integração. Você também pode enviar cabeçalhos HTTP
como opções.
Para passar dados de entrada em uma chamada POST, você pode especificar um corpo de solicitação JSON ou
parâmetros de URL.
No exemplo a seguir, um Procedimento de Integração que cria casos requer um nome de contato e retorna a
ID do caso recém-criado. O nome do contato é especificado em um corpo de solicitação JSON.
PUBLICAR
/services/apexrest/vlocity_ins/v1/integrationprocedure/Create_Cases/
Dados POST JSON:

company
{
" Contato":"Dennis Reynolds"
}
Exemplo de resultado:
{
"Caso": {
"Id": "0036100001HDn3QAAT"
}
}
Existem duas maneiras de passar parâmetros para o Procedimento de Integração na URL:
• Parâmetro / valor pares

• Valores embutidos no caminho do URL
A sintaxe é a seguinte:
{inlinevalue1}/{inlinevalue2}/?{Param1}={Value1}
Por exemplo, o seguinte URL:
/services/apexrest/vlocity_cmt/v1/integrationprocedure/IP_Rest/Apple/Phones/? produto= iPhoneX
...envia esta entrada para o Procedimento de Integração:
{
"opções": {
"Caminho1": "Maçã",
"Caminho2": "Telefones",
"produto": " iPhoneX ",
" isDebug ": "true"
}
}
Os valores passados no caminho são adicionados no nó de opções , com chaves denominadas Path N .
Você também pode definir opções de Procedimento de Integração, como chainable ou queueableChainable,
usando uma API REST. Por exemplo:
/services/apexrest/vlocity_ins/v1/integrationprocedure/Create_Cases/? encadeável = verdadeiro
Invocação do procedimento de integração do Salesforce Flow

Para chamar um Procedimento de Integração de um Salesforce Flow, crie um componente Salesforce Flow
definindo uma classe usando o Salesforce Developer Console , conforme mostrado no exemplo a seguir.
Observe que a classe deve ter a anotação @InvocableMethod .
global com compartilhamento de classe IntegrationProcedureInvocable {

@InvocableMethod(label = 'Procedimento de Integração') lista estática
global < IntegrationProcedureOutput >
runIntegrationServiceInvocable (Lista < IntegrationProcedureInput > input) {
System.debug ( LoggingLevel.Error , JSON.serialize (entrada) );
company
Resultado de IntegrationProcedureOutput = new IntegrationProcedureOutput ( );
resultado.saída = JSON.serialize (
IntegrationProcedureService.runIntegrationService (
entrada[0]. procedureAPIName , new
Map < String, Object >
{
'Id' => input[0].input
},
new Map < String, Object > ()) );
System.debug ( LoggingLevel.Error , JSON.serialize (resultado) );
return new List < IntegrationProcedureOutput >
{
resultad
o
};
}
classe global IntegrationProcedureInput
{
@InvocableVariable(label = 'Nome do procedimento') global String procedureAPIName ;
@InvocableVariable(label = 'Input') global String input;
}
classe global IntegrationProcedureOutput
{
@InvocableVariable(label = 'Saída') global String output;
}
}
Depois de definir a classe, você pode usar o componente de fluxo resultante no Salesforce Flow Designer para
chamar os Procedimentos de Integração. Arraste o componente da lista para o fluxo e defina suas
propriedades da seguinte maneira.
Configurações gerais : defina Nome e Nome exclusivo para nomes descritivos para a instância do componente
no fluxo.
Configurações de entrada
• Nome do Procedimento: Especifique o Procedimento de Integração a ser executado usando este formato:
Tipo _ Subtipo (observe o sublinhado).
• Entrada: Para cada variável de entrada exigida pelo Procedimento de Integração, escolha Variável e
especifique o nome da variável de entrada usando o seguinte formato: {! nomedavariável }
Configurações de Saída : Para cada variável retornada pelo Procedimento de Integração, escolha Variável e
especifique o nome da variável de saída usando o seguinte formato: {! nomedavariável }
Configurações para procedimentos de integração de longa duração

Você pode usar configurações encadeáveis e enfileiradas para evitar atingir os limites do administrador do
Salesforce ao invocar Procedimentos de integração de longa execução. Você também pode encadear em uma
ou mais etapas específicas de longa duração.
Por padrão, todas as ações em um Procedimento de Integração são executadas em uma única
transação. Se a transação exceder um limite do administrador do Salesforce, o Salesforce encerrará a

company
transação e o Procedimento de integração falhará. Você não pode definir um limite que exceda o máximo
imposto pelo Salesforce. Para obter detalhes sobre os limites do governador, consulte o tópico relevante do
Salesforce .
Para mitigar esse problema, use as configurações em ambos os níveis:
• Habilite o encadeamento do OmniScript ou da ação do Procedimento de Integração pai que chama o

Procedimento de Integração de longa duração .
• Opcionalmente, defina limites que acionam o encadeamento no próprio Procedimento de Integração de
longa duração usando as configurações descritas aqui.
Quando o encadeamento é ativado e uma etapa do Procedimento de Integração excede um limite do

controlador, seus resultados provisórios são salvos e a etapa continua em uma transação separada. Como a
etapa é executada em sua própria transação, ela não disputa recursos com outras etapas no Procedimento de
Integração, portanto, é menos provável que atinja os limites do administrador.
Para maximizar o desempenho, as etapas são encadeadas somente quando atingem os limites do regulador.
Se nenhum limite for excedido, todas as etapas do Procedimento de Integração serão executadas em uma
única transação. Quando as etapas são encadeadas, o desempenho do Procedimento de Integração pode ser
afetado negativamente pela necessidade de dividir a execução em partes que não excedam os limites do
controlador e a necessidade de armazenar resultados provisórios.
Você pode aumentar os limites do administrador do Salesforce permitindo que uma etapa encadeável inicie
um trabalho enfileirado, que é executado como um trabalho do Apex assíncrono. Esses trabalhos têm limites
de tamanho de CPU, SOQL e heap mais altos do que as transações regulares. No entanto, embora isso ajude a
garantir que os limites do regulador não sejam excedidos, pode reduzir o desempenho.
Para organizações Developer Edition e Trial, a profundidade máxima da pilha para tarefas encadeadas é 5, o
que significa que você pode encadear tarefas quatro vezes. Esse limite de 5 inclui o trabalho enfileirado pai
inicial. Ver Apex enfileirado na ajuda do Salesforce.
Para obter um exemplo, consulte Invocar um procedimento de integração encadeável com chamadas REST .
Configurações encadeáveis e enfileiradas
Para configurar limites abaixo dos padrões do Salesforce, edite as configurações Chainable Configuration e
Queueable Chainable Limits na seção Configuração do procedimento do procedimento de integração . Para
desabilitar a verificação de um limite, deixe-o em branco. Se você desativar a verificação de um limite e uma
etapa exceder o limite do Salesforce, o Procedimento de integração falhará.
As configurações encadeadas são as seguintes:
• Limite de consultas encadeadas : número máximo de consultas SOQL que podem ser emitidas. O máximo
padrão é 100.
• Limite de instruções DML encadeadas : número máximo de instruções DML (Data Manipulation Language)
que podem ser emitidas. O máximo padrão é 150.
• Limite de CPU encadeável : tempo máximo de CPU nos servidores do Salesforce. Máximo padrão é 10.000
milissegundos .
• Limite de tamanho de heap encadeável : Memória usada para armazenar dados durante o processamento
de transações. O máximo padrão é 6MB.
• Limite de linhas DML encadeadas : número máximo de registros que podem ser processados como
resultado de instruções DML, Approval.process ou database.emptyRecycleBin . O máximo padrão é
10.000.
company
• Limite de linhas de consulta encadeadas : número máximo de linhas que uma consulta SOQL pode
recuperar. O máximo padrão é 50.000.
• Limite de consultas SOSL encadeadas : Número máximo de consultas SOSL que podem ser emitidas.
Máximo padrão é 20.
• Tempo real do encadeamento : número de segundos que um procedimento de integração pode ser
executado antes que o encadeamento ocorra para evitar atingir o limite de solicitações simultâneas do
Salesforce . Nenhum padrão.
NOTA
Limite de consultas encadeáveis , Limite de linhas de consulta encadeável e Limite de consultas
SOSL encadeável funcionam dentro de um pacote gerenciado, mas não fora dele. Por exemplo, se
uma Ação Remota executa consultas fora do pacote, elas não contam para os limites.
As configurações de enfileiramento enfileirado são as seguintes:
• Limite de tamanho de heap encadeado enfileirado : Memória usada para armazenar dados durante o
processamento da transação. O máximo padrão é 12MB.
• Limite de CPU encadeável em fila : tempo máximo de CPU nos servidores do Salesforce. O máximo padrão
é 60.000 milissegundos .
• Limite de consultas enfileiradas em fila : número máximo de consultas SOQL que podem ser emitidas.
Máximo padrão é 200.
As configurações de encadeamento enfileirado substituem seus equivalentes encadeados se ambos estiverem

definidos.
Como chamar um procedimento de integração encadeável ou enfileirado
Para habilitar o encadeamento para um Procedimento de Integração que é chamado de um OmniScript , abra
a ação Procedimento de Integração que chama o Procedimento de Integração e marque a caixa de seleção
Encadeável . Para habilitar etapas encadeadas para iniciar trabalhos enfileirados, marque também a caixa de
seleção Enfileirado . Consulte Ação do Procedimento de Integração .
Se você estiver chamando um Procedimento de Integração de uma API REST, poderá definir a opção chainable
ou queueableChainable como true . Consulte Invocar um procedimento de integração encadeável com
chamadas REST .
Um Procedimento de Integração pai pode desabilitar as configurações Chainable de um Procedimento de

Integração filho que ele chama. Consulte Ação do procedimento de integração para procedimentos de
integração .
A Cadeia na Configuração de Passos

Para habilitar o encadeamento para uma determinada etapa de longa duração em um Procedimento de
Integração, verifique sua configuração Chain On Step . Quando o Procedimento de Integração é chamado com
encadeamento ativado e um limite é atingido, a etapa é executada em sua própria transação.
Chain On Step não é necessário para que ocorra o encadeamento. Se nenhuma etapa tiver Chain On Step
aplicado, o encadeamento ocorre na etapa em que o uso de recursos do Procedimento de Integração se
aproxima dos limites do controlador ou de uma configuração encadeável ou enfileirada.

company
Se o seu Procedimento de Integração tiver uma ação DataRaptor Post seguida por uma ação HTTP, ative Chain
On Step para a ação DataRaptor Post para evitar o seguinte erro do Salesforce: Você tem trabalho pendente
não confirmado. Por favor, confirme ou reverta antes de chamar.
Configurações encadeáveis e enfileiradas na pré-visualização

Para habilitar as configurações Chainable e/ou Queueable Chainable ao testar um Procedimento de Integração
usando a guia Visualização, expanda o painel Opções e defina uma ou mais destas opções:
• chainable : Se true , habilita as configurações Chainable para teste.

• queueableChainable : Se true , habilita as configurações de Queueable Chainable para teste.
• useQueueableApexRemoting : se true , limita a quantidade de tempo que a CPU do Apex é executada
iniciando um trabalho enfileirado sem encadeamento.
A propriedade da mensagem de ação no OmniScript de chamada

Para visualizar o progresso de um Procedimento de Integração encadeado ao depurar o OminScript que o
chama, defina a propriedade Mensagem de Ação das etapas encadeadas no Procedimento de Integração. O
texto inserido no campo Mensagem de ação pode ser visualizado no painel Depuração do OmniScript
Designer, conforme mostrado na figura a seguir.
Os OmniScripts e os Procedimentos de Integração pai que chamam os Procedimentos de Integração

encadeados tratam as transações automaticamente. No entanto, se você chamar um procedimento de
company
integração encadeável de um componente da Web do Lightning , será necessário incluir um código que lide
com as respostas intermediárias.
Para ver como são as respostas intermediárias, consulte Invoke a Chainable Integration Procedure with REST
Calls .
Aqui está uma maneira de estruturar o código JavaScript para lidar com essas respostas:
function runChainable (opções) { options.isDebug = vm.

isDebug ;
remoteActions.testIntegrationProcedure ( ipId , inputData ,
opções).then(function(resposta) { responseHandler (resposta); } );
}
function responseHandler (resposta) { if ( typeof

(resposta) === 'string') { resposta = JSON.parse
(resposta );
}
if (resposta && resposta.vlcIPData &&
response.vlcStatus === 'Em andamento') {
runChainable (resposta );
} senão {
// trata a resposta do IP
}
}
Invocar um procedimento de integração encadeável com chamadas REST

Um procedimento de integração encadeável é dividido em várias transações para evitar atingir os limites do
administrador do Salesforce. Usar uma API REST é a maneira mais fácil de ver as re spostas parciais que cada
transação retorna antes que o Procedimento de Integração seja concluído.
Antes de começar
1. Para garantir que você possa usar os comandos curl em seu computador, em uma janela de terminal, digite curl -help . Se a curvatura estiver
disponível, você verá uma longa lista de opções de curvatura .
2. Determine o namespace que os Procedimentos de Integração em sua organização usam, omnistudio , vlocity_ins , vlocity_cmt ou vlocity_ps .
3. Crie este exemplo de Procedimento de Integração ou importe seu DataPack : Crie um Exemplo de Bloco Try-Catch com uma Fórmula .
4. Obtenha o ID de sessão para seu login atual em sua organização. Consulte Configurar autorização no Guia do desenvolvedor da API REST do
Salesforce .
1. Abra o exemplo do Procedimento de Integração em sua organização. Se você importou o DataPack , ele
está listado em Documentation/IPTryCatch2 ou Documentation/IPTryCatchF2 .
2. Na guia Visualizar, tente valores de parâmetro de entrada Nome diferentes até encontrar um que retorne
mais de um registro, mas não muitos. Um nome ideal valor retorna dois nomes .
3. Na Configuração do Procedimento, clique em Desativar Versão se o Procedimento de Integração estiver
ativo para que você possa editá-lo. Defina o Limite de linhas de consulta encadeadas para um valor baixo
o suficiente para causar encadeamento.
Por exemplo, se o valor Name na etapa anterior retornar dois registros, um valor Chainable Query Rows
Limit de 1 resultará em duas transações. Se o valor Name na etapa anterior retornar seis registros, um
valor Chainable Query Rows Limit de 2 resultará em três transações.
4. Acesse o componente DataRaptorExtractAction1 e verifique sua propriedade Chain on Step .
5. Volte para a Configuração do Procedimento e clique em Ativar Versão .
6. Em uma janela de terminal, digite um comando curl neste formato, tudo em uma linha:

company
curl -X POST -H 'Autorização: Bearer session_id ' -H 'Content-Type: application/ json ' -H ' chainable:true
' --data-raw '{" Name":" Name "}' https:// ap1.salesforce.com/services/apexrest/ namespace
/v1/integrationprocedure/
Tipo _ Subtipo
Por exemplo, se o Name for Jones , o namespace for vlocity_ins , o Type for Documentation e o SubType
for IPTryCatchF2 , seu comando curl terá a seguinte aparência:
curl -X POST -H 'Autorização: Portador 00Dnn000000nnnn!ARUAQLt ...

QqodNY3' -H 'Tipo de conteúdo: application/ json ' -H ' chainable:true ' -- dataraw '{" Name":"Jones "}'
https://ap1.salesforce.com/services/apexrest/ vlocity_ins / v1/ procedimento de integração
/Documentation_IPTryCatchF2
Um ID de sessão é uma String muito longa. Neste exemplo, o ID da sessão é truncado para maior clareza.
GORJETA
Você pode montar o comando curl em um editor de texto e copiá-lo na janela do terminal.
7. Examine a resposta. Se parece com isso:
{
" vlcUseQueueableApexRemoting ": false,
" vlcMessage ": null ,
" vlcIPData ": "dc3e1986-2f7c-0871-e968-28eb63e11820",
" vlcStatus ": " Em andamento "
}
NOTA
A Visualização do Procedimento de Integração trata o encadeamento automaticamente, para
que você nunca veja esse tipo de resposta.
8. Adicione um cabeçalho para o vlcIPData ao comando curl e insira-o. Por exemplo :
curl -X POST -H 'Autorização: Portador 00Dnn000000nnnn!ARUAQLt ...

QqodNY3' -H 'Tipo de conteúdo: application/ json ' -H ' chainable:true ' -- dataraw '{" Name":"Jones "}'
-H 'vlcIPData:dc3e1986-2f7c-0871-e968-28eb63e11820'
https://ap1.salesforce.com/services/apexrest/vlocity_ins/v1/ integrationprocedure
/Documentation_IPTryCatchF2
9. Examine a resposta. Se ele contiver outro valor vlcIPData , repita a etapa anterior com o novo valor
vlcIPData . Continue repetindo com cada novo valor vlcIPData até que a resposta fique assim:
{
"resposta": {},
"Nome": "Jones",
"opções": {
"Aceitar": "*/*",
"X-B3-SpanId": "ee09609f22d890e1",
" CipherSuite ": "ECDHE-RSA-AES256-GCM-SHA384 TLSv1.2 256 bits",
"User-Agent": "curl/7.64.1",

company
"X-B3-Sample": "0",
"Host": "ap1.salesforce.com",
"X-B3-TraceId": "ee09609f22d890e1",
"encadeável": "verdadeiro",
"X-Salesforce-SIP": "42.42.42.42",
"Content-Type": "application/ json "
},
{
" ContactName ": "John Jones"
},
{
" ContactName ": "June Jones"
}
],
"TryCatchBlock1": null
}
Esta resposta é um exemplo do que você obtém quando o Procedimento de Integração é concluído.
Continuação em chamadas de longa duração

Para oferecer suporte a chamadas de longa duração, o Salesforce oferece Continuações do Apex . Se o
OmniScript chamar um procedimento de integração de longa duração ou uma classe do Apex, você poderá
habilitar a continuação.
Para OmniScripts que chamam Procedimentos de Integração de longa execução, verifique a configuração Usar
Continuação na Ação do Procedimento de Integração.
Para OmniScripts que chamam classes do Apex usando ações remotas, você tem duas opções:
• Faça uma chamada remota de longa duração usando VlocityContinuationIntegration — Essa abordagem é
mais antiga, ainda com suporte, mas obsoleta.
• Faça uma chamada remota de longa duração usando OmniStudio.OmniContinuation — Essa abordagem é
recomendada porque é independente de namespace.
Faça uma chamada remota de longa duração usando VlocityContinuationIntegration

Para oferecer suporte a chamadas remotas de longa duração, o Vlocity oferece suporte ao uso do objeto
Salesforce Continuation. o
interface VlocityOpenInterface2 e a classe VlocityContinuationIntegration suportam normal
Chamadas Remotas e Chamadas Remotas que usam o Objeto de Continuação. Para as novas classes do Apex,
não use VlocityOpenInterface .
Para obter mais informações sobre o objeto SFDC Continuation, consulte a seguinte documentação do
Salesforce:
• Processo para uso Assíncrono Frases de destaque
• Continuações do Apex: chamadas assíncronas de páginas do Visualforce

company
Para fazer uma chamada remota usando o objeto Salesforce Continuation e estendendo a classe
VlocityContinuationIntegration :
1. Crie uma classe do Apex que estenda a classe VlocityContinuationIntegration . este classe implementa
VlocityOpenInterface2 .
2. Implemente o método de retorno de chamada no invokeMethod . Para obter mais informações, consulte
a classe de exemplo no final deste tópico.
3. Para o método que retorna o Objeto de Continuação, chame o método VlocitySetAsyncCallbackState
antes do retorno.
con.continuationMethod = ' customcallback '; // implementado em invokeMethod

VlocitySetAsyncCallbackState (con, con.addHttpRequest (req), opções );
4. Para o último método de retorno de chamada na cadeia que retorna a resposta para OmniScript , use o
código a seguir para obter o estado do Objeto de Continuação e os rótulos do sistema.
Estado do objeto = inputMap.get (' vlcContinuationCallbackState ' );

Etiquetas de objetos = inputMap.get (' vlcContinuationCallbackLabels ' );
5. O objeto 'state' retornado de inputMap.get (' vlcContinuationCallbackState ') deve ser um Map<String,
Object> com conteúdo que não pode ser convertido diretamente usando
(CustomApexWrapperClass)inputMap.get('vlcContinuationCallbackState') . Em vez disso, o objeto
retornado deve ser serializado para JSON e, em seguida, desserializado e convertido em sua classe
correta. Por exemplo:
CustomApexWrapperClass =
( CustomApexWrapperClass ) JSON.deserialize ( JSON.serialize (estado),
CustomApexWrapperClass.class );
Essa abordagem permite que quaisquer dados gravados no VlocitySetAsyncCallbackState sejam retidos e
usados como sua classe Apex personalizada.
Exemplo 15. Exemplo de classe VlocityContinuationIntegrationTest.cls

// Exemplo de classe do Apex para fazer chamadas remotas no OmniScript
// (1) Cria uma classe Apex personalizada que estende
VlocityContinuationIntegration , para um pacote gerenciado Vlocity ,
// precisa incluir o prefixo de namespace - NS.VlocityContinuationIntegration
// (2) implementa invokeMethod , o tipo de retorno é Object (a) na continuação
Caso de objeto, retorne Objeto de Continuação
// (b) no caso normal, você pode retornar Boolean
global com a classe de compartilhamento VlocityContinuationIntegrationTest estende
VlocityContinuaçãoIntegração
{
substituição global Object invokeMethod (String methodName , Map<String, Object> inputMap ,
Map<String, Object> outMap , Map<String, Object> opções)
{
tent
ar {
// os métodos personalizados podem ter qualquer assinatura personalizada, mas
// POR FAVOR, FAÇA VOCÊ SEMPRE PASSAR opções if( methodName.equals ('Continuation1'))
{

company
// isso retorna o Objeto de Continuação
return Continuation1(10, inputMap , outMap , opções );
}
else if( methodName.equals ('Continuation2'))
{
return Continuation2(8, opções );
}
else if( methodName.equals (' customcallback '))
{
customcallback ( inputMap , outMap , opções );
}
// outros métodos para lidar com a chamada remota normal
senão
{
resultado = falso;
}
}
catch( System.Exception e) {
// System.log ... resultado = false;
}
retorno resultado;
}
// Você também pode ter outros parâmetros, mas certifique-se de sempre passar
Opções de Map<String, Object>
private Object Continuation1(Contagem de inteiros, Map<String, Object> inputMap ,
Map<String, Object> outMap , Map<String, Object>)
{
// ESTE É UM EXEMPLO PARA CHAMAR O SERVIÇO DE NÓ HEROKU
// Faça um HTTPRequest como normalmente faríamos // Lembre-se de configurar uma
Configuração de Site Remoto para o serviço!
String url = ' https://node-count.herokuapp.com/'+count;
> HttpRequest req = new HttpRequest ( );
req.setMethod ('GET'); req.setEndpoint ( url );
// Cria uma continuação para o HTTPRequest
Continuação con = new Continuação(60 );
//
// Por favor, configure o método de retorno de chamada aqui
// (1) Inclua este método de retorno de chamada no invokeMethod acima , consulte
// else if( methodName.equals ('Continuation2'))
// (2) methodName é sensível a maiúsculas e minúsculas
con.continuationMethod = 'Continuation2'; // O seguinte
método DEVE SER CHAMADO // params:
// (1) primeiro parâmetro = Objeto de Continuação
// (2) segundo parâmetro = O QUE VOCÊ QUER DEFINIR O parâmetro de estado de
o objeto CONTINUAION
// https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/
apexcode /apex_continuation_process.htm //
(3) terceiro parâmetro = opções // o que faz:
// reestrutura a propriedade de estado do Objeto de Continuação a ser passado
para o próximo retorno de chamada
company
// con.state é um Map, que contém:
// (a) vlcContinuationCallbackState - o estado que você deseja definir, neste
exemplo, con.addHttpRequest (req)
// (b) vlcContinuationCallbackLabels - rótulos, consulte
// https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/
apexcode /apex_continuation_process.htm
// Devolve ao sistema para processamento
retorno contra;
}
// retorno de chamada para a primeira Continuação
// Retorna o objeto de continuação
// Isso é para mostrar como serializar várias chamadas remotas de longa duração private Object
Continuation2(Integer count, Map<String, Object> options)
{
// EXEMPLO
HttpRequest req = new HttpRequest ( );
Continuação con = new Continuação(60 );
// (1) Este método de retorno de chamada deve ser incluído no invokeMethod acima ,
consulte acima
// else if( methodName.equals (' customcallback ')) con.continuationMethod = ' customcallback ';
// A seguinte linha deve ser chamada
retorno contra;
}
// Último método de retorno de chamada
// Isso NÃO retorna o Objeto de Continuação
// Isso retornará a resposta de volta ao OmniScript , portanto, é necessário definir
outMapa
private Object customcallback (Map<String, Object> inputMap , Map<String,
objeto> outMap , Map<String, Object>)
{
// É assim que você acessa o estado e os rótulos passados pela Continuação
Objeto
// EXEMPLO
Resposta HttpResponse = Continuation.getResponse ((String)state );
Número inteiro statusCode = response.getStatusCode ( );
if ( statusCode >= 2000) { //
System.log ...
}
// Isso volta para OmniScript
outMap.put (' continuousResp ', response.getBody () );
company
retornar nulo;
}
}
Faça uma chamada remota de longa duração usando OmniStudio.OmniContinuation

Para oferecer suporte a chamadas remotas de longa duração, o Vlocity oferece suporte ao uso do objeto
Salesforce Continuation. Chamar o método construtor OmniStudio.OmniContinuation retorna um objeto
OmniContinuation , que estende o objeto Continuation. Se a classe que chama esse método construtor
implementar a interface Callable , você poderá chamar a classe usando as propriedades Remote Class e
Remote Method de um OmniScript ou Integration Procedure.
Para obter detalhes sobre o objeto SFDC Continuation e a interface Callable , consulte a seguinte
documentação do Salesforce:
• Processo para uso Assíncrono Frases de destaque

• Continuações do Apex: chamadas assíncronas de páginas do Visualforce
• Interface que pode ser chamada
Para fazer uma chamada remota usando o objeto OmniContinuation e implementando a interface Callable :
1. Crie uma classe do Apex que implemente a interface Callable .

2. Implemente o método de retorno de chamada no invokeMethod . Veja o objeto privado invokeMethod
código no exemplo.
3. Para o método que retorna o objeto OmniContinuation , chame o OmniStudio.OmniContinuation
construtor.
OmniStudio.OmniContinuation con = new OmniStudio.OmniContinuation (120);

con.ContinuationMethod = ' customCallback ';
4. Para o último método de retorno de chamada na cadeia que retorna a resposta para OmniScript , use o
código a seguir para obter o estado do objeto OmniContinuation e os rótulos do sistema.

5. Use o método OmniStudio.OmniContinuation.getResponse para recuperar a resposta. Exemplo 16.
Exemplo de classe OmniContinuationTest.cls

global com a classe de compartilhamento RemoteActionCallableOmniContinuation implementa
Chamado
{
// Despacha métodos reais
public Object call(String action, Map<String, Object> args ) {
Map<String, Object> input = (Map<String, Object>) args.get ('input' );

Map<String, Object> output = (Map<String, Object>) args.get ('output' );
Map<String, Object> options = (Map<String, Object>) args.get ('options' );
return invokeMethod (ação, entrada, saída, opções); }
private Object invokeMethod (String methodName , Map<String, Object> inputMap , Map<String, Object>
outMap , Map<String, Object> options)
{
company
tentar {
// os métodos personalizados podem ter qualquer assinatura personalizada, mas
// POR FAVOR, FAÇA QUE VOCÊ SEMPRE PASSA OPÇÕES if( methodName.equals (' populateElements '))
{
// isso retorna o Objeto de Continuação
return populateElements (5, inputMap , outMap , opções );
}
else if( methodName.equals ('continuation2'))
{
return continuation2(8, inputMap , opções );
}
else if( methodName.equals (' customCallback '))
{
customCallback ( inputMap , outMap , opções );
} senão
{
resultado = falso;
}
}
catch( System.Exception e)
{
resultado = falso; }
// outMap.put ('nada', methodName );
retorno resultado;
}
// Você também pode ter outros parâmetros, mas certifique-se de sempre passar
Opções de Map<String, Object>
private Object populateElements (Contagem de inteiros, opções Map<String, Object> inputMap ,
Map<String, Object> outMap , Map<String, Object>)
{
// ESTE É UM EXEMPLO PARA CHAMAR O SERVIÇO DE NÓ HEROKU
//

OmniStudio.OmniContinuation con = new OmniStudio.OmniContinuation (60 );
con.ContinuationMethod = 'continuação2 ';
//cria o estado
Map<string, Object> stateAsMap = new Map<String, Object>( );
String label = con.addHttpRequest (req); stateAsMap.put ('label', label );

company
// Armazena o estado con.state =
stateAsMap ;
options.put (' continuationState ', label );

options.put (' continuationCallback ', 'continuation2' );

retorno contra;
}
// retorno de chamada para a primeira Continuação

// isso retorna novamente o Objeto de Continuação
// Isso é para mostrar como serializar várias chamadas remotas de longa duração private Object
continuation2(Integer count, Map<String, Object> inputMap ,
Opções de Map<String, Object>)
{
// Cria um OmniContinuationTest para o HTTPRequest

OmniStudio.OmniContinuation con = new OmniStudio.OmniContinuation (120 );
con.ContinuationMethod = ' customCallback ';
//cria o estado
Map<string, Object> stateAsMap = new Map<String, Object>( );
String label = con.addHttpRequest (req); stateAsMap.put ('rótulo', rótulo); stateAsMap.put ('
populateElements -label', inputMap.get (' vlcContinuationCallbackState ') );
// Salva o estado con.state = stateAsMap ;
options.put (' continuationState ', label );

options.put (' continuationCallback ', ' customCallback ' );

retorno contra;
}
// Último método de retorno de chamada

// Isso NÃO retorna o Objeto de Continuação
// Isso retornará a resposta de volta ao OmniScript , portanto, é necessário definir
outMapa
private Object customCallback (Map<String, Object> inputMap , Map<String,
objeto> outMap , Map<String, Object>)
{
// É assim que você acessa o estado e os rótulos passados pelo
Objeto de continuação

company
Map<String, Object> stateAsMap = (Map<String, Object>) state;
// EXEMPLO
Resposta HttpResponse =
OmniStudio.OmniContinuation.getResponse((String)stateAsMap.get('label') );
Número inteiro statusCode = response.getStatusCode ( );
if ( statusCode >= 2000) { //

System.log ...
}
// Isso volta para OmniScript

outMap.put (' responseFromCallableOmniContinuation ', 'Resposta usando
OmniContinuationWrapperPtc (Usando Callable): ' + response.getBody () );
retornar nulo;
}
}

IMPORTANTE
Compartilhamento concedem acesso. Sem adicional configuração é necessário para isso expandido
acesso .
Você pode permitir o acesso a um DataRaptor ou Procedimento de Integração com base nas Permissões
Personalizadas habilitadas nos Perfis do Salesforce de um usuário ou conjuntos de permissões . Uma classe do
Configurações de Compartilhamento, Conjuntos de Compartilhamento, Perfis e Conjuntos de

Permissões controlam o acesso a DataRaptors e Procedimentos de Integração como registros de

company
objetos. Para reforçar a segurança em nível de campo nos dados que DataRaptors acessam, vá para a guia
Opções do DataRaptor e selecione Check Field Level Security .
IMPORTANTE

Configuração.
de integração .


dados Valor





company



3. Clique em Novo .

{
{
{
}
company
retorna falso; }
Calculation Procedures and Matrices

{
{
{
parar;
}
}
}
}
Um procedimento de cálculo é uma série de cálculos realizados em pesquisas de matriz e variáveis e
constantes definidas pelo usuário. Uma matriz de cálculo é uma tabela que pesquisa informações usando
várias dimensões de entrada e retorna o valor de saída correspondente.
Figura 13. Procedimentos de Cálculo e Matrizes
Procedimentos de cálculo e matrizes podem automatizar a criação de cotações complexas. Juntos, eles podem
orientar um cliente ou agente por meio de uma série de perguntas, extrair dados de várias fontes e apresentar
uma ou mais cotações personalizadas ou determinações de elegibilidade. Esses posso ser citações ou
elegibilidade determinações para:
company
• Um plano de saúde individual através de um site para um cliente
• Uma cotação de vida do termo por meio de um agente
• Um desconto por volume em um pedido
• Uma permissão ou inscrição taxa
• Uma pessoa que solicita benefícios ou serviços
Os procedimentos e matrizes de cálculo aceitam entrada de um formulário do Salesforce, API REST e

OmniScript (no JSON de dados). As entradas podem vir de mais de uma fonte. A saída pode ser uma proposta
ou PDF, ou dados para preencher um OmniScript , formulário, lista, estrutura JSON ou solicitação de API REST.
Exemplo de cálculo para cotação de seguro de vida

Para fornecer uma cotação precisa, um agente deve saber a idade de uma pessoa, CEP de casa e se ela fuma.
Primeiro, um formulário solicita os dados necessários, de um agente ou autoatendimento da web. Quando o
formulário é enviado, um procedimento de cálculo definido para esse formulário é executado. A primeira
etapa do procedimento é uma Pesquisa de Matriz, que examina os campos de entrada da matriz — Fumante,
CEP e Idade — para encontrar a saída correspondente (Taxa).
Após a primeira etapa do procedimento, a segunda etapa do procedimento é executada. Esta etapa pega a
Taxa que é a saída da primeira etapa do procedimento, a divide por uma constante e gera a Taxa Mensal. As
etapas subsequentes podem realizar cálculos adicionais nos dados enviados — Fumante, CEP, Idade — ou usar
entradas de outras fontes de dados, como políticas atualmente mantidas ou status de integridade atual, para
realizar cálculos adicionais e retornar uma variedade de cotações.

company
Matrizes de Cálculo
As matrizes de cálculo são um dos elementos-chave de um mecanismo de classificação Vlocity . O Vlocity usa
matrizes de cálculo para pesquisar entradas, combiná-las com saídas e fornecer as saídas para procedimentos
de cálculo.
O Vlocity oferece três estilos de matrizes de cálculo que você pode usar com base nas suas necessidades de
negócios:
• Matrizes de cálculo padrão — Possui características comuns a todas as matrizes de cálculo, incluindo
colunas de entrada, colunas de saída e versões.
• Matrizes de cálculo agrupadas — Permite o agrupamento de linhas da matriz por uma chave, como região
geográfica ou idade.
• Matrizes de cálculo com versão de linha — Permite que as versões se apliquem a linhas específicas em vez
de à matriz inteira.

company
IMPORTANTE
Você não pode criar matrizes de cálculo agrupadas e com versão de linha.
É mais importante do que nunca que você planeje sua estrutura de matriz de cálculo antes de
começar a criar suas matrizes em Vlocity . Depois de escolher o tipo de matriz de cálculo, você não
poderá alterá-lo .
CUIDADO
Você pode permitir que as pessoas modifiquem as matrizes de cálculo com base nos perfis de
usuário. Em sua sandbox Vlocity e organizações de desenvolvimento, pode ser útil permitir que
vários grupos de perfis de usuário modifiquem as matrizes de cálculo.
Mas modificar as matrizes de cálculo em um ambiente de produção pode ter consequências graves
nas taxas que você obtém para produtos de seguro. Recomendamos que você limite o número de
pessoas que podem modificar as matrizes de cálculo de produção apenas para administradores
essenciais.
Matrizes de cálculo padrão

Todas as matrizes de cálculo têm as características das matrizes de cálculo padrão. Outros tipos possuem
características que as matrizes de cálculo padrão não possuem. Todas as matrizes de cálculo têm colunas de
entrada, colunas de saída e versões.
Uma matriz de cálculo é uma tabela de classificação de Vlocity que é estruturada e armazenada da seguinte
forma:
• Uma coluna de entrada ou um conjunto de colunas de entrada

• Os nomes dos cabeçalhos das colunas de entrada devem corresponder às entradas, como atributos e
opções remotas
• Cada entrada ou conjunto de entradas deve ser único
• Vlocity armazena todos os nomes de cabeçalho de coluna de entrada e todos os dados de entrada em um
JSON
• Uma coluna de saída ou um conjunto de colunas de saída
• Saídas e conjuntos de saídas não precisam ser únicos
• Vlocity armazena todos os nomes de cabeçalho de coluna de saída e todos os dados de saída em um JSON

company
Você pode ter várias versões da mesma matriz de cálculo habilitadas ao mesmo tempo. Vlocity usa a data/hora
de início, data/hora de término e prioridade (o número mais alto é a prioridade mais alta, portanto 2 é a
prioridade mais alta que 1) para determinar qual versão da matriz usar.
Se a data/hora inicial de uma versão de uma matriz de cálculo se sobrepuser à data/hora final de outra matriz
de cálculo, você pode definir prioridades nelas para permitir que o Vlocity determine qual usar. Se uma
chamada para uma matriz de cálculo especificar uma data efetiva, o Vlocity usará essa data para localizar a
matriz correta. Se uma data não for especificada, o Vlocity usará hoje como a data efetiva.
A chamada para a matriz de cálculo encontra o hash correto, corresponde à entrada, de scompacta o JSON de
saída, encontra a saída correta e a retorna.
Matrizes de cálculo agrupadas

Você pode criar grupos de matrizes de cálculo e subgrupos dentro de cada grupo.
Matrizes de cálculo agrupadas têm vários benefícios:
• Matrizes de cálculo agrupadas são projetadas para funcionar melhor para seguradoras que possuem muitas
matrizes que são quase exatamente iguais: mesmos cabeçalhos de entrada e mesmos cabeçalhos de saída.
• Matrizes de cálculo agrupadas melhoram o gerenciamento e reduzem os requisitos de tamanho.
• Vlocity usa apenas uma consulta SOQL para consultar um grupo de versões de matriz.
• Os membros da equipe da seguradora que mantêm os dados da matriz de cálculo atualizados podem criar e
habilitar novas versões de uma matriz sem tocar em nenhuma outra versão.
No entanto, as matrizes agrupadas têm algumas limitações. Cada matriz em um grupo deve ter os mesmos
cabeçalhos de coluna de entrada e saída.

company
Exemplo 17. Caso de Uso de Amostra de Propriedade e Acidentes
Uma operadora de seguros de automóveis tem taxas de seguro diferentes para diferentes jurisdições (como
estados). A transportadora precisa gerenciar cada jurisdição separadamente, mas não quer ter que criar um
cálculo separado para cada jurisdição (porque todos os cálculos são iguais).
Portanto , essa operadora cria uma matriz de cálculo diferente para cada estado em que oferece seguro,
usando Jurisdição como a chave do grupo.
Todos os cabeçalhos de entrada e saída são iguais, apenas os valores diferem. A matriz de cálculo de cada
estado pode ser atualizada em um momento diferente, e novas versões podem ser ativadas em momentos
diferentes.
Exemplo 18. Caso de uso de amostra de integridade do grupo

Cada provedor na rede de uma operadora de seguro de saúde tem uma tabela de taxas diferente, e essas
tabelas de taxas devem ser atualizadas ao longo do ano à medida que as operadoras alteram ou renovam seus
contratos com a operadora.
A chave do grupo para essa matriz de cálculo é ProviderFeeSchedule e cada versão da matriz de cálculo é para
um provedor específico.
Em tempo de execução, Vlocity usa a chave de grupo para encontrar a matriz de cálculo agrupada correta e o
código do provedor para escolher a versão correta da matriz.
Matrizes de cálculo com versão de linha

Se você estiver lidando com grandes matrizes de cálculo que não podem ser seccionadas claramente em
grupos e subgrupos, você pode criar matrizes de cálculo que são versionadas por linha.
Por exemplo, você tem uma matriz que cria um fator de classificação por CEP (postal), que inclui todos os CEPs
dos Estados Unidos. Você deseja atualizar os CEPs individualmente ou em pequenos grupos. Essa situação
exige uma matriz de cálculo com versão de linha.
Cada linha desse tipo de matriz de cálculo recebe uma data de início quando a matriz é criada.
No tempo de execução, as matrizes padrão e agrupadas extraem matrizes por versão, data de início, data de
término e prioridade no nível da matriz de cálculo. Em uma matriz com versão de linha, tudo isso sai pela
janela.
No tempo de execução, o Vlocity verifica a data de início e a data de término de cada linha na matriz de cálculo
com versão de linha. Se as datas se sobrepuserem em duas versões de uma linha, o cálculo usará a versão com
a prioridade mais alta especificada.
Mas o Vlocity ainda usa as versões para gerenciar as linhas em uma matriz de cálculo com versão de linha.
Ao atualizar matrizes de cálculo com versão de linha, você pode incluir alterações apenas nas linhas que
precisa atualizar. Vlocity carrega apenas as linhas alteradas e compartilha as linhas inalteradas com ambas as
versões da matriz.
O que o Vlocity faz quando você atualiza as linhas é um pouco complicado. Aqui está como funciona.
Primeira versão

company
A primeira versão de uma matriz de cálculo com versão de linha parece quase igual a uma matriz de cálculo
padrão. Mas alguns dados são armazenados de forma ligeiramente diferente pelo Vlocity . A Data/Hora de
início inserida é atribuída a cada linha da matriz individualmente.
Segunda Versão
Sua segunda versão do arquivo CSV pode ser a matriz inteira que inclui linhas novas e alteradas. Ou seu CSV
pode conter apenas as linhas novas e alteradas.
Quando você carrega a segunda versão, você dá à nova versão da matriz uma data/hora de início diferente.
Vlocity fornece a todas as linhas novas e alteradas nesta versão a nova Data/Hora de início.
Vlocity não copia as linhas inalteradas para a nova versão da matriz de cálculo. Em vez disso, ele compartilha
as linhas da versão 1 da matriz com a versão 2. Dessa forma, as linhas inalteradas são armazenadas apenas
uma vez, o que economiza espaço de armazenamento.
NOTA
Vlocity compartilha linhas somente quando ambas as versões estão habilitadas.
Por exemplo, se a versão 1 de uma matriz de cálculo não estiver habilitada, sua linha não será
compartilhada com a versão 2.
Você ainda vê todas as linhas, tanto as linhas compartilhadas da versão 1 quanto as linhas novas e alteradas da
versão 2 ao visualizar a versão 2.
Você também pode criar uma segunda versão da matriz de cálculo e alterar manualmente as linhas em vez de
carregá-las em um CSV. Isso funciona melhor se houver apenas algumas alterações necessárias.
Terceira versão e além

Você carrega a versão 3 da mesma forma que fez a versão 2 e fornece uma data/hora de início diferente da
versão 1 ou 2. Vlocity fornece a todas as linhas novas e alteradas esta data/hora de início.
Vlocity não copia as linhas inalteradas das versões anteriores. Em vez disso, ele compartilha linhas de todas as
versões anteriores com a nova versão. Portanto , se você carregou a versão 3, verá linhas inalteradas
armazenadas na versão 1, linhas alteradas na versão 2, mas não na versão 3 armazenadas na versão 2, e linhas
novas e alteradas armazenadas apenas na versão 3.
Linhas excluídas
Em um cenário em que você tem três versões de uma matriz de cálculo com versão de linha, veja o que
acontece quando você exclui linhas diferentes de versões diferentes:
• Ação: Na versão 3, exclua uma linha que você atualizou na versão 3 que existia pela primeira vez na versão
2.
Resultado: Vlocity compartilha a linha da versão 2 na versão 3 da matriz. A versão 3 linha é excluído .
• Ação: Na versão 3, exclua uma linha que existe inalterada desde a versão 1.
Resultado: a linha desaparece da versão 3 da matriz. A linha permanece inalterada na versão 1 e na versão
2.
Maneiras de criar uma matriz de cálculo padrão

Uma matriz de cálculo padrão não faz parte de um grupo e não tem controle de versão de linha. Você
pode criar uma matriz de cálculo padrão de três maneiras diferentes.

company
• Carregar um arquivo CSV
Para economizar tempo e reduzir erros ao configurar matrizes complexas com muitos dados, crie um
arquivo CSV contendo os dados e carregue-o na matriz.
• Crie manualmente a matriz no Vlocity
Para uma matriz simples com uma pequena quantidade de dados, insira os dados manualmente.
• Crie uma nova versão de uma matriz existente (recomendado quando possível)
Crie uma nova versão de uma matriz existente e altere seus dados manualmente ou fazendo upload de um
arquivo CSV contendo dados revisados.
CUIDADO
Depois de escolher Padrão como o tipo de registro de uma matriz de cálculo, você não poderá
alterá-lo. Escolher sabiamente .
Preparar um arquivo CSV para carregar em uma matriz de cálculo

Você deve executar etapas específicas para configurar arquivos CSV para upload para preencher uma matriz
de cálculo.
IMPORTANTE
A partir da versão CME Summer '18, os seguintes limites são suportados:
• Linhas de entrada e saída: 12.752 caracteres no total (máximo)

• Colunas: Aproximadamente 500 (máximo) dependendo da quantidade de dados nas colunas.
• Linhas exibido : 2000 ( máximo )
Antes de iniciar o upload, siga as diretrizes abaixo para garantir que seu arquivo CSV esteja formatado para uso
como matriz de cálculo.
1. Adicione um nome de cabeçalho a cada coluna.

Faça seus cabeçalhos curtos e fáceis de ler e entender. Os cabeçalhos de coluna são importados com os
dados CSV, o que significa que você não precisa renomeá-los todos no Vlocity se estiverem bem
nomeados no arquivo CSV.
• Para colunas de entrada, dê a cada coluna um nome que você usará como variável de entrada.
Isso possibilita que Vlocity passe corretamente variáveis de entrada quando uma pesquisa de matriz
chama uma matriz de cálculo.
• Sempre que possível, crie nomes de coluna consistentes para colunas de entrada.
Isso possibilita que um JSON de entrada forneça uma variável de entrada que pode ser usada por várias
pesquisas de matriz em um procedimento de cálculo.
Por exemplo, para dois arquivos CSV que você planeja usar como matrizes em um único procedimento
de cálculo, nomeie a coluna de entrada para limite de responsabilidade responsabilidadeLimite em
ambos os arquivos CSV.
• Para colunas de saída, insira nomes de coluna exclusivos que você usará como variáveis de saída em
procedimentos de cálculo .

company
GORJETA
Quando é hora de atualizar uma matriz de cálculo com novos dados - como sempre que um
governo faz uma alteração em seus regulamentos de seguro - você pode fazer isso com um
arquivo CSV. O Vlocity é inteligente o suficiente para verificar seu arquivo CSV em busca de
novas linhas e dados alterados na linha existente. Somente as linhas novas e alteradas são
carregadas, o que reduz muito o tempo de carregamento, especialmente para matrizes
enormes.
Você deve certificar-se de que todos os nomes de cabeçalho de coluna correspondem

exatamente aos da matriz de cálculo atual.
2. Crio linhas .
Cada linha deve incluir uma combinação exclusiva de valores de entrada.
Várias linhas podem conter o mesmo valor de saída ou combinação de valores para diferentes valores de
entrada.
Quando você cria intervalos, cada conjunto de valores deve ter os mesmos valores de intervalo. Por
exemplo , se a Segue condições são verdadeiras :
• Os intervalos são 1, 20 e 300 para a entrada 1.
• Os intervalos são a, b e c para entrada 2. Veja como a tabela é formatada:
entrada1 entrada2 saída1
1 uma 0,1
1 b 0,2
1 c 0,3
20 uma 0,4
20 b 0,5
entrada1 entrada2 saída1
20 c 0,6
300 uma 0,7
300 b 0,8
300 c 0,9
Aqui está um exemplo mais realista mostrando um arquivo CSV que se tornará uma matriz de cálculo
para valores de carros, a ser usada para avaliar apólices de automóveis:

company
Carregar um arquivo CSV para criar uma matriz de cálculo
Você pode carregar um arquivo CSV para criar uma nova matriz de cálculo. Você também pode carregar um
arquivo CSV para uma matriz de cálculo existente, como uma nova versão de uma matriz existente, para
atualizar e adicionar aos cabeçalhos e dados.
Para obter detalhes, consulte Preparar um arquivo CSV para carregar em uma matriz de cálculo .
Para criar uma matriz de cálculo carregando um arquivo CSV:

1. Na página Matrizes de cálculo de Vlocity , clique em New .
2. Na janela Novas matrizes de cálculo de velocidade, escolha Padrão.
3. Insira um Nome da Matriz de Cálculo .
Escolha um nome simples para sua matriz de cálculo. Vlocity adiciona o nome da matriz de cálculo aos
nomes do cabeçalho da coluna e usa a combinação nos procedimentos de cálculo. Deixe o restante dos
campos nesta janela em branco.
4. (Opcional) Se você planeja usar uma coluna curinga, insira o seguinte:
• Coluna curinga : o nome da coluna que pode ter um curinga inserido como um valor de usuário.
• Valor curinga : o valor que um usuário pode inserir que é o curinga.
Certifique-se de adicionar o valor curinga à sua coluna no arquivo CSV.
6. Para abrir a página de detalhes, clique na versão que você acabou de criar.

company
GORJETA
Se estiver importando um arquivo CSV para uma matriz de cálculo existente, certifique-se
de que os nomes de cabeçalho de coluna no arquivo CSV correspondam exatamente aos
nomes de cabeçalho de coluna na matriz de cálculo. Os nomes de cabeçalho de coluna CSV
que não correspondem a nenhuma coluna existente são adicionados à matriz de cálculo
como novas colunas.
7. Na seção Tabela, clique em Carregar CSV .

8. Quando a janela Carregar CSV for aberta, clique em Escolher arquivo .
9. Selecione o arquivo, clique em Abrir e clique em Carregar .
10. Defina o tipo de cabeçalho de cada coluna. O Tipo de Cabeçalho define o mapeamento da coluna.
• Entrada : A coluna obtém dados para o cálculo.
• Saída : A coluna retorna os dados do cálculo.
NOTA
Você deve mapear todos os Tipos de Cabeçalho: defina cada Tipo de Cabeçalho como Entrada
ou Saída .
11. Selecione um Tipo de Dados para cada coluna desta lista:

• Texto
• Número
• Moeda
• Por cento
• boleano
• Intervalo de números
• Faixa de texto
O Tipo de Dados é padronizado como Texto para todas as colunas recém-carregadas .
12. Clique em Salvar dados .
13. Para ver as linhas de dados, clique em Editar dados .
14. Revise sua tabela no Vlocity para ter certeza de que está tudo correto. Para saber como editar cabeçalhos
e dados, consulte Revisar e editar uma matriz de cálculo .
Para ver as colunas com erros, clique em Mostrar apenas erros . (O botão alterna para Mostrar todas as
linhas depois de clicar nele.)
16. Se sua organização tiver um processo de aprovação configurado para matrizes de cálculo, clique em
Enviar para aprovação .
17. Depois que a matriz de cálculo for aprovada ou se sua organização não aprovar e você estiver pronto para
usar essa matriz de cálculo, habilite a matriz de cálculo.
Clique no ícone de lápis à direita da caixa de seleção Ativado .
Selecionar Ativado .
IMPORTANTE
Você não pode desabilitar uma matriz de cálculo habilitada e não pode editar cabeçalhos ou
dados em um cálculo habilitado. Tenha certeza antes da você clica em Habilitado .
Criar uma matriz de cálculo manualmente

Se uma matriz de cálculo tiver apenas algumas linhas de dados, pode ser mais fácil criá-la
manualmente.
company
1. Na página de lista Matrizes de cálculo de velocidade, clique em Novo .
2. Na janela Novas matrizes de cálculo de velocidade, escolha Padrão.
3. Na caixa Nome da Matriz de Cálculo , insira o nome da matriz de cálculo.
Escolha um nome simples para sua matriz de cálculo. Vlocity adiciona o nome da matriz de cálculo aos
nomes do cabeçalho da coluna e usa a combinação nos procedimentos de cálculo. Deixe o restante dos
campos nesta janela em branco.
6. Clique na versão da matriz que você acabou de criar.
7. Na seção Tabela, clique em Adicionar Cabeçalho .
8. Digitar a Segue informações :
• Nome é o nome do cabeçalho da coluna.
• Tipo de cabeçalho define o mapeamento de coluna. Selecione Entrada se a coluna obtiver dados
para o cálculo. Selecione Saída se a coluna retornar dados do cálculo.
• Tipo de dados especifica o tipo de dados armazenados na coluna:
• Texto
• Número
• Moeda
• Por cento
• boleano
• Faixa de texto
IMPORTANTE
Não altere o tipo de dados de um cabeçalho existente, a menos que você não tenha outra
opção. Quando você altera o Data Type , os dados na coluna podem ser corrompidos,
exigindo que você reinsira todos os dados.
• Matrix Display Order define o número da coluna (sequência).

9. Repita as etapas 5 e 6 para definir o restante dos cabeçalhos das colunas.
11. Clique em Editar dados para inserir valores nas colunas.
12. Insira um valor em cada campo de dados em cada coluna.
NOTA
Você deve inserir dados em todos os campos de dados. Você não pode habilitar uma matriz de
cálculo que contém campos de dados vazios.
13. Quando terminar de editar, clique em Salvar dados .

15. Depois que a matriz de cálculo for aprovada ou se sua organização não aprovar e você estiver
pronto para usar essa matriz de cálculo, habilite a matriz de cálculo.
company
Clique no ícone de lápis à direita da caixa de seleção Ativado .
IMPORTANTE
Você não pode desabilitar uma matriz de cálculo habilitada e não pode editar cabeçalhos ou
dados em um cálculo habilitado. Tenha certeza antes da você clica em Habilitado .
Criar uma nova versão de uma matriz de cálculo existente

É muito mais rápido clonar uma versão existente de uma matriz de cálculo do que criar uma nova matriz do
zero. A clonagem copia tudo a cabeçalhos e dados.
1. Na página da lista Matriz de Cálculo, clique no nome da matriz. Em seguida, clique na versão da matriz
que deseja clonar.
2. Clique na seta para baixo no canto superior direito da página de detalhes da matriz de cálculo e escolha
Criar nova versão .
Vlocity abre a nova versão da matriz de cálculo. Inclui o seguinte :
• Um nome exclusivo composto por matrixName vX onde X é o número da nova versão
• Uma nova versão número
• A mesma data de início da versão anterior
• A mesma data de término (ou falta de data de término) da versão anterior
• Todos os mesmos dados da versão anterior
NOTA
Se você criar uma nova versão da matriz com mais de 1.500 linhas, apenas os cabeçalhos
das linhas serão copiados para a nova versão. Você deve reenviar os dados para a nova
versão.
Se houver menos de 1.500 linhas, todos os dados serão copiados para a nova versão.
A nova versão não inclui um número de prioridade e não está habilitada.

3. Para atualizar os cabeçalhos e dados na matriz, faça upload de um arquivo CSV ou revise e edite a matriz
de cálculo .
4. Defina a nova data/hora de início e data/hora de término para a nova matriz.
a. Ao inserir uma data/hora de início para a nova versão da matriz, defina-a para a data/hora de
término da versão anterior.
Ou
Defina uma data/hora de início antes da data/hora de término da versão anterior e defina números
de prioridade para ambas as matrizes para que a Vlocity possa escolher a matriz correta quando for
chamada.
b. Habilite a nova matriz quando estiver pronta, mesmo se a Data/Hora de início estiver no futuro.
Vlocity não usará a nova matriz habilitada até que a data/hora de início seja alcançada.
5. Insira uma prioridade número .
Quando o Vlocity encontra mais de uma matriz de cálculo habilitada que corresponde à chamada que
está sendo tratada, ele escolhe a matriz de cálculo com a prioridade mais alta. Por exemplo, se duas
matrizes de cálculo habilitadas tiverem Prioridade definida como 1 e 2, Vlocity usará a matriz de cálculo
definida como Prioridade 2.

company
7. Depois que a matriz de cálculo for aprovada ou se sua organização não aprovar e você estiver pronto para
usar essa matriz de cálculo, habilite a matriz de cálculo.
Clique no ícone de lápis à direita da caixa de seleção Ativado.
NOTA
Você não pode desabilitar diretamente uma matriz de cálculo habilitada e não pode editar
cabeçalhos ou dados em um cálculo habilitado. Certifique-se antes de clicar em Ativado !
Se você precisar modificar ou substituir uma matriz de cálculo habilitada, poderá criar e habilitar
uma nova versão da matriz de cálculo e atribuir a ela um número de prioridade mais alto do que
a matriz antiga.
Fluxo de trabalho para criar uma matriz de cálculo agrupada

Você pode criar uma matriz de cálculo que faça parte de um grupo de matrizes. Você cria matrizes de cálculo
agrupadas para que um procedimento de cálculo (ou outro processo de chamada) possa pesquisar todas as
matrizes usando apenas uma consulta SOQL. Isso acelera o processamento de Vlocity e libera consultas SOQL
para outros fins.
As versões em uma matriz agrupada podem ter datas de vigência diferentes.
Para criar uma matriz de cálculo agrupada:
1. Certifique-se de que seus grupos de matrizes podem seguir todas estas regras:
• Cabeçalhos de coluna de entrada e saída idênticos
• Conter pelo menos uma e no máximo duas dimensões de entrada comuns
• Os intervalos de variáveis de entrada devem ser todos iguais
• A Chave de Grupo e a Chave de Subgrupo não podem ser entradas de intervalo
O valor do grupo e o valor do subgrupo geralmente são entradas de texto, como um código de
jurisdição ou um código de produto.
2. Crie uma Matriz de Cálculo Agrupada .
3. Preencha o resto das matrizes no grupo .
Criar uma matriz de cálculo agrupada

Matrizes de cálculo agrupadas criadas podem ser um pouco complicadas. Aguenta aí ! _

2. Na janela Novas matrizes de cálculo de velocidade, escolha Grupo.
5. Insira uma chave de grupo. (Requeridos)
Você só fará isso uma vez por grupo.
6. Insira uma chave de subgrupo . (Opcional) Você fará isso apenas uma vez por subgrupo.
8. Clique no nome da versão da matriz que você acabou de criar.

company
9. Insira um grupo Valor .
10. Se você estiver usando subgrupos, insira um valor de subgrupo .
11. (Opcional) Você pode adicionar e alterar o seguinte:
• Nome
Você pode alterar o nome desta versão da matriz para algo mais descritivo.
• Prioridade
• Versão Número
• Data/hora de início
• Data/hora de término
Depois de fazer as alterações, clique em Salvar.
12. Ainda na página da versão da matriz, clique em Upload CVS. Consulte Carregar um arquivo CSV para criar
uma matriz de cálculo .
Se você estiver criando esse grupo de matrizes manualmente no Vlocity , clique em Adicionar cabeçalhos.
Preencha o resto das matrizes no grupo

Depois de criar a primeira matriz em um grupo, você pode criar quantos outros membros do grupo precisar.
GORJETA
Chamamos os membros do grupo de matrizes de Versões.
Para adicionar uma nova matriz de membro (versão):
1. Na página do grupo Matriz de Cálculo, clique na guia Relacionado .

2. Ao lado de Versões da Matriz de Cálculo de Vlocity , clique em Novo.
3. Insira um Nome para esta matriz.
5. Altere o Número de Versão para um número diferente de todos os outros Números de Versão das
matrizes existentes neste grupo.
6. Adicione qualquer uma das seguintes informações opcionais:
• Data / Hora de Início
O padrão é a data e hora em que você cria esta matriz de membros.
• Data/hora de término
O padrão é nenhum valor .
• Valor da chave do grupo
Insira um valor para a Chave de Grupo que você inseriu quando criou este grupo.
• Valor da chave do subgrupo
Insira um valor para a Chave de Subgrupo se estiver usando Subgrupos.
• Prioridade
Este é importante se você planeja ter mais de uma versão de cada matriz de membro neste grupo. Por
exemplo, se você tiver duas matrizes de membros que tenham datas de início e datas de término

company
sobrepostas, defina uma prioridade para que Vlocity saiba qual matriz de membro usar quando
chamada.
Fluxo de trabalho para criar uma matriz de cálculo com versão de linha
A criação da primeira versão de uma matriz de cálculo com versão de linha segue a maioria das mesmas etapas
da criação de uma matriz de cálculo padrão. Então, conforme você precisa fazer alterações nessas matrizes,
você pode fazer upload de novas linhas individuais. Isso cria novas versões das linhas substituídas com novas
datas de início e de término.
Certifique-se de que seu arquivo CSV esteja configurado para dar suporte ao controle de versão em nível de
linha. Para saber como, consulte Preparar um arquivo CSV para carregar em uma matriz de cálculo .
IMPORTANTE
Você não pode adicionar controle de versão em nível de linha a uma matriz existente que não o
tenha, porque a sobreposição de datas efetivas causa erros.
Para criar e gerenciar uma matriz de cálculo com versão de linha:
1. Crie uma Matriz de Cálculo com Versão de Linha .

2. Carregar nova versão Linhas .
3. Excluir versão Linhas .
4. Excluir uma versão de matriz inteira .
Criar uma matriz de cálculo com versão de linha

A primeira etapa é criar a matriz com versão de linha e escolher como adicionar dados.

2. Na janela New Vlocity Calculation Matrices, escolha Row-Versioned.
4. (Opcional) Se você planeja usar uma coluna curinga (disponível nas versões Winter '20 e posteriores),
insira o seguinte:
7. Ainda na página da versão da matriz, escolha uma destas opções:
• Se você estiver carregando dados de um arquivo .csv, clique em Carregar CVS. Consulte Carregar um
arquivo CSV para criar uma matriz de cálculo .
• Se você estiver criando essa matriz manualmente, clique em Adicionar cabeçalhos.

company
IMPORTANTE
Depois de habilitar sua versão da matriz de cálculo, os cabeçalhos são bloqueados. Você não vai ser
capaz para mudança eles novamente .
Carregar nova versão Linhas

Você deve criar uma nova versão de uma matriz de cálculo com versão de linha antes de fazer upload de
novos dados de um arquivo .csv.
1. Verifique se o CSV está em boas condições. Mais importante ainda, certifique-se de que todos os
cabeçalhos de coluna no arquivo .csv sejam idênticos aos cabeçalhos da matriz de cálculo existente.
Consulte Preparar um arquivo CSV para carregar em uma matriz de cálculo .
2. Na matriz de cálculo que você está atualizando, clique na guia Relacionado .
3. Em Versões da Matriz de Cálculo de Vlocity , clique em Novo.
4. Digitar a Segue informações :
• Nome : Insira um nome para esta versão desta matriz de cálculo.
GORJETA
Escolha um nome que facilite a compreensão do conteúdo desta versão do
matriz de cálculo. Por exemplo, CalcMatrix_ChangedRows12-24 ou
CalcMatrix_ChangedRowsForWesternStates2020.
• Número da versão : Insira um número de versão exclusivo para esta versão da matriz de cálculo. Esse
número de versão não está relacionado às versões de linha, mas o Vlocity precisa dele como um
identificador exclusivo para cada versão de matriz carregada.
• Ativado : Marque esta caixa de seleção para ativar esta versão da matriz de cálculo.
• Data/Hora de início : Insira a data de início para as linhas novas e atualizadas.
IMPORTANTE
O campo Data é obrigatório para matrizes de cálculo com versão de linha.
• Data/hora de término : Insira a data de término para as linhas novas e atualizadas.
GORJETA
Se você precisar atualizar linhas com uma data de término que não seja hoje, não exclua
as linhas. Em vez disso, crie um arquivo .csv que inclua apenas as linhas para as quais você
deseja definir uma Data de término .
• Prioridade : Insira um número de prioridade exclusivo que os procedimentos de cálculo podem usar
para priorizar em qual ordem pesquisar matrizes de cálculo.

company
NOTA
Não insira nada nos campos Data/Hora de término, a menos que esteja atualizando as linhas
especificamente para fornecer uma data de término. Em matrizes de cálculo com versão de
linha, o Vlocity define as datas de término nos bastidores. Se você inserir datas de término
específicas, poderá obter resultados imprevisíveis.
7. Clique em Carregar CSV.
8. Escolha seu novo arquivo CSV e clique em Carregar.
9. Revise o matriz .
10. Clique em Salvar dados.
Excluir versão Linhas

Você pode excluir linhas individuais de uma matriz de cálculo com versão de linha.
GORJETA
Você não precisa excluir linhas de matrizes para fazer o versionamento de linhas do Vlocity
funcionar. Você pode deixar as linhas existentes no lugar. Quando a matriz é chamada, a linha
com a Data de início mais recente é usada.
Para excluir uma única linha de uma versão de uma matriz de cálculo:
1. Abra o Cálculo matriz .

2. Desmarque a caixa de seleção Ativado se esta matriz estiver ativada.
3. Na guia Relacionado , abra a versão da matriz de cálculo da qual deseja excluir uma linha.
4. No cabeçalho, clique no lápis ao lado de Ativar .
5. Desmarque Ativar e clique em Salvar.
6. Encontre a linha que você deseja excluir.
7. Clique no ícone da lixeira no lado direito da linha a ser excluída.
8. Na mensagem que aparece, clique em OK.
Excluir um Versão da matriz inteira

Você pode excluir todos os dados de uma versão específica de uma matriz de cálculo com versão de linha.
CUIDADO
Não exclua todos os dados de qualquer versão da matriz de cálculo, a menos que tenha certeza
absoluta de que precisa. Essa ação pode causar problemas com procedimentos de cálculo que
usam dados da matriz de cálculo.
1. Abra o Cálculo matriz .

2. Na guia Relacionado , abra a versão da matriz de cálculo que deseja excluir.
3. Clique em Excluir dados.

company
4. Na mensagem que aparece, clique em OK.
Curingas no cálculo Matrizes

A partir do Winter '20, você pode possibilitar que procedimentos de cálculo e outros recursos de Vlocity que
chamam matrizes de cálculo usem um curinga no lugar de um valor para uma coluna.
Por exemplo, você tem uma matriz de cálculo que contém classificações de seguro para trinta desses estados
nos Estados Unidos. Como você não tem classificações separadas para os outros vinte estados, mas deseja que
seu procedimento de cálculo encontre um valor para esses estados, você transforma a coluna Estado em uma
coluna habilitada para curingas.
Você configura sua coluna curinga quando cria sua matriz de cálculo pela primeira vez. Portanto , você precisa
saber o nome exato da coluna e o valor do curinga.
Para o exemplo State, o nome e o valor da coluna podem ser:
• Curinga Coluna : estado

• Curinga Valor : TODOS
As colunas curinga funcionam em matrizes de cálculo padrão, agrupadas e com versão de linha.
Pesquisar em uma matriz de cálculo

Você pode pesquisar valores específicos em uma matriz de cálculo que tenha muitas linhas.
1. Encontre a coluna ou colunas para as quais você deseja restringir os valores.

2. Digite o valor que você está procurando no campo ao lado da lupa.
NOTA
Não use curingas ao pesquisar em uma matriz. Usar exato valores .
3. Clique no botão Pesquisar acima das colunas.

Vlocity exibe as linhas da matriz contendo o valor especificado na coluna selecionada.
4. Se sua pesquisa não retornar resultados, observe o seguinte:
• Por padrão, o Vlocity retorna apenas os primeiros 2.000 resultados de sua pesquisa.
• Para pesquisas em várias colunas, o Vlocity pesquisa uma coluna por vez, em ordem.
Você pode inserir parâmetros de pesquisa em várias colunas e clicar em Pesquisar . Vlocity pesquisa a
primeira coluna e, em seguida, usa o segundo parâmetro para pesquisar os resultados da primeira
coluna.
5. Para melhorar a pesquisa resultados :
• Defina a configuração geral CalculationMatrixRowPrettify = true (se estiver definido como false).
a. Para definir essa configuração, vá para Configuração > Configurações personalizadas >
Configurações gerais > Gerenciar .
b. Adicione a configuração manualmente ou, se já existir, edite-a.
• Para matrizes de cálculo criadas antes da versão Summer '19, clique no botão Atualizar JSON antes de
pesquisar.
Baixar dados da matriz de cálculo para um arquivo CSV

Você pode baixar todos ou parte dos dados em uma matriz de cálculo.
company
Para baixar todos os dados, navegue até a versão da matriz de cálculo que você precisa baixar e clique em
Baixar CSV . O arquivo CSV contendo toda a matriz de cálculo é baixado em seu computador.
Para baixar parte de uma matriz:
1. Navegue até a versão da matriz de cálculo que você deseja baixar.

2. Encontre a coluna ou colunas para as quais você deseja restringir os valores.
3. Digite o valor que você está procurando no campo ao lado da lupa.
4. Clique no botão Pesquisar acima das colunas.
5. Clique em Baixar CSV .
O arquivo CSV que contém os resultados da pesquisa é baixado em seu computador.
Editar e excluir dados de matriz

Você pode editar e excluir os dados em uma matriz de cálculo se ainda não a ativou.
1. Clique em Editar dados .

2. Altere os dados em qualquer campo.
3. Para excluir uma linha inteira, clique no ícone da lixeira na extremidade direita da linha que deseja
excluir.
4. Para excluir todos os dados de uma matriz, mas deixar os cabeçalhos no lugar, clique em Excluir dados e
clique em OK para confirmar.
5. Para excluir todos os cabeçalhos e dados, clique em Excluir tudo e clique em OK para confirmar.
Editar cabeçalhos de matriz

Você pode alterar os nomes e os tipos de dados dos cabeçalhos das colunas em uma matriz de cálculo.
1. Clique em Editar Cabeçalhos .

2. Altere nomes e campos em qualquer cabeçalho.
• Nome é o nome do cabeçalho da coluna.
• Tipo de cabeçalho define o mapeamento de coluna. Selecione Entrada se a coluna obtiver dados
para o cálculo.
Selecione Saída se a coluna retornar dados do cálculo.
NOTA
Você não pode usar um atributo split-limit como uma saída em uma matriz de cálculo.
• Tipo de dados especifica o tipo de dados armazenados na coluna:

• Texto
• Número
• Moeda
• Por cento
• boleano
• Faixa de texto

company
IMPORTANTE
Não altere o tipo de dados de um cabeçalho existente, a menos que você não tenha outra
opção. Quando você altera o Data Type , os dados na coluna podem ser corrompidos.
Se os dados forem corrompidos, reimporte o arquivo CSV para substituir os dados

corrompidos.
• Matrix Display Order define o número da coluna (sequência).

3. Para excluir uma coluna, incluindo seus dados, da matriz, clique em Remover coluna na parte inferior do
cabeçalho da coluna.
4. Para adicionar um cabeçalho, clique em Adicionar cabeçalho .
Preencha o cabeçalho conforme descrito na etapa 2.
Desabilitar uma Matriz de Cálculo

Para desabilitar uma matriz de cálculo, edite sua Data/Hora de término .
1. Abra a versão da matriz de cálculo que você deseja desabilitar.

2. Na seção de detalhes, clique no ícone de lápis à direita de Data/hora de término .
3. Defina a Data/Hora de término para a data e hora em que você deseja que a matriz seja desativada.
Intervalos no cálculo Matrizes

Um intervalo recebe um valor numérico ou de texto e o atribui a grupos que você definiu. Você pode usar
intervalos numéricos e intervalos alfabéticos em matrizes de cálculo de Vlocity . Por exemplo, se a idade for
um componente do preço, você poderá usar um intervalo numérico para mapear a idade do candidato para a
faixa etária correta.
Idade Hoje Atribuído para faixa etária
17 ou mais jovem Faixa Etária 0
18 a 24 Faixa Etária 1
Idade Hoje Atribuído para faixa etária
25 a 29 Faixa Etária 2
30 a ... ...
Intervalos Numéricos no Cálculo Matrizes

Ao configurar intervalos numéricos para uma matriz, os valores abaixo do nível mais baixo configurado são
tratados como o valor mais baixo e os valores acima do valor mais alto configurado são tratados como o valor
mais alto configurado para a matriz.
No exemplo a seguir, o intervalo numérico é definido na coluna Entrada. A Faixa de faixa etária descreve como
os valores são tratados: todos os valores abaixo de 18 caem na primeira faixa, os valores que são 18 ou mais e
abaixo de 25 caem na segunda faixa e assim por diante. Por exemplo, para 48 anos, a matriz retorna uma Faixa
de faixa etária de 6. Para 22 anos, ela retorna uma Faixa de Faixa Etária de 1.

company
Quando você tem várias entradas que incluem intervalo, defina intervalos idênticos para cada valor de
variável. Por exemplo :

company
Veja Também
• ???
• ???
Agrupando por intervalos alfabéticos (exemplo)

Suponha que você queira atribuir contatos a um dos três buckets por sobrenome, de forma que:
• I = Contatos cujos sobrenomes começam com AI

• J = Contatos cujos sobrenomes começam com JR• S = Contatos cujos sobrenomes começam com SZ
Monte a matriz da seguinte forma:

company
Dimensões adicionadas na matriz
Você pode querer procurar dimensões adicionais na Matrix. Por exemplo, para pesquisar Faixa de faixa etária
por sexo, crie duas linhas para cada idade: uma para candidatos do sexo masculino e outra para candidatos do
sexo feminino. Adicional dimensões requerem adicionais linhas .
Visão geral dos procedimentos de cálculo

Um Procedimento de Cálculo é uma série de cálculos realizados usando pesquisas de matriz e variáveis e
constantes definidas pelo usuário. Um procedimento de cálculo pode chamar classes do Apex para lógica
personalizada pré e pós-cálculo. Os procedimentos de cálculo fazem parte das regras de precificação.
Existem dois tipos de procedimentos de cálculo:
• Baseado em classe : a lógica de preços é escrita em uma classe do Apex.

• Declarativo : A lógica de preços é implementada usando pesquisas de matriz, variáveis, constantes e
operações matemáticas básicas.
Os procedimentos de cálculo declarativo estão associados aos mapeamentos do DataRaptor . Os
procedimentos de cálculo declarativo usam DataRaptors para ler e salvar dados de objetos do Salesforce. Você
pode adicionar variáveis da extração do DataRaptor , como Preço Original (Moeda) e Quantidade (Número).
Por exemplo, você pode adicionar uma variável de moeda chamada UnitPrice como uma saída de cálculo que
pode ser usada em um carregamento do DataRaptor para atualizar um campo em um objeto do Salesforce.
Um procedimento de cálculo pode usar dois tipos de etapas.

company
• Matriz: Se você ativou Matrizes de cálculo, um procedimento de cálculo pode incluir uma Matriz de cálculo
nas etapas de cálculo. Para mais informações cerca de Cálculo Matrizes , ver Cálculo Matrizes .
• Fórmula: Por exemplo, você pode especificar a variável UnitPrice como saída. Se você estiver usando
DataRaptormappings , o nome da variável de saída do procedimento de cálculo deve corresponder ao nome
da variável de entrada DataRaptor Load
Cada etapa em um Procedimento de Cálculo pode ter uma condição que deve ser atendida para que a etapa
seja executada. Consulte Etapas condicionais para procedimentos de cálculo .
Na seção Nome da Classe do Pré-processador do procedimento de cálculo, você deve especificar a classe que
implementa um método de cálculo nameSpace.VlocityOpenInterface .
Para incluir a saída de uma etapa de cálculo na saída final, selecione Incluir na saída .
Casos de uso para procedimentos de cálculo

Aqui estão maneiras de configurar os possíveis casos de uso para procedimentos de cálculo que usam ou não
usam preços baseados em atributos ou preços baseados em volume.
Caso 1 — Sem preços baseados em atributos ou preços baseados em volume em vários itens de linha:
• Defina o filtro DataRaptor de entrada no OrderItem .

• Use um DataRaptor Extract para entrada e um DataRaptor Load para saída.
Caso 2 — Preços baseados em atributos, mas sem preços baseados em volume em vários itens de linha:
• Você não pode especificar a entrada DataRaptor no Procedimento de Cálculo.

• Um pré-processador é necessário para formatar os dados de entrada e as informações de atributo para uso
no CalculationMatrix .
• No pacote não gerenciado, uma classe do Apex chamada CalcProcPreProcessor formata a entrada do
DataRaptor conforme necessário para dar suporte aos atributos na Matriz de cálculo.
• Uma configuração personalizada — CPPreProc Object DRBundle — especifica o nome do DataRaptor de
entrada que o pré-processador usa.
• O objeto deve ser Oportunidade, Pedido ou Cotação.
Caso 3 — Preços baseados em atributos e preços baseados em volume nos itens de linha:
• Você não pode especificar os DataRaptors de entrada ou saída no Procedimento de Cálculo.

• Um pré-processador é necessário para formatar os dados de entrada para uso na Matriz de Cálculo.
• Um pós-processador é necessário para avaliar as quantidades em todas as linhas no objeto de cabeçalho.
• Duas classes do Apex — CalcProcPreProcessor e CalcProcPostProcessor — são fornecidas no pacote não
gerenciado.
• As configurações personalizadas definem o nome do DataRaptor de entrada que o pré -processador usa e o
outputDataRaptor que o pós-processador usa.
• CPPreProc Object DRBundle
• DRBundle de objeto CPPostProc
• O objeto deve ser Oportunidade, Pedido ou Cotação.
Use o Apex para definir a lógica de preços

Para usar o Apex para definir a lógica de preços, crie um Procedimento de cálculo baseado em classe. O nome
do procedimento de cálculo e o nome da classe de ação devem ser iguais ao nome da classe do Apex.

company
(Para definir a lógica de preços sem usar uma classe do Apex, crie um procedimento de cálculo declarativo.)
Para criar um Procedimento de Cálculo:
1. Vá para a guia Procedimentos de cálculo de Vlocity .

2. Clique em Novo .
3. Na lista de opções Tipo de registro do novo registro , selecione Baseado em classe .
4. Clique em Continuar .
5. No campo Nome do procedimento de cálculo , insira um nome para o procedimento.
6. Na caixa Descrição , insira uma breve descrição.
Clonar um procedimento de cálculo

O botão de ação Clonar não está presente para procedimentos de cálculo por padrão, mas você pode adicioná-
lo. Ao clonar um procedimento de cálculo, você está clonando todas as suas versões, etapas, variáveis e
constantes.
Por padrão, o novo procedimento de cálculo (clonado) não possui nenhuma versão definida como Ativada.
Você precisa habilitar manualmente uma das versões para usá-la.
Quaisquer matrizes de cálculo usadas pelo procedimento de cálculo não são clonadas.
No Salesforce Lightning, você adiciona um botão Clonar ao objeto Procedimento de cálculo e adiciona o botão
ao layout de página Procedimento de cálculo:
1. Vá para Configuração > Gerenciador de Objetos > Procedimento de Cálculo de Vlocity > Botões, Links e
Ações .
3. Insira um Rótulo e um Nome para o botão.
4. Em Tipo de exibição , escolha Botão da página de detalhes ou Link da página de detalhes .
5. Escolha um Comportamento .
Recomendado: Exibir em janela existente com barra lateral.
6. Em Fonte de conteúdo , escolha Página do Visualforce .
7. Em Conteúdo , escolha CálculoProcedimentoCloner .
9. Vá para Configuração > Gerenciador de objetos > Procedimento de cálculo de Vlocity > Layouts de
página .
10. Escolher o layout.
11. No painel superior, escolha Botões e arraste o botão Clonar para o layout da página.
Local recomendado: A área Detalhe do procedimento de cálculo de Vlocity > Botões personalizados .
13. Depois de adicionar o botão, você pode clonar um procedimento de cálculo:
a. Vá para a página da lista Procedimentos de cálculo de Vlocity e clique no procedimento de cálculo
que você deseja clonar.
b. Clique no Clone botão .

company
GORJETA
Se você não conseguir ver o botão Clonar na tela, clique na seta cinza para baixo no
canto superior direito da página e selecione Clonar .
c. Na janela Novo procedimento de cálculo de velocidade , insira um nome para o novo procedimento
de cálculo e clique em Salvar .
Veja Também
• Declarativo Procedimentos de cálculo
Variáveis e Constantes em Procedimentos de Cálculo

Você deve criar variáveis, constantes e matrizes antes de poder usá-los em um procedimento de cálculo.
Depois de criá-los, eles estarão disponíveis para uso em Procedimentos de Cálculo.
A seguir estão algumas diretrizes para usar variáveis em Procedimentos de Cálculo:
• Crie uma variável para cada valor no cálculo.

• Uma variável à direita do sinal de igual (=) significa que a saída da equação será atribuída como o valor da
variável .
Por exemplo, x + y = variável significa que o valor da variável agora é a soma de x + y.
• Uma variável à esquerda do sinal de igual (=) significa que o valor atual da variável faz parte do cálculo .
Por exemplo, x + variável = y significa que o valor de y agora é a soma de x mais o valor atual da variável.
• Uma variável mantém o valor atribuído a ela até que outra operação altere seu valor. Por exemplo :
x=2y=3
variável =
0 variável
=0
Etapa 1: x + y = variável // 2 + 3 = 5. variável = 5

Etapa 2: y + y = variável // 3 + 3 = 6. variável = 6
Etapa 3: variável + y = variável // 6 + 3 = 9. variável agora é 9.
Etapa 4: variável + variável = variável // 9 + 9 = 18. variável agora é 18.
Veja Também
• Adicionar Variáveis e Constantes
Condicional Etapas para procedimentos de cálculo

Para cada etapa do Procedimento de cálculo, você pode definir uma condição que deve ser atendida para que
a etapa seja executada. A etapa só é executada quando a condição é atendida.
Para especificar uma condição, marque Etapa Condicional e insira a condição para a etapa. Se a condição
compara uma variável com uma constante, a constante deve ser definida na seção Constante.
Funções para Procedimentos de Cálculo

As seguintes funções são suportadas nos procedimentos de cálculo.

company
Função Descrição Exemplo
company
ADDDAY Adiciona o número especificado de dias à data ADDDAY("1999-01-01",100) retorna "1999-04-11 00:00:00"
company
especificada e retorna a data resultante.
company
ADDMONTH Adiciona o número especificado de meses à data ADDMONTH("1999-01-01",100) retorna "2007-05-01
company
especificada e retorna a data resultante. 00:00:00"
company
ADICIONE ANO Adiciona o número especificado de anos à data ADDYEAR("1999-01-01",100) retorna "2099-01-01 00:00:00"
company
especificada e retorna a data resultante.
company
ERA Retorna a idade para a data de nascimento especificada. IDADE( Conta:Contato:Data de nascimento )
AGEON Dada uma data de nascimento, retorna a idade em AGEON( Conta:Contato:Data de nascimento,HOJE ()).
uma data especificada
DATADIF Retorna o número de dias entre duas datas DATEDIFF("1900-01-01","2000-01-01") retorna 36524
especificadas. Se a primeira data for maior que a
segunda data, o valor será retornado como um DATEDIFF("2000-01-01","1999-01-01") retorna -36524
número negativo.
DATEDIFF( Account:Cases:CreatedDate,TODAY ()) retorna o número
de dias que um caso foi aberto
MOE Para uma data especificada, retorna a data do último EOM( Account:CaseRetorna o mês da data especificada como um
dia do mês. número inteiro. s:CreatedDate)
MÊS Para uma data especificada, retorna o mês como um MONTH("1999-01-11") retorna 1
número inteiro (1-12).
REDONDO Arredonda o número ou expressão especificada. Por REDONDO(3,1415 * 3) = 9,42

padrão, os resultados são arredondados para duas
casas decimais, mas você pode especificar o número ARRED(3,1415 * 3, 0) = 9
desejado de casas decimais para o resultado.
Você também pode usar os parâmetros UP, DOWN,

HALF_UP, HALF_DOWN e HALF_EVEN para refinar os
resultados de arredondamento.
PISO Retorna um número arredondado para o inteiro mais FLOOR(2.5) retorna 2, que é 2.5 arredondado para o inteiro mais
próximo, para zero se for negativo. próximo.
ACIMA Use com ROUND para especificar que o resultado do ROUND(2,572, 2, UP) retorna 2,58
arredondamento é arredondado para cima (afastado
de zero).
BAIXA Use com ROUND para especificar que o resultado do ARRED(2,572, 2, BAIXO) retorna 2,57
arredondamento seja arredondado para baixo (em
direção a zero).
HALF_UP Use com ROUND para especificar que o resultado do ROUND(2,575, 2, HALF_UP) retorna 2,58
arredondamento é arredondado para o vizinho mais
próximo
( para cima ou para baixo), a menos que os vizinhos
sejam equidistantes, caso em que arredonda para
cima.
HALF_DOWN Use com ROUND para especificar que o resultado do ROUND(2,575, 2, HALF_DOWN) retorna 2,57
arredondamento é arredondado para o vizinho mais
próximo (para cima ou para baixo), a menos que os
vizinhos sejam equidistantes, caso em que ele
arredonda para baixo.
HALF_EVEN Use com ROUND para especificar que o resultado do ROUND(2,57, 1, HALF_EVEN) retorna 2,6, que é arredondado para a
arredondamento é arredondado para o vizinho mais casa decimal mais próxima.
próximo (para cima ou para baixo), a menos que os
vizinhos sejam equidistantes; nesse caso, ele
arredonda para o vizinho par mais próximo.
Comporta-se como para ROUND HALF_UP se o dígito à

esquerda da fração descartada for ímpar; se comporta
como para ROUND HALF_DOWN se for par.
TETO Arredonda um número para o inteiro mais próximo, CEILING(2.5) retorna 3, que é 2.5 arredondado para o inteiro mais
longe de zero se for negativo. próximo.
SQRT Calcula a raiz quadrada de um valor. SQRT(12 * 3) retorna 6
HOJE Devoluções data de hoje
ANO Retorna o ano da data especificada como um número ANO("1999-01-11") retorna 1999
inteiro.
Para procedimentos de loop: ANTERIOR
Para etapas de agregação, as funções a seguir são suportadas.

company
AVG Média da lista de valores. AVG(1,2,3,4,5,6,7,8,9,10) retorna 5,5
MÁX. Valor máximo em uma lista de valores. MAX(1,2,3,4,5,6,7,8,9,10) retorna 10
MIN Valor mínimo em uma lista de valores. MIN(1,2,3,4,5,6,7,8,9,10) retorna 1
SOMA Retorna a soma de uma lista de valores SOMA(1,2,3,4,5,6,7,8,9,10) retorna 55
Declarativo Procedimentos de cálculo

Os procedimentos de cálculo declarativo são um componente chave do mecanismo de classificação.
Juntamente com as matrizes de cálculo, os procedimentos de cálculo são os principais componentes de
qualquer mecanismo de classificação. Os procedimentos de cálculo usam um JSON de entrada e executam
uma série de pesquisas de matriz (chamando valores de matrizes de cálculo) e cálculos para calcular
classificações para produtos de política.
Os procedimentos de cálculo podem calcular prêmios de cobertura, prêmios de partes seguradas, prêmios de
itens segurados e prêmios de apólices de seguro. Os procedimentos de cálculo podem calcular baseado em
atributos preços dos produtos .
NOTA
A partir da versão Summer '19, os procedimentos de cálculo declarativo são compatíveis com:
• Agrupado Cálculo matrizes

• Versão de linha Cálculo matrizes
O que há em um procedimento de cálculo

Um procedimento de cálculo bem formado contém os seguintes elementos:
• Constantes
Todas as constantes que você precisa para cada etapa de cálculo
• Variáveis
Variáveis de entrada, todas as variáveis que você precisa para cada etapa de cálculo e a chave de grupo e a
chave de subgrupo se você estiver chamando um grupo de matrizes todas as variáveis nas matrizes de
cálculo que você chama nas etapas de pesquisa de matriz
• Cálculo passos , incluindo :
• Cálculos
company
Cada cálculo necessário para obter o resultado correto de todo o procedimento de cálculo
• Pesquisas de matriz
Encontra um ou mais valores de variáveis em matrizes de cálculo, com base em uma ou mais entradas de
variáveis
• Agregação passos ( opcional )
Se este procedimento de cálculo lidar com uma matriz de entradas, as etapas de agregação realizarão
cálculos sobre os conjuntos de saída.
Como os procedimentos de cálculo funcionam no contexto
OmniScripts , Procedimentos de Integração e outros processos Vlocity podem chamar um procedimento de

cálculo. O procedimento de cálculo usa um JSON que fornece ao procedimento de cálculo os ingredientes
necessários para concluir seu cálculo.
Os procedimentos de cálculo podem usar uma única entrada, um único conjunto de entradas ou vários arrays
de entradas.
Aqui está um exemplo de um único conjunto de valores de entrada, conforme passado por um JSON:
{
"entrada": {
" opMVRPoints ": "0",
" opAccidentPoints ": "0",
" driverGoodStudent ": "N",
" driverMaritalStatus ": "M",
" driverGender ": "M",
" driverYrsExp ": "14",
" driverMileage ": "7500",
" driverUse ": "Negócios"
}
}
O procedimento de cálculo é executado em todas as etapas uma vez para uma única entrada ou uma única
matriz de entradas. Ele retorna um cálculo ou matriz de cálculos. O JSON de saída para o procedimento de
cálculo que processou essa entrada é:
{
"resultado": [
company
{
" cálculoResultados ": [
{
" driverCCD ": 1.11,
" driverCOLL ": 0,92,
" driverMED ": 0,91,
" driverUM ": 0,92,
" driverBIPD ": 0,86,
" autoSafeDriver __ driverSafe ": "Y",
"ID": "entrada"
}
],
" aggregationResults ": {}
}
]
}
Como o procedimento de cálculo não teve nenhuma etapa de agregação, não há resultados de agregação no
JSON de saída.
Como funciona a agregação nos procedimentos de cálculo

Quando você adiciona etapas de agregação ao procedimento de cálculo, o procedimento de cálculo reúne os
resultados de cada execução, executa operações neles e, em seguida, gera os resultados das operações. Aqui
está o que que se parece com:
Por exemplo, em um caso simples, o procedimento de cálculo precisa calcular um prêmio de grupo com base
em um censo. Cada membro do censo tem um conjunto de valores de entrada que são passados para o
procedimento de cálculo. O procedimento de cálculo executa todas as e tapas de cálculo para cada membro,
resultando em uma saída (prêmio) para cada membro. Então agora ele tem uma matriz de saídas. Para somar
os prêmios de todos os membros do censo, uma etapa de agregação soma todas as variáveis de saída
dos prêmios.

company
NOTA
A funcionalidade aggByKey no exemplo a seguir está disponível no Vlocity Seguro e Vlocity Saúde
apenas.
Em um cenário mais complexo, um procedimento de cálculo de seguro automóvel deve calcular um prêmio
por instância de carro e motorista. Por exemplo, um usuário precisa avaliar uma política para dois carros – um
Toyota Prius e um Tesla Model S. O Prius é dirigido por Roger e Amy, e o Model S é dirigido por Amy e Steve. O
procedimento de cálculo precisa calcular e agregar resultados separadamente para o Pr ius e para o Modelo S.
Neste caso :
• instanceKey = carro+motorista
• aggByKey = carroModel
Para concluir esse cálculo com agregação, o procedimento de cálculo usa aggByKeys . Quando o procedimento
de cálculo recebe aggByKeys como entrada, ele executa as etapas de agregação uma vez por aggByKey . Aqui
está o que que se parece com:
Assim, para o exemplo acima, o procedimento de cálculo agrupa os resultados de suas quatro etapas de
cálculo em dois subconjuntos: um para as instâncias do Prius e outro para as instâncias do Modelo S. Em
seguida, ele executa as etapas de agregação duas vezes: uma para o Prius e novamente para o Model S. O
procedimento de cálculo retorna dois resultados de agregação – um para cada veículo.
Você não precisa adicionar aggByKeys e instanceKeys ao seu procedimento de cálculo como variáveis. Desde
que a opção aggByKey e a opção includeInputKeys estejam definidas corretamente nos serviços, os serviços
getRatedProduct e repriceProduct passarão as chaves automaticamente como parte do JSON de entrada.
Classes de pré-processador e pós-processador

company
Essas são classes do Apex que você pode usar se precisar massagear seus dados de entrada ou dados de saída
antes e depois de serem processados por um procedimento de cálculo. Consulte Exemplo de classe de pré-
processador .
Se você acha que precisa usar classes de pré-processador ou classes de pós-processador, entre em contato
com seu representante Vlocity para verificar se seu caso de uso exige que você escreva essas classes. (Temos
muitas ferramentas que são mais fáceis e configuráveis agora, e algumas delas podem funcionar melhor para
você.)
Fluxo de trabalho para criar um procedimento de cálculo

Para criar um procedimento de cálculo, você define a configuração geral, adiciona variáveis e constantes,
adiciona etapas e testa.
1. Configure um procedimento de cálculo .

2. Adicionar Variáveis e Constantes .
3. Adicionar Cálculo Passos .
4. Adicionar pesquisas de matriz .
5. Adicionar Agregação Passos .
6. Teste um procedimento de cálculo .
Configurar um procedimento de cálculo

Antes de criar etapas do procedimento de cálculo, você deve configurar o procedimento de cálculo como um
todo .
1. Na página da lista Procedimentos de cálculo de velocidade , clique em Novo .

2. Insira um Nome de procedimento de cálculo e clique em Salvar .
3. Na lista Vlocity Calculation Procedure Versions, clique no nome da versão que você acabou de criar.
4. Para completar o cabeçalho, clique em Editar .
No cabeçalho Detalhes da versão do procedimento de cálculo de velocidade , insira as seguintes
informações:
• Data e hora de início : O dia e a hora que Vlocity começará usando este procedimento de cálculo.
• End Date Time : O dia e hora Vlocity irá parar usando este procedimento de cálculo.
• Habilitado : Selecione para habilitar este procedimento de cálculo e bloqueá-lo. Observação: você não
pode editar um procedimento de cálculo que é ativado .
• Priority : A prioridade Vlocity fornece este procedimento de cálculo se uma chamada corresponder a
mais de um procedimento de cálculo habilitado. Quanto maior o número de prioridade, maior a
classificação de Vlocity . Por exemplo, se Vlocity encontrar dois procedimentos de cálculo
correspondentes, RatingCalc com Priority = 1 e RatingCalc com Priority = 2, Vlocity usará o
procedimento de cálculo com Priority = 2.
• Número da versão : Altere se desejar atribuir a este procedimento de cálculo um número de versão
diferente.
• Habilitar Looping : Selecione para habilitar isso como um procedimento de cálculo de loop.
Para saber mais sobre os procedimentos de cálculo de loop, consulte Uso de loop em procedimentos
de cálculo .
• Especificação de loop : Se você selecionou Habilitar loop, insira uma especificação de loop aqui.

company
Adicionar Variáveis e Constantes
Todos os procedimentos de cálculo requerem constantes, variáveis ou ambos.
NOTA
Você não pode usar o mesmo nome para uma variável que você usa para uma constante. Variáveis
e constantes usam o mesmo espaço de nomes .
Veja como você adiciona variáveis e constantes:
1. Adicionar variáveis :
a. Na seção Variáveis e Constantes, clique em +Adicionar Variável .
b. Digitar dados variáveis :
• Nome : um nome exclusivo para a variável.
• Tipo de dados : Escolha um da lista.
• Precisão : Opcional. Insira o nível de precisão que você deseja que o Vlocity siga para esta variável.
Por exemplo, insira 0,25 para tornar o valor dessa variável preciso para o quarto mais próximo de
um número inteiro. Para um exemplo de valor em dólar, insira 10 para tornar a variável precisa
para os $ 10 mais próximos.
Insira 0 se este procedimento de cálculo deve usar o valor preciso desta variável, sem derrapagem.
• Valor padrão : Opcional. Insira um valor se este procedimento de cálculo exigir um valor para essa
variável (não pode usar um valor nulo).
Se você não inserir um valor padrão, Vlocity definirá essa variável como nula se nenhum valor for
inserido para a variável.
NOTA
Antes de inserir as variáveis de saída, verifique as matrizes de cálculo que esta matriz de
cálculo usará.
Uma variável de entrada que requer uma entrada do usuário não pode ser usada como uma
variável de saída.
2. Adicionar constantes :
a. Na seção Variáveis e Constantes, clique em +Adicionar Constante .
b. Digitar a dados constantes :
• Nome : um nome exclusivo para a constante.
• Tipo de dados : Escolha um dos tipos disponíveis.
• Precisão : Opcional. Insira o nível de precisão que você deseja que o Vlocity siga para essa
constante. Por exemplo, insira 0,25 para tornar o valor dessa constante preciso para o quarto mais
próximo de um número inteiro. Para um exemplo de valor em dólar, insira 10 para tornar a
constante precisa para os $ 10 mais próximos.
Insira 0 se este procedimento de cálculo deve usar o valor preciso dessa constante, sem ajuste.
• Valor : O valor desta constante.
3. Clique em Salvar Procedimento de Cálculo .
Veja Também
• Variáveis e Constantes nos Procedimentos de Cálculo

company
Adicionar etapas de cálculo
Uma etapa de cálculo inclui uma ou mais operações e/ou funções matemáticas.
1. Na guia Cálculo do procedimento da página do procedimento de cálculo, role para baixo até a seção
Etapas de cálculo.
2. Clique + Adicionar Etapa
3. Selecionar Cálculo .
4. No primeiro campo, insira uma constante ou variável e pressione Return.
5. Insira um operador e pressione Return. Escolha entre os seguintes operadores:
• + ( sinal de adição )
• – ( menos sinal )
• * ( asterisco )
• / ( barra invertida )
• ^ ( acento circunflexo )
• ( (abra parênteses )
• ) ( fechado parênteses )
6. Digite o próximo item e pressione Return.
7. Continue inserindo operadores e itens até concluir o cálculo.
8. Para tornar esta etapa de cálculo condicional, selecione Etapa Condicional .
Insira a condição que invocará esta etapa de cálculo.
9. Para incluir a saída de cálculo nos dados de saída de cálculo, selecione Incluir na saída de cálculo .
Veja Também
• Funções para Procedimentos de Cálculo
• Função Referência
Adicionar pesquisas de matriz

Uma etapa de pesquisa de matriz chama uma matriz de cálculo, fornecendo entrada para a matriz e
retornando sua saída.
1. Na área Etapas de cálculo, clique em Adicionar etapa .

2. Selecionar Pesquisa de Matriz .
3. No campo Nome da Matriz , insira o nome da matriz de cálculo.
Depois de selecionar a matriz de cálculo, a etapa de cálculo exibe as entradas e saídas da matriz. O
sistema adiciona todas as colunas à seção Variáveis. O Vlocity desativa as variáveis que ele adiciona para
pesquisas de matriz, para que você não possa modificá-las ou excluí-las acidentalmente.
Um link para a matriz de cálculo também aparece na etapa de cálculo.
4. Para tornar esta etapa de cálculo condicional, selecione Etapa Condicional .
Insira a condição que invocará esta pesquisa de matriz.
5. Para incluir a saída da pesquisa de matriz nos dados de saída do cálculo, selecione Incluir na saída do
cálculo .
Adicionar Agregação Passos

company
Se a entrada para o procedimento de cálculo for uma matriz — por exemplo, vários membros da família estão
solicitando seguro e desejam visualizar o prêmio total — o procedimento de cálculo é executado para cada
entrada. Usando uma etapa de agregação, você pode agregar os resultados do procedimento e executar
cálculos adicionais no resultado agregado.
1. Na página Detalhes da versão do procedimento de cálculo de velocidade, role para baixo até a seção
Cálculo de preço.
2. Na área Etapa de Agregação, clique em Adicionar Etapa .
3. Selecionar Agregação .
4. No primeiro campo, insira um dos seguintes operadores:
• SOMA
• AVG
• MIN
• MÁX.
5. Insira a variável a ser agregada entre parênteses. Por exemplo , ( preço ) .
6. No segundo campo, insira uma variável para representar a variável agregada. Por exemplo , totalPrice .
7. Crie todas as outras etapas de agregação necessárias para concluir a agregação.
Testar um procedimento de cálculo

Recomendamos que você use a guia Simulador para testar o procedimento de cálculo que acabou de criar
antes de criar outros procedimentos de cálculo, Procedimentos de integração ou OmniScripts .
1. Na página do procedimento de cálculo, clique na guia Simular .

2. Insira ou altere as informações nos campos disponíveis.
3. Para ver apenas os resultados finais do cálculo, clique em Simular etapa final .
Vlocity mostra os resultados da etapa de cálculo final. Ele também mostra o JSON de entrada (com todos
os valores inseridos na etapa 2 do teste) e o JSON de saída.
OU
4. Para ver os resultados de cada etapa de cálculo inserida e o resultado final , clique em Simular todas as
etapas .
Vlocity mostra os resultados de cada etapa do procedimento de cálculo, as variáveis de todos os valores
de cada etapa, o JSON de entrada e o JSON de saída.
GORJETA
Se você tentou Simular Etapa Final e não obteve o resultado correto, faça Simular Todas as
Etapas e examine os resultados começando pela primeira etapa para ver qual etapa de
cálculo não está funcionando corretamente.
Criar uma nova versão de um procedimento de cálculo

É muito mais rápido criar uma nova versão de um procedimento de cálculo existente do que criar uma nova
versão do zero. Ao criar uma nova versão, todos os detalhes, variáveis, constantes, cálculos, pesquisas de
matriz e etapas de agregação são clonados da versão anterior.
1. Abra a versão do procedimento de cálculo que deseja clonar e clique em Criar nova versão . Talvez seja
necessário clicar na seta cinza para baixo no canto superior direito da janela para encontrar esse link.

company
O clone inclui todos os detalhes, variáveis, constantes e etapas de cálculo (cálculos e pesquisas de matriz)
da versão anterior. Mas a nova versão é não definido para ativado .
2. Para fazer alterações nos detalhes do procedimento de cálculo, clique em Editar no canto superior
direito.
a. Altere os valores de detalhes, como Data/hora de início e Data/hora de término.
b. Clique em Salvar .
3. Para fazer alterações nas variáveis e constantes:
a. Clique em uma variável ou constante para alterar seus dados.
b. Para excluir uma variável ou constante, clique no ícone da lixeira à direita do item específico.
c. Clique em Salvar Procedimento de Cálculo .
4. Para fazer alterações em cálculos e pesquisas de matriz:
a. Clique em qualquer campo de cálculo para excluir, adicionar ou alterar itens e operadores nele.
b. Clique em qualquer campo de pesquisa de matriz para alterar a matriz ou a variável resultante.
c. Clique no ícone da lixeira à direita de qualquer cálculo ou pesquisa de matriz para excluí-lo.
5. Para fazer alterações nas etapas de agregação:
a. Clique em qualquer campo de agregação para excluir, adicionar ou alterar itens e operadores nele.
b. Clique no ícone da lixeira à direita de qualquer etapa de agregação para excluí-la.
O recurso de loop nos procedimentos de cálculo

Os cálculos de loop usam um ponto inicial, um ponto final e um intervalo. Em tempo de execução, o
procedimento de cálculo é executado em um loop do início ao fim por intervalo. Cada execução usa as
mesmas variáveis de entrada, além de uma variável de índice que você pode usar no cálculo.
Os procedimentos de cálculo suportam cálculos de loop começando na versão principal do Vlocity Insurance
Winter '18.
Por exemplo, você pode criar um procedimento de cálculo em loop para uma apólice de seguro de vida. O
procedimento de cálculo de loop calcula o valor da apólice para cada ano desde a idade atual do titular da
apólice até a idade do titular da apólice no final da vigência da apólice. O cálculo leva uma idade atual (35
anos), idade final (65 anos) e um intervalo de 1 para calcular anualmente. O cálculo é executado, fazendo um
loop 30 vezes. Todas as variáveis de entrada permanecem constantes, mas o índice começa em 35 e aumenta
de um a 65. A saída mostra ao usuário o valor da política a cada ano, desde a data de início até o final do
prazo.
Para configurar o loop, consulte Configurar um procedimento de cálculo para loop .
Variável de índice
A variável de índice fica disponível quando você define Habilitar Looping na Versão do Procedimento de
Cálculo. Para adicioná-lo às etapas de cálculo, digite índice em uma etapa de cálculo.
Quando um procedimento de cálculo tem o loop configurado e habilitado, ele incrementa o índice com base
na variável Interval do loop (qualquer que seja o nome), desde o início do loop até o final do loop. Você pode
então usar o índice para alterar o cálculo em cada passagem de loop. Por exemplo, você pode adicioná-lo a um
Age para incrementar o valor de Age para cada loop.

company
NOTA
índice fornecida pelo sistema não aparece na lista de variáveis. Você não precisar para criá -lo.
Neste exemplo, a etapa de cálculo 3 é configurada para calcular o ano da apólice, fazendo um loop por
intervalo (um ano). A etapa 4 calcula a idade do titular da apólice, fazendo um loop por intervalo (um),
começando com a idade do titular da apólice no início da apólice.
Função ANTERIOR
Você pode usar a função PREVIOUS para obter o resultado da iteração em loop anterior. A etapa de cálculo
pode usar esta função para acessar os resultados da variável de uma iteração anterior e calculá-la com outras
variáveis.
ANTERIOR aceita a seguinte :
• Variável nome
Normalmente configurado como uma constante do tipo Texto
• anteriorIterador
O índice do conjunto de resultados da iteração anterior do qual obter o valor para a variável
• ITERAÇÃO
Variável fornecida pelo sistema para resultados acumulados
Neste exemplo, a função PREVIOUS usa iterações anteriores para calcular o valor em dinheiro da política por
iteração (uma).
Exemplo 1: Simulação do Procedimento de Cálculo

Para este exemplo, o termo = 2 (anos), o início = 0 (ano zero do prazo) e o incremento = 1 (ano).

company
O JSON de saída para esta simulação é:
{
"resultado": [
{
" cálculoResultados ": [
{
"índice": 0,
" intervaloNumero ": 0,
" Benefício de morte ": 3000,
" morteBenefícioGarantia ": 3000,
" cashValue ": 0,
" intervaloDividendo ": 0,
" Investimento em caixa ": 2995,83 ,
" dinheiroSeguro ": 4.17,
" probabilidade de morte ": 0,00139 ,
" currentMortality __ currentDeathProbability ": 0,002402,
" idade atual ": 47,
" intervalDate ": "2017-12-07",
" fim de idade ": 52,
"ID": "entrada"
},
{
"índice": 1,
" Benefício de morte ": 5995,83 ,
" cashValue ": 2995,83,
" intervaloDividendo ": 0,
company
" dinheiroSeguro ": 3,48,
" currentMotality __ currentDeathProbability ": 0,002639,
" intervalDate ": "2018-12-07",
"ID": "entrada"
},
{
"índice": 2,
" Benefício de morte ": 8992,35 ,
" cashValue ": 5992,35,
" intervaloDividendo ": 44,94,
" dinheiroSeguro ": 2,67,
" currentMotality __ currentDeathProbability ": 0,002903,
" intervalDate ": "2019-12-07",
"ID": "entrada"
}
],
" aggregationResults ": {}
}
]
}
Exemplo 2: OmniScript
Neste exemplo, o procedimento de cálculo de loop é adicionado a um OmniScript como uma ação de cálculo.

company
O cálculo de loop cria uma lista de resultados. Você pode exibir esses resultados em um formato de sua
escolha. No exemplo abaixo, um modelo personalizado exibe os resultados em uma tabela que mostra os
valores da apólice ano após ano (incrementados em 1).

company
Configurar um procedimento de cálculo para loop
Certifique-se de que a IU do procedimento de cálculo esteja configurada para cálculos de loop e, em seguida,
configure as variáveis de loop.
1. A partir do App Launcher, vá para a guia Vlocity Calculation Procedures.

2. Selecione seu procedimento de cálculo na lista. Na página de registro, clique na guia Relacionado .
3. Clique no nome da versão do procedimento de cálculo que você está usando.
4. Clique no ícone de engrenagem e selecione Editar objeto .
Uma nova guia do navegador é aberta e você está em Configuração, no Gerenciador de Objetos e na
página Versão do Procedimento de Cálculo de Vlocity .
5. Selecione Layouts de página e, em seguida, selecione o layout de página que você está usando.
6. Arraste os seguintes itens de Campos para a seção Detalhes da Versão do Procedimento de Cálculo de
Vlocidade :
• Habilitar
Looping •
Especificação de
Loop

company
8. Retorne à guia do navegador para a versão do procedimento de cálculo que você está usando e atualize o
navegador.
9. Clique no ícone de lápis para o campo Enable Looping e marque a caixa Enable Looping .
10. No campo Especificação de Loop , digite um valor JSON neste formato:
{"loopingStart":" StartVariableName ","loopingEnd":" TermVariableName ","loopin gInterval ":"

IntervalVariableName "}
Os valores devem corresponder aos nomes das variáveis que você definirá no procedimento de cálculo na
próxima etapa.
Por exemplo :

12. Em seu procedimento de cálculo, crie três variáveis com um tipo de dados de número e uma precisão de
0 . Os nomes devem corresponder às variáveis que você definiu na Especificação de Loop na etapa
anterior. Por exemplo :

Após a configuração do loop, você pode criar etapas de cálculo usando a variável de índice e a função
PREVIOUS . Consulte O recurso de loop em Procedimentos de cálculo .
Exemplo de classe de pré-processador

O exemplo a seguir mostra a estrutura típica de uma classe Apex de pré-processador para um procedimento
de cálculo declarativo.
global com classe de compartilhamento PricingCalculationPreProcessExample implementa

VlocityOpenInterface {
public Boolean invokeMethod (String methodName , Map< String,Object > inputMap ,
Map< String,Object > outMap , Map< String,Object > options) {
Sucesso booleano = true;
tentar{
if( methodName == 'calcular') {
cálculo( inputMap , outMap , opções );
}
}catch(Exception e){ logger.err (e);
sucesso=falso; }

company
sucesso de retorno ;
}
Vlocity Actions
cálculo de vazio estático privado (Map< String,Object > inputMap ,
Map< String,Object > outMap , Map< String,Object > options){
Logger.dbg ('no mapa de entrada de pré-processamento é '+ inputMap );
for(String key: inputMap.keySet ()){
if(chave == 'ABCD1234'){
Objeto realData = inputMap.get (key );
Map<String, Object> real = (Map<String, Object>) realData ;
for(String key1 : real.keySet ()){ if(key1==' Payor_code '){
real.put (' Payor_code ', ' kpf ' );
}
}
}
}
Logger.dbg (' no pré-processamento após a conversão, o mapa de entrada é '+ inputMap );
}
}
Vlocity Actions são URLs gerados automaticamente que iniciam Vlocity OmniScripts , componentes Vlocity
Cards, páginas da Web ou aplicativos externos. As ações geralmente são específicas para um determinado tipo
de objeto, como Conta, Contato, Política ou Ativo.
A API Vlocity Action retorna as ações associadas a um objeto. Os ícones, links e texto de exibição permitem
que os usuários invoquem a ação a partir do contexto do objeto.
Para configurar ações de Vlocity , consulte Configurar uma ação de Vlocity .
Configurar uma ação de Vlocity

Configure uma ação Vlocity para iniciar o Vlocity OmniScripts , componentes Vlocity Cards, páginas da Web ou
aplicativos externos. As ações geralmente são específicas para um determinado tipo de objeto, como Conta,
Contato, Política ou Ativo.
1. Vá para a guia Ações de Vlocity .

2. Clique em Novo ou selecione uma ação e clique em Editar .
3. Na página New Vlocity Action ou na página Details no modo de edição, insira ou atualize os valores para
estes campos:

company
NOTE
If a f ield is missing, confirm that the field is available in theVlocity Action Layout
page layout for theVlocity Actionobject.
Nome do campo Descrição
Vlocity Ações Nome Requeridos. Insira um nome para a ação com no máximo 80 caracteres.
Descrição Começando com Vlocity Insurance and Health Winter '20 e Vlocity CME Winter '20, o Vlocity Actions
suporta a inserção de uma descrição para a ação.
Aplicável Modelo Requeridos. Selecione os objetos a partir dos quais você deseja que a ação seja iniciada. O valor padrão é
Todos . A Vlocity recomenda selecionar objetos específicos porque a ação tenta invocar todos os Tipos
Aplicáveis, o que reduz o desempenho.
Para adicionar valores à lista de opções Tipo aplicável , use o nome da API do objeto, como
Família__c . O valor pode ser um nome de sObject ou qualquer string. Se a ação tiver um Filter , o
Applicable Type deverá ser o nome do sObject , como Policy__c , que é usado em uma consulta SOQL.
Aplicável Perfil do usuário Para escolher qual ação exibir para um perfil de usuário, selecione uma opção na lista. O valor padrão é
Todos . Um administrador pode adicionar outros perfis de usuário à lista de opções. Por exemplo, se o
perfil do usuário de login atual for Vlocity Health , somente as ações em que Applicable User Profile
estiver definido como All ou Vlocity Health serão exibidas.
Ativo Para tornar a ação visível, marque esta opção.
Rótulo de exibição Requeridos. Insira um rótulo visível para a ação.
Sequência de exibição Requeridos. Insira a sequência na qual a ação é exibida em uma subguia ou componente. Mais baixo
número no _ seqüência é exibida primeiro .
Exibir ativado Requeridos. Para filtrar onde a ação é exibida, selecione All , Web Client ou Mobile na lista.

company
Vlocity Ícone Para exibir um ícone para esta ação, visualize os ícones de Vlocity disponíveis e seus nomes de classe
associados na seção Ícones de Vlocity da página de detalhes da ação. Insira o nome da classe do ícone a
ser exibido para esta ação. Os ícones de Vlocity não podem ser visualizados ao criar uma nova ação na
página New Vlocity Action.
Carregue um ícone personalizado como anexo na guia Relacionado. A imagem anexada mais recente
carregada (com tamanho inferior a 50 KB) é usada como imagem personalizada. Se o ícone Vlocity e o
ícone personalizado (anexo) estiverem definidos, o ícone personalizado será usado. Quando o ícone
personalizado não é carregado, o ícone Vlocity é usado.
Abrir URL em Para definir como abrir o URL de destino, selecione Janela atual ou Nova guia/janela . O padrão é Atual
Janela .
Tipo de link Requeridos. Para especificar de onde a ação é iniciada, selecione uma destas opções:
• CommunityURL : inicia uma página da Comunidade do Salesforce.

• OmniScript : inicia um OmniScript .
• Outro : inicia um URL específico.
• ConsoleCards : inicia um cartão do Salesforce Classic.
• LEXConsoleCards : inicia um cartão do Lightning Experience Console em uma subguia.
• Documento : Lança um Contrato Documento .
• Layout : inicia uma página de Layout do cartão.
É Semente Ação Marque esta caixa de seleção se a ação for uma ação de Documento de contrato fornecida pronta para
uso. Não verifique isso para uma ação personalizada. As ações de semente são dados de semente que as
Ações de Vlocity exigem para que determinada funcionalidade funcione. Uma mensagem de erro é
exibida quando você exclui uma ação de semente. Um usuário não pode excluir uma ação de semente
ou limpar a ação É semente checkbox, mas pode ser definido como inativo.
NOTA
Uma mensagem de erro é exibida quando você exclui uma ação de semente. Um
usuário não pode excluir uma ação de semente ou limpar a ação É semente
checkbox, mas pode ser definido como inativo.

company
Alvo URL Requeridos. A URL para a qual a ação navega. Insira um URL, como /apex/< pageName > ou um URL com
company
parâmetros. Por exemplo:
company
/apex/ TestPolicyOmniPage?id ={0}#/OmniScriptType/Policy/
company
OmniScriptSubType /Auto/ OmniScriptLang /English/ ContextId /{0}/ PrefillDataRaptorBundle /true.
company
IMPORTANTE
company
Para ações de Vlocity prontas para uso , como Exibir registro , o URL de destino
company
/{0} não funciona fora do Salesforce Classic. Para navegar para uma página no
company
Salesforce Lightning Experience, atualize o URL para /relâmpago/r/[ ObjectName
company
]/{0}/view , em que ObjectName é o nome da API do sObject , como Account.
company
O {0} no URL de destino representa a posição indexada de um parâmetro na lista de parâmetros no
company
campo Parâmetro de URL . Consulte a descrição do campo Parâmetro de URL .
company
Para navegar para uma página da comunidade do Lightning ou do Lightning, prefixe a URL relat iva com
company
ltngpage :. Por exemplo, ltngpage :/Home redireciona para a página inicial da sua comunidade.
company
Para abrir uma página do Visualforce a partir do contêiner Lightning do Salesforce, prefixe o URL relativo
company
com ltng . Por exemplo, ltng :/apex/ CustomVFPage , redireciona para CustomVFPage .
company
Exemplo de URLs de destino:
company
• /apex/ NameSpace __ OmniScriptUniversalPageConsole ?
company
id={0}&OmniScriptType=VPL&O mniScrip tSub Type=GetPolicyAccountAgentDet
company
ails&OmniScriptLang=En glish&scriptMode=vertic al&layout=lightn ing&Con textId ={0}& InteractionId
company
={1}&Role={2}
company
• / apex / NameSpace __ OmniScriptUniversalPageWHeader?id ={0}#/
company
OmniScriptType/Policy/Omn iScriptSu bType/Auto/ Omn iScriptL ang/ English/
company
ContextId /{0}/ PrefillDataRaptorBundle / true
company
• /apex/ NameSpace __ ConsoleCards?id ={0}&layout=lex-layout
company
• /apex/NameSpace__ConsoleCards?id={0}&layout=SampleGetObjectFro mInteraction
company
Consulte URL de destino e parâmetros de URL .
company
Parâmetro de URL Se o URL de destino exigir parâmetros, insira-os aqui. O parâmetro URL representa o nome do atributo
do objeto Applicable Type, como AccountId em Contact . Na sequência em que você deseja substituir os
parâmetros na URL de destino, especifique os parâmetros em uma lista separada por vírgulas sem
espaços.
Por exemplo, quando você insere AssetId,CustomerInteractionId,Role neste campo, AssetId substitui
{0} , CustomerInteractionId substitui {1} e Role substitui {2} em um URL de destino.
Consulte URL de destino e parâmetros de URL .
Aplicável Permissão Para Vlocity Winter '18 versão secundária 900.85.3 e posterior. Para especificar quais ações são exibidas
Nome com base na permissão concedida ao perfil do usuário ou a um ou mais conjuntos de permissões do
usuário, insira o nome de um objeto de Permissão Personalizada padrão. Para obter mais informações
sobre conjuntos de permissões, consulte Controlar quem vê o quê na ajuda do Salesforce.
Filtro Para especificar qual ação é exibida para cada instância do objeto, crie um filtro usando AND ou OR
condições com atributos do Tipo Aplicável . Por exemplo:
Tipo aplicável= Policy__c , Filter= PolicyType __c='Auto' AND

Status__c ='Ativo'
Este exemplo especifica que a ação é exibida apenas para políticas ativas em que o tipo de política é
'Auto'. A condição de filtro é aplicável a objetos padrão e personalizados válidos do Salesforce. Filtre por
qualquer campo no objeto. O comprimento máximo é de 255 caracteres.
Adicional Filtro Insira um filtro com mais de 255 caracteres.
Modelo de estado Para contratos, especifique o Modelo de Estado do Contrato que define o ciclo de vida do contrato
associado a esta ação.
Para Estado Para contratos, especifique o estado associado a esta ação.
Nome da classe de invocação Insira o nome da classe de invocação do Apex e o nome do método. A classe deve implementar
VlocityOpenInterface /VlocityOpenInterface2 .
Nome do método de invocação
Nome da classe de validação Insira o nome da classe de validação e o nome do método. A classe deve implementar
VlocityOpenInterface /VlocityOpenInterface2 . Ele é usado na barra de ferramentas Ação da interface
Nome do método de validação do usuário do gerenciamento de documentos do contrato para exibir uma mensagem de aviso.
Atualizar lógica de filtro para ações de Vlocity

Vlocity e a configuração Tipo Aplicável determinam qual ação aparece para uma instância de um objeto. Você
pode usar as condições E ou OU com os atributos na configuração Tipo Aplicável. Por exemplo,
Tipo Aplicável= Policy__c , Filter= PolicyType __c='Auto' AND Status__c ='Active' , significa que esta ação
aparece apenas na barra de ferramentas Ação para as Políticas com tipo de política ='Auto' e status 'ativo'.

2. Clique na seta para baixo da Ação a ser atualizada e clique em Editar .
3. No campo Filtro , insira a nova lógica de filtro.

company
Atualizar configurações de perfil para ações de contrato

Vlocity controlam as ações e operações que são permitidas em cada estado em um registro de Documento de
Contrato específico. Vlocity Actions também controla quais usuários podem realizar ações e operações.
1. Vá para a guia Vlocity Actions e clique na caixa de seleção

ao lado de 2. Clique na seta para baixo para Add Ação de
Vlocity e clique em Editar .
3. Na lista de opções Perfil de usuário aplicável :
a. Para impedir que usuários não autorizados baixem documentos de contrato, para cada usuário
autorizado, selecione o usuário na lista Disponível e clique na seta para a direita para movê-lo para a lista
Escolhido .
b. Para garantir que apenas usuários autorizados possam fazer download de documentos de contrato,
para cada usuário não autorizado, selecione o usuário na lista Escolhido e clique na seta para a esquerda
para movê-lo para a lista Disponível .

company
5. Repita as etapas de 1 a 4 para as ações Check-out para personalizar e Check-out para personalizar o
console .
Atualizar o tipo de link para uma ação

O aplicativo móvel Vlocity usa o tipo de link Vlocity Action para filtrar as ações do OmniScript .
2. Clique na seta para baixo da Ação a ser editada e clique em Editar .
3. Na lista de opções Tipo de link , selecione um tipo de link.

company
URL de destino e parâmetros de URL
Para iniciar o Vlocity OmniScripts , componentes Vlocity Cards, páginas da web ou aplicativos externos de um
Vlocity Action, insira uma página do Apex ou um URL com parâmetros como o URL de destino. Os
componentes LWC não são endereçáveis por URL e, portanto, não podem ser acessados diretamente de um
URL e devem ser incorporados em uma página. Ver Vlocity Ações .
IMPORTANTE
Para ações de Vlocity prontas para uso , como Visualizar registro , o URL de destino /{0} não
trabalhe fora do Salesforce Classic. Para navegar para uma página no Salesforce Lightning
Experience, atualize o URL para /lightning/r/[ ObjectName ]/{0}/view , em que ObjectName é o
nome da API do sObject , como Account.
Páginas do Visualforce disponíveis para iniciar OmniScripts

Vlocity fornece estas páginas do Visualforce para iniciar OmniScripts :
• OmniScriptUniversalPage
• OmniScriptUniversalPageWHeader
• OmniScriptUniversalPageWHeaderSidebar .
• OmniScriptUniversalMobilePage (para uso apenas com dispositivos móveis)
• OmniScriptUniveralPageConsole (para uso no Industry Console)
• OmniScriptUniversalCommunitiesPage (para uso em Comunidades)
Formatando o URL de destino

Para um URL de destino que inicia um componente Vlocity Card ou um Vlocity OmniScript , a primeira parte do
URL é a página do apex, seguida pelo PageName , como /apex/< PageName > . A segunda parte do URL de
destino é uma lista de parâmetros definidos no campo Parâmetros de URL e está disponível para qualquer
tipo de URL suportado pelo Vlocity Actions, incluindo páginas da Web e aplicativos externos.
O exemplo a seguir mostra como formatar o URL:
//Exemplo de URL de destino para iniciar um OmniScript
/apexNS__[PageName]?id={0}#/OmniScriptType/AAA1/OmniScriptSubType/AAA2/
OmniScriptLang/AAA3/layout/[LayoutName]/ContextId/{0}/PrefillDataRaptorBundle/ [ BundleName ]/[
verticalMode ]
//Exemplo de URL de destino para iniciar um componente de cartão
/apex/NS__[ PageName ]?id={0}#/layout=[LayoutName] //Exemplo de URL
externo https://www.domainName.com/?id={0 }/
A partir do Vlocity Versão 12, um padrão de URL alternativo está disponível:
//Exemplo de URL de destino para iniciar um OmniScript
/ apexNS __[ PageName ]?

id={0}&OmniScriptType=AAA1&OmniScriptSubType=AAA2&OmniScriptLang=AAA3&layout=[L
company
ayoutName]]&PrefillDataRaptorBundle=[BundleName]&scriptMode=[verticalMode] //Exemplo de URL de
destino para iniciar um componente de cartão /apex/NS__[ PageName ]?id={0 }&layout=[ LayoutName ]
//Exemplo de URL externo https://www.domainName.com/?id={0}/
NOTA
Embora ambos os padrões de URL sejam válidos, a vantagem do padrão alternativo é que ele é
compatível com dispositivos móveis e permite adicionar parâmetros de URL adicionais diretamente
no OmniScript Data JSON. Por exemplo, anexar & customerSLALevel =gold ao URL adicionaria um nó
à raiz do OmniScript Data JSON, como " customerSLALevel ":"gold" .
Descrições de variáveis de URL de destino

Esta tabela lista as descrições das variáveis dos exemplos de URL de destino nesta página:
Variável Descrição Disponível
Por
NS __ Namespace do pacote instalado. Use ao fazer referência a uma página do Universal Visualforce. OmniScript ,
Cartão
Variável Descrição Disponível

Por
[ PageName ] Página Universal do Visualforce, OmniScriptUniversalPage , OmniScriptUniversalPageWHeader , OmniScript ,

OmniScriptUniversalPageWHeaderSidebar ou OmniScriptUniversalMobilePage ) ou outra página do Cartão
Visualforce contendo o OmniScript .
{0} O primeiro parâmetro listado no campo Parâmetros de URL e geralmente é o ID de contexto de um OmniScript ,
sObject . Ver Parâmetros de URL sobre isto página . Cartão
AAA1 OmniScript Modelo OmniScript
AAA2 Subtipo de OmniScript OmniScript
AAA3 OmniScript Linguagem OmniScript
[ LayoutName ] • (Opcional) Para OmniScript : relâmpago ou Newport . Define qual tema de layout usar. O padrão é OmniScript ,
relâmpago . Cartão
• (Opcional) Para Cartão: Define qual layout de cartão usar.
[ NomeDoPacote ] (Opcional) Nome do pacote DataRaptor usado para preencher previamente os campos no script. OmniScript
[ modo vertical ] (Opcional) true ou false . Se true, todas as etapas em um OmniScript são empilhadas verticalmente. Se OmniScript
false, todas as etapas em um OmniScript são navegadas horizontalmente. O padrão é verdadeiro .
Parâmetros de URL
Em um URL de destino, o {0} representa a posição indexada de um parâmetro na lista de parâmetros no campo
Parâmetro de URL . O parâmetro é o nome da API do campo no objeto aplicável, como AccountId ou ID em
Contact.
Especifique os parâmetros como uma string delimitada por vírgulas, na sequência em que você deseja
substituir os parâmetros na URL de destino. Por exemplo, AccountId,vlocity_ins__ PrimaryContactId __c ,
substitui {0} no URL de destino pelo AccountId e substitui {1} no URL de destino pelo vlocity_ins__
PrimaryContactId __c.
Você também pode usar atributos do objeto User, como User.ContactId , para obter o ID do usuário atual.

company
NOTA
A partir do CME Fall '18, o Vlocity oferece suporte ao formato de URL de edição de objeto do
Salesforce de /{3 character sobject prefix}/e' .
Exemplo 19. Exemplo de parâmetro de URL

//Exemplo de URL de destino para iniciar um componente de cartão
/apex/vlocity_ins__ OmniScriptUniversalPage ?
id={0}&OmniScriptType=AppointmentAppointment&OmniScriptSubType=IndependentAgent
AppointmentApplication&OmniScriptLang = English&layout =relâmpago
//Exemplo de URL de destino para iniciar um componente de cartão /apex/ NameSpace __ ConsoleCards?id
={0}&layout=lex-layout
Navegando em URLs no Lightning e na comunidade do Lightning

Navegar para páginas do Lightning e de contêineres do Lightning requer que o caminho relativo tenha um
prefixo.
Para usar a sintaxe de URL adequada, siga estes requisitos :
• Para usar URLs relativos no Lightning Console (LEX), prefixe o URL de destino com ltng : e verifique se o
valor Abrir URL em está definido como Nova guia/janela para que o link do URL relativo seja aberto em
uma nova janela. Por exemplo, ltng :/apex/ NewLandingPage , abrirá a nova página de destino em uma
nova janela.
• Para redirecionar para uma página da comunidade do Lightning ou do Lightning, prefixe a URL relativa com
ltngpage : . Por exemplo, ltngpage :/Home redirecionará para a página inicial da sua comunidade.
• Para abrir uma página do Visualforce a partir do contêiner Lightning do Salesforce, prefixe o URL relativo
com ltng : . Por exemplo, ltng :/apex/ CustomVFPage , redirecionará para CustomVFPage .
Exibir ações de Vlocity com a barra de ferramentas de ação de Vlocity

Cartões abertos, OmniScripts , páginas da comunidade, páginas da Web, documentos e aplicativos externos
em um
Lightning ou página de registro da comunidade clicando nos links Vlocity Action na barra de ferramentas
Vlocity Actions. A ID de registro da página de registro e as permissões concedidas às ações Vlocity determinam
quais ações são exibidas na barra de ferramentas de ação Vlocity .
NOTA
Como os componentes da Web do Lightning, como LWC Cards e LWC OmniScripts , não são
endereçáveis por URL, você só pode Angular Vlocity Cards e Angular Vlocity OmniScripts na barra
de ferramentas.
Adicionar a barra de ferramentas de ação Vlocity a uma página de registro do

Lightning

company
Adicione a Barra de ferramentas de ação Vlocity a uma página de registro de iluminação para abrir um cartão,
OmniScript , página da comunidade, página da Web, documento ou aplicativo externo. Por exemplo, adicione
a barra de ferramentas em uma página de Conta para visualizar todas as Ações de Vlocity disponíveis para
Contas, como Atualizar conta .
1. Na sua organização, abra uma página de registro, como uma Conta, clique no ícone Configurar e clique
em Editar página .
2. No painel de componentes do Lightning, arraste o componente Vlocity Action Toolbar da lista de
componentes Personalizados - Gerenciados para a área de tela onde deseja que sua barra de
ferramentas seja exibida.
3. Para atualizar as propriedades no Painel de Propriedades, consulte Configurar a Barra de Ferramentas de
Ação de Vlocity .
Adicionar a barra de ferramentas Vlocity Actions a uma página de registro da
comunidade
Adicione a barra de ferramentas de ação Vlocity a uma página de registro da comunidade para abrir um
cartão, OmniScript , outra página da comunidade, página da Web, documento ou aplicativo externo. Por
exemplo, adicione a barra de ferramentas em uma página de Conta para visualizar todas as Ações de Vlocity
disponíveis para Contas, como Atualizar conta .
1. Em sua organização, vá para Configuração de serviço > Todas as comunidades e clique em Construtor ao
lado do nome de uma comunidade existente para abrir o Construtor de comunidade.
2. Clique no ícone de raio azul e branco à esquerda para abrir o painel Componentes.
3. Na lista de Componentes Personalizados no painel Componentes, arraste a Barra de Ferramentas de
Ação Vlocity para a área da tela onde deseja que sua barra de ferramentas seja exibida.
4. Para atualizar as propriedades no Painel de Propriedades, consulte Configurar a Barra de Ferramentas de
Ações de Vlocity nesta página.
Configurar a barra de ferramentas de ação Vlocity

A Barra de Ferramentas de Ação Vlocity tem propriedades opcionais que você pode configurar. Por padrão, a
barra de ferramentas funciona fora da caixa sem configurar nenhuma propriedade. Adicione uma barra de
ferramentas Vlocity Action para abrir Cartões, OmniScripts , páginas da Comunidade, páginas da Web,
documentos e aplicativos externos em uma página de registro do Lightning ou da Comunidade clicando nos
links Vlocity Action na barra de ferramentas. Ver Mostrar Vlocidade Ações com a Vlocity Barra de ferramentas
de ação .

company
Formulas and Functions
ID do registro Para habilitar a barra de ferramentas para usar automaticamente o recordId da página de registro em que está, deixe em
branco. Para exibir ações associadas a um ID de registro específico, insira um ID de registro.
Estilo Selecione um layout horizontal ou vertical . O padrão é horizontais .
Objeto Modelo Selecione os objetos cujas ações possuem Tipos Aplicáveis específicos. Tipos aplicáveis determinam os objetos a partir dos
quais você deseja que a ação seja iniciada. Consulte Ações de Vlocity . Por exemplo, insira Account,Policy_c para exibir ações
de Vlocity que só podem ser iniciadas a partir de uma página de registro de conta ou política. O padrão é Casa .
Exibir ativado Para limitar a ações de Vlocity que são exibidas apenas em plataformas específicas. Selecionar a partir de 1 do esses opções :
Opção Descrição
Tudo
For actions that display on both web client and mobile.
Cliente Web Predefinição. As ações são exibidas apenas no cliente da web do salesforce.
Móvel Para ações exibidas online no aplicativo móvel.
Tipo de link Para especificar de onde a ação é iniciada, insira uma lista separada por vírgulas sem espaços. Por exemplo, para exibir
ações que iniciam OmniScripts e URLs específicos, insira Other,OmniScript .
Modelo Descrição
URL da comunidade Inicia uma página da Comunidade do Salesforce.
OmniScript
Launches an OmniScript.
Outro Inicia um URL específico .
Placas de console
Launches a Salesforce Classic card.
LEXConsoleCards Inicia um cartão do Lightning Experience Console em uma subguia.
Documento
Launches a Contracts Document.
Esquema Inicia uma página de layout de cartão.
Comunidade Se o tipo de link for CommunityURL , digite o nome da página da comunidade que você criou para exibir OmniScripts .
Página
O Expression Engine é um construtor de fórmulas baseado em APEX usado em várias áreas do OmniStudio ,
incluindo OmniScripts , DataRaptors e Integration Procedures.
O construtor de fórmulas OmniScript e as regras de atributos usam um mecanismo de expressão JavaScript do

lado do cliente que é avaliado no navegador e permite aplicativos rápidos e em tempo real.
Para obter informações sobre operadores, funções e sintaxe de fórmulas, consulte Referência de funções .
Para obter mais informações sobre a sintaxe do construtor de fórmulas do OmniScript , consulte Criando
campos de fórmula em um OmniScript .
Referência de função
Você pode usar os seguintes operadores e funções em DataRaptors e Procedimentos de Integração.
Operadores suportados
Operadores lógicos:
&& E || OU > >= < <= = == != <> + - * / % ^
Corda operadores :
• LIKE — Verdadeiro se o lado esquerdo contiver o lado direito. Por exemplo, "ABC" LIKE "A" retorna
verdadeiro.

company
• NOTLIKE — Verdadeiro se o lado esquerdo não contém o lado direito. Por exemplo , "ABC" NÃO É COMO
"A" retorna falso.
• ~= — Executa uma comparação que não diferencia maiúsculas de minúsculas. Por exemplo, "ABC" ~= " abc
" retorna verdadeiro.
Certifique-se de incluir um espaço antes e depois de um operador.
Compatível Funções
Função _ Retornar _ Exemplo
abdômen Valor ABS(-1) retorna 1

absoluto
do
especifique
o número
d
ADICIONAR Adiciona o ADDDAY("1999-01-01",100) retorna "1999-04-11 00:00:00"

S especifique
d
número de
dias para
especificar
d data
e
retorna a
data
resultante
.
ADDM Adiciona o ADDMONTH("1999-01-01",100) retorna "2007-05-01 00:00:00"

ONTH especifique
d
número
do
meses
para
especificar
d data
e
retorna a
data
resultante
.
ADDIE Adiciona o ADDYEAR("1999-01-01",100) retorna "2099-01-01 00:00:00"

RA especifique
d
número
de anos
para
especificar
d data
e
retorna a
data
resultante
.

company
ERA Retorna a IDADE( Conta:Contato:Data de nascimento )
idade para o
especifique
d
data de
nascimento
e.
AGEON Para AGEON( Conta:Contato:Data de nascimento,HOJE ()) (o mesmo que IDADE).

especifique d
nascimento
e, retorna a
idade na
data
especificada
AVG Média da AVG(1,2,3,4,5,6,7,8,9,10) retorna 5,5

lista de
valores. Você pode usar o AVG em uma matriz JSON. Por exemplo, AVG( List:Item ) retorna 4 para os seguintes dados de
amostra:
{
" Lista ": [
{
"Artigo": 3
},
{
"Artigo": 4
},
{
"Artigo": 5
}
]
}
BASE Devoluções BASEURL()
RL a URL base
da
organização.
UMA
parâmetro
er não é
necessário
.
TETO Arredonda CEILING(2.5) retorna 3, que é 2.5 arredondado para o inteiro mais próximo.
G um
número
até o mais
próximo
inteiro,
um jeito
a partir de
zero se
negativo e.

company
CONCA Retorna o CONCAT( Contact:FirstName , " ", Contact:LastName )
T concatenar
tação do
especificar d
cordas .
CONTAR Devoluções COUNTQUERY( "SELECT COUNT() FROM Case WHERE AccountId = '{0}'", Id)
CONSULTA a
numero de
linhas
este
encontrar
a
ONDE
critérios da
cláusula.
Personalizado Executar CustomFunction ('Statistics. calcStdDev ', DataPoints )

Função n(' classe s é um
. metanfetamina personalizadas
od ' , entrada ) função definida
no
método de um
Apex
classe.
Ver
Amostra
Código Apex
para
Função
Personalizada .
_
Se a entrada
inclui uma
função LIST, o
LISTA
parte de
entrada é
salva em
a VLOC ITY-
FÓRMULA
ALIST k
ei . Ver
Lista
Entrada em
Personalizado
Função ns .

company
DATA Devoluções DATEDIFF("1900-01-01","2000-01-01") retorna 36524
FF a
número de dias DATEDIFF("2000-01-01","1999-01-01") retorna -36524
entre duas
DATEDIFF(Account:Cases:CreatedDate,TODAY()) retorna o número de dias que um caso foi aberto
datas
especificadas.
Se o
primeiro
data é maior que a
segunda data,
o valor é
retornado
como um
número
negativo.
DATA Converter para DATETIMETOUNIX('11/30/2016 07:15:34') retorna 1480490134000

METOU DateTi
NIX Eu
valor para
época
(a
número
do
segundos
decorridos
desde 1/1/197
0).
DESER Converter DESERIALIZE("{\"chave\":\"valor\"}")

IALIZAR( sa
Corda JSON retorna { "chave": "valor" }
) Corda
dentro de LIST(DESERIALIZE("[{\"chave\":\"valor\"},{\"chave2\":\"valor2\"}]"))
JSON retorna [ { "chave": "valor" }, { "chave2": "valor2" } ]
objeto. Se o
os dados são
na lista
formato,
use o
DESER
Função IALIZE
dentro da
função LIST
.

company
BAIXA Usar com ARRED(2,572, 2, BAIXO) retorna 2,57
REDONDO
para especificar
que o resultado
do
arredondamento
é
arredondado
baixa
(em direção a s
zero).
MOE Para uma data EOM(Conta:Casos:Data de Criação)

especificada,
retorna a data
do último dia do
mês.
EXIST( lista Devoluções EXIST(rentDwelling.dwBusUse, 'escritório')

de pesquisa , true se o valor
valor alvo ) de destino
especificado for
encontrado na
lista.
FILTRO Filtrar um FILTER(LIST(InputList), 'Sobrenome == "Smith"')

lista de
JSON FILTER(LIST(data(PromotionProducts), 'productCode == "' + ConnectionProdCode + '"')
objetos
e
retorne o
subconjunto
este
match é o
Especificadas
condições.
Suporte apenas
para edição
por
DataRa
ptor Transforma
rms.
PISO Retorna um FLOOR(2.5) retorna 2, que é 2.5 arredondado para o inteiro mais próximo.
número
arredondado
para o mais
próximo
inteiro,
em direção
zero se
negativo e.

company
FORMA Aceita uma FORMATDATETIME("2019-02-02T00:00:00")
DATA data ou
TEMPO datetime e FORMATDATETIME("2018-12-30T00:00:00.000000Z","aaaa-MM-dd'T'HH:mm:ss.SSSZ")
SObject
campo ou
uma string de
data e hora
e
retorna
uma
formato d data
e string. Uma
linha
entrada deve
estar em um
destes
formatos:
• 02-02-2019
T00:0 0:00
• 30-12-2018
T00:0 0:00.
0000
00Z
Você pode
fornecer
um
saída opcional
parâmetro de
formatação
usando Simple
DateFor
esteira
notação
.
Especificando
GMT
vezes é
recomendado.
Estes são
convertidos
para o usuário

company
fuso horário.
o
a hora
padrão é
00:00:0 0
GMT. o
predefinição
data é 01-01-1
970, então
especificando
um completo
e data
é
fortemente
recomendado.

company
FORMA Formata FORMATDATETIMEGMT("2018-12-30T00:00:00.000000Z","América/Nova_York","aaaa-MMdd'T'HH :mm:ss.SSSZ")
DATA dados de
TIMEG data e hora
MT Como
FORMA
TDATE TIME
faz, mas
também
converte s do
fuso horário
especificado
para GMT.
Se nenhum
nome de fuso
horário
parâmetro
er for
especificado,
o padrão é o
fuso horário
do usuário
atual. Para
uma lista de
nomes de
fusos
horários,
consulte o
Lista de
tz
bancos de dados
e fusos
horários
Wikiped ia
página.
Se nenhum
formato de
saída
parâmetro
er é
especificado
d, o formato
de saída
padrão
é aaaa-
MILÍMETROS-
dd'T'HH :mm:ss.
SSSZ.

company
METADE_ Usar com ROUND(2,575, 2, HALF_DOWN) retorna 2,57
BAIXA REDONDO
para especificar
que o resultado
do
arredondamento
é
arredondado
arredondado para
o mais próximo
vizinho (para
cima ou para
baixo), a menos
que os vizinhos
sejam
equidistantes
formiga, em que
caso ele arredonda
para baixo.

company
METADE_ Usar com ROUND(2,57, 1, HALF_EVEN) retorna 2,6, que é arredondado para a casa decimal mais próxima.
ATÉ REDONDO
para especificar
que o resultado
do
arredondamento
é
arredondado
arredondado para
o mais próximo
vizinho (para
cima ou para
baixo), a menos
que os vizinhos
sejam
equidistantes
formiga, em que
caso isso
arredonda para
o par mais
próximo
vizinho
r.
Comportar-se
s como para
REDONDO
METADE_
UP se o dígito
para o
esquerda do
descarte
ed
fração
é estranho;
comportar-se
como para
REDONDO
MEIO_ BAIXO
se for mesmo.

company
METADE_ Usar com ROUND(2,575, 2, HALF_UP) retorna 2,58
ACIMA REDONDO
para especificar
que o resultado
do
arredondamento
é
arredondado para
o mais próximo
vizinho (para
cima ou para
baixo), a menos
que os vizinhos
sejam
equidistantes
formiga, em que
caso ele
arredonda para
cima.
GENER Gera uma chave GERAR CHAVE GLOBAL(SUB)

ATEGL global que pode
OBALK ser usada como Retorna um valor como SUB-4c6aaba3-88e4-13f3-fe07-afa756f31e92
EY um Id em
um DataPa
k. Se
vocês
incluir
um
opcional
parâmetro
é, é
prefixado à
chave.

company
SE ( Avalie o IF(InputDate < "2000-01-01", "Século 20", "Século 21")
expressão expressar
íon. Se for IF(telefones:marca == "Apple", telefones:nome, null)
,
trueResult , verdade,
IF(SUBSTRING(preço,0,1) == "$", SUBSTRING(preço,1), preço)
falseResult ) retorna
o primeiro IF(DriverAge >= 25,IF(FriendsReferred >= 2, true, false),IF(GPA >= 3.0, true, false))
valor do
resultado, se
falso, retorna
o segundo.
Você pode
use SE
para filtrar
uma lista.
O segundo
exemplo de
filtros
uma entrada
lista de
telefones
para um
resultado
lista de
apenas
telefones da
Apple.
o
terceiro
exemplo
remover
é um
inicial
cifrão se for
é presente,
deixando
um
número
que pode ser
usado
nos cálculos.
o
quarto
exemplo
demônios
trata o
aninhamento
da função SE
s.

company
Motoristas
abaixo
25
qualificar
para
desconto
t se
eles são
bons
alunos e
motoristas
acima de 25
qualificam-
se se
referirem
dois ou mais
amigos.

company
InvokeI Chama um Integrati InvokeIP ('Auto_Renewal', INPUT('assetId', 123456), 'AnOutPutKey')
P em Procedido
(' IP_Na ura para fórmula
eu ', INPUT(' s com casos de
Chave ', uso x
Valor ), completos.
INPUT('
Pega o 'IP_Na
Chave ',
me' no
Valor ). formato Type_S
.., ubType.
' Chave de
saída ') Leva
um ou mais
INPUT('Key',Val
ue) pares
como entradas
para o Integrati
em Processo.
o
'Chave de saída' é
a resposta IP
Saída de ação
Chave JSON
para obter o
valor g
resultante.
ISLAN Devoluções ISBLANK('Marty') retorna falso

K verdade se o
argumentar
não é
em branco,
falso se não for.
NÃO É Devoluções ISNOTBLANK('Marty') retorna verdadeiro

EM BRANCO verdade
se o
argumento
n não é
em branco,
falso se for.

company
LISTA Encapsula
a
argumentar
n como um
list, para
chamar
funções
que
requerem
entrada em
formato de
lista.

company
LISTME Mescla qualquer LISTMERGE("Id", LIST(Contas Atuais), LIST(Contas Arquivadas), LIST(Contas Prospectivas))
RGE(" m número
erge_k ey1 de listas,
"[,... combinar
" merge ng
keyN "], LIST( entradas
Li st1 ), ... quando
os valores das
LISTA( Li stN
chaves
))
especificadas
correspondem
s.
Especifique
as chaves
como um
vírgula-
separar
lista de edição
de nomes-
chave citados,
e
especificamos
listas
usando a
LISTA
função
. Se as listas
contiverem
idênticas
ly-
nomeado
nós
que contêm
diferentes
valores, valores
subseq uentes
sobrescritos
e valores
anteriores no
resultado
Lista. A saída
contém
s todas as chaves
de todas as
listas.

company
LISTME Identica LISTMERGEPRIMARY("Nome,Sobrenome", LIST(ListMerge1), LIST(ListMerge2), LIST(ListMerge3))
RGEPR eu para
IMARY( LISTME RGE,
" mesclar exceto que o
_key1 "[ resultado
,..." me Lista
gekeyN contém s
"], apenas as
LISTA( Li st1 chaves da
), ... primeira lista.
Útil,
LISTA( Li stN
por
))
ex., quando
você
tenha um
lista de
qualificar
d produto
s que
você
quer
aumentar
t com
dados de
relacionados
listas, mas
você não quer
nenhum
produto do
relacionado
listas
adicionado
à saída.
LISTSI Devoluções LISTA(6,7,8,9,10) retorna 5

ZE a
número Você pode usar LISTSIZE em uma matriz JSON. Por exemplo, LISTSIZE(NameList) retorna 3 para os seguintes dados de
de itens exemplo:
da lista.
{
Para "Lista de nomes": [
testar um {
vazio "Nome": "Aarão",
listar, usar "Sobrenome": "Xavier"
o ISBLAN },
K {
função "Nome": "Zellie",
. "Sobrenome": "Xavier"
},
{
"Nome": "Mike",
}
]
}

company
MÁX. Valor MAX(1,2,3,4,5,6,7,8,9,10) retorna 10
máximo
em uma lista Você pode usar MAX em uma matriz JSON. Por exemplo, MAX(List:Item) retorna 5 para os seguintes dados de amostra:
de valores
{
numéricos.
"Lista": [
{
"Artigo": 3
},
{
"Artigo": 4
},
{
"Artigo": 5
}
]
}
MAXST Retorna a MAXSTRING("Amy","Ziggy") retorna "Ziggy"
ANEL última
string em
ordem
alfabética.
MIN Retorna o MIN(1,2,3,4,5,6,7,8,9,10) retorna 1

mais baixo
em uma Você pode usar MIN em uma matriz JSON. Por exemplo, AVG(List:Item) retorna 3 para os seguintes dados de amostra:
lista de
{
valores
"Lista": [
{
"Artigo": 3
},
{
"Artigo": 4
},
{
"Artigo": 5
}
]
}
MONTE Devoluções MONTH("1999-01-11") retorna 1

H a
mês
da data
especificada
como um
número
inteiro.
NOTAX Devoluções NOTEXIST(rentDwelling.dwBusUse, 'escritório')
IST( se archLi true se o
st , valor valor de
alvo ) destino
especificado
não for
encontrado
na lista.

company
AGORA Retorna a AGORA()
data atual
e NOW("aaaa-MM-dd'T'HH:mm:ss.SSSZ")
hora no
fuso
horário do
usuário.
Você pode
fornecer
um
opcional
parâmetro
de
formatação
usando
https: //docs.or
acle.co
m/
java/ 7/
documentos/ap
i/java/ texto/
Data Simples
Para mat.htm
eu
notação
.
Você pode
usar
AGORA
para
especificar
datas e
horas
relativas à
data e
hora
atuais.

company
ORDER Retorna o ORDERITEMATTRIBUTES(80146000002I7dO)
ITEMAT atributo s do
TRIBUT ES ( item do pedido
ID do item em pares de
do pedido ) valores-chave.
OrderIte mId
deve ser
especificado
como
parâmetro.
Formato de saída:
Lista<Ma
p<String,Objeto>>
CONSULTA Executar QUERY ("SELECT Name FROM Account WHERE BillingState ='CA'")
sa
SOQL Você também pode passar valores. Por exemplo:
perguntar isso
QUERY( "SELECT AccountId FROM User WHERE Id = '{0}'",$Vlocity.UserId )
retorna
um JSON
lista de valores.
A consulta não
pode
recuperar
mais de uma
coluna.

company
RESERVATÓRIO Equivalente Consulte Ação Remota para Procedimentos de Integração .
IALIZAR( ent para
Corda SERIAL
) IZE(DE
SERIAL
IZE()). Converta
os dados de s
em
Mapa genérico<St
anel,
Objeto>
formato. Útil
em
Controlo remoto
Ações para
converter a
saída da classe
Apex para que
os
procedimentos
de integração
e DataRa
ptors podem
aceite isso.

company
ROUN Arredonda o REDONDO(3,1415 * 3) = 9,42
D Especificadas
número ARRED(3,1415 * 3, 0) = 9
ou expressão. Por
padrão, os
resultados são
arredondados
para duas casas
decimais, mas
você
posso
especifique o
desejado
número
de casas decimais
para o resultado.
Você também
pode usar o UP,
BAIXA,
METADE_
ACIMA,
MEIO_ BAIXO e
MEIO_ MESMO
parâmetros para
refinar o
arredondamento
dos resultados.

company
SERIAL IZE( Converter SERIALIZE({ "chave": "valor" }) retorna
js onObje ct sa
) Objeto JSON "{\"chave\":\"valor\"}"
dentro de
SERIALIZE(LIST([ { "chave": "valor" }, { "chave2": "valor2" } ])) retorna
JSON
corda. Se os "[{\"chave\":\"valor\"},{\"chave2\" :\"valor2\"}]"
dados
está na lista
formato,
use a
função LIST
dentro
a função
SERIAL
IZE.
Observe
como
difere de
TOSTRI NG.

company
SORTB Classificar um SORTBY(LIST(NameList), 'LastName', 'FirstName')
S lista de
JSON Dados de amostra:
objetos
{
por
"Lista de nomes": [
especificar
{
nós. Por
"Nome": "Aarão",
padrão,
"Sobrenome": "Xavier"
execute
},
uma
{
classificação
"Nome": "Zellie",
crescente.
"Sobrenome": "Xavier"
Ordenar
},
descendente,
especifique {
"Nome": "Mike",
:DSC .
Suporte "Sobrenome": "Smith"
}
apenas para
]
edição
por }
DataRa
ptor
Transforma
rms.
Sintaxe:
SORTB
Y(LIS
T( Lista de
Entrada ),
' chave1 '
,
' chave2 '
...,
[:DSC]
)
SQRT Calcule o SQRT(12 * 3) retorna 6

quadrado
raiz de um
valor.

company
STRIN Retorna a STRINGINDEXOF("Este é o teste String","teste") retorna 12
GINDE XOF( posição
St ring , índice de
substring ) uma
substr
em dado
Corda
.o
primeiro
posição é
zero. Se o
substr
ing não
estiver
presente,
o valor
retornado
é -1.

company
SUBST RING( Retorna a Os exemplos a seguir operam nesta entrada:
String , parte do
startIndex , Corda { "input": "A rápida raposa marrom pulou sobre o cachorro preguiçoso." }
endInde que começa
SUBSTRING(entrada) retorna a String inteira
x) no
startI ndex e SUBSTRING(entrada,32) retorna "o cachorro preguiçoso".
termina no
endInd ex . SUBSTRING(entrada,"preguiçoso") retorna "cachorro preguiçoso".
Os opcionais
startI ndex e SUBSTRING(entrada,0,9) retorna "O rápido"
endInd ex
SUBSTRING(entrada,10,19) retorna "raposa marrom"
podem ser
Strings ou SUBSTRING(entrada,"q","n") retorna "pesquisa rápida"
inteiros.
Para
números
inteiros, o
primeiro
posição é
zero. Se o
começo eu
ndex não foi
encontrado,
a primeira
posição é
usada. Se o
endInd ex
não foi
encontrado,
a última
posição é
usada.
SOMA Devoluções SOMA(1,2,3,4,5,6,7,8,9,10) retorna 55

a soma
de uma lista de Você pode usar SUM em uma matriz JSON. Por exemplo, AVG(List:Item) retorna 12 para os seguintes dados de
valores. amostra:
{
"Lista": [
{
"Artigo": 3
},
{
"Artigo": 4
},
{
"Artigo": 5
}
]
}

company
HOJE Retorna a data de HOJE()
hoje.
HOJE("aaaa-MM-dd'T'HH:mm:ss.SSSZ")
Você pode
usar ADDDAY(EOM(ADDMONTH(TODAY(),-1)),1) retorna o primeiro dia do mês atual
HOJE
ADDDAY(EOM(ADDMONTH(TODAY(),0)),1) retorna o primeiro dia do próximo mês
especificar
datas CONCAT(YEAR(ADDYEAR(TODAY(),1)),"-01-01") retorna o primeiro dia do próximo ano
em relação à
data atual.
TOSTRI Converta TOSTRING(3.0) retorna "3.0"

NG( dat qualquer
a) entrada em TOSTRING([4,5]) retorna "4,5"
uma String
TOSTRING({ "chave": "valor" }) retorna "{chave=valor}"
literal.
TOSTRING([ { "chave": "valor" }, { "chave2": "valor2" } ])
Observação
retorna "{chave=valor }, {chave2=valor2}"
como é
difere de SERIAL
IZE em
o caminho
isto
converter s
dados JSON.
UNIXD Dado um Unix UNIXDATETOTIME('1480490134000') retorna

ATETO valor de época, "2016-11-30T07:15:34.000Z"
TEMPO retorna o
DateTime
correspondente.
ACIMA Usar com ROUND(2,572, 2, UP) retorna 2,58

REDONDO
para especificar
que o resultado
do
arredondamento
é
arredondado
para cima
(distante de
zero).

company
VALOR Retorna o Para os seguintes dados de entrada de amostra:
PROCURAR valor de um
P( Star tNode JSON {
, nó "Dados": {
referenciado "Nome": {
NodeVar ,
por outro "Nome": "Thomas",
NodeVa
Nó JSON. este "MiddleName": "Alva",
r ,,,)
permite que "LastName": "Edison"
você }
dinamismo },
especifique "GetGroup": "Nome",
o nó do qual "GetField": "Nome"
recuperar. }
o VALUELOOKUP(Dados, GetGroup, GetField) retorna "Thomas"

O parâmetro
StartN ode VALUELOOKUP(Data:Name, GetField) também retorna "Thomas"
deve ser um
VALUELOOKUP(Data, GetGroup) retorna o conteúdo de Name
codificado
nó. Pode ser
um caminho
como
Data:Name.
Cada
O parâmetro
NodeVar
deve ser um
nó de entrada
com o nome de
outro
nó como
seu valor.
Se mais de
um NodeVa
ré
especificado,
o anterior
NodeVar
define

company
o nó inicial
para o
próximo
NodeVa
r . Você pode
recuperar
qualquer
número
de níveis.
ANO Retorna o ANO("1999-01-11") retorna 1999

ano da data
especificada
como um
número
inteiro.
Exemplo de código Apex para uma função personalizada

Uma classe do Apex implementa uma função de cliente contendo métodos para uma função SPLIT() e uma
função SUM() . Observe que a classe e invokeMethod devem ser globais. Observe também o uso do
namespace na referência da interface.
classe global CustomFunctionImplementation implementa

vlocity_cmt.VlocityOpenInterface
{
/*
entradas - argumentos - Lista<Objeto> de argumentos passados saída - resultado - O resultado da
Função que está sendo chamada. Apoia
valores de objeto único, List<Object> ou Map<String, Object>
*/
global Boolean invokeMethod(String methodName, Map<String, Object> entradas,
Saída Map<String, Object>, opções Map<String, Object>)
{
// SUM Retorna um único valor if (methodName
== 'sum')
{
List<Object> argumentos = (List<Object>)inputs.get('arguments');
output.put('resultado', sum(argumentos));
}
/*
Split Retorna um Map<String, Object de valores. Nem todas as funções
será capaz de manipular os resultados de Map<String, Object>,
portanto, tenha cuidado ao usar essas funções.
Em uma etapa DataRaptor Transform retornando um Map<String, Object>
de uma Fórmula resultará na aplicação desse Mapa ao
Dados JSON no FormulaResultPath. Veja https://
vlocity.atlassian.net/wiki/display/RAP/Transforms
*/
senão se (methodName == 'split')
{
List<Object> argumentos = (List<Object>)inputs.get('arguments');
output.put('resultado', split(argumentos));
company
}
retorne verdadeiro;
}
Double sum(List<Object> argumentos)
{
Resultado duplo = 0;
for(Object token: argumentos)
{
if (token != null)
{
resultado += (Duplo) token;
}
}
retorno resultado;
}
Map<String, String> split(List<Object> argumentos)
{
Map<String, String> resultado = new Map<String, String>();
String toSplit = (String)arguments[0];
Separador de String = (String)argumentos[1];
List<> splitList = toSplit.split(splitter); for (Integer i = 0; i < splitList.size(); i++)
{
if (argumentos.size() > i+2)
{
result.put((String)arguments[i+2], splitList[i]);
} senão
{
result.put('Split'+i, splitList[i]);
}
}
retorno resultado;
}
}
Listar entrada em funções personalizadas

Se uma entrada para sua função personalizada for do tipo List<Object> , a entrada será salva em uma chave
VLOCITYFORMULA-LIST . Para recuperar a entrada, use o código que recupera essa chave.
Por exemplo:
static List<Map<String, Object>> CUSTOMFUNCTION(List<Object> inputs)
{
List<Object> listInput = ((Map<String, Object>)inputs[0]).get('VLOCITY-
LISTA DE FÓRMULA');
Objeto variávelInput = inputs[1];
// Resto da Função
}

company
O OmniStudio Tracking Service é um serviço de rastreamento de eventos que captura detalhes das ações que
os usuários realizam. Você pode usar o serviço para rastrear qualquer tipo de evento. Por exemplo, você pode
OmniStudio Tracking Service

acompanhar o tempo que leva para concluir as etapas em um OmniScript para identificar melhorias no
processo.
O Serviço de Rastreamento grava dados no objeto de Entrada de Rastreamento: VlocityTrackingEntry__c . Os

componentes OmniStudio, incluindo OmniScripts , Cards Framework e Integration Procedures , podem chamar
o Serviço de Rastreamento. O objeto Tracking Entry contém os campos personalizados para garantir que o
serviço funcione e você pode adicionar campos para armazenar dados adicionais que deseja rastrear.
A classe Vlocity Tracking Service recebe dados JSON e os grava no objeto Tracking Entry. A classe cor responde
as chaves JSON aos nomes de campos personalizados do Salesforce e grava os valores JSON nos valores dos
campos. Por
exemplo, a classe grava o valor mantido na chave JSON ElapsedTime no campo personalizado ElapsedTime__c
.
Este diagrama mostra como um OmniScript pronto para uso usaria o Serviço de Rastreamento.
Ativar rastreamento para componentes do OmniStudio

Você pode habilitar o rastreamento para componentes do OmniStudio configurando acionadores.
Para configurar acionadores para campos personalizados, consulte Rastreamento de eventos para
campos personalizados .
company
4. Insira uma das seguintes configurações no campo Rótulo . (O nome padrão é o mesmo valor.)
Tipo de componente Vlocity Nome do gatilho
OmniScripts Track_OmniScript
Procedimentos de Integração Track_IntProc
FlexCards Track_CardFramework
Track_CardPreview
Você pode habilitar o rastreamento de eventos específicos de tipos de componentes específicos. Por
exemplo, para habilitar apenas eventos StepActionTime para OmniScripts, crie um gatilho
Track_OmniScript_StepActionTime .
Você pode habilitar o rastreamento para procedimentos de integração específicos usando um gatilho do
formato
Faixa_ Tipo _ Subtipo . Por exemplo, se o Tipo for CheckContact e o SubType for CreditScore, o nome do
gatilho será Track_CheckContact_CreditScore . Quando um Procedimento de Integração chama outro e
você ativa o rastreamento apenas no Procedimento de Integração chamado, os eve ntos no Procedimento
de Integração chamado também são rastreados.
5. No campo Valor , digite true .
7. Repita as etapas 3 a 6 para cada acionador que deseja adicionar.
Acompanhamento de eventos de componentes do OmniStudio

Os dados de rastreamento são armazenados no objeto VlocityTrackingEntry__c . Alguns dados, listados aqui,
são rastreados para todos os componentes e tipos de eventos. Você também pode adicionar campos
personalizados aos dados que estão sendo rastreados.
NOTA
Se você rastrear uma grande quantidade de dados, gerencie o consumo de espaço implementando
uma política de arquivamento para o objeto de rastreamento.
Os seguintes dados são rastreados para todos os eventos:
• Evento ou nome de rastreamento: tipo de evento, por exemplo StepActionTime ou Error

• ID do usuário: usuário que acionou o evento
• Context Id: o valor do nó Context Id no Data JSON
• Dados: JSON de dados da chamada de rastreamento
• Mensagem de interação
• Token de sessão do Salesforce: token de sessão do Salesforce levemente mascarado para o usuário
• Token de interação com o cliente: identificador exclusivo para eventos registrados para uma única sessão
• Timestamp: Hora do evento
• Serviço de rastreamento: o serviço que registrou o evento
• Recurso de acuidade de Vlocity: recurso de inteligência
company
• Interação Vlocity: ID de interação
• Token de Interação Vlocity: Token exclusivo usado como identificador para associar eventos registrados
para uma única sessão.
Veja também
• ???
• Acompanhamento de eventos OmniScript
• Acompanhamento de eventos do procedimento de integração
• Dados de acompanhamento de eventos para estrutura de cartões
• Acompanhamento de eventos para campos personalizados
Acompanhamento de eventos OmniScript

Para OmniScripts, os eventos a seguir são rastreados. Para eventos de resultado, os eventos SaveForLater e
Cancel do usuário são registrados por padrão. Para configurar o valor registrado para uma ação Concluída,
defina sua propriedade Resultado.
Evento Dados rastreados
StepActionTime • Id OmniScript: A Id do OmniScript__c sObject que contém a definição OmniScript

• ID de contexto: valor de ID de contexto do JSON de dados do OmniScript
• Tipo de OmniScript
• Subtipo OmniScript
• Linguagem
• Tipo de elemento
• Nome do elemento
• Rótulo do elemento
• Número da Etapa do Elemento
• Tempo decorrido
Resultado • Tempo decorrido
• Rótulo do elemento
• Nome do elemento
• Número da Etapa do Elemento
• ID de contexto OmniScript
• ID do OmniScript
• Linguagem OmniScript
• OmniScrip tSubType
• Tipo de OmniScript
• Resultado: Cancelar, Salvar ou o resultado configurado para um elemento de ação Concluído.
• TrackingEvent: Resultado
Acompanhamento de eventos do procedimento de integração

Para Procedimentos de Integração, os eventos a seguir são rastreados. Quando um Procedimento de
Integração chama outro e você ativa o rastreamento apenas no Procedimento de Integração chamado, os
eventos no Procedimento de Integração chamado também são rastreados.
Para rastrear eventos de procedimentos de integração específicos, consulte Habilitar rastreamento para
componentes do OmniStudio .
Evento de rastreamento Dados rastreados

company
Todos os eventos do procedimento de • CpuTotal
integração • DMLRowsTotal
• DMLStatementsTotal
• HeapSizeTotal
• OmniScriptId: O Id do OmniScript__c sObject que contém a definição do
Procedimento de Integração
• Tipo OmniScript
• OmniScriptSubType
• Versão OmniScript
• ParentInteractionToken: O VlocityInteractionToken do OmniScript ou Procedimento de
Integração de pai de chamada.
• Total de consultas
• ConsultaRowsTotal
• SoslQueryTotal
• TestBatchUniqueKey: identificador para um grupo de teste invocado em conjunto, com sufixo de
visualização ifrun em visualização, incluído apenas para procedimentos de teste
• TestUniqueKey: identificador para uma única invocação de teste, incluído apenas para
procedimentos de teste• TrackingService: definido como IntProc
Eventos de procedimento de teste se • Erro de código
OmniAnalyticsTrackingDebug é verdadeiro • Mensagem de erro
• Ocorreu um erro
• Solicitar carga útil
• Carga de resposta
Afirmar • assertFormula Condicional

• assertFailureMessage
(Apenas rastreado para procedimentos de teste)
• assertResult
• ElementName
• StepDebugInfo: incluído se a configuração personalizada OmniAnalyticsTrackingDebug estiver
definida como true
• variableData: dados que são comparados com a assertConditionalFormula
Erro • Ação
• assertConditionalFormula: incluído apenas para procedimentos de teste
• assertFailureMessage: incluído apenas para procedimentos de teste
• assertResult: incluído apenas para procedimentos de teste
• ErrorTime
• StepDebugInfo: incluído se a configuração personalizada OmniAnalyticsTrackingDebug estiver
definida como true
• variableData: dados que são comparados com assertConditionalFormula, incluídos apenas para
procedimentos de teste
StepActionTime • Tempo decorrido
• ElementName
• ElementResult
• ElementStepNumber
• StepResult
Resultado do teste • TestStatus: Sucesso ou Falha
(Apenas rastreado para procedimentos de teste)
Adicionar dados de depuração ao acompanhamento de eventos do procedimento de

teste
Quando você executa um procedimento de teste na guia Visualização, os dados JSON para depuração são
incluídos no painel Erros/saída de depuração. Para incluir esses dados de depuração nos registros do objeto
VlocityTrackingEntry__c no nó StepDebugInfo JSON, você pode definir o valor da configuração personalizada
OmniAnalyticsTrackingDebug como True .

company
4. No campo Rótulo , digite OmniAnalyticsTrackingDebug .
5. No campo Valor , digite True .
Acompanhamento de eventos da estrutura de cartões

O OmniStudio Tracking Service é um serviço de rastreamento de eventos que pode capturar detalhes sobre
como os usuários do Vlocity interagem com o Cards Framework.
Visualize o acompanhamento de eventos no Designer de cartões
Normalmente, os administradores que estão rastreando gatilhos do Cards Framework desejam rastrear apenas
eventos de tempo de execução. O Cards Framework inclui um gatilho Track_CardPreview para entradas de
rastreamento do Card Designer Preview, que você pode desabilitar para excluir eventos de visualização.
NOTA
Se sua organização não incluir o gatilho Track_CardPreview , você poderá criá-lo. Consulte Ativar
rastreamento para componentes do OmniStudio .
Estado do gatilho Track_CardPreview na configuração do gatilho de Rastreamento de entradas geradas para o Card Designer
configurações personalizadas Visualizar
Ausente Não
Presente, mas desligado Não
Presente, mas o gatilho Track_CardFramework está ausente ou desativado Não
Ativado, e o gatilho Track_CardFramework também está ativado Sim
Dados de acompanhamento de eventos para estrutura de cartões

Para o Cards Framework, os eventos rastreados são OmniAnalytics Card Events, initTracking,
initCardFramework, initLayout, selectCard, performAction, trackField e Resolution.
Os seguintes dados são registrados para todos os eventos do cartão:
• Token de sessão do Salesforce

• Token de interação Vlocity
• ID do usuário
• Carimbo de data e hora
A tabela a seguir lista eventos e dados específicos de eventos registrados para interação do usuário com o
Cards Framework:
Evento Dados rastreados
initTracking ID de contexto
initCardFramework ID de contexto
initLayout • Nome do cartão

• ID de contexto
• Informações do layout
• Nome do layout
• Versão do layout

company
selecioneCartão • EU IRIA
• ID do tópico de
interação
• Nome
• Segurado
executar a ação • ID de contexto
• EU IRIA
• Código de interação
• Função
pista • Tempo decorrido

• EntityLabel
• Nome da entidade
• Valor do campo
Resolução Nenhum
(Fim do rastreamento)
Acompanhamento de eventos para campos personalizados

Para Procedimentos de Integração, FlexCards e OmniScripts, você pode adicionar seus próprios campos
personalizados aos dados armazenados pelo Serviço de Rastreamento.
O nome do campo personalizado, menos o __c à direita , deve corresponder à chave do nó correspondente no
JSON de dados de entrada. Por exemplo:
• Campo personalizado adicionado ao objeto VlocityTrackingEntry__c : MyTrackingField__c

• Chave JSON de dados correspondente: MyTrackingField
Adicione os pares de chave/valor JSON à lista de dados personalizados de rastreamento no componente. Esta
lista está localizada:
• No painel de configuração do FlexCard

• Na Configuração do Procedimento do Procedimento de Integração
• Na configuração de script do OmniScript
NOTA
Se o espaço for uma preocupação, certifique-se de monitorar o tamanho do objeto de
rastreamento e excluir registros desnecessários conforme necessário.
ID de interação da sessão de rastreamento

Para associar todos os eventos rastreados para uma única sessão, o sistema de rastreamento registra um ID de
interação exclusivo para a sessão. Para fornecer esse ID de um OmniScript ou Procedimento de integração,
adicione um par de chave/valor ao campo Rastreamento de dados personalizados na seção Configuração.
Por exemplo:
CustomerInteractionId: %InteractionId%
Para fornecer o ID de interação em uma chamada REST, especifique-o como um parâmetro:
/apex/DFOmniScriptUniversalPageConsole?id={0}&OmniScriptType=Política
%20Servicing&OmniScriptSubType=Pagamento
company
%20Extension&OmniScriptLang=Inglês&scriptMode=vertical&layout=relâmpago&Contex
tId={0}&InteractionId={1}&Role={2}
Pré-processador de dados de rastreamento

Antes que o serviço de rastreamento execute sua própria lógica, ele chama qualquer implementação de
interface chamada TrackOmniScript ou TrackCard , permitindo que você pré-processe os dados de
rastreamento. Por exemplo, essa implementação usa o ID do cliente enviado por um OmniScript para
adicionar detalhes do cliente aos dados do evento.
classe global VlocityDemoTrackOmniscript implementa

vlocity_cmt.VlocityOpenInterface {
global Boolean invokeMethod( String methodName, Map<String,Object> inputMap, Map<String,Object>
outMap, Map<String,Object> options ) {
Sucesso booleano = true; erros de string = 'OK';
tentar {
if( methodName == 'processTracking' ){ processTrackingEvent( (List<Map<String,
Object>>)inputMap.get('trackingDataList'), outMap );
}
} catch ( Exceção e ) { errors = e.getMessage();
sucesso = falso;
System.debug( '##### erros: ' + erros );
}
retorne verdadeiro;
}
/**
* Processe os eventos de rastreamento
*/
void processTrackingEvent( List<Map<String, Object>> trackingDataList, Map<String, Object>
outMap ){ // Obtém o ID dos usuários atuais do JSON de entrada...
Id userId = (Id)trackingDataList[0].get('UserId'); // Obter os detalhes dos usuários
para adicionar aos dados de rastreamento...
User currentUser = [SELECT Id, FirstName, LastName, Profile.Name,
UserRole.Name FROM User WHERE Id = :userId];
// Iterar pelas entradas de rastreamento e adicionar os detalhes do usuário... for ( Map<String, Object>
trackingEvent : trackingDataList ){ trackingEvent.put( 'UserFirstName', currentUser.FirstName );
trackingEvent.put( 'UserLastName', currentUser.LastName ); trackingEvent.put( 'UserProfile',
currentUser.Profile.Name ); trackingEvent.put( 'UserRole', currentUser.UserRole.Name );
}
outMap.put( 'trackingDataList', trackingDataList );
}
}

company
Aproveite a abordagem declarativa de 'cliques, não código' da Vlocity para criar e modificar seus aplicativos
com os componentes da Web OmniStudio Vlocity Lightning. Com o OmniStudio Vlocity Lightning Web
OmniStudio Lightning Web Components

Components, use JavaScript e HTML padrão para modificar e estender os produtos Vlocity.
Os componentes da Web do OmniStudio Vlocity Lightning são:
• Rápido e Leve. É executado nativamente em navegadores e é independente de estruturas JavaScript.

• Reutilizável. Os componentes da Web do OmniStudio Vlocity Lightning usam componentes da Web para
criar elementos HTML personalizados reutilizáveis. Os elementos personalizados envolvem a
funcionalidade, protegendo os componentes de outros estilos e scripts na página.
Embora alguns componentes da web do OmniStudio Vlocity Lightning apareçam na Comunidade e nos App
Builders, eles diferem dos componentes do OmniStudio Vlocity Lightning que também aparecem nos builders.
Os componentes da Web do Vlocity Lightning seguem os mesmos padrões dos componentes da Web do
Lightning do Salesforce. Para obter mais informações sobre os padrões do Lightning Web Component, consulte
Lightning Web Components .
Referência de componentes da Web do OmniStudio Vlocity Lightning

Tipo de Descrição Referências
componente
Base Componentes básicos usados por toda a plataforma Vlocity. Estenda ou ReadMes: LWC de base Vlocity ReadMe
modifique os componentes básicos para personalizar a aparência e o Referência
comportamento.
OmniScript Componentes específicos do OmniScript. ReadMes: OmniScript ReadMe
Referência
NOTA
Os OmniStudio FlexCards são criados com o modelo de programação Lightning Web Components e
compartilham componentes básicos. Os FlexCards são criados no FlexCard Designer .
Configurar componentes da Web do Lightning

Para gerenciar e desenvolver componentes da Web do Vlocity Lightning, use o Salesforce DX com Visual Studio
ou IDX Workbench com Visual Studio. Ambas as abordagens de desenvolvimento têm controle de origem. No
entanto, recomendamos o IDX Workbench porque ele permite migrar componentes do Vlocity de uma
organização para outra e comparar os arquivos de origem e de destino.
• Para gerenciar e desenvolver seus LWCs com o Salesforce DX, consulte Configurar seu ambiente de
desenvolvimento .
• Para gerenciar e desenvolver seus LWCs com o IDX Workbench, consulte IDX Workbench Desktop
Application .
Estender os componentes da Web do Vlocity Lightning

Personalize o comportamento e o estilo de um aplicativo estendendo os componentes da Web do OmniStudio
Vlocity Lightning. Por exemplo, substitua propriedades, adicione outros componentes ou insira HTML.

company
NOTA
Os componentes Web personalizados do Lightning criados fora do pacote não podem usar nenhum
componente Web do Salesforce Lightning que use recursos do Salesforce ou afete o componente em
tempo de execução. Para obter mais informações, consulte Módulos do Salesforce .
NOTA
Os componentes Web personalizados do Lightning não gerarão erros, a menos que o Modo de
1. Certifique-se de ter o IDX Workbench ou o Salesforce DX configurado localmente. Para obter informações
sobre como configurar o IDX Workbench ou o Salesforce DX, consulte Configurar componentes da Web
do Lightning .
2. Escolha qual componente você deseja estender. Para obter uma lista de componentes da Web do
Lightning, consulte Componentes da Web do Lightning do OmniStudio .
3. Para criar um novo componente da Web do Lightning, navegue até a pasta lwc em seu projeto e execute
o comando force:lightning:component:create SFDX. Por exemplo:
sfdx force:lightning:component:create --type lwc --componentname componentname_extended
Para saber mais sobre como criar um componente da Web do Lightning, consulte Criar componentes da
Web do Lightning . Para obter uma lista completa de comandos SFDX disponíveis, consulte Comandos do
Lightning .
4. Em seu arquivo JavaScript, importe e estenda o componente Web do Lightning. Veja o exemplo de código
nesta página.
5. Para tornar o componente da Web personalizado do Lightning compatível com os componentes da Web
do OmniStudio Vlocity Lightning, você deve definir duas tags de metadados em seu arquivo de
configuração XML:
• Adicione o namespace do seu pacote OmniStudio Vlocity usando a tag de metadados
runtimeNamespace . Veja o exemplo de código nesta página. Para obter mais informações sobre como
localizar o namespace do seu pacote, consulte Visualizando o namespace e a versão do pacote
• Defina a tag de metadados isExposed como true. Veja o exemplo de código nesta página.
6. (Opcional) Habilite um componente Web do Lightning personalizado para fazer chamadas remotas
usando o utilitário Common Action. Para obter mais informações, consulte Fazer chamadas remotas de
componentes Web do Lightning usando o OmniScript Action Framework .
Exemplo
Neste exemplo de código, um componente Web do Lightning personalizado estende o componente Web do
Lightning de botão. Substitua a variável NS no exemplo de código pelo namespace do pacote OmniStudio
Vlocity que você está usando.
//.js
Importar Botão de "NS/botão";
export default class buttonExtended extends Button { //sobrescreve a propriedade

aqui para que seja acionada

company
onclickbutton() { this.label = "Botão
clicado"; }}
//.js-meta.xml
<?xml version="1.0" encoding="UTF-8"?><LightningComponentBundle xmlns="http://

soap.sforce.com/2006/04/metadata">
<apiVersion>45.0</apiVersion>
<isExposed>verdadeiro</isExposed>
<masterLabel>button_extended</masterLabel>
<description>Botão estendido</description>
<alvos>
<target>lightning__RecordPage</target>
<target>lightning__AppPage</target>
<target>lightning__HomePage</target>
</destinos>
<runtimeNamespace>NS</runtimeNamespace>
</LightningComponentBundle>
//.html
<modelo>
//adiciona HTML aqui para substituir o layout do modelo
</template>
//_slds.css
//adiciona CSS para substituir ou anexar o CSS do tema SLDS

.slds-button { background:
#cccccc; cor da borda:
#dddddd;
}
Implantar componentes da Web do Lightning

Implante novos componentes da Web do Lightning ou altere componentes existentes de seu ambiente de
desenvolvimento local com o Visual Studio e o Salesforce DX ou IDX Workbench. Para configurar seu ambiente
de desenvolvimento para gerenciar e implantar seus componentes, consulte Configurar componentes Web do
Lightning .
1. Abra seu projeto no Visual Studio.

2. Certifique-se de ter o Salesforce DX ou IDX Workbench instalado. Para instalar o Salesforce DX ou IDX
Workbench, consulte o Guia de configuração do Salesforce DX .
3. No terminal, execute o seguinte comando para implantar as alterações em sua organização:
sfdx força: fonte: push
Para saber mais sobre como implantar componentes em sua organização com o Visual Studio, consulte
Analisar seu código e implantá-lo em sua organização .

company
Iniciar URLs de componentes da Web do Lightning com
vlocityLWCWrapper
Adicione o vlocityLWCWrapper para tornar os componentes da Web do Lightning em uma URL de página do
Lightning endereçável. Os componentes da Web do Lightning não são endereçáveis por URL por padrão. O
vlocityLWCWrapper envolve o componente Web do Lightning em um componente aura endereçável por URL.
Para obter informações sobre como acessar um LWC OmniScript por meio de um URL, consulte Iniciar um
OmniScript com LWC OmniScript Wrapper .
Configurando um URL para iniciar um componente Web do Lightning

1. Adicione o wrapper copiando o caminho relativo no exemplo e substituindo a variável NS pelo
namespace do pacote OmniStudio Vlocity. Para obter informações sobre como localizar o namespace,
consulte Visualizando o namespace e a versão do pacote OmniStudio Vlocity .
Lightning/cmp/NS__vlocityLWCWrapper?
2. Direcione o componente adicionando c__target= ao URL.
Lightning/cmp/NS__vlocityLWCWrapper?c__target=
3. Defina a URL para direcionar o componente adicionando c: para indicar um componente e adicione o
nome do componente sem traços usando camelCase. Por exemplo, para adicionar um componente com o
nome <c-demobutton> use a sintaxe c:demoButton .
Lightning/cmp/NS__vlocityLWCWrapper?c__target=c:demoButton
4. (Opcional) Ao usar o wrapper em um aplicativo de console, adicione um ícone da guia do console e um
rótulo da guia do console definindo os parâmetros c__tabIcon e c__tabLabel . O c__tabIcon aceita um
ícone SLDS e c__tabLabel aceita texto simples. Por exemplo, &c__tabLabel=Personalizado
Label&c__tabIcon=standard:account renderiza a guia do console mostrada nesta imagem de exemplo.
5. (Opcional) Atribua atributos adicionais passando parâmetros que correspondam aos nomes dos atributos.
Os parâmetros devem usar o prefixo c__ . Exemplo de código de componente de botão:
<c-button label=”Gerado dinamicamente” variant=”outline-brand”</c-button>
Exemplo de componente de botão como um componente endereçável por URL:

company
Lightning/cmp/NS__vlocityLWCWrapper? c__target=c:button&c__label=Gerado
dinamicamente&c__variant=Outline-brand Exemplo de imagem:
Iniciando um LWC a partir de uma ação de layout

1. Em Configuração , insira Gerenciador de objetos na pesquisa Busca rápida .
2. Selecione um Objeto e clique em Botões, Links e Ações .
4. Definir Tipo de Exibição para Página de Detalhes .
5. Defina a Origem do conteúdo como URL .
6. No valor da URL, adicione uma URL vlocityLWCWrapper. Para obter informações sobre como configurar
URLs do vlocityLWCWrapper, consulte Configurando um URL para iniciar um componente Web do
Lightning .
Lightning/cmp/NS__vlocityLWCWrapper?c__target=c:demoButton
Referência Leia-me do LWC de base Vlocity

Veja exemplos e saiba mais sobre atributos, métodos e outras funções disponíveis nos ReadMes de cada
componente da Web do Base Vlocity Lightning. Para estender componentes, consulte Estender componentes
da Web do Vlocity Lightning .
Liberar ⇬ Fazer download do arquivo
Vlocity Saúde e Seguro Primavera '21 baseLWCReadMes.zip

company
Migração de dados com OmniStudio DataPacks
Um DataPack é uma coleção de componentes e funcionalidades relacionadas que são empacotadas para
migração de uma organização para outra. DataPacks podem ser usados para implantação; ou seja, para migrar
a funcionalidade de um ambiente de sandbox para um ambiente de produção.
Você pode salvar em um DataPack qualquer objeto listado em Tipos de Objetos de DataPack Suportados .
NOTA
Ao importar e exportar dados, o tamanho máximo do arquivo é 2 MB.
Os DataPacks criados manualmente são adequados para migrar um pequeno número de objetos semelhantes,
por exemplo, mover OmniScripts de uma organização de desenvolvimento para uma organização de produção.
No entanto, para exportar em massa dados corporativos complexos, como produtos, use uma destas
ferramentas:
• O IDX Workbench migra objetos e metadados entre organizações ou entre organizações e repositórios Git.
Consulte Aplicativo de desktop IDX Workbench .
• A ferramenta Vlocity Build cria DataPacks que preservam relacionamentos de objetos. Consulte o projeto
gitHub da ferramenta de compilação Vlocity .
A ferramenta Vlocity Build está disponível no GitHub . A ferramenta Build é uma ferramenta de linha de
comando que empacota objetos relacionados como DataPacks, garantindo que as dependências sejam
preservadas. Por exemplo, para garantir que os dados não sejam duplicados inadvertidamente, a ferramenta
Build exige que determinados registros tenham IDs exclusivos atribuídos a eles. A ferramenta oferece
facilidades para validar dados e verificar o sucesso da migração. O projeto GitHub fornece instruções
detalhadas para migração.
Para simplificar a migração de vários objetos relacionados, você pode combinar DataPacks em multipacks. Para
manter o controle máximo sobre grupos de DataPacks relacionados, incorpore ferramentas de controle de
versão e integração contínua em seu processo de desenvolvimento e migração. Para obter orientação sobre
como fazer isso, leia o white paper Managing Vlocity Releases .
A migração é melhor executada por administradores do Salesforce com uma sólida compreensão de como os
dados são armazenados no Salesforce. O sucesso depende de dados de origem de alta qualidade.
Para treinamento sobre migração e implantação de dados, confira as práticas recomendadas de Vlocity
DevOps curso.

company
NOTA
Você pode importar DataPacks de alguns OmniStudio for Vlocity mais antigos (anteriormente
Digital
Interaction Platform) em uma organização OmniStudio. Objetos DataRaptor, Integration Procedure
e OmniScript habilitados para LWC são convertidos automaticamente em objetos OmniStudio.
A importação de DataPacks de objetos OmniStudio para uma organização OmniStudio for Vlocity não
é compatível. A importação de cartões entre OmniStudio e OmniStudio for Vlocity orgs não é
compatível.
Ver .
Criar um DataPack
Para migrar dados de uma organização para outra, você pode criar e exportar DataPacks, que são arquivos que
contêm seus dados no formato JSON.
1. Abra o objeto para exportar em seu designer.

2. Clique em Exportar .
A caixa de diálogo Exportar DataPack é aberta.
A caixa de diálogo Revisar é aberta.
Exportar final é aberta.
Para evitar a substituição de um DataPack existente, especifique um nome e uma versão exclusivos.
Quando Publicado está marcado, o DataPack vai para a subguia Publicado na guia DataPacks .
Quando Download está marcado, o DataPack JSON é baixado para sua máquina local.
O DataPack é criado e, em seguida, baixado para seu diretório de download, se você selecionou
Download .
Importar um DataPack
Depois de criar um DataPack, você pode importá-lo para outra organização.
CUIDADO
O nome e a versão dos DataPacks devem ser exclusivos. Se você importar um DataPack que
tenha o mesmo nome de um DataPack existente, o DataPack existente será substituído.

company
NOTA
Digital
compatível.
1. Baixe o DataPack da organização de origem.
2. Faça login na organização de destino.
3. Vá para a guia de designer apropriada e clique em Importar .
4. Quando solicitado, navegue até o arquivo DataPack e clique em Abrir .
5. Clique em Avançar e responda aos prompts do assistente de importação até que o arquivo seja
importado.
Tipos de objeto DataPack suportados

Os objetos que podem ser exportados como DataPacks estão listados aqui.
• Acessório
• Regra de atribuição de atributo
• Categoria de atributo
• Substituição de atributo
• Matriz de cálculo
• Procedimento de cálculo
• Catálogo
• Medição de Carga
• tipo de contrato
• Configurações personalizadas de CPQ
• DataRaptor
• Documento
• Cláusula do Documento
• Modelo de documento
Você também pode exportar modelos de documento de contrato Vlocity no Microsoft Word e Microsoft
PowerPoint criados no Vlocity Communications, Media e Energy.
• Filtro de entidade
• FlexCard
• Procedimento de Integração
• Implementação de Interface
• Implementação de itens
• Fila Manual
• Classe de objeto
• Layout do objeto
• Procedimento de oferta
• OmniScript
• Definição de dependência de orquestração
• Definição do item de orquestração
company
• Definição do plano de orquestração
• Livro de preços
• Lista de preços
• Variável de preço
• produtos
• Caminho da hierarquia do produto
• Relacionamento com o produto
• Promoção
• Criador de consultas
• Regra
• Trabalhos agendados
• Modelo de especificação
• Mapeamento de modelo de especificação
• Objeto da história
• Traduções de String
• Sistema
• Plano de tempo
• Política de tempo
• Seção de IU
• Faceta de IU
• Ação Vlocity
• Anexo Vlocity
• Cartão de velocidade
• Lista de opções de velocidade
• Iniciador de interação Vlocity
• Modelo de estado de Vlocity• Layout de IU de Vlocity
• Modelo de IU de Vlocity
• Máquina de Inteligência de Vlocity
• Recurso de inteligência de Vlocity
• Componente de Rastreamento de Vlocity
• Grupo de rastreamento de velocidade
• Configuração de rastreamento da Web Vlocity
• Tipo de evento de rastreamento da Web Vlocity
Corrija o erro de importação/exportação do DataPack: Nenhuma
configuração encontrada
Se você vir a mensagem de erro Nenhuma configuração encontrada: ao tentar importar ou exportar um
DataPack, isso provavelmente é um problema com a configuração da organização do Salesforce. Esse erro
geralmente ocorre em Developer Sandboxes que estão faltando alguns dos arquivos de configuração Vlocity
devido a uma atualização recente ou uma instalação ou atualização que perdeu uma etapa pós-instalação ou
pós-atualização. Você pode corrigir esse erro.
A solução é executar o código no Apex Anônimo. Para fazer isso, você deve acessar o Developer Console:
1. Navegue até o console do desenvolvedor.

• No Lightning Experience, clique no ícone de engrenagem e selecione Developer Console no menu.
• No Salesforce Classic, clique no menu do usuário e selecione Developer Console no menu.
2. Selecione Depurar > Abrir janela de execução anônima .

company
3. Cole o seguinte código na janela Inserir código do Apex: namespace
.CorePostInstallClass.runDev2ProdInserts();
IDX Workbench Desktop Application

Se você estiver usando o Gerenciamento do Ciclo de Vida do Contrato, adicione:
namespace .CmPostInstallClass.cmRunDev2ProdInserts();
Se você estiver usando o Gerenciamento de pedidos, adicione:
namespace .XOMCreateDPMappings.createDPMappings();
4. Para namespace , substitua um dos seguintes:
• vlocity_cmt para Vlocity Communications, Media e Energy
• vlocity_ins para Vlocity Insurance • vlocity_ps para Vlocity Government
O IDX Workbench é um aplicativo de desktop que permite migrar OmniStudio DataPacks e metadados do
Salesforce.
As migrações são suportadas:
• De uma organização Vlocity para outra

• De uma organização Vlocity para um repositório Git
• De um repositório Git para uma organização Vlocity
• Da biblioteca de processos Vlocity para uma organização Vlocity
• De um arquivo JSON para um repositório Git ou uma organização Vlocity
Os componentes são empacotados como DataPacks, que são otimizados para controle de origem e
implantação em outras organizações. Por exemplo, você pode desenvolver aplicativos em uma organização de
desenvolvimento dedicada e, em seguida, usar o IDX Workbench para implantá-los em uma organização de
controle de qualidade até que estejam prontos para uso em produção e, em seguida, implantar de sua
organização de controle de qualidade em organizações de produção.
NOTA
Digital
compatível.
Quando você escolhe um componente para migração, o IDX Workbench garante que seus componentes
dependentes sejam incluídos. Por exemplo, se você migrar um OmniScript que requer um DataRaptor, esse
DataRaptor é empacotado para migração com o OmniScript.
No IDX Workbench, você define a organização ou repositório de origem, a organização ou repositório de

destino e os componentes a serem migrados. Você deve criar essa definição antes de executar uma migração.
A migração é um caminho, da origem para o destino. Os componentes de origem substituem os componentes
de destino do mesmo nome e tipo.

company
Se você precisar de um cliente de linha de comando para implantação de script, baixe e use a ferramenta de
compilação Vlocity .
Instalar o IDX Workbench

O IDX Workbench é um aplicativo de desktop, portanto, você deve instalá-lo em seu computador.
1. Acesse o site de download e clique no link da sua plataforma.
2. Quando o download do arquivo IDXWorkbench-release.dmg terminar, clique duas vezes no arquivo.
3. No sistema operacional Mac, uma janela pop-up é exibida. Arraste o aplicativo para a pasta Aplicativos.
4. Abra o aplicativo IDX Workbench.
Ao abrir o IDX Workbench pela primeira vez após instalá-lo, a caixa de diálogo Configure Workspace é
exibida. Você deve configurar um espaço de trabalho e um projeto para continuar. Consulte Configuração
do IDX Workbench para migração .
5. No sistema operacional Mac, você pode ver uma mensagem informando que o IDX Workbench não pode
ser aberto porque a Apple não pode verificar se há software malicioso.
Para permitir que o IDX Workbench
seja aberto: a. Abra as
Preferências do Sistema .
b. Clique em Segurança e privacidade .
c. Clique na guia Geral .
d. Clique no botão Open Anyway para o aplicativo IDX Workbench.
Configurar ativação e compilação do LWC OmniScript e FlexCard

Se o Google Chrome for seu navegador padrão e o IDX Workbench fizer login em suas organizações de origem
e destino por meio dele, ignore esta tarefa. Quando você migra OmniScripts, Integration Procedures e
FlexCards, eles são ativados automaticamente na organização de destino. No entanto, se você usar um
navegador diferente, deverá configurar esse recurso de ativação automática manualmente.
Para configurar a ativação automática de OmniScripts, Procedimentos de Integração e FlexCards migrados

para um navegador não Chrome:
1. Instale o Node.js em seu computador.

2. Abra uma janela de terminal em seu computador.
3. Instale o módulo Puppeteer em seu computador usando este comando:
npm install marionetista -g
O IDX Workbench usa o módulo Puppeteer para ativar automaticamente OmniScripts, Procedimentos de
Integração e FlexCards na organização de destino.
Veja também
• nodejs.org
Configuração do IDX Workbench para migração

Antes de poder migrar componentes, você deve especificar a origem, o destino e os objetos a serem migrados.
A origem pode ser uma organização, um objeto Project em uma organização, um arquivo JSON, a

company
Vlocity Process Library ou um repositório Git. O destino pode ser uma organização ou um repositório Git.
Você também pode salvar em um arquivo JSON ao migrar. Consulte Salvar objetos em um arquivo JSON .
Configurar para migração entre organizações
Você deve configurar uma organização de origem e uma organização de destino. Ambos devem ser
organizações Vlocity.
NOTA
Digital
compatível.
1. Na organização que você planeja usar como origem, certifique-se de que as versões corretas dos objetos
do Salesforce que você deseja migrar estejam ativas.
Alguns objetos, como OmniScripts e Procedimentos de Integração, possuem versões que podem ser
ativadas e desativadas. Somente as versões ativas desses objetos são migradas.
2. Abra o IDX Workbench. Se não existir nenhum projeto, a caixa de diálogo Configure Workspace será
exibida.
Se existirem outros projetos e você desejar criar um novo projeto, clique no ícone Editar na tela principal
do IDX Workbench para abrir a caixa de diálogo Configurar espaço de trabalho.
3. Na lista suspensa Repositório, selecione Novo Repositório .
Você deve criar um repositório para o projeto mesmo que sua origem e destino sejam organizações.
4. Na caixa de diálogo Novo Repositório, especifique um Nome e uma Pasta de Repositório . Se a pasta não
existir, ela será criada. Clique em Salvar .

company
5. Na lista suspensa Origem, selecione Novo ambiente . (Um ambiente é uma organização.)
Para configurar o acesso limitado a uma organização, consulte Configurar uma organização usando
um login de usuário da comunidade .
6. Na caixa de diálogo Nova organização do Salesforce, especifique um Nome .
7. Se sua origem for uma organização sandbox, altere o tipo de organização para
https://test.salesforce.com .
8. Clique em Fazer login usando OAuth . A janela de login do Salesforce é exibida. Faça login na organização.
Se a janela Permitir acesso for exibida, clique em Permitir .
9. Na lista suspensa Destino, selecione Novo Ambiente .

company
Repita os mesmos passos.
Para configurar o acesso limitado a uma organização, consulte Configurar uma organização usando um
login de usuário da comunidade .
10. Na lista suspensa Projeto, selecione Novo Projeto .
Para usar um objeto Project em vez de configurar um projeto, consulte a próxima seção.
11. Na caixa de diálogo Novo Projeto, especifique um Nome para seu projeto.
company
12. Selecione os tipos de objetos Vlocity e/ou Salesforce para migrar. Você pode usar o campo Pesquisar para
filtrar a lista. Selecione todos os tipos que você precisa.
13. Clique em Buscar DataPacks .

14. Em Escolher pacotes de dados para o projeto , você pode, opcionalmente, inserir texto para filtrar os
nomes dos objetos buscados.
15. Mova os objetos que deseja migrar da lista Todos os pacotes de dados para a lista Pacotes de dados
selecionados . Você pode usar a tecla Shift para selecionar vários itens em qualquer lista.
Você pode clicar em Ignorar dependências para excluir objetos dependentes da migração.

company
16. Clique em Salvar . A caixa de diálogo Configurar área de trabalho reaparece.
17. Para atualizar os dados de comparação sempre que salvar o espaço de trabalho, verifique se a caixa
Forçar atualização de dados de organizações está marcada.
18. Clique em Salvar para salvar a área de trabalho.

As mensagens aparecem à medida que os objetos são buscados. Para cancelar, pressione Command-R no
Mac ou Control-R em outros sistemas operacionais.
19. Quando a listagem estiver completa, o IDX Workbench ficará assim:
Os ícones verdes + indicam que os objetos são novos na organização de origem.

20. Para editar o repositório:
a. Clique no ícone Editar na tela principal do IDX Workbench para reabrir a caixa de diálogo Configurar
espaço de trabalho.
b. Clique no ícone Editar ao lado da lista suspensa Repositório para abrir as Configurações do
Repositório.
c. Edite o Caminho de Expansão se desejar alterar a subpasta da pasta do repositório na qual os
DataPacks estão armazenados.
d. Especifique Filtros de Consulta de DataPack Adicionais se desejar filtrar objetos do tipo especificado
em todos os projetos que usam o repositório. Clique em Adicionar novo filtro para adicionar
quantos filtros forem necessários.
Por exemplo, definir DataPack Type como Product2 e Additional Query Filter como RecordTypeId
!= null exclui produtos que não sejam Vlocity.
e. Clique em Salvar .
21. Para adicionar objetos ao projeto:
a. Clique no ícone Editar na tela principal do IDX Workbench para reabrir a caixa de diálogo Configurar
b. Clique no ícone Editar ao lado da lista suspensa Projeto para reabrir a caixa de diálogo Projeto.
c. Repita as etapas 12 a 18 acima.
Configurar uma organização usando um login de usuário da comunidade

Ao configurar uma organização para executar procedimentos de teste, você pode especificar uma comunidade
do Salesforce e autenticar como usuário da comunidade. Isso é especialmente útil para executar
procedimentos de teste nos quais o acesso do usuário afeta os resultados.

company
Você deve configurar o usuário da Comunidade para ter acesso a todos os objetos relacionados ao
Procedimento de Integração, ao Serviço de Rastreamento e à classe Apex ProcedureTestFramework .
Para obter assistência com essas tarefas, consulte Configurar e gerenciar comunidades do
Salesforce .
1. Configure uma comunidade do Salesforce.

2. Crie um usuário da comunidade com os conjuntos de permissões necessários.
3. Conheça o nome de usuário e a senha deste usuário.
1. Na organização, vá para Configuração.
2. Em Configuração, na caixa Busca rápida, digite comunidades e selecione Todas as comunidades .
3. Copie o URL da Comunidade que você deseja usar.
4. No IDX Workbench, selecione New Environment na lista suspensa Source, Target ou Test User.
5. Especifique o Nome do usuário ou outro nome descritivo.
6. Clique no + à direita do campo Tipo de organização .
7. Cole o URL da Comunidade no campo Digite um novo URL de login .
8. Clique em Fazer login usando OAuth . A janela de login do Salesforce é exibida. Faça login na organização
usando o nome de usuário e a senha do usuário.
Se a janela Permitir acesso for exibida, clique em Permitir .
Configurar um objeto de projeto

Para criar um objeto de projeto, consulte a documentação da comunidade Vlocity Success.
1. Configure a Origem e o Destino. Consulte as etapas de 1 a 9 de Configurar para migração entre

organizações .
2. Na lista suspensa Projeto, selecione Carregar projetos da origem .
Isso recupera objetos de projeto ativos na organização de origem que têm um status de liberado.
3. Quando os objetos Project terminarem de carregar, selecione um objeto Project.
4. Para atualizar os dados de comparação sempre que salvar o espaço de trabalho, verifique se a caixa
Forçar atualização de dados de organizações está marcada.
Configurar para migração de um arquivo JSON

Você pode especificar um DataPack como Origem e migrar para uma organização ou um destino do repositório
Git. O DataPack deve incluir todos os objetos que você deseja migrar em um único arquivo JSON.
1. Siga as instruções para migrar entre organizações. Consulte Configurar para migração entre organizações
.
2. Na etapa 5, selecione Importar JSON na lista suspensa Origem e procure o arquivo.
Configurar para migração da biblioteca de processos do Salesforce Industries

Você pode migrar DataPacks da Salesforce Industries Process Library para uma organização Vlocity.
Para criar um projeto usando a Salesforce Industries Process Library como sua origem:

company
1. Abra o IDX Workbench. Se não existir nenhum projeto, a caixa de diálogo Configure Workspace será
exibida.
Se existirem outros projetos e você desejar criar um novo projeto, clique no ícone Editar na tela principal
do IDX Workbench para abrir a caixa de diálogo Configurar espaço de trabalho.
2. Selecione Biblioteca de Processos Vlocity na lista suspensa Repositório.
3. Clique em Login com nome de usuário diferente .
4. Clique em Continuar para abrir a Biblioteca de Processos Vlocity em uma guia do navegador.
5. Na guia do navegador, faça login na Biblioteca de Processos Vlocity usando seu nome de usuário e senha
da Comunidade Vlocity Success.
6. Se você vir o Permitir acesso? janela, clique em Permitir .
7. Após o login bem-sucedido, retorne ao IDX Workbench e clique no botão Atualizar em Vlocity Process
Listing .
8. Na lista suspensa Listagem de processos, selecione a listagem desejada.
9. Na lista suspensa Destino, selecione uma organização configurada anteriormente ou Novo ambiente .
Para uma nova organização, siga as etapas de 5 a 8 em Configurar para migração entre organizações .
Configurar para migração entre um repositório e uma organização

Você pode usar um repositório Git como Origem ou Destino no IDX Workbench, migrando DataPacks do
repositório para uma organização Vlocity ou vice-versa.
Antes de configurar um projeto com um repositório Git como Origem ou Destino, você deve:
1. Instale o Git no seu computador. Consulte Instalando o Git .

2. Configure sua identidade para usar o Git. Consulte Configuração inicial do Git .
3. Certifique-se de que o IDX Workbench tenha acesso ao repositório Git.
As instruções diferem dependendo do tipo de repositório e se você usa uma senha ou SSH — consulte a documentação do seu repositório. Se você usa
o Bitbucket com acesso por senha, consulte Dar a um repositório Git Bitbucket acesso ao IDX Workbe nch .
Para criar um projeto usando um repositório Git como origem ou destino:
1. Siga as instruções para migrar entre organizações. Consulte Configurar para migração entre organizações
.
2. Na etapa 4, na caixa de diálogo New Repository, cole a URL de clonagem no campo Clone from Git
Repository URL .
3. Na etapa 5, selecione o repositório como Origem ou na etapa 9, selecione o repositório como Destino.
Dê a um repositório Git Bitbucket acesso ao IDX Workbench

Você pode conceder ao IDX Workbench acesso a um repositório Bitbucket usando uma senha.
1. Acesse o Bitbucket no seu navegador.

2. Clique no ícone com suas iniciais e selecione as configurações do Bitbucket .

company
3. Em GERENCIAMENTO DE ACESSO, clique em Senhas de aplicativos .
4. Clique em Criar senha do aplicativo .

5. Para o Rótulo , especifique VlocityDX .
6. Em Repositórios, verifique o nível de acesso que você tem ao repositório.
Por exemplo, se você tiver acesso de gravação, marque Write .

company
7. Clique em Criar .
8. Copie a senha exibida para um local de onde você possa copiá-la novamente, como um arquivo de texto.
9. Vá para o repositório que você deseja usar como a Origem.

10. Clique em Clonar .
11. Na caixa de diálogo Clonar este repositório , altere SSH para HTTPS .
12. Copie o URL para um local de onde você possa copiá-lo novamente, como um arquivo de texto. Deve ser
algo assim:
https://username@bitbucket.org/company/reponame.git
13. Edite o URL para adicionar dois pontos e a senha após o nome de usuário. Por exemplo:

company
https://username:rCcrFYhXY4rSrxLaW8HV@bitbucket.org/company/reponame.git
Este é o URL que você colará no campo Clone from Git Repository URL ao criar o Repositório usado como
a Origem.
14. Clique em Fechar .
Criar projetos adicionais

Depois de criar seu primeiro projeto, você pode criar projetos adicionais.
1. Clique no ícone Editar na tela principal do IDX Workbench para reabrir a caixa de diálogo Configurar
2. Altere o repositório, a origem e o destino conforme necessário.
3. Para a lista suspensa Projeto, selecione Novo Projeto.
4. Configure o projeto.
5. Na caixa de diálogo Configurar área de trabalho, clique em Salvar .
Veja também
• Configurar para migração entre organizações
Alternar entre projetos

Você pode alternar do seu projeto atual para outro projeto existente.
1. Clique no ícone Editar na tela principal do IDX Workbench para reabrir a caixa de diálogo Configurar
2. Na lista suspensa Repositório, selecione o Repositório para o projeto. Você deve fazer isso mesmo se seu
projeto migrar entre organizações e seu repositório for apenas uma pasta.
3. Para a lista suspensa Projeto, selecione o projeto.
4. Verifique se a Origem e o Destino estão corretos. Altere-os se necessário.
Veja também
• Configurar para migração entre organizações
Lidar com uma mensagem de falha de login

Se você atualizar uma organização de origem ou de destino e vir uma mensagem Falha no login... Faça login
novamente , você poderá corrigir o erro.
1. Se a caixa de diálogo Configurar espaço de trabalho não estiver aberta, clique no ícone Editar na tela
principal do IDX Workbench para abri-la.
2. Não exclua a organização de Origem ou Destino, mas selecione Novo Ambiente na lista suspensa Origem
ou Destino.
3. Siga as etapas de 6 a 8 das instruções para migrar entre organizações acima.
4. Na caixa de diálogo Configurar área de trabalho, clique em Salvar .
Use um arquivo .vlocityignore para excluir objetos

Você pode especificar uma lista de tipos de objetos e/ou objetos a serem ignorados em todos os projetos que
usam o mesmo repositório.

company
Um arquivo .vlocityignore segue todas as regras para arquivos .gitignore . Para obter mais informações,
consulte Ignorando arquivos .
1. Coloque um arquivo chamado .vlocityignore no nível superior de sua pasta de repositório.

2. Abra este arquivo em um editor de texto.
3. Adicione os nomes dos tipos de objetos e/ou objetos a serem ignorados, cada um em uma linha
separada.
Por exemplo, o arquivo a seguir ignora todos os objetos CalculationMatrix, exceto o chamado Matrix1:
Matriz de Cálculo
!Matriz de Cálculo/Matriz1
4. Salve o arquivo.
Migração e comparação de objetos

Depois de configurar um projeto, você pode migrar objetos da Origem para o Destino. Após a migração inicial,
você pode comparar objetos na Origem e Destino para ver se algum foi atualizado e precisa ser migrado
novamente. Você também pode salvar objetos na Origem em DataPacks.
Migrar objetos da origem para o destino

Quando você cria um projeto pela primeira vez, os objetos a serem migrados ainda existem apenas na Origem.
Esses objetos são listados no painel esquerdo da tela principal do IDX Workbench.
Para migrar objetos para o Destino:

1. Marque a caixa de seleção ao lado de cada objeto a ser migrado.
2. Clique em Ações > Migrar com dependências .

company
3. Verifique se a migração foi bem-sucedida.
Quando a migração for concluída, os rótulos migrados serão exibidos ao lado dos objetos
migrados com êxito.
Além disso, as informações sobre os objetos aparecem nas guias Comparação e Migração.
Opções de migração e comparação de objetos

company
Depois de configurar um projeto, você pode migrar objetos da Origem para o Destino. Após a migração inicial,
você pode comparar objetos na Origem e Destino para ver se algum foi atualizado e precisa ser migrado
novamente. Você também pode salvar objetos na Origem em DataPacks.
Atualizar opções para comparar objetos

Para ver se algum objeto foi atualizado em seu projeto, clique em Atualizar na tela principal do IDX Workbench
e selecione uma destas opções:
• Atualizar tudo — Atualiza as informações de todos os objetos nas organizações de origem e destino.
• Atualizar fonte — Atualiza as informações de todos os objetos somente na fonte.
• Atualizar Destino — Atualiza as informações de todos os objetos somente no Destino.
• Atualizar Selecionado — Atualiza as informações apenas para os objetos selecionados, na Origem e no
Destino.
• Redefinir Diferenças — Reverte as alterações locais sem recuperar novas informações da Origem ou
Destino.
Isso também é útil se você tiver feito alterações nos dados subjacentes usando as opções Reverter ou Editar
como JSON em DataPacks individuais.
Quando a atualização difere? caixa de diálogo for exibida, clique em Continuar .
Se você vir uma mensagem Falha de login... Faça login novamente , siga as instruções em Manipular uma
mensagem de falha de login na configuração do IDX Workbench para migração .
Se a Origem for um arquivo JSON, o menu Atualizar será desabilitado.

Quando a atualização for concluída, os ícones de til amarelo (~) indicam objetos que não são os mesmos em
ambas as organizações. Os ícones de mais (+) verdes indicam novos objetos na Origem.
Na guia Comparação, as diferenças são resumidas.

company
DataPacks relacionados lista as dependências do objeto atual. Onde Usado lista o objeto do qual o objeto
atual é uma dependência.
Você pode clicar em Exibir fonte para ver detalhes adicionais sobre as diferenças.
Para sincronizar objetos diferentes, siga um destes procedimentos:
• Marque a caixa de seleção ao lado de cada objeto a ser migrado e clique em Ações > Migrar com
dependências .
• Vá para a guia Migração e clique em Migrar com dependências para cada objeto que deseja migrar.
Os círculos brancos indicam que os componentes agora são os mesmos em ambas as organizações.
Descartar todas as opções para excluir componentes

Ao comparar DataPacks na guia Comparação, os detalhes das diferenças são exibidos. Por exemplo, aqui está
uma comparação mostrando uma ação Definir valores em um OmniScript:
Para excluir um componente de um DataPack que você está exportando, localize -o nas diferenças por
elemento e clique em Descartar tudo . Por exemplo, você pode excluir componentes que adicionou
company
para depuração, mas deseja remover para produção. Observe que suas edições não são propagadas de volta
para a organização de origem. Se você clicar em Descartar tudo por engano, use Atualizar > Redefinir
diferenças para restabelecer o componente.
Opções para filtrar a lista de objetos

Para filtrar a lista de objetos, clique no ícone Filtrar (funil). Use as seguintes opções de filtro:
• Por palavra-chave — Digite parte de um nome para exibir itens com essa parte em seus nomes.
• Por Seleção — Marque Itens Selecionados para exibir os itens que você selecionou. Marque Itens Não
Selecionados para exibir os itens que você não selecionou.
• Por Tipo de Alteração — Marque Novos Itens para exibir itens na Origem, mas não no Destino. Marque
Itens Alterados para exibir os itens que foram atualizados na Origem.
• Por Status — Verifique Falha ao exibir componentes que não foram migrados.
• Por projeto — Marque Ocultar dependências para ocultar componentes que não estão explicitamente
incluídos no projeto, mas que são dependências de componentes incluídos.
Opções de comando do Git

Para usar comandos do Git em um repositório Target Git, clique no ícone Git (branch). Use os seguintes
comandos do Git:
• Init — Inicialize a pasta do repositório.

• Filial de Checkout — Selecione uma filial existente ou crie uma nova.
• Pull — Puxe as últimas alterações do branch selecionado para o seu branch.
• Push — Envie suas alterações para a ramificação selecionada.
• Status — Liste as alterações em seu branch local que não estão presentes no branch remoto.
Salvar objetos em um arquivo JSON

Em vez de migrar objetos para outra organização, você pode salvá-los em um DataPack.
1. Marque a caixa de seleção ao lado de cada objeto a ser salvo.
2. Clique em Ações > Salvar . A janela Salvar DataPacks é exibida.

3. Especifique um nome de arquivo e um caminho de arquivo . Clique em Escolher para procurar um
caminho de arquivo.
4. Clique em Salvar . O arquivo salvo recebe uma extensão .json .

company
Use o IDX Workbench Process Profiler
O Process Profiler permite visualizar os dados do OmniStudio Tracking Service para um objeto em uma
organização de origem ou de destino. Antes de poder visualizar esses dados, você deve habilitar os
acionadores conforme descrito em Habilitar o rastreamento para componentes do OmniStudio e executar seu
fluxo de negócios para capturar esses dados de rastreamento.
1. Clique no ícone do Painel de listas no canto superior esquerdo, .

2. Clique em Process Profiler .
3. Selecione uma organização na lista suspensa. As organizações configuradas em qualquer projeto são
listadas ou você pode configurar um Novo Ambiente .
Os dados de desempenho são baixados imediatamente. Para grandes organizações, isso pode levar algum
tempo.
4. Selecione um Tipo de Componente na lista suspensa, OmniScript ou Procedimento de Integração . Os
tipos de componentes que possuem dados de rastreamento são listados.
5. Selecione um Componente na lista suspensa. Os componentes que possuem dados de rastreamento são
listados.
6. (Opcional) Para filtrar os dados por data, insira uma Data de início e/ou uma Data de término .
7. (Opcional) Para limitar o número de invocações a serem calculadas, digite um número inteiro em Last N
Executions .
8. (Opcional) Para filtrar os dados por usuários do componente, clique na lista de usuários e marque as
caixas à esquerda dos nomes de usuário desejados.
9. (Opcional) Para ir para uma etapa na organização, clique com o botão direito do mouse no nome da
etapa e clique em Abrir no navegador .
Por exemplo, clicar com o botão direito do mouse em uma ação de extração do DataRaptor abre o
DataRaptor que a etapa chama.
10. Se novos dados de desempenho foram gerados na organização, clique em Atualizar dados para baixá-los.
Por exemplo, quando você recupera dados do OmniScript, o Process Profiler se parece com isto:

company
Comparar versões do OmniScript e do procedimento de integração
O painel Comparação de versões permite comparar duas versões de um OmniScript ou Procedimento de
integração na mesma organização de origem ou de destino.

2. Clique em Comparar versões .
3. Selecione uma fonte de dados na lista suspensa. As organizações configuradas em qualquer projeto são
listadas. Os dados são baixados imediatamente. Para grandes organizações, isso pode levar algum tempo.
4. Selecione um Tipo de Componente , OmniScript ou IntegrationProcedure , na lista suspensa.
5. Selecione um Componente na lista suspensa.
6. Selecione uma versão base e uma versão de destino .

company
7. Clique em Encontrar diferenças .
A lista de diferenças se parece com isso:

company
8. Clique em Exibir fonte para ver detalhes adicionais sobre as diferenças. Para excluir um componente da
versão de destino, clique em Descartar tudo .
Executar procedimentos de teste

O painel de teste permite executar procedimentos de teste (procedimentos de integração que realizam testes
de unidade) e analisar os resultados dos testes.
Para criar procedimentos de teste, consulte Procedimentos de teste: Procedimentos de integração para teste
de unidade .

2. Clique em Testar Console .
3. Selecione um usuário conectado a uma organização na lista suspensa Usuário de teste .
Para configurar o acesso limitado a uma organização, consulte Configurar uma organização
usando um login de usuário da comunidade . Uma lista de procedimentos de teste ativos é
exibida. Para atualizar a lista, clique em Obter testes .

company
4. Marque a caixa de seleção ao lado de cada procedimento de teste a ser executado. Para executar todos
os Procedimentos de Teste, marque Todos os Testes .
5. Clique em Ações > Iniciar Teste .
Quando os testes forem concluídos, os resultados serão exibidos no painel Resultados do teste.

company
Se um teste falhar, a mensagem de falha e a expressão de teste da Ação de Asserção do Procedimento de
Teste para Procedimentos de Integração serão exibidas.
6. Para exibir todos os dados do resultado do teste, clique em Visualizar JSON .
Para obter detalhes sobre esses dados, consulte Acompanhamento de eventos do procedimento de
integração .
company
7. Para exibir um gráfico dos tempos de execução das etapas do Procedimento de teste, clique em Exibir
gráfico .
Se uma Ação de Asserção falhar, um ícone de aviso (! dentro de um triângulo) aparecerá próximo à etapa.
8. Para ver os tempos de execução de um Procedimento de Integração que está sendo testado, expanda a
etapa Ação do Procedimento de Integração.

company
9. Para ir para uma etapa na organização, clique com o botão direito do mouse no nome da etapa e clique
em Abrir no navegador .
Por exemplo, clicar com o botão direito do mouse em uma ação de extração do DataRaptor abre o
DataRaptor que a etapa chama.
10. Para exibir dados de uma etapa específica em uma janela pop-up, clique na barra dessa etapa no gráfico.

company
11. Você pode expandir Dados e rolar para baixo para ver os dados de solicitação e resposta.

company
Comandos do menu do IDX Workbench
A maioria dos comandos nos menus do IDX Workbench são como os de qualquer aplicativo. Por exemplo,
Editar > Copiar copia o texto selecionado. Os comandos específicos do IDX Workbench estão listados aqui.
• Repositório > Configurações — Permite abrir a janela Configurações do repositório para o repositório atual
sem precisar abrir primeiro a janela Configurar espaço de trabalho. Inclui as seguintes configurações: •
Caminho de expansão — Determina a subpasta da pasta do repositório na qual os DataPacks são
armazenados.
• consulta do DataPack adicionais — Filtra objetos do tipo especificado em todos os projetos que usam o
repositório. Clique em Adicionar novo filtro para adicionar quantos filtros forem necessários.

company
Por exemplo, definir DataPack Type como Product2 e Additional Query Filter como RecordTypeId != null
exclui produtos que não sejam Vlocity.
• Projeto > Editar detalhes do projeto — Permite abrir a janela Editar projeto para o projeto atual sem ter
que abrir primeiro a janela Configurar espaço de trabalho.
• Trabalhos > Garantir chaves globais na origem — itera sobre os dados na organização de origem e garante
que cada registro que precise tenha um valor de chave global.
• Exibir > Recarregar — Recarrega o aplicativo IDX Workbench.
• Exibir > Forçar recarga — Força uma recarga do aplicativo IDX Workbench.
• Exibir > Alternar Ferramentas do Desenvolvedor — Exibe ou oculta um ambiente de desenvolvimento.
• Depurar > Abrir logs — Abre o arquivo de log do IDX Workbench.
É muito importante incluir dados de log ao enviar um caso de suporte Vlocity.
• Depurar > Redefinir dados do repositório — Redefine a configuração do IDX Workbench como se tivesse
sido instalado recentemente. Isso limpa todos os projetos. No entanto, ele não exclui as pastas do projeto.
Você pode restaurar um projeto na caixa de diálogo Configurar Workspace selecionando Novo Repositório
e referenciando a Pasta de Repositório existente para o projeto.

company

OmniStudio Documentation Traduzido

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

OmniStudio Documentation Traduzido

Enviado por

Direitos autorais:

Formatos disponíveis

OmniStudio Foundation

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

Com OmniStudio , você pode criar:

• OmniScripts , que contêm a lógica de interação

© 2021 Vlocity LLC, a Salesforce

Noções Básicas do OmniScript

• Um agente de atendimento ao cliente para adicionar um novo cliente

• Adicione ações como extrair dados ou enviar um email

© 2021 Vlocity LLC, a Salesforce

• Um botão de ação como o mostrado aqui na página da conta

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

DataRaptor ou Procedimento de Integração?

Use um Procedimento de Integração se:

© 2021 Vlocity LLC, a Salesforce

Use o Formulários Juntos

Aqui está um exemplo de FlexCards , OmniScripts e DataRaptors usados juntos para:

• Exibir e fornecer um contexto para informações e ações

© 2021 Vlocity LLC, a Salesforce

• Lightning: Refere- se ao Salesforce Lightning Design System.

Sobre o Newport Design System

O Newport Design System suporta duas funções:

• Fornece um guia de estilo visual de nível de consumidor pronto para uso.

© 2021 Vlocity LLC, a Salesforce

Implementações que podem ser chamadas

Embora as interfaces VlocityOpenInterface e VlocityOpenInterface2 permitam implementações flexíveis com uma

Para alterar classes personalizadas que implementam VlocityOpenInterface ou VlocityOpenInterface2 para

global with sharing class ClassName implements Callable

Map<String, Object> input = (Map<String, Object>)args.get('input');

return invokeMethod(action, input, output, options);

© 2021 Vlocity LLC, a Salesforce

© 2021 Vlocity LLC, a Salesforce

Um OmniScript é um envolvimento do cliente omnicanal e uma ferramenta de negócios criada na plataforma

Práticas recomendadas do OmniScript

Processo de negócios e lógica

• Use um proprietário para cada OmniScript .

melhores práticas incluem:

© 2021 Vlocity LLC, a Salesforce

As melhores práticas do lado do cliente incluem:

• Reduza exibições condicionais, mesclar campos, fórmulas sempre que possível.

As melhores práticas do lado do servidor incluem:

OmniScript Designer Overview

© 2021 Vlocity LLC, a Salesforce

Destaques do Designer OmniScript

© 2021 Vlocity LLC, a Salesforce

Painel de Navegação (2)

(B) Reorganize, clone e exclua elementos conforme necessário.

© 2021 Vlocity LLC, a Salesforce

https://myDomain.force.com/CommunityName/s/CommunityPage/ clayout = relâmpago&c