Versions Compared

Old Version 6

changes.mady.by.user Michael Lando

Saved on

compared with

New Version 7

changes.mady.by.user Michael Lando

Saved on

Key

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

Table of Contents
maxLevel2

Overview

SDC is a Design platform, as such, we want to create an easy way to add new design capabilities to SDC.

...

The solution will provide several options for showing the designer as part of SDC. The communication between the SDC and the designers on the UI side will be event based and on the back-end side it will be based on the external API’s SDC exposes.


Designer

...

Configuration

As part of the integration between SDC and the different plugins, we uphold the concept that SDC can function without any of the different plugins.

...

The configuration allows SDC to control where the plugin UI will be displayed, tab mode or context mode.

...


Configuration fields

The designer configuration is located under {app base}/config/catalog-fe/plugin-configuration.yaml

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"]

...

Code Block
languagejs
titleExample with events to wait for
eventsClientId=<received from query params>
parentUrl=<received from query params>
eventsToWaitFor = [ “CHECK_IN” ]
PluginPubSub client = new PluginPubSub(eventsClientId, parentUrl, eventsToWaitFor)

...



Send ready event

As part of the plugin flow, the plugin will need to send the ready event to SDC so that SDC will know the plugin has loaded successfully.

...

Info
iconfalse

{

    type: ACTION_COMPLETED

    origion:plugin

    data:

}

...


Security TBD

Need to add solution for the iframe authorization and authentication.

...