Definição de componente
A definição de um componente é realizada através de um arquivo de marcação no formato XML, que deve seguir o arquivo de esquema disponibilizado pelo portal. O link para a documentação desse arquivo de esquema pode ser encontrado na página API e XSD.
Nesse arquivo podem ser definidos:
- Versão: Indica qual é a versão do componente.
- Descrição: Descrição do componente.
- Caminho de códigos-fonte: Caminho de códigos-fonte usado pelo portal para armazenar códigos-fonte gerados pelo mesmo. Típicamente usado em ambientes de desenvolvimento e montagem.
- Restrições de instalação: Validadores que serão checados a cada deploy e a cada undeploy para verificar se o componente pode ser instalado, atualizado ou desinstalado. As restrições podem ser de dependências e podem ser definidas especificando os seguintes dados:
- Identificador do componente: Identificador do componente do qual o componente atual depende.
- Versão: Versão do componente da qual o componente atual depende.
- Tipo de restrição de versão: Indica qual o tipo de restrição de versão esse componente depende. Pode ser: versão igual a, versão maior que ou versão igual a ou maior que. O padrão, caso não informado, é versão igual a.
- Substituição de componentes: Configuração de substituição de componente. Essa configuração deve ser realizada para indicar que o componente atual substitui outros componentes. Essa configuração requer que cada componente substituído seja referenciado nessa configuração, devendo, também, ter sua versão definida.
- Uma substituição pode ser realizado conjuntamente com outros componentes. Nesse caso, para que a substituição ocorra, todos os componentes referenciados na substituição conjunta devem estar presentes no mesmo pacote de deploy para que o mesmo possa ocorrer. Caso não estejam, um erro será gerado e o deploy não ocorrerá.
- Identificador de canal: É o identificador de canal que será usado para identificar para qual website copiar os arquivos estáticos do componente. Se não for especificado, os arquivos estáticos do componente serão copiados para todos os websites. O canal deve existir e pertencer a um website no momento em que for feito o deploy do componente para que a cópia do arquivo aconteça. Caso contrário, deve ser feito o deploy do componente quando isso for feito. Além disso, quando as alterações no website do canal ou no diretório estático do website forem alteradas, deverá ser feito o deploy do componente e a remoção dos arquivos de componentes dos diretórios estáticos anteriores deve ser feita manualmente.
Para maiores informações sobre o arquivo de definição de componente, veja a documentação técnica.