Editing a Hold Request Preference

Prerequisites

To edit a hold request preference, you should have:

  • Required characteristic types defined in the application (where the characteristic entity is set to Membership)

  • Values defined in the HOLD_​REASON_​FLG lookup field.

  • Required hold request types defined in the application.

  • Required reasons defined for the Discarded and Released statuses of the C1-HoldRequest business object in the Status Reason screen.

Procedure

To edit a hold request preference:

  1. Search for the hold request preference in the Field Mapping screen.
  2. In the Search Results section, click the Edit (The Edit Icon) icon in the Edit column corresponding to the hold request preference whose details you want to edit.

    The Field Mapping screen appears. It contains the following sections:

    • Main - Used to specify basic details for the hold request preference. It contains the following fields:

      Field Name Field Description Mandatory (Yes or No)
      Preference Displays the hold request preference. Not applicable
      Description Used to specify the description for the hold request preference. Yes
      Detailed Description Used to specify additional information about the hold request preference.
      Note: You can resize the text box depending on your requirement by clicking the Resize Handle (The Resize Handle Icon) icon at the bottom right corner of the text box.
      		 No
      Status Used to indicate the status of the hold request preference. The valid values are:

      • Active

      • Inactive

      		 Yes
      Preference Category Indicates the category to which the preference belongs. The valid value is:

      • Hold Request

      		 Not applicable

    • Preference Settings - Used to set the attributes in the hold request preference. It contains the following fields:

      Field Name Field Description Mandatory (Yes or No)
      Attribute Used to indicate the attribute that you want to set in the hold request preference. Yes
      Value Used to specify the attribute value.
      Note:

      The attribute value list appears only when the attribute is selected from the respective list.

      The attribute value list varies depending on the attribute that you want to set in the hold request preference.

      		 Yes
      Entity Type Used to indicate the type of entity for which the attribute is applicable. The valid values are:

      • Account

      • Adjustment

      • Billable Charge

      • Membership

      • Payment

      • Policy

      Note: At present, this data is stored for informational purposes only and is not considered in the business logic. If required, you can add more entity types in the MAP_​ENTITY_​FLG lookup field.
      		 No

      The following table lists and describes the attributes available while defining, editing, or copying the hold request preference:

      Attribute Description Mandatory (Yes or No)
      Characteristic Type for Bill Level 1 Used to specify the characteristic type which stores the bill group derivation and pricing parameter 1 for the membership. The system considers this characteristic type to determine the account to which the group membership is billed. The system then creates an automatic hold request for the respective billing account via the inbound message.
      Note: You must specify a characteristic type where the characteristic entity is set to Membership.
      		 Yes
      Characteristic Type for Bill Level 2 Used to specify the characteristic type which stores the bill group derivation and pricing parameter 2 for the membership. The system considers this characteristic type to determine the account to which the group membership is billed. The system then creates an automatic hold request for the respective billing account via the inbound message.
      Note: You must specify a characteristic type where the characteristic entity is set to Membership.
      		 Yes
      Characteristic Type for Bill Level 3 Used to specify the characteristic type which stores the bill group derivation and pricing parameter 3 for the membership. The system considers this characteristic type to determine the account to which the group membership is billed. The system then creates an automatic hold request for the respective billing account via the inbound message.
      Note: You must specify a characteristic type where the characteristic entity is set to Membership.
      		 Yes
      Characteristic Type for Bill Level 4 Used to specify the characteristic type which stores the bill group derivation and pricing parameter 4 for the membership. The system considers this characteristic type to determine the account to which the group membership is billed. The system then creates an automatic hold request for the respective billing account via the inbound message.
      Note: You must specify a characteristic type where the characteristic entity is set to Membership.
      		 Yes
      Create Automatic Hold Request Used to indicate whether the system should automatically create a hold request whenever the status of an inbound message (with person or account data) is changed to Rejected. The valid values are:

      • Yes

      • No

      		 Yes
      Create Premium Hold Request Used to indicate whether the system should automatically create a hold request when a billable charge creation or cancelation fails for an account through the File Upload Interface feature. The valid values are:

      • Yes

      • No

      		 Yes
      Default Automatic End Date Used to specify the date till when you want an automatic hold request to be effective.
      Note:

      The specified date should be later than the date when the automatic hold request is created via an inbound message or file upload interface.

      You must specify the date in the YYYY-MM-DD format.

      		 Yes
      Default Automatic Hold Reason Used to indicate the reason why you want to hold the entity via an automatic hold request.
      Note: The list includes only those values which are defined in the HOLD_​REASON_​FLG lookup field.
      		 Yes
      Default Automatic Hold Request Type Code Used to indicate the hold request type using which you want to create an automatic hold request via an inbound message or file upload interface.
      Note: The list includes only those hold request types which are already defined in the system.
      		 Yes
      Default Manual Discard Reason Used to indicate the reason why you want to discard the hold request via an inbound message. The system considers the default manual discard reason when the action tag is set to R within the billHold tag in an inbound message and the derived hold request’s start data is a future date.
      Note: You must specify a reason which is already defined for the Discarded status of the C1-HoldRequest business object through the Status Reason screen.
      		 Yes
      Default Manual End Date Used to specify the date till when you want a manual hold request to be effective. The system considers the default manual end date when the action tag is set to H or R and other hold details are not received within the billHold tag in an inbound message.
      Note:

      The specified date should be later than the date when the manual hold request is created via an inbound message.

      You must specify the date in the YYYY-MM-DD format.

      		 Yes
      Default Manual Hold Reason Used to indicate the reason why you want to hold the entity via a manual hold request. The system considers the default manual hold reason when the action tag is set to H or R and other hold details are not received within the billHold tag in an inbound message.
      Note: The list includes only those values which are defined in the HOLD_​REASON_​FLG lookup field.
      		 Yes
      Default Manual Hold Request Type Code Used to indicate the hold request type using which you want to create a manual hold request via an inbound message. The system considers the default manual hold request type when the action tag is set to H or R and other hold details are not received within the billHold tag in an inbound message.
      Note: The list includes only those hold request types which are already defined in the system.
      		 Yes
      Default Manual Release Reason Used to indicate the reason why you want to release the hold request via an inbound message. The system considers the default manual release reason when the action tag is set to R within the billHold tag in an inbound message.
      Note: You must specify a reason which is already defined for the Released status of the C1-HoldRequest business object through the Status Reason screen.
      		 Yes
    Tip: Alternatively, you can click the Edit button in the Field Mapping zone to edit the details of the hold request preference.
  3. Modify the required details in the Main section.
  4. Define, edit, or remove the attribute from the hold request preference, if required.
    Note: You must set at least one attribute in the hold request preference.
  5. Click Save.
    The changes made to the hold request preference are saved.

Related Topics

For more information on... See...
How to search for a hold request preference Searching for a Hold Request Preference
Field Mapping zone Field Mapping
Manual Hold Request Creation Via Inbound Message Manual Hold Request Creation Via Inbound Message
Automatic Hold Request Creation Via Inbound Message Automatic Hold Request Creation Via Inbound Message
Automatic Hold Request Creation Via File Upload Interface Automatic Hold Request Creation Via File Upload Interface