Propostas para o Módulo Workflow
- Definir uma nova árvore de diretórios para o módulo que contemple:
- Isolar o código acessível pelo Expresso (inc);
- Separar o código interno do módulo (lib);
- Separar o código de terceiros (php e js);
- Prever local (custom) para o código das organizações: hooks, plugins, especializações de classes, templates.
- Revisar o código do engine
- Remover métodos desnecessários;
- Encapsular as classes e atributos, segundo orientação por objetos (private, public, protected);
- Remover o design pattern Observer;
- Transferir para o módulo as classes que são de estrutura dos processos e deixar no engine apenas as funcionalidades relativas ao andamento das instâncias;
- Eliminar a sobrecarga de métodos do engine que está sendo feita na pasta inc do workflow. Por exemplo a classe workflow_processomanager;
- Eliminar o parâmetro link do banco de dados passado na construção da classe;
- Documentar o engine com um diagrama de classes e um diagrama entidade-relacionamento;
- Verificar se é possível documentar o engine com algum diagrama comportamental.
- Criar uma nova factory estática para o workflow
- Fazer o registro das classes que podem ser utilizadas;
- Avaliar o design pattern registry e ver como pode ser aproveitado;
- Encapsular objetos do array $Globals;
- Criar um cache na factory;
- Avaliar como pode ser feito um cache de objetos que perdure após um recarregamento da página, por exemplo utilizando sessão ou memcache;
- Definir um hook para implementar o cache personalizado de um organização. Se inexistente, usa o padrão do workflow;
- Aproveitar esta factory também para os processos, e prover uma forma de isolar as classes que são do módulo. Uma possibilidade seria criar uma factory abstrata e uma especialização para o workflow e outra para os processos;
- Verificar se é possível utilizar o autoload para identicar a localização dos arquivos fontes;
- Reorganizar o código do workflow utilizando plugins
- Definir uma estrutura de plugins que possibilite a separação do núcleo do workflow e suas funcionalidades periféricas;
- Entende-se por núcleo do workflow toda a estrutura responsável pela execução de atividades, controle do fluxo dos processos, controle de plugins e segurança;
- Cada plugin deve ter um identificador único que será cadastrado no banco de dados e que possibilite a sua habilitação ou desabilitação;
- No banco de dados devem ser inseridos dados como: o identificador, localização do arquivo da controller, nome da classe e status;
- Os plugins devem estender uma classe geral que defina métodos padrão para registro, instanciação e execução daqueles;
- Em determinados lugares dentro do módulo devem ser definidos hooks. Ex. Menu lateral de administração, aba na interface de usuário, etc.;
- Deve-se criar uma estrutura padrão para os plugins que siga o design pattern MVC;
- Deve existir algum controle de acesso para liberar os plugins para usuários;
- Possibilitar aninhamento de plugins;
- Possibilitar a criação de plugin na área custom da organização.
- Definir uma estrutura de plugins que possibilite a separação do núcleo do workflow e suas funcionalidades periféricas;
- Pesquisar e implantar uma ferramenta para design dos fluxos dos processos
- Atualmente os processos são cadastrados através de formulários, onde o desenvolvedor informa as atividades, transições, perfis, etc. Depois pode exibir um gráfico do processo. A proposta é encontrar uma ferramenta que faça o contrário: desenhe o fluxo e este sirva de entrada para registrar a estrutura do processo. Possivelmente o fluxo será descrito em uma linguagem de definição que pode ser lida pelo módulo workflow, ou então a nova ferramenta poderia acessar diretamente o banco de dados;
- Reformular a interface administrativa para que as operações possam ser feitas sobre a imagem do processo. Por exemplo, clicando sobre ícone de uma atividade tem-se acesso às suas propriedades e perfis;
- Impedir que modificações sejam feitas no fluxo quando existirem instâncias dependentes das atividades.
- Implantar um gerador de código
- Com este novo recurso, quando o gráfico do processo estiver concluído, será gerado o código básico para que o processo funcione. Assim sendo, o desenvolvedor ficaria com a tarefa de preencher lacunas no código, como por exemplo os formulários e métodos associados aos botões.
- Criar um mecanismo autenticado para inclusão de instâncias
- Com esta funcionalidade, sistemas externos poderão iniciar instâncias no workflow, sem passar pelas atividades Start dos processos;
- Considerar o uso de web-service autenticado;
- Considerar a possibilidade de uso de certificado.
- Criar boletins para processos
- Implementar uma área, em cada processo, para divulgar as novidades, melhorias e correções. Isso é útil para os usuários acompanharem a evolução dos processos.
- Avaliar as bibliotedas de javascript utilizadas no Expresso e escolher aquelas que serão as oficiais
- Dentre as bibliotecas existentes, que sejam de mesma natureza, optar por uma delas e modificar o código do módulo.
- Substituir o conector Ajax
- Trocar o atual conector Ajax (connector.js / controller.php) usado na interface do módulo, pelo framework nanoAjax, que já é utilizado nos processos. Substituir todas as chamadas do antigo conector pelo novo.
- Criar um controle de tempo de execução para atividades
- Implementar uma nova funcionalidade para atividades em que possa ser definido um tempo máximo de permanência da mesma com o usuário que detém a posse;
- Criar um job genérico que rode diariamente e selecione as atividades que expiraram os prazos, e de alguma forma comunicar o usuário ou um administrador designado;
- Se ficar inviável criar o job, porque o atual modelo exige configuração do cron do servidor, criar ao menos um página que mostre o resultado das pesquisas com opção de envio de email;
- Verificar a possibilidade de gravar buscas no monitoramento por processo, e efetuar envio de email automático a partir do resultado da busca.
- Prover uma auditoria de queries executadas nas tabelas do módulo Workflow.
- Quando alguma alteração nos dados do processo for realizada, na interface de administração, registrar o evento em banco de dados para se ter um histórico dos acontecimentos. Por exemplo, ativação/desativação de processo, alteração de configuração, inclusão/exclusão de elementos, etc;
- Verificar a possibilidade de executar triggers nas tabelas do módulo Workflow, para logar a atividade sql. Cuidar para não impactar na performance geral do banco;
- Outra abordagem pode ser inserção de código nos principais eventos administrativos, para logar as modificações;
- Pensar em uma maneira de fazer um acompanhamento por processo, onde um usuário possa visualizar qualquer instância, e não somente as que detém a posse;
- Uma solução pode ser a criação de um perfil especial [Leitor] e associar os usuários que podem visualizar instâncias do processo;
- No menu 'mais ações' da instância, criar hooks para possibilitar inclusão de código a ser executado quando a ação for acionada;
- Por exemplo, ao abortar uma instância, realizar também alguma manutenção no banco de dados do processo;
- Modificar o template padrão de processos para:
- Definir um hook para personilizar o template de processos por organização;
- Criar parâmetros para incluir as bibliotecas de javascript.
- Implantar uma ferramenta de automação de testes e deploy
- Considerar a experiência do Serpro-BA com os softwares phpunit, phpdocumentor, codesniffer, ant, hudson (integração contínua);
- Verificar a possibilidade de expandir as funcionalidades do Processo de Transferência;
- Estudar uma maneira de realizar o deploy completo do processo, envolvendo o código fonte e a estrutura de atividades, transições e perfis.
- Executar o código do módulo sob tratamento de exceções (try/catch);