DISA Code Template Generator

Or perhaps you were looking for the PW generator or PRPM generator?

If something doesn't look right, try a modern browser

Overview

To purpose of this generator is to quickly create the content for all the separate five files you need to create a template DISA integration. Almost everything can be keyed from a single name: the name of the plugin. Even though we can collect multiple plugins in a single JAR file, keeping each plugin separate will probably aid maintenance. The generator will create a shell for you to fill with your purpose. As with the PR/PM generator, the aim is to get something running quickly that generates console-logged evidence so that you can move as quickly as possible to the point where you implement the purpose, instead of wasting a lot of time ensuring that everything matches up.

Details

To get started, let's capture some key details about your plugin and the location of DISA on your machine

DISA Directory

Plugin Name

Type

Sprinkle comments?

Yes No

Add Logging?

Yes No

Prepare user properties

PR

Copy and save the code below in your Siebel custom folder and call it DISACunningPluginPR.js. Get the cASe right, it's important.

//Regenerate using:https://duncanford.github.io/disa-code-generator/?prpm=undefined&object=DesktopForm&name=CunningPlugin&userprops=&comments=Yes&logging=No
if (typeof(SiebelAppFacade.DISACunningPluginPR) === "undefined") {

SiebelJS.Namespace("SiebelAppFacade.DISACunningPluginPR");
 define("siebel/custom/DISACunningPluginPR", ["siebel/phyrenderer"],
  function () {
   SiebelAppFacade.DISACunningPluginPR = (function () {

function DISACunningPluginPR(pm) {
     SiebelAppFacade.DISACunningPluginPR.superclass.constructor.apply(this, arguments);
    }

SiebelJS.Extend(DISACunningPluginPR, SiebelAppFacade.PhysicalRenderer);

DISACunningPluginPR.prototype.Init = function () {
     SiebelAppFacade.DISACunningPluginPR.superclass.Init.apply(this, arguments);
     // attach to the PM method called by the WS when it responds
     this.AttachPMBinding("DISAResponse", ShowDISAResponse, {scope:this});
     this.AttachPMBinding("DISAFileResponse", ShowDISAFileResponse, {scope:this});
    }

function ShowDISAResponse(response) {
     SiebelJS.Log(response);
    }

function ShowDISAFileResponse(fileName, fileMsg) {
     SiebelJS.Log("File Name: "+fileName);
     SiebelJS.Log("File Message: "+fileMsg);
    }

DISACunningPluginPR.prototype.ShowUI = function () {
     SiebelAppFacade.DISACunningPluginPR.superclass.ShowUI.apply(this, arguments);
     // Initiate the call to the custom DISA Plugin
     this.GetPM().ExecuteMethod("callDISAPlugin");
    }

return DISACunningPluginPR;
   }()
  );
  return "SiebelAppFacade.DISACunningPluginPR";
 })
}

PM

Copy and save the code below in your Siebel custom folder and call it DISACunningPluginPM.js. Get the cASe right, it's important.

SiebelJS.Namespace("SiebelAppFacade.DISACunningPluginPM");
 define("siebel/custom/DISACunningPluginPM", ["siebel/pmodel"],
  function () {
   SiebelAppFacade.DISACunningPluginPM = (function () {

var consts = SiebelJS.Dependency("SiebelApp.Constants");
    var DISA_PLUGIN = "plugin_cunningplugin";
    consts.set("WS_"+DISA_PLUGIN.toUpperCase()+"_VERSION", "1.0.0");

var DISAHandler = null;
    var attachedHandlers = 0;

function DISACunningPluginPM(pm) {
     SiebelAppFacade.DISACunningPluginPM.superclass.constructor.apply(this, arguments);
    }

SiebelJS.Extend(DISACunningPluginPM, SiebelAppFacade.PresentationModel);

DISACunningPluginPM.prototype.Setup = function (propSet) {
     SiebelAppFacade.DISACunningPluginPM.superclass.Setup.apply(this, arguments);
     // Register a method to interface with DISA. This will be called from the PR.
     this.AddMethod("callDISAPlugin", callDISAPlugin, {sequence:false, scope:this});
     // Register a method which will carry the DISA plugin response back to the PR
     this.AddMethod("DISAResponse", function() {}, {});
     this.AddMethod("DISAFileResponse", function() {}, {});
     // Increase the number of attached handlers
     attachedHandlers++;
    }

DISACunningPluginPM.prototype.EndLife = function () {
     // Called when the PM is no longer needed
     SiebelAppFacade.DISACunningPluginPM.superclass.EndLife.apply(this, arguments);
     // Reduce attachHandlers and, if necessary, destroy the WS Handler
     if (--attachedHandlers == 0) {
      unregisterDISAHandler.call();
     }
    }

function callDISAPlugin() {
     var handler = getDISAHandler.call(this);
     // here we create an object containing data which the Java application will read.
     // Neither "Command", nor "GetSysInfo" are DISA specific.
     // The shape and content of the message is entirely up to the developer.
     var msgJSON = {};
     msgJSON["Command"] = "CunningPlugin";
     handler.SendMessage(msgJSON);
     // the message is sent asychronously, so once the command is sent, nothing further happens
     // within the PR/PM until a message is received.
    }

function getDISAHandler() {
     if (DISAHandler === null) {
      DISAHandler = SiebelApp.WebSocketManager.CreateWSHandler(DISA_PLUGIN);
     // communications with DISA are asynchronous. We define handler functions here to deal with
     // possible responses from DISA, such as a message or communication failure conditions.
      DISAHandler.OnClose = onWSClose.bind(this);
      DISAHandler.OnFail = onWSSendFail.bind(this);
      DISAHandler.OnMessage = onWSMessage.bind(this);
     }
     return DISAHandler;
    }

function onWSMessage(msg, fileName, fileMsg) {
     // this is the result of callDISAPlugin if all goes well
     if (msg instanceof Blob) {
      // Message is binary data
      // fileName is the ID of the binary data
      handleFile.call(this, msg, fileName, fileMsg);
     } else {
      handleMsg.call(this,msg);
     }
    }

// Normally this indicates something wrong with communication attempt to operator at DISA
    // Maybe because Siebel OpenUI never establishes connection with DISA due to various reasons
    // Maybe because the version number at two sides are not matched, operator version should be equal or newer
    // Reset state or other variables if necessary
    function onWSSendFail() {
     handleException("Failed to send message to DISA");
    }

// This indicates Siebel OpenUI with DISA connection was lost
    // Maybe because Siebel OpenUI never establishes connection with DISA due to various reasons
    // Maybe because DISA exited (by user) or crashed
    // Reset state or other variables if necessary
    function onWSClose() {
     handleException("Connection to DISA was lost");
    }

// Called by onWSMessage event handler
    function handleFile(msg, fileName, fileMsg) {
    // Log the file received
    // Pass the message to the PR
    // Pass the fileName and fileMsg to the PR. This is where you will need to decide what to do with the actual file contents
     this.ExecuteMethod("DISAFileResponse",fileName,fileMsg);
    }

function handleMsg(msg) {
    // Log the message received
    // Pass the message to the PR
     this.ExecuteMethod("DISAResponse",msg);
    }

// Called by onWSClose or onWSSendFail event handler
    function handleException(msg) {
    // Add other error handling logic
     SiebelJS.Log(msg);
    }

// Tidy up
    function unregisterDISAHandler(msg) {
     if (DISAHandler) {
      DISAHandler.Unregister();
      DISAHandler = null;
     }
    }

return DISACunningPluginPM;
   }()
  );
  return "SiebelAppFacade.DISACunningPluginPM";
 })
}

Java

Copy and save the code below in your Java's src/com/siebel/wsserver/plugin folder and call it CSSWSCunningPluginOperator.java. Get the cASe right, it's important.

//Regenerate using:https://duncanford.github.io/disa-code-generator/?prpm=undefined&object=DesktopForm&name=CunningPlugin&userprops=&comments=Yes&logging=No
package com.siebel.wsserver.plugin;

import com.siebel.wsserver.operator.CSSWSSingletonOperator;
import com.google.gson.JsonObject;

public class CSSWSCunningPluginOperator extends CSSWSSingletonOperator {

java.util.logging.Logger logger = java.util.logging.Logger.getLogger("disa.server");

public static final String COMMAND = "Command";

/*
 * Return the type of this plugin operator.
 */
 @Override
 public String getType() {
  logger.warning("**** PLUGIN_CUNNINGPLUGIN LOADED ****");
  return "plugin_cunningplugin";
 }

/*
 * Return the version of this plugin operator.
 */
 @Override
 public String getVersion() {
  return "1.0.0";
 }

@Override
 protected void processMessage(JsonObject msg) {
  if (msg.has(COMMAND)) {
   if (msg.get(COMMAND).getAsString().equals("CunningPlugin")) {
    CunningPlugin();
   }
  }
 }

private void CunningPlugin() {
  JsonObject response = new JsonObject();
  response.addProperty("DISAResponse", "Hello from CunningPlugin");
  sendMessage(response);
 }
}

Manifest

Copy and save the code below in your Java's src/META-INF/services folder and call it com.siebel.wsserver.operator.CSSWSOperator. Get the cASe right, it's important.

Build

Copy and save the code below in your Java's src folder and call it build.xml. Get the cASe right, it's important.