MANEJO DE DOCUMENTOS COM O GXFLOW Introdução GXflow permite associar documentos às diferentes tarefas dos processos. O controle de versões e permissões de edição destes documentos é realizado em forma automática. Além disso, o cliente GXflow incorpora aplicações que permitem ao usuário interagir com os documentos bem como assiná-los digitalmente. Mediante a funcionalidade de manejo de documentos, GXflow permite a associação e propagação de documentos através das diferentes tarefas que compõem os processos de negócio. Para cada tarefa, pode-se definir com quais documento é possível trabalhar, bem como quais operações podem ou devem se realizar sobre cada documento. Um aspecto importante do manejo de documentos que oferece GXflow é que para cada documento mantém-se o traçado todo de modificações às que foi submetido ao longo do processo, e conserva-se a toda a informação sobre o usuário, as mudanças e momento em que foram realizadas. Por sua vez, controla-se automaticamente que apenas um usuário possa realizar modificações sobre um documento num determinado momento. A definição dos documentos e associação dos mesmos a tarefas é feita em GXPM, enquanto o cliente do GXflow fornece aplicações que permitem aos usuários realizar operações sobre os documentos como ser: criação, modificação, eliminação e leitura documentos. A continuação, descrevem-se os passos a seguir para definir novos tipos de documentos em GXPM e a maneira em que funcionam as aplicações que o cliente do GXflow fornece para trabalhar com documentos. Definição de documentos em GXPM Os documentos são definidos em nível de projeto GXPM. Posteriormente, a cada processo deverão se associar os documentos necessários. Depois, a cada tarefa dos processos será possível associar documentos associados ao processo ao qual pertencem. Eis os passos a seguir. DEFINIÇÃO DE DOCUMENTOS EM NÍVEL DE PROJECTO Para definir um novo documento é preciso proceder conforme os seguintes passos: 1. Selecionar a opção Project->Documents do menu principal para exibir o diálogo de documentos 1
2. Pressionar o botão Add (adicionar novo documento) para exibir o seguinte diálogo: A informação fundamental do documento que deve se ingressar neste diálogo é seu nome e tipo (formato) de documento. Está disponível uma ampla lista de tipos de documentos (MS Office, OpenOffice, PDF, entre outros). Por sua vez, é possível atribuir ao documento um modelo mediante a opção Based On Template. É importante esclarecer que o que é feito em GXPM é definir logicamente os documentos. Em tempo de execução, será possível ter várias instâncias de um mesmo documento definido em GXPM. Estas instâncias são as que irão conter o documento. Além disso, como se mostrará mais adiante, a cada instância de documento guardam-se todas suas versões, ou seja, cada mudança que for feita na instância acarreta a geração de um nova versão do documento. 2
Também é possível definir modelos que podem estar associadas a documentos. Para isto no mesmo diálogo de documentos mencionado anteriormente deve se pressionar o botão Templates para acessar o diálogo de modelos. Quando se adiciona um modelo (botão Add) deve-se especificar um nome (Name) que o identificará no projeto, o tipo (Type) e o arquivo em disco correspondente (File). ASOCIAÇÃO DE DOCUMENTOS A PROCESSOS Uma vez definidos os documentos em nível de projeto, é necessário associar estes documentos aos processos nos quais se planeja utilizá-los. Para isso, deve-se selecionar a opção Workflow->Documents (tendo o diagrama aberto de atividade do processo em questão) do menu principal para exibir um diálogo como o seguinte: 3
Para associar um documento ao processo, ele deve ser selecionado da lista Global Documents e pressionar o botão Add-->. É possível associar todos os documentos mediante o botão Add All-->>. Igualmente, para desassociar um documento de um processo, primeiro é preciso selecioná-lo o da lista Docs.of XXXX e pressionar o botão Remove. O botão Remove All remove todos os documentos associados ao processo. ASOCIAÇÃO DE DOCUMENTOS A TAREFAS Uma vez que os documentos foram definidos no projeto e associados aos processos, é possível associá-los às tarefas destes processos. Para isso é necessário abrir o diálogo de propriedades da tarefa em questão e clicar no botão Documents como se exibe na seguinte figura: 4
Assim, vai se desdobrar o diálogo de documentos da tarefa. Nesse diálogo é possível adicionar ou subtrair documentos à tarefa. Por sua vez, para cada documento é possível especificar quais operações podem se realizar. Para isso deve selecionar um documento e clicar no botão Operations. Desdobra-se um diálogo de 3 colunas: Actions, Enabled, Required 5
Action. A coluna Action, exibe as diferentes ações que potencialmente podem se realizar com os documentos. Elas são: New: indica se os usuários poderão criar novas instâncias do documento ao trabalhar sobre esta tarefa. Read: indica se os usuários poderão visualizar (ler) instâncias do documento Update: indica se os usuários poderão modificar instâncias do documento. Delete: indica se os usuários poderão eliminar instâncias do documento ao trabalhar sobre esta tarefa. A coluna Enabled permite especificar quais ações podem se realizar com este documento nesta tarefa. A coluna Required Action permite estabelecer se uma determinada ação sobre o documento é obrigatória para que a tarefa possa se completar. Quer dizer, uma tarefa não poderá se completar se possuir ações requeridas sobre documentos que não tenham sido cumpridas. Manejo de documentos no cliente de GXflow Nesta seção, descrevem-se os requerimentos de configuração para poder trabalhar com documentos do cliente de GXflow assim como também as aplicações que fornece o cliente para trabalhar com documentos. CONFIGURAÇÃO NECESSÁRIA PARA TRABALHAR COM DOCUMENTOS Antes de poder trabalhar com documentos no cliente de GXflow é necessário ter configurado: No modelo GeneXus, deverá-se configurar a preferência Client server information/blob local storage path com o caminho no qual querem se guardar os campos blob no servidor onde reside a aplicação de workflow. Isto é devido a que os documentos são armazenados em campos blob na base de dados. Na Consola de Administração, no grupo de preferências Avançado/Manejo de Documentos, a preferência Habilitada deve estar em Sim e em Caminho de Subida deve se especificar o caminho do diretório no servidor no qual se armazenarão temporalmente os documentos que forem subidos ao servidor (prévio a ser ingressados na base de dados do sistema, os documentos devem ser armazenados temporalmente em disco no servidor. 6
Em caso de estar gerando para Java é necessário copiar as classes que se encontram em \GXFlowClientApplicationFiles\Java\Upload (onde é o diretório de instalação do GXflow) no diretório onde se encontram as classes da aplicação no motor de servlets. APLICAÇÕES PARA MANEJO DE DOCUMENTOS Trabalhar com documentos Quando uma tarefa tem documentos associados, na Caixa de Entrada se visualizará o ícone na coluna de documentos (indicada com o ícone ) para essa tarefa. Ao clicar neste ícone é possível acessar a aplicação Trabalhar com Documentos. NOTA: para visualizar a coluna de documentos é necessário ter a preferência de usuário Caixa de Entrada/Visibilidade/Documentos com o valor Sim. Se em GXPM especificou-se que na tarefa é possível criar instâncias de algum documento, se visualizar-se-á o botão. Clicando neste botão desdobrará um diálogo como o seguinte no qual será possível criar uma nova instância de algum dos documentos para os quais tenha sido habilitada a criação de novas instâncias. 7
Outras ações possíveis com documentos são: Visualizar documentos Acessando a imagen é possível visualizar o conteúdo da última versão do documento. Se o formato do documento tiver uma aplicação associada na máquina cliente, o documento será aberto com essa aplicação. Do contrário, simplesmente será armazenada em disco uma cópia do documento. Modificar documentos Acessando a imagen é possível modificar o conteúdo de um documento. Esta ação corresponde a fazer um check out do documento. Ou seja, o usuário obtém uma cópia em disco do documento para realizar as modificações. Uma vez feitas as modificações, o usuário poderá realizar o correspondente check in do documen quer dizer, subir o documento ao servidor como uma nova versão. É importante esclarecer que uma vez que um usuário realiza o check out de um documento, este permanecerá bloqueado e não poderá ser modificado por ou usuários até realizar o correspondente check in. Subir documentos Acessando a imagem é possível subir uma nova versão de um documento ao servidor (realizar um check in) diálogo que se desdobra deverá se especificar o caminho do documento (na máquina do usuário) que se deseja subir. Esta opção só estará disponível se o usuário tiver realizado o correspondente check out do documento (mencionado na seção anterior). Se a definição do documento em GXPM indica que este deve ser assinado digitalmente, então, além de indicar um camniho para subir o documento será necessário assiná-lo digitalmente Eliminar documentos Acessando a imagen é possível eliminar um documento e todas suas versões. 8
Meus Documentos Esta aplicação faz parte do Escritório do cliente de GXflow e seu propósito é mostrar todos os documentos que foram criados pelo usuário desse escritório. Para cada documento existente pode se visualizar informação descritiva do mesmo como na aplicação Trabalhar com documentos. Além disso, há uma coluna adicional, indicada com o ícone, que permite ver se um documento está bloqueado por um usuário -se foi realizado um Check Out- ou não. Administrador de Documentos Nesta aplicação pode se administrar em nível global todos os documentos existentes na aplicação de workflow independentemente do processo ou tarefa a que pertencem. Esta aplicação pode se acessar na barra de aplicações e somente podem acessar os usuários administradores de processos. Como é exibido na seguinte figura, para cada documento existente pode se visualizar informação descritiva do mesmo como na aplicação Trabalhar com documentos. Ao igual a na aplicação Meus Documentos, dispõe-se da coluna indicada com o icone, que permite ver se um documento está bloqueado por um usuário -se foi realizado um Check Out- ou não. Além disso, dispõem-se de ações maciças que podem ser realizadas sobre documentos: Desfazer Check Out Permite cancelar o Check Out, deixando livre o documento para que outro usuário possa modificá-lo. O usuário que anteriormente tiver realizado o Check Out já não poderá realizar o correspondente Check In. Renomear Permite trocar o nome do documento Eliminar Permite eliminar um documento e todas suas versões. 9
10