Documento de API

Considerações Gerais

Objetivo

Validar e salvar os pedidos RPW para processos de distribuição.

Funcionamento

Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.

A sintaxe para a chamada da API é:

run fch/fchdis/fchdis0029.p

A sintaxe para executar a API em modo persistente é:

run fch/fchdis/fchdis0029.p persistent set h-handle.

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

Nos atributos das tabelas temporárias de entrada e saída:

ttParam					Entrada/Saída
Parametros RPW.					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
opcao	Int	-	Opção filtro conta.	-	-
ltabelBasic	Log	-	Tabelas básicas?	-	-
lInfoPedEnv	log	-	Enviar Info Pedido?	-	-
lInfoPedReceb	log	-	Receber Info Pedido?	-	-
lTitCta	Log	-	Enviar Titulos Conta?	-	-
iPeriodico	int	-	Periódico.	-	-
disProces	Char	-	Processo.	-	-
dtExec	Char	-	Data execução.	-	-
dtLimit	char	-	Data limite.	-	-
cHoraExec	Char	-	Hora execução.	-	-
dtAux	Char	-	Data auxiliar.	-	-
lAgenda	log	-	Possuí agenda de execução?	-	-
destino	Int	-	Tipo destino.	-	-
arquivo	Char	-	Arquivo.	-	-
usuario	Char	-	Usuário.	-	-
progRp	Char	-	Programa rp.	-	-
programa	Char	-	Programa.	-	-
versao	char	-	Versão.	-	-
rttRepresTarget	Raw	-	Filtro representante.	-	-
rttEstabTarget	Raw	-	Filtro estabelecimento.	-	-
rttTabPrecoTarget	Raw	-	Filtro tabela de preço.	-	-
rttCondPagtoTarget	raw	-	Filtro condição de pagamento.	-	-

ttRepresSource					Entrada/Saída
Representantes disponíveis no filtro.					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codigo	char	-	Código.	Sim	-
nivAces	char	-	Nivel acesso.	sim	-
descr	char	-	Nome.	sim	-

ttRepresTarget					Entrada/Saída
Representantes selecionados no filtro.					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codigo	char	-	Código.	Sim	-
nivAces	char	-	Nivel acesso.	sim	-
descr	char	-	Nome.	sim	-

ttEstabSource					Entrada/Saída
Estabelecimentos disponíveis no filtro.					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codigo	char	-	Código.	Sim	-
descr	char	-	Nome.	sim	-

ttEstabTarget					Entrada/Saída
Estabelecimentos selecionados no filtro					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codigo	char	-	Código.	Sim	-
descr	char	-	Nome.	sim	-

ttTabPrecoSource					Entrada/Saída
Tabelas de preço disponíveis no filtro.					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codigo	char	-	Código.	Sim	-
descr	char	-	Nome.	sim	-

ttTabPrecoTarget					Entrada/Saída
Tabelas de preços selecionadas no filtro.					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codigo	char	-	Código.	Sim	-
descr	char	-	Nome.	sim	-

ttCondPagtoSource					Entrada/Saída
Condições de pagamento disponíveis no filtro					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codigo	char	-	Código.	Sim	-
descr	char	-	Nome.	sim	-

ttCondPagtoTarget					Entrada/Saída
Condições de pagamento selecionadas no filtro.					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codigo	char	-	Código.	Sim	-
descr	char	-	Nome.	sim	-

Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

chooseIntgrSoftSite
Requisito	Nenhum.
Sintaxe
Descrição	Método principal para gerar um novo pedido de execução para o processo de carga da integração com a Softsite.
	Parâmetros	Descrição
	ttParam1	Parâmetros de tela.
	ttRepresTarget	Filtro representante.
	ttEstabTarget	Filtro estabelecimento.
	ttTabPrecoTarget	Filtro tabela de preço.
	ttCondPagtoTarget	Filtro condição de pagamento.
	RowErrors	Erros durante o processo.
Retorno	RowErrors (saida).

agendarPedExec
Requisito	Nenhum.
Sintaxe
Descrição	Calcula e envia os dados do pedido que deve ser gerado.
	Parâmetros	Descrição
	vProgramRPW	Identificador do programa RPW a ser gerado.
	RowErrors	Erros durante o processo.
Retorno	RowErrors (saida).

EnviarParam
Requisito	Nenhum.
Sintaxe
Descrição	Validar e enviar os dados do pedido de execução.
	Parâmetros	Descrição
	cArquivo	Arquivo.
	cProgram	Programa.
	iCodigo	Código.
	cArquivoRP	Programa rp.
	lAgendaRpw	Possuí agenda?
	cDataExec	Data de Execução.
	cHoraExec	Hora de Execução.
	cDataLim	Data Limite.
	iTipCalend	Tipo de agendamento.
	raw-param	Paramtro para o programa rp.
	RowErrors	Erros durante o processo.
Retorno	RowErrors (saida).

CalculeDateExecute
Requisito	Nenhum.
Sintaxe
Descrição	Calcular os intervalos em que devem ser gerados os pedidos, baseado no periódico selecionado.
	Parâmetros	Descrição
	iPeriodico	Período para calcular a data de execução dos pedidos.
	dtExec	Data de execução.
	dtControle	Data controle para salvar o pedido.
Retorno	dtControle (saida)

FindAgenda
Requisito	Nenhum.
Sintaxe
Descrição	Verifica se existe uma agenda de execução para o programa selecionado.
	Parâmetros	Descrição
	p_cod_prog_dtsul_w	Programa dtsul.
	v-dat-prox-exec	Data execução.
	v-hra-prox-exec	Hora execução.
	RowErrors	Erros durante o processo.
Retorno	RowErrors (saida).

FindMessageError
Requisito	Nenhum.
Sintaxe
Descrição	Verifica se existe uma agenda de execução para o programa selecionado.
	Parâmetros	Descrição
	numMsg	Código da message.
	param1	Parâmetro 1.
	param2	Parâmetro 2.
	RowErrors	Erro adicionado.
Retorno	RowErrors (saida).

destroyHandle
Requisito	Nenhum.
Sintaxe
Descrição	Delete procedure e object dos objetos handle.
	Parâmetros	Descrição
	Não contém.	-
Retorno	RowErrors (saida).