Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	crmapi/apiCrmAccessPortalRegra.p

Considerações Gerais

Objetivo

Realizar a manutenção de ocorrências.

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/bocrmOcor.p (input-output table tt-...,

input table tt-...,

...,

...).

A execução na forma persistente ...

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

run crmbo/bocrmOcor.p persistent set h-handle (input-output table tt-...,

input table tt-...,

...,

...).

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:

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

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

getFieldControlByViewForms
Requisito	Temp-tables DEFINE TEMP-TABLE ttRestrictedFields NO-UNDO FIELD codField AS CHARACTER FIELD idiRestriction AS INTEGER. /* ( 1 - Oculto, 2 - Desabilitado ). */ DEF TEMP-TABLE RowErrors NO-UNDO FIELD ErrorSequence AS INTEGER FIELD ErrorNumber AS INTEGER FIELD ErrorDescription AS CHARACTER FIELD ErrorParameters AS CHARACTER FIELD ErrorType AS CHARACTER FIELD ErrorHelp AS CHARACTER FIELD ErrorSubType AS CHARACTER INDEX idxSequence IS PRIMARY ErrorSequence.
Sintaxe	Run getFieldControlByViewforms in h-handle (input formCode, input userLogin, output table ttRestrictedFields, output table RowErrors)
Descrição	Retorna todas as restrições cadastrados para um determinado formulário e usuário.
	Parâmetros	Descrição
	formCode	Código do Formulário
	userLogin	Usuário
Retorno	ttRestrictedFields – temp-table RowErrors – temp-table

getFieldControlByView
Requisito	Temp-tables DEFINE TEMP-TABLE ttRestrictedFields NO-UNDO FIELD codField AS CHARACTER FIELD idiRestriction AS INTEGER. /* ( 1 - Oculto, 2 - Desabilitado ). */ DEF TEMP-TABLE RowErrors NO-UNDO FIELD ErrorSequence AS INTEGER FIELD ErrorNumber AS INTEGER FIELD ErrorDescription AS CHARACTER FIELD ErrorParameters AS CHARACTER FIELD ErrorType AS CHARACTER FIELD ErrorHelp AS CHARACTER FIELD ErrorSubType AS CHARACTER INDEX idxSequence IS PRIMARY ErrorSequence.
Sintaxe	Run getFieldControlByView in h-handle (input formCode, input userLogin, output table ttRestrictedFields, output table RowErrors)
Descrição	Método principal, retorna todas as restrições cadastrados para um determinado formulário e usuário, inclusive restrições gerais.
	Parâmetros	Descrição
	formCode	Código do Formulário
	userLogin	Usuário
Retorno	ttRestrictedFields – temp-table RowErrors – temp-table