Plugin Manifest

The manifest is the blueprint of your plugin for the Act! application. It is responsible for telling Act! how to register and handle your plugin.

Properties

Here is the example manifest generated by the CLI tool for your project:

{
  "actions": "http://localhost:8000/src/actions.js",
  "company": "",
  "description": "DESCRIPTION",
  "extensions": [{
    "entity": "contact",
    "payload": {
      "src": "http://localhost:8000/tab.html",
      "name": "plugin-docs",
      "label": "PLUGIN_DOCS",
      "position": {
        "name": "opportunities",
        "type": "after"
      }
    },
    "type": "tab"
  }, {
    "type": "view",
    "payload": {
      "src": "http://localhost:8000/index.html",
      "name": "plugin-docs",
      "label": "PLUGIN_DOCS",
      "icon": "note"
    }
  }],
  "name": "",
  "permissions": {},
  "pluginImageSrc": "",
  "settings": {},
  "supportEmail": "",
  "translations": {
    "de": {
      "DESCRIPTION": "",
      "PLUGIN_DOCS": "Plugin Documentation"
    },
    "en-GB": {
      "DESCRIPTION": "",
      "PLUGIN_DOCS": "Plugin Documentation"
    },
    "en-US": {
      "DESCRIPTION": "",
      "PLUGIN_DOCS": "Plugin Documentation"
    },
    "fr": {
      "DESCRIPTION": "",
      "PLUGIN_DOCS": "Plugin Documentation"
    }
  },
  "version": {
    "major": 0,
    "minor": 0,
    "patch": 0
  }
}

The available properties for a valid manifest are:

actions: The endpoint to use for hosting your actions.js file. This should be a set of global functions to utilize when adding any action extension points.
company: Your company name.
description: A description of the plugin and its functionality. This will be displayed in the plugin management view within Act! Note: In the sample manifest above, the description is localized by specifying a key referenced in the translation section. If localization is not required, the description can defined explicitly here.
extensions: An array containing the definitions for your plugin extension points. Jump to the section on extensions for more detail.
main: (DEPRECATED) The endpoint for where your plugin application is hosted. This is utilized for the iframe src.
name: The unique name of your plugin.
permissions: The desired permissions your plugin application will request from the Act! application. This will be actively expanded as the security of the application is updated (currently under development). The goal is to provide a similar experience as mobile applications requesting permission from the phone's OS to communicate with other applications or access specific data.
pluginImageSrc: The path to the image file to be displayed with the plugin management view. The image is displayed in a 100px x 100px area in the view and images are automatically resized to fit correctly.
settings: If custom settings are required for your plugin, this section will be used to define the location of the settings page. Jump to the section on settings for more detail.
supportEmail: The email to use for directing users for any support with your plugin. This will be displayed to the user in the event of an application level error detected by Act! due to your plugin.
translations: The definitions necessary for displaying your plugin within Act!. This is needed for any strings that are to be displayed by the Act! application and not by your application (ex. the text to display for a View extension within the navigation menu). Please note that locales are restricted to the available locales within the Act! product.
version: All plugins are required to be semantic versioned. The goal is to provide a similar experience to the mobile application update process from iOS or Android.

Next, we go over the extension definitions and available extension points for your Act! plugin.

Extension Points