Definir funções SQL adicionais adding-additional-sql-functions
O Adobe Campaign permite que o usuário defina suas próprias funções que podem acessar funções SQL, aquelas oferecidas pelo banco de dados e aquelas que ainda não estão disponíveis no console. Isso é útil para funções agregadas (média, máximo, soma), por exemplo, que só podem ser calculadas no servidor ou quando o banco de dados fornece uma maneira mais fácil de implementar determinadas funções, em vez de gravar "manualmente" a expressão no console (por exemplo, gerenciamento de datas).
Esse mecanismo também pode ser usado se você quiser usar uma função SQL recente ou incomum do mecanismo de banco de dados, que ainda não é oferecida pelo console do Adobe Campaign.
Depois que essas funções forem adicionadas, elas aparecerão no editor de expressão da mesma forma que outras funções predefinidas.
Instalação installation
As funções a serem adicionadas estão em um arquivo "package" no formato XML, cuja estrutura é apresentada em pormenor no parágrafo seguinte.
Para instalá-lo a partir do console, selecione a opção Ferramentas/Avançado/Importar pacote opções no menu e, em seguida, na guia Install from file e siga as instruções do assistente de importação.
Estrutura geral do pacote a importar general-structure-of-package-to-import
As funções a serem adicionadas podem ser encontradas no arquivo "package" no formato XML. Aqui está um exemplo:
<?xml version="1.0" encoding='ISO-8859-1' ?>
<!-- ===========================================================================
Additional SQL functions for Adobe Campaign
========================================================================== -->
<package
namespace = "nms"
name = "package-additional-funclist"
label = "Additional functions"
buildVersion= "7.1"
buildNumber = "10000">
<entities schema="xtk:funcList">
<funcList name="myList" namespace="cus">
<group name="date" label="Personalized date">
<function name="relativeMaturity" type="long" args="(<Âge>)" help="Returns the difference between a date and 18 years"
minArgs="1" maxArgs="1" display="Relative maturity of the person born on the date $1">
<providerPart provider="MSSQL,Sybase,PostgreSQL" body="extract(year from age($1))-18"/>
</function>
</group>
</funcList>
</entities>
</package>
-
A variável name, namespace e rótulo são apenas para fins informativos. Eles permitem exibir um resumo do pacote na lista de pacotes instalados (Explorer/Administration/Package management/Installed packages).
-
A variável buildVersion e buildNumber Os campos são obrigatórios. Eles devem corresponder ao número do servidor ao qual o console está conectado. Essas informações podem ser encontradas na caixa "Ajuda/Sobre".
-
Os seguintes blocos, entidades e funclist são obrigatórios. Em funcList, os campos "name" e "namespace" são obrigatórios, mas seu nome é deixado para o usuário decidir e ele designa exclusivamente a lista de funções.
Isso significa que se outra lista de funções com o mesmo par de namespace/nome (aqui "cus::myList") for importada, as funções importadas anteriormente serão excluídas. Por outro lado, se você alterar esse par de namespace/nome, a nova série de funções importadas será adicionada à série anterior.
-
A variável grupo element permite especificar o grupo de funções no qual as funções importadas aparecerão no editor de funções. O atributo @name pode ser um nome que já existe (nesse caso, as funções serão adicionadas ao grupo considerado) ou um novo nome (nesse caso, ele aparecerá em um novo grupo).
-
Lembrete: valores possíveis para o atributo @name no
<group>elementos são:code language-none name="aggregate" ( label="Aggregates" ) name="string" ( label="String" ) name="date" ( label="Date" ) name="numeric" ( label="Numeric" ) name="geomarketing" ( label="Geomarketing" ) name="other" ( label="Others" ) name="window" ( label="Windowing functions" )
Se quiser adicionar funções a vários grupos diferentes, você pode fazer vários <group> Os elementos do são rastreados na mesma lista.
Por último, uma <group> O elemento pode conter a definição de uma ou várias funções, que é a finalidade do arquivo de pacote. A variável <function> O elemento é detalhado no parágrafo a seguir.
Descritor de função <function></function> function-descriptor--function-
O caso aqui apresentado é um caso geral em que pretendemos apresentar implementação de função.
Abaixo está um exemplo de uma função de "maturidade relativa" que, usando uma idade, indica por quantos anos a pessoa foi considerada madura.
<function name="relativeMaturity" type="long" args="(<Âge>)" help="Returns the difference between a date and 18 years"
minArgs="1" maxArgs="1" display="Relative maturity of the person born on the date $1">
<providerPart provider="PostgreSQL" body="extract(year from age($1))-18"/>
<providerPart provider="MSSQL,Sybase,Teradata" body="[Other implementation]"/>
</function>
A variável @name o campo refere-se ao nome da função, e "args" é a lista de parâmetros que será exibida na descrição. Nesse caso, a função aparecerá como "relativeMaturity ( <age> )" na janela de seleção de função.
-
ajuda é o campo exibido na parte inferior da janela do editor de expressões.
-
@display é uma mensagem informativa.
note note NOTE Nos atributos @help e @display, a string "$1" representa o nome fornecido no primeiro parâmetro de função (aqui, "Age"). $2, $3… representariam os seguintes parâmetros. No atributo @body detalhado abaixo, $1 designa o valor do argumento passado para a função durante a chamada. note note NOTE A descrição deve ser uma cadeia de caracteres XML válidos: observe o uso de '<' e '>' em vez de < e >. -
@type é o tipo de retorno da função e é um valor padrão (long, string, byte, datetime…). Se for omitido, o servidor determinará o melhor tipo entre os tipos disponíveis na expressão que implementa a função.
-
@minArgs e maxArgs designa o número de parâmetros (mínimo e máximo) para um parâmetro. Por exemplo, para uma função com 2 parâmetros, minArgs e maxArgs serão 2 e 2. Para 3 parâmetros, mais 1 opcional, eles serão 3 e 4, respectivamente.
-
Por último, a providerPart elemento fornece a implementação da função.
- A variável provider atributo é obrigatório, ele especifica os sistemas de banco de dados para os quais a implementação é fornecida. Como mostrado no exemplo, quando as sintaxes de expressão ou as funções subjacentes diferem, implementações alternativas podem ser fornecidas de acordo com o banco de dados.
- A variável @body O atributo contém a implementação da função. Observação: esta implementação deve ser uma expressão em linguagem de banco de dados (não um bloco de código). Dependendo dos bancos de dados, as expressões podem ser subconsultas ("(selecione a coluna da tabela onde…)") que retornam apenas um valor único. Por exemplo, esse é o caso no Oracle (a consulta deve ser gravada entre parênteses).
note note NOTE Se apenas um ou dois bancos de dados forem consultados pela função definida, sempre poderemos fornecer apenas as definições correspondentes a esses bancos de dados.
Descritor de função 'Pass-through' pass-through--function-descriptor
Um descritor de função especial é o "passagem" bloco, com um sistema de banco de dados "provedor" não especificado. Nesse caso, a implementação "body" só pode conter uma única chamada de função com uma sintaxe que não depende do banco de dados usado. Enquanto isso, o bloco "ProviderPart" é exclusivo.
<function name="CountAll" args="()" help="Counts the values returned (all fields together)"
type="long" minArgs="0" maxArgs="0">
<providerPart body="Count(*)"/>
</function>
Nesse caso, adicionar uma função serve apenas para tornar uma função de banco de dados que não estaria disponível por padrão, agora visível para o cliente.
Exemplos examples
Mais exemplos de função podem ser encontrados no pacote predefinido "xtkdatakitfuncList.xml".