Introdução
O modelo Data Dictionary Chain permite que os usuários capturem e exportem para uma planilha detalhes de alto nível sobre tabelas específicas do espaço de trabalho. Os usuários podem especificar uma palavra-chave para localizar tabelas, definir o nome da planilha de exportação e criar uma tabela no espaço de trabalho para armazenar o esquema de cada tabela.
Para obter mais detalhes, consulte a documentação sobre o processo Load Data to Wdata para obter uma visão geral abrangente. Recomenda-se que você leia esta documentação antes de usar o modelo do Data Dictionary .
Pré-requisitos
Esse modelo pressupõe que os objetos a seguir já estejam configurados no aplicativo Workiva:
- Concessão da API
- Para aproveitar as APIs da Workiva, o usuário deve estabelecer uma concessão de API OAuth em seu espaço de trabalho. Consulte este artigo para conhecer as principais práticas para gerenciar a concessão do OAuth.
- Os seguintes conectores devem ser ativados e configurados em seu espaço de trabalho:
Observação: Alguns valores de variáveis podem conter informações confidenciais, como nomes de usuário e senhas. Recomendamos que você use a opção "Encrypt" (Criptografar) para variáveis sensíveis a informações e defina as permissões apropriadas para sua planilha.
- Configurar variáveis
Observação: É recomendável que você defina o valor padrão dessa variável como 50 (representando 50 MB), embora esse valor possa ser ajustado, se necessário.
-
- Além disso, quatro outras variáveis de espaço de trabalho devem ser criadas antes de você usar a cadeia do Data Dictionary.
A seguir, você encontrará um detalhamento de cada variável que precisa ser configurada e preenchida:
Crie sua cadeia
O modelo Data Dictionary | ALL | Primary Chain está localizado na seção Workiva Chains da tela Templates.
Veja como encontrá-lo:
- Em Construtor de Cadeia, vá para a guia Modelos .
- Selecione Cadeias Workiva no menu na parte superior
- Procure por Data Dictionary | ALL | Primary Chain Template no canto superior direito e abra o modelo
Quando a cadeia Data Dictionary | ALL | Primary for implementada em um espaço de trabalho, ela implementará automaticamente seis subcadeias adicionais.
Os usuários devem garantir que todas as sete cadeias tenham sido implementadas e publicadas no mesmo espaço de trabalho:
- Dicionário de dados | TODOS | Primário
- Data Dictionary | Criar documento e subseções | Criação de planilha
- Dicionário de dados | Criar documento e subseções | Criação de planilha
- Dicionário de dados | Criar tabela
- Carregar dados para Wdata | Cadeia primária
- Carregar dados para Wdata | Substituir conjunto de dados
- Carregar dados no Wdata | Adicionar novo conjunto de dados
Depois de localizar o seu modelo, configure-o para o seu espaço de trabalho usando as variáveis criadas na seção acima.
Observação: Para obter instruções detalhadas sobre como criar uma cadeia a partir de um modelo, consulte o artigo Criar e gerenciar cadeias.
Entradas de tempo de execução
Ao executar essa cadeia primária (Data Dictionary | ALL | Primary), as seguintes entradas de tempo de execução precisarão ser preenchidas ou passadas por uma cadeia de chamada:
| Entrada de tempo de execução | Descrição | Tipo de campo | Necessário? |
|---|---|---|---|
| SpreadsheetName | Especifica o nome da planilha em que o esquema de tabela será gravado. | Texto | Sim |
| Valor de pesquisa | Essa entrada é usada para localizar tabelas que contêm a palavra-chave especificada. | Texto | Sim |
| Nome da tabela Wdata | Especifica o nome da tabela do dicionário de dados criada na execução inicial do modelo. | Texto | Sim |
Tabela Wdata
Para utilizar essa cadeia, você deve ter uma tabela Wdata do Data Dictionary no espaço de trabalho. A cadeia criará automaticamente essa tabela, usando a convenção de nomenclatura "Tabela de dicionário de dados", a menos que um usuário especifique um nome de tabela diferente.
O esquema de tabela a seguir será usado para criar a tabela do dicionário de dados:
| Nome da coluna | Descrição da coluna | ID da coluna | Tipo de coluna |
|---|---|---|---|
| Nome_da_tabela | N/A | nome_da_tabela | texto |
| Alias | N/A | Alias | texto |
| Modo | N/A | Modo | texto |
| Nome | N/A | name | texto |
| Tipo | N/A | tipo | texto |
Isenção de responsabilidade de ajustes personalizados: Se os usuários tiverem problemas com cabeçalhos de coluna não correspondentes ao importar seus dados para uma tabela Wdata, eles podem aproveitar a preparação de dados ou outros comandos para corrigir isso. No entanto, se um usuário adicionar ajustes personalizados a esse modelo, recomenda-se que ele faça uma cópia antes de fazê-lo. Qualquer alteração no modelo impedirá sua reutilização. Isso também se aplica se você aplicar uma configuração de tag ao modelo.
Solução de problemas
As etapas a seguir podem ser usadas para solucionar problemas com o modelo de cadeia:
Erros de execução de cadeia
- Verifique se todas as cadeias estão publicadas.
- Verifique se as credenciais do OAuth2 (
wsv-Client IDewsv-Client Secret) são válidas e estão atualizadas. - Verifique as permissões de espaço de trabalho do usuário que está executando a cadeia.
Erros de importação de dados
- Confirme se os cabeçalhos de coluna em seu arquivo de origem correspondem ao esquema da tabela Wdata.
- Para operações de substituição de conjunto de dados, certifique-se de que os nomes de arquivo correspondam aos conjuntos de dados existentes na tabela.
- Para operações de Adicionar novo conjunto de dados, certifique-se de que os nomes de arquivo sejam exclusivos dentro da tabela.
Criação de tabelas ou planilhas duplicadas
- Use nomes consistentes para
Wdata Table NameeSpreadsheetNameem todas as execuções.
Tela do monitor
- Os usuários podem diagnosticar a causa de um erro navegando até a tela do monitor.
- A variável DCV_Chain Result captura o status da cadeia com base no resultado final. Se ocorrer um erro, o motivo da falha será aplicado ao texto de saída da cadeia na tela do monitor.
Os usuários também podem usar a tela do monitor para determinar se o arquivo foi importado com sucesso
Práticas recomendadas
-
Evite personalizar o modelo original:
Crie uma cópia se você precisar de ajustes. Alterações no modelo podem prejudicar a reutilização. -
Marcação para contexto aprimorado:
Adicione entradas de tempo de execução (Tag-KeyeTag-Value) para marcar conjuntos de dados, se necessário. Atualize os nós da cadeia para passar essas entradas. -
Gerenciamento de tamanho de arquivo:
Monitore o tamanho do conjunto de dados usando a variávelwsv-WdataLoadWarningThreshold. Considere a possibilidade de dividir conjuntos de dados grandes se forem acionados avisos.