Scope
user generated templates
TO DISCUSS: UGD only? SMS? Future outgoing integration event REST calls? PDF??
...
TODO Read up.. learn about features.. compare them (blog?)... pick one!
Services (internal)
TemplateDomainService
CRUD and persistance specific functions
TemplateMergeService
Merge data representation into template and return
...
TODO Document new Java-level interfaces, packages used, utilities needed, etc. etc.
TODO Write some early code! No UI here, yet. No REST interface even. Just TDD! Goal is to illustrate templating, but accessing real entities already (including dynamic custom fields!), consider relationship traversal management, list iteration, etc.
Database Changes
TODO Document DB changes.. new tables (incl. column details), or changes to existing tables.
REST API
...
First attempt for template table
CREATE TABLE `m_template` (
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`name` VARCHAR(45) NOT NULL,
`text` LONGTEXT NOT NULL,
PRIMARY KEY (`id`)
)ENGINE=InnoDB DEFAULT CHARSET=utf8;
missing:
how to add metadata, in a generic way?
multitenancy, or do we need to save the creator?
REST API
@GET | /templates | getTemplates() | get all templates |
@GET | /templates/{templateID} | getTemplate() | get specific template |
@PUT | /templates/{templateID} | saveTemplate() | create or update template |
@DELETE | /templates/{templateID} | deleteTemplate() | delte template |
@POST | /templates/{templateID} | mergeTemplate() | send data / get template and merge them |
UI Mockups
TODO Discuss & refine existing draft mockup. May be after some of above is decided?
...