A String List give you a way to store long lists of keys (such as a list of zip codes in
your service area) to be used in string list lookups using the "Is In String List" and
"Is Not In String List" comparison operators in Filters and Field Validations.
We support very large String Lists, so for performance reasons we do not allow you to directly edit the lists on the Portal.
Instead, you create the values for the list on your computer in a text editor and then you upload them to the list. If you want
to edit an existing list, you download the file to your computer, edit it, and then re-upload it to the Portal. For more information
on this process, see the sections below on uploading and downloading files.
||A unique string list name up to 255 characters.
||Anything goes here.
||You can't delete an String List once you create it but you can change its name and contents and you can also
hide it so that it does not appear in drop down lists
||You can provide a comment here to be included in the audit trail entry when updating the String List.
||This shows the count of items currently in the list.
Uploading Items to the List
To create a file for upload, you need to create a text file in an plain text editor like Notepad or
separate key on each line with every line being no more than 255 characters long. Based on your service plan, there
is a limit to the size of the file you can upload which is show in the upload section. When the file is uploaded, it
does not trim leading or trailing spaces, so
make sure your keys are in the exact format you need in the system. For example, if you are uploading a list of USA zip
codes for your service areas make sure there is one zip code on each line with no leading or trailing spaces.
Some example files you might want to upload are:
Note that due to a limitation in the way the files are loaded, if you want to provide the empty string as a valid value
in the list, you can not put it as the very last item in the list. If you do, the line will be ignored. You might want
to provide the empty value if it is OK to provide a zip code from a list or no zip code at all.
To upload a list do the following:
- Create the list in a text file on your computer as described above.
- Click on the "Select File" button
- Select the file from your computer and click the appropriate button to start the upload
- Wait for the file name to appear with a green dot next to it in place of the "Select File" button
- Click the "Process File" button and the button name will be disabled and the text will change to "Processing File"
Now the file has been processed and you can finish making any edits to the other String List fields and then click Insert or Update to
save the new list. When you click Insert or Update, the update is done as an atomic operation so parts of the system that reference the
String List will never get a partial list. They will only either use the entire previous list or the entire new list.
To download the list to a file, press the "Download File" button. Note that when creating a new list, the download button will
not appear until you have uploaded items to the string list.