GiftEntryGridTemplate

Represents templates that customize the gift entry grid in Fundraising.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

GiftEntryGridTemplate components have the suffix .giftEntryGridTempate and are stored in the giftEntryGridTemplate folder.

Version

GiftEntryGridTemplate components are available in API version 66.0 and later.

Special Access Rules

This object is available only if the Fundraising Access license is enabled, the Fundraising User system permission is assigned to users, and the Gift Entry Grid is enabled.

Fields

Field Name	Description
Description	Type textarea Properties Create, Nillable, Update Description The description of the gift entry grid template.
IsSingleGiftDefault	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the template is the default template for single gift entry (true) or not (false, the default).
TemplateConfiguration	Type string Properties Create, Filter, Group, Sort, Update Description The template configuration that includes the data for fields, columns, and components.

Declarative Metadata Sample Definition

The following is an example of a GiftEntryGridTemplate component.

1<?xml version="1.0" encoding="UTF-8"?>
2<GiftEntryGridTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>Demo of Default Template</description>
4    <developerName>Demo_of_Default_Template</developerName>
5    <isSingleGiftDefault>false</isSingleGiftDefault>
6    <masterLabel>Demo of Default Template</masterLabel>
7    <templateConfiguration>templateName: Demo of Default Template
8apiVersion: 66.0
9columns:
10 -
11  columnId: Donor
12  columnType: Component
13  columnField:
14    sourceField: DonorId
15    isFieldRequired: true
16    isFieldHidden: false
17  columnComponent:
18    componentNameDisplay: runtime_industries_frops/giftEntryGridColumnDisplay
19    componentNameEdit: runtime_industries_frops/giftEntryGridLookup
20  columnModal:
21    modalTitleLabel: $Label.GiftEntryGrid.AddDonorDetailsModalTitle
22    modalComponent:
23      componentName: runtime_industries_frops/giftEntryGridFieldsModal
24    modalIcon:
25      expandIcon: utility:expand_alt
26      expandIconAltText: $Label.GiftEntryGrid.DonorExpandIconAltText
27      lockIcon: utility:lock
28      lockIconAltText: $Label.GiftEntryGrid.LockIconAltText
29      noIconAltText: &quot;&quot;
30    isModalReadOnly: false
31    modalAltTitleLabel: $Label.GiftEntryGrid.EditDonorDetailsModalTitle
32    modalAltTitleLabelVisibilityRule:
33     -
34      field: DonorId
35      values:
36       - null
37      operator: NOT_EQUALS
38      multipleRulesEvaluationOperator: AND
39    modalFields:
40     -
41      sourceField: GiftType
42      fieldLabel: $Label.GiftEntryGrid.DonorType
43      isFieldRequired: true
44      isFieldHidden: false
45      defaultValue: Individual
46      fieldReadOnlyRule:
47       -
48        field: DonorId
49        values:
50         - null
51        operator: NOT_EQUALS
52        multipleRulesEvaluationOperator: AND
53     -
54      sourceField: OrganizationName
55      isFieldRequired: true
56      isFieldHidden: false
57      visibilityRules:
58       -
59        field: GiftType
60        values:
61         - Organizational
62        operator: EQUALS
63        multipleRulesEvaluationOperator: AND
64     -
65      sourceField: Salutation
66      isFieldRequired: false
67      isFieldHidden: false
68      visibilityRules:
69       -
70        field: GiftType
71        values:
72         - Individual
73        operator: EQUALS
74        multipleRulesEvaluationOperator: AND
75     -
76      sourceField: FirstName
77      isFieldRequired: false
78      isFieldHidden: false
79      visibilityRules:
80       -
81        field: GiftType
82        values:
83         - Individual
84        operator: EQUALS
85        multipleRulesEvaluationOperator: AND
86     -
87      sourceField: LastName
88      isFieldRequired: true
89      isFieldHidden: false
90      visibilityRules:
91       -
92        field: GiftType
93        values:
94         - Individual
95        operator: EQUALS
96        multipleRulesEvaluationOperator: AND
97     -
98      sourceField: Email
99      isFieldRequired: false
100      isFieldHidden: false
101      visibilityRules:
102       -
103        field: GiftType
104        values:
105         - Individual
106        operator: EQUALS
107        multipleRulesEvaluationOperator: AND
108     -
109      sourceField: HomePhone
110      isFieldRequired: false
111      isFieldHidden: false
112      visibilityRules:
113       -
114        field: GiftType
115        values:
116         - Individual
117        operator: EQUALS
118        multipleRulesEvaluationOperator: AND
119     -
120      sourceField: MobilePhone
121      isFieldRequired: false
122      isFieldHidden: false
123      visibilityRules:
124       -
125        field: GiftType
126        values:
127         - Individual
128        operator: EQUALS
129        multipleRulesEvaluationOperator: AND
130     -
131      sourceField: MobilePhone
132      fieldLabel: $Label.GiftEntryGrid.OrganizationPhone
133      isFieldRequired: false
134      isFieldHidden: false
135      visibilityRules:
136       -
137        field: GiftType
138        values:
139         - Organizational
140        operator: EQUALS
141        multipleRulesEvaluationOperator: AND
142     -
143      sourceField: Street
144      isFieldRequired: false
145      isFieldHidden: false
146     -
147      sourceField: City
148      isFieldRequired: false
149      isFieldHidden: false
150     -
151      sourceField: State
152      isFieldRequired: false
153      isFieldHidden: false
154     -
155      sourceField: PostalCode
156      isFieldRequired: false
157      isFieldHidden: false
158     -
159      sourceField: Country
160      isFieldRequired: false
161      isFieldHidden: false
162  isColumnHidden: false
163  isColumnReadOnly: false
164  columnWidth: 240
165  columnLabel: $Label.GiftEntryGrid.DonorLookup
166 -
167  columnId: GiftReceivedDate
168  columnType: Field
169  columnField:
170    sourceField: GiftReceivedDate
171    isFieldRequired: true
172    isFieldHidden: false
173  isColumnHidden: false
174  isColumnReadOnly: false
175  columnWidth: 180
176  columnLabel: GiftReceivedDate
177 -
178  columnId: Commitments
179  columnType: Component
180  columnField:
181    sourceField: GiftCommitmentId
182    isFieldRequired: false
183    isFieldHidden: false
184  columnComponent:
185    componentNameDisplay: runtime_industries_frops/giftEntryGridColumnDisplay
186    componentNameEdit: runtime_industries_frops/giftEntryGridCommitmentColEdit
187  columnModal:
188    modalTitleLabel: $Label.GiftEntryGrid.NewCommitmentModalTitle
189    modalComponent:
190      componentName: runtime_industries_frops/giftEntryGridFieldsModal
191    modalIcon:
192      expandIcon: utility:expand_alt
193      expandIconAltText: $Label.GiftEntryGrid.CommitmentExpandIconAltText
194      lockIcon: utility:lock
195      lockIconAltText: $Label.GiftEntryGrid.LockIconAltText
196      noIconAltText: &quot;&quot;
197    isModalReadOnly: false
198    modalAltTitleLabel: $Label.GiftEntryGrid.ViewCommitmentModalTitle
199    modalAltTitleLabelVisibilityRule:
200     -
201      field: GiftCommitmentId
202      values:
203       - null
204      operator: NOT_EQUALS
205      multipleRulesEvaluationOperator: AND
206    modalFields:
207     -
208      sourceField: EffectiveStartDate
209      fieldLabel: $Label.GiftEntryGrid.CommitmentEffectiveStartDateLabel
210      isFieldRequired: true
211      isFieldHidden: false
212      fieldReadOnlyRule:
213       -
214        field: GiftCommitmentId
215        values:
216         - null
217        operator: NOT_EQUALS
218        multipleRulesEvaluationOperator: AND
219     -
220      sourceField: ExpectedEndDate
221      fieldLabel: $Label.GiftEntryGrid.CommitmentExpectedEndDateLabel
222      isFieldRequired: false
223      isFieldHidden: false
224      fieldReadOnlyRule:
225       -
226        field: GiftCommitmentId
227        values:
228         - null
229        operator: NOT_EQUALS
230        multipleRulesEvaluationOperator: AND
231     -
232      sourceField: TransactionPeriod
233      isFieldRequired: true
234      isFieldHidden: false
235      fieldReadOnlyRule:
236       -
237        field: GiftCommitmentId
238        values:
239         - null
240        operator: NOT_EQUALS
241        multipleRulesEvaluationOperator: AND
242     -
243      sourceField: TransactionInterval
244      isFieldRequired: true
245      isFieldHidden: false
246      fieldReadOnlyRule:
247       -
248        field: GiftCommitmentId
249        values:
250         - null
251        operator: NOT_EQUALS
252        multipleRulesEvaluationOperator: AND
253     -
254      sourceField: TransactionDay
255      isFieldRequired: true
256      isFieldHidden: false
257      visibilityRules:
258       -
259        field: TransactionPeriod
260        values:
261         - Monthly
262        operator: EQUALS
263        multipleRulesEvaluationOperator: AND
264      fieldReadOnlyRule:
265       -
266        field: GiftCommitmentId
267        values:
268         - null
269        operator: NOT_EQUALS
270        multipleRulesEvaluationOperator: AND
271  isColumnHidden: false
272  isColumnReadOnly: false
273  columnWidth: 240
274  columnLabel: $Label.GiftEntryGrid.CommitmentColumnLabel
275 -
276  columnId: GiftAmount
277  columnType: Field
278  columnField:
279    sourceField: GiftAmount
280    isFieldRequired: false
281    isFieldHidden: false
282  isColumnHidden: false
283  isColumnReadOnly: false
284  columnWidth: 160
285  columnLabel: GiftAmount
286 -
287  columnId: PaymentMethod
288  columnType: Field
289  columnField:
290    sourceField: PaymentMethod
291    isFieldRequired: true
292    isFieldHidden: false
293  columnModal:
294    modalTitleLabel: $Label.GiftEntryGrid.PaymentInformationModalTitle
295    modalComponent:
296      componentName: runtime_industries_frops/giftEntryGridFieldsModal
297    modalIcon:
298      expandIcon: utility:expand_alt
299      expandIconAltText: $Label.GiftEntryGrid.PaymentMethodIconAltText
300      lockIcon: utility:lock
301      lockIconAltText: $Label.GiftEntryGrid.LockIconAltText
302      noIconAltText: &quot;&quot;
303    isModalReadOnly: false
304    modalFields:
305     -
306      sourceField: PaymentMethod
307      isFieldRequired: true
308      isFieldHidden: false
309     -
310      sourceField: Last4
311      isFieldRequired: false
312      isFieldHidden: false
313      visibilityRules:
314       -
315        field: PaymentMethod
316        values:
317         - Credit Card
318         - ACH
319        operator: EQUALS
320        multipleRulesEvaluationOperator: AND
321     -
322      sourceField: ExpiryMonth
323      isFieldRequired: false
324      isFieldHidden: false
325      visibilityRules:
326       -
327        field: PaymentMethod
328        values:
329         - Credit Card
330        operator: EQUALS
331        multipleRulesEvaluationOperator: AND
332     -
333      sourceField: ExpiryYear
334      isFieldRequired: false
335      isFieldHidden: false
336      visibilityRules:
337       -
338        field: PaymentMethod
339        values:
340         - Credit Card
341        operator: EQUALS
342        multipleRulesEvaluationOperator: AND
343     -
344      sourceField: CheckDate
345      isFieldRequired: false
346      isFieldHidden: false
347      visibilityRules:
348       -
349        field: PaymentMethod
350        values:
351         - Check
352        operator: EQUALS
353        multipleRulesEvaluationOperator: AND
354     -
355      sourceField: PaymentIdentifier
356      isFieldRequired: false
357      isFieldHidden: false
358      visibilityRules:
359       -
360        field: PaymentMethod
361        values:
362         - Check
363        operator: EQUALS
364        multipleRulesEvaluationOperator: AND
365  isColumnHidden: false
366  isColumnReadOnly: false
367  columnWidth: 180
368  columnLabel: PaymentMethod
369 -
370  columnId: OutreachSourceCode
371  columnType: Field
372  columnField:
373    sourceField: OutreachSourceCodeId
374    isFieldRequired: false
375    isFieldHidden: false
376  isColumnHidden: false
377  isColumnReadOnly: false
378  columnWidth: 200
379  columnLabel: $Label.GiftEntryGrid.OutreachSourceCodeLookup
380 -
381  columnId: Campaign
382  columnType: Field
383  columnField:
384    sourceField: CampaignId
385    isFieldRequired: false
386    isFieldHidden: false
387  isColumnHidden: false
388  isColumnReadOnly: false
389  columnWidth: 200
390  columnLabel: $Label.GiftEntryGrid.CampaignLookup
391 -
392  columnId: Designations
393  columnType: Component
394  columnField:
395    sourceField: GiftDesignation1Id
396    isFieldRequired: false
397    isFieldHidden: false
398  columnComponent:
399    componentNameDisplay: runtime_industries_frops/giftEntryGridColumnDisplay
400    componentNameEdit: runtime_industries_frops/giftEntryGridLookup
401  columnModal:
402    modalTitleLabel: $Label.GiftEntryGrid.DesignationsModalTitle
403    modalComponent:
404      componentName: runtime_industries_frops/giftEntryGridDesignation
405    modalIcon:
406      expandIcon: utility:expand_alt
407      expandIconAltText: $Label.GiftEntryGrid.DesignationExpandIconAltText
408      lockIcon: utility:lock
409      lockIconAltText: $Label.GiftEntryGrid.LockIconAltText
410      noIconAltText: &quot;&quot;
411    isModalReadOnly: false
412  isColumnHidden: false
413  isColumnReadOnly: false
414  columnWidth: 240
415  columnLabel: $Label.GiftEntryGrid.DesignationsLookup
416 -
417  columnId: SoftCredits
418  columnType: Component
419  columnField:
420    sourceField: RecipientId
421    isFieldRequired: false
422    isFieldHidden: false
423  columnComponent:
424    componentNameDisplay: runtime_industries_frops/giftEntryGridColumnDisplay
425    componentNameEdit: runtime_industries_frops/giftEntryGridLookup
426  columnModal:
427    modalTitleLabel: $Label.GiftEntryGrid.SoftCreditsModalTitle
428    modalComponent:
429      componentName: runtime_industries_frops/giftEntryGridSoftCredit
430    modalIcon:
431      expandIcon: utility:expand_alt
432      expandIconAltText: $Label.GiftEntryGrid.SoftCreditsExpandIconAltText
433      lockIcon: utility:lock
434      lockIconAltText: $Label.GiftEntryGrid.LockIconAltText
435      noIconAltText: &quot;&quot;
436    isModalReadOnly: false
437  isColumnHidden: false
438  isColumnReadOnly: false
439  columnWidth: 240
440  columnLabel: $Label.GiftEntryGrid.SoftCreditsLookup</templateConfiguration>
441</GiftEntryGridTemplate>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>GiftEntryGridTemplate</name>
6    </types>
7    <version>66.0</version>
8</Package>

Metadata API Developer Guide