---
title: "Create an entity print template"
slug: "create-an-entity-print-template"
abstract: "How to use the print templates functionality to create a PDF based on entity properties and relations."
---
# Create an entity print template

You can use the print templates functionality to create a PDF based on entity properties and relations, for example a [PDF report of annotations made on an asset](https://doc.sitecore.com/ch/en/developers/cloud-dev/create-a-shared-script-using-visual-studio-code.html "Create a shared script using Visual Studio Code").

> [!note]
> **Before you begin**
> -   [Initialize your working folder](https://doc.sitecore.com/ch/en/developers/api-reference/cli--sitecore.ch.cli.plugin.content.commands.print.initializecommand.html)

After your working folder has been initialized, it contains the following files:

```shell
[working folder]
├── template.json
├── template.cshtml
├── template.css
├── template.csproj
├── lib
│  ├── RazorLight.dll
│  └── Stylelabs.M.Print.dll

```

This walkthrough describes how to:

- [Validate your entity print template](https://doc.sitecore.com/ch/en/developers/cloud-dev/create-an-entity-print-template.html#UUID-a2d55f8a-b018-ba08-2e78-e425e5a231ea_N1715855074629 "Validate your entity print template")
- [Push your entity print template](https://doc.sitecore.com/ch/en/developers/cloud-dev/create-an-entity-print-template.html#UUID-a2d55f8a-b018-ba08-2e78-e425e5a231ea_N1715855091317 "Push your entity print template")
- [Generate your entity print template](https://doc.sitecore.com/ch/en/developers/cloud-dev/create-an-entity-print-template.html#UUID-a2d55f8a-b018-ba08-2e78-e425e5a231ea_N1715855105389 "Generate your entity print template")

## Validate your entity print template

The `validate` command validates the formatting of the JSON file, the properties and relations described in the JSON file against the entity definition, and the variables used in the razor files.

You can run `validate` at any time, to be certain there are not errors in your print template.

To validate the entity print template, run the following command:

```shell
ch-cli print validate -d <ENTITY_DEFINITION_NAME> -f <YOUR_FOLDER_PATH>

```

Alternatively, do the following:

1. In the **Terminal** menu, click **Run Build Task**.
2. Select the **Validate Entity Print Template** task.

    ![CLI Print Template validate template task](https://doc.sitecore.com/api/markdown-image/ch/en/developers/cloud-dev/images/cli_print_template_validate_template_taskpng.png)

3. Enter the name of the entity definition.

    ![CLI Print Template entity definition task argument](https://doc.sitecore.com/api/markdown-image/ch/en/developers/cloud-dev/images/cli_print_template_entity_definition_task_argumentpng.png)

Validation errors are shown in the **Problems** and **Terminal** views:

![CLI Print Template problems view](https://doc.sitecore.com/api/markdown-image/ch/en/developers/cloud-dev/images/cli_print_template_problems_viewpng.png)

![CLI Print Template terminal view](https://doc.sitecore.com/api/markdown-image/ch/en/developers/cloud-dev/images/cli_print_template_terminal_viewpng.png)

## Push your entity print template

After you have validated your template, you can push it from your working directory to the connected Content Hub instance.

> [!note]
> The `push` command runs the `validate` command before uploading the entity print template to the connected Content Hub instance.

To push your entity print template, run the following command:

```shellscript
ch-cli print push -n <ENTITY_PRINT_TEMPLATE_NAME> -d <ENTITY_DEFINITION_NAME> -f <YOUR_FOLDER_PATH>

```

Alternatively, do the following:

1. In the **Terminal** menu, click **Run Task**.
2. Select the **Push Entity Print Template** task.

    ![CLI Print Template push template task](https://doc.sitecore.com/api/markdown-image/ch/en/developers/cloud-dev/images/cli_print_template_push_template_taskpng.png)

3. Enter the name of the entity definition.

    ![CLI Print Template entity definition task argument](https://doc.sitecore.com/api/markdown-image/ch/en/developers/cloud-dev/images/cli_print_template_entity_definition_task_argumentpng.png)

4. Enter the name of the entity print template.

    ![CLI Print Template template name task argument](https://doc.sitecore.com/api/markdown-image/ch/en/developers/cloud-dev/images/cli_print_template_template_name_task_argumentpng.png)

## Generate your entity print template

To review the final PDF file, run the following command:

```shell
ch-cli print generate -n <ENTITY_PRINT_TEMPLATE_NAME> -i <ENTITY_ID> -c <CULTURE>

```

Alternatively, do the following:

1. In the **Terminal** menu, click **Run Task**.
2. Select the **Push Entity Print Template** task.

    ![CLI Print Template generate template task](https://doc.sitecore.com/api/markdown-image/ch/en/developers/cloud-dev/images/cli_print_template_generate_template_taskpng.png)

3. Enter the name of the entity print template.

    ![CLI Print Template template name task argument](https://doc.sitecore.com/api/markdown-image/ch/en/developers/cloud-dev/images/cli_print_template_template_name_task_argumentpng.png)

4. Enter the ID of the entity.

    ![CLI Print Template entity id task argument](https://doc.sitecore.com/api/markdown-image/ch/en/developers/cloud-dev/images/cli_print_template_entity_id_task_argumentpng.png)

5. Enter the culture.

    ![CLI Print Template culture task argument](https://doc.sitecore.com/api/markdown-image/ch/en/developers/cloud-dev/images/cli_print_template_culture_task_argumentpng.png)

From your browser, you can now open the downloaded PDF file.