Mudanças entre as edições de "Controle de Versão"

De LATROMI Manuais
Ir para: navegação, pesquisa
(Criando um novo objeto)
 
(26 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 1: Linha 1:
 +
[[Arquivo:VersionControlDiagram.png|thumb|Diagrama de Controle de Versão]]
 +
[[Arquivo:ObjectHeader.jpg|thumb|Objeto na revisão 150]]
 +
[[Arquivo:ObjectHeader Alterando.jpg|thumb|Objeto na revisão 150, com alterações em andamento]]
 +
[[Arquivo:SalvandoNovoObjeto.jpg|thumb|Salvando novo objeto]]
 +
[[Arquivo:ObjectReleaseRevert.jpg|thumb|Revertendo alterações em um objeto]]
 
Todos os objetos (consultas, formulários e etc) desenvolvidos dentro do LATROMI possuem suporte a versionamento. Ao criar ou iniciar a alteração de um objeto, o mesmo fica bloqueado para o usuário logado, e ao final das alterações, o mesmo deve ser liberado, gerando assim uma '''revisão''', com o estado atual do objeto armazenado para consulta ou restauração posterior.
 
Todos os objetos (consultas, formulários e etc) desenvolvidos dentro do LATROMI possuem suporte a versionamento. Ao criar ou iniciar a alteração de um objeto, o mesmo fica bloqueado para o usuário logado, e ao final das alterações, o mesmo deve ser liberado, gerando assim uma '''revisão''', com o estado atual do objeto armazenado para consulta ou restauração posterior.
  
 
== Revisões ==
 
== Revisões ==
[[Arquivo:ObjectHeader.jpg|miniaturadaimagem|Objeto na revisão 150]]
+
 
[[Arquivo:ObjectHeader Alterando.jpg|miniaturadaimagem|Objeto na revisão 150, com alterações em andamento]]
 
 
O Controle de Versão é formado por um conjunto de revisões, e cada '''revisão''' é formada por uma ou mais "imagens" de objetos. Através dessa imagem, é possível consultar como um objeto era em determinada data, quem realizou as alterações e até mesmo restaurar as alterações.
 
O Controle de Versão é formado por um conjunto de revisões, e cada '''revisão''' é formada por uma ou mais "imagens" de objetos. Através dessa imagem, é possível consultar como um objeto era em determinada data, quem realizou as alterações e até mesmo restaurar as alterações.
  
Linha 15: Linha 19:
  
 
== Criando um novo objeto ==
 
== Criando um novo objeto ==
O processo de criação de qualquer objeto é muito simples. Basta clicar no botão ''Novo'', preencher os campos obrigatórios e em seguida clicar em ''Salvar''. Quando o objeto for salvo no sistema, ele entrará em modo de alteração, e um bloqueio será criado automaticamente em nome do usuário logado.
+
O processo de criação de qualquer objeto é muito simples. Basta clicar no botão '''Novo''', preencher os campos obrigatórios e em seguida clicar em '''Salvar'''. Quando o objeto for salvo no sistema, ele entrará em '''modo de alteração''', e um bloqueio será criado automaticamente em nome do usuário logado.
  
 
== Alterando um objeto existente ==
 
== Alterando um objeto existente ==
 +
Para iniciar uma alteração em um objeto já existente, basta clicar no botão '''Alterar''', conforme indica a mensagem no cabeçalho do objeto.
  
 
=== Restrições ===
 
=== Restrições ===
 +
Existe algumas restrições que impedem o usuário de iniciar uma alteração em um objeto. Essas restrições são:
 +
* O proprietário do objeto (empresa) é diferente do detentor da licença e uso do sistema.
 +
* O objeto está sendo alterado por outro usuário.
 +
* O objeto foi marcado para exclusão (leia sobre a [[#Excluindo um objeto|exclusão de objetos]]).
  
 
== Excluindo um objeto ==
 
== Excluindo um objeto ==
 +
Ao clicar em ''Excluir'', o objeto não é realmente excluído do sistema. Ele fica marcado para exclusão, e entra na lista de alterações pendentes a serem liberadas. Quando a exclusão for liberada (efetivada), o objeto passa a fazer parte de uma nova revisão, e é enviado para a '''Lixeira''', podendo ser restaurado posteriormente.
 +
 +
Enquanto a exclusão do objeto não for efetivada, o objeto poderá ser carregado em modo '''Somente Leitura''', e a mensagem "''Marcado para Exclusão''" será exibida no cabeçalho do objeto. Após a efetivação da exclusão, o objeto não poderá mais ser carregado, e uma mensagem de crítica será exibida informando que o objeto foi excluído.
  
 
== Liberação de Objetos ==
 
== Liberação de Objetos ==
 +
Existem duas maneiras de liberar um objeto. A primeira, é clicar no botão de alteração quando o texto for "Alterando". Dessa forma, a tela liberação de objeto será aberta, e apenas o objeto selecionado será filtrado. A segunda maneira é através do menu ''Desenvolvimento '''>''' Controle de Versão '''>''' Liberação de Objetos''. Ao abrir este menu, a mesma tela de liberação de objetos será aberta, mostrando todos os objetos pendentes de liberação.
  
 
=== Liberar ===
 
=== Liberar ===
 +
Para realizar a liberação, marque os objetos que deseja liberar, preencha os comentários e clique no botão '''Liberar'''. Após o final do processamento, uma nova revisão será criada, e os objetos liberados farão parte dela.
 +
 +
Após a liberação, os bloqueios são removidos, e o objeto fica disponível para ser alterado por outros usuários.
 +
 +
''OBS.: É muito importante que os comentários sejam preenchidos, para que as alterações realizadas possam ser facilmente identificadas no [[#Log de Revisões|Log de Revisões]].''
  
 
=== Reverter alterações ===
 
=== Reverter alterações ===
 +
Em alguns casos, uma alteração realizada em um objeto pode se tornar desnecessária no final do desenvolvimento. Nestes casos, é possível '''Reverter''' as alterações, fazendo com que o objeto retorne ao seu estado original.
 +
 +
Para reverter alterações, marque os objetos que deseja reverter, e clique no botão '''Reverter'''.
  
 
== Log de Revisões ==
 
== Log de Revisões ==
 +
O Log de Revisões é o histórico de todas as alterações realizadas no projeto. Nele é possível verificar cronologicamente quando e quais objetos foram criados, modificados ou excluídos, e se necessário, restaurar versões anteriores.
 +
 +
Para abrir o Log de Revisões, acesse o menu ''Desenvolvimento '''>''' Controle de Versão '''>''' Log de Revisões'' no LATROMI Client.
  
 
=== Restaurando versões anteriores de um objeto ===
 
=== Restaurando versões anteriores de um objeto ===
 +
Para restaurar a versão anterior de um objeto, localize a revisão que deseja restaurar, clique com o botão direito sobre o objeto (na grade inferior) e clique em '''Restaurar'''. Feito isso, o objeto foi restaurado, mas essa operação ainda precisa ser confirmada e liberada em uma nova revisão. Para isso, acesso a tela de [[#Liberação de Objetos|Liberação de Objetos]].
  
 
== Lixeira ==
 
== Lixeira ==
 +
Todos os objetos excluídos do sistema são movidos para a '''Lixeira''', e podem ser recuperados a qualquer momento pelo administrador do sistema.
 +
 +
Para abrir a Lixeira, acesse o menu ''Desenvolvimento '''>''' Controle de Versão '''>''' Lixeira'' no LATROMI Client.
  
 
=== Restaurando um objeto excluído ===
 
=== Restaurando um objeto excluído ===
 +
Para recuperar um objeto excluído, selecione-o na Lixeira, clique com o botão direito do mouse sobre ele e em seguida clique na opção '''Recuperar'''. Feito isso, o objeto foi recuperado, mas essa operação ainda precisa ser confirmada e liberada em uma nova revisão. Para isso, acesso a tela de Liberação de Objetos.

Edição atual tal como às 12h48min de 10 de setembro de 2018

Diagrama de Controle de Versão
Objeto na revisão 150
Objeto na revisão 150, com alterações em andamento
Salvando novo objeto
Revertendo alterações em um objeto

Todos os objetos (consultas, formulários e etc) desenvolvidos dentro do LATROMI possuem suporte a versionamento. Ao criar ou iniciar a alteração de um objeto, o mesmo fica bloqueado para o usuário logado, e ao final das alterações, o mesmo deve ser liberado, gerando assim uma revisão, com o estado atual do objeto armazenado para consulta ou restauração posterior.

Revisões

O Controle de Versão é formado por um conjunto de revisões, e cada revisão é formada por uma ou mais "imagens" de objetos. Através dessa imagem, é possível consultar como um objeto era em determinada data, quem realizou as alterações e até mesmo restaurar as alterações.

O número de revisão em que um objeto se encontra pode ser conferido no cabeçalho do objeto, ao lado direito do botão de alteração, no formato r<nro revisão>. Se o o caractere + for exibido junto ao número da revisão, significa que objeto está sendo alterado.

Exemplos:
r150: Revisão 150. O objeto não está sendo alterado.
r150+: Revisão 150 sendo alterada por algum usuário. Quando o objeto for liberado, ele será vinculado a um novo número de revisão, e se as alterações forem revertidas, voltará a ser r150.

OBS.: Objetos mais antigos podem não fazer parte de nenhuma revisão, até que uma alteração seja realizada e liberada.

Criando um novo objeto

O processo de criação de qualquer objeto é muito simples. Basta clicar no botão Novo, preencher os campos obrigatórios e em seguida clicar em Salvar. Quando o objeto for salvo no sistema, ele entrará em modo de alteração, e um bloqueio será criado automaticamente em nome do usuário logado.

Alterando um objeto existente

Para iniciar uma alteração em um objeto já existente, basta clicar no botão Alterar, conforme indica a mensagem no cabeçalho do objeto.

Restrições

Existe algumas restrições que impedem o usuário de iniciar uma alteração em um objeto. Essas restrições são:

  • O proprietário do objeto (empresa) é diferente do detentor da licença e uso do sistema.
  • O objeto está sendo alterado por outro usuário.
  • O objeto foi marcado para exclusão (leia sobre a exclusão de objetos).

Excluindo um objeto

Ao clicar em Excluir, o objeto não é realmente excluído do sistema. Ele fica marcado para exclusão, e entra na lista de alterações pendentes a serem liberadas. Quando a exclusão for liberada (efetivada), o objeto passa a fazer parte de uma nova revisão, e é enviado para a Lixeira, podendo ser restaurado posteriormente.

Enquanto a exclusão do objeto não for efetivada, o objeto poderá ser carregado em modo Somente Leitura, e a mensagem "Marcado para Exclusão" será exibida no cabeçalho do objeto. Após a efetivação da exclusão, o objeto não poderá mais ser carregado, e uma mensagem de crítica será exibida informando que o objeto foi excluído.

Liberação de Objetos

Existem duas maneiras de liberar um objeto. A primeira, é clicar no botão de alteração quando o texto for "Alterando". Dessa forma, a tela liberação de objeto será aberta, e apenas o objeto selecionado será filtrado. A segunda maneira é através do menu Desenvolvimento > Controle de Versão > Liberação de Objetos. Ao abrir este menu, a mesma tela de liberação de objetos será aberta, mostrando todos os objetos pendentes de liberação.

Liberar

Para realizar a liberação, marque os objetos que deseja liberar, preencha os comentários e clique no botão Liberar. Após o final do processamento, uma nova revisão será criada, e os objetos liberados farão parte dela.

Após a liberação, os bloqueios são removidos, e o objeto fica disponível para ser alterado por outros usuários.

OBS.: É muito importante que os comentários sejam preenchidos, para que as alterações realizadas possam ser facilmente identificadas no Log de Revisões.

Reverter alterações

Em alguns casos, uma alteração realizada em um objeto pode se tornar desnecessária no final do desenvolvimento. Nestes casos, é possível Reverter as alterações, fazendo com que o objeto retorne ao seu estado original.

Para reverter alterações, marque os objetos que deseja reverter, e clique no botão Reverter.

Log de Revisões

O Log de Revisões é o histórico de todas as alterações realizadas no projeto. Nele é possível verificar cronologicamente quando e quais objetos foram criados, modificados ou excluídos, e se necessário, restaurar versões anteriores.

Para abrir o Log de Revisões, acesse o menu Desenvolvimento > Controle de Versão > Log de Revisões no LATROMI Client.

Restaurando versões anteriores de um objeto

Para restaurar a versão anterior de um objeto, localize a revisão que deseja restaurar, clique com o botão direito sobre o objeto (na grade inferior) e clique em Restaurar. Feito isso, o objeto foi restaurado, mas essa operação ainda precisa ser confirmada e liberada em uma nova revisão. Para isso, acesso a tela de Liberação de Objetos.

Lixeira

Todos os objetos excluídos do sistema são movidos para a Lixeira, e podem ser recuperados a qualquer momento pelo administrador do sistema.

Para abrir a Lixeira, acesse o menu Desenvolvimento > Controle de Versão > Lixeira no LATROMI Client.

Restaurando um objeto excluído

Para recuperar um objeto excluído, selecione-o na Lixeira, clique com o botão direito do mouse sobre ele e em seguida clique na opção Recuperar. Feito isso, o objeto foi recuperado, mas essa operação ainda precisa ser confirmada e liberada em uma nova revisão. Para isso, acesso a tela de Liberação de Objetos.