O modelo Initiate Document Export permite que você exporte documentos da Workiva no formato HTTP, que pode ser convertido em um arquivo PDF ou DOCX. Esse recurso é normalmente usado para fazer backup de documentos, permitir a edição off-line ou compartilhar documentos da Workiva com usuários fora do espaço de trabalho.
Requisitos
- Você deve ter acesso ao ID do cliente e ao segredo do cliente por meio de sua concessão OAuth2.
- Os seguintes conectores devem ser configurados em seu espaço de trabalho:
Crie seu modelo
O modelo Initiate Document Export 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.
- Pesquise Initiate Document Export no canto superior direito e abra o modelo.
Depois de localizar seu modelo, configure-o para seu espaço de trabalho usando as variáveis e entradas de tempo de execução listadas abaixo.
Observação: Para obter instruções detalhadas sobre como criar uma cadeia a partir de um modelo, consulte o artigo Criar e gerenciar cadeias.
Variáveis
| Tipo de variável | Nome da variável | Descrição | Necessário? |
| Cadeia dinâmica | dcv-exportStatus | Usado para capturar o status de exportação do documento. | Sim |
| Cadeia dinâmica | dcv-resourceURL | O nome do documento ou o valor do ID. | Sim |
| Espaço de trabalho | wsv-ClientID | ID gerado a partir da concessão do OAuth2 para seu conector Workiva. | Sim |
| Espaço de trabalho | wsv-Secreto | Token secreto gerado a partir da concessão do OAuth2 para seu conector Workiva. | Sim |
| Espaço de trabalho | wsv-IAMURL | O URL de substituição de host do IAM. | Sim |
| Espaço de trabalho | wsv-PlatformURL | O URL de substituição do host da API da plataforma. | Sim |
Considerações
| Entrada em tempo de execução | Descrição | Opções | Necessário? |
| ExportFormat | Indica o formato da exportação. | .pdf ou .docx | Sim |
| ExportID | O ID do documento. | Sim | |
| ExportFileName | Pode ser usado ao fazer upload ou enviar um e-mail para substituir o nome padrão do arquivo. | Não | |
| Seções | Os IDs das seções dentro do documento a ser exportado. Pode ser deixado em branco se você estiver exportando o documento inteiro. | Não | |
| Docx - Opções de exportação | Ao exportar para .docx, isso fornece especificações sobre o objeto exportado. |
|
Não |
| Opções de exportação de PDF | Ao exportar para PDF, isso fornece especificações sobre o objeto exportado. |
|
Não |
Observação: Se os campos opcionais forem deixados em branco, o objeto inteiro será exportado sem nenhuma especificação aplicada.
Configuração da notificação de entrega de e-mail
Para receber o arquivo exportado, você deve configurar adicionalmente o comando Get (Final Resource) com uma notificação por e-mail:
- Durante a edição da cadeia Initiate Document Export, selecione o comando Get (Final Resource) e clique no lápis de criação Edit
- Clique no ícone do envelope para abrir a tela Notificações.
- Clique no botão + Nova notificação.
- Abra o menu suspenso "Condition" (Condição) e selecione Sucesso.
- Abra o menu suspenso "Recipients" (Destinatários) e selecione o e-mail de todos os usuários que devem receber o objeto exportado.
- Abra o menu "Attachments" (Anexos) e selecione a saída do arquivo do comando Get (Final Resource).
Esse processo enviará ao destinatário do e-mail um arquivo HTTP. O destinatário deve então renomear manualmente a extensão do arquivo para o formato desejado:
- File_name.txt. => file_name.pdf
- File_name.txt => file_name.docx
Solução de problemas
Se sua cadeia acionou um erro ou não conseguiu atualizar os dados corretos, verifique se o seguinte é verdadeiro:
-
Todas as variáveis do espaço de trabalho estão corretas. Se estiver usando um espaço de trabalho de área restrita, use a versão de área restrita dos URLs de IAM/Plataforma.
-
Você incluiu todas as entradas de tempo de execução necessárias, como a apresentação e o ID de exportação.
-
Você configurou uma definição de notificação por e-mail para o comando Get (Final Result).