Documento de BO

Produto:	Datasul
Ocorrência:	Documentação de BO
Nome Físico	crmbo/boCrmTextPessoaPortal.p

Considerações Gerais

Objetivo

Realizar a manutenção de texto da conta.

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/BO é:

run crmbo/boCrmTextPessoaPortal.p.

A sintaxe para executar a API/BO em modo persistente é:

run crmbo/boCrmTextPessoaPortal.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.

Tabelas Temporárias

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

RowObject					Entrada/Saída
Textos da Conta					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obriga tório	Evolução
num_id	integer	99999999	Código idenficador sequencial	Sim
num_id_pessoa	integer	>>>>,>>9	Pessoa	Sim
dsl_text_livre	character	x(4000)	Texto Livre	Sim
idi_tip_text	integer	9	Tipo de Texto	Sim
dat_timestamp	date	99/99/9999	Data de Alteração do Registro	Sim
cdd_version	decimal	>>>,>>>,>>>,>>9	Versão	Não
num_livre_1	integer	>>>>>9	Livre 1	Não
val_livre_1	decimal	zzz,zzz,zz9.9999	Livre 1	Não
val_livre_2	decimal	zzz,zzz,zz9.9999	Livre 2	Não
num_livre_2	integer	>>>>>9	Livre 2	Não
cod_livre_1	character	x(100)	Livre 1	Não
cod_livre_2	character	x(100)	Livre 2	Não
dat_livre_1	date	99/99/9999	Livre 1	Não
dat_livre_2	date	99/99/9999	Livre 2	Não
log_livre_1	logical	Sim/Não	Livre 1	Não
log_livre_2	logical	Sim/Não	Livre 2	Não

Método Básico

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

goToKey
Requisito	N/A
Sintaxe	goToKey (input num_id)
Descrição	Reposiciona registro com base no índice
	Parâmetros	Descrição
	Num_id	Código identificador sequencial
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

getKey
Requisito	N/A
Sintaxe	getKey (output num_id)
Descrição	Retorna valores dos campos do índice
	Parâmetros	Descrição
	Num_id	Código identificador sequencial
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

getCharField
Requisito	N/A
Sintaxe	getCharField (input pFieldName, output pFieldValue)
Descrição	Retorna valor de campos do tipo caracter.
	Parâmetros	Descrição
	pFieldName	Nome do Campo
	pFieldValue	Valor do Campo
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

getDateField
Requisito	N/A
Sintaxe	getDateField (input pFieldName, output pFieldValue)
Descrição	Retorna valor de campos do tipo data.
	Parâmetros	Descrição
	pFieldName	Nome do Campo
	pFieldValue	Valor do Campo
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

getDecField
Requisito	N/A
Sintaxe	getDecField (input pFieldName, output pFieldValue)
Descrição	Retorna valor de campos do tipo decimal.
	Parâmetros	Descrição
	pFieldName	Nome do Campo
	pFieldValue	Valor do Campo
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

getLogField
Requisito	N/A
Sintaxe	getLogField (input pFieldName, output pFieldValue)
Descrição	Retorna valor de campos do tipo lógico.
	Parâmetros	Descrição
	pFieldName	Nome do Campo
	pFieldValue	Valor do Campo
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

getRawField
Requisito	N/A
Sintaxe	getRawField (input pFieldName, output pFieldValue)
Descrição	Retorna valor de campos do tipo raw.
	Parâmetros	Descrição
	pFieldName	Nome do Campo
	pFieldValue	Valor do Campo
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

getRecidField
Requisito	N/A
Sintaxe	getRecidField (input pFieldName, output pFieldValue)
Descrição	Retorna valor de campos do tipo recid.
	Parâmetros	Descrição
	pFieldName	Nome do Campo
	pFieldValue	Valor do Campo
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

validateRecord
Requisito	N/A
Sintaxe	validateRecord (input pType)
Descrição	Recebe o tipo de validação (Create, Delete, Update)
	Parâmetros	Descrição
	pType	Tipo de validação
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

afterUpdateRecord
Requisito	N/A
Sintaxe	afterUpdateRecord
Descrição	Realiza validações/integrações após alterar o registro
	Parâmetros	Descrição
	N/A
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

afterCreateRecord
Requisito	N/A
Sintaxe	afterCreateRecord
Descrição	Realiza validações/integrações após criar o registro
	Parâmetros	Descrição
	N/A
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

afterDeleteRecord
Requisito	N/A
Sintaxe	afterDeleteRecord
Descrição	Realiza validações/integrações após excluir o registro
	Parâmetros	Descrição
	N/A
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

Método Negócio

ValidateChangeTextERP
Requisito	N/A
Sintaxe	ValidateChangeTextERP
Descrição	Realiza a validação para integrar o registro com o ERP
	Parâmetros	Descrição
	N/A
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

checkParamIntegr
Requisito	N/A
Sintaxe	checkParamIntegr
Descrição	Realiza a verificação se está integrado ao ERP.
	Parâmetros	Descrição
	N/A
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: NOK (execução com problemas).

setOrigemERP
Requisito	N/A
Sintaxe	setOrigemERP
Descrição	Realiza a alteração da variável que indica que a origem do dado é o ERP.
	Parâmetros	Descrição
	pl-origem-erp	Valor lógico para alterar variável de origem ERP
Retorno	Altera a variável l-origem-erp para TRUE.

setOrigemGP
Requisito	N/A
Sintaxe	setOrigemGP
Descrição	Realiza a alteração da variável que indica que a origem do dado é o GP.
	Parâmetros	Descrição
	pl-origem-gp	Valor lógico para alterar variável de origem GP
Retorno	Altera a variável l-origem-gp para TRUE.

integraCRMToEMS2
Requisito	N/A
Sintaxe	integraCRMToEMS2
Descrição	Realiza a integração com EMS2, enviando os dados.
	Parâmetros	Descrição
	N/A
Retorno

Árvore de páginas

boCrmTextPessoaPortal - Manutenção de Texto da Conta no Portal

Documento de BO

Considerações Gerais

Tabelas Temporárias

Método Básico

Método Negócio