Os campos personalizados são campos exclusivos criados pela sua empresa e adicionados a documentos, planilhas ou apresentações existentes. Esses campos adequados à finalidade são totalmente personalizados para seu espaço de trabalho, mas coletam e armazenam dados da mesma forma que um campo nativo da Workiva. Essa funcionalidade adicional permite que você crie relatórios personalizados e soluções automatizadas não disponíveis de outra forma.
Requisitos
- A função Custom Field Admin é necessária para modificar grupos e definições de campos personalizados. Isso também se aplica aos usuários da API.
- As permissões Owner ou Editor são necessárias para gerenciar os valores de campo personalizado de um arquivo.
- As permissões de proprietário são necessárias para gerenciar o grupo de campos personalizados de um arquivo.
- Você deve ter acesso View a um determinado arquivo ou seção para poder consultá-lo.
Criar campos personalizados
Qualquer usuário com a função Custom Field Admin pode criar e gerenciar campos personalizados na tela Workspace Settings (Configurações do espaço de trabalho). Ao atribuir esses campos a grupos de campos, eles podem ser aplicados a todos os documentos, planilhas ou apresentações do seu espaço de trabalho ou apenas a um subconjunto específico dos seus arquivos. Saiba mais sobre grupos de campos personalizados.
Para criar um campo personalizado:
- No canto superior direito, clique no nome do espaço de trabalho e selecione Settings para abrir as configurações do espaço de trabalho.
- Selecione Custom Fields na barra de navegação na parte superior da tela.
- Clique no botão Create > Create custom field (Criar campo personalizado).
-
Digite os detalhes de seu novo campo personalizado.
Nome do campo O nome do campo ou "título", como será exibido na Workiva. ID do campo O identificador exclusivo do campo; usado principalmente de forma programática, em consultas ou via API.
Caracteres suportados:
- Cartas
- Números
- Períodos
- Pontos sublinhados
- Hífens
Observação: Quando um campo é ativado pela primeira vez, o ID não pode ser alterado.
Tipo de campo O formato de dados para esse campo.
Opções:
- Texto/String
- Lista
- Inteiro (um número inteiro; por exemplo, 1 ou -1)
- Número (qualquer valor numérico; por exemplo, 1,1 ou -1,1)
- Booleano (Verdadeiro ou Falso)
- Data (AAAA-MM-DD)
- Usuário (ID de usuário da Workiva)
Ordem de classificação A ordem em que esse campo aparecerá no painel Campos personalizados de seu objeto. Começa a partir de 0.
Observação: Se deixados em branco, os campos são classificados alfanumericamente por ID de campo.
Descrição Uma breve descrição da finalidade do campo personalizado. Isso só é mostrado na tela Custom Fields (Campos personalizados) em Workspace Settings (Configurações do espaço de trabalho). Grupos de campo Determina onde esse campo aparece e a quais objetos da Workiva ele se aplica.
Por exemplo, um campo aplicado ao grupo padrão Todos os documentos aparecerá com todos os documentos em seu espaço de trabalho, enquanto um campo aplicado ao seu próprio grupo de campos personalizados aparecerá somente no conjunto específico de documentos que se enquadram nesse grupo.
- Clique em Salvar.
Como posso usar campos personalizados?
Os campos personalizados ampliam os recursos dos objetos existentes da Workiva e adaptam melhor o software às necessidades de sua empresa. Por exemplo, você pode usar campos personalizados para:
- Acompanhe as aprovações adicionando um campo de "parte responsável" às seções do documento.
- Simplifique seu processo de roll forward criando um campo de "período de relatório".
- Organize as planilhas por local com a adição de um campo "Region" (Região).
Essas são apenas sugestões; os usos exatos variam de empresa para empresa e podem ser coordenados com a ajuda de seu gerente de conta.
Escolha de um grupo de campos
Os grupos de campos são usados para classificar, organizar e estruturar os campos personalizados em seu espaço de trabalho. Se um campo personalizado for amplamente aplicado a todos os objetos do seu espaço de trabalho, certifique-se de escolher o grupo de campos padrão para o item com o qual está trabalhando.
Por exemplo, você escolheria o grupo "All Documents" se quisesse que um campo aparecesse em todos os documentos do seu espaço de trabalho. Caso contrário, você será forçado a aplicar manualmente um grupo de campos a cada arquivo em seu espaço de trabalho.
Usar campos personalizados
Depois de criados, os campos personalizados podem ser acessados por qualquer pessoa com a permissão para esse objeto. Os usuários com permissão Viewer só podem ver os campos personalizados, enquanto os Owners e Editors podem interagir com eles.
- Na tela Arquivos , selecione um documento, apresentação ou planilha.
- Selecione o ícone Custom Fields no painel à direita.
- Alterne entre os tipos de objetos (como um Documento ou Seção) usando as guias na parte superior.
- Expanda o grupo de campos específico que você gostaria de usar.
- Localize o campo desejado e preencha-o adequadamente.
Ativar e desativar campos personalizados
Depois de criados, os novos campos personalizados são colocados em um estado de "Rascunho". Esses campos personalizados devem ser ativados para que apareçam em seus documentos, planilhas e apresentações. Você pode desativá-los posteriormente se não forem mais necessários.
Observação: Depois que um campo personalizado for ativado pela primeira vez, você não poderá alterar o ID do campo nem excluí-lo.
- No canto superior direito, clique no nome do espaço de trabalho e selecione Settings para abrir as configurações do espaço de trabalho.
- Selecione Custom Fields na barra de navegação na parte superior da tela.
- Selecione o menu de três pontosno lado direito e selecione Activate ou Deactivate.
Se um campo desativado for reativado posteriormente, ele será restaurado instantaneamente em todos os locais anteriores.
Compreensão dos campos ativos e inativos
Os campos personalizados ativos do estarão disponíveis no painel Custom Fields (Campos personalizados) do seu documento, planilha ou apresentação.
Neste exemplo, você notará que o campo personalizado "Preparer Sign Off" está visível:
Os campos personalizados desativados são marcados como Inactive na tela de administração de campos personalizados e não aparecerão em seus documentos, planilhas ou apresentações.
Neste exemplo, você notará que o campo personalizado "Preparer Sign Off" foi removido:
Observação: Se reativados posteriormente, os campos personalizados serão restaurados automaticamente.
Copiar, importar e exportar valores de campos personalizados
Para facilitar o processo de transferência, os valores dos campos personalizados podem ser incluídos opcionalmente quando você copia um arquivo ou pasta copiar um arquivo ou pasta. Basta marcar a caixa Custom field values para incluir todos os valores atuais em sua ação de cópia, ou desmarcar a caixa para redefinir todos os valores. Isso permite que você mantenha os valores atuais ao copiar arquivos ou redefina-os completamente.
Observação: Os campos personalizados e seus valores também podem ser importados e exportados entre espaços de trabalho.
Saiba mais sobre a cópia de arquivos e pastas.
Observação: Essa opção só aparece se os campos personalizados tiverem sido ativados em seu espaço de trabalho.
Consultar dados de campos personalizados
Se o Wdata estiver ativado em seu espaço de trabalho, você poderá adicionar dados de campos personalizados às consultas usando os tipos de fonte Common Object Model (COM) e Memberships. Essas fontes de dados permitem que você consulte e agregue os dados do seu campo personalizado.
Para obter mais informações sobre como criar consultas, consulte nosso artigo gerenciar as fontes de uma consulta.
Nota: Os dados de associação só estão disponíveis em espaços de trabalho com campos personalizados, interfaces, links inteligentesou explorador de sustentabilidade ativados. Entre em contato com seu Gerente de Sucesso do Cliente (CSM) se tiver interesse em adicionar uma dessas soluções.
A fonte de dados COM inclui a maioria dos valores de campos personalizados armazenados em seu espaço de trabalho. Ele pode ser usado para identificar os arquivos e as seções do Workiva, unir-se a outras fontes de dados para ampliar a visualização ou criar cálculos em suas consultas.
- Ao criar uma consulta, selecione Admin > COM.
-
Escolha um tipo de campo e clique em Add. Isso fará com que todos os IDs de campo ativos para esse recurso fiquem disponíveis para a sua consulta.
Nota: A fonte de dados COM apresentará todos os campos personalizados em seus espaços de trabalho, independentemente do status deles.
As associações são usadas especificamente para o tipo de dados User. Cada usuário é armazenado como um ID de usuário na Workiva. Assim, você pode unir essa fonte de dados às suas consultas COM para alterar as IDs de usuário com informações como nome ou e-mail.
- Ao criar uma consulta, selecione Admin > Memberships.
- Escolha uma coluna e clique em Add. Isso fará com que todas as associações desse recurso fiquem disponíveis para sua consulta.
Dicas e práticas recomendadas
A seção a seguir é uma coleção de dicas e práticas recomendadas para gerenciar os campos personalizados em seu site. Embora não sejam obrigatórias, essas recomendações podem ajudá-lo a evitar alguns dos erros comuns que vemos ao adotar campos personalizados.
O ID do campo é o identificador definitivo dos campos personalizados. Enquanto os nomes de campo podem ser repetidos, cada ID de campo é único e imutável. Por esse motivo, sugerimos o uso de uma convenção de nomenclatura padrão que inclua o processo, o nome do projeto ou a versão da qual cada campo faz parte.
Na Workiva, por exemplo, usamos [process_name.fieldName.version].
Se um campo personalizado for adicionado a vários grupos, ele poderá aparecer várias vezes no mesmo registro. No entanto, esse campo só pode conter um único valor, o que significa que qualquer alteração feita em um grupo também atualizará esse campo em todos os outros grupos.
Por exemplo, o campo abaixo é atribuído aos grupos FY23 e Todos os documentos.
Ao visualizar um documento individual, esse campo personalizado agora aparecerá em ambos os grupos.
Como um único campo não pode conter dois valores diferentes, a atualização desse campo no grupo Todos os documentos atualizará simultaneamente o mesmo campo no grupo FY23.