Comandos do Anaplan

Para interagir com o Anaplan®, adicione uma etapa em uma cadeia que use um comando de conexão do Anaplan.

Para habilitar esses comandos, um administrador de TI primeiro configura um conector Anaplan:

Para executar funções padrão para gerenciar arquivos, ações e processos no Anaplan, configure um conector Anaplan (Standard).
Para definir configurações de segurança no Anaplan por meio da automação de processos robóticos (RPA), como quando você carrega uma nova fonte de dados como parte de uma cadeia, configure um conector Anaplan (RPA).

Baixar arquivo

Para fazer download de um arquivo de servidor Anaplan, adicione um comando Download File.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#Download-files

Propriedades

Propriedade	Detalhes
Espaço de trabalho	Entre no espaço de trabalho do Anaplan.
Modelo	Digite o modelo do Anaplan.
Arquivo do servidor	Digite o arquivo do servidor Anaplan.
Baixar arquivo	Digite o arquivo a ser baixado do Anaplan.
Registros de cabeçalho	Insira o número de registros antes do primeiro registro de dados.
Cabeçalho da tarefa	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.
Registros de amostra	Selecione se você deseja fazer o download dos primeiros 100 registros, incluindo o cabeçalho.

Saídas

Saída	Tipo de saída
Sessão de download de arquivos do Anaplan	String
Contagem de registros do arquivo de download do Anaplan	Inteiro
Tamanho do arquivo de download do Anaplan	Inteiro
Arquivo de download do Anaplan	Arquivo

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais logs foram criados por meio da ação ou do processo de importação do Anaplan

Exportar histórico do modelo

Para executar uma exportação de histórico de modelos salvos e fazer download do conteúdo do arquivo, adicione um comando Export Model History.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#Export

Propriedades

Propriedade	Detalhes
Espaço de trabalho	Entre no espaço de trabalho do Anaplan.
Modelo	Insira o modelo Anaplan.
Ação de exportação do histórico do modelo	Digite o nome da ação de exportação do histórico do modelo.
Baixar arquivo	Digite o arquivo baixado do Anaplan.
Cabeçalho da tarefa	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.
Registros de amostra	Selecione se você deseja fazer o download dos primeiros 100 registros, incluindo o cabeçalho.

Saídas

Saída	Tipo de saída
Detalhes da sessão do histórico do modelo	String
Contagem de registros do histórico do modelo	Inteiro
Tamanho do arquivo do histórico do modelo	Inteiro
Dados do histórico do modelo	Arquivo

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais logs foram criados por meio da ação ou do processo de importação do Anaplan

Obter itens de dimensão

Para recuperar todos os itens em uma dimensão, adicione um comando Get Dimension Items.

Dica: Para recuperar somente itens específicos em uma dimensão, use o comando Get Selected Dimension Items.

Chamada de API equivalente: https://help.anaplan.com/general-lists-403a1ed1-ad7b-4ab3-b40c-61dd9d651075

Propriedades

Propriedade	Detalhes
Modelo	Digite o ID do modelo do Anaplan.
Dimensão	Digite a dimensão do Anaplan para a qual você deseja recuperar itens.

Saídas

Saída	Tipo de saída
Itens	Arquivo
Detalhes do erro	JSON

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha

Obter itens de dimensão selecionados

Para recuperar itens específicos em uma dimensão, adicione um comando Get Selected Dimension Items.

Dica: Para recuperar todos os itens em uma dimensão, use o comando Get Dimension Items.

Equivalent API call: https://help.anaplan.com/list-subsets-589d9f5d-f439-40a4-905f-5027c2dc9c21

Propriedades

Propriedade	Detalhes
Modelo	Digite o ID do modelo do Anaplan.
Dimensão	Digite a dimensão do Anaplan para a qual você deseja recuperar os itens.
Exibir ID	Digite o ID da visualização do Anaplan a ser recuperada.

Saídas

Saída	Tipo de saída
Itens	Arquivo
Detalhes do erro	JSON

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha

Obter metadados de exportação

Para recuperar os metadados de uma ação de exportação, adicione um comando Get Export Metadata.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#Export

Propriedades

Propriedade	Detalhes
Espaço de trabalho	Entre no espaço de trabalho do Anaplan.
Modelo	Insira o modelo do Anaplan.
Ação de exportação	Insira a ação de exportação do Anaplan.
Cabeçalho da tarefa	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.
Mapear misto para duplo	Para o Tableau®, selecione para converter o tipo de coluna `Mixed` para `Double`.

Saídas

Saída	Tipo de saída
Sessão de metadados da ação de exportação do Anaplan	String
Contagem de colunas da ação de exportação do Anaplan	Inteiro
Contagem de linhas da ação de exportação do Anaplan	Inteiro
Formato de arquivo de ação de exportação do Anaplan	String
Delimitador do campo de exportação da ação de exportação do Anaplan	String
Codificação de arquivo de ação de exportação do Anaplan	String
Separador de colunas da ação de exportação do Anaplan	String
Ação de exportação do Anaplan exportar metadados de coluna	JSON
Colunas de saída do Oracle	String
Colunas de saída do SQL Server	String
Colunas relacionais	String
Colunas de cabeçalho do Tableau	String

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais logs foram criados por meio da ação ou do processo de importação do Anaplan

Obter metadados de visualização

Para recuperar metadados de dimensões em uma exibição, adicione um comando Get View Metadata.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#RetrieveMetadataDimensionView

Propriedades

Propriedade	Detalhes
Modelo	Digite o ID do modelo Anaplan.
Ver	Digite a visualização para a qual você deseja recuperar os metadados.

Saídas

Saída	Tipo de saída
Exibir metadados	Arquivo
Detalhes do erro	JSON

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha

Listar ações

Para recuperar uma lista de ações do Anaplan, adicione um comando List Actions.

Chamada de API equivalente: NA

Propriedades

Propriedade	Detalhes
Espaço de trabalho	Entre no espaço de trabalho do Anaplan.
Modelo	Digite o modelo do Anaplan.
Cabeçalho da tarefa	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.

Saídas

Saída	Tipo de saída
Sessão de ações da lista Anaplan	String
Mapa de ações da lista Anaplan	Mapa
Lista de ações do Anaplan	Matriz

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais logs foram criados por meio da ação ou processo de importação do Anaplan

Listar ações de exportação

Para recuperar uma lista de ações de exportação do Anaplan, adicione um comando List Export Actions.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#Export

Propriedades

Propriedade	Detalhes
Espaço de trabalho	Entre no espaço de trabalho do Anaplan.
Modelo	Insira o modelo do Anaplan.
Cabeçalho da tarefa	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.

Saídas

Saída	Tipo de saída
Sessão de exportações da lista Anaplan	String
Mapa de exportações da lista Anaplan	Mapa
Lista de exportações da Anaplan	Matriz

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais logs foram criados por meio da ação ou do processo de importação do Anaplan

Listar arquivos

Para recuperar uma lista de arquivos do servidor Anaplan, adicione um comando List Files.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#GetListExportFiles

Propriedades

Propriedade	Detalhes
Espaço de trabalho	Entre no espaço de trabalho do Anaplan.
Modelo	Insira o modelo do Anaplan.
Tipo de arquivo	Selecione o tipo de recurso de arquivo Anaplan a ser baixado.
Exibir cabeçalho	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.

Saídas

Saída	Tipo de saída
Sessão de arquivos de lista do Anaplan	String
Mapa de arquivos de lista do Anaplan	Mapa
Lista de arquivos Anaplan	Matriz

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais logs foram criados por meio da ação ou do processo de importação do Anaplan

Listar ações de importação

Para recuperar uma lista de ações de importação do Anaplan, adicione um comando List Import Actions.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#Import

Propriedades

Propriedade	Detalhes
Espaço de trabalho	Entre no espaço de trabalho do Anaplan.
Modelo	Digite o modelo do Anaplan.
Cabeçalho da tarefa	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.

Saídas

Saída	Tipo de saída
Sessão de importações da lista Anaplan	String
Mapa de importações da lista Anaplan	Mapa
Lista de importações da Anaplan	Matriz

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais logs foram criados por meio da ação ou do processo de importação do Anaplan

Listar modelos

Para recuperar uma lista de modelos no locatário padrão do usuário, adicione um comando List Models.

Observação: Esse comando retorna detalhes sobre cada modelo, inclusive o tamanho atual, a ID, o nome e o estado do arquivo. Você pode usar essa saída com outros comandos Anaplan, por exemplo, para fornecer o ID do modelo.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#RetrieveModels

Propriedades

Propriedade	Detalhes
Espaço de trabalho	Digite o ID do espaço de trabalho do Anaplan.
Exibir cabeçalho	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.

Saídas

Saída	Tipo de saída
Sessão de modelos de lista Anaplan	String
Mapa de modelos da lista Anaplan	Mapa
Lista de modelos do Anaplan	Matriz
Modelos	Arquivo

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais logs foram criados por meio da ação ou do processo de importação do Anaplan

Listar módulos

Para recuperar uma lista de módulos de um modelo específico, adicione o comando List Modules.

Chamada de API equivalente: N/A

Propriedades

Propriedade	Detalhes
Espaço de trabalho	Digite o ID do espaço de trabalho do Anaplan.
Modelo	Digite o ID do modelo do qual você deseja recuperar os módulos.
Exibir cabeçalho	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.

Saídas

Saída	Tipo de saída
Sessão de módulos da lista Anaplan	String
Mapa de módulos da lista Anaplan	Mapa
Lista de módulos do Anaplan	Matriz

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais logs foram criados por meio da ação ou do processo de importação do Anaplan

Listar processos

Para recuperar uma lista de processos do Anaplan, adicione um comando List Processes.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#Process

Propriedades

Propriedade	Detalhes
Espaço de trabalho	Entre no espaço de trabalho do Anaplan.
Modelo	Digite o modelo do Anaplan.
Cabeçalho da tarefa	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.

Saídas

Saída	Tipo de saída
Sessão de processos da lista Anaplan	String
Mapa de processos da lista Anaplan	Mapa
Lista de processos do Anaplan	Matriz

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais logs foram criados por meio da ação ou do processo de importação do Anaplan

Listar visualizações

Para recuperar uma lista de exibições do Anaplan em um módulo, adicione um comando List Views.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#RetrieveIDNamesViewsModel

Propriedades

Propriedade	Detalhes
Espaço de trabalho	Entre no espaço de trabalho do Anaplan.
Modelo	Entre no modelo do Anaplan.
Módulo	Digite o módulo Anaplan.
Cabeçalho da tarefa	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.

Saídas

Saída	Tipo de saída
Sessão de exibições de lista do Anaplan	String
Mapa de visualizações da lista Anaplan	Mapa
Lista de visualizações do Anaplan	Matriz

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais logs foram criados por meio da ação ou do processo de importação do Anaplan

Listar espaços de trabalho

Para recuperar uma lista dos espaços de trabalho Anaplan disponíveis, adicione um comando List Workspaces.

Observação: Esse comando retorna detalhes sobre cada espaço de trabalho, inclusive o tamanho atual, o ID, o nome e o estado do arquivo. Você pode usar essa saída com outros comandos do Anaplan, por exemplo, para fornecer o ID do espaço de trabalho.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#ListUserWorkspaces

Propriedades

Propriedade	Detalhes
Cabeçalho da tarefa	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.

Saídas

Saída	Tipo de saída
Sessão de espaços de trabalho da lista Anaplan	String
Mapa de espaços de trabalho da lista Anaplan	Mapa
Lista de espaços de trabalho do Anaplan	Matriz
Espaços de trabalho	Arquivo

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais logs foram criados por meio da ação ou do processo de importação do Anaplan

Recuperar dados de célula para uma visualização (CSV)

Para recuperar os dados de célula de uma visualização como valores separados por vírgula (CSV), adicione um comando Retrieve cell data for a view (CSV).

Chamada de API equivalente: https://anaplan.docs.apiary.io/#RetrieveCellDataView

Propriedades

Propriedade	Detalhes
Modelo	Digite o ID do modelo Anaplan.
Ver	Digite a visualização para a qual você deseja recuperar os dados da célula.
Páginas	Digite os valores do seletor das páginas para as quais você deseja recuperar os dados da célula.

Saídas

Saída	Tipo de saída
Dados da célula	Arquivo
Detalhes do erro	JSON

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha

Recuperar dados de célula para uma visualização (JSON)

Para recuperar os dados de célula de uma exibição como JavaScript Object Notation (JSON), adicione um comando Retrieve cell data for a view (JSON).

Chamada de API equivalente: https://anaplan.docs.apiary.io/#RetrieveCellDataView

Propriedades

Propriedade	Detalhes
Modelo	Digite o ID do modelo Anaplan.
Ver	Digite a visualização para a qual você deseja recuperar os dados da célula.
Páginas	Digite os valores do seletor das páginas para as quais você deseja recuperar os dados da célula.

Saídas

Saída	Tipo de saída
Dados da célula	Arquivo
Detalhes do erro	JSON

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha

Executar ação de exportação

Para executar uma ação de exportação do Anaplan, adicione um comando Run Export Action.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#Export

Propriedades

Propriedade	Detalhes
Espaço de trabalho	Entre no espaço de trabalho do Anaplan.
Modelo	Insira o modelo do Anaplan.
Ação de exportação	Insira a ação de exportação do Anaplan.
Cabeçalho da tarefa	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.

Saídas

Saída	Tipo de saída
Sessão de ação de exportação do Anaplan	String

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais logs foram criados por meio da ação ou do processo de importação do Anaplan

Executar ação de exportação com dados

Para executar uma ação de exportação do Anaplan e fazer download do conteúdo do arquivo, adicione um comando Run Export Action with Data.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#Export

Propriedades

Propriedade	Detalhes
Espaço de trabalho	Entre no espaço de trabalho do Anaplan.
Modelo	Insira o modelo do Anaplan.
Ação de exportação	Insira a ação de exportação do Anaplan.
Baixar arquivo	Insira o arquivo baixado do Anaplan.
Registros de cabeçalho	Insira o número de registros antes do primeiro registro de dados.
Cabeçalho da tarefa	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.

Saídas

Saída	Tipo de saída
Sessão de download de arquivos do Anaplan	String
Contagem de registros do arquivo de download do Anaplan	Inteiro
Tamanho do arquivo de download do Anaplan	Inteiro
Arquivo de download do Anaplan	Arquivo

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais logs foram criados por meio da ação ou do processo de importação do Anaplan

Executar ação de importação

Para executar uma ação de importação do Anaplan, adicione um comando Run Import Action.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#Import

Propriedades

Propriedade	Detalhes
Espaço de trabalho	Entre no espaço de trabalho do Anaplan.
Modelo	Insira o modelo do Anaplan.
Ação de importação	Insira a ação de importação do Anaplan.
Exibir contagem de registros	Insira o número de registros a serem exibidos nos resultados do resumo da carga.
Cabeçalho da tarefa	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.

Saídas

Saída	Tipo de saída
Sessão de ação de importação do Anaplan	String
Arquivo de registro de ação de importação zipado do Anaplan	Arquivo
Registros de ações de importação do Anaplan criados	String

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais logs foram criados por meio da ação ou do processo de importação do Anaplan

Executar processo

Para executar um processo do Anaplan, adicione um comando Run Process.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#StartTheProcess

Propriedades

Propriedade	Detalhes
Espaço de trabalho	Entre no espaço de trabalho do Anaplan.
Modelo	Insira o modelo do Anaplan.
Processo	Insira o processo do Anaplan.
Exibir detalhes do processo	Selecione se deseja mostrar amostras de registros do arquivo de log.
Exibir contagem de registros	Insira o número de registros a serem exibidos nos resultados do resumo da carga.
Cabeçalho da tarefa	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.

Saídas

Saída	Tipo de saída
Sessão de execução do processo do Anaplan	String
Registros de ação de importação zipados do Anaplan em processo	Arquivo
Registros do processo de importação do Anaplan criados	String

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais registros foram criados por meio da ação ou processo de importação do Anaplan

Obter período atual

Para descobrir a data final do período atual de um modelo, adicione um comando getCurrentPeriod.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#RetrieveCurrentPeriod

Sintaxe

CURRENTPERIODEND()

Argumentos

A função CURRENTPERIODEND não usa nenhum argumento.

Esta função retorna um resultado de data.

Exemplo de sintaxe

CURRENTPERIODEND()

Neste exemplo, a fórmula retorna a data final do período atual.

Exemplo

PERIOD(CURRENTPERIODEND() + 1)

Nesse exemplo, a fórmula retorna o primeiro período de tempo após o período atual do modelo. Se o período atual do modelo for 20 de janeiro, ele retornará 20 de fevereiro.

Definir período atual

Para definir o valor do período atual no Anaplan, adicione um comando Set Current Period.

Chamada de API equivalente: https://help.anaplan.com/set-up-an-update-current-period-action-29c83f5d-6683-4af7-beee-eef966fde485

Propriedades

Propriedade	Detalhes
WorkspaceID	Digite o ID do espaço de trabalho do Anaplan.
Modelo	Digite o ID do modelo do Anaplan.
Data	Digite a data para o novo período atual como AAAA-MM-DD.

Saídas

Saída	Tipo de saída
Período atual ()	Arquivo
Detalhes do erro	JSON

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha

Carregar arquivo

Para fazer upload de um arquivo para o Anaplan, adicione um comando Upload File.

Chamadas de API equivalentes:

Propriedades

Propriedade	Detalhes
Espaço de trabalho	Entre no espaço de trabalho do Anaplan.
Modelo	Digite o modelo do Anaplan.
Arquivo do servidor	Digite o arquivo do servidor Anaplan.
Arquivo de origem	Digite o arquivo de origem para fazer upload.
Registros de cabeçalho	Insira o número de registros antes do primeiro registro de dados.
Cabeçalho da tarefa	Selecione se você deseja mostrar ou ocultar as informações da tarefa do plug-in.

Saídas

Saída	Tipo de saída
Sessão de upload de arquivo do Anaplan	String
Contagem de registros de upload de arquivo Anaplan	Inteiro
Tamanho do arquivo de upload do arquivo Anaplan	Inteiro

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral
2	Erro	Propriedades de conexão inválidas, como URI, certificado, nome de usuário ou senha
3	Erro	ID de espaço de trabalho, ID de modelo, ID de visualização, ID de exportação ou ID de arquivo do servidor inválidos
4	Erro	Caminho de arquivo inválido
5	Erro	Erro de execução ao acessar o sistema de arquivos ou a conectividade do Anaplan
6	Erro	Conexão ou configuração inválida com o sistema relacional de origem
10	Advertência	Um ou mais logs foram criados por meio da ação ou do processo de importação do Anaplan

Carregar arquivo com permissões

Para fazer upload de um arquivo padrão para o Anaplan e permitir a configuração de permissões, adicione um comando Upload File with Permissions.

Chamada de API equivalente: https://anaplan.docs.apiary.io/#Upload-files

Propriedades

Propriedade	Detalhes
URL do modelo	Digite o URL do navegador da página inicial do modelo, como, por exemplo, `https://us2a.app.anaplan.com/core10194/anaplan/framework.jsp?selectedWorkspaceId=[workspaceId]&selectedModelId=[modelId]`.
Arquivo de origem	Digite o arquivo de origem a ser carregado, com até 1 MB.
Nome do upload	Digite o nome para carregar o arquivo.
Permissão	Selecione a permissão a ser aplicada ao arquivo.

Saídas

Nenhum

Códigos de saída

Código	Tipo	Detalhes
0	Sucesso	Sucesso
1	Erro	Falha geral

Centro de suporte da Workiva

Baixar arquivo

Propriedades

Saídas

Códigos de saída

Exportar histórico do modelo

Propriedades

Saídas

Códigos de saída

Obter itens de dimensão

Dica: Para recuperar somente itens específicos em uma dimensão, use o comando Get Selected Dimension Items.

Propriedades

Saídas

Códigos de saída

Obter itens de dimensão selecionados

Dica: Para recuperar todos os itens em uma dimensão, use o comando Get Dimension Items.

Propriedades

Saídas

Códigos de saída

Obter metadados de exportação

Propriedades

Saídas

Códigos de saída

Obter metadados de visualização

Propriedades

Saídas

Códigos de saída

Listar ações

Propriedades

Saídas

Códigos de saída

Listar ações de exportação

Propriedades

Saídas

Códigos de saída

Listar arquivos

Propriedades

Saídas

Códigos de saída

Listar ações de importação

Propriedades

Saídas

Códigos de saída

Listar modelos

Observação: Esse comando retorna detalhes sobre cada modelo, inclusive o tamanho atual, a ID, o nome e o estado do arquivo. Você pode usar essa saída com outros comandos Anaplan, por exemplo, para fornecer o ID do modelo.

Propriedades

Saídas

Códigos de saída

Listar módulos

Propriedades

Saídas

Códigos de saída

Listar processos

Propriedades

Saídas

Códigos de saída

Listar visualizações

Propriedades

Saídas

Códigos de saída

Listar espaços de trabalho

Observação: Esse comando retorna detalhes sobre cada espaço de trabalho, inclusive o tamanho atual, o ID, o nome e o estado do arquivo. Você pode usar essa saída com outros comandos do Anaplan, por exemplo, para fornecer o ID do espaço de trabalho.

Propriedades

Saídas

Códigos de saída

Recuperar dados de célula para uma visualização (CSV)

Propriedades

Saídas

Códigos de saída

Recuperar dados de célula para uma visualização (JSON)

Propriedades

Saídas

Códigos de saída

Executar ação de exportação

Propriedades

Saídas

Códigos de saída

Executar ação de exportação com dados

Propriedades