Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | crmapi\apiCrmManterParam.p |
Objetivo
Realizar manutenção dos Parâmetros do CRM.
Tabelas Temporárias
Atributos das tabelas temporárias de entrada e saída:
tt-resultado |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
num_id | Int |
| Código |
|
ttResp |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
nom_grp_param | Char |
| Grupo |
|
nom_tit_param | Char |
| Título |
|
dsl_descr_param | Char |
| Descrição |
|
nom_param_crm | Char |
| Parâmetro |
|
dsl_param_crm | Char |
| ValorCampo |
|
cod_campo_compon | Char |
| TipoCampo |
|
des_legend | Char |
| LegendaComboBox |
|
idi_tip_dados_crm | Char |
| TipoDados |
|
num_id | Char |
| CampoChave |
|
tab_referada | Char |
| Tabela Referênciada |
|
val_default | Char |
| ValorDefault |
|
ttPref |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
nom_grp_param | Char |
| Grupo |
|
nom_tit_param | Char |
| Título |
|
dsl_descr_param | Char |
| Descrição |
|
nom_param_crm | Char |
| Parâmetro |
|
dsl_param_crm | Char |
| Valor do Campo |
|
cod_campo_compon | Char |
| Tipo do Campo |
|
des_legend | Char |
| Legenda do Combo Box |
|
idi_tip_dados_crm | Char |
| Tipo de Dados |
|
num_id | Char |
| Campo Chave |
|
tab_referada | Char |
| Tabela Referênciada |
|
val_default | Char |
| Valor Default |
|
ttGeraGrid |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
num_id | Char |
| Código |
|
grupo | Char |
| Grupo |
|
titulo | Char |
| Título |
|
descricao | Char |
| Valor |
|
ttTabZoom |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
numId | Char |
| campoChave |
|
tabReferada | Char |
| TabReferada |
|
entityHandler | Char |
| BO |
|
entityName | Char |
| model.banco.tabela |
|
fieldCode | Char |
| CampoRetornado |
|
fieldLabel | Char |
| descZoom |
|
queryColumnName | Char |
| ChaveTabAtual |
|
typeColumn | Char |
| TipoColuna |
|
tool_Tip | Char |
| Mensagem |
|
xmlName | Char |
| CrudRefenc |
|
Métodos
Métodos básicos
Método: carregaTtResp.
Descrição: Carrega a ttResp com todos os registros da CRM_PARAM.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ttResp | tt |
|
| X |
| Responsáveis |
Método: populaTtPref.
Descrição: Popula ttPref de acordo com o registro posicionado na ttResp.
Requisitos: Nenhum.
Parâmetros: Nenhum.
Método: filtroParam.
Descrição: Retorna os valores encontrados no filtro passado.
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-descr | Char |
| X |
|
| Descrição |
c-indice | Char |
| X |
|
| Índice |
ttPref | tt |
|
| X |
|
|
ttGeraGrid | tt |
|
| X |
|
|
Método: alterParamCrm.
Descrição: Altera o valor do parâmetro.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-valor | Char |
| X |
|
| Valor |
num_id | Char |
| X |
|
| Código |
c-descr | Char |
| X |
|
| Descrição |
flag_salv | Log |
|
| X |
| Flag Salvar |
Método: alteraValor.
Descrição: Altera valores.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-texto | Char |
|
|
| X | Texto |
Método: descZoom.
Descrição: Retorna a descrição do valor do parâmetro.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-fk_zoom | Char |
| X |
|
| Chave Estrangeira do Zoom |
c-tabela | Char |
| X |
|
| Tabela |
i-default | Char |
| X |
|
| Default |
guarda_val | Char |
|
| X |
| Valor |
val_default | Char |
|
| X |
| Valor Default |
Método: referencZoom.
Descrição: Retorna as propriedades da tabela passada como parâmetro.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-tab_refer | Char |
| X |
|
| Tabela Referenciada |
ttTabZoom | tt |
|
| X |
|
|
Método: buscaAcoesDaCampanha.
Descrição: Retorna a campanha cadastrada no parâmetro do CRM.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
i-campanha | Int |
|
| X |
| Campanha |
c-msg | Char |
|
| X |
| Mensagem |
Método: buscaResultadosDaAcaoCampanha.
Descrição: Retorna os resultados da ação X campanha cadastrada no parâmetro do CRM.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
tt-resultado | tt |
|
| X |
| Resultados |
c-msg | Char |
|
| X |
| Mensagem |
nenhumResultado | Log |
|
| X |
| Nenhum Resultado |