PROC007 OS Modo Visualização

	Projeto/Sistema: O.S. - GerencieAqui	Versão do Template: 1.2
	Processo: PROC007 OS Modo Visualização	Versão do Documento: 1.0
	Responsável(eis):  Luís Leite	Data:  05/02/2025

1. Introdução

Este processo visa exemplificar a documentação da visualização da O.S.

Processo	Envolvidos	Dados de Entrada	Dados de Saída
PROC005 Reformulação Tela Principal O.S.	-	Nova ordem de serviço ou edição dos dados da ordem de serviço	Ordem de Serviço salva ou alterada
PROC005.2 Reformulação Tela Principal O.S. - Detalhes	-	Nova ordem de serviço ou edição dos dados da ordem de serviço	Ordem de Serviço salva ou alterada
PROC006 Reformulação Tela de Listagens da O.S.	-	Filtros de período e etapas das O.Ss	Listagem filtrada de ordens de serviço
PROC007 OS Modo Visualização	-	-	-

Processos Relacionados

---

PROC005 Reformulação Tela Principal O.S.

PROC005.1 Reformulação Tela Principal O.S. - Detalhes

PROC006 Reformulação Tela de Listagens da O.S.

Especificação Funcional

---

PROC001 OS em Modo Visualização:

Protótipo de Tela:

Imagem I - Dialog de visualização da Ordem de Serviço

Imagem II - Dialog de visualização da Ordem de Serviço sem checklist

Imagem III - Dialog de visualização da Ordem de Serviço cancelada

Regras de Interface Principais:

1. Primariamente os campos serão exibidos somente para visualização, não podendo ser editados. 

1 Cabeçalho da Visualização:

Protótipo de Tela:

Imagem IV - Cabeçalho da visualização

Descrição dos Campos:

Campo	Tipo	Tamanho	Obrig. ?	Máscara	Observações
Header
Ordem de Serviço	Texto	-	-	-	-
Prioridade	Badge	-	-	-	-
Etapa	Badge	-	-	-	-
Criado em	Texto	-	-	-	-
Cancelar OS	Botão	-	-	-	-
Editar OS	Botão	-	-	-	-
Imprimir OS	Botão	-	-	-	-
Cliente
Nome Cliente	Texto
Telefone	Texto
E-mail	Texto
Ver contato completo	Link
Equipamento
Ver especificações	Link
Nome Equipamento	Texto
Modelo	Texto
N/S	Texto
Garantia	Texto
Técnico	Texto
Informações do Serviço
Aberto Em	Data
Retirada Prevista	Data
Valor	Decmal
Fechamento	Data

Regras de Interface:

1. Header da Dialog

1.1. Prioridade:
Badge da prioridade deve permitir a seleção de outra prioridade, seguindo os valores prefixados de "Alta, Normal e Baixa"

1.2. Etapa:
Badge da Etapa, deve permitir alterar baseado nas etapas cadastradas na empresa. Mais detalhes AQUI.

1.3. Criado em:
Deve exibir a data de criação da O.S. na base de dados concatenado a informação do usuário que criou.

1.4 Cancelar O.S.:
Deve ser aberta a Dialog de validação de ação do usuário. Caso confirme o cancelamento, dialog de confirmação e da Ordem de Serviço devem ser fechadas.

Imagem V - Dialog de confirmação de cancelamento

1.4.1 Reativar OS:
A Ordem de Serviço em estado cancelado deve exibir no lugar do botão de cancelamento, o botão de reativação. Deve abrir a mesma Dialog semelhante ao cancelamento, mas alterar para "Reativar ordem de serviço XXX". 
"Você tem certeza que deseja reativar esta ordem de serviço?"

1.5 Editar O.S.:
Se permitido a edição da O.S. Deve ser redirecionado para a tela de preenchimento da Ordem de Serviço. Caso contrário retornar em tela o aviso da impossibilidade da edição.

Não é permitida a edição da ordem de serviço! Verifique a Etapa em que se encontra.

1.6 Imprimir O.S.:
Deve gerar a impressão da Ordem de Serviço, nova impressão está contida no PROC008 Impressão OS

2. Cliente:

2.1. Ver Contato Completo:
Deverá abrir a Dialog de Contatos do Cliente, contido no PROC007.1 Dialog Contatos, processo se encontra ao fim desse documento.

3. Equipamento:

3.1. Ver especificações: 
Deve abrir Dialog com dados adicionais do equipamento, mais detalhes em .

3.2 Equipamento:
Deve puxar o nome do equipamento vinculado á O.S.

3.3 Modelo: Referente ao campo chave.

3.4 N/S ou Número de Série: Primeiro campo opcional.

3.5 Garantia:
Comparar se a data de garantia salva em banco é inferior a data atual para validar se ela esta ou não fora do período de garantia. Dentro do período deve ser exibida a data em si, caso esteja acima desse período exibir a mensagem "Fora de Garantia"

3.6 Técnico:
Deve exibir o Técnico vinculado na O.S.

4. Equipamento:

4.1 Aberto Em:
Deve exibir a data de criação da Ordem de Serviço.

4.2 Retirada Prevista:
Referente ao campo "Data de Retirada".

4.3 Status de Pagamento:
Deve exibir em tela como "Pago" ou "A Pagar", a depender do estado financeiro da Ordem de Serviço.

4.4 Valor:
Deve ser exibido o valor liquido total da Ordem de Serviço.

4.5 Fechamento:
Deve armazenar a data da finalização da OS ou do seu cancelamento.

Regras de Negócio:

1. Cancelar O.S.:
Se cancelada a Ordem de Serviço, o estado dela na base de dados deve ser alterado para que não seja mais listada.

2. Reativar O.S.:
Ao ser reativada a O.S., deve ser alterado o estado na base e voltar a listar.

3. Editar O.S.:
O botão de Editar O.S. deve validar a permissão de edição cadastrado na Etapa que estará vinculada á Ordem de Serviço. Caso seja permitida a edição, redirecionar para tela de preenchimento (aqui), do contrário não permitir o redirecionamento.

4. Etapa:
A mudança da Etapa também deve validar a inativação da O.S., Caso seja selecionado uma Etapa de inativação, ao salvar a Ordem de Serviço não deve ser mais listada.

Questões Técnicas:

1. A confirmação do Cancelar O.S. deve alterar o campo de estado da O.S. na base de dados para inativar e também deve alterar seu estado de cancelamento.

2. Cancelamento:
Deve ser criado o seguinte campo na base de dados para indicar o cancelamento da O.S.

ALTER TABLE ordemservico
ADD COLUMN cancelado BOOL

3. Fechamento:
Deve ser criado o campo na base de dados para armazenar a data do "fechamento" da OS:

ALTER TABLE ordemservico
ADD COLUMN dataFechamento date

2 Aba Detalhes do Serviço:

Protótipo de Tela:

Imagem VI - Aba Detalhes do Serviço

Descrição dos Campos:

Campo	Tipo	Tamanho	Obrig. ?	Máscara	Observações
Problema Relatado	Texto	-	-	-	-
Laudo Técnico	Texto
Observações	Texto
Observação Interna	Texto
Checklist de estado do equipamento	-	-	-	-	-

Regras de Interface:

1. Checklist de estado do equipamento:
O Checklist de "Estado do Equipamento" só deve ser renderizado caso exista essa informação na Ordem de Serviço, ou seja, um Tipo de Equipamento sem Checklist não trará essa informação, portanto não deve ser renderizado em tela. 

3 Aba Produto/Serviços:

Protótipo de Tela:

Imagem VII - Aba Produtos/Serviços

Descrição dos Campos:

Campo	Tipo	Tamanho	Obrig. ?	Máscara	Observações
Listagem de Produtos/Serviços
Produto/Serviço	Column Header	-	-	-	-
Código	Column Header	-	-	-	-
Quantidade	Column Header	-	-	-	-
Valor Unit.	Column Header	-	-	R$ 0,00	-
Desconto	Column Header	-	-	R$ 0,00	-
Subtotal	Column Header	-	-	R$ 0,00	-
Card Resumo Financeiro
Produtos	Text	-	-	R$ 0,00	-
Serviços	Decimal	-	-	R$ 0,00	-
Desconto	Decimal	-	-	R$ 0,00	-
Total	Decimal	-	-	R$ 0,00	-

Regras de Interface:

1. Listagem:

Produto/Serviço: A coluna deve listar o nome do item inserido na Ordem de Serviço. Deve permitir reordenar ASC ou DESC.
Código: A coluna deve listar o código do item inserido na Ordem de Serviço. Deve permitir reordenar ASC ou DESC.
Quantidade: A coluna deve listar a quantidade do item inserido na Ordem de Serviço. Deve permitir reordenar ASC ou DESC.
Valor Unit.: A coluna deve listar o valor unitário do item inserido na Ordem de Serviço. Deve permitir reordenar ASC ou DESC.
Desconto: A coluna deve listar desconto dado no item inserido na Ordem de Serviço. Deve permitir reordenar ASC ou DESC.
Subtotal: A coluna deve listar o subtotal ou total liquido item inserido na Ordem de Serviço. Deve permitir reordenar ASC ou DESC.

2. Resumo Financeiro:

2.1 Produtos:
Soma dos produtos inseridos na listagem da Ordem de Serviço.
2.2 Serviços:
Soma de serviços inseridos na listagem da Ordem de Serviço.
2.3 Desconto:
Soma dos descontos dados na Ordem de Serviço.
2.4 Total:
Soma de produtos e serviços subtraído pelo desconto.

Regras de Negócio:

1. Subtotal da Listagem:
O subtotal é calculado automaticamente, sendo Subtotal = (Valor Unitário × Quantidade) - Desconto

4 Aba Anexos:

Protótipo de Tela:

Imagem VIII - Aba Anexos

Imagem IX - Aba Anexos expandida

Descrição dos Campos:

Campo	Tipo	Tamanho	Obrig. ?	Máscara	Observações
Anexo	PanelGroup	-	-	-	-
Ver Mais	Link	-	-	-	-

Regras de Interface:

1. Anexos - Em cada anexo devem ter 3 botões

Visualizar =  Deve abrir a visualização do Anexo inserido na Ordem de Serviço.
Excluir = Deve realizar a confirmação da ação com o usuário por meio de uma Dialog "Deseja realizar a exclusão do anexo?" com as opções Sim e Não. Caso positivo, deve ser removido o anexo.
Download = Deve realizar o download do arquivo anexado.

2. Link "Ver Mais":
Deve ser renderizado somente caso possua mais do que três anexos. A ação do clique no link deve carregar mais 3 anexos. 

5 Aba Histórico Anexos:

Protótipo de Tela:

Imagem X - Aba Histórico em loading

Imagem XI - Aba Histórico

Descrição dos Campos:

Campo	Tipo	Tamanho	Obrig. ?	Máscara	Observações
Listagem de Histórico		-	-	-	-

Regras de Interface:

1. Histórico:
Ao clicar na aba de Histórico deve ser feito o Loading para carregar as informações do histórico da movimentação da Ordem de Serviço.
Históricos exemplos no protótipo.

2. O padrão de cada histórico deve ser:
OS criada
Ordem de Serviço criada por {Usuário}

Alterado Status para {Status}
Ordem de Serviço entrou na etapa: {Status} por {Usuário}

OS Finalizada
Ordem de Serviço finalizada por {Usuário}

OS Cancelada
Ordem de Serviço cancelada por {Usuário}

Regras de Negócio:

1. Deve ser criado no banco de dados um histórico para armazenar toda alteração de status, contendo a criação da OS e a finalização dela. 

Questões Técnicas:

1. Deve ser criado uma coluna para armazenar as informações de histórico:

ALTER TABLE gerencieaqui.ordemservico ADD historico VARCHAR (3500) NULL;

2. Deve ser armazenado um JSON com o histórico:

[
   {
      "tipoAcao": "criacao",
      "Status": "novo",
      "usuario": "João da Silva",
      "horario": dd-mm-aaaa hh:mm:ss
    },
    {
      "tipoAcao": "mudanca_status",
      "Status": "finalizado",
      "usuario": "João da Silva",
      "horario": dd-mm-aaaa hh:mm:ss
    }
    ...
]

3. Fixo devem ser utilizados o tipoAcao "criacao" quando abre a OS, "cancelada" e "finalizada".

4. Quando o tipoAcao for "mudanca_status", o campo chave Status deve refletir o novo Status alterado na OS.

PROC007.1 Dialog Contatos:

Protótipo de Tela:

Descrição dos Campos:

Campo	Tipo	Tamanho	Obrig. ?	Máscara	Observações
Nome	Texto		-	-	-
Celular	Texto		-	-	-
Telefone	Texto		-	-	-
E-mail	Texto		-	-	-
Adicionar Contato!	Botão		-	-	-
Listagem de contatos	Listagem		-	-	-
Nome	Column Header		-	-	-
Celular	Column Header		-	-	-
Telefone	Column Header		-	-	-
E-mail	Column Header		-	-	-
Ações	Column Header		-	-	--

Regras de Interface:

1. Nome:
Deve conter o placeholder "Informe o nome do Contato"

2. Celular:
Deve conter o placeholder "Informe o número de celular"

3. Telefone:
Deve conter o placeholder "Informe o número de telefone"

4. E-mail:
Deve conter o placeholder "Informe o número de telefone"

5. Adicionar Contato:
Deve validar se existe um "Nome" preenchido, caso tenha, exibir a mensagem de confirmação de vínculo de contato:

Contato adicionado com sucesso!

5.1 Caso não tenha o "Nome" preenchido, retornar aviso:

O nome do contato é obrigatório!

6. Listagem:

6.1 Nome: Deve permitir a ordenação por ASC e DESC
6.2 Celular: Deve permitir a ordenação por ASC e DESC
6.3 Telefone: Deve permitir a ordenação por ASC e DESC
6.4 E-mail: Deve permitir a ordenação por ASC e DESC
6.5 Ações: Contém as seguintes opções por botão

• • • • Favorito/Contato Principal:
        Somente um contato pode ser o favorito, ao clicar no botão de "contato principal" de outro contato, deve ser desmarcado o contato favorito anterior e salvo no que foi realizado a ação do clique.
        Caso clique novamente no ícone do contato já favoritado, não permitir desmarcar e retornar aviso em tela:

"Não é possível retirar o contato principal"

• • • • Editar :
        Deve liberar os campos nome, celular, telefone e e-mail para edição.
        Os botões de ação serão alterados para, para confirmar ou cancelar a edição.
        
        
        
        
      • Excluir:
        Deve remover o registro selecionado

Questões Técnicas Gerais:

1. A confirmação do Cancelar O.S. deve alterar o campo de estado da O.S. na base de dados para inativar e também deve alterar seu estado de cancelamento.

2. Cancelamento:
Deve ser criado o seguinte campo na base de dados para indicar o cancelamento da O.S.

ALTER TABLE ordemservico
ADD COLUMN cancelado BIT --0 Ativo; 1 Cancelado

3. Fechamento:
Deve ser criado o campo na base de dados para armazenar a data do "fechamento" da OS:

ALTER TABLE ordemservico
ADD COLUMN dataFechamento date

©SOFTEN SISTEMAS 2025