Em Desenvolvimento
Esta documentação ainda está em desenvolvimento. Agradecemos sua paciência!
Pular para o conteúdo principal
Versão: 03.008.000 🚧 (em desenvolvimento)

Instalação e operação do Content App

Esta página descreve como o Content App é publicado e quais ajustes o administrador pode fazer sem recompilar a imagem.

Publicação​

O Content App roda no container aca, atrás do proxy do PRESTOBR, e é servido no caminho /aca/ do endereço público da instalação (por exemplo, https://seuservidor/aca/). Ele é habilitado ao subir o módulo no stack:

./run.sh aca

Para subir o módulo sempre, informe DIST_MODULES="aca" (ou "aca portal") no .env. O proxy só publica o caminho /aca quando o módulo está habilitado. Para que o Content App seja a tela inicial (/) do endereço, defina PROXY_DEFAULT_URL=aca no .env.

URLs sem #​

As telas do Content App usam endereços limpos, como /aca/personal-files ou /aca/capture, sem #. Consequências:

  • Atualizar a página (F5) e abrir um link direto em qualquer tela funcionam normalmente.
  • Links enviados por e-mail (tarefas, recuperação de senha) e favoritos apontam diretamente para a tela.
  • Favoritos antigos que contenham /#/ não são reconhecidos e devem ser refeitos.

Variáveis do container​

Definidas no serviço aca do arquivo compose.aca.yml da distribuição.

VariávelFunçãoValor padrão na distribuição
BASE_PATHCaminho em que o Content App é servido/aca/
APP_CONFIG_ECM_HOSTEndereço público do repositório (servidor Alfresco)${PUBLIC_BASE_URL}
APP_BASE_SHARE_URLEndereço do Alfresco Share, usado nos atalhos para a interface clássica${PUBLIC_BASE_URL}/share
APP_CONFIG_APPLICATION_NAMENome da aplicação exibido no cabeçalhoHTF Apps
APP_CONFIG_APPLICATION_LOGOLogo do cabeçalho (caminho dentro da aplicação)assets/images/app-logo.svg
APP_CONFIG_OAUTH2_HOSTServidor de identidade; EMPTY desliga o uso de OAuth2 e mantém o login por usuário e senhaEMPTY
APP_CONFIG_PLUGIN_TAGSHabilita (true) ou desabilita (false) a gestão de tagspadrão da aplicação
APP_CONFIG_PLUGIN_CATEGORIESHabilita ou desabilita a gestão de categoriaspadrão da aplicação
APP_CONFIG_SEARCH_CUSTOM_FILECaminho do arquivo de busca customizada (veja abaixo)/config/search-custom.json
TZFuso horário do container${TZ} do .env

Após alterar qualquer variável, recrie o container: docker compose up -d aca.

Identidade visual​

O nome e o logo do cabeçalho são ajustados pelas variáveis APP_CONFIG_APPLICATION_NAME e APP_CONFIG_APPLICATION_LOGO. As demais imagens são substituídas montando um arquivo sobre o original, na seção volumes do serviço aca:

ImagemCaminho dentro do container
Logo do cabeçalho/usr/share/nginx/html/assets/images/app-logo.svg
Logo da tela de login/usr/share/nginx/html/assets/images/updated-alfresco-logo.svg
Fundo (login, esqueci minha senha, redefinição de senha, captura externa e tarefa externa)/usr/share/nginx/html/assets/images/Wallpaper-BG-generic.svg

Exemplo:

volumes:
- ./customs/meu-logo-header.svg:/usr/share/nginx/html/assets/images/app-logo.svg
- ./customs/meu-logo-login.svg:/usr/share/nginx/html/assets/images/updated-alfresco-logo.svg
- ./customs/meu-fundo.svg:/usr/share/nginx/html/assets/images/Wallpaper-BG-generic.svg

Busca customizada​

Os filtros da busca e os conjuntos de filtros (seletor no topo da tela de busca, ao lado de Padrão, Dublin Core e Efetividade) podem ser ajustados sem recompilar a imagem e sem repetir a configuração padrão. O administrador monta um arquivo JSON no container, que é aplicado sobre a configuração padrão a cada inicialização.

Como ativar​

  1. Crie o arquivo customs/search-custom.json no diretório da distribuição.

  2. Monte-o no serviço aca como somente leitura:

    volumes:
    - ./customs/search-custom.json:/config/search-custom.json:ro
  3. Reinicie o container: docker restart aca.

Para usar outro caminho, defina APP_CONFIG_SEARCH_CUSTOM_FILE.

Formato do arquivo​

O arquivo é um objeto com duas chaves, ambas opcionais:

  • categories: filtros adicionados ao conjunto Padrão (por exemplo, um filtro de "Tipo documental").
  • presets: conjuntos novos de filtros, exibidos no seletor do topo. Cada um pode ser restrito a um tipo documental e ter filtros próprios, campos pesquisados, ordenação e destaque de resultados (equivale a um formulário de busca avançada do Share).

A mesclagem é por identificador (id): um id que já existe substitui o item na mesma posição; um id novo é acrescentado ao final. O que não for citado no arquivo permanece como na imagem. Um arquivo contendo apenas uma lista é tratado como categories. Os rótulos aceitam texto literal.

Exemplo reduzido, com um filtro no conjunto Padrão:

{
"categories": [
{
"id": "documentType",
"name": "Tipo documental",
"enabled": true,
"component": {
"selector": "check-list",
"settings": {
"operator": "OR",
"pageSize": 10,
"options": [
{ "name": "Documentos", "value": "TYPE:'cm:content'" },
{ "name": "Pastas", "value": "TYPE:'cm:folder'" },
{ "name": "Assinados", "value": "ASPECT:'sign:signed'" }
]
}
}
}
]
}

A distribuição inclui um exemplo completo em docker/examples/search-custom.json, com o filtro acima e um conjunto Prontuário (filtros por nome do paciente, número do prontuário, datas e categoria).

Comportamento em caso de erro​

A customização é tolerante a falhas: se o arquivo não existir, não for um JSON válido ou não puder ser aplicado, o Content App sobe normalmente com a busca padrão e registra o motivo no log do container (docker logs aca).

Modo de manutenção​

O banner de manutenção do Content App acompanha o modo de manutenção do repositório; não há configuração adicional no container.