IncludeModel

Última atualização: 2026-11-03

A instrução IncludeModel carrega um produto de dados e seu modelo semântico, incluindo tabelas, relacionamentos, medidas e dimensões. Medidas e dimensões do modelo semântico aparecem automaticamente como itens mestres no aplicativo.

IncludeModel data_product_name [InEnvironment environment_name] [FromSpace data_product_space | FromCurrentSpace | FromPersonalSpace] [WithTables Table table_name1 Fields fieldlist Connection dataset_connection {, Table table_nameN Fields fieldlist Connection dataset_connection,... }] [WithMeasures measurelist] [WithDimensions dimensionlist]

Argumentos e palavras-chave
Argumento ou palavra-chave	Descrição
data_product_name	O nome do produto de dados a ser carregado.
FromSpace, FromCurrentSpace, or FromPersonalSpace	Palavras-chave que especificam o espaço a partir do qual carregar o produto de dados. Use um dos seguintes conforme necessário. Se todas essas opções de palavras-chave forem omitidas, a instrução IncludeModel procura o produto de dados em seu espaço pessoal. FromSpace: Carregue o produto de dados localizado no espaço especificado com data_product_space. FromCurrentSpace: Carregar o produto de dados localizado no espaço atual. FromPersonalSpace: Carregue o produto de dados localizado no seu espaço pessoal.
data_product_space	Especifica o espaço do produto de dados que você deseja carregar, se você estiver usando FromSpace para especificar explicitamente um determinado espaço do qual carregar. Isso não se aplica se você estiver usando FromPersonalSpace ou FromCurrentSpace. Siga as convenções de uso de aspas documentadas em Usando aspas no script. Exemplos: MyAnalyticsSpace "My Analytics Space" [My Analytics Space]
InEnvironment	Palavra-chave que especifica o uso do produto de dados no ambiente especificado com environment_name. Não é obrigatório se o produto de dados não estiver localizado em um ambiente.
environment_name	O nome do ambiente, se aplicável, que contém o produto de dados que você deseja carregar. Siga as convenções de uso de aspas documentadas em Usando aspas no script. Exemplos: Production [Production Environment] "Production Environment"
WithTables	Palavra-chave que especifica o uso das tabelas definidas em instruções Table subsequentes.
Table	Palavra-chave que especifica o uso de uma tabela. Carrega uma tabela por instrução Table.
table_name	Especifica o nome da tabela a ser usada no modelo de dados. Siga as convenções de uso de aspas documentadas em Usando aspas no script. Exemplos: MyDataTable [My Data Table] "My Data Table"
Fields	Palavra-chave que instrui a usar os campos especificados (fieldlist) da tabela para integrar ao modelo de dados.
fieldlist	Lista de campos da tabela referenciada na instrução Table anterior. Você pode usar * para utilizar todos os campos da tabela ou fornecer uma lista de campos específicos separados por vírgula. Exemplos: Amount, Quantity, Region [Amount], [Quantity], [Region]
Connection	Palavra-chave que especifica o uso do conjunto de dados especificado em dataset_connection.
dataset_connection	Uma conexão que pode carregar o conjunto de dados que contém a tabela referenciada. Dependendo da localização da conexão, use um dos seguintes formatos: environment:space:connection — Usado para arquivos localizados dentro de ambientes (contêineres para dados sincronizados entre Qlik Cloud e Qlik Talend Cloud). Os ambientes são associados a espaços (particularmente, espaços de dados). Para obter mais informações sobre ambientes, consulte Sincronizando e gerenciando ambientes. space:connection — Usado para conexões com um espaço como o contêiner de armazenamento de nível superior ou no mesmo ambiente que o aplicativo de carregamento. Podem ser conexões localizadas em espaços compartilhados, gerenciados ou de dados. Por exemplo, para um conjunto de dados armazenado localmente dentro de Qlik Cloud (conexão DataFiles), localizado em um espaço chamado Sales Analysis, você usaria o seguinte: Sales Analysis:DataFiles connection — Apenas o nome da conexão. Isso se refere a conexões localizadas no seu espaço pessoal. Neste caso, a conexão seria simplesmente: DataFiles Exemplos: [CustomerOrders:DataFiles] [SalesData2026:SnowflakeSales]
WithMeasures	Palavra-chave que instrui a converter as medidas especificadas do produto de dados (measurelist) em medidas mestre.
measurelist	Lista de medidas do modelo semântico do produto de dados a serem convertidas em medidas mestre. Você pode usar * para converter todas as medidas ou fornecer uma lista separada por vírgulas de medidas específicas. Exemplo: [Sales], [Total Quantity], [Cost]
WithDimensions	Palavra-chave que instrui a converter as dimensões especificadas do produto de dados (dimensionlist) em dimensões mestre.
dimensionlist	Lista de dimensões do modelo semântico do produto de dados a serem convertidas em dimensões mestre. Você pode usar * para converter todas as dimensões ou fornecer uma lista separada por vírgulas de dimensões específicas. Exemplo: [Product Name], [Region], [Customer]

comentários

A instrução IncludeModel geralmente é gerada automaticamente pelo catálogo de dados quando você escolhe carregar um produto de dados com seu modelo semântico. Você também pode escrever a instrução manualmente ou editar a instrução gerada para personalizar quais campos, medidas e dimensões são incluídos.

Os relacionamentos definidos no modelo semântico são aplicados automaticamente às tabelas carregadas, criando associações no seu modelo de dados.

As operações para medidas e dimensões são aplicadas ao final da carga de dados, depois que as tabelas e os campos são carregados. Se o carregamento falhar antes dessa fase, nenhuma operação de medida ou dimensão é aplicada.

Você deve ter a permissão Pode consumir dados ou Pode visualizar no espaço que contém o produto de dados para usar a instrução IncludeModel.

Propriedades de itens mestre

A maioria dos atributos de itens mestres herdados de modelos semânticos é somente leitura no aplicativo consumidor. Alguns outros atributos de item mestre, como aqueles relacionados a visualizações, ainda podem ser editados dentro do aplicativo.

O comportamento de somente leitura se aplica apenas à interface do usuário—você pode definir várias propriedades do item mestre via API:

Propriedades que são configuráveis no modelo semântico, mas somente leitura na interface do usuário do aplicativo consumidor. Isso inclui título, descrição e tags.
Propriedades que não estão configuradas no modelo semântico e não estão expostas na interface do usuário do aplicativo consumidor.

As alterações nas propriedades definidas pelo modelo semântico serão sobrescritas quando o aplicativo for recarregado.

Exclusão de item mestre

Em um aplicativo não publicado, você pode excluir um item mestre herdado, mas ele reaparece na próxima recarga se ainda estiver referenciado no script IncludeModel. Para removê-lo permanentemente, remova-o do script primeiro. Você também pode duplicar um item mestre herdado. O item obtido ao duplicar é um item mestre comum do aplicativo e é totalmente editável.

Exemplo 1 – Carregar tabelas específicas, juntamente com todas as medidas e dimensões

Este exemplo carrega tabelas específicas, e seus relacionamentos, do produto de dados e de seu modelo semântico. Ele também usa caracteres curinga (*) para carregar todos os campos das tabelas específicas, e que todas as medidas e dimensões no modelo semântico devem ser definidas como itens mestre no aplicativo.

IncludeModel [Sales Performance Data] FromSpace [Sales Analysis Space]
WithTables
    Table [Transactions] Fields * Connection [Sales Analysis Space:DataFiles],
    Table [Products] Fields * Connection [Sales Analysis Space:DataFiles]
WithMeasures *
WithDimensions *;

Os componentes desta instrução IncludeModel são:

Nome do produto de dados: Sales Performance Data
Espaço de produto de dados: Sales Analysis Space
Tabelas: Transactions e Products
Campos: todos
Medidas e dimensões: todas

As duas tabelas são carregadas com seus relacionamentos. Todas as medidas e dimensões no modelo semântico aparecerão como itens mestres no aplicativo.

Exemplo 2 – Carregar tabelas, medidas e dimensões específicas

Este exemplo carrega tabelas específicas, e seus relacionamentos, do produto de dados e de seu modelo semântico. Ele usa caracteres curinga (*) para carregar todos os campos das tabelas específicas. Medidas e dimensões específicas são definidas como itens mestre, em vez de definir automaticamente todas as medidas e dimensões como itens mestre.

IncludeModel [Customer Analytics] FromSpace [sales]
WithTables 
    Table [Customers] Fields * Connection [sales:DataFiles],
    Table [Orders] Fields * Connection [sales:DataFiles]
WithMeasures [Total Revenue], [Customer Count]
WithDimensions [Customer Name];

Os componentes desta instrução IncludeModel são:

Nome do produto de dados: Customer Analytics
Espaço de produto de dados: sales
Tabelas: Customers e Orders
Campos: todos
Medidas: Total Revenue e Customer Count
Dimensões: Customer Name

As duas tabelas são carregadas com seus relacionamentos. Cada uma das medidas e dimensões específicas do modelo semântico aparecerá como item mestre no aplicativo.

Exemplo 3 – Carregar tabelas específicas, juntamente com todas as medidas e dimensões (dataset localizado no ambiente)

Este exemplo carrega tabelas específicas e seus relacionamentos de modelo semântico de um produto de dados localizado em um espaço de dados contido em um ambiente (consulte Sincronizando e gerenciando ambientes). Ele também usa caracteres curinga (*) para carregar todos os campos das tabelas específicas, e que todas as medidas e dimensões no modelo semântico devem ser definidas como itens mestre no aplicativo.

IncludeModel [Sales Performance Data]
    InEnvironment 'Production'
    FromSpace [Sales Analysis Space]
WithTables
    Table [Transactions] Fields * Connection [Sales Analysis Space:DataFiles],
    Table [Products] Fields * Connection [Sales Analysis Space:DataFiles]
WithMeasures *
WithDimensions *;

Os componentes desta instrução IncludeModel são:

Nome do produto de dados: Sales Performance Data
Ambiente do produto de dados: Production
Espaço de produto de dados: Sales Analysis Space
Tabelas: Transactions e Products
Campos: todos
Medidas e dimensões: todas

As duas tabelas são carregadas com seus relacionamentos. Todas as medidas e dimensões no modelo semântico aparecerão como itens mestres no aplicativo.

IncludeModel limitações de script

A sintaxe de curinga WithTables: * não é suportada. Você deve listar as tabelas explicitamente.

Modelos semânticos em produtos de dados

Consumir produtos de dados em aplicativos

Catálogo de dados

Esta página ajudou?

Se você encontrar algum problema com esta página ou seu conteúdo – um erro de digitação, uma etapa ausente ou um erro técnico – avise-nos!

Deixe seu feedback aqui