Skip to content
Snippets Groups Projects
Commit d4d79773 authored by ErikHommel's avatar ErikHommel :homes:
Browse files

wip documentation

parent e866fa16
No related branches found
No related tags found
No related merge requests found
......@@ -75,3 +75,41 @@ Once I have selected the type of join I can specify what fields I have to join o
## Fields
Once you have selected your data source(s) you can then select what fields you want to use from those data sources.
So in my example my data processor form now looks like this with the data sources selected and joind:
![Data Processor Form](docs/images/dp_fields1.png)
I can now select fields from those data sources for my data processor by clicking on the **Add Field** button. In the example I will start with the name of the member:
![Add Member Name](docs/images.dp_fields2.png)
You can see that I have the following bits to select or enter:
* **Select field**: I have selected here _raw field value_, which will display the field as it comes from the database. I could also select an option to format my data, for example when I use a date or when I use an option value from the database but I want to use the label of that value etc.
* **Field**: this is where I select the relevant field from the data sources on my data processor.
* I can tick the box at **Aggregate on this field**
* I can specify a title for the field in my data processor.
In this way I have added a few fields so in the end my data processor form looks like this:
![Data Processor Form with Fields](docs/images/dp_field3.png).
I can click on the dots at the right of each field to either **edit** or **remove** the field.
And I will now also be presented with some options to sort the data processor data.
## Filters
I can add filters to my data processor, so the user that sees the data can filter the data if needed.
![Add Filter](docs/images/dp_filter1.png)
More about filters will be explained in the How to examples in this documentation.
## Output
Finally I can specify where the output of my data processor should go by clicking on the **Add Input** button. Output could be an API action for a public website, a tab on the CiviCRM contact summary, a custom search on CiviCRM and many other things.
![Add Output](docs/images/dp_output1.png)
See the examples for examples :-)
docs/images/dp_fields2.png

26.3 KiB

docs/images/dp_fields3.png

64 KiB

docs/images/dp_filter1.png

30 KiB

docs/images/dp_output1.png

24.1 KiB

......@@ -28,6 +28,10 @@ This guide also contains a few examples of use cases:
- [How to publish a list of contact name, country and website on the public website (Drupal 8 website)](usecase1.md)
And some technical information on how to add your own data sources:
- [How to add your own data source](HowToDevelopACsvDataSource.md)
- [How to add a data source for a CiviCRM entity](add_your_own_datasource.md)
## CiviCRM versions
The **Data Processor** extension has initially been developed with CiviCRM 4.7 and has been tested with CiviCRM 5.x on various sites.
......
......@@ -9,8 +9,8 @@ nav:
- How to create:
- Website overview of contact, country and website from CiviCRM: usecase1.md
- Blabla: usercase2.md
- Your own data source: add_your_own_datasource.md
- Your own CSV data source: HowToDevelopACsvDataSource.md
- Your own data source: HowToDevelopACsvDataSource.md
- A data source for a CiviCRM entity: add_your_own_datasource.md
markdown_extensions:
- attr_list
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment