From aa9a4630f65f5732e083a5d1dba7c030cf52fa9f Mon Sep 17 00:00:00 2001 From: Matthew Wire <mjw@mjwconsult.co.uk> Date: Mon, 14 Aug 2023 23:29:45 +0100 Subject: [PATCH] Fix images in docs --- docs/HowToAddAPIDataOutput.md | 8 ++++---- docs/basic-concept.md | 24 ++++++++++++------------ docs/uc-mailtokens.md | 30 +++++++++++++++--------------- docs/uc-members-online.md | 28 ++++++++++++++-------------- 4 files changed, 45 insertions(+), 45 deletions(-) diff --git a/docs/HowToAddAPIDataOutput.md b/docs/HowToAddAPIDataOutput.md index 2137f560..df59ed62 100644 --- a/docs/HowToAddAPIDataOutput.md +++ b/docs/HowToAddAPIDataOutput.md @@ -1,13 +1,13 @@ # How to Add API Output in Data Processor -API output returns an API which can be called to retrieve the Data Processor results. +API output returns an API which can be called to retrieve the Data Processor results. In this tutorial we are going to add API Output to our Data Processor Following the previous tutorials we have added Data Source and Data Fields to Data Processor For this tutorial we are considering Contact as the Data Source and DisplayName, Contact ID as the output fields of the Data Processor -##### Follow the below mentioned steps to add API output: +##### Follow the below mentioned steps to add API output: - First Navigate to your Data Processor and select **Add Output** - Select **API** from the **Select Output** dropdown @@ -16,12 +16,12 @@ For this tutorial we are considering Contact as the Data Source and DisplayName, See the below screen for example: - + - Then click on Save button ##### Follow the below mentioned steps to see the usage of : - Navigate to API Explorer v3 under Support -> Developer - Seach for Entity name you entered while configuring API output (example: MyTestEntity) -- Click on Execute +- Click on Execute - This is the result of Data Processor which we can get by making API calls as shown. diff --git a/docs/basic-concept.md b/docs/basic-concept.md index 98cfeeb7..5742c33e 100755 --- a/docs/basic-concept.md +++ b/docs/basic-concept.md @@ -17,18 +17,18 @@ Once you installed the **Data Processor** extension you will have an additional Initially the **Manage Data Processors** will be empty when you have just installed the extension and look like this: - + You can add a new data processor or import a data processor. The latter can be useful if you tried to create one in your test environment and then want to use it on your production environment. With export and import you can easily move data processors between environments. ## Add Data Processor Form You can create a new data processor by selecting the menu option **Add Data Processor** (Administer>Data Processor>Add Data Processor) or by clicking the button **Add DataProcessor** on the **Manage Data Processors** page. If you do this you will see a form like the one below. On this form you can add the _title_ and _description_ for the data processor and then hit **Next** to save and continue. - + When you have entered the title and description and hit next you will be presented with a form like this: - + On this form you have four elements that you can add: **Data Sources**, **Fields**, **Filters** and **Output**. You can check what these elements do in detail in the **How to** examples in this documentation, below is a quick overview. @@ -46,13 +46,13 @@ Literally the source(s) where your data is coming from. This can be known CiviCR For example, I select the data source _Contact_ but only want to see Individuals. I would then filter on _Contact Type is one of Individual_. - + If you use more than one data source you will have to specify how they are joined. For example, if I add the entity _Activity_ to my data processor that already has the entity _Contact_. I will then have to specify how contact and activity are joined so that I only get the activities for the relevant contacts. When specifying how data sources are joined I will be presented with this form: - + You can see that there are 2 types of joins: 1. Select fields to join on @@ -64,25 +64,25 @@ An example to illustrate: * I have selected the entities Contact and Membership in that sequence (so Contact is my first) * The data looks like this: - + * If I use the first type of join my data processor will only show contacts Martha Hamster and Bor de Wolf. Only in those cases do I have data in both of my data sources. * If I use the second type of join my data processor will show all contacts but the membership fields will be empty for Ed Bever. Once I have selected the type of join I can specify what fields I have to join on. In my example that is the Contact ID from the Membership has to be the same as the Contact ID of the Contact, see: - + ## 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: @@ -93,7 +93,7 @@ You can see that I have the following bits to select or enter: 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. @@ -102,7 +102,7 @@ And I will now also be presented with some options to sort the data processor da 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. @@ -110,6 +110,6 @@ More about filters will be explained in the How to examples in this documentatio 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/uc-mailtokens.md b/docs/uc-mailtokens.md index 8c67564e..c2eb65bc 100755 --- a/docs/uc-mailtokens.md +++ b/docs/uc-mailtokens.md @@ -15,16 +15,16 @@ Note: by default, CiviCRM has a number of default tokens available. There are al 1. In CiviCRM go to Administer / DataProcessor / Add DataProcessor 1. Enter basic information on your Data Processor (Name, description) Note that the Name you give this dataprocessor will be the title of the tokenset such as it appears to users when writing their mail or mail template. - -We will only need two data sources: + +We will only need two data sources: 1. Add Datasource "Activity" - Filter on Activity Type "Appointment" and Activity Status "Scheduled" and at the bottom of the filters Activity contact :: Record Type ID - is one of - "Activity Assignees" (so that the staff member the appointment is with can be added to the reminder) and Save it - - - + + + 1. Add Datasource "Individual" no need to add filters - Jointype "Select fields to join on" (i.e. there has to be a contact to send it to) and join on fields "Conact ID and "Activity::Activity contact::Contact ID (match to contact)" - + -Those were the required Datasources. +Those were the required Datasources. ### Fields Now lets go to the fields that are necessary: Display Name of the staff member, the location of the appointment and the date and time of the appointment. We'll also add the Activity ID and the Contact ID so that we can also create an output Search. With it we can quickly check if the output Token provides the correct fields/tokens. @@ -34,9 +34,9 @@ Now lets go to the fields that are necessary: Display Name of the staff member, 1. Add field "Location" - Raw Field Value and give it a title. 1. Add field "Activity Date" - Date field value and give it a title. You should now have a list of fields like this: - + -Those are the required fields. Since we don't need any sorting or more filters (we've done those on the datasources), we can now continue with the output. +Those are the required fields. Since we don't need any sorting or more filters (we've done those on the datasources), we can now continue with the output. Note: the title you give to each field is the name of the token such as it will appear in the token list when writing an email or email template! @@ -50,19 +50,19 @@ The output we're creating is "Tokens" that can be used by any user of this CiviC 1. No sorting required 1. Save the Data Processor Output - + -Note: once saved, the tokens will be available for selection on the appropriate places when writing emails or email templates. The name of the dataprocessor will also be the name of the tokenset the user gets to see when writing email or emailtemplate. +Note: once saved, the tokens will be available for selection on the appropriate places when writing emails or email templates. The name of the dataprocessor will also be the name of the tokenset the user gets to see when writing email or emailtemplate. ### Output (Search) -To make sure that I have defined all properly, I usually also create a Search output so that I can check in CiviCRM that my dataprocessor does what I expect it to do. -1. Add a second output, but this time select "Activity Search" from the Select output drop down. +To make sure that I have defined all properly, I usually also create a Search output so that I can check in CiviCRM that my dataprocessor does what I expect it to do. +1. Add a second output, but this time select "Activity Search" from the Select output drop down. 1. Add the Search form to a Parent menu in CiviCRM -1. Define the permission, the default is perfect. +1. Define the permission, the default is perfect. 1. The ID field here would be the Activity ID 1. Define whether or not you want the ID field hidden 1. Save the form and look for the Search form under the menu you defined in step 2 here. - + diff --git a/docs/uc-members-online.md b/docs/uc-members-online.md index 92020e18..e0eefad6 100755 --- a/docs/uc-members-online.md +++ b/docs/uc-members-online.md @@ -1,7 +1,7 @@ # Use Case: Member Organisations presented on website ## Situation Many organisations that have organisations as their members, publish their member organisations on their website. Sometimes with limited data such as the name, country and website URL. Others publish full member information, with descriptions and whatever else they collect of their member organistaions. -This use case describes how to create the API with the Data Processor that a website can use to pick up the data from CiviCRM. +This use case describes how to create the API with the Data Processor that a website can use to pick up the data from CiviCRM. ## Requirements * CiviCRM installed @@ -11,16 +11,16 @@ This use case describes how to create the API with the Data Processor that a web ### Datasources 1. In CiviCRM go to Administer / DataProcessor / Add DataProcessor 1. Enter basic information on your Data Processor (Name, description) - + 1. Add Datasource "Organisation" - no need to add filters 1. Add datasource "Address" - leave default values for filters (primary address is 'yes' - Join type "Select fields to join on - not required" since we may not have address data of this organisation and in that case the organisation would not be shown at all. Join on field "Contact ID" and "Organisation :: Contact ID" - + 1. Add Datasource "Website" - leave default values for filters - Joint type "Select fields to join on - not required" and Joint on field "Contact" and "Organisation :: contact ID" - + 1. Add Datasource "Membership" - Filter on "Membership Status ID" "is one of" and then pick the statusses you want shown (current, new, pending) on the website - Select Join type should be set to "Select fields to join on" since the organisation must be a member in order to be shown and therefore there must be a membership and Join on Field "Contact ID" and "Organsisation:: Contact ID" - + -Those were the required Datasources. +Those were the required Datasources. ### Fields Now lets go to the fields that are necessary: Organisation Name, Organisation Country of primary address and Organisation Website. We'll also add the Organisation Contact ID so that we can also create an output Search. With it we can quickly check if the output API should work. 1. Add field "Contact ID" - Raw Field Value, i.e. what is written in this field in CiviCRM; @@ -28,30 +28,30 @@ Now lets go to the fields that are necessary: Organisation Name, Organisation Co 1. Add field "Country" - Option Label (the label of the field, i.e. the country name here, rather than the country ID which would just be a number; and the Option from Option Label is because the field "Country" in CiviCRM is an option list, i.e. a list of all countries that you select the country from beloging to this address) 1. Add field "Website" - Raw Field Value You should now have a list of fields like this: - + -Those are the required fields. Since we don't need any sorting or more filters (we've done those on the datasources), we can now continue with the output. -Note: if you want users on the website to be able to sort or filter, add filters here that can then be used by the webdeveloper through the API output we're creating in the next step. +Those are the required fields. Since we don't need any sorting or more filters (we've done those on the datasources), we can now continue with the output. +Note: if you want users on the website to be able to sort or filter, add filters here that can then be used by the webdeveloper through the API output we're creating in the next step. ### Output (API) The output we're creating is an API that can be used by the webdeveloper that is creating the page with the member organisations on it. 1. Go to the Output part of the Dataprocessor and choose "Add Output" -1. From the "Select output*" dropdown, select "API" +1. From the "Select output*" dropdown, select "API" 1. Enter a name in the API Entity field - keep that simple and do not use spaces in between characters; this is the name the webdeveloper will use to call the API; 1. leave the aPI Action Name and API GetCount Action Name with their default values 1. define the CiviCRM permission that is required to enable the use of this API; teh default value is perfect for this purpose. 1. Save the Data Processor Output 1. provide the API Enitity field value to the webdeveloper: - + Note: your webdeveloper will also need a Sitekey and API key in order to access CiviCRM data in the first place. Find out in CiviCRM manuals how to provide those. ### Output (Search) -To make sure that I have defined all properly, I usually also create a Search output so that I can check in CiviCRM that my dataprocessor does what I expect it to do. -1. Add a second output, but this time select "Search/Report" from the Select output dropwdown. +To make sure that I have defined all properly, I usually also create a Search output so that I can check in CiviCRM that my dataprocessor does what I expect it to do. +1. Add a second output, but this time select "Search/Report" from the Select output dropwdown. 1. Add the Search form to a Parent menu in CiviCRM -1. Define the permission, the default is perfect. +1. Define the permission, the default is perfect. 1. The ID field here would be the Contact ID 1. Define whether or not you want the ID field hidden 1. Save the form and look for the Search form under the menu you defined in step 2 here. -- GitLab