Importing and exporting resource profile packages

To share resource profiles among tenants, you can export a resource profile to a resource profile package file. This allows for another tenant to then import that resource profile package. Resource profiles may be imported and exported as resource packages. The package is a zip file containing the following:

  • manifest.json – manifest file with meta-data.
  • script.js.
  • icon.png (optional).
  • password-profile.json – password profile (optional).

There are no directory structures in the zip. The text files in resource profile packages (scripts, manifest, and password profile) are in UTF-8 encoding. Line endings may be either CRLF or LF.

Note:   Other file names are permitted but must start with the names given above. For example: manifest-PAN311.json.

The documentation below provides steps to perform the following:

Importing a resource profile package

You can import previously exported resource profile packages. Things to keep in mind before you import a profile package:

  • If the resource profile package has a password profile, you are given the option to ignore it and specify an existing password profile. You can create a new profile based on the information in the package or manually create a password profile.
  • The information in the package is used to initialize a form for creating the new resource profile. You can edit the resource profile before saving it.

To import a resource profile package

  1. In the Admin Portal, navigate to Settings > Resources > Resource Profiles > Import Profile. A warning message appears to ensure the package is from a trusted source.

  1. Click Continue and proceed to import profile package. Click Browse to add your package and assign Password Complexity Profile to custom or package settings:

  1. The details of the imported package will appear. Confirm all the fields to the package are correct or amend as needed. Click Save.

Exporting a resource profile package

You can export a resource profile package from an existing resource profile. The <identifier>.zip contains the following:

  • manifest-<identifier>.json.
  • script-<identifier>.js.
  • icon-<identifier>.png.
  • password-profile-<identifier>.json.

Note:   There is no directory structure. When exporting, you can export the optional icon and password profile components of the package.

To export a resource profile package

  1. In the Admin Portal, navigate to Settings > Resources > Resource Profiles. Choose a profile and navigate to Actions and choose Export.
  2. An Export Profile window appears. Name the package and check off if you want to include the Password Profile and Logo:

  1. Click Export and you will see the downloaded package in your Downloads folder.

Updating an existing resource profile from a resource profile package

After you have imported a resource profile package, at a later date you might want to update it with the "latest copy" of the resource profile (for example, the script may have been updated).

To update a resource profile package

  1. In the Admin Portal, navigate to Settings > Resources > Resource Profiles. Choose a profile to update. Navigate to Actions and choose Update.

Here, you can update the:

  • Script.
  • Manifest.
  • Icon.
  • Password Profile.
  1. Make changes as needed and click Update. The profile package will appear. Confirm all the components are correct and click Save.

Manually creating and modifying a resource profile package

You can manually create and modify resource profile packages. To create a resource package manually:

  1. Write a script and create a manifest file (using the editor of your choice).
  2. Create an icon (optional).
  3. Create Resource Profile Package password profile file.
  4. Create a zip with these files. The zip is a resource profile package that can be imported.

Resource Profile package manifest

The manifest file is JSON as in the following example:

{
"Identifier": "Pan311",
"Name": "PAN 311",
"Description": "{ \"en\": \"PAN 311 Description\", \"es\": \"Descripcion de PAN 311\" }",
"Author": "Rich Smith",
"Version": "4.4.4.4"
}

Resource Profile package password profile

The optional password profile allows a package developer to suggest the settings for a password profile that works for the device (example: has particular device requirements for password generation).

Note:   When importing a package, you can ignore the password profile in the package in favor of your own password profile.

The password profile is JSON as in the following example:

{
"Name": "dev2 profile",
"Description": "dev2 password profile",
"MinimumPasswordLength": 6,
"MaximumPasswordLength": 8,
"AtLeastOneLowercase": true,
"AtLeastOneUppercase": true,
"AtLeastOneDigit": true,
"ConsecutiveCharRepeatAllowed": true,
"AtLeastOneSpecial": true,
"MaximumCharOccurrenceCount": 2,
"SpecialCharSet": "!$%&()*+,-./:;<=>?[\\]^_{|}~",
"FirstCharacterType": "AnyChar",
"LastCharacterType:" "AnyChar",
"MinimumAlphabeticCharacterCount": 2,
"MinimumNonAlphabeticCharacterCount": 2
}

Using sets with resource profiles

You can add sets to resource profiles. For more information on managing sets, see Managing sets.