Last updated 15 September 2015. Created on 28 April 2015.
Edited by FatherShawn. Log in to edit this page.

This is a configuration guide for the FormAssembly integration module.

The module is installed in the usual way. Configuration is found at

admin/config/services/formassembly

.

OAuth

The Drupal site needs to authenticate with the FormAssembly service. This authentication process will yield a Client ID and a Client Secret. The process is slightly different depending on the endpoint you are attempting contact.

Before you can interact with the API, you must obtain a CLIENT_ID and a CLIENT_SECRET code. This is done by completing the registration process on the particular instance you are targeting. For the Developer Sandbox and FormAssembly.com, you must register through the FormAssembly Developer Hub. For Enterprise instances, the FormAssembly administrator can register your app.
https://github.com/veerwest/formassembly-api#registration

The FormAssembly module will present a login from the FormAssembly service on form save and store an authorization token for use in api calls to the service when the form is saved.

API Endpoint

  • Developer Sandbox: Sandbox access is for testing against the consumer instance and can be requested at http://www.formassembly.com/api/
  • FormAssembly.com: The public consumer endpoint.
  • FormAssembly Enterprise Cloud: The enterprise endpoint. If this endpoint is chosen then an Enterprise Cloud Subdoman field will expose so the proper domain can be specified.

Options

  • Admin Index: This option exposes if the endpoint is Enterprise Cloud. If this option is selected, the OAuth tokens must have been created by an admin level user. This option causes sync to pull in all the forms in the Enterprise instance. When not selected, only the forms belonging to the user that created the tokens will be pulled down.
  • Sync Now: Initiates a batch process to sync with FormAssembly when the configuration is saved.
  • Reauthorize: Obtains a new authorization token from FormAssembly

Scheduled Syncing

The FormAssembly module provides a drush command that you can use in your server's cron or a Jenkins scheduled job to synchronize with the service.

drush fa-sync

See Solution using Drush and crontab and without wget for documentation on how to add a drush command to a server's cron.

Looking for support? Visit the Drupal.org forums, or join #drupal-support in IRC.