Skip to main content

Antes de começar

Dúvidas sobre o que é um Carol App? → Veja mais informações na seção de conceitos.

É necessário o cumprimento dos pré-requisitos listados abaixo, para se desenvolver e implantar um Carol App no topo da plataforma Carol:

Fluxo de materialização de esquemas na instalação de Carol Apps nos clientes​

A instalação de um aplicativo Carol considera um processo padrão de atualização da staging table nos clientes, ao invés de aplicar um novo esquema excluindo colunas existentes. As regras seguidas são:

  1. Executa validação verificando a existência da staging table;
  2. Se não existir, cria;
  3. Se existir, verifica se o conector é restrito;
  4. Se não for restrito, somente adiciona novas colunas que o aplicativo Carol definiu para a staging table do cliente;
  5. Se for restrito, verifica o parâmetro forceMaterializeStagingSchemaFromConnectorProtheusCarol;
  6. Se o parâmetro for verdadeiro, somente adiciona novas colunas que o aplicativo Carol definiu para a staging table do cliente;
  7. Se o parâmetro for falso, pula a materialização da staging table e crosswalk;

OBS: Nos itens 4 e 6, vale ressaltar que a eliminação de colunas não são materializadas.

Importante

Se o tipo do campo definido na tenant do Carol App for diferente daquele previamente definido na tenant do cliente, um aviso será registrado no log da tarefa de instalação do Carol App, informando o nome do conector, da staging table e do campo.

Carol App FronEnd SDK​

Este documento se apresenta como uma introdução teórica ao pacote de desenvolvimento carol-app-fe-sdk, que tem como objetivo auxiliar na criação e desenvolvimento de aplicações web para a plataforma Carol, usando o framework Angular.

A plataforma Carol permite a hospedagem de aplicações customizadas em seus ambientes como forma de prover serviços adicionais aos seus usuários. Entre as modalidades de aplicação disponíveis estão as aplicações web, as quais são o publico alvo deste pacote.

Dica

Todas as aplicações web hospedadas na plataforma Carol são recomendadas a utilizarem o framework javascript Angular. Este SDK foi desenvolvido levando em consideração o ecossistema desta ferramenta, e não prevê suporte a outras tecnologias.

Adicionalmente, recomenda-se também que as aplicações sejam desenvolvidas em conjunto com a biblioteca de componentes open source da TOTVS, o PO UI - embora o SDK seja agnóstico em relação a isso.

O SDK possui uma documentação técnica com um guia de integração, e descrição de todas as ferramentas embutidas que facilitam a interação com a plataforma.

Através das APIs disponibilizadas, os desenvolvedores conseguem com poucas linhas de código interagir com todos os aspectos relevantes do ambiente da aplicação.

Documentação de Referência​