Commit fafa77c3 authored by jaapjansma's avatar jaapjansma

Merge branch 'master' of lab.civicrm.org:extensions/form-processor

parents c2d02609 acb566b5
......@@ -39,7 +39,7 @@ In the top part of the form you can enter the general form processor information
* a *name* will be suggested based on the *title* but can be changed if you click on the lock behind the field first!
!!! Note
A *name* can not contain any spaces!
A *name* can not contain any spaces! And should be unique!
* you can specify a detailed description (and it makes sense to do so if you expect to build a few forms!)
* you can tick if the form processor should be enabled (on by default)
......@@ -76,12 +76,13 @@ Initially the part of the form where we can specify actions will look like this:
![Action part of the form](/images/new-action-part.png)
If you click on the action select box you will get a list of actions that are already available because some of the funding organizations needed that action.
As time goes by and more people start using and enhancing the **Action Provider** extension, the list will grow.
As time goes by and more people start using and enhancing the [**Action Provider** extension][actionproviderrepo], the list will grow.
!!! Note "Create your own"
It is possible to develop your own specific actions, or indeed generic ones that others can use too! Check the relevant sections in this guide:
* [Introduction to creating your own][create-your-own-introduction.md]
* [Example of Email Preferences][email-preferences.md]
* [Introduction to creating your own](create-your-own-introduction.md)
* [Example of Email Preferences](email-preferences.md)
In this example we have a first step: find the contact with the data from the form:
......@@ -106,10 +107,24 @@ I can specify here what criteria I want to use, in this example I have specified
At the *retrieval methods* part I can select how I want to retrieve my data.
Here I would like an action called *Find contact with checksum*. Unfortunately that is not available yet because it has not been developed yet, but you get the gist.
And it will be developed in the section [Email Preferences][email-preferences.md].
And it will be developed in the section [Email Preferences](email-preferences.md).
For each of my input fields I can finally specify what data should be loaded here, which should come from the result of my action.
!!! Note "Techie stuff"
On a technical level: If you have enabled default data retrieval it actually generates an API action for the FormProcessorDefaults API entity.
## Output Handler
At the bottom of the form where you edit or create your form processor there is also a bit about an *output handler*:
![Output Handler](/images/output-handler.png)
This gives you the option to manipulate the output that is sent back to the public website once all the actions have been executed.
If you do not specify anything, the default value of *send everything* then all the data involved is sent back (inputs, output from actions etc.).
If you decide for example you only want to send the ID of the contact back you can select the *decide what to send* and specify what from all the available data should be send back and how it is called.
## That's it!
If you click on the *Retrieval of defaults* tab in the **New Form Processor** form you will get a form like this:
......@@ -117,8 +132,8 @@ And that is all! A form to be used without coding. Once I saved the form process
![API to be used](/images/api-to-be-used.png)
So far the basic concept. Obviously the public website part needs to be done too, check the [Example Sign Up Newsletter][sign-up-newsletter.md] section for that part, this section just covers the basis principles.
So far the basic concept. Obviously the public website part needs to be done too, check the [Example Sign Up Newsletter](sign-up-newsletter.md) section for that part, this section just covers the basis principles.
[actionproviderrepo]:https://lab.civicrm.org/extensions/action-provider
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment