Subscriber List Definition
-
To access the definition wizard for a subscriber list, open the node of the parent dataset of the desired list in the
Subscriber Datasets
subtree, to show its subnodes.
- For a standard dataset (in subscriber area mode), proceed to open the Lists subnode, to show the subtree with all the lists in the dataset. Select the desired subscriber list node in this subtree.
- For a "single list mode" dataset, there is no such "Lists" subnode. Simply select the node for the single list from the subnodes of the dataset node.
- To create a new subscriber list, select the desired parent dataset in the Subscriber Datasets subtree and select New -> Subscriber List from the menu (or go via the right-click menu of the dataset node in the explorer tree).
- To convert an existing Classic LISTSERV list into an advanced subscriber list in the LISTSERV Maestro Subscriber Warehouse or to create a clone (copy) of an existing Classic LISTSERV list as a new advanced subscriber list in LISTSERV Maestro, select the desired parent dataset in the Subscriber Datasets subtree and select New -> Convert or Clone Classic LISTSERV List from the menu (or go via the right-click menu of the dataset node in the explorer tree).
The Subscriber List wizard lets you define the settings of a subscriber list or edit an existing list.
Note: A subscriber list is only fully editable while it is "empty", meaning that there are no subscribers on the list. For a non-empty list, only certain settings are editable.
The wizard has eight pages:
General, Profile Fields, Profile Field Details, List Type, List Options, Posting Restrictions, Topics, and Summary
The top row of the wizard displays links to these pages. The page that is currently open is marked with a highlighted background color. Depending on the choices made on some of the wizard pages, other pages may become disabled or may be shown in different versions. If a wizard page is disabled, then it means that this page is not necessary with the current choices and can safely be ignored.
The LISTSERV Maestro admin may configure a user account or group so that it is only allowed to create standard announcement subscriber lists, but not advanced subscriber lists. If this is the case, then the wizard has only four pages and the "List Type", "List Options", "Posting Restrictions" and "Topics" pages are not shown.
General Page: Name, Description and External Subscriber Download Token
This screen defines the general settings of the subscriber list:
Name: The name of the subscriber list is used internally in LISTSERV Maestro and is displayed externally to subscribers as the name of the list. The name must be unique in the dataset. There cannot be two subscriber lists with the same name in the same dataset.
If the list is an advanced subscriber list, then the name must also be unique on the LISTSERV instance that your account is connected to (there cannot be two LISTSERV lists with the same name on the connected LISTSERV server).
Depending on the configuration in the Administration Hub, it may be that all advanced subscriber lists that belong to your account or group will have an automatic name suffix that is always appended to the name that you enter here (a hyphen is used as a separator). If this is the case, then this suffix is displayed immediately to the right of the Name field.The list name can no longer be changed once there are subscribers on the list.
Internal Description: The internal description of the subscriber list is used internally in LISTSERV Maestro and for an advanced subscriber list it is also used in the list header of the LISTSERV list. It is not normally visible externally to subscribers.
Public Description: An optional public description that is visible externally to subscribers as the description of the subscriber list.
External Download: The subscribers of the list can be downloaded via an external download URL, i.e. an URL that can be accessed without first logging in to LISTSERV Maestro. This external download URL is a so-called "external trigger" of the type "Simple URL Access", with the download data in the body of the HTTP response (in form of a ZIP file). See below for more details about external triggers and what this means in detail.
For the external trigger, a special security token is required. Each list has a unique download security token.
Important: Everyone who is in possession of this security token and who can also access LISTSERV Maestro on its HTTP port (for example with a normal web browser) is able to download the list subscribers. The security token should therefore be closely guarded and not be given out to unauthorized persons. Because of this, the screen does not display the token directly (so no one can simply look over your shoulder and "steal" the token). To display the token, you first have to click on the Show Download Security Token link.
Creating a new Download Security Token: If you suspect that an unauthorized person has gained access to the download security token, you can use the Create New Download Security Token link to invalidate the previously used token and to create a new one.
External Triggers
LISTSERV Maestro offers several actions that can be triggered remotely from an external source by simply accessing a special external trigger URL, via the HTTP protocol. This trigger URL can be accessed without the need to first login to LISTSERV Maestro.
With this, several scenarios are possible:
If there are actions that need to be triggered manually by a user who does not want to login to LISTSERV Maestro first; then, the user could create bookmarks in his browser, where each bookmark contains a trigger URL and stands for an action that can be triggered. Or, perhaps a custom-made HTML page could be created with links that point to the trigger URLs.
In a different scenario, these actions could be triggered by another process, such as a script or program. To trigger an action, all this other process has to do is to open a HTTP communication to the action's trigger URL. This type of external process could, for example, trigger an action according to a certain time schedule or each time a certain outside event happens.
To secure the external trigger URLs against unauthorized access, a security token needs to be included in each URL. Each action that can be triggered externally has a unique security token. Therefore, the security token in the URL serves two purposes: It identifies the action that is to be triggered, and it validates that the user or process that makes this request is indeed authorized to do so.
The security token for the action in question can be obtained from inside of the LISTSERV Maestro user interface. The exact location where the token can be obtained depends on the action that it stands for. Please see the description of the action in question for this information.
Important: You should make sure that this security token is not given out to unauthorized persons because anyone who knows the security token of a certain action is able to trigger this action, as long as he also has HTTP access to the LISTSERV Maestro server. If you suspect that an unauthorized person has gained access to the token, then you can create a new token (and invalidate the existing token) by clicking the appropriate link at the location where you obtained the token.
A trigger URL always has the following form:
http://SERVER_NAME/lui/externalAction.do?token=SECURITY_TOKEN
where SERVER_NAME is replaced with the name of your LISTSERV Maestro server. (If a non-standard HTTP port is used, also include the port, separated with a colon ":". If access to your LISTSERV Maestro is protected with HTTPS, you need to specify "https://" instead of "http://".)
where SECURITY_TOKEN is replaced with the security token for the action that the URL shall trigger.
External triggers come in two variants:
-
Simple URL Access: The action is triggered by accessing the external trigger URL with a HTTP GET request.
By accessing this URL, a HTTP GET request is made to LISTSERV Maestro. The server then first verifies the given security token and, if it is valid, triggers the corresponding action. The result of the action is returned in the form of a HTTP response.
If everything went well, a response with the status code "200 - OK" is returned. In this case, the response body contains the result of the action. Most actions return a simple "OK" text in the result, but some actions may also return more data in the result; for example, if the purpose of the action was to download certain data from LISTSERV Maestro.
If there was a problem executing the action, a response with a different status code is returned, such as "404 - Not Found" if an invalid security token was specified.
-
URL Access with Additional Data: The action is triggered by accessing the external trigger URL with a HTTP POST request.
In contrast to the "simple URL access" of above, the trigger URL must be accessed with a HTTP POST request, and the additional data that is necessary for the action must be included as part of the request body. The data that is required depends on the action in question. Please see the description of the action for this information.
The result of the action is returned in form of a HTTP response, just like for the "simple URL access". Please see above for details.