Act Plugin Development
Welcome to the Act! Developer Documentation for plugin development. This site will walk you through getting yourself setup for creating an Act! plugin.
- NodeJS & NPM (comes with NodeJS download)
- An Act! Developer Account
You can run the CLI using the
First, login to the Act! NPM registry:
npm set registry http://npm.actops.com
Use the username and password given to you when you signed up.
Then, from the terminal, go to the directory you wish to hold your project and run the following command:
npx @act/plugins plugin init
yes will result in a new property in your manifest and an
actions.js file being created with some initial code to contain your global functions. You will still need to define the action extension within the
plugin-manifest.json file. Use the extensions docs to see the model for that.
This should place you through all of the
Getting Started. Check out the API section for consuming this library.
Check out the sample plugin built to demonstrate a Google Maps integration for the Contact entity. To see the full plugin in action, acquire an API key from Google for their Google Maps API. Insert the key into the code at the corresponding
TODO section, then build and run the project.
If your project does not have a
to initialize your
package.json for your project.
Add the latest
@act/plugins package to your
Copy the following into the
plugin-manifest.json file and fill with values for your plugin:
"company": "Your Company",
"name": "Your Plugin Name",
Please note, you do not need an
actions property if you do not use global actions. See the
Actions section below if this functionality is desired.
There are multiple ways to create extension points for Act!:
- Tab: shows as a new tab on the detail view for a specific entity. Supported entities are -
- Contextual Action: adds an action to the detail view for an entity. Supported entities are -
- View: adds a full screen view that is represented on the side navigation menu.
Here are the following models for each extension type. Add the object to the
extensions array in your
For a full screen view, add the object to the
extensions array on your
label property should map to the
translations property per locale. Please note that locales are restricted to the available locales within the Act! product.
icon property should exist within Act! icons or point to a URL for the icon you desire rendered (TODO: Add this functionality).
color property should map to one of the colors in the color palette for Act!.