Criar carregadores em nuvem personalizados

Etapas básicas

Insira as configurações da fonte de dados.
Definir parâmetros.
Escreva JavaScript usando as APIs da fonte de dados em nuvem personalizada no Namespace ai.
Definir regras de negócios.
Executar ou programar o carregador.

Pré-requisitos

Verifique se você tem a permissão de desenvolvedor de integração.
Verifique se
Adaptive Planning
os dados do plano que você quer exportar já existem em uma tabela de preparação.
Crie uma credencial OAuth para seu sistema externo ou obtenha credenciais que você possa incluir explicitamente em seu JavaScript.
Saiba quais parâmetros você precisa passar para seu sistema externo e quais valores por padrão o sistema externo espera.
Entenda como escrever no ponto de extremidade do sistema externo.

Navegação

No menu de navegação, acesse

Integração

Design de integrações

.

Inserir as configurações de fonte de dados

Criar um novo carregador em nuvem personalizado

Acesse o Designer de dados em
Integração > Design de integrações
.
Na pasta Carregadores da Biblioteca de componentes, selecione
Criar novo carregador
.
Selecione
Carregador em nuvem personalizado
como o tipo de carregador e informe um nome.
Se a opção Carregador em nuvem personalizado não é exibida, ele não está habilitado para essa instância ou você não tem a permissão de desenvolvedor de integração necessária para acessá-lo.
Selecione
Criar
.

Selecione a tabela de origem, a credencial e o nível de registro

Insira as informações do carregador em nuvem personalizado:
Tabela de origem:
selecione uma tabela de preparação que contenha
Adaptive Planning
dados do Planning que você quer exportar.
Credencial obrigatória
: selecione se o sistema externo requer OAuth e você exige que um usuário com permissão de operador de integração selecione a credencial OAuth apropriada.
Credencial
: selecione uma credencial OAuth preexistente.
Nível de registro
: selecione o nível de detalhes que você quer registrar quando o carregador é executado:
Erro
:
registra somente erros.
Informações
:
registra todas as informações básicas, como por exemplo, a data em que a fonte de dados foi atualizada.
Detalhado
:
apresenta informações muito detalhadas sobre todas as fases e ações. Esse nível é usado principalmente para depuração ou auditoria, pois pode produzir mais informações de registro do que as necessárias para o uso geral.
Clique em
Salvar
no menu de ações.

Definir parâmetros

Selecione
Configurações do designer.
Arraste os itens de configuração parametrizados ou estáticos do painel
Componente de configuração
até
Configurações do designer.
Os valores de configuração parametrizados informados aqui se tornam valores por padrão do carregador se você não fornece outros durante a execução do carregador.
As configurações estáticas informadas aqui são usadas sempre que o carregador é executado e não exige nenhuma entrada em tempo de execução.
Booliano: valor representado como um ou zero.
Dimensão: dimensão do administrador de dimensões no
Adaptive Planning
.
Inteiro: número inteiro não negativo.
Senha: senha. Esse valor não pode ser visualizado depois de salvo.
Intervalo de períodos: um intervalo de períodos de dentro de
Adaptive Planning
.
Texto: valor alfanumérico.
Clique duas vezes em um item de parâmetro para inserir um nome e alterar seu valor.
Arraste para dentro todos os itens que você precisar para fazer referência no JavaScript.
Salve o carregador.
Use o nome de um parâmetro no JavaScript para fazer referência a ele.

Escrever JavaScript

Selecione
Scripts
.
Selecione o modelo preexistente e altere-o ou selecione
Novo script
para criar o seu.
Escreva o código JavaScript que você quer que o carregador execute usando as APIs da fonte de dados em nuvem personalizada no Namespace ai.
Verifique se o script inclui os seguintes itens obrigatórios:
testConnection
Função para criar uma solicitação https para publicar em seu sistema externo
exportData
função para exportar dados de
Adaptive Planning
. Consulte Função Exportar dados (somente carregador em nuvem personalizado) no tópico Funções do Adaptive Planning.
Crie as referências de todos os parâmetros que você criou em Configurações do designer pelos nomes deles.
Salve o script.

Usar o OAuth em scripts do carregador em nuvem personalizado

Selecionar
Solicitar autorização
antes de executar o carregador.
Fornecer todos os detalhes de autorização, como o escopo, necessários para o ponto de extremidade do sistema externo.
Selecionar
Testar conexão
para verificar se as credenciais OAuth foram transmitidas com êxito ao ponto de extremidade.
Observar a data da autorização e a ID de usuário em Status de autorização. As datas de vencimento da autorização variam de um sistema externo para outro. Quando necessário, selecione Redefinir autorização no painel Ações para atualizar a autorização.

Definir regras de negócios

Selecione a guia
Regras de negócios
.
Selecione
Editar
.
Insira uma expressão SQL. Você pode clicar em um item em Colunas disponíveis para trazer essa coluna para a expressão SQL em vez de digitá-la.
Selecione
Aplicar
para verificar a sintaxe. Se houver erros na sintaxe, a borda ao redor da expressão se tornará vermelha. Posicione o cursor do mouse sobre a expressão para ver as informações dos erros de sintaxe.
Corrija os erros na sintaxe e selecione
Aplicar
. Somente as linhas de preparação que correspondem à expressão SQL são carregadas.

Incluir o carregador em nuvem personalizado em uma tarefa de integração

Exemplo de script CCL

Defina uma fonte de dados de planilha.
Crie um novo carregador em nuvem personalizado no painel
Carregadores
.
Navegue até a guia
Configurações de fonte de dados
e selecione a fonte de dados de planilha no campo
Tabela de origem
.
Copie o script de amostra a seguir na guia
Scripts
.
 // Manually invoke this method via 'Test connection'
function testConnection(context) {
    return true;
}
// Manually invoke this method via 'Run manually'
function exportData(context) {
   //"xxx" is the name of your Amazon S3 bucket. 
    var bucketName = 'xxx';
    //Name of the sample CSV file to which data from your spreadsheet data source is exported
    var key = 'exampleTest.csv';
    //"xxxx" is the access key for your AWS S3 bucket.
    var awsAccessKey = 'xxxx';
    //"xxxx" is the secret key of your AWS S3 bucket. 
    var awsSecretKey = 'xxxx';
    var region = 'us-west-1';
    // Step 1: Get the data
    var reader = context.createTableReader();
    // Step 2: Process and export the data
    var result = "Column,Heading,Names\n";
    var row = null;
    while ((row = reader.readRow()) !== null) {
       // remove meta columns we don't need
       row.length = row.length - 2;
       result += row.join() + '\n';
   }
    ai.awss3.putFile(bucketName, key, result, region, awsAccessKey, awsSecretKey);
} 
Selecione
Salvar
no painel
Ações
.
Para executar o script, selecione
Executar manualmente
no painel
Ações
.