PCF Component: Docx Templates in Canvas Apps

PCF Component: Docx Templates in Canvas Apps

Have you ever wanted to fill in a Docx template within a Canvas App? Look no further! I’m excited to introduce a new PCF component that allows you to do just that. This component leverages the easy-template-x open-source library, making it a breeze to create and structure templates.

Docx Template Sample App

How to Get Started:

  1. Installation: Begin by downloading and importing the managed solution into your environment. Ensure you’ve enabled PCF components for Canvas apps. If you’re unsure how, you can find instructions here.

  2. Usage Instructions: Once you’re in the Power Apps Editor, navigate to Insert -> Custom -> Import Components. From there, select the Code tab and import the RAW! Docx Templates (Canvas). Add the component to the form, and you’re good to go! The component offers various input properties, such as docxTemplate, fillTemplate, and templateData, allowing for a customizable experience.

Explore the Sample Application:

To get a feel for the component, download the sample solution. This includes a Canvas app with a sample Docx and other essential components. You can download the sample app here.

Template Features from easy-template-x:

  • Text Plugin: The most basic plugin that replaces a single tag with custom text while preserving the original text style.

  • Loop Plugin: This plugin allows for iterating text, table rows, and list rows. It also supports simple conditions and nested conditions, providing flexibility in template creation.

  • Image Plugin: Embed images directly into the document with ease.

  • Link Plugin: Insert hyperlinks into the document, preserving their original style.

  • Raw XML Plugin: Add custom XML into the document to be interpreted by Word. This can be especially useful for adding elements like page breaks.

  • Scope Resolution: easy-template-x supports tag data scoping, allowing you to reference “shallow” data from deeper in the hierarchy. This is similar to referencing an outer scope variable from within a function in JavaScript.

  • Extensions: While most document manipulations can be achieved using plugins, easy-template-x also supports extensions for more advanced use cases. For instance, the community-developed easy-template-x-data-binding extension supports updating custom XML files inside Word documents, enabling the automatic filling of Word forms that use content controls.

In conclusion, this new PCF component, combined with the capabilities of easy-template-x, offers a powerful and seamless way to integrate Docx templates within Canvas Apps. Whether you’re looking to create simple text replacements or more complex templates with loops, conditions, and embedded images, this solution has got you covered. Give it a try and let me know your thoughts!

Comments

  1. AnnamalaiDecember 9, 2023 at 7:35 PM

    Hi. This will be very helpful for me. I have done everything step by step. But i am receiving the below error,
    "ERROR: The Docx template filler ran into an error. MESSAGE: Malformed file detected. Make sure the file is a valid docx file."
    I have properly converted the docx file into base64. Am I missing any thing. Please help

    ReplyDelete
    Replies
    1. NononoMarch 12, 2024 at 11:42 AM

      Maybe a bit late answer, but the base64 needs to have a datauri prefix.
      Fore example

      "data:@file/vnd.openxmlformats-officedocument.wordprocessingml.document;base64,[HERE IS THE BASE64]"

      Use https://base64.guru/converter/encode/file and select output format "Data URI"

      Delete

Post a Comment

Popular posts from this blog

Add User As Local Administrator On Domain Controller

I recently was settting up a new Microsoft SharePoint 2010 machine and had promoted the machine to a domain controller before creating my SharePoint admin accounts.  I needed to add several of my accounts to the local Administrators group.  Unfortunately after you promote a server to a domain controller you can no longer access the GUI for Local Users and Groups.  Instead I had to use the command line to add the users. Open a command promt using the "Run as administrator" function and then run the following command. net localgroup Administrators /add {domain}\{user} Note: do not include the {} brackets.
Read more

Calling Dataverse Web API in PowerShell using Client Credentials

Image
Connecting to Dataverse using PowerShell can be very helpful for data migrations and use within Azure DevOps. Connecting to an instance in a non-interactive way can be tricky though. This article will provide you the links you need for creation and App registration and adding the app user to your environment. You can then utilize the script provided to call Web API requests including ones you define using the new Custom API functionality now available. The script was written so that it is not dependent on any outside libraries such as the Microsoft.Xrm.Tooling connector. This is helpful in situation where involving an outside library will slow down your deployment time by having to be approved in a change control board. If utilizing an outside code library is not a concern you can create a connection to Dataverse utilizing the Microsoft.Xrm.Tooling connector Get-CrmConnection cmdlet. Create App Registration The first thing to do is create an App Registration within Azure AD for
Read more

Windows Server 2008R2 VMs Shut Down After 1 to 2 Hours

Image
When created a lab environment to test ADFS 2.0 I utilized the Windows 2008R2 VM baselines distributed by Microsoft.  After a few days I was told that I had to activate.  The VMs included a 180 day license for use but I didn't feel like adding another network adapter into Hyper-V to connect them to the internet.  I started having issues though where the servers would shut down every hour or so.  I though that maybe there was a memory issue and Hyper-V was shutting them down in order to free up RAM.  Turns out that if Server 2008R2 is not activated it automatically shuts down after a period of time.  After connecting the server to the internet and activating them the problem went away. Finally the madness of the unknown shut downs has ended :)
Read more