Skip to content
Data & Connectivity

OpenFin

OpenFin Documentation

To start utilizing the integration features, you need to run this in the OpenFin workspace and include this in your local.properties file:

1
ami.guiservice.plugins=com.f1.ami.web.guiplugin.AmiWebGuiServicePlugin_OpenFin

Variables

__OpenFin: You can see this in Dashboard > Session Variables.

Methods

raiseIntent(String intent, Map context)

  • Raises the specified intent with context, to be handled by another app.

    1
2
3
    String context= "{ 'type': 'fdc3.instrument', 'id': { 'ticker': 'AAPL' } }";
map m = parseJson(context);
__OpenFin.raiseIntent("ViewChart", m);

broadcast(Map context)

  • Broadcasts context to all the other apps in workspace that are in the same color channel.

    1
2
3
    String context= "{ 'type': 'fdc3.instrument', 'id': { 'ticker': 'AAPL' } }";
map m = parseJson(context);
__OpenFin.broadcast(m);

addIntentListener(String intentType)

  • This method adds an intent handler for the specified intent. You will need to have a corresponding entry in the intent section of the apps.json as well to indicate 3forge can handle the specified intent.

    1
    __OpenFin.addIntentListener("ViewChart");

addContextListener(String context type)

  • This method qualifies 3forge to receive the specified context from a broadcast. Both the broadcaster and the receiver need to be in the same color channel.

    1
    __OpenFin.addContextListener("fdc3.instrument");

bringToFront()

  • This method brings the current 3forge window to the front of the OpenFin stack. This is different from 3forge's own bringToFront method.

setAsForeground()

  • This method brings the 3forge window to the front.

sendNotification(Map options)

  • Sends a notification to the OpenFin workspace, available keys in the map are:

    • bodyTitle (required)
    • bodyText (required)
    • iconUrl
    • customData, you may specify the data for each notification, to be used when user clicks on a button
    • indicatorColor, must be of the following: red, green, yellow, blue, purple, gray
    • indicatorText
    • button1title (required if adding buttons, see below for explanation)
    • button1primary
    • button1data

  • For adding button, use the format button + number + title/data/primary/iconUrl where:

    • number: corresponds to the ordering of the button. The lower the value, the more left the button appears e.g. if you have 3 buttons, the ordering will be 1 2 3.
    • primary: indicates whether it will have the blue background color, this color cannot be changed.
    • title: title of the button, required.
    • iconUrl: image url for the button icon.
    • data: custom data for each button.

  • Note that the maximum number of buttons is 8, per OpenFin.

  • Example configuration below creates 2 buttons:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    Map config= new Map();
config.put("customData",new map("myData", "data1"));
config.put("indicatorColor","green");
config.put("indicatorText","indicator Text!");
config.put("bodyTitle","news flash!");
config.put("bodyText","Gotcha!");
config.put("button1title","Close");
config.put("button1data","some data here");
config.put("button1primary","false");
config.put("button2title","Shut Down");
config.put("button2data","some data there");
config.put("button2title","Restart");

Callbacks

  1. onRaiseIntent(Object intentResolution): triggered when 3forge receives an intentResolution or its result from raising the intent.

    • On fdc3 ver 2.0, if 3forge is able to get the result of the intentResolution, then you will receive the result, otherwise the intentResolution is returned.
    • On fdc3 ver 1.2, it always returns the intentResolution.

  2. onContext(Object context, Object metadata): triggered when 3forge receives a broadcast of a specific context.

    • You will need to set up a listener first to receive the specific context. See Supported AmiScript methods for an example.

  3. onReceiveIntent(Object context): triggered when 3forge receives an intent from another app.

    • You will need to set up an intent listener first to trigger this. See Supported AmiScript methods for an example.

  4. onNotificationAction(Object event): triggered when the user clicks on a button in the notification.

    • You can use the following to parse the json into a map for ease of access

      1
      Map m= parseJson((String) event);

    • Below is a sample json structure that you will receive from the callback once the user clicks on the button:

       1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
      {
    "type": "notification-action",
    "trigger": "control",
    "notification": {
        "form": null,
        "body": "Gotcha!",
        "buttons": [
            {
                "submit": false,
                "onClick": {
                "data": "some data here"
            },
                "index": 0,
                "iconUrl": "",
                "cta": false,
                "title": "Close",
                "type": "button"
            },
            {
                "submit": false,
                "onClick": {
                "data": "some data there"
            },
                "index": 1,
                "iconUrl": "",
                "cta": true,
                "title": "Restart",
                "type": "button"
            }
        ],
        "onExpire": null,
        "onClose": null,
        "onSelect": null,
        "stream": null,
        "expires": null,
        "date": "2023-09-21T18:09:04.481Z",
        "toast": "transient",
        "customData": {
            "myData": "data1"
        },
        "priority": 1,
        "icon":
        "http://www.bing.com/sa/simg/facebook_sharing_5.png",
        "indicator": {
            "color": "green",
            "text": "indicator Text!"
        },
        "allowReminder": true,
        "category": "default",
        "title": "news flash!",
        "template": "markdown",
        "id": "a938f456-ef36-4f21-8062-7dd556bf093d"
    },
    "source": {
        "type": "desktop",
        "identity": {
            "uuid": "workspace-platform-starter",
            "name": "f3amione"
        }
    },
    "result": {
        "data": "some data here"
    },
    "control": {
        "submit": false,
        "onClick": {
            "data": "some data here"
        },
        "index": 0,
        "iconUrl": "",
        "cta": false,
        "title": "Close",
        "type": "button"
    }
}