diff --git a/docs/basic-concept.md b/docs/basic-concept.md index cf440bbcefe990062b301fe76d8dc3e5bca07df0..68c83b5c1f5bf0b1f195fdc8e48a1c346e08f7bf 100755 --- a/docs/basic-concept.md +++ b/docs/basic-concept.md @@ -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: + + + +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: + + + +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: + +. + +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. + + + +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. + + + +See the examples for examples :-) diff --git a/docs/images/dp_fields2.png b/docs/images/dp_fields2.png new file mode 100644 index 0000000000000000000000000000000000000000..ef7e0587c133ab423d5926822319336bf8b79025 Binary files /dev/null and b/docs/images/dp_fields2.png differ diff --git a/docs/images/dp_fields3.png b/docs/images/dp_fields3.png new file mode 100644 index 0000000000000000000000000000000000000000..1bec7578fcd0762f9abb4451fb59657103a74683 Binary files /dev/null and b/docs/images/dp_fields3.png differ diff --git a/docs/images/dp_filter1.png b/docs/images/dp_filter1.png new file mode 100644 index 0000000000000000000000000000000000000000..99165442a2ac5ade554b90033a337aae05591e6f Binary files /dev/null and b/docs/images/dp_filter1.png differ diff --git a/docs/images/dp_output1.png b/docs/images/dp_output1.png new file mode 100644 index 0000000000000000000000000000000000000000..29ee81d75aebe3caf84f31c79ff5d550addecfe7 Binary files /dev/null and b/docs/images/dp_output1.png differ diff --git a/docs/index.md b/docs/index.md index 1de96fec31f521665f8d5d9e0de9e1f134c7e2ad..7537ce2f3c99856fa5207489b6ed6d95c65791af 100755 --- a/docs/index.md +++ b/docs/index.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml index 8e352974b82084aae9ded3760987216358f6ec64..8efd8d255ca7914def4971f697351e7843a6f0ba 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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