Árvore Docs Guia

Estruturas Organizacionais

Estruturas organizacionais, referenciadas simplesmente pelo termo entidades, são a base para a organização e gestão de acesso dos usuários da plataforma.

No momento em que uma conta é criada, é vinculada a ela uma hierarquia estrutural, que pode ser composta de até 4 níveis. Esses níveis da hierarquia buscam simular a estrutura organizacional das instituições de ensino.

A hierarquia da conta e a entidade raiz são definidas durante a configuração inicial da conta, que é realizada pela Árvore. Após essa configuração, é de responsabilidade do parceiro criar e gerenciar as entidades abaixo.

Tipos e hierarquia

As entidades são identificadas pelos seguintes tipos:

  • trademark: representa uma marca, e está no nível máximo de agrupamento permitido para as estruturas atualmente. Uma marca possui uma ou mais redes. Não é possível criar entidades com esse tipo via API.
  • network: representa uma rede, e é o mais alto nível permitido para criação de entidades. Uma rede é composta por várias escolas.
  • school: representa uma escola, e deve estar obrigatoriamente abaixo de uma rede. Uma escola geralmente é composta por várias turmas, e também possui professores vinculados a ela.
  • class: representa uma turma, e está obrigatoriamente abaixo de uma escola. Uma turma é composta por leitores, e não possui nenhuma estrutura organizacional abaixo dela.

As possíveis combinações de hierarquia estão descritas abaixo. O primeiro nível da hierarquia, de acordo com a configuração escolhida no momento do cadastro, não pode ser alterado via API.

  • trademark > network > school > class
  • network > school > class
  • school > class
  • class

Após o cadastro inicial, os dados relativos à estrutura hierárquica da conta não poderão ser editados. Portanto, de acordo com sua necessidade, planeje-se para escolher e utilizar a estrutura organizacional correta. Caso tenha dúvidas, consulte o nosso time.

Exemplo de hierarquia

Para melhor compreensão da estrutura hierárquica, veja o exemplo abaixo:

Network
├── School A
│   ├── Class 1A
│   ├── Class 1B
│   └── Class 2A
└── School B
    ├── Class 1A
    └── Class 2A

Nesse exemplo, temos uma conta que possui três níveis hierárquicos em sua estrutura. A raiz da conta (Network) é utilizada para gerenciar duas escolas, que possuem 2 e 3 turmas em sua estrutura, respectivamente.

Com isso, os usuários são criados posteriormente e alocados nessas estruturas. O escopo de informações que um usuário pode acessar está diretamente associado a qual entidade ele está alocado. Para mais detalhes sobre isso, visite a seção Professores.

Listando a mesma estrutura com o número de usuários associados, teríamos o seguinte:

Network (3 professores)
├── School A (10 professores)
│   ├── Class 1A (21 alunos)
│   ├── Class 1B (20 alunos)
│   └── Class 2A (12 alunos)
└── School B (5 professores)
    ├── Class 3A (5 alunos)
    └── Class 4A (8 alunos)

Nesse exemplo, professores alocados na School A visualizam e gerenciam leitores nas turmas 1A, 1B e 2A. Da mesma forma, professores da School B gerenciam leitores nas turmas 3A e 4A abaixo da sua estrutura.

A criação de uma entidade deve estar de acordo com a hierarquia acima, que é vinculada à conta do parceiro.

Ao criar uma nova entidade, é necessário atenção ao preencher os campos entity_type e parent_reference_id, sendo este último o identificador da entidade que estará logo acima da estrutura criada.

Limitações de acervo e otimização das recomendações

As limitações do acervo de conteúdos disponível, além da curadoria de conteúdos adequados para o leitor, são realizadas através da definição da série dos leitores dentro de uma turma. Essa configuração é feita através do campo série (degree) em uma entidade.

Exemplo

Network (F)
└── School A (F)
    ├── Class 1A (1)
    └── Class 2A (2)

No exemplo acima, temos 4 entidades: uma rede, uma escola e duas turmas. A rede e a escola possuem a série F, que não aplica restrições de acervo de acordo com a idade. Já as turmas 1A e 2A possuem a série 1 e 2, respectivamente, que faz com que os conteúdos sejam filtrados para os primeiros e segundos anos do Ensino Fundamental.

Todos os usuários alocados nessas estruturas (rede, escola e turmas) terão os conteúdos filtrados de acordo com a série alocada para sua estrutura.

Valores possíveis para degree

ValorDescrição
EIEducação Infantil
11ª série (Ensino Fundamental I)
22ª série (Ensino Fundamental I)
33ª série (Ensino Fundamental I)
44ª série (Ensino Fundamental I)
55ª série (Ensino Fundamental I)
66ª série (Ensino Fundamental II)
77ª série (Ensino Fundamental II)
88ª série (Ensino Fundamental II)
99ª série (Ensino Fundamental II)
MEnsino Médio
FProfessores (sem restrição de acervo)