LeadAPIHelperOOB - Com escopo

. LeadAPIHelperOOB a inclusão de script fornece métodos de ajuda chamados pelo lead REST API para executar várias funções, como converter um conjunto de registros de lead de um objeto GlideRecord em uma matriz JSON ou objeto JSON e transformar campos em um objeto lead.

Se você quiser personalizar essas funções de ajuda, substitua os métodos nesta inclusão de script no LeadAPIHelper inclusão de script. Os nomes dos métodos que você está substituindo no LeadAPIHelper a inclusão de script deve ser igual às do LeadAPIHelperOOB arquivo de inclusão de script.

Esta API é fornecida no sn_lead_mgmt_core namespace. Para acessar a API, o plug-in Modelo de dados de gestão de leads (sn_lead_mgmt_core) deve ser ativado na instância e o usuário chamador deve ter a função sn_lead_mgmt_core.lead_integrator.

Para obter informações adicionais sobre Gestão de leads, consulte Using Lead Management.

LeadAPIHelperOOB - getJSONFromGR(GlideRecord gr, campos de matriz)

Converte um objeto GlideRecord em um objeto JSON. Este método itera nos campos do GlideRecord, verifica seus tipos e formata adequadamente seus valores em uma estrutura compatível com JSON.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
gr	GlideRecord	Objeto GlideRecord a ser convertido em um objeto JSON.
campos	Matriz	Opcional. Nomes de campos separados por vírgulas a serem incluídos no objeto JSON. Esses nomes devem corresponder exatamente aos nomes no registro do lead. Por exemplo:  [account", "first_name", "do_not_call", "lead_line_items"] Nota: . fieldso parâmetro é nulo ou contém o valor "lead_line_items" , o método busca cada registro de item de linha associado, incluindo todos os campos do item de linha. Este método só oferece suporte à conversão de campos individuais da tabela Lead [sn_lead_mgmt_core_lead], não da tabela Item de linha de lead [sn_lead_mgmt_core_lead_line_item]. Se você especificar um campo específico da tabela Item de linha de lead, ele será ignorado. Padrão: Todos os campos de registro de lead estão incluídos no objeto JSON.

Tabela 2. Retornos

Tipo	Descrição
Objeto JSON	Objeto JSON que contém os campos do GlideRecord especificado. Cada campo no GlideRecord é convertido em um par de chave-valor. Tratamento especial é aplicado a campos de referência, campos de opção, campos de data/hora e outros tipos de dados específicos para garantir que eles estejam formatados corretamente.

O exemplo de código a seguir mostra onde adicionar seu código personalizado para GetJsonFromGR() método no LeadAPIHelper inclusão de script.

var LeadAPIHelper = Class.create(); 
LeadAPIHelper.prototype = Object.extendsObject(LeadAPIHelperOOB, {

// Define overriding functions here
getJSONFromGR: function(gr, fields) {

// Add your custom code here
},

type: 'LeadAPIHelper'
});

LeadAPIHelperOOB - getLeadsJSON(GlideRecord leadsGr, campos de matriz)

Converte um conjunto de registros de lead de um objeto GlideRecord em uma matriz JSON. Você deve especificar os campos de registro de lead que deseja incluir na matriz JSON.

Tabela 3. Parâmetros

Nome	Tipo	Descrição
LeadsGr	GlideRecord	Objeto GlideRecord que contém os registros de lead a serem convertidos em JSON. Tabela: Lead [sn_lead_mgmt-core_lead]
campos	Matriz	Nomes de campos separados por vírgulas a serem incluídos no objeto JSON. Esses nomes devem corresponder exatamente aos nomes no registro do lead. Por exemplo:  [account", "first_name", "do_not_call", "lead_line_items"] Nota: . fieldso parâmetro é nulo ou contém o valor "lead_line_items" , o método busca cada registro de item de linha associado, incluindo todos os campos do item de linha. Este método só oferece suporte à conversão de campos individuais da tabela Lead [sn_lead_mgmt_core_lead], não da tabela Item de linha de lead [sn_lead_mgmt_core_lead_line_item]. Se você especificar um campo específico da tabela Item de linha de lead, ele será ignorado.

Tabela 4. Retornos

Tipo

Descrição

Matriz de objetos JSON

Cada objeto representa um lead que contém os campos especificados. Se aplicável, ele também inclui uma matriz de objetos de item de linha de lead para cada lead. Cada campo no GlideRecord é convertido em um par de chave-valor. Tratamento especial é aplicado a campos de referência, campos de opção, campos de data/hora e outros tipos de dados específicos para garantir que eles estejam formatados corretamente.

O exemplo de código a seguir mostra onde adicionar seu código personalizado para GetLeadsJson() método no LeadAPIHelper inclusão de script.

var LeadAPIHelper = Class.create();
LeadAPIHelper.prototype = Object.extendsObject(LeadAPIHelperOOB, { 

// Define overriding functions here 
getLeadsJson: function(leadsGR, fields) {

// Add your custom code here
}, 

type: 'LeadAPIHelper' 
}); 

LeadAPIHelperOOB - getTransformedLeadObject(Object leadObject)

Transforma o objeto principal especificado.

Esta transformação inclui:

• Removendo campos ignorados.
• Convertendo campos de referência em seus valores associados, como um sys_id.
• Combinar textos de anotações de trabalho em uma cadeia de caracteres separada por vírgulas.
• Validando os campos Conta, contato e consumidor. Os valores de conta, contato e consumidor serão ignorados se a conta e o consumidor contiverem valores.

Tabela 5. Parâmetros

Nome	Tipo	Descrição
LeadObject	Objeto	Objeto principal a ser transformado. Este objeto contém detalhes do lead e seus itens de linha de lead relacionados.

Tabela 6. Retornos

Tipo	Descrição
Objeto	Objeto de lead transformado.

O exemplo de código a seguir mostra onde adicionar seu código personalizado para ObtObjeLeadObject() método no LeadAPIHelper inclusão de script.

var LeadAPIHelper = Class.create();

LeadAPIHelper.prototype = Object.extendsObject(LeadAPIHelperOOB, {

// Define overriding functions here 
getTransformedLeadObject: function(leadObject) { 

// Add your custom code here
}, 

type: 'LeadAPIHelper'
});