Set up email alert subscriber system

[anderspeders]

As a subscriber I want an alert when - a contract:

• from X country is uploaded
• from X corporate group is uploaded

[manishgs]

Design/Workflow on Frontend.

1) There will be subscription form at the footer of the page.

2) When user submit the form, a popup window will be shown as below:

user have option to subscribe for all countries or specific country, Likewise to subscribe for all corporate group or a single corporate group.

3) When user submit the form thank you message will be shown as below.

Backend workflow

1) Separate system will be build to handle subscription system. subscribe.resourcecontract.org (proposed) subdomain will be created/used for subscription.

2) All the subscribers' information will be store/view in the above subdomain.

3) When a contract is published on the admin for thee first time, a notification will be sent to all subscribed users. Later If contract is unpublished and then re-published, notification will not be sent.

4) There will be unsubscribe link at the button of the email template where user can unsubscribe anytime from the notification system.

@anderspeders @SamCCSI @charlesyoung Let us know your comments and suggestions.

[charlesyoung]

Thanks @manishgs

Will another notification be sent out for contracts (that already have had the metadata published) that are annotated?

[manishgs]

No, system will not send notification when pdf text or annotation is published. Notification will be sent when contract metadata is published.

We can discuss if we need the feature to send notification on pdf text and annotation publish.

[charlesyoung]

@KaitlinCCSI @SamCCSI @anderspeders do we only send a notification when the contract metadata is published or also when the PDF text or annotation is published?

[charlesyoung]

@anjesh no feedback received so please implement as suggested. We can always extend the subscriber system later on if required.

[charlesyoung]

@anjesh can you set this up on the demo site?

[charlesyoung]

@anderspeders can we also include company name, additional to country and corporate group, because only a small proportion of contracts have corporate group captured?

[charlesyoung]

@anderspeders @SamCCSI @KaitlinCCSI can we also include company name, additional to country and corporate group, because only a small proportion of contracts have corporate group captured?

This function has been developed so just waiting for feedback on above.

cc @manishgs

[anderspeders]

Sounds good to me. If this does not include a substantial amount of extra work.

[KaitlinCCSI]

Fine with me too, though I wonder how many situations this will actually be relevant for -- how many times will a company already be in system (for someone to find in the dropdown list) with then new contracts from same company, or updates to existing contracts of that company, made?

On separate note, the thank you message should probably be refined; assume @jedm might have some suggestions?

[jedm]

I agree that the use case for this as spec-ed will be limited.

Suggest that the most likely need will be on single contract pages, country pages and search result pages when user searches single country or resource, e.g.,

• notify me when this country has a new contract
• notify me when this resource has a new contract
• notify me when this document has annotations (for unannotated docs)

YI, 1) are all three of these scenarios possible, and 2) is there a way to offer notification signup from the contextual pages instead of only from homepage?

On Dec 19, 2016, at 11:07 AM, KaitlinCCSI notifications@github.com wrote:

Fine with me too, though I wonder how many situations this will actually be relevant for -- how many times will a company already be in system (for someone to find in the dropdown list) with then new contracts from same company, or updates to existing contracts of that company, made?

On separate note, the thank you message should probably be refined; assume @jedm might have some suggestions?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

[manishgs]

@jedm

YI, 1) are all three of these scenarios possible,

1, 2 is possible for third, it is possible when annotation is published for first time. if annotation added later and publish then notification will not be sent.

2) is there a way to offer notification signup from the contextual pages instead of only from homepage?

signup form will be present at the bottom of all pages (homepage and inner pages)

[shashikhanal]

Newsletter system workflow for testing:

1. Go to any subsites and fill up the subscription field and click subscribe button.
2. Now you reach newsletter system. Here fill up the desired fields and click the subscribe button.
3. Now you get an acknowledgement page and receive a confirmation mail.
4. Click "Click to confirm your email." button. Now you get a confirmation message.
5. Now go to admin section and login with correct admin username and password.
6. Now your dashboard looks as follows:
7. Contracts page looks as follows:
8. Settings page looks as follows. Now in order to get subscription email set the 'Time' field in UTC timezone accordingly.
9. You can logout clicking the logout button.
10. Subscription email looks as follows:

[jedm]

@shashikhanal and @manishgs thank you for these examples and documentation.

Can you clarify if user can subscribe to a specific contract directly from the contract page?

ie, can you create a "doc-specific" subscription link higher up on the UI?

If not, I am not sure that the usage will be sufficient enough to justify the coding time.

Meanwhile, wishing you all a very Happy New Year! Looking forward to doing more in 2017.

Jed

[manishgs]

@jedm Thank you and wish you the same.

Can you clarify if user can subscribe to a specific contract directly from the contract page?

Current scope is to subscribe from the system not to a specific contract. But we can discuss for your suggestion.

Could please provide example why user subscribes to specific contract and what type of updates should notify to subscriber?

[jedm]

Sorry if I was not clear, the specific contract subscription is for when annotations are added to a specific contract (for the first time). Per previous question here: https://github.com/NRGI/resourcecontracts.org/issues/126#issuecomment-268067687

The other question was regarding "contextual subscriptions." User should be able to click from a specific page (country, resource, contract) directly to a signup for notifications regarding THAT page/list/contract. Same question as here: https://github.com/NRGI/resourcecontracts.org/issues/126#issuecomment-269746723

Thanks.

[charlesyoung]

Putting this ticket on-hold for now to be discussed in more detail during the 20/01 call.

[charlesyoung]

Ticket not prioritized. When @jedm conducts use case research he could look into user demand for this.

[charlesyoung]

Something to reconsider again?

Below is how ResourceProjects allows for alerts/notifications.

https://resourceprojects.org/subscribe

[man-git007]

@charlesyoung I think we need discussion for this ticket.

cc @jedm