Zesty Instance Installer

Definition

Instance module is a set of predefined schema or model built with styles in which users can import or add to their own project instance.

Instance template is a base template with a predefined theme in which users can use as a starting base when creating a new project instance.

📘

Note: In order to use the instance installer, user must have an authenticated session, or developer access token in Zesty.

Exporting Template

This function is used to create a zip file that contains the resources from your instance including css, js, settings, style variable, models, contents and views.

Steps on how to export an Instance template:

1. Access the templating.api.zesty.io
   Input your session or developer token in the token field.
   Select the Export Template. In the Instance ZUID field, input the Instance ZUID of the instance you want to export.

2. Click Export. This will generate a zip file containing the instance resources. Export duration may vary depending on the size of the instance.

Note: The exported zip only includes the published contents and codes.

Exporting Module

This function is used to create a zip file that contains the resources of a specific model from the instance.

Steps on how to export an Instance module:

1. Access the templating.api.zesty.io
   Input your session or developer token in the token field.
   Select Export Module and input the fields needed for exporting.

• Instance ZUID (required) - The target instance zuid.
• Model ZUID (required) - The model zuid that you want to export.
• Include Clippings / Global (default false) - select true if you want to include the global/clipping model and its content when exporting the instance resources.
• Views ZUID (optional) - add the views zuid that you want to include on the generated zip file which is not associated with the selected models.

2. Click Export. This will generate a zip file.

The generated zip will include:

• The specified model and the models parented to it.
• The published contents and views bind to the models.
• The css and scripts that are associated with the models. To include css and js on the export, you need to rename the files with the model name on it. For example, about model can include css and js with filename about.module.css and about.module.js
• Clippings / Global models if tagged as true.
• The views that are specified on views zuid field.

Installing Template

This function is used to import the resources to an instance which includes the setting, headtags, style variables, scripts, css, contents, views and models. Before using this function, make sure that the exported file from the installer has been pushed to a github repository as this function is referencing the files in the github repository.

Note: This function resets the instance and wipes all the existing resources from the instance before proceeding to the installation process. Make sure to use an instance that will be updated or a newly created instance.

Steps on how to install an Instance template:

1. Access the templating.api.zesty.io
   Input your session or developer token in the token field.
   Select Install Template and input the required fields for installation.

• Instance ZUID (required) - The target instance zuid that you want the template to be installed.
• Github URL (required) - The template files repository that will be installed on the instance. This must contain the resources from the exported instance.
• Branch (default main) - The target branch from the github repository. By default, the installer will use the main branch but you can specify other branches.
• Github Access Token (optional) - This will only be used if the repository is private. You must provide the access token from the repository.

2. Click Install to start the installation process, this will take a few minutes but may vary depending on the size of the resources being installed.

Installing Module

This function is used to import the resources to an instance from the exported files from the installer. Before using this function, make sure that the exported file from the installer has been pushed to a github repository as this function is referencing the files in the github repository.

Note: This function will return an error once the model name that will be installed already exists on the target instance.

Steps on how to install an Instance module:

1. Access the templating.api.zesty.io
   Input your session or developer token in the token field.
   Select Install Module and input the required fields for installation.

• Instance ZUID (required) - The target instance zuid that you want the template to be installed.
• Github URL (required) - The template files repository that will be installed on the instance. This must contain the resources from the exported instance.
• Branch (required / default main) - The target branch from the github repository. By default, the installer will use the main branch but you can specify other branches.
• Github Access Token (optional) - This will only be used if the repository is private. You must provide the access token from the repository.
• Force Install (default false) - if set to true, installation will add prefix for the models that already exist during installation. For example, if the model already exists on the instance, this will be installed as about_1.

2. Click Install to start the installation process. This will take a few minutes but may vary depending on the size of the resources being installed.

Note: Check the target Instance and verify if the module or template has been installed correctly (eg. contents, models, view/code files, media)