binotification.json

{
  "id": "com.biexcellence.openbi.sap.sac.notification",
  "version": "0.0.2",
  "name": "biNotification",
  "description": "trigger notifications such as e-mails",
  "newInstancePrefix": "biNotification",
  "icon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAABegAAAXoBMrnI/AAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAJGSURBVDiNlZNPSNNxGMY/399+++OWuKaJQ0MtBItBhYwEEexQhNglECLq0EU9mZ06Ti8dIujQITqEBy+B1wjrkFEQBWqUaC3NBUtLs7ma+/v783YQl3MW9MD38uV5PvA+Ly8iwt/e8Jvj/uHJLv1fHiUi7NTIfMhF1hoUuA7UAIgtQ1o4eieC2OxSCWBkPrSPnDUjQstuI6hH6uH7c5FIKUQrhsdDLnLmp73DANItPa1ju3+LADlk3xZRtXuHi7o4Mn3kTNkIg4st7sBPPVdmt7Wn8c/dE3a+qlfTkh8DwVdL3sofffXKd7CvbcoA0AGqk84WUaVlGob7QezDpbDfp92s8gsOpcKpRJjkerzf0Tx7ARj7M4JXW98ZLuR9d+fnLp91u7TDfp/QUKM4VOek2qfjMCvvff1S4yjt4OjcmhJiAAoVn5o534mFXwMcCjy64HFChbsCpYR0siFy690xXxEQQey8wzyJKHPmbdt9KIQsFAVT2MzCSkIRWy0Q9DZxwBdkv9ffNPHC4ynZwo0TC98XYgPtqZRnwJY0hpkiYxgkMibLGxmWN35RsDUEjcbqZnTcjcUSt7Xy7fQVHF2WLY/HDSvemc276iwLMpoBKs3i2hIBXxXR1XnyhmOpDCDQhjjrhZ5eCzNhW6+fmXY0q6uNAKRbp+MrVbZkcpYEr04OTSbLAEAMaN8qUw/YdHQVpIPC1oY3ESMqyjma9mRGtwMlADOr9esemQU5hVK1ILYgawrmNOF5zgo8eXmtIbszU3aN/6vfbVAouCAyeN4AAAAASUVORK5CYII=",
  "vendor": "bi excellence software GmbH",
  "eula": "",
  "license": "",
  "imports": [ "input-controls" ],
  "webcomponents": [
    {
      "kind": "main",
      "tag": "com-biexcellence-openbi-sap-sac-notification",
      "url": "https://biexcellence.github.io/biexport-sac/binotification.js",
      "integrity": "",
      "ignoreIntegrity": true
    },
    {
      "kind": "styling",
      "tag": "com-biexcellence-openbi-sap-sac-notification-aps",
      "url": "https://biexcellence.github.io/biexport-sac/binotification_aps.js",
      "integrity": "",
      "ignoreIntegrity": true
    }
  ],
  "properties": {
    "serverURL": {
      "type": "string",
      "description": "The URL to the open bi Repository installation that handles the notification. If you use an installation on your local machine, change this property to http://localhost:9091, otherwise to the address and port of your installation.",
      "default": "https://designstudioexport.biexcellence.com"
    },
    "licenseKey": {
      "type": "string",
      "description": "The license key to be used for sending the notification (for usage tracking, usage limits, special smtp server configuration",
      "default": ""
    },
    "type": {
      "type": "string",
      "description": "The notification type",
      "default": "MAIL"
    },
    "sender": {
      "type": "string",
      "description": "The notification sender",
      "default": ""
    },
    "notificationBody": {
      "type": "string",
      "description": "The notification detail (in HTML format)",
      "default": ""
    }
  },
  "methods": {
    "getServerUrl": {
      "returnType": "string",
      "description": "Get the Server URL",
      "parameters": []
    },
    "setServerUrl": {
      "description": "Set the Server URL",
      "parameters": [
        {
          "name": "value",
          "type": "string",
          "description": "The new Server URL"
        }
      ]
    },
    "getLicenseKey": {
      "returnType": "string",
      "description": "Get the License Key",
      "parameters": []
    },
    "setLicenseKey": {
      "description": "Set the License Key",
      "parameters": [
        {
          "name": "value",
          "type": "string",
          "description": "The new License Key"
        }
      ]
    },
    "getType": {
      "returnType": "string",
      "description": "Get the Notification Type",
      "parameters": []
    },
    "setType": {
      "description": "Set the Notification Type",
      "parameters": [
        {
          "name": "value",
          "type": "string",
          "description": "The new Type"
        }
      ]
    },
    "getSender": {
      "returnType": "string",
      "description": "Get the Sender",
      "parameters": []
    },
    "setSender": {
      "description": "Set the Sender",
      "parameters": [
        {
          "name": "value",
          "type": "string",
          "description": "The new Mail From"
        }
      ]
    },
    "getNotificationBody": {
      "returnType": "string",
      "description": "Get the Notification detail",
      "parameters": []
    },
    "setNotificationBody": {
      "description": "Set the Notification detail",
      "parameters": [
        {
          "name": "value",
          "type": "string",
          "description": "The new notification detail"
        }
      ]
    },
    "addCustomText": {
      "description": "Add a Custom Text to replace a placeholder in the notification.",
      "parameters": [
        {
          "name": "name",
          "type": "string",
          "description": "The name of the placeholder."
        },
        {
          "name": "value",
          "type": "string",
          "description": "The text to be displayed for the placeholder."
        }
      ]
    },
    "clearCustomTexts": {
      "description": "Clears all Custom Texts."
    },
    "getServiceMessage": {
      "returnType": "string",
      "description": "Gets the Service Message",
      "parameters": []
    },
    "sendNotification": {
      "description": "Sends a notification.",
      "parameters": [
        {
          "name": "to",
          "type": "string[]",
          "description": "The recipients of the notification."
        },
        {
          "name": "cc",
          "type": "string[]",
          "description": "Optional: Recipients that shall receive a copy of the notification."
        },
        {
          "name": "subject",
          "type": "string",
          "description": "The notification text."
        }
      ]
    }
  },
  "events": {
    "onSend": {
      "description": "Specify the SAC Script that shall be triggered when the notification is sent to the Export service."
    },
    "onSuccess": {
      "description": "Specify the SAC Script that shall be triggered when successful execution is reported by the Export service."
    },
    "onError": {
      "description": "Specify the SAC Script that shall be triggered when an error is reported by the Export service."
    }
  }
}