Create a terminal command dev tool for scaffolding notifications

Description

Add scaffolding for Notifications in Dev Tools.

High level, needs to cover:

  • Handler

    • /handlers/renderers/notifications/NOTIFICATION_TYPE.cfc

  • i18n

    • i18n/notifications/NOTIFICATION_TYPE.properties

  • Views

    • views/renderers/notifications/NOTIFICATION_TYPE/dataTable.cfm

    • views/renderers/notifications/NOTIFICATION_TYPE/dataTable.cfm

    • Populate as much detail for the display based on the specified fields

  • Config.cfc

    • Documentation on adding the line for settings.notificationTopics.append("NOTIFICATION_TYPE");

Generate code example for raising a Notification.

Activity

Show:
Alex Skinner
December 11, 2016, 11:37 PM

@niall

If you had any outline for this could you pass it to Mani or Selva to pick up

Niall O'Doherty
December 12, 2016, 12:03 AM

Sure @alex - I think the initial thoughts were for this to be just a dumb scaffolder to inject the basic required files (as detailed above in the description) into the project, but then it got more complicated when trying to specify select fields and other custom message detail as markup in the full view template etc.

The intention was to also output a comment post file generation with the line to include in the config.cfc e.g. settings.notificationTopics.append("NOTIFICATION_TYPE");

So maybe that would suffice for now with maybe ALL the core object properties being pulled in for the selectData() call in the handler and also the full.cfm view and just dumped out for reference and customisation.

So thoughts on initial prompts could be:

  • Object name

  • Title

  • Description

  • Icon class name

  • Data table title (for the dataTable.cfm renderer view)

  • Select fields (Leave blank to use all properties)

One complication would be the addition of any relation data but we could look at the option of fully qualified properties e.g. contact.title, contact.firstname, contact.surname, website_user.welcome_email_sent

Assignee

Niall

Reporter

Niall

Labels

Accepted

Yes

Fix versions

Priority

Medium
Configure