{ "sections": [ "title", "description", "file_information", "directory_location", "fields", "declarative_metadata_sample_definition" ], "title": "GiftEntryGridTemplate - Metadata API", "description": "Represents templates that customize the gift entry grid in Fundraising.", "file_information": ".giftEntryGridTempate", "directory_location": "giftEntryGridTemplate", "fields_columns": [ "type", "properties", "description" ], "fields": { "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": [ { "description": "The following is an example of a GiftEntryGridTemplate component.", "code": "\n\n Demo of Default Template\n Demo_of_Default_Template\n false\n Demo of Default Template\n templateName: Demo of Default Template\napiVersion: 66.0\ncolumns:\n -\n columnId: Donor\n columnType: Component\n columnField:\n sourceField: DonorId\n isFieldRequired: true\n isFieldHidden: false\n columnComponent:\n componentNameDisplay: runtime_industries_frops/giftEntryGridColumnDisplay\n componentNameEdit: runtime_industries_frops/giftEntryGridLookup\n columnModal:\n modalTitleLabel: $Label.GiftEntryGrid.AddDonorDetailsModalTitle\n modalComponent:\n componentName: runtime_industries_frops/giftEntryGridFieldsModal\n modalIcon:\n expandIcon: utility:expand_alt\n expandIconAltText: $Label.GiftEntryGrid.DonorExpandIconAltText\n lockIcon: utility:lock\n lockIconAltText: $Label.GiftEntryGrid.LockIconAltText\n noIconAltText: ""\n isModalReadOnly: false\n modalAltTitleLabel: $Label.GiftEntryGrid.EditDonorDetailsModalTitle\n modalAltTitleLabelVisibilityRule:\n -\n field: DonorId\n values:\n - null\n operator: NOT_EQUALS\n multipleRulesEvaluationOperator: AND\n modalFields:\n -\n sourceField: GiftType\n fieldLabel: $Label.GiftEntryGrid.DonorType\n isFieldRequired: true\n isFieldHidden: false\n defaultValue: Individual\n fieldReadOnlyRule:\n -\n field: DonorId\n values:\n - null\n operator: NOT_EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: OrganizationName\n isFieldRequired: true\n isFieldHidden: false\n visibilityRules:\n -\n field: GiftType\n values:\n - Organizational\n operator: EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: Salutation\n isFieldRequired: false\n isFieldHidden: false\n visibilityRules:\n -\n field: GiftType\n values:\n - Individual\n operator: EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: FirstName\n isFieldRequired: false\n isFieldHidden: false\n visibilityRules:\n -\n field: GiftType\n values:\n - Individual\n operator: EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: LastName\n isFieldRequired: true\n isFieldHidden: false\n visibilityRules:\n -\n field: GiftType\n values:\n - Individual\n operator: EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: Email\n isFieldRequired: false\n isFieldHidden: false\n visibilityRules:\n -\n field: GiftType\n values:\n - Individual\n operator: EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: HomePhone\n isFieldRequired: false\n isFieldHidden: false\n visibilityRules:\n -\n field: GiftType\n values:\n - Individual\n operator: EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: MobilePhone\n isFieldRequired: false\n isFieldHidden: false\n visibilityRules:\n -\n field: GiftType\n values:\n - Individual\n operator: EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: MobilePhone\n fieldLabel: $Label.GiftEntryGrid.OrganizationPhone\n isFieldRequired: false\n isFieldHidden: false\n visibilityRules:\n -\n field: GiftType\n values:\n - Organizational\n operator: EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: Street\n isFieldRequired: false\n isFieldHidden: false\n -\n sourceField: City\n isFieldRequired: false\n isFieldHidden: false\n -\n sourceField: State\n isFieldRequired: false\n isFieldHidden: false\n -\n sourceField: PostalCode\n isFieldRequired: false\n isFieldHidden: false\n -\n sourceField: Country\n isFieldRequired: false\n isFieldHidden: false\n isColumnHidden: false\n isColumnReadOnly: false\n columnWidth: 240\n columnLabel: $Label.GiftEntryGrid.DonorLookup\n -\n columnId: GiftReceivedDate\n columnType: Field\n columnField:\n sourceField: GiftReceivedDate\n isFieldRequired: true\n isFieldHidden: false\n isColumnHidden: false\n isColumnReadOnly: false\n columnWidth: 180\n columnLabel: GiftReceivedDate\n -\n columnId: Commitments\n columnType: Component\n columnField:\n sourceField: GiftCommitmentId\n isFieldRequired: false\n isFieldHidden: false\n columnComponent:\n componentNameDisplay: runtime_industries_frops/giftEntryGridColumnDisplay\n componentNameEdit: runtime_industries_frops/giftEntryGridCommitmentColEdit\n columnModal:\n modalTitleLabel: $Label.GiftEntryGrid.NewCommitmentModalTitle\n modalComponent:\n componentName: runtime_industries_frops/giftEntryGridFieldsModal\n modalIcon:\n expandIcon: utility:expand_alt\n expandIconAltText: $Label.GiftEntryGrid.CommitmentExpandIconAltText\n lockIcon: utility:lock\n lockIconAltText: $Label.GiftEntryGrid.LockIconAltText\n noIconAltText: ""\n isModalReadOnly: false\n modalAltTitleLabel: $Label.GiftEntryGrid.ViewCommitmentModalTitle\n modalAltTitleLabelVisibilityRule:\n -\n field: GiftCommitmentId\n values:\n - null\n operator: NOT_EQUALS\n multipleRulesEvaluationOperator: AND\n modalFields:\n -\n sourceField: EffectiveStartDate\n fieldLabel: $Label.GiftEntryGrid.CommitmentEffectiveStartDateLabel\n isFieldRequired: true\n isFieldHidden: false\n fieldReadOnlyRule:\n -\n field: GiftCommitmentId\n values:\n - null\n operator: NOT_EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: ExpectedEndDate\n fieldLabel: $Label.GiftEntryGrid.CommitmentExpectedEndDateLabel\n isFieldRequired: false\n isFieldHidden: false\n fieldReadOnlyRule:\n -\n field: GiftCommitmentId\n values:\n - null\n operator: NOT_EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: TransactionPeriod\n isFieldRequired: true\n isFieldHidden: false\n fieldReadOnlyRule:\n -\n field: GiftCommitmentId\n values:\n - null\n operator: NOT_EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: TransactionInterval\n isFieldRequired: true\n isFieldHidden: false\n fieldReadOnlyRule:\n -\n field: GiftCommitmentId\n values:\n - null\n operator: NOT_EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: TransactionDay\n isFieldRequired: true\n isFieldHidden: false\n visibilityRules:\n -\n field: TransactionPeriod\n values:\n - Monthly\n operator: EQUALS\n multipleRulesEvaluationOperator: AND\n fieldReadOnlyRule:\n -\n field: GiftCommitmentId\n values:\n - null\n operator: NOT_EQUALS\n multipleRulesEvaluationOperator: AND\n isColumnHidden: false\n isColumnReadOnly: false\n columnWidth: 240\n columnLabel: $Label.GiftEntryGrid.CommitmentColumnLabel\n -\n columnId: GiftAmount\n columnType: Field\n columnField:\n sourceField: GiftAmount\n isFieldRequired: false\n isFieldHidden: false\n isColumnHidden: false\n isColumnReadOnly: false\n columnWidth: 160\n columnLabel: GiftAmount\n -\n columnId: PaymentMethod\n columnType: Field\n columnField:\n sourceField: PaymentMethod\n isFieldRequired: true\n isFieldHidden: false\n columnModal:\n modalTitleLabel: $Label.GiftEntryGrid.PaymentInformationModalTitle\n modalComponent:\n componentName: runtime_industries_frops/giftEntryGridFieldsModal\n modalIcon:\n expandIcon: utility:expand_alt\n expandIconAltText: $Label.GiftEntryGrid.PaymentMethodIconAltText\n lockIcon: utility:lock\n lockIconAltText: $Label.GiftEntryGrid.LockIconAltText\n noIconAltText: ""\n isModalReadOnly: false\n modalFields:\n -\n sourceField: PaymentMethod\n isFieldRequired: true\n isFieldHidden: false\n -\n sourceField: Last4\n isFieldRequired: false\n isFieldHidden: false\n visibilityRules:\n -\n field: PaymentMethod\n values:\n - Credit Card\n - ACH\n operator: EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: ExpiryMonth\n isFieldRequired: false\n isFieldHidden: false\n visibilityRules:\n -\n field: PaymentMethod\n values:\n - Credit Card\n operator: EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: ExpiryYear\n isFieldRequired: false\n isFieldHidden: false\n visibilityRules:\n -\n field: PaymentMethod\n values:\n - Credit Card\n operator: EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: CheckDate\n isFieldRequired: false\n isFieldHidden: false\n visibilityRules:\n -\n field: PaymentMethod\n values:\n - Check\n operator: EQUALS\n multipleRulesEvaluationOperator: AND\n -\n sourceField: PaymentIdentifier\n isFieldRequired: false\n isFieldHidden: false\n visibilityRules:\n -\n field: PaymentMethod\n values:\n - Check\n operator: EQUALS\n multipleRulesEvaluationOperator: AND\n isColumnHidden: false\n isColumnReadOnly: false\n columnWidth: 180\n columnLabel: PaymentMethod\n -\n columnId: OutreachSourceCode\n columnType: Field\n columnField:\n sourceField: OutreachSourceCodeId\n isFieldRequired: false\n isFieldHidden: false\n isColumnHidden: false\n isColumnReadOnly: false\n columnWidth: 200\n columnLabel: $Label.GiftEntryGrid.OutreachSourceCodeLookup\n -\n columnId: Campaign\n columnType: Field\n columnField:\n sourceField: CampaignId\n isFieldRequired: false\n isFieldHidden: false\n isColumnHidden: false\n isColumnReadOnly: false\n columnWidth: 200\n columnLabel: $Label.GiftEntryGrid.CampaignLookup\n -\n columnId: Designations\n columnType: Component\n columnField:\n sourceField: GiftDesignation1Id\n isFieldRequired: false\n isFieldHidden: false\n columnComponent:\n componentNameDisplay: runtime_industries_frops/giftEntryGridColumnDisplay\n componentNameEdit: runtime_industries_frops/giftEntryGridLookup\n columnModal:\n modalTitleLabel: $Label.GiftEntryGrid.DesignationsModalTitle\n modalComponent:\n componentName: runtime_industries_frops/giftEntryGridDesignation\n modalIcon:\n expandIcon: utility:expand_alt\n expandIconAltText: $Label.GiftEntryGrid.DesignationExpandIconAltText\n lockIcon: utility:lock\n lockIconAltText: $Label.GiftEntryGrid.LockIconAltText\n noIconAltText: ""\n isModalReadOnly: false\n isColumnHidden: false\n isColumnReadOnly: false\n columnWidth: 240\n columnLabel: $Label.GiftEntryGrid.DesignationsLookup\n -\n columnId: SoftCredits\n columnType: Component\n columnField:\n sourceField: RecipientId\n isFieldRequired: false\n isFieldHidden: false\n columnComponent:\n componentNameDisplay: runtime_industries_frops/giftEntryGridColumnDisplay\n componentNameEdit: runtime_industries_frops/giftEntryGridLookup\n columnModal:\n modalTitleLabel: $Label.GiftEntryGrid.SoftCreditsModalTitle\n modalComponent:\n componentName: runtime_industries_frops/giftEntryGridSoftCredit\n modalIcon:\n expandIcon: utility:expand_alt\n expandIconAltText: $Label.GiftEntryGrid.SoftCreditsExpandIconAltText\n lockIcon: utility:lock\n lockIconAltText: $Label.GiftEntryGrid.LockIconAltText\n noIconAltText: ""\n isModalReadOnly: false\n isColumnHidden: false\n isColumnReadOnly: false\n columnWidth: 240\n columnLabel: $Label.GiftEntryGrid.SoftCreditsLookup\n" } ] }