README.md 2.56 KB
Newer Older
1
# Data Processor
jaapjansma's avatar
jaapjansma committed
2

3
The data processor is an extension with which system administrator can do the following:
jaapjansma's avatar
jaapjansma committed
4

5
* Create custom searches with optional the possibility to export the results
6
* Create an API to fetch data. This is quite useful if you have external systems which need data from CiviCRM.
7
* ... and developers can enhance the outputs of the data processor so that much more is possible, even things we haven't thought of yet.
jaapjansma's avatar
jaapjansma committed
8

9
Below a screenshot of the configuration screen
jaapjansma's avatar
jaapjansma committed
10

11
![Screenshot configuration screen](docs/images/dataprocessor_1.png)
jaapjansma's avatar
jaapjansma committed
12

13
And below a screenshot of the above data processor in action as a custom search:
jaapjansma's avatar
jaapjansma committed
14

15
![Screen of data processor in action as a search](docs/images/dataprocessor_2.png)
jaapjansma's avatar
jaapjansma committed
16

17
The extension is licensed under [AGPL-3.0](LICENSE.txt).
jaapjansma's avatar
jaapjansma committed
18

19
## Documentation
jaapjansma's avatar
jaapjansma committed
20

21
* [How to create a search with the data processor](docs/how_to_create_search.md)
sarvesh21's avatar
sarvesh21 committed
22
* [Using API output to fetch the results in data processor](docs/HowToAddAPIDataOutput.md)
23
* How to export and import a data processor
jaapjansma's avatar
jaapjansma committed
24

jaapjansma's avatar
update    
jaapjansma committed
25
26
27
28
29
30
## Related extenions

* [dataprocessor-token-output](https://lab.civicrm.org/extensions/dataprocessor-token-output) Create tokens from a data processor
* [dataprocessor-vega-graphs](https://lab.civicrm.org/extensions/dataprocessor-vega-graphs) Graph output of a dataprocessor


31
## Developer documentation
jaapjansma's avatar
jaapjansma committed
32

33
34
* Enhancing the data processor
* [Available Hooks](docs/hooks.md)
sarvesh21's avatar
sarvesh21 committed
35
* [Add your own data source for a CiviCRM Entity](docs/add_your_own_datasource.md)
36
* Add your own data source for a CSV File
37
* * [Add your own data source for a CiviCRM Entity](docs/add_your_own_datasource.md)
38
* [Data Flow Classes](docs/dev/DataFlowClasses.md) - Overview of all the available data flow classes.
sarvesh21's avatar
sarvesh21 committed
39
* [Develop PHPUnit TestCase for the extension](docs/how_to_create_test.md)
jaapjansma's avatar
jaapjansma committed
40

41
## Installation
jaapjansma's avatar
jaapjansma committed
42

43
44
45
Install this extension by downloading it from https://lab.civicrm.org/extensions/dataprocessor/-/archive/master/dataprocessor-master.zip
and then upload it to your civicrm server in the extension folder.
And then press install in the Administer -->  System Settings --> Extensions screen.
sarvesh21's avatar
sarvesh21 committed
46

47
## Optional
sarvesh21's avatar
sarvesh21 committed
48
49
50
51

To get more information about each fields in DataProcessor. A CiviTutorial has been created, to view tutorial install CiviTutorial Extension.

To Install CiviTutorial in the Administer -->  System Settings --> Extensions screen. (Found in Add New)
52
53
54
55
56

## Known Issues

* From civicrm 5.41.0 and up the extension `legacycustomsearches` must be enabled. This is a core supplied extension, so there is no need for download.
Enable it in the Administer -->  System Settings --> Extensions screen, or use `cv en legacycustomsearches`.