Skip to main content

Notification Events Sent Based on Selected Triggers

Abstract

Notification Events Sent Based on Selected Triggers

This section contains a short overview of what types of triggers exist for PoolParty notifications and some use case examples.

In PoolParty the notifications you can set up will be triggered by the change action triggers implemented. These triggers are subdivided into groups to make using them easy.

The webhook API in PoolParty will send callbacks to an HTTP API you configure. The respective API configuration you have to set up in the Semantic Middleware Configurator first. Find an example below.

The following types exist:

Examples for Different Triggers

Below find examples for the different types.

Blacklist Add/Remove

Any addition to or removal from the blacklist in the PoolParty Corpus Management will trigger a notification.

{
  "date" : 1552418329009,
  "notifications" : [ {
    "notificationId" : 617,
    "date" : 1552418327957,
    "trigger" : "CONCEPT_BLACKLIST_ADD",
    "notificationInterval" : "IMMEDIATELY",
    "concept" : {
      "uri" : "http://docu.poolparty.biz/cocktails/b523727e-7f49-4e1b-9c09-55002ee3a81e"
    }
  } ],
  "notificationSetting" : {
    "uri" : "http://schema.semantic-web.at/ppt/notifications/Setting#ed62c765-ccb5-42d4-942c-ec2ae4542a57"
  },
  "notificationInterval" : "IMMEDIATELY",
  "projectId" : "1E1476D2-C85F-0001-EF2B-19372FD81FDB",
  "extractionModelUpToDate" : false,
  "messageId" : 1,
  "user" : {
    "uri" : "https://docu.semantic-web.at/user/admin"
  }
}

Concept Create/Change/Delete

Any addition, value change or deletion of concepts in the PoolParty Thesaurus Management will trigger a notification.

{
  "date" : 1552418418008,
  "notifications" : [ {
    "notificationId" : 618,
    "date" : 1552418417368,
    "trigger" : "CONCEPT_VALUE_CHANGE",
    "notificationInterval" : "IMMEDIATELY",
    "concept" : {
      "uri" : "http://docu.poolparty.biz/cocktails/2c3083d2-8650-4460-b019-cae7aea38f14"
    },
    "property" : {
      "uri" : "http://www.w3.org/2004/02/skos/core#altLabel"
    },
    "oldValue" : null,
    "newValue" : {
      "label" : "Paradiso",
      "datatype" : {
        "uri" : "http://www.w3.org/1999/02/22-rdf-syntax-ns#langString"
      },
      "language" : "en"
    }
  } ],
  "notificationSetting" : {
    "uri" : "http://schema.semantic-web.at/ppt/notifications/Setting#ed62c765-ccb5-42d4-942c-ec2ae4542a57"
  },
  "notificationInterval" : "IMMEDIATELY",
  "projectId" : "1E1476D2-C85F-0001-EF2B-19372FD81FDB",
  "extractionModelUpToDate" : false,
  "messageId" : 2,
  "user" : {
    "uri" : "https://docu.semantic-web.at/user/admin"
  }
}

Concept Scheme Create/Change/Delete

Any addition, value change or deletion of concept schemes in the PoolParty Thesaurus Management will trigger a notification.

{
  "date" : 1552418464008,
  "notifications" : [ {
    "notificationId" : 619,
    "date" : 1552418463693,
    "trigger" : "CONCEPTSCHEME_VALUE_CHANGE",
    "notificationInterval" : "IMMEDIATELY",
    "scheme" : {
      "uri" : "http://docu.poolparty.biz/cocktails/eff672ac-6601-42c6-a3e9-0adda3b45df8"
    },
    "property" : {
      "uri" : "http://purl.org/dc/terms/subject"
    },
    "newValue" : {
      "label" : "Garnish, Ingredients",
      "datatype" : {
        "uri" : "http://www.w3.org/1999/02/22-rdf-syntax-ns#langString"
      },
      "language" : "en"
    },
    "oldValue" : null
  } ],
  "notificationSetting" : {
    "uri" : "http://schema.semantic-web.at/ppt/notifications/Setting#ed62c765-ccb5-42d4-942c-ec2ae4542a57"
  },
  "notificationInterval" : "IMMEDIATELY",
  "projectId" : "1E1476D2-C85F-0001-EF2B-19372FD81FDB",
  "extractionModelUpToDate" : false,
  "messageId" : 3,
  "user" : {
    "uri" : "https://docu.semantic-web.at/user/admin"
  }
}

Corpus Analysis Status Change

On Corpus Analysis status changes, a notification will be triggered.

{
  "date" : 1553272744011,
  "notifications" : [ {
    "notificationId" : 620,
    "date" : 1553272743865,
    "trigger" : "CORPUS_ANALYSIS_STATUS",
    "notificationInterval" : "IMMEDIATELY",
    "corpusID" : {
      "uri" : "corpus:d9d6fd29-6d5b-4f9f-9c76-f18a4d672f11"
    },
    "status" : "COMPLETE",
    "message" : "Analysis done in 0:00:16.511"
  } ],
  "notificationSetting" : {
    "uri" : "http://schema.semantic-web.at/ppt/notifications/Setting#ed62c765-ccb5-42d4-942c-ec2ae4542a57"
  },
  "notificationInterval" : "IMMEDIATELY",
  "projectId" : "1E1476D2-C85F-0001-EF2B-19372FD81FDB",
  "extractionModelUpToDate" : true,
  "messageId" : 4,
  "user" : {
    "uri" : "https://docu.semantic-web.at/user/superadmin"
  }
}

SKOS-XL Label Create/Change/Delete

Any addition, deletion or value change for SKOS-XL Labels in the PoolParty Thesaurus Management will trigger a notification.

{
  "date" : 1553273500464,
  "notifications" : [ {
    "notificationId" : 2,
    "date" : 1553273499660,
    "trigger" : "SKOSXL_VALUE_CHANGE",
    "notificationInterval" : "IMMEDIATELY",
    "xlLabel" : {
      "uri" : "http://docu.poolparty.biz/cocktails/45788a96-1fde-486b-80fc-31ad243bba31"
    },
    "property" : {
      "uri" : "http://www.w3.org/2008/05/skos-xl#prefLabel"
    },
    "oldValue" : null,
    "newValue" : {
      "uri" : "http://docu.poolparty.biz/cocktails/82efe8a9-cce9-4761-a3c3-3739a0f3418a"
    }
  } ],
  "notificationSetting" : {
    "uri" : "http://schema.semantic-web.at/ppt/notifications/Setting#ed62c765-ccb5-42d4-942c-ec2ae4542a57"
  },
  "notificationInterval" : "IMMEDIATELY",
  "projectId" : "1E1476D2-C85F-0001-EF2B-19372FD81FDB",
  "extractionModelUpToDate" : false,
  "messageId" : 2,
  "user" : {
    "uri" : "https://docu.semantic-web.at/user/superadmin"
  }
}

Suggested Concept

On creation of a suggested concept via the PoolParty Thesaurus API, a notification will be triggered.

{
  "date" : 1553273019022,
  "notifications" : [ {
    "notificationId" : 624,
    "date" : 1553273018765,
    "trigger" : "SUGGESTED_CONCEPT_CREATE",
    "notificationInterval" : "IMMEDIATELY",
    "concept" : {
      "uri" : "http://docu.poolparty.biz/cocktails/3823b163-ad5f-4880-b48e-b116a0ef2bf6"
    }
  } ],
  "notificationSetting" : {
    "uri" : "http://schema.semantic-web.at/ppt/notifications/Setting#ed62c765-ccb5-42d4-942c-ec2ae4542a57"
  },
  "notificationInterval" : "IMMEDIATELY",
  "projectId" : "1E1476D2-C85F-0001-EF2B-19372FD81FDB",
  "extractionModelUpToDate" : false,
  "messageId" : 8,
  "user" : {
    "uri" : "https://docu.semantic-web.at/user/superadmin"
  }
}

Workflow Status Change

A change of concept states in the Workflow Management will trigger a notification.

{
  "date" : 1553272851034,
  "notifications" : [ {
    "notificationId" : 622,
    "date" : 1553272850274,
    "trigger" : "WORKFLOW_STATE_CHANGE",
    "notificationInterval" : "IMMEDIATELY",
    "concept" : {
      "uri" : "http://docu.poolparty.biz/cocktails/9584f497-1e61-4a74-9253-7c423d0dbf75"
    },
    "oldState" : "DRAFT",
    "newState" : "APPROVED",
    "oldAssignee" : {
      "uri" : "https://docu.semantic-web.at/user/superadmin"
    },
    "newAssignee" : null
  } ],
  "notificationSetting" : {
    "uri" : "http://schema.semantic-web.at/ppt/notifications/Setting#ed62c765-ccb5-42d4-942c-ec2ae4542a57"
  },
  "notificationInterval" : "IMMEDIATELY",
  "projectId" : "1E1476D2-C85F-0001-EF2B-19372FD81FDB",
  "extractionModelUpToDate" : false,
  "messageId" : 6,
  "user" : {
    "uri" : "https://docu.semantic-web.at/user/superadmin"
  }
}