DPServer - Serviço: mudanças entre as edições
Sem resumo de edição |
Sem resumo de edição |
||
| Linha 2: | Linha 2: | ||
Este documento define claramente o escopo de atuação da equipe de '''Desenvolvimento''' e da equipe de '''Atendimento/Suporte''' no processo de geração de versões, instalação e atualização do serviço <code>dpServer</code>. | Este documento define claramente o escopo de atuação da equipe de '''Desenvolvimento''' e da equipe de '''Atendimento/Suporte''' no processo de geração de versões, instalação e atualização do serviço <code>dpServer</code>. | ||
== 💻 1. ESCOPO DO DESENVOLVIMENTO | == 💻 1. ESCOPO DO DESENVOLVIMENTO == | ||
=== 1.1. Alteração da Versão do Executável (Assembly) === | === 1.1. Alteração da Versão do Executável (Assembly) === | ||
* Incrementar o número da versão física do arquivo sempre que houver modificações. | * Incrementar o número da versão física do arquivo sempre que houver modificações. | ||
* '''Como fazer:''' No Visual Studio, acesse as propriedades do projeto <code>dpServerService</code> -> Aba '''Aplicativo''' -> Botão '''Informações do Assembly...''' -> Incremente a '''Versão do assembly''' e '''Versão do arquivo''' (Ex: <code>1.0.0.0</code> para <code>1.1.0.0</code>).[[Arquivo:Mudança de versão - dpServerService.png| | * '''Como fazer:''' No Visual Studio, acesse as propriedades do projeto <code>dpServerService</code> -> Aba '''Aplicativo''' -> Botão '''Informações do Assembly...''' -> Incremente a '''Versão do assembly''' e '''Versão do arquivo''' (Ex: <code>1.0.0.0</code> para <code>1.1.0.0</code>).[[Arquivo:Mudança de versão - dpServerService.png|miniaturadaimagem|785x785px|centro]] | ||
* ''Nota:'' Nunca utilize a aba "Publicar" (ClickOnce), pois o serviço não lê essa numeração. | * ''Nota:'' Nunca utilize a aba "Publicar" (ClickOnce), pois o serviço não lê essa numeração. | ||
| Linha 15: | Linha 15: | ||
=== 1.3. Compilação e Geração do Instalador (.msi) === | === 1.3. Compilação e Geração do Instalador (.msi) === | ||
Separar apenas os arquivos necessários para a atualização e disponibilizá-los para a equipe de Atendimento. | |||
O projeto possui um projeto de Setup integrado (usando Microsoft Visual Studio Installer Projects). | O projeto possui um projeto de Setup integrado (usando Microsoft Visual Studio Installer Projects). | ||
# Na janela do ''Solution Explorer'', localize o projeto de instalação ( | # Na janela do ''Solution Explorer'', localize o projeto de instalação ('''<code>dpServerService.Setup</code>''') . | ||
# Clique com o botão direito sobre o projeto '''<code> | # Clique com o botão direito sobre o projeto '''<code>dpServerService.Setup</code>'''e selecione '''Compilar''' (''Build'') ou ''Rebuild''. | ||
# O Visual Studio gerará os arquivos de instalação na pasta de saída do setup. | # O Visual Studio gerará os arquivos de instalação na pasta de saída do setup. | ||
# Navegue até a pasta física do projeto de setup (Ex: <code>...\</code><code>dpServerService.Setup\Release\</code>) e copie o arquivo '''<code>dpServerService.Setup</code>''' (e o <code>setup.exe</code> se houver). | # Navegue até a pasta física do projeto de setup (Ex: <code>...\</code><code>dpServerService.Setup\Release\</code>) e copie o arquivo '''<code>dpServerService.Setup.msi</code>''' (e o <code>setup.exe</code> se houver). | ||
# Disponibilize | # Disponibilize estes arquivos para a equipe de Atendimento. | ||
⚠️ '''REGRA:''' '''NUNCA''' inclua o arquivo <code>dpServerService.exe.config</code> (App.Config) no pacote de atualização. O envio deste arquivo destrói as configurações customizadas do cliente, pois é lá que fica configurado o caminho dos arquivos de atualização. | |||
== 🛠️ 2. ESCOPO DO ATENDIMENTO / SUPORTE == | == 🛠️ 2. ESCOPO DO ATENDIMENTO / SUPORTE == | ||
| Linha 31: | Linha 32: | ||
* '''O que fazer:''' Instalar o serviço e parametrizar o arquivo (<code>dpServerService.exe.config</code>) de configuração de acordo com a realidade de cada cliente. | * '''O que fazer:''' Instalar o serviço e parametrizar o arquivo (<code>dpServerService.exe.config</code>) de configuração de acordo com a realidade de cada cliente. | ||
* '''Como fazer:''' 1. Executar o instalador <code>. | * '''Como fazer:''' 1. Executar o instalador <code>.msi</code> padrão no servidor do cliente. | ||
Clique em '''avançar''': | |||
[[Arquivo:Instalação setup .msi 1 - dpServerService.png|centro|miniaturadaimagem|471x471px]] | |||
Escolha o caminho de instalação e clique em '''avançar''': | |||
[[Arquivo:Instalação setup .msi 2 - dpServerService.png|centro|miniaturadaimagem|486x486px]] | |||
Clique em '''avançar''': | |||
[[Arquivo:Instalação setup .msi 3 - dpServerService.png|centro|miniaturadaimagem|496x496px]] | |||
Aguarde a instalação concluir e clique em '''fechar'''. | |||
* 2. Abrir o arquivo <code>dpServerService.exe.config</code> com o Bloco de Notas na pasta de instalação <code>C:\Program Files (x86)\...\dpServerService.Setup</code>. | |||
* 3. Configurar a chave '''<code>CaminhoArquivos</code>''' apontando para a pasta raiz acordada (Ex: <code>value="C:\DpServer\"</code>). [[Arquivo:Caminho arquivos - dpServerService.png|centro|miniaturadaimagem|661x661px]] | |||
* 4. Verificar se as credenciais do email estão corretas. | |||
=== 2.2. Gestão do Arquivo DpSettings.xml === | === 2.2. Gestão do Arquivo DpSettings.xml === | ||
* '''O que fazer:''' Garantir que o arquivo de conexão com o banco de dados esteja no local correto determinado pela configuração ( | * '''O que fazer:''' Garantir que o arquivo de conexão com o banco de dados esteja no local correto determinado pela configuração (Deve ser disponibilizado na pasta de instalação). | ||
'''Como fazer:''' Copiar o arquivo <code>DpSettings.xml</code> do cliente e colá-lo dentro da pasta raiz configurada na chave <code>CaminhoArquivos</code> (Ex: dentro de <code>C:\DpServer\</code>).[[Arquivo:DpSettings - dpServerService.png|miniaturadaimagem|448x448px|centro]] | |||
=== 2.3. Iniciando o serviço. === | |||
'''Primeira Instalação:''' > Após concluir as configurações nos arquivos (incluindo o <code>DpSettings.xml</code>), será necessário iniciar o serviço do Windows. Siga os passos abaixo: | |||
# Pressione '''Win + R''', digite <code>services.msc</code> e pressione '''Enter'''. | |||
# Procure pelo serviço '''dpServer''' (caso não o encontre, clique em "Atualizar"). | |||
# Clique em '''Iniciar'''. | |||
# Certifique-se de que o status na coluna correspondente mudou para '''"Em execução"'''.[[Arquivo:Serviços - dpServerServico.png|centro|miniaturadaimagem|712x712px]] | |||
=== 2.4. Aplicação de Atualizações (Update de Versão) === | |||
* Certificar-se de que a subpasta '''<code>Atualizacao</code>''' existe (caso não exista, criar exatamente com esse nome) dentro da pasta raiz do cliente (Ex: <code>C:\DpServer\Atualizacao</code>). | * Certificar-se de que a subpasta '''<code>Atualizacao</code>''' existe (caso não exista, criar exatamente com esse nome) dentro da pasta raiz do cliente (Ex: <code>C:\DpServer\Atualizacao</code>). | ||
* Pegar os arquivos liberados pelo desenvolvimento (<code>.exe</code> e <code>.dlls</code>) e colá-los '''dentro''' dessa pasta <code>\Atualizacao</code>. | * Pegar os arquivos liberados pelo desenvolvimento (<code>.exe</code> e <code>.dlls</code>) e colá-los '''dentro''' dessa pasta <code>\Atualizacao</code>. | ||
| Linha 50: | Linha 71: | ||
* '''Causa 1:''' Os arquivos foram colocados na pasta errada. Certifique-se de que estão dentro da subpasta <code>\Atualizacao</code>. | * '''Causa 1:''' Os arquivos foram colocados na pasta errada. Certifique-se de que estão dentro da subpasta <code>\Atualizacao</code>. | ||
* '''Causa 2:''' O Desenvolvimento esqueceu de mudar a versão do Assembly. Abra as propriedades do arquivo <code>.exe</code> enviado pelo Dev, vá na aba ''Detalhes'' e verifique se a versão é realmente maior do que a que já está rodando.[[Arquivo:Propriedades - dpServerService.png|nenhum|miniaturadaimagem]] | * '''Causa 2:''' O Desenvolvimento esqueceu de mudar a versão do Assembly. Abra as propriedades do arquivo <code>.exe</code> enviado pelo Dev, vá na aba ''Detalhes'' e verifique se a versão é realmente maior do que a que já está rodando.[[Arquivo:Propriedades - dpServerService.png|nenhum|miniaturadaimagem|529x529px]] | ||
=== Onde verificar o que aconteceu? === | === Onde verificar o que aconteceu? === | ||
Edição das 10h05min de 29 de maio de 2026
📖 MANUAL DE DEPLOY E ATUALIZAÇÃO: Matriz de Responsabilidades (dpServer)
Este documento define claramente o escopo de atuação da equipe de Desenvolvimento e da equipe de Atendimento/Suporte no processo de geração de versões, instalação e atualização do serviço dpServer.
💻 1. ESCOPO DO DESENVOLVIMENTO
1.1. Alteração da Versão do Executável (Assembly)
- Incrementar o número da versão física do arquivo sempre que houver modificações.
- Como fazer: No Visual Studio, acesse as propriedades do projeto
dpServerService-> Aba Aplicativo -> Botão Informações do Assembly... -> Incremente a Versão do assembly e Versão do arquivo (Ex:1.0.0.0para1.1.0.0).
- Nota: Nunca utilize a aba "Publicar" (ClickOnce), pois o serviço não lê essa numeração.
1.2. Compilação em Modo Release
- Alterar o seletor do Visual Studio de
DebugparaReleasee executar o comando Recompilar Solução (Rebuild Solution) dos dois projetos.
1.3. Compilação e Geração do Instalador (.msi)
Separar apenas os arquivos necessários para a atualização e disponibilizá-los para a equipe de Atendimento.
O projeto possui um projeto de Setup integrado (usando Microsoft Visual Studio Installer Projects).
- Na janela do Solution Explorer, localize o projeto de instalação (
dpServerService.Setup) . - Clique com o botão direito sobre o projeto
dpServerService.Setupe selecione Compilar (Build) ou Rebuild. - O Visual Studio gerará os arquivos de instalação na pasta de saída do setup.
- Navegue até a pasta física do projeto de setup (Ex:
...\dpServerService.Setup\Release\) e copie o arquivodpServerService.Setup.msi(e osetup.exese houver). - Disponibilize estes arquivos para a equipe de Atendimento.
⚠️ REGRA: NUNCA inclua o arquivo dpServerService.exe.config (App.Config) no pacote de atualização. O envio deste arquivo destrói as configurações customizadas do cliente, pois é lá que fica configurado o caminho dos arquivos de atualização.
🛠️ 2. ESCOPO DO ATENDIMENTO / SUPORTE
O Atendimento é responsável pela implantação no servidor do cliente, configuração dos ambientes, parametrização dos arquivos locais e aplicação de atualizações enviadas pelo desenvolvimento.
2.1. Primeira Instalação e Configuração do Ambiente
- O que fazer: Instalar o serviço e parametrizar o arquivo (
dpServerService.exe.config) de configuração de acordo com a realidade de cada cliente. - Como fazer: 1. Executar o instalador
.msipadrão no servidor do cliente.
Clique em avançar:

Escolha o caminho de instalação e clique em avançar:

Clique em avançar:

Aguarde a instalação concluir e clique em fechar.
- 2. Abrir o arquivo
dpServerService.exe.configcom o Bloco de Notas na pasta de instalaçãoC:\Program Files (x86)\...\dpServerService.Setup. - 3. Configurar a chave
CaminhoArquivosapontando para a pasta raiz acordada (Ex:value="C:\DpServer\").
- 4. Verificar se as credenciais do email estão corretas.
2.2. Gestão do Arquivo DpSettings.xml
- O que fazer: Garantir que o arquivo de conexão com o banco de dados esteja no local correto determinado pela configuração (Deve ser disponibilizado na pasta de instalação).
Como fazer: Copiar o arquivo DpSettings.xml do cliente e colá-lo dentro da pasta raiz configurada na chave CaminhoArquivos (Ex: dentro de C:\DpServer\).

2.3. Iniciando o serviço.
Primeira Instalação: > Após concluir as configurações nos arquivos (incluindo o DpSettings.xml), será necessário iniciar o serviço do Windows. Siga os passos abaixo:
- Pressione Win + R, digite
services.msce pressione Enter. - Procure pelo serviço dpServer (caso não o encontre, clique em "Atualizar").
- Clique em Iniciar.
- Certifique-se de que o status na coluna correspondente mudou para "Em execução".

2.4. Aplicação de Atualizações (Update de Versão)
- Certificar-se de que a subpasta
Atualizacaoexiste (caso não exista, criar exatamente com esse nome) dentro da pasta raiz do cliente (Ex:C:\DpServer\Atualizacao). - Pegar os arquivos liberados pelo desenvolvimento (
.exee.dlls) e colá-los dentro dessa pasta\Atualizacao. - O serviço detectará os arquivos novos, fará a substituição e reiniciará de forma 100% automatizada em até 5 minutos.
🔍 3. GUIA DE RESOLUÇÃO DE PROBLEMAS
Se a atualização falhar ou o serviço não iniciar, o Atendimento deve seguir este roteiro de checagem:
O serviço não atualizou automaticamente?
- Causa 1: Os arquivos foram colocados na pasta errada. Certifique-se de que estão dentro da subpasta
\Atualizacao. - Causa 2: O Desenvolvimento esqueceu de mudar a versão do Assembly. Abra as propriedades do arquivo
.exeenviado pelo Dev, vá na aba Detalhes e verifique se a versão é realmente maior do que a que já está rodando.
Onde verificar o que aconteceu?
- Logs do dpServer: Para visualizar os logs, basta dar um duplo clique sobre o ícone de status.:

- No arquivo de texto: Abra o arquivo
dpServerApp.loglocalizado diretamente na pasta raiz configurada do cliente
- E-mail de avisos: Diferente dos outros logs, o log de e-mail será enviado somente quando ocorrerem erros no processamento:
