Documento de Fachada
Produto: | Datasul |
| Ocorrência:
| Documentação de Fachada |
Dados do Documento | |
Nome | Fachada Controle de Acesso |
Descrição |
|
Nome Físico | fchcrm/fchcrm1045.p |
Include com Parâmetros | fchcrm/fchcrm1045.i |
Release Inicial | 12.1.8 |
Versão de Integração | N/A |
Data Liberação | N/A |
Banco | Mdtcrm |
Tabela | crm_acess_portal |
Aplicativo | Portal CRM |
Evolução | |
Versão | 12.1.8 |
Programa | fchcrm/fchcrm1045.p |
Objetivo
Realizar a manutenção de controle de acesso.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
ttFilter | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
c_table | character |
| Tabela | Sim |
c_property | character |
| Propriedade | Sim |
c_value | character |
| Valor | Sim |
ttRestricaoAcesso | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
nom_acess | character |
| Nome acesso | Sim |
idi_tip_acess | integer |
| Tipo acesso | Sim |
ttRegraAcesso | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
num_id_acess_portal | integer |
| Numero Id acesso | Sim |
idi_tip_acess | integer |
| Tipo acesso | Sim |
num_id_acess_compon | integer |
| Numero Id componente | Sim |
nom_compon | character |
| Nome componente | Sim |
num_id_acess_form_portal | Integer |
| Numero Id formulário | Sim |
nom_form | Character |
| Nome formulário | Sim |
log_livre_1 | Logical |
| Logico livre 1 | Sim |
log_visivel | Logical |
| Visível | Sim |
log_editavel | Logical |
| Editável | Sim |
log_op_editavel | logical |
| Formulário editável | Sim |
ttUsuario | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
num_id_acess_portal | integer |
| Numero Id acesso | Sim |
num_id_grp_usuar | integer |
| Numero Id grupo usuário | Sim |
nom_grp_usuar | character |
| Nome grupo usuário | Sim |
num_id_usuar | integer |
| Numero Id usuário | Sim |
nom_usuar | character |
| Nome usuário | Sim |
cod_usuario | character |
| Codigo usuário | Sim |
log_usuar | logical |
| Usuário | Sim |
ttFormulario | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
nom_form | character |
| Nome formulário | Sim |
cod_form | character |
| Codigo formulário | Sim |
log_padr | logical |
| Padrão | Sim |
log_livre_1 | logical |
| Logico livre 1 | Sim |
ttRestricaoFormulario | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
num_id_acess_portal | integer |
| Numero Id acesso | Sim |
idi_tip_acess | integer |
| Tipo acesso | Sim |
num_id_acess_compon | integer |
| Numero Id componente | Sim |
nom_compon | character |
| Nome componente | Sim |
num_id_acess_form_portal | Integer |
| Numero Id formulário | Sim |
nom_form | Character |
| Nome formulário | Sim |
log_livre_1 | Logical |
| Logico livre 1 | Sim |
log_visivel | Logical |
| Visível | Sim |
log_editavel | Logical |
| Editável | Sim |
log_op_editavel | logical |
| Formulário editável | Sim |
ttRestricaoUsuario | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
num_id_acess_portal | integer |
| Numero Id acesso | Sim |
num_id_grp_usuar | integer |
| Numero Id grupo usuário | Sim |
nom_grp_usuar | character |
| Nome grupo usuário | Sim |
num_id_usuar | integer |
| Numero Id usuário | Sim |
nom_usuar | character |
| Nome usuário | Sim |
cod_usuario | character |
| Codigo usuário | Sim |
log_usuar | logical |
| Usuário | Sim |
ttRestricaoFormularioUsuario | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
cod_compon | character |
| Codigo componente | Sim |
log_visivel | logical |
| Visivel | Sim |
idi_tip_acess | integer |
| Tipo acesso | Sim |
log_editavel | logical |
| Editavel | Sim |
Metodo Básico
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
REST_GET | ||
Requisito | N/A | |
Sintaxe | REST_GET (INPUT QP_start, INPUT QP_end, INPUT QP_properties, INPUT QP_values, INPUT QP_orderBy, INPUT QP_asc, INPUT QP_count, INPUT QP_type, OUTPUT REST_count, OUTPUT DATASET DSCRMRestricaoAcesso, OUTPUT TABLE RowErrors) | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
QP_start | Valor inicial da faixa de registros | |
QP_end | Valor final da faixa de registros | |
QP_properties | Propriedades | |
QP_values | Valores | |
QP_orderBy | Campo para ordenação | |
QP_asc | Ascendente ou Decrescente | |
QP_count | Contador | |
QP_type | Tipo | |
REST_count | Quantidade de registros selecionados | |
DATASET DSCRMRestricaoAcesso | Dataset com os registros selecionados | |
TABLE RowErros | Tabela de erros | |
Retorno | A API/BO irá retornar os registros selecionados e a quantidade. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. | |
REST_POST |
| ||
Requisito | N/A |
| |
Sintaxe | REST_POST (INPUT TABLE ttRestricaoAcessoVO, OUTPUT DATASET DSCRMRestricaoAcesso, OUTPUT TABLE RowErrors) |
| |
Descrição | Cria nova restrição de acesso. |
| |
Parâmetros | Descrição |
| |
TABLE ttRestricaoAcessoVO | Tabela restrição de acesso |
| |
DATASET DSCRMRestricaoAcesso | Dataset com os registros selecionados |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar a restrição de acesso cadastrada na base. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
REST_PUT |
| ||
Requisito | N/A |
| |
Sintaxe | REST_PUT (INPUT PP_id, INPUT TABLE ttRestricaoAcessoVO, DATASET DSCRMRestricaoAcesso, OUTPUT TABLE RowErrors) |
| |
Descrição | Atualiza restrição de acesso. |
| |
Parâmetros | Descrição |
| |
PP_id | Codigo Identificador Sequencial |
| |
TABLE ttRestricaoAcessoVO | Tabela restrição de acesso |
| |
DATASET DSCRMRestricaoAcesso | Dataset com os registros selecionados |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá atualizar a restrição de acesso solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
REST_DELETE |
| ||
Requisito | N/A |
| |
Sintaxe | REST_DELETE (INPUT PP_id, OUTPUT l_ok, OUTPUT TABLE RowErrors) |
| |
Descrição | Exclui a restrição de acesso. |
| |
Parâmetros | Descrição |
| |
PP_id | Código Identificador Sequencial |
| |
l_ok | Indentificador sucesso |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá excluir a restrição de acesso. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
Metodo Negócio
REST_GET_detail |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_detail (INPUT PP_id, OUTPUT DATASET DSCRMRestricaoAcesso, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna o detalhe da restrição de acesso solicitada. |
| |
Parâmetros | Descrição |
| |
PP_id | Codigo Identificador Sequencial |
| |
DATASET DSCRMRestricaoAcesso | Dataset com os registros selecionados |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar o detalhe da restrição de acesso solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
REST_GET_form |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_form (INPUT QP_general, OUTPUT TABLE ttFormulario, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna todos os formulários. |
| |
Parâmetros | Descrição |
| |
QP_general | Geral |
| |
TABLE ttFormulario | Tabela Formulário |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar todos os formulários cadastrados. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
REST_POST_form |
| ||
Requisito | N/A |
| |
Sintaxe | REST_POST_form (INPUT PP_restriction, INPUT-OUTPUT TABLE ttRestricaoFormularioVO, OUTPUT TABLE RowErrors) |
| |
Descrição | Cria nova restrição de acesso ao formulário. |
| |
Parâmetros | Descrição |
| |
PP_restriction | Codigo Identificador Sequencial |
| |
TABLE ttRestricaoFormularioVO | Tabela restrição formulário |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar a restrição de acesso formulário cadastrada na base. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
REST_DELETE_form |
| ||
Requisito | N/A |
| |
Sintaxe | REST_DELETE_form (INPUT PP_id, OUTPUT l_ok, OUTPUT TABLE RowErrors) |
| |
Descrição | Exclui a restrição de acesso formulário. |
| |
Parâmetros | Descrição |
| |
PP_id | Código Identificador Sequencial |
| |
l_ok | Indentificador sucesso |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá excluir a restrição de acesso formulário. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
REST_GET_form_component |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_form_component (INPUT PP_restriction, INPUT PP_form, OUTPUT TABLE ttRegraAcesso, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna todos os componentes cadastrados para o formulário. |
| |
Parâmetros | Descrição |
| |
PP_restriction | Codigo Identificador Sequencial Restrição |
| |
PP_form | Codigo Identificador Sequencial Formulário |
| |
TABLE ttRegraAcesso | Tabela regras acesso |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar todos os componentes cadastrados para o formulário. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
REST_POST_form_component_restriction |
| ||
Requisito | N/A |
| |
Sintaxe | REST_POST_form_component_restriction (INPUT-OUTPUT TABLE ttRegraAcesso, OUTPUT TABLE RowErrors) |
| |
Descrição | Cria nova restrição de acesso ao componente do formulario. |
| |
Parâmetros | Descrição |
| |
TABLE ttRegraAcesso | Tabela regras acesso |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar a restrição de acesso ao componente do formulário cadastrada na base. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
REST_POST_restriction_user_group |
| ||
Requisito | N/A |
| |
Sintaxe | REST_POST_restriction_user_group (INPUT PP_restriction, INPUT-OUTPUT TABLE ttRestricaoUsuarioVO, OUTPUT TABLE RowErrors) |
| |
Descrição | Cria nova restrição de acesso ao grupo de usuário. |
| |
Parâmetros | Descrição |
| |
PP_restriction | Codigo Identificador Sequencial |
| |
TABLE ttRestricaoUsuarioVO | Tabela restrição usuário |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar a restrição de acesso ao grupo de usuário cadastrada na base. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
REST_DELETE_restriction_user_group |
| ||
Requisito | N/A |
| |
Sintaxe | REST_DELETE_restriction_user_group (INPUT PP_id, OUTPUT l_ok, OUTPUT TABLE RowErrors) |
| |
Descrição | Exclui o grupo de usuário da restrição de acesso. |
| |
Parâmetros | Descrição |
| |
PP_id | Código Identificador Sequencial |
| |
l_ok | Indentificador sucesso |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá excluir o grupo de usuário da restrição de acesso. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
REST_GET_user_restriction |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_user_restriction (INPUT PP_form, INPUT QP_user, OUTPUT TABLE ttRestricaoFormularioUsuario, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna todas as restrições do usuário. |
| |
Parâmetros | Descrição |
| |
PP_form | Codigo Identificador Sequencial Formulário |
| |
QP_user | Codigo Identificador Sequencial Usuário |
| |
TABLE ttRestricaoFormularioUsuario | Tabela restrição formulário usuário |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar todas as restrições cadastradas para o usuário. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas