Decipher users can subscribe to projects in order to receive email notifications about future errors or changes made to their surveys. Along with subscribing to projects, shell users also have the ability to manage existing subscriptions for any project directly from the Command Line.
2: Managing Subscriptions via the Command Line
Requires Decipher Cloud
Shell users have access to the
subscribe command which can be used to mass-manage email subscriptions to projects. Users who are subscribed to a project will receive the following notification emails:
- support request notifications
- survey status (e.g. going LIVE or closing)
- fatal error message reports
- team emails regarding data edits
- project errors and warnings
2.1: Subscribe Functions
subscribe command takes one of the arguments below as its first parameter followed by either an email address or project path (or both).
subscribe [ARGUMENT] <EMAIL ADDRESS> <SURVEY PATH> <SURVEY PATH>
||Shows who has subscribed to one or more surveys or what survey(s) a user is subscribed to|
||Adds a new subscriber to one or more surveys|
||Removes a subscriber from one or more surveys|
||Replaces a subscriber on ALL surveys the subscriber belongs to with another|
||Loads subscriptions from a tab-delimited file|
list argument displays all subscriptions for one or more projects or the subscriptions a user is subscribed to.
subscribe list <EMAIL ADDRESS> subscribe list <SURVEY PATH> <SURVEY PATH> ...
# List all projects user is subscribed to $> subscribe list email@example.com selfserve/9d3/proj100 selfserve/9d3/proj301 selfserve/9d3/proj310 selfserve/9d3/proj711 # List all subscribers for these projects $> subscribe list selfserve/9d3/proj100 selfserve/9d3/proj301 * selfserve/9d3/proj100 firstname.lastname@example.org email@example.com * selfserve/9d3/proj301 firstname.lastname@example.org email@example.com firstname.lastname@example.org # List all subscribers for this directory's project $> subscribe list . email@example.com firstname.lastname@example.org
add argument adds a subscriber (email address) to one or more projects.
subscribe add <EMAIL ADDRESS> <SURVEY PATH> <SURVEY PATH>
# Add email@example.com to this directory's project $> subscribe add firstname.lastname@example.org . Adding user email@example.com to these 1 projects: selfserve/9d3/101 Continue?? (Y/N) Y # Add firstname.lastname@example.org to many projects $> subscribe add email@example.com selfserve/9d3/102 selfserve/9d3/103 Adding user firstname.lastname@example.org to these 2 projects: selfserve/9d3/102 selfserve/9d3/103 Continue?? (Y/N) Y
remove argument removes a subscriber (email address) from one or more projects.
subscribe remove <EMAIL ADDRESS> <SURVEY PATH> <SURVEY PATH>
# Remove subscriber from this directory's project $> subscribe remove email@example.com . Removing user firstname.lastname@example.org from these 1 projects: selfserve/9d3/101 Continue?? (Y/N) Y # Remove subscriber from many projects $> subscribe remove email@example.com selfserve/9d3/102 selfserve/9d3/103 Removing user firstname.lastname@example.org from these 2 projects: selfserve/9d3/102 selfserve/9d3/103 Continue?? (Y/N) Y
replace argument replaces a subscriber (email address) with another subscriber (email address) for ALL projects the subscriber is subscribed to.
subscribe replace <EMAIL ADDRESS> <EMAIL ADDRESS>
# Replace all of email@example.com's subscriptions with firstname.lastname@example.org $> subscribe replace email@example.com firstname.lastname@example.org Move email@example.com's 73 existing subscriptions to firstname.lastname@example.org?? (Y/N) Y
import argument adds subscribers (email addresses) to the paths provided in a tab-delimited file. The tab-delimited file must contain exactly two columns named "email" and "path". The import function is the equivalent to calling the
add argument for every line in the file.
subscribe import <FILENAME>
Here are the additional subscriptions we will be creating (
email path email@example.com selfserve/9d3/proj456 firstname.lastname@example.org selfserve/9d3/proj567 email@example.com selfserve/9d3/proj567 firstname.lastname@example.org selfserve/9d3/proj678 email@example.com selfserve/9d3/proj789 firstname.lastname@example.org selfserve/9d3/proj890 email@example.com selfserve/9d3/proj890 firstname.lastname@example.org selfserve/9d3/proj890
To add these subscriptions:
$> subscribe import new_subscriptions.txt OK.