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:

• Tenants provisionadas:

  • Desenvolvimento: é nela onde o Carol App será criado, desenvolvido (Development) e liberado para aprovação (Submitted to Review). Após aprovado, o Carol App tem o seu status alterado para Deployed.
  • Unificada: é nela onde o Carol App será instalado após passar por aprovação (Published).
  • Cliente (produção): é nela onde o Carol será instalado após instalação na unificada (Published).

  Dúvidas sobre como provisionar? → Veja mais informações em Provisionamento.

• Manifesto de pipeline e Pipeline SQL em um repositório git
  Dúvidas sobre a criação do manifesto e da pipeline SQL? → Veja mais informações em Data Processing.

• Conector criado na Tenant de desenvolvimento
  Dúvidas sobre a criação de conectores? → Veja mais informações em Data Ingestion.

• Tabela staging criada na Tenant de desenvolvimento
  Dúvidas sobre a criação de tabelas staging? → Veja mais informações em Data Ingestion.

• Data model criado na Tenant de desenvolvimento
  Dúvidas sobre a criação de data models? → Veja mais informações em Data Processing.

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

• Pacote SDK carol-app-fe-sdk no npmjs: https://www.npmjs.com/package/@totvslabs/carol-app-fe-sdk

• Biblioteca PO UI: https://po-ui.io