...
Each notification has one of four statuses (info, success, warning, error) and will end up in Notification center.
Take a look at Notification (Technical User Reference) for API reference .
...
and at Context Linking to use full potential of Notifications.
Notification Center
...
.withErrorStatus()
.withWarningStatus()
.withSuccessStatus()
.withInfoStatus()
Here you can see a couple of examples
...
Code Block | ||||
---|---|---|---|---|
| ||||
// SimpleInfo success notification with a link to the quote and download action def user = api.user("loginNameadmin") def quotequoteTypedId = "896.Q" api.notificationApi() .withRecipient(api.user("loginName")) .withTitle("Quote review requested ") .withSuccessStatus() .withSource("896.Q"quoteTypedId) .withContextLink("Go to P-896", AppPages.QC_DETAILS_PAGE, "896.Q"quoteTypedId) .withDownloadActionTypewithDownloadAction("asyncdownloadmanager.download/Pricefx_seeddata_DMDS_Customer_20221111_100755_nvgg4whatever.zip") .withMessage("Quote created by $user needs your attention.") .send() |
Code Block | ||||
---|---|---|---|---|
| ||||
// Creates a notifications with a deep-link to a specific Quote to a particular tab. E.g. P-896, tab: dashboard. api.notificationApi() .withRecipient(api.user("loginName")) .withTitle("New insight found") .withInfoStatus() .withSource("896.Q") .withContextLink("P-896.", AppPages.QC_DETAILS_PAGE, [id: "896", tpTab: 'dashboard']) .withMessage("We found an issue with the Quote P-896. Go to") .send() |
Code Block | ||||
---|---|---|---|---|
| ||||
// Creates a notification for current user with a link to a an existing Configuration Wizard with some inputs prefilled api.notificationApi() .withRecipient(api.user("loginName")) .withTitle("New opportunity found!") .withInfoStatus() .withSource("392.DB") .withContextLink("here.", AppPages.MD_WIZARD_PAGE, [ id: 48, targetPageInputs: [ TextUserEntry: "Hello World!", Margin : 10, Products : "BR1600SI", InputMatrix : [ [name: "CONTEXT", RACI: "R", comment: "no comment"], [name: "LINKING", RACI: "A,C", comment: "no comment"], [name: "EXPERIMENT", RACI: "A", comment: "With comment", selected: true], [name: "WITH", RACI: "I", comment: "Without comment"], [name: "INPUT", RACI: "I, A", comment: "no comment", selected: true], [name: "MATRIX", RACI: "I", comment: "All comments", selected: true]] ] ]) .withMessage("Start new Wizard for Product: BR1600SI") .send() |