Customer Subsystem Application Parameters

The following table describes the application parameters for the CUS and MRM subsystem. Prior to working with customers, you need to define the Parameter Value for each applicable parameter. For more information on application parameters, please see Setting Up Application Parameters.

Parameter

Default Value

Description

ADDR_VALIDATION_PIP_ATTRIBUTES

Cong_Dist

As of 7.5.2, this is a comma separated list of attributes which the PBBI Point In Polygon service returns from the server.

 

With every Point In Polygon database provided by PBBI, the attributes returned by the service are listed in the accompanying documentation. Those attributes should be comma separated in this parameter to enable the data to be returned back to the corresponding Personify columns.

 

With the base delivery, Cong_Dist is returned by default. If any additional fields are needed, the APIs would need to be modified to allow Personify to save the data.

 

If you want to use additional columns, you need to add the columns to this parameter list, make the columns available in the dataflow service via the Enterprise Designer, and override the “ValidateAddress” function in the CustomerAddress API in the clients Customer Layer, as shown below.

Dim strColumnValues As String = CType(oAddressResponse, TIMSS.Server.CDQP.Messages.UserDefinedAddressValidationResponse).UserNeededColumnValues

If Not String.IsNullOrWhiteSpace(strColumnValues) Then

Dim iCount As Short

For Each strColValue As String In strColumnValues.Split(",")

iCount += 1

Select Case iCount

Case 1

CongressionalDistrict = strColValue

‘Need to add different cases here.

End Select

Next

End If

  

For more information on congressional districts, please see Installing Congressional Districts.

ADDR_VALIDATION_PIP_DB_NAME

CON112013

Identifies the database name for the Point In Polygon stage.

 

The Point In Polygon stage runs against a Database provided by PBBI. If the user defined address validation service has a Point In polygon stage, then this parameter must have the name of the Point In Polygon DB.

 

For more information on congressional districts, please see Installing Congressional Districts.

ADDR_VALIDATION_SERVICE_NAME

ValidateAddressGeocodeUSAddress

Identifies the user defined service name for address validation.

 

If a user wants to change the address validation logic they would need to create their own address validation service and provide the name of the service in this parameter. They would also need to update the ADDR_VALIDATION_PIP_DB_NAME and ADDR_VALIDATION_PIP_ATTRIBUTES if there is a Point In Polygon stage in the service.

The CUS530 dataflow uses the ValidateAddressGeocodeUSAddress service. If you want to use a different service for the front-end address validation, you can set that service here, but CUS530 will continue to use ValidateAddressGeocodeUSAddress.

For more information on congressional districts, please see Installing Congressional Districts.

CALCULATE_CRM360_BALANCE

Y

Identifies whether the calculation of the customer’s balance that appears in the Overview section on CRM360 should be turned on or off. Set this parameter to "Y" to calculate the balance. Set this parameter to "N" to turn off the calculation. Base is delivered with this set to "Y".

CALCULATE_CRM360_ENGAGEMENT_SCORE_POINTS

Y

Identifies whether the calculation of engagement score points that appears in the Overview section on CRM360 should be turned on or off. Set this parameter to "Y" to calculate the engagement score points. Set this parameter to "N" to turn off the calculation. Base is delivered with this set to "Y".

CALCULATE_CRM360_INVOLVEMENT

Y

Identifies whether the calculation of the customer’s involvement that appears in the Overview section on CRM360 should be turned on or off. The Involvement section lists memberships and committee service. Set this parameter to "Y" to calculate the involvement. Set this parameter to "N" to turn off the calculation. Base is delivered with this set to "Y".

CALCULATE_CRM360_SPENDING

Y

Identifies whether the calculation of the customer’s spending that appears in the Overview section on CRM360 should be turned on or off. Set this parameter to "Y" to calculate the spending. Set this parameter to "N" to turn off the calculation. Base is delivered with this set to "Y".

CALLCENTER_ORDTAB_DEFAULT

ORDINVOICED

If ORDINVOICED is selected, the Invoiced Balance option is selected on the Orders tab. If ORDALL is selected, the All Orders option is selected on the Orders tab.

CHECKDUPLEMAIL

Y

Enables a duplicate primary email address check for a customer. For more information on duplicates, please see the Duplicate Customers section.

As of 7.5.2, this parameter will determine on the Guest Email Lookup, Membership Join Registration, Membership Join User Already Exists, Registration, and User Already Exists controls in e-Business whether the same email address can be shared by multiple web users. If you set this parameter to 'N" (you allow duplicate emails), multiple users can share the same email address. In addition, if you allow web users to share the same email address, you should NOT set the application parameter WEBUSERNAME_FORMAT to "CUSTOMER_EMAIL_ADDRESS".

COMMITTEE_TREE_RELATIONSHIP_TYPE

COMMITTEE

Determines the relationship type used to create the hierarchal tree. You can enter either a committee, corporation, or subgroup. In addition, if you create a new relationship type, you need to add it here, so the relationship tree will be created.

COMPANY_TREE_RELATIONSHIP_TYPE

CORPORATE

Determines the relationship type used to create the hierarchal tree that is generated from CRM360 when a user opens a customer record.

CRM360_OVERVIEW_YEARS

3

Indicates the number of years back that the system should calculate engagement score points and spending. Calculations start on the first of the year. For example, if this is set to 3, the system will calculate points and spending starting on January 1st of the current year minus 3. If the current year is 2015, the calculations for points and spending will select orders and activities that occurred on or after January 1, 2012. Base is delivered with this set to "3".

CRM360_ROLLUP_EMPLOYEES_TO_EMPLOYER

N

Identifies whether spending totals and engagement scores of employees should roll up to the employer. Base is delivered with this set to "N"; set to "Y" to have spending amounts and engagement scores of employees included in spending and engagement score of employer companies.

CRM360_YTD_START_MONTH

1

The start month for spending and score year-to-date (YTD) calculations displayed in the Overview section in CRM360. For example, if your fiscal year starts in June, enter 6 for this value. Base is delivered with this set to "1".

CUSTOMER_ID_LENGTH

12

Length of the customer ID. Please note that once this value has been set, it can not be changed. In addition, as a best practice, this should not be set to a low value (e.g., 1, 2, 3, etc.).

As of 7.4.2, the MKT500 process looks at this parameter and supports Master Customer IDs with the number of characters defined here.

DEDUP

SOUNDEX

Selects the criteria based on the functionality you use to identify a duplicate customer using the CUS590 process. You can enter either SOUNDEX or PHONETIC.  These options are methods by which to establish duplicate criteria when you run the CUS590 process. Soundex is less restrictive and will produce more potential duplicates, whereas Phonetic is more restrictive and will produce less potential duplicates. See Soundex vs. Phonetic for more information.    

DEDUP_CDQPSERVICE

DuplicateMatching- [Database Name]-PDQASQL

This is the name of a service published in CDQP, which will be used for fetching duplicate records and uses the dedup logic. Please note that the service name is CASE sensitive. For more information on duplicates, please see the Duplicate Customers section.

DEFAULT_BILL_PRIMARY_EMPLOYER

N

When new customers are created, the system will automatically default the "Bill Primary Employer" checkbox to checked on the Demographics screen in CRM360. For every new order for this customer, the current primary employer relationship customer will be the bill-to customer on the order.

DUPADDRESSCHECK

N

If set to "N", the Merge Verified Duplicates (CUS595) batch process moves the CUS_ADDRESS_DETAIL and CUS_ADDRESS_DETAIL_KEY_LINE records from the duplicate company customer to the retained company customer.

  

If set to "Y", the Merge Verified Duplicates (CUS595) batch process deletes both the CUS_ADDRESS_DETAIL and CUS_ADDRESS_DETAIL_KEY_LINE records from the duplicate company customer which causes the CUS_ADDRESS_DETAIL and CUS_ADDRESS_DETAIL_KEY_LINE record for the individual customer to be updated with the CUS_ADDRESS_ID of the retained company customer.

EXISTING_CUSTOMER_NEW_EMPLOYER_RULE

KEEP

This identifies whether existing employment relationship(s) to other company(ies) should be ended or kept when a group manager selects an existing customer as an employee and creates a new employment relationship for him/her. See Customer Segmentation for more information.

  

If this parameter is set to "END", the other employment relationship is ended. In addition, if the selected customer had a linked address to a company where the employment relationship is being ended, the linked address is marked as BAD and the Cus_Address_Detail.MANUAL_BAD_STATUS_FLAG is set to Y. Set this parameter to "KEEP" to leave the existing employment relationships as is.

INCLUDE_PREFIX_IN_LABELNAME

Y

If set to "Y", the customer's Prefix, which is defined on the Individual Name Edit screen, will be included in the formatted label name, which displays on the Individual Name Edit screen, in the header on CRM360, and on the Add/Edit Address screen. Please note that changing this application parameter will only affect new records, not existing.

MAINTAIN_ADDR_KEY_LINE_ID_DAYS

90

Identifies the minimum number of days that the unique address key line ID will be maintained.

 

For customers using the U.S. Postal Service's (USPS) Address Change Service, the USPS requires that the organization maintain a unique identifier for the address for at least 45 days; therefore, the value in this parameter should not be set less than 45. Base is delivered with this value set to 90, so that organizations have plenty of time to process Address Change Service data received from the post office. In Personify, the unique address identifier is the address key line ID (Cus_Address_Detail_Key_Line.CURRENT_KEY_LINE_ID).

MAX_ADDR_KEY_LINE_ID_LENGTH

6

The length of the unique identifier for a customer?s address that is used by the U.S. Postal Service's Address Change Service.

 

Customers using the U.S. Postal Service's Address Change Service are required to generate Intelligent Mail barcodes that contain, among other values, a 2-part number consisting of a unique sequence-number identifier for the customer's address and the organization?s mailer id account number. This 2-part number must equal 15 digits in length. The mailer ID is either a 6-digit number or a 9-digit number, which means that the unique customer-address sequence-number identifier must either be 6 digits or 9 digits. Most Personify customers do not generate enough mail to qualify for a 6-digit mailer ID account number, so most Personify customers have 9-digit mailer ID account numbers, meaning that the unique sequence-number identifier for customer addresses must be 6 digits. The only valid values for this parameter are 6 or 9.

MULTIPLE_CONCURRENT_EMPLOYERS

N

Identifies whether the organization tracks multiple concurrent employers for individuals. Base is delivered with this set to N; set to Y to enable a workflow in back office and on the web that allows a different employer to be selected to be associated with orders. Used when engagement scores for companies includes employee points rolled up to the employer company.

ONLINE_DUP_CUST_CHECK

Y

If set to “Y,” the system will check for potential duplicate customers when creating a new customer or, as of 7.5.0, when converting a prospect into a customer. If potential duplicate customers are found, the Potential Duplicate Customers window displays. For more information, please see Identifying Potential Duplicate Customers.

This application parameter applies to the back office ONLY. In order to turn on duplicate customer checking on the web, you must set the GroupOneDupMatching parameter in the config.web to "True". By default, customer duplicate checking is disabled for the web.

ORDERVIEWMONTHLIMIT

6

Number of months to go back for open orders. The orders display on the Order History tab of the Call Center screen.

PRIMARY_ADDR_PROPAGATION

NONE

When the primary address of a customer is changed from one address to another, this parameter is used to determine how the new primary address should be propagated to current and unfulfilled orders that refer to the previous primary address.

  

Enter AUTO, SELECT or NONE. When this parameter is set to AUTO, when users make a change to their primary address, the system will automatically propagate primary address changes to current and unfulfilled orders that refer to the previous primary address. When this parameter is set to SELECT, when users make a change to their primary address, you will be presented with a screen showing all current orders using the previous primary address and you manually select the orders to be updated. The default is NONE.

  

As a best practice, set this parameter to AUTO.

PRIMARY_FAMILY_CONTACT_DESIGNATION

Primary Family Contact

Identifies the term to be used to describe a primary family contact; for example, Head of Household, Family Bill-to Contact, etc. The term entered here will be displayed as the caption for the primary family contact person.  In the base application, this is set as "Primary Family Contact".

REQ_USE_OF_CONSTITUENT_ROLES

Y

If set to "Y", the system will require that each new individual or company customer record that is created must have at least one record in the Cus_Constituent_Role table.  If set to N, an individual or company record is not required to have a record in Cus_Constituent_Role.

If the organization wishes to require that each individual or company customer record have at least one Cus_Constituent_Role record, the organization will need to create a record for each existing individual and company record before setting the value of this parameter to Y.

SHOW_CERTIFICATION_CURRENT_ORGUNIT

Y

If set to "Y", user can display a customer's certifications based on the current org/org unit of the logged in user AND all certifications across org/org units. If set to "N", only certifications in the org/org unit of the logged in user will display.

SHOW_COMMITTEE_CURRENT_ORGUNIT

Y

If set to "Y", display committees from the currently logged in organization unit in the search results on the Committee Central screen.

SHOW_MBRSHIP_CURRENT_ORGUNIT

Y

If set to "Y", display customer membership information for the current primary, level one of the organization unit of the logged in user in the Involvement section on CRM360 and Donor360. If set to "N", display customer membership essential information for all organization units.

SSN_FORMAT

FULL

If parameter value FULL then user can store 9 character SSN number. If parameter value is LAST_FOUR then allow to store last four character of SSN number.

SUBGROUP_TREE_RELATIONSHIP_TYPE

SUBGROUPS

Determines the Relationship Type used to create the hierarchal tree that is generated from Subgroup Central when a user opens a subgroup record.

TAX_EXEMPT_ONINVOICE

N

If this parameter is set to N, the recalculation of tax exempt will not be done for all applicable orders even when ORD700 is run. If this parameter is set to Y, when ORD700 is ran, all the applicable orders will be recalculated for tax exemptions as of today.

TAX_REEXEMPT_SELECTION

PROFORMA

If this parameter is set to PROFORMA, only proforma orders are recalculated for tax exemption when ORD700 is ran. If this parameter is set to UNINVOICED, it will include both proforma and active uninvoiced lines when ORD700 is ran.

TELEPHONY_ACTIVITY_BUTTON_CAPTION

Activity

This parameter defines the text to display on the call alerts pop-up button that will open the activity screen.

TELEPHONY_ACTIVITY_SCREEN_NAME

ContactTracking

This parameter points to the screen which you would like to open when the user clicks the Activity button on the integrated telephony pop-up. Please note that the button label is based on the TELEPHONY_ACTIVITY_BUTTON_CAPTION application parameter defined above.

TELEPHONY_CUSTOMER_BUTTON_CAPTION

Open CRM360

This parameter defines the text to display on the call alerts pop-up button that will open a customer screen.

TELEPHONY_CUSTOMER_SCREEN_NAME

CRM360

This parameter defines the screen to open when the user clicks [CRM360] button on the integrated telephony pop-up. Please note that the button label is based on the TELEPHONY_CUSTOMER_BUTTON_CAPTION application parameter defined above.

TELEPHONY_INSTALLED

N

This parameter defines whether or not the call alerts integration is enabled.

TELEPHONY_POPUP_TIMEOUT

5

This parameter defines the value in seconds that the call alerts pop-up will remain visible. This value MUST be greater than zero when TELEPHONY_POPUP_TIMEOUT_RULE is set to TimeInterval.

TELEPHONY_POPUP_TIMEOUT_RULE

TimeInterval

This parameter determines how long the call alerts pop-up stays visible. Valid values are TimeInterval, AfterCallEnd, or UntilNextCall. When set to TimeInterval, the value (in seconds) of the parameter TELEPHONY_POPUP_TIMEOUT will be used.

USE_CONSTITUENT_IMAGES

Y

Allows organizations to enable the display of customer images in the header of customer-oriented screens. Set to N in the base application.  To 'turn on' the display of images in CRM360, Donor360 and Volunteer Central, set this parameter to Y. The Image Service must also be installed and running for images to display.

USE_CREDENTIALS_IN_LABELNAME

Y

If set to "Y", the customer's credentials, which is defined on the Individual Name Edit screen, will be included in the formatted label name, which displays on the Individual Name Edit screen, in the header on CRM360, and on the Add/Edit Address screen. Please note that changing this application parameter will only affect new records, not existing.

USE_HOUSEHOLDING

N

As of 7.4.2, if the organization wishes to use householding, the parameter should be set to "Y". Otherwise, this value should be set to "N". When this is set to "N", the ONLINE_DUP_HOUSEHOLD_CHECK parameter is also set to "N".

 

When set to "N", the Household360 screen cannot be opened by any menu items; the ability to search for a household will be disabled from CRM360 and Donor 360; and tasks related to householding will not be visible to end users.  If this is set to "Y", organizations should set the org unit parameter to define whether the household should get a soft-credit for household member donations. Households should get a soft credit if the organization wants to award recognition to households based on the level of giving of all household members combined.

USE_PREFIX_DESCR_LBL

Y

This parameter is no longer being used.

USE_SUFFIX_DESCR_LBL

Y

This parameter is no longer being used.

VALIDATE_EMAIL_REGEX

^[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$

The regular expression string to be used to validate that email addresses have the correct syntax.

WEB_NEW_CUSTOMER_SOURCE_CODE

WEB

Defines the customer’s ORIGINAL_SOURCE_CODE parameter value when a new customer is created from the web.

WEBUSERNAME_FORMAT

CUSTOMER_ID

If CUSTOMER_EMAIL_ADDRESS is selected, then the primary email address will be added as the New User Name on the Web Access Control screen. If CUSTOMER_NAME is selected, then the first initial and last name will be added as the New User Name on the Web Access Control screen. If CUSTOMER_NUMBER is selected, then the Customer ID will be added as the New User Name on the Web Access Control screen.

As of 7.5.2, if you set the CHECKDUPEMAIL application parameter to 'N" (i.e., you allow duplicate emails), you should NOT set this parameter to "CUSTOMER_EMAIL_ADDRESS".