Edit auto-install.json

auto-install.json configures the template for the auto-install framework. Always create this optional file if you plan to design your template for auto-installation via a managed package with an auto-install request.

Template developers use this file to specify the configuration of the auto-install framework hook and the app installation. When this file is created, add the autoInstallDefinition attribute to the template-info.json file.

Example

1{
2  "hooks": [
3    {
4      "type" : "PackageInstall",
5      "requestName" : "Hook for the Auto-Install Template"
6    }
7  ],
8  "configuration" : {
9    "appConfiguration" :{
10      "failOnDuplicateNames" : false,
11      "autoShareWithLicensedUsers" : true,
12      "autoShareWithOriginator" : true,
13      "deleteAppOnConstructionFailure" : true,
14      "values" : {
15        "value1" : "testString",
16        "value2" : false
17      }
18    }
19  }
20}

The example creates an auto-install hook to install the template via a managed package, naming the auto-install request Hook for the Auto-Install Template. The supported auto-install hooks are PackageInstall only.

The appConfiguration specifies that the installed app will:

not fail creation if an app or assets exist with the same developer name
be automatically shared with appropriately licensed users
be automatically shared with the user that created the auto-install request
be deleted if app creation fails for any reason; for create requests only, it doesn’t apply to app upgrades
be created with the template variable values in the values map

Because users don’t use the CRM Analytics Studio wizard to create the app, an app name attribute is required. To specify the app name, add a name attribute in the template’s folder.json file.

Important

Templates packaged for automatic install can’t be dependent templates. The creation of auto-install requests can’t guarantee dependent templates are installed in the correct order.

Note

See Also

auto-install.json Attributes