Record Store plugin can be used to persistently store, update, retrieve and e-mail meta-searched records. It allows building UI component that require the records to be persistent, including: user-managed record lists ("record basket"), record sharing (e.g via e-mail) and record "tagging".
Assuming the plugin has been mapped to the store chain (see configuration) it is invoked with:
GET /service-proxy/?command=store
If mapping was successful you will see an error indicating that mandatory request parameters (specific to the plugin) are missing.
Specifies the action performed by the plugin. Depending on the value of this parameter, additional parameters may need to be specified.
Possible values include:
Example:
POST /service-proxy/?command=store&action=create
In response, status document containing id element with a local id of the stored record is returned.
Example:
GET /service-proxy/?command=store&action=read&id=99
Example:
GET /service-proxy/?command=store&action=delete&id=99
Example:
GET /service-proxy/?command=store&action=list&start=0&max=100
Example:
GET /service-proxy/?command=store&action=email&id=99&to=me@server.com
This plug-in is configured in service-proxy.properties or equivalent as follows:
plugins.store = com.indexdata.masterkey.store.RecordStorePlugin
Mail server host (for email action).
Mandatory in email action.
Example:
store.MAIL_SMTP_HOST = smtp.someserver.com
Mail server user name (for email action).
Mandatory in email action.
Example:
store.MAIL_SMTP_USER = username
Mail server password (for email action).
Mandatory in email action.
Example:
store.MAIL_SMTP_PASSWORD = somepass
Sender (from) name (for email action).
Mandatory in email action.
Example:
store.MAIL_FROM = Index Data