Versions Compared

Old Version 15

changes.mady.by.user Idan Amit

Saved on

compared with

New Version Current

changes.mady.by.user Idan Amit

Saved on

Key

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

...

Parameter Name

Parameter Type

Description

pluginsList

List of objects

List describing each plugin location and configuration for the UI integration.

connectionTimoutIntegerTime in milliseconds for trying to establish a connection to when executing an HEAD request to each plugin


Plugins list:

Parameter Name

Parameter Type

Description

pluginId

String

The id of the plugin

pluginDiscoveryUrl

String

The URL which will be used to check the plugin availability

pluginSourceUrl

String

The URL which will be used to load the plugin page

pluginStateUrlStringThe state URL for the UI router

pluginDisplayOptions

Map of objects

An map of object representing the plugin options, the currently supported options are tab and context.

isOnline

Boolean

This value indicates to the SDC UI if the plugin is currently online. If the plugin is down an attempt to open the plugin will result in an error screen.

PluginDisplayOptions tab:

...

Parameter Name

...

Parameter Type

...

Description


...

displayName

...

String

...

PluginDisplayOptions tab:

Parameter Name

Parameter Type

Description

displayName

String

The name to show for this plugin in the tab area.

displayRoles

List of string

The user roles for which this plugin will be shown.

Supported roles are: ADMIN, DESIGNER, TESTER, OPS, GOVERNOR

...

Info
iconfalse
titleResponse Sample

[  {    "pluginId": "DCAE",

    "pluginDiscoveryUrl": "http://<ip>:8702/openoui/vnfmarketdcae/#!/marketplaceindex",

    "pluginSourceUrl": "http:// <ip>:8702/openouidcae/vnfmarket/#!/marketplaceindex",

    "pluginStateUrl": "dcae",

    "pluginDisplayOptions": {

      "tab": {

        "displayName": "DCAE",

        "displayRoles": [ "TESTER" ]

      },

      "context": {

        "displayName": "Monitor",

        "displayContext": [ "VF", "SERVICE" ],

        "displayRoles": ["DESIGNER" ]

      }

    }

  },  {

    "pluginId": "WORKFLOW",

    "pluginDiscoveryUrl": "http://<ip>:9527/",

    "pluginSourceUrl": "http:// <ip>:9527/",

    "pluginStateUrl": "workflowDesigner",

    "pluginDisplayOptions": {

      "tab": {

        "displayName": "WORKFLOW",

        "displayRoles": ["DESIGNER","TESTER" ]

      },

      "context": {

        "displayName": "Workflow Designer",

        "displayContext": ["VF"],

        "displayRoles": ["DESIGNER", "TESTER" ]

      }

    }

  }]

...

Field

Type

Description

connectionTimeout

Integer

This is the number of milliseconds, for the head request to wait for a response from the plugin.

pluginsList

List of objects

A list of plugins’s configurations.

pluginId

String

The name of the plugin.

pluginHost

String

The host where the designer is located.

pluginSourceUrl

String

The plugin URL passed to the UI to retrieve the page.

pluginDiscoveryUrl

String

The plugin URL used for the availability check.

pluginStateUrl

String

The plugin state for UI router.

pluginerDisplayOptions

String

We currently support two work modes for plugins:

  1. tab – opens the designer as a tab, for this type we need to set displayName field to define what the tab text and the display roles which define what roles will see the plugin.
    example:
    tab:

displayName: "Workflow Designer"

displayRole: [“TESTER”]

  1. context – opens the designer as a context, for this type we need to set displayName field, displayRole and define the displayContext in which the plugin will open, options VF/SERVICE/CP/VL/VFC.
    example:
    context:

            displayName: "monitor"

            displayRole: [“TESTER”]

            displayContext: ["VF", "SERVICE"]

...

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.

...

Param

Description

userId

The id of the user logged into SDC.

userRole

The role of the connected user, options ADMIN, DESIGNER, TESTER, OPS, GOVERNOR.

displayType

The type of view the plugin is opened in tab/context.

contextType

The type of the context where the plugin is opened: VF/CP/VL/VFC/SERVICE

uuid

Unique id of the context the designer plugin is opened in.

lifecycleState

The state the context /resource or service are currently in:
                                READY_FOR_CERTIFICATION/                CERTIFICATION_IN_PROGRESS/

                CERTIFIED/          NOT_CERTIFIED_CHECKIN/

NOT_CERTIFIED_CHECKOUT;

isOwner

A Boolean value describing if the logged user is the owner/lastUpdator of the resource/service.

version

The version of the item displayed.

parentUrl

The URL of the SDC the plugin is opened in. used to subscribe to the event bus in SDC.

eventsClientId

The name with which the plugin needs to register with to the event bus.

...

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;

...

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.
The class will define a set of method that will allow the communication with SDC.


BasePubSub API
Base class holding all the basic operations needed for using the event hub.
...
 Info
iconfalse
{
       type: XXX"eventType"
       originIddata: YYY{}
        data:{}originId: "originName"
}
SDC generated events
Name
Type
When
Data
UI state
Description
Window out
WINDOW_OUT
Before SDC closes plugin,
The event is sent on all events below except VERSION_CHANGE and check out
none
Moves out of the plugin scope
The event is posted by SDC once the plugin window is going to be closed because of user action.
Version change
VERSION_CHANGE
After SDC retrieves item
New item version and UUID
The plugin is displayed on screen.
The event is posted by SDC once context version is changed by the user.
Check in
CHECK_IN
Before SDC closes plugin
none
SDC opens the catalog.
The event is posted by SDC once the context is being checked by the user.
Check out
CHECK_OUT
After SDC successful checkout the item
New item version and UUID
The plugin is displayed on screen.
The event is posted by SDC once the context is being check out by the user.
Submit for testing
SUBMIT_FOR_TESTING
Before submitting for testing is executed
none
SDC opens the catalog.
The event is posted by SDC once the context is being submitted for testing by the user.
Undo check out
UNDO_CHECK_OUT
After SDC executed the undo check out.
item version and UUID
SDC opens the catalog.
The event is posted by SDC once the context is being undone by the user.
Window out event example

 Info
iconfalse
{
    type: "WINDOW_OUT"
    origiondata:
    originId: "sdc-hub"
    data:
}

 
Version change 
...
event example

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

 Info
iconfalse
{
    type: "CHECK_IN"
    origiondata:
 originId: "sdc-hub"
}
Check out event example

 Info
iconfalse
{
    type: "_CHECK_OUT"
    data: {
         uuid: a21af8a1daa948f78e30f9b269a253ba ,
         version:1.1
    }
    originId: "sdc-hub"
}
Submit for testing 
...
event example

 Info
iconfalse
{
type: "SUBMIT_FOR_TESTING"
origiondata:
 originId: "sdc-hub"
data:
}

Undo check out 
...
event example

 Info
iconfalse
{
    type: SUBMIT"UNDO_FORCHECK_TESTINGOUT"
    origion:sdc-hub    data: {
         uuid: a21af8a1daa948f78e30f9b269a253ba ,
         version:1.1
    }
    originId: "sdc-hub"
}


Designer events
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"
    origiondata:plugin    data
originId: "pluginName"
}

Action completed event example

 Info
iconfalse
{
    type: "ACTION_COMPLETED"
    origiondata:plugin    data
originId: "pluginName"
}

Security TBD
Need to add solution for the iframe authorization and authentication.
...
more information in the Appendix.

Appendix A – References
SDC external API’s
SDC consumer definition