Package Structure

Component plug-ins are packaged in ZIP files. This page describes the required ZIP structure.

This version of Appian supports component plug-ins that use SDK version 2.0.0. Refer to the Integration SDK compatibility table for version details.

Package Structure

The folder structure of your component plug-ins references properties from the plug-in manifest file including the component's rule-name and version attributes.

  • file Plug-in, packaged as a ZIP file
    • file appian-component-plugin.xml - Component plug-in package manifest
    • folder Component folder, one for each component rule-name defined in the plug-in
      • folder Component version folder, one for each major version (For example: v1, v2)
        • file Plug-in web content, including HTML, JS, CSS, etc. files. The HTML file used as the component's html-entry-point should be placed in this folder. Use subfolders for organization.
        • file Internationalization bundles (For example: <rule-name>_en_US.properties)

Notes

  • The appian-component-plugin.xml manifest file and all component rule name folders must be at the root directory of the zip file.
  • All paths for web content should be relative to its version folder as it will be unpacked into separate directories inside the container on deployment.
  • Internationalization bundles are removed from the folder structure when the plug-in is deployed. Don't reference these files in your code.
  • The allowed file types for web content are: .html, .htm, .css, .less, .js, .woff, .woff2, .png, .gif, .jpg, .jpeg, .svg, .ico, .map. Files not matching these extensions will be ignored on deployment.

Example

In the following example:

  • The package version is 2.1.0
  • The package contains two components: mapField and directionsField
  • mapField has two major versions
  • directionsField has a single major version

file geo-components_2.1.0.zip

  • file appian-component-plugin.xml
  • folder mapField
    • folder v1
      • file index.html
      • file map.js
      • file mapField_en_US.properties
      • folder images
        • file maps.svg
    • folder v2
      • file index.html
      • file map-advanced.js
      • file mapField_en_US.properties
      • file mapField_en_GB.properties
      • folder images
        • file maps.svg
  • folder directionsField
    • folder v1
      • file index.html
      • file directions.js
      • file directionsField_en_US.properties
      • file directionsField_en_GB.properties
      • folder images
        • file directions.svg
FEEDBACK