To build component plug-ins, you'll need an Appian installation to test them. This page walks you through the steps to get your environment up and running so you can develop your first component.
Note: Prior to listing a component plug-in on the AppMarket, we review the plug-in to ensure it meets our standards for customer use. Check the review guidelines and get a pre-approval to make sure you're on the right track before starting your developer setup.
Configure your developer instanceCopy link to clipboard
- If you don't already have an Appian instance, use the installation guide to install one.
- A properly configured dynamic content URL is required to use component plug-ins. For local installations, follow these steps:
- Create a dummy dynamic domain based on your site domain. For example, if your
SERVER_AND_PORT
property islocal.example.com:8080
, setDYNAMIC_SERVER_AND_PORT
tolocal.example-dynamic.com:8080
. - Add
local.example-dynamic.com
to/etc/hosts
(orC:\Windows\System32\Drivers\etc\hosts
) and map it to your local IP address.
- Create a dummy dynamic domain based on your site domain. For example, if your
Register your developer instanceCopy link to clipboard
Component plug-ins must be reviewed and approved before they can be deployed and used by Appian developers to build applications. In order to deploy and test components that are still under-development you must register your developer instance using these steps:
- Request a developer token from the AppMarket Submissions Site:
- Enter the
FQDN
on file with an active product license for a non-production server. - Provide the
SERVER_AND_PORT
value fromcustom.properties
for your developer instance. - Include details on the type of component(s) you plan to build.
Note: Requesting a developer token can take up to seven (7) business days.
- Enter the
- Once your instance is approved we will provide a developer token. The token is valid only for the developer instance identified by the
SERVER_AND_PORT
you provide in the support case. - Add the following property to your
custom.properties
file to enable component plug-in development:conf.plugins.INTEGRATION_SDK_DEVELOPER_TOKEN=<token value provided>