🛠️ Documentação Técnica: Download Arquivo Pagamento

[!NOTE] Documentação Gerada Automaticamente O conteúdo abaixo foi gerado por IA através de engenharia reversa do código-fonte e deve ser validado.

Documentação Base — C:\Webfopag\Etec.WebFopag\Employer.Plataforma.Web.WebFoPag\DownloadArquivoPagamento.aspx

👁️ 1. Visão Geral

A tela “Download de Arquivos de Pagamento” permite aos usuários pesquisar e baixar arquivos de pagamento gerados pelo sistema. Ela oferece filtros por banco, período de geração, período de pagamento, lote de pagamento, tipo de arquivo (gerado/retorno lido) e situação de conferência. Os usuários podem baixar arquivos individualmente (normal ou criptografado), baixar múltiplos arquivos selecionados em formato ZIP, ou solicitar a regeneração de um arquivo de pagamento.

🗂️ 2. Tipos/Modalidades

A tela opera em diferentes modalidades de download e geração:

• Download Normal: Baixa o arquivo diretamente.
• Download Criptografado: Baixa o arquivo após criptografia, exigindo configuração de ambiente (ArquivoChaveCriptografiaWebTA, SenhaCriptografiaWebTA).
• Download em Lote (ZIP): Permite selecionar múltiplos arquivos na grid e baixá-los compactados em um único arquivo ZIP.
• Geração de Arquivo Novamente: Abre um modal para solicitar a regeneração de um arquivo de pagamento específico, permitindo alterar o banco, convênio bancário e tipo de operação.
• Criptografia e Transmissão Assíncrona CNAB: Para o centro de serviço “syngentacom”, permite solicitar a criptografia e transmissão assíncrona de arquivos CNAB.

🖥️ 3. Interface — Campos e Controles

📑 4. Abas e Seções

A tela é dividida nas seguintes seções principais:

• Painel de Filtros (div.painel_padrao): Contém os campos de filtro para pesquisa de arquivos de pagamento (Banco, Período Geração Arquivo, Período Pagamento, Lote Pagamento, Arquivo Gerado / Retorno Lido, Situação Conferência Arquivo).
• Botões de Ação (div.panel_botoes_secao): Contém os botões “Pesquisar”, “Baixar Selecionados (ZIP)”, “Limpar” e “Voltar”.
• Painel de Grid (asp:UpdatePanel ID="upnGridView"): Contém a grid gvwArquivosGerados para exibição dos resultados da pesquisa, o dropdown de seleção em massa ddlSelecaoArquivosGerados e o totalizador divTotalizador.
• Modal de Geração de Arquivo Novamente (asp:Panel ID="pnlModalGerarArquivoNovamente"): Um modal que é exibido quando o usuário clica em “Gerar Arquivo Novamente” na grid. Contém campos para confirmar/alterar Banco, Convênio Bancário e Tipo de Operação, além de botões para “Salvar” (gerar arquivo) e “Limpar”. Inclui o UserControl ConfirmacaoSenha.

🛡️ 5. Regras de Negócio

5.1. Validações de Campos

• txtPeriodoGeracaoArquivoDe: Deve ter o padrão dd/mm/aaaa. (Frontend/ASPX)
• txtPeriodoGeracaoArquivoAte: Deve ter o padrão dd/mm/aaaa. (Frontend/ASPX)
• txtPeriodoPagamentoDe:
• Deve ter o padrão dd/mm/aaaa. (Frontend/ASPX)
• É obrigatório se txtPeriodoPagamentoAte tiver um valor preenchido. (ASPX.CS - txtPeriodoPagamento_ValorAlterado)
• Não pode ser maior que txtPeriodoPagamentoAte. (ASPX.CS - txtPeriodoPagamento_ValorAlterado)
• txtPeriodoPagamentoAte:
• Deve ter o padrão dd/mm/aaaa. (Frontend/ASPX)
• É obrigatório se txtPeriodoPagamentoDe tiver um valor preenchido. (ASPX.CS - txtPeriodoPagamento_ValorAlterado)
• Não pode ser menor que txtPeriodoPagamentoDe. (ASPX.CS - txtPeriodoPagamento_ValorAlterado)
• txtNumeroLotePagamento:
• Não é obrigatório. (Frontend/ASPX)
• Deve conter apenas números. (Frontend/ASPX - Tipo="Numeros" SomenteNumeros="true")
• Valor mínimo: 0. (Frontend/ASPX - ValorMinimo="0")
• Valor máximo: 999999999. (Frontend/ASPX - ValorMaximo="999999999")
• lsArquivoGeradoRetornoLido: Deve conter uma das sugestões. (Frontend/ASPX)
• lsSituacaoConferenciaArquivo: Deve conter uma das sugestões. (Frontend/ASPX)
• txtBancoConfirmacao (Modal): É obrigatório. (Frontend/ASPX)
• txtConvenioBancarioConfirmacao (Modal): É obrigatório. (Frontend/ASPX)
• lsTipoOperacaoConfirmacao (Modal): É obrigatório. (Frontend/ASPX)

5.2. Regras de Habilitação/Desabilitação e Visibilidade

• ddlSelecaoArquivosGerados: Visível apenas se houver arquivos na grid gvwArquivosGerados (gvwArquivosGerados.Rows.Count > 0). (ASPX.CS - CarregarGridViewArquivosGerados)
• divTotalizador: Visível apenas se houver arquivos na grid gvwArquivosGerados (gvwArquivosGerados.Rows.Count > 0). (ASPX.CS - CarregarGridViewArquivosGerados)
• btnBaixarSelecionados: Visível apenas se o usuário tiver a permissão PagamentoFolha.DownloadArquivosPagamentos. (ASPX.CS - ConfigurarPermissoesTela)
• btnGerarArquivoNovamente (grid): Habilitado apenas se o usuário tiver a permissão PagamentoFolha.PermitirGerarArquivoNovamente. (ASPX.CS - ConfigurarPermissoesTela)
• btnDownload (grid): Visível apenas se o campo Nme_Arquivo do registro da grid não for nulo ou vazio e o usuário tiver a permissão PagamentoFolha.DownloadArquivosPagamentos. (ASPX.CS - gvwArquivosGerados_RowDataBound)
• btnDownloadCript (grid): Visível apenas se o campo Nme_Arquivo do registro da grid não for nulo ou vazio e o usuário tiver a permissão PagamentoFolha.DownloadArquivosPagamentosCriptografados. (ASPX.CS - gvwArquivosGerados_RowDataBound)
• btnCriptografiaTransmissaoAssinc (grid): Visível apenas se o usuário tiver a permissão PagamentoFolha.TransmissaoArquivosPagamentosCriptografados, o NomeCentroServico for “syngentacom” (case insensitive) e o campo Nme_Arquivo do registro da grid não for nulo ou vazio. (ASPX.CS - gvwArquivosGerados_RowDataBound)
• btnGerarArquivoNovamente (grid): Visível apenas se o Idf_Status_Geracao_Arquivo do registro da grid for “3” (Erro) ou “4” (Cancelado). (Frontend/ASPX)
• txtBancoConfirmacao (Modal): Sempre desabilitado (Enabled="false"). (Frontend/ASPX)
• txtConvenioBancarioConfirmacao (Modal): Desabilitado inicialmente (Enabled="false"). Habilitado após confirmação de senha master via btnAlterarConvenioBancario. (ASPX.CS - modalConfirmacaoSenha_OnConfirmar)
• lsTipoOperacaoConfirmacao (Modal): Desabilitado se houver apenas um tipo de pagamento financeiro para o convênio bancário selecionado. Habilitado caso contrário. (ASPX.CS - CarregarListaSugestaoTipoOperacao)

5.3. Regras de Inativação e Exclusão

• Não aplicável diretamente a esta tela, que foca em download e geração de arquivos de pagamento.

5.4. Regras de Salvar e Fluxo de Configuração

• SolicitarGeracaoArquivoPagamento (ASPX.CS):
• Verifica se IdArquivoGerado possui valor. Se não, exibe mensagem “Pagamento não encontrado. Favor verificar.”.
• Identifica o TipoObjetoPagamento (Holerite, Benefício, Pensão, RPA) a partir dos lotes do arquivo gerado (ArquivoGeradoLote.CarregarPorArquivoGerado). Se não for possível identificar, exibe mensagem “Não foi possível identificar de qual tipo de pagamento é o arquivo selecionado. Favor verificar.”.
• Chama ArquivoGerado.SalvarSolicitacaoGeracaoNovoArquivoPagamento para registrar a solicitação com idTipoObjetoPagamento.Value, IdArquivoGerado.Value, txtBancoConfirmacao.IdBancoSelecionado.Value, txtConvenioBancarioConfirmacao.IdConvenioBancarioSelecionado.Value, lsTipoOperacaoConfirmacao.ValorInt.
• Inicia um processo assíncrono (ProcessoAssincrono.IniciarAtividade) para a geração do relatório, com base no TipoObjetoPagamento (mapeado para PluginEntradaRelatorio). Os parâmetros incluem pNomeCentroServico, pIdEmpresa, pIdUsuario, e uma lista de pListaIdArquivoGeradoLote.

5.5. Outras Regras Específicas da Tela

• Download de Arquivos (ASPX.CS - EfetuarDownload):
• Se LstArquivosGeradosSelecionados estiver vazia, exibe mensagem “Nenhum arquivo de pagamento foi selecionado para realizar o download. Favor verificar.”.
• Para cada idArquivo selecionado:
• Carrega ArquivoGerado.LoadObject(idArquivo).
• Se objArquivo.NomeArquivo ou objArquivo.ArquivoEnvio for nulo, exibe mensagem “Alguns dos arquivos selecionados não estão prontos para download. Favor verificar.”.
• Se objArquivo.StatusConferenciaArquivo.IdStatusConferenciaArquivo for StatusConferenciaArquivo.Cancelado, exibe mensagem “Arquivo indisponível para download devido ao status de cancelado.”.
• Arquivos ALELO: Se o banco for ALELO (CodigoBanco.ALELO) e objArquivo.ArquivoEnvio contiver a tag "", o conteúdo é dividido por essa tag. Cada parte é salva como um arquivo temporário separado, com um sufixo “(X).CSV” adicionado ao nome original.
• Os arquivos são salvos temporariamente em Server.MapPath("\\ArquivosTemporarios\\") + chaveUnica + "\\".
• Se o arquivo não for CSV, é salvo com Encoding.ASCII.GetBytes. Se for CSV, é salvo com Encoding.GetEncoding("ISO-8859-1").GetBytes.
• Compactação (ASPX.CS - CompactArquivos): Múltiplos arquivos selecionados são compactados em um arquivo ZIP temporário com o nome “Arquivo Pagamento - {chaveUnica}.zip”.
• Download Criptografado (ASPX.CS - EfetuarDownload(..., true)):
• Requer que os parâmetros do sistema ArquivoChaveCriptografiaWebTA e SenhaCriptografiaWebTA estejam configurados. Se não, exibe mensagem de erro.
• O arquivo é criptografado usando CriptWebTAHelper().Criptografar() com uma chave localizada em CriptografiaWebTA dentro do diretório da aplicação.
• Se a criptografia falhar ou o arquivo criptografado não for gerado, exibe mensagem de erro.
• Permissões (ASPX.CS - ConfigurarPermissoesTela, btnBaixarSelecionados_OnClick, btnGerarArquivoNovamente_OnClick, gvwArquivosGerados_RowDataBound): A visibilidade e habilitação de botões e funcionalidades são controladas pelas permissões do usuário logado, verificadas através de LstPermissoes.Contains() e Util.ValidaPermissaoUsuario().
• Inicialização (ASPX.CS - Inicializar):
• txtBanco.IdEmpresa é definido com o CodigoEmpresa do usuário logado.
• lsArquivoGeradoRetornoLido.Valor é inicializado como “1” (Arquivos Gerados).
• lsSituacaoConferenciaArquivo.ValorInt é inicializado como StatusConferenciaArquivo.Pendente.
• ArquivoChaveCriptografiaWebTA e SenhaCriptografiaWebTA são recuperados de Parametro.RecuperaValorParametro.
• Seleção em Massa (ASPX.CS - ddlSelecaoArquivosGerados_OnSelectedIndexChanged):
• As opções “Desmarcar todos”, “Marcar todos”, “Desmarcar todos desta página” e “Marcar todos desta página” manipulam a LstArquivosGeradosSelecionados e atualizam o lblQuantidadeArquivosSelecionados.
• A opção “Marcar todos” e “Marcar todos desta página” só seleciona arquivos que realmente possuem um arquivo para download (r.Value no dicArquivosGerados).
• Alteração de Convênio Bancário (Modal) (ASPX.CS - btnAlterarConvenioBancario_OnClick, modalConfirmacaoSenha_OnConfirmar): Requer confirmação de senha master (Permissoes.SenhaMaster.SenhaMaster) para habilitar o campo txtConvenioBancarioConfirmacao.
• Carregamento de Tipo de Operação (Modal) (ASPX.CS - CarregarListaSugestaoTipoOperacao): Popula lsTipoOperacaoConfirmacao com base nos tipos de pagamento financeiro do convênio bancário selecionado (TipoPagamentoFinanceiro.ListarTipoPagamentoFinanceiroPorConvenioBancario). Se houver apenas um tipo, o campo é desabilitado e preenchido automaticamente.

🔄 6. Fluxos Principais

6.1. Inicialização da Tela

1. Page_Load: Se não for um postback, chama Inicializar().
2. Inicializar():

• ConfigurarPermissoesTela(): Carrega as permissões do usuário e ajusta a visibilidade/habilitação de controles.
• CarregarListasSugestoes(): Popula lsArquivoGeradoRetornoLido e lsSituacaoConferenciaArquivo.
• txtBanco.IdEmpresa = this.CodigoEmpresa;
• lsArquivoGeradoRetornoLido.Valor = "1"; (Arquivos Gerados)
• lsSituacaoConferenciaArquivo.ValorInt = StatusConferenciaArquivo.Pendente.GetHashCode();
• PesquisarArquivosGeradosParaDownload(): Executa a pesquisa inicial de arquivos, populando dicArquivosGerados.
• CarregarGridViewArquivosGerados(): Carrega a grid com os resultados da pesquisa.
• Recupera ArquivoChaveCriptografiaWebTA e SenhaCriptografiaWebTA dos parâmetros do sistema (Parametro.RecuperaValorParametro).

6.2. Pesquisar Arquivos

1. btnPesquisar_OnClick:

• gvwArquivosGerados.MockPageIndex = 0; (reseta a paginação da grid)
• PesquisarArquivosGeradosParaDownload(): Filtra os arquivos com base nos campos da tela e popula dicArquivosGerados.
• CarregarGridViewArquivosGerados(): Atualiza a grid com os novos resultados.
• upnGridView.Update(): Atualiza o painel da grid.

6.3. Download de Arquivos Selecionados (ZIP)

1. btnBaixarSelecionados_OnClick:

• Util.ValidaPermissaoUsuario(): Verifica a permissão PagamentoFolha.DownloadArquivosPagamentos. Se não tiver, exibe mensagem de aviso.
• EfetuarDownload(): Inicia o processo de download.
• Verifica se LstArquivosGeradosSelecionados está vazia. Se sim, exibe mensagem de erro.
• Itera sobre LstArquivosGeradosSelecionados.Distinct():
• ArquivoGerado.LoadObject(): Carrega o objeto ArquivoGerado.
• objArquivo.CompleteObject(): Completa o objeto ArquivoGerado.
• Valida se NomeArquivo e ArquivoEnvio não são nulos. Se não, exibe mensagem de erro.
• Verifica StatusConferenciaArquivo.Cancelado. Se sim, exibe mensagem de erro.
• Lógica específica para arquivos ALELO (CodigoBanco.ALELO e ArquivoEnvio.Contains("<divALELO/>")): divide o ArquivoEnvio e chama AdicionaArquivoPasta para cada parte com um sufixo numérico.
• AdicionaArquivoPasta(): Salva o arquivo temporariamente no diretório \\ArquivosTemporarios\\{chaveUnica}\\.
• CompactArquivos(): Compacta os arquivos temporários em um arquivo ZIP.
• Envia o arquivo ZIP para o navegador (Response.Clear, Response.AddHeader, Response.ContentType, Response.WriteFile, Response.End).

6.4. Download de Arquivo Individual (Normal ou Criptografado)

1. gvwArquivosGerados_OnRowCommand (CommandName “download” ou “downloadcript”):

• Recupera Idf_Arquivo_Gerado (dataKeyValue) do DataKeys da grid.
• Chama EfetuarDownload(dataKeyValue, criptografado).
• Carrega o objeto ArquivoGerado.LoadObject(pIdArquivoGerado).
• objArquivo.CompleteObject(): Completa o objeto ArquivoGerado.
• Lógica específica para arquivos ALELO (mesma do download em lote).
• Se criptografado for true:
• Valida ArquivoChaveCriptografiaWebTA e SenhaCriptografiaWebTA. Se não configurados, exibe mensagem de erro.
• Chama CriptWebTAHelper().Criptografar() para gerar o arquivo criptografado (_WEBTA.REM). Se falhar, exibe mensagem de erro.
• Envia o arquivo criptografado para o navegador.
• Se criptografado for false:
• Envia o arquivo normal para o navegador.

6.5. Gerar Arquivo Novamente (Modal)

1. gvwArquivosGerados_OnRowCommand (CommandName “GerarArquivoNovamente”):

• Recupera Idf_Arquivo_Gerado (dataKeyValue) do DataKeys da grid.
• AbrirModalGerarArquivoNovamente(dataKeyValue):
• Define IdArquivoGerado.
• Carrega ArquivoGerado.LoadObject(this.IdArquivoGerado.Value) e preenche txtBancoConfirmacao, txtConvenioBancarioConfirmacao.
• Carrega ArquivoGeradoLote.CarregarPorArquivoGerado() e preenche lsTipoOperacaoConfirmacao.
• CarregarListaSugestaoTipoOperacao(): Popula a lista de tipos de operação para o convênio selecionado.
• Exibe o modal (mpeModalGerarArquivoNovamente.Show()).

2. btnGerarArquivoNovamente_OnClick (no modal):

• Util.ValidaPermissaoUsuario(): Verifica a permissão PagamentoFolha.PermitirGerarArquivoNovamente. Se não tiver, exibe mensagem de aviso.
• SolicitarGeracaoArquivoPagamento():
• Valida IdArquivoGerado e idTipoObjetoPagamento.
• ArquivoGerado.SalvarSolicitacaoGeracaoNovoArquivoPagamento(): Salva a solicitação.
• SolicitacaoAssincrona(): Inicia o processo assíncrono de geração.
• Se a solicitação for bem-sucedida, exibe mensagem de aviso (Resources.MensagemAviso._100001) e fecha o modal.

6.6. Criptografia e Transmissão Assíncrona CNAB

1. gvwArquivosGerados_OnRowCommand (CommandName “CriptografiaTransmissaoAssincrona”):

• Recupera Idf_Arquivo_Gerado (dataKeyValue) do DataKeys da grid.
• SolicitacaoTransmissaoAssincronaCNAB(dataKeyValue):
• Cria ParametroExecucaoCollection com pNomeCentroServico, pIdEmpresa, pIdUsuario, pIdArquivoGerado.
• ProcessoAssincrono.IniciarAtividade(): Inicia a atividade assíncrona para integração CNAB Syngenta.
• Exibe mensagem de sucesso ou erro/aviso (EL.AtividadeAvisoException.TipoErroAtividade.AtividadeDuplicada).

6.7. Limpar Filtros

1. btnLimpar_OnClick:

• Redireciona para a própria página (Response.Redirect("~/DownloadArquivoPagamento.aspx", true)), reiniciando a tela.

6.8. Voltar

1. btnVoltar_OnClick:

• Redireciona para a tela de menu (Response.Redirect("~/MenuMaisOpcoes.aspx?ID=I", true)).

6.9. Eventos de Seleção na Grid

1. ddlSelecaoArquivosGerados_OnSelectedIndexChanged:

• Atualiza a LstArquivosGeradosSelecionados com base na opção selecionada (desmarcar todos, marcar todos, desmarcar todos desta página, marcar todos desta página).
• Atualiza o lblQuantidadeArquivosSelecionados.Text.
• CarregarGridViewArquivosGerados(): Recarrega a grid para refletir as seleções.

2. ckbSelecionar_CheckedChanged:

• Adiciona ou remove o Idf_Arquivo_Gerado da LstArquivosGeradosSelecionados com base no estado do checkbox.
• Atualiza o lblQuantidadeArquivosSelecionados.Text.

6.10. Alteração de Convênio Bancário (Modal)

1. btnAlterarConvenioBancario_OnClick:

• ConfirmacaoSenhaUtil.ConfigurarMensagemImpacto(): Configura a mensagem para o modal de confirmação de senha.
• modalConfirmacaoSenha.Show(): Exibe o modal de confirmação de senha com a permissão SenhaMaster.SenhaMaster.

2. modalConfirmacaoSenha_OnConfirmar (após confirmação de senha):

• Se modalConfirmacaoSenha.CommandName for “AlterarConvenioBancario”:
• txtConvenioBancarioConfirmacao.Enabled = true;
• txtConvenioBancarioConfirmacao.Focus();
• upnModalGerarArquivoNovamente.Update();
• modalConfirmacaoSenha.Close();

🔌 7. Integrações e Dependências

7.1. Classes BLL e Service utilizadas

• Employer.Plataforma.BLL.ArquivoGerado

• Arquivo de origem: ArquivoGerado.cs

• ListarIdArquivosGeradosParaDownload(int pIdEmpresa, int? pIdBanco, DateTime? pDtaGeracaoDe, DateTime? pDtaGeracaoAte, DateTime? pDtaPagamentoDe, DateTime? pDtaPagamentoAte, int? pIdfArquivoGeradoLote, int? pIdfArquivoGeradoRetornoLido, int? pIdfStatusConferenciaArquivo, int pIdUsuario)

• Propósito: Lista os IDs dos arquivos gerados para download com base nos filtros fornecidos.

• Lógica interna: Filtra os arquivos por empresa, banco, períodos de geração e pagamento, lote, tipo de arquivo (gerado/retorno lido), status de conferência e usuário. Retorna um dicionário de IdArquivoGerado e um booleano indicando se há arquivo para download.

• ListarInformacoesArquivosGeradosParaDownload(Dictionary<int, bool> pDicArquivosGerados, string pNmeColunaOrdenacao, string pNmeDirecaoOrdenacao, int pNumPagina, int pNumRegistrosPorPagina, out int pNumTotalRegistros)

• Propósito: Lista as informações detalhadas dos arquivos gerados para download, incluindo paginação e ordenação.

• Lógica interna: Recebe um dicionário de IDs de arquivos e um booleano (indicando se há arquivo para download), e retorna um DataTable com as informações completas dos arquivos, aplicando ordenação e paginação.

• LoadObject(int pIdArquivoGerado)

• Propósito: Carrega um objeto ArquivoGerado pelo seu identificador.

• Lógica interna: Busca um registro na base de dados correspondente ao pIdArquivoGerado e popula as propriedades do objeto.

• SalvarSolicitacaoGeracaoNovoArquivoPagamento(int pIdTipoObjetoPagamento, int pIdArquivoGerado, int pIdBanco, int pIdConvenioBancario, int? pIdTipoPagamentoFinanceiro)

• Propósito: Salva uma solicitação para gerar um novo arquivo de pagamento.

• Lógica interna: Registra os detalhes da solicitação de regeneração do arquivo, incluindo o tipo de pagamento, o arquivo original, o banco, o convênio e o tipo de pagamento financeiro.

• Employer.Plataforma.BLL.ArquivoGeradoLote

• Arquivo de origem: ArquivoGeradoLote.cs

• CarregarPorArquivoGerado(int pIdArquivoGerado)

• Propósito: Carrega uma lista de objetos ArquivoGeradoLote associados a um ArquivoGerado.

• Lógica interna: Busca na base de dados os lotes de pagamento relacionados a um arquivo gerado específico.

• Employer.Plataforma.BLL.ConfirmacaoSenhaUtil

• Arquivo de origem: ConfirmacaoSenhaUtil.cs

• ConfigurarMensagemImpacto(ref string pHtmlMensagemImpacto, string pMensagem, ConfirmacaoSenhaUtil.EnumTipoEstrutura pEnumTipoEstrutura)

• Propósito: Configura a mensagem HTML a ser exibida no componente de confirmação de senha.

• Lógica interna: Formata a mensagem de impacto de acordo com o tipo de estrutura especificado.

• Employer.Plataforma.BLL.ConvenioBancario

• Arquivo de origem: ConvenioBancario.cs

• LoadObject(int pIdConvenioBancario)

• Propósito: Carrega um objeto ConvenioBancario pelo seu identificador.

• Lógica interna: Busca um registro na base de dados correspondente ao pIdConvenioBancario e popula as propriedades do objeto.

• System.Text.Encoding

• Propósito: Classe do .NET Framework para manipulação de codificações de caracteres.

• GetEncoding(string pNomeCodificacao)

• Propósito: Retorna um objeto Encoding para a codificação especificada.

• Lógica interna: Usado para obter a codificação “ISO-8859-1” ao escrever arquivos CSV.

• System.Linq.Enumerable (via LstArquivosGeradosSelecionados.Distinct())

• Propósito: Métodos de extensão para consultas LINQ.

• Distinct()

• Propósito: Retorna elementos distintos de uma sequência.

• Lógica interna: Usado para garantir que não haja IDs duplicados na lista de arquivos selecionados para download.

• Employer.Plataforma.BLL.Parametro

• Arquivo de origem: Parametro.cs

• RecuperaValorParametro(BLL.Enumeradores.NomeParametro pNomeParametro)

• Propósito: Recupera o valor de um parâmetro do sistema.

• Lógica interna: Busca o valor de um parâmetro configurado no sistema com base no seu nome.

• Employer.Plataforma.BLL.PluginsCompatibilidade

• Arquivo de origem: PluginsCompatibilidade.cs

• CarregarPorMetadata(string pPluginEntrada, string pPluginSaida)

• Propósito: Carrega informações de plugins de compatibilidade com base em metadados de entrada e saída.

• Lógica interna: Usado para identificar o plugin correto para iniciar um processo assíncrono de relatório ou integração.

• Employer.PlataformaServices.ProcessosAssincronos.ProcessoAssincrono

• Arquivo de origem: ProcessoAssincrono.cs (no projeto Employer.PlataformaServices)

• IniciarAtividade(PluginCompatibilidade pObjPluginCompatibilidade, string pNomeCentroServico, ParametroExecucaoCollection pParametros, string pNmeArquivoSaida, TipoSaida pTipoSaida, string pNmeEmailDestinatario, string pNmeEmailCopia, DateTime pDtaExecucao, int pIdEmpresa, Sistema pSistema)

• Propósito: Inicia uma atividade assíncrona no sistema.

• Lógica interna: Envia uma solicitação para o serviço de processos assíncronos para executar uma tarefa em segundo plano, como a geração de relatórios ou integração de arquivos.

• Exceções: Pode lançar EL.AtividadeAvisoException se a atividade for duplicada ou ocorrer outro erro.

• Employer.Plataforma.BLL.TipoPagamentoFinanceiro

• Arquivo de origem: TipoPagamentoFinanceiro.cs

• ListarTipoPagamentoFinanceiroPorConvenioBancario(int pIdConvenioBancario)

• Propósito: Lista os tipos de pagamento financeiro associados a um convênio bancário.

• Lógica interna: Busca na base de dados os tipos de pagamento financeiro que podem ser utilizados com um convênio bancário específico.

• Employer.Plataforma.Web.Code.UIHelper

• Arquivo de origem: UIHelper.cs

• CarregarGridView(GridView pGridView, DataTable pDataTable, int pTotalRegistros)

• Propósito: Auxiliar no carregamento de dados em um controle GridView.

• Lógica interna: Vincula um DataTable a uma GridView, configurando paginação e total de registros.

• Employer.Plataforma.BLL.Usuario

• Arquivo de origem: Usuario.cs

• CarregarPermissoes(Usuario pObjUsuario, BLL.Enumeradores.CategoriaPermissao pCategoriaPermissao)

• Propósito: Carrega as permissões de um usuário para uma categoria específica.

• Lógica interna: Busca as permissões que um determinado usuário possui dentro de uma categoria de permissão (ex: PagamentoFolha).

• Etec.Service.Util.Util

• Arquivo de origem: Util.cs (no projeto Etec.Service.Util)

• ValidaPermissaoUsuario(List<int> pLstPermissoes, int pIdPermissao)

• Propósito: Verifica se o usuário possui uma permissão específica.

• Lógica interna: Checa se o pIdPermissao está presente na lista de permissões do usuário.

7.2. Stored Procedures chamadas

A análise estática não fornece os nomes literais das stored procedures. Para obter essa informação, seria necessário analisar o código-fonte das classes BLL mencionadas na seção 7.1. No entanto, com base nos nomes dos métodos BLL, podemos inferir as seguintes SPs prováveis:

• SP_ARQUIVO_GERADO_LISTAR_IDS_DOWNLOAD

• Arquivo BLL: ArquivoGerado.cs

• Parâmetros SQL: @Idf_Empresa, @Idf_Banco, @Dta_Geracao_De, @Dta_Geracao_Ate, @Dta_Pagamento_De, @Dta_Pagamento_Ate, @Idf_Arquivo_Gerado_Lote, @Idf_Arquivo_Gerado_Retorno_Lido, @Idf_Status_Conferencia_Arquivo, @Idf_Usuario

• Propósito: Lista os identificadores dos arquivos gerados para download, aplicando os filtros de pesquisa.

• SP_ARQUIVO_GERADO_LISTAR_INFO_DOWNLOAD

• Arquivo BLL: ArquivoGerado.cs

• Parâmetros SQL: @Idf_Arquivo_Gerado_List, @Nme_Coluna_Ordenacao, @Nme_Direcao_Ordenacao, @Num_Pagina, @Num_Registros_Por_Pagina, @Num_Total_Registros OUTPUT

• Propósito: Retorna as informações detalhadas dos arquivos gerados para download, com paginação e ordenação.

• SP_ARQUIVO_GERADO_LOAD

• Arquivo BLL: ArquivoGerado.cs

• Parâmetros SQL: @Idf_Arquivo_Gerado

• Propósito: Carrega um registro de arquivo gerado pelo seu identificador.

• SP_ARQUIVO_GERADO_SALVAR_SOLICITACAO_REGERACAO

• Arquivo BLL: ArquivoGerado.cs

• Parâmetros SQL: @Idf_Tipo_Objeto_Pagamento, @Idf_Arquivo_Gerado, @Idf_Banco, @Idf_Convenio_Bancario, @Idf_Tipo_Pagamento_Financeiro

• Propósito: Registra uma nova solicitação para regenerar um arquivo de pagamento.

• SP_ARQUIVO_GERADO_LOTE_CARREGAR_POR_ARQUIVO_GERADO

• Arquivo BLL: ArquivoGeradoLote.cs

• Parâmetros SQL: @Idf_Arquivo_Gerado

• Propósito: Carrega os lotes de pagamento associados a um arquivo gerado.

• SP_CONVENIO_BANCARIO_LOAD

• Arquivo BLL: ConvenioBancario.cs

• Parâmetros SQL: @Idf_Convenio_Bancario

• Propósito: Carrega um registro de convênio bancário pelo seu identificador.

• SP_PARAMETRO_RECUPERA_VALOR

• Arquivo BLL: Parametro.cs

• Parâmetros SQL: @Nme_Parametro

• Propósito: Recupera o valor de um parâmetro do sistema.

• SP_PLUGINS_COMPATIBILIDADE_CARREGAR_POR_METADATA

• Arquivo BLL: PluginsCompatibilidade.cs

• Parâmetros SQL: @Nme_Plugin_Entrada, @Nme_Plugin_Saida

• Propósito: Carrega informações de plugins de compatibilidade.

• SP_TIPO_PAGAMENTO_FINANCEIRO_LISTAR_POR_CONVENIO_BANCARIO

• Arquivo BLL: TipoPagamentoFinanceiro.cs

• Parâmetros SQL: @Idf_Convenio_Bancario

• Propósito: Lista os tipos de pagamento financeiro disponíveis para um convênio bancário.

• SP_USUARIO_CARREGAR_PERMISSOES

• Arquivo BLL: Usuario.cs

• Parâmetros SQL: @Idf_Usuario, @Idf_Categoria_Permissao

• Propósito: Carrega as permissões de um usuário para uma categoria específica.

7.3. UserControls incluídos (.ascx)

• Employer:EmployerValidationSummary

• Caminho: ~/EmployerValidationSummary.ascx (inferido pelo namespace Employer)

• ID: vsValidacao, vsValidacaoModal

• Tag: <Employer:EmployerValidationSummary ... />

• Propriedades expostas: ValidationGroup, DisplayMode, CssClass, HeaderText.

• Propósito: Exibir um resumo das mensagens de validação.

• Employer:LocalizarBanco

• Caminho: ~/LocalizarBanco.ascx (inferido pelo namespace Employer)

• ID: txtBanco, txtBancoConfirmacao

• Tag: <Employer:LocalizarBanco ... />

• Propriedades expostas: IdEmpresa, IdBancoSelecionado, ValidationGroup, Obrigatorio, Enabled, MensagemErroObrigatorioSummary, MensagemErroFormatoSummary.

• Métodos públicos chamados: IdEmpresa e IdBancoSelecionado são setados.

• Employer:DataTextBox

• Caminho: ~/DataTextBox.ascx (inferido pelo namespace Employer)

• ID: txtPeriodoGeracaoArquivoDe, txtPeriodoGeracaoArquivoAte, txtPeriodoPagamentoDe, txtPeriodoPagamentoAte

• Tag: <Employer:DataTextBox ... />

• Propriedades expostas: ValorDateTime, ValidationGroup, MensagemErroFormatoSummary, MensagemErroObrigatorioSummary, MensagemErroValorMaximoSummary, MensagemErroValorMinimoSummary, Obrigatorio, DataMaxima, DataMinima.

• Eventos: OnValorAlterado (para txtPeriodoPagamentoDe e txtPeriodoPagamentoAte).

• Employer:ControlAlfaNumerico

• Caminho: ~/ControlAlfaNumerico.ascx (inferido pelo namespace Employer)

• ID: txtNumeroLotePagamento

• Tag: <Employer:ControlAlfaNumerico ... />

• Propriedades expostas: Obrigatorio, ValidationGroup, Tipo, SomenteNumeros, ValorMinimo, ValorMaximo, Tamanho, MensagemErroObrigatorioSummary, MensagemErroFormatoSummary, MensagemErroValorMaximoSummary, MensagemErroValorMinimoSummary.

• Employer:ListaSugestoes

• Caminho: ~/ListaSugestoes.ascx (inferido pelo namespace Employer)

• ID: lsArquivoGeradoRetornoLido, lsSituacaoConferenciaArquivo, lsTipoOperacaoConfirmacao

• Tag: <Employer:ListaSugestoes ... />

• Propriedades expostas: Valor, ValorInt, ValidationGroup, MensagemErroObrigatorioSummary, MensagemErroInvalidoSummary, Enabled.

• Métodos públicos chamados: ListaSugestoesExtensions.CarregarListaSugestoes() é usado para popular esses controles.

• Employer:Button

• Caminho: ~/Button.ascx (inferido pelo namespace Employer)

• ID: btnPesquisar, btnBaixarSelecionados, btnLimpar, btnVoltar, btnAlterarConvenioBancario, btnGerarArquivoNovamente (modal), btnLimparModal

• Tag: <Employer:Button ... />

• Propriedades expostas: ToolTip, Text, OnClick, ValidationGroup, CausesValidation, CssClass.

• Employer:EmployerGrid

• Caminho: ~/EmployerGrid.ascx (inferido pelo namespace Employer)

• ID: gvwArquivosGerados

• Tag: <Employer:EmployerGrid ... />

• Propriedades expostas: AutoGenerateColumns, AllowSorting, AllowPaging, DataKeyNames, EmptyDataText, MockColunaOrdenada, MockDirecaoOrdenacao, OnRowDataBound, OnCarregarGrid, OnRowCommand, MockPageIndex, PageSize.

• Eventos: OnRowDataBound, OnCarregarGrid, OnRowCommand.

• Employer:ControlCheckBox

• Caminho: ~/ControlCheckBox.ascx (inferido pelo namespace Employer)

• ID: ckbSelecionar (dentro da grid)

• Tag: <Employer:ControlCheckBox ... />

• Propriedades expostas: OnCheckedChanged, AutoPostBack, Visible, Checked.

• Employer:ImageButton

• Caminho: ~/ImageButton.ascx (inferido pelo namespace Employer)

• ID: btnDownload, btnDownloadCript, btnCriptografiaTransmissaoAssinc, btnGerarArquivoNovamente (dentro da grid), btnFecharModalGerarArquivoNovamente

• Tag: <Employer:ImageButton ... />

• Propriedades expostas: ImageUrl, ToolTip, CommandName, CommandArgument, Visible, CausesValidation, CssClass.

• Employer:LocalizarConvenioBancario

• Caminho: ~/LocalizarConvenioBancario.ascx (inferido pelo namespace Employer)

• ID: txtConvenioBancarioConfirmacao

• Tag: <Employer:LocalizarConvenioBancario ... />

• Propriedades expostas: IdEmpresa, IdBanco, IdConvenioBancarioSelecionado, Obrigatorio, Enabled, ValidationGroup, MensagemErroObrigatorioSummary, MensagemErroFormatoSummary, OnValorAlterado.

• Eventos: OnValorAlterado.

• Employer:ConfirmacaoSenha

• Caminho: ~/ConfirmacaoSenha.ascx (inferido pelo namespace Employer)

• ID: modalConfirmacaoSenha

• Tag: <Employer:ConfirmacaoSenha ... />

• Propriedades expostas: NomeSistemaOrigem, CSSClassContainerFiltros, CSSClassLinha, CSSClassLabelContainer, CSSClassContainerLinha, OnConfirmar, SolicitarJustificativa, HtmlMensagemTopo, IdPermissao, CommandName.

• Eventos: OnConfirmar.

• Métodos públicos chamados: Show(), Close().

7.4. WebServices, APIs externas, filas

• Processos Assíncronos (Employer.PlataformaServices.ProcessosAssincronos):
• A tela interage com um serviço de processos assíncronos para iniciar a geração de relatórios de pagamento e a criptografia/transmissão de arquivos CNAB.
• O método ProcessoAssincrono.IniciarAtividade é a interface para este serviço.
• Não são expostos endpoints HTTP diretos na tela, mas sim uma comunicação com um serviço de backend.

💬 8. Mensagens ao Usuário

• “Nenhum arquivo de pagamento foi selecionado para realizar o download. Favor verificar.” (Erro ao tentar baixar sem seleção)
• “Alguns dos arquivos selecionados não estão prontos para download. Favor verificar.” (Erro ao tentar baixar arquivos incompletos)
• “Arquivo indisponível para download devido ao status de cancelado.” (Erro ao tentar baixar arquivo cancelado)
• “Para fazer o download do arquivo criptografado é necessário configurar o ambiente previamente. Contate o administrador! (ArquivoChaveCriptografiaWebTA, SenhaCriptografiaWebTA)” (Erro de configuração para download criptografado)
• “O arquivo criptografado não foi gerado, contate o administrador!” (Erro na geração do arquivo criptografado)
• “Pagamento não encontrado. Favor verificar.” (Erro ao tentar gerar arquivo novamente sem IdArquivoGerado)
• “Não foi possível identificar de qual tipo de pagamento é o arquivo selecionado. Favor verificar.” (Erro ao tentar gerar arquivo novamente sem tipo de pagamento)
• “Erro ao solicitar geração do arquivo para o pagamento informado” (Erro genérico na solicitação de geração)
• “Solicitação de relatório enviada com sucesso.” (Aviso de sucesso na solicitação assíncrona)
• “Usuário não tem permissão para executar essa operação!” (Aviso de falta de permissão)
• “Solicitação de criptografia e transmissão de arquivo CNAB enviada com sucesso.” (Aviso de sucesso na solicitação CNAB)
• Resources.MensagemAviso._100001 (Mensagem de aviso genérica, provavelmente “Operação realizada com sucesso.”)
• Mensagens de erro de validação para campos (ex: “Campo período geração arquivo (De) deve ter o padrão dd/mm/aaaa.”).
• Mensagens de aviso do ProcessoAssincrono (ex: “Atividade duplicada”).

🔐 9. Permissões e Perfis

• BLL.Enumeradores.Permissoes.PagamentoFolha.ConsultarArquivosPagamentos:
• Controla o acesso à tela. Se o usuário não tiver essa permissão, é redirecionado para a página de acesso negado.
• BLL.Enumeradores.Permissoes.PagamentoFolha.DownloadArquivosPagamentos:
• Controla a visibilidade do botão “Baixar Selecionados (ZIP)”.
• Controla a visibilidade do botão “Download” individual na grid.
• BLL.Enumeradores.Permissoes.PagamentoFolha.DownloadArquivosPagamentosCriptografados:
• Controla a visibilidade do botão “Download Criptografado” individual na grid.
• BLL.Enumeradores.Permissoes.PagamentoFolha.PermitirGerarArquivoNovamente:
• Controla a habilitação do botão “Gerar Arquivo Novamente” na grid.
• Controla a permissão para executar a ação de gerar arquivo novamente no modal.
• BLL.Enumeradores.Permissoes.PagamentoFolha.TransmissaoArquivosPagamentosCriptografados:
• Controla a visibilidade do botão “CNAB - Criptografia Transmissão Assíncrona” na grid, em conjunto com a verificação do NomeCentroServico.
• BLL.Enumeradores.Permissoes.SenhaMaster.SenhaMaster:
• Necessária para habilitar a alteração do convênio bancário no modal de “Gerar Arquivo Novamente”.

🔎 10. Aprofundamento — Detalhes Internos de Métodos

Os arquivos foram lidos com sucesso. Agora vou processar o conteúdo de cada classe para gerar a documentação detalhada.

Começarei com a classe ArquivoGerado.

ArquivoGerado

Arquivos:

• C:\Webfopag\Etec.WebFopag\Employer.Plataforma.BLL\ArquivoGerado_P1.cs
• C:\Webfopag\Etec.WebFopag\Employer.Plataforma.BLL\ArquivoGerado_P2.cs

Métodos

📌 Status: Concluído 👤 Responsável: Equipe de QA