Versions Compared

Old Version 18

changes.mady.by.user Idan Amit

Saved on

compared with

New Version 19

changes.mady.by.user Idan Amit

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySDC-1568


UI Integration

SDC need needs to onboard plugins in a way that will be decoupled from the SDC UI implication.

...

before you can integrate with SDC you will need to add our pubsub librery in to your aplicationapplication.

SDC will expose a base class in JS as part of the SDC UI project. Any plugin will be able to communicate with SDC after they instantiate this class.

...

Info
iconfalse
titleUsing the librery

Loading It Up

CommonJS

import {PluginPubSub} from 'sdc-pubsub'

Global Variable

<!-- index.html -->
<script src="./node_Modulesmodules/sdc-pubsub/dist/sdc-pubsub.js"></script>

// script.js
var pubsub = window.sdcPubSub.PluginPubSub;

Plugin registration

SDC will expose a base class in JS as part of the SDC UI project. Any plugin will be able to communicate with SDC after they instantiate this class.

...



BasePubSub API
Base class holding all the basic operations needed for using the event hub.
...
 Info
iconfalse
{
    type: WINDOW_OUT
    origionorigin: "sdc-hub"
    data:
}

 
Version change 
...
event example

 Info
iconfalse
{
    type: VERSION_CHANGE
    origion origin: "sdc-hub"
    data:{
         uuid: a21af8a1daa948f78e30f9b269a253ba ,
         version:1.1
    }
}
Check in 
...
event example

 Info
iconfalse
{
    type: CHECK_IN
    origion origin: "sdc-hub"
    data:
}
Submit for testing 
...
event example

 Info
iconfalse
{
type: SUBMIT_FOR_TESTING
origion origin: "sdc-hub"
data:
}

Undo check out 
...
event example
 Info
iconfalse
{
    type: SUBMIT_FOR_TESTING
    origion origin: "sdc-hub"
    data: {
         uuid: a21af8a1daa948f78e30f9b269a253ba ,
         version:1.1
    }
}
...
Name
Type
Description
Ready
READY
The event is posted by the plugin once it is ready.
Action completed
ACTION_COMPLETED
The event is sent by the plugin after receiving an event from SDC that the plugin added to notify the event passed to the plugin has be completed and SDC can continue the eventsToWait list in order to notify SDC to continue with its flow.

Ready event example
 Info
iconfalse
{
    type: READY
    origionorigin: plugin"pluginName"
    data:
}

Action completed event example
...
 Info
iconfalse
{
    type: ACTION_COMPLETED
    origionorigin: plugin"pluginName"
    data:
}

Security TBD
Need to add solution for the iframe authorization and authentication.
...