The RaiseNow SEXTANT integration supports various parameters. These parameters need to be set correctly for each use case in order to transfer them into SEXTANT.
Below are code examples for each use case that can be adapted and implemented on your website, self-service at RaiseNow Hub, and/or the RaiseNow P2P platform.
- Person entity
- One-off donation (Tamaro on website)
- Recurring donation (Tamaro on website)
- Gift option (payer vs. recipient)
- Event payment (Tamaro on website)
- P2P campaigns
- RaiseNow Hub solution payments/donations (self-service)
Important note on setting identifiers in touchpoints
IDs such as ProjectUId, PaymentOption, ContractTemplateUID that are provided to SEXTANT must be valid. Make sure that if you are setting these IDs dynamically via touchpoint configurations, the IDs are also valid. Otherwise, transfers may result in an error state, which would require manual actions to resolve, potentially with assistance from RaiseNow support.
one-off & recurring donation
For both one-off and recurring donations, you can set the following parameters:
CampaignIdentifier
This can be set using the purposeDetails setting stored_campaign_id for each purpose that a donor can select.
window.rnw.tamaro.runWidget('.rnw-widget-container', { purposes: [p1, p2],
purposeDetails: {
p1: {
stored_campaign_id: 1234
},
p2: {
stored_campaign_id: 5678
},
},
translations: {
en: {
purposes:{
p1: "Where it’s needed the most",
p2: "Healthy nutrition for pre-school children"
}
}
} });
Note: If you hide the purpose selector, you need to set a purpose via config and the campaign identifier via a custom event handler.
window.rnw.tamaro.runWidget('.rnw-widget-container', { purposes: [p2],
translations: {
en: {
purposes:{
p1: "Where it’s needed the most",
p2: "Healthy nutrition for pre-school children"
}
}
} });
const setCampaign = (event: WidgetEvent) => {
const api = event.data.api
const data = api.paymentForm.data
data.stored_campaign_id = 5678
}
window.rnw.tamaro.events.beforePaymentSend.subscribe(setCampaign)
stored_sxt_contract_template_id
Usually used for recurring donations but can also be set for one-off donations. Example:
window.rnw.tamaro.runWidget('.rnw-widget-container', { paymentFormPrefill: { stored_sxt_contract_template_id: "200714" } });
stored_sxt_product_id
To overwrite the setting in the import default, you can set a SEXTANT's ProductUId for one-off and recurring donations. Example:
window.rnw.tamaro.runWidget('.rnw-widget-container', { paymentFormPrefill: { stored_sxt_product_id:"GÖ" } });
DEFINE EDGECASE?! // TODO
stored_mandate_reference
Person entity via Tamaro
Contact Matching
To match a contact in SextANT directly, you can use two different parameters:
(1) stored_customer_crmid: 2381214712
(2) customer_token: 3c22a68720d15c2f4986f954e3bf6f0a5bb2cbff
- stored_customer_crmid refers to an object within SextANT to which RaiseNow has no access. RaiseNow transfers this identifier to SextANT for matching.
- customer_token refers to an object within RaiseNow. This identifier can be used to prefill the Tamaro form with donor data. A customer_token is always created within the creation of a recurring donation charged by RaiseNow. RaiseNow integration transfers this identifier to SextANT for matching.
Usually such an identifier will be used in E-Mail marketing on a specific landing page. Firstly to match the contact (donor making a donation) and secondly (if the customer_token is used) to prefill data and therefore to ease and simplify the process of donating for the known donor.
You can provide these parameters via URL using Tamaro's feature:
(1) For stored_customer_crmid
https://tamaro.raisenow.com/{{widget_uuid}}/latest/index.html?rnw-stored_customer_crmid=238121471
(2) For customer_token
https://tamaro.raisenow.com/{{widget_uuid}}/latest/index.html?customer_token=3c22a68720d15c2f4986f954e3bf6f0a5bb2cbff
Person data
Other parameters for your Tamaro integration can be prefilled via JS code (hidden) or you create custom fields (shown).
stored_customer_language
This can be defined using a custom field to let the donor explicitly choose the language for communication or by copying the value from the language in which the form is shown
Define a custom field: https://support.raisenow.com/hc/en-us/articles/360011968978-Adding-Custom-Fields-and-hidden-parameters
Copy the value via custom event handler: https://support.raisenow.com/hc/en-us/articles/360011964278-Implement-Custom-Event-Handlers
Example:
const setCustomerLanguage = (event: WidgetEvent) => {
const api = event.data.api
const data = api.paymentForm.data
data.stored_customer_language = api.config.language
}
window.rnw.tamaro.events.beforePaymentValidateAndSend.subscribe(setCustomerLanguage)
stored_sxt_address_source
You can define the source of the address for a contact by prefilling it statically as a custom field.: https://support.raisenow.com/hc/en-us/articles/360011968978-Adding-Custom-Fields-and-hidden-parameters
window.rnw.tamaro.runWidget('.rnw-widget-container', { paymentFormPrefill: { stored_sxt_address_source: "web" } });
stored_sxt_communication_keywords
For newsletter communication, you can set one or more SEXTANT Newsletter Keyword UIDs by prefilling them statically as a custom field: https://support.raisenow.com/hc/en-us/articles/360011968978-Adding-Custom-Fields-and-hidden-parameters
window.rnw.tamaro.runWidget('.rnw-widget-container', { paymentFormPrefill: { stored_sxt_communication_keywords:"421910,417814" } });
one-off donation
stored_campaign_subid
In the case of one-off donations, you can set a PaymentOptionUID. This can be done for each purpose or (if the purpose selector is hidden) for each landing page.
window.rnw.tamaro.runWidget('.rnw-widget-container', { purposes: [p1, p2],
purposeDetails: {
p1: {
stored_campaign_id: 1234
},
p2: {
stored_campaign_id: 5678
stored_campaign_subid: 4321
},
},
translations: {
en: {
purposes:{
p1: "Where it’s needed the most",
p2: "Healthy nutrition for pre-school children"
}
}
} });
Note: If you hide the purpose selector you need to set a purpose via config and the campaign identifier via custom event handler.
window.rnw.tamaro.runWidget('.rnw-widget-container', { purposes: [p2],
translations: {
en: {
purposes:{
p1: "Where it’s needed the most",
p2: "Healthy nutrition for pre-school children"
}
}
} });
const setCampaign = (event: WidgetEvent) => {
const api = event.data.api
const data = api.paymentForm.data
data.stored_campaign_id = 5678
data.stored_campaign_subid = 4321
}
window.rnw.tamaro.events.beforePaymentSend.subscribe(setCampaign)
Recurring gift donation
For recurring payments, it is possible to transfer them to SEXTANT as a gift from a payer to a recipient.
Recipient person attributes
To transfer recipient data to SEXTANT, you need to define custom fields for each recipient field: https://support.raisenow.com/hc/en-us/articles/360011968978-Adding-Custom-Fields-and-hidden-parameters
Additionally, you can set whether to send the gift document to the payer or the recipient. This can be implemented as a checkbox selectable by the donor.
Example:
window.rnw.tamaro.runWidget('.rnw-widget-container', { debug: true, paymentFormPrefill: { stored_sxt_send_document_to_payer: false, }, translations: { en: { payment_form: { stored_sxt_send_document_to_payer: 'Please send the gift document to me', }, }, }, slots: { profile_form_end: [{ component: "field", type: "checkbox", name: "stored_sxt_send_document_to_payer", text: "payment_form.stored_sxt_send_document_to_payer", }, ]}, });
Event payment
In the RaiseNow integration towards SEXTANT, you can transfer event payments with a recipient (similar to recurring gift donations) and additional event parameters.
The additional event parameters are: stored_donation_type, stored_sxt_event_description_1, stored_sxt_event_description_2 and stored_sxt_event_description_3
stored_donation_type
Describes the type of an event payment (e.g., "event", "in-memoria"). You can set it on a landing page as a hidden parameter or make the donation type selectable by the donor.
window.rnw.tamaro.runWidget('.rnw-widget-container', { debug: true, paymentFormPrefill: { stored_donation_type: null, }, translations: { en: { payment_form: { stored_donation_type: 'Donation type', drop_donations_options: { event: "Event", in_memoria: "In memoria" } }, }, }, slots: { profile_form_start: [{ component: "field", type: "select", name: "stored_donation_type", label: "payment_form.stored_donation_type", options: [ {value: 'event', label: 'payment_form.drop_donations_options.event'}, {value: 'in_memoria', label: 'payment_form.drop_donations_options.in_memoria'} ], }, ]}, });
stored_sxt_event_description_1
The first field for describing the event. You can use a custom field as text or select.
- In case of a donation in memoria SEXTANT here needs the Firstname of the deceased person.
- In case of a simple event payment you can make it selectable: birthday, wedding, other, …
stored_sxt_event_description_2
The second field for describing the event. You can use a custom field as text or select.
- In case of a donation in memoria SEXTANT here needs the Lastname of the deceased person.
- In case of a simple event payment a donor can set things like: "Wedding of Jane and John", "Birthday of John", …
stored_sxt_event_description_3
The third field for describing the event. You can set it statically on the landing page or use a free text field for the donor to provide additional information.
P2P campaign
If you have a RaiseNow P2P platform, you need to adjust the identifier for each purpose (campaign) within the P2P platform. It should match the SEXTANT's PaymentOptionShortname in the creation of a newly created P2P campaign by a fundraiser. This ensures that a new P2P campaign is created correctly in SEXTANT and each donation of that campaign can be matched easily by SEXTANT.
Note that both fields campaign_id and campaign_subid must be set due to restrictions set by the P2P platform. However, only campaign_suibid will be used in the process with SEXTANT as the PaymentOption.
RaiseNow Hub
To differentiate between different campaigns on self-service created touchpoint solutions, you can set a campaignId and campaignSubId on those touchpoints. Refer to the following link for more information: https://support.raisenow.com/hc/en-us/articles/360010007998-How-can-I-differentiate-between-different-campaigns-
Comments
0 comments
Article is closed for comments.