Editing and localizing list values

About the list value maintenance function

Selecting the list for which to manage values

Filtering the values for the selected list

Adding values to the list

Editing list values

Localizing list values

Changing the display sequence of the list

Resetting the cache to propagate changes

About the list value maintenance function

The list value maintenance function is used to perform several different tasks. Its primary function is to control the display of the dropdown lists that appear on Poetic pages.

It can be used to customize:

The lists include several different types of lists. The type of list controls the available list value maintenance functions for that list:

Type of list What you can edit
Site-specific dropdowns (This is the only type of list for which you can add a value)
  • Default display text
  • Localized display text
  • Whether the value is active or disabled
  • Display order in the dropdown
System dropdowns (for example, company status)
  • Display order in the dropdown
  • Localized display text
Site properties (for example, product families)
  • Display order in a dropdown
  • Localized display text
Report names Localized display text
Report columns Localized display text
Values created elsewhere in Poetic (for example, company types, carrier services, regions)
  • Display order in a dropdown
  • Localized display text
Headers for tables included in notification templates
  • Default display text
  • Localized display text
  • Whether the value is active or disabled
  • Display order in the notification

Selecting the list for which to manage values

When working with lists, you first select the list you want to edit, then select the values.

To search for a list for which to edit or localize the values:

  1. On the Administration menu, click Site maintenance.
  2. On the Site Maintenance menu, click the Customization tab.
  3. On the Customization tab, click List values. The List values option is also available on the Frequent tab of the Site Maintenance menu.
  4. On the Search Lists page, to narrow the list search results, provide search criteria.

    You can search for lists based on either the list name or the list description. The list name is the formal identifier of the list in the database (for example, COMPANY_STATUS). The description is a brief text description of the list (for example, Status values for companies).

    You can use partial criteria for each criteria field. For example, to find all lists that have "COMPANY" somewhere in their name, type %company% in the List name field.

  5. Click Search Lists.

    The list search results display below the search criteria. For each list, the results include:

    • The list name
    • The list description
    • The total number of values in the list
  6. To select the list you want to work with, click the Select link for that list.

Filtering the values for the selected list

The Filter List Values page includes the name and description of the selected list. It also by default lists all of the values for the selected list. To filter the values:

  1. To filter the list values based on the value description, enter criteria in the List value description field. For example, to filter the list to only include values with "report" in the description, type %report%.
  2. To filter the list values based on when they were added to Poetic:
    • In the Introduced dropdown, select Since, Equal, or Before to determine whether to include list values introduced since the specified build number, in the specified build number, or before the specified build number.
    • In the Build# field, type the build number.

    For example, to filter the list values to include only those added in build 1555:

    • In the Introduced dropdown, select Equal.
    • In the Build# field, type 1555.
  3. Click Filter List Values.

    Only values that meet the criteria display. The results are limited to 80 per page.

Adding values to the list

If you are able to add values to the list, then the results toolbar includes an Add values option. To add values:

  1. Click Add values.

    The List Value Maintenance form displays. It contains rows for adding new values.

  2. For each new value, in the Value column, type the value description. This is how the value displays on the UI. Depending on the type of list, the Value field may be a text field or a larger text area.
  3. In the Code column, type the code associated with the value. List values are restricted in length (the maximum may be 10 or 50, depending on the list) and can only contain:
    • Letters (A-Z). If you type lowercase letters, they will be saved as uppercase.
    • Numbers (0-9)
    • Underscores (_)

    You can also use plus signs, asterisks, and pound signs.

  4. To make the value active, check the Active check box.
  5. If needed, provide data in the Custom 1 - Custom 3 columns.
  6. If you need additional rows for new values, click Add Lines.
  7. If you want to clear a row for which you've entered information, click the Clear link for that row.
  8. When you are finished adding values, click Save.

    The form closes and the new values are saved.

Editing list values

If you are allowed to edit the values for the list, the toolbar includes an Edit these values link. To edit the values on the current page of results:

  1. On the results toolbar, click Edit these values.

    The List Value Maintenance form displays, containing the values from the current page of results.

  2. The information you can edit depends on the type of list. For each list value, you may be able to specify:
    Value The actual text to display in a dropdown list. Depending on the type of list, the Value field may be a text field or a larger text area. List values can include HTML markup. For example, if you are configuring a list value for key installation instructions or a download description, you can include an HTML link to additional information on your web site.
    Active Whether to display the value in the list. To disable the value, uncheck the check box.
    Custom 1, 2, 3 The Custom 1 field is used for XML communication.When Poetic exports the list value in an XML document, it sends the value that is in the Custom 1 field.If there is no value in Custom 1, then Poetic sends the value that is in the Code field.The Custom 2 and Custom 3 fields may or may not be used.
  3. When you're finished editing, click Save.

Localizing list values

To localize values on the current page of results:

  1. On the results toolbar, click Localize these values.

    The Select Language and Context form displays.

  2. From the Language dropdown, select the language for which you want to localize the list values.
  3. From the Context dropdown, select the context to which this localization applies. Each context can then be mapped to a skin.

    The combination of language and context must be unique.

  4. Click Localize Values.

    The List Value Localization form displays, containing the values for the selected language and context. The Base Value column lists the value for the default language.

  5. In the Value column, type the localized value.

    You may also be able to disable/enable a value for a specific language.

  6. When you are finished localizing the values, click the Save button.

    The localization changes are saved. The Select Language and Context form displays to allow you to select another language and context for which to localize the values.

Changing the display sequence of the list

You can change the order in which values display. For example, you may want to move more commonly used options to the top of the list, or arrange all of the list values alphabetically.

Each localized value can have a different display sequence, so for example options can be alphabetized in each language they are localized into.

To set the display sequence for the entire list:

  1. Click the Change display sequence link on the toolbar.

    The Select Language and Context form displays.

  2. From the Language dropdown, select the language for which you want to change the display sequence.
  3. From the Context dropdown, select the context to which the display sequence applies.
  4. Click Change Sequence.

    The Change List Display Sequence form displays.

  5. In the Set sequence dropdown, select the option for setting the display sequence.
    • To alphabetize the values based on their description, select Alphabetically by description.
    • To alphabetize the values based on their code, select Alphabetically by code.
    • To set the display sequence manually, select Manually.
  6. If you select Manually, then the list of values in their current display sequence display below the dropdown, with buttons to move a selected value.
    • To move a value to the top of the list, click the value, then click Move to Top.
    • To move a value up one position in the list, click the value, then click Move Up.
    • To move a value down one position in the list, click the value, then click Move Down.
    • To move a value to the end of the list, click the value, then click Move to End.
  7. When you are finished setting the sequence, click Save.

    The display sequence changes are saved. The Select Language and Context form displays to allow you to select another language and context for which to set the display sequence.

Resetting the cache to propagate changes

After you edit the list values, you must reset the cache.

On the Filter List Values or Search Lists page, click Reset Cache on the page toolbar. This updates the server to ensure that the new values are available immediately.

If you are editing or localizing multiple lists, then while you do not need to reset the cache after each edit, you must at least reset the cache when you have completed all of the edits.