How to access dynamic config

HFCDev

Hi,

I am trying to access additional config information from my Smart UI command. The idea is to make a command conditional based on things like global parameters in the module (i.e. feature enabled or not), and information about the object itself (i.e. is it a document or a folder).

  In another post, I got a solution for how to access dynamic config which you can set in your module. Here is the link:

https://forums.opentext.com/forums/support/discussion/comment/941913/#Comment_941913

Said post references an article by Reiner Merz that discusses this very topic:

https://pos2007.de/config-settings-send-to-a-smartui-module

I am able to override the CSUIExtensions object in my module to add my own code to the GetDynamicConfiguration() script which returns an assoc with turns into a JSON object in SmartUI. 

Both Pierre's post and Reiner's blog make reference to a module object and its config method, i.e.

var config = module.config();

If I add this to my Command JS object, module is not found.  I probably need to "require" or "csui.define" something to get that config, but what?  I have scoured the KC and the forums for a sample illustrating how you access this module object or even the config and so far, the only things I find on config are about a local config.js file that you define, whereas I need something which is defined server-side.

I could also use some guidance on what we *should* be putting in this dynamic config object. In Reiner's blog, the unmodified GetDynamicConfig() returns undefined.  Since at least CS 16.2.10 and higher, it now returns an Assoc that actually resembles what Reiner added in his blog (is he OT's latest secret Smart UI development lead).  In that default object, the keys are all paths, things like "csui/lib/some/param", which leads me to wonder if only bits which match a particular oath are supposed to show, while others should be ignored.

It would be helpful if OpenText could post a *full* example on how you access this dynamic config from your custom command and/or widget, *including* what requireJS dependencies we need to define.

Thanks

-Hugh

HFCDev

I found what was missing.

Within your command, you can add "module" to your define statement. Taking the rename command from the samples in the SDK directory, and assuming you copied the example into your module, let's call it mymodule, you would alter the existing define statement to include "module".  In this case, I'm altering samples/commands/rename/rename.command.js, having copied it to mymodule/commands/rename/rename.command.js:

define(['require', 'csui/lib/jquery', 'csui/utils/base', 'csui/utils/log',
  'i18n!mymodule/commands/rename/impl/nls/lang', 'csui/lib/backbone',
  'csui/models/command', 'csui/utils/commandhelper', 'module'
], function (require, $, base, log, lang, Backbone, CommandModel, CommandHelper, module) {
  'use strict';

  // you can put this statement in the function, or you can put it in one of the methods.

  var config = module.config();

  // Example, use your module config inside the enabled function

  enabled: function (status) {
      // Check that a single node, which can be modified, was selected
      var node = CommandHelper.getJustOneNode(status);
      // If the permission information is not available (undefined), enable
      // the command on the client side and let the server check it

      // ADDENDUM: lets say you want to turn the command on or off depending on a server

      // side setting you store in your Oscript module.

      if (config.FeatureEnabled)

          return node && node.get('perm_modify') !== false;

      else

          return false;

    },

...and the rest of your rename command

In Oscript, you would override the GetDynamicConfiguration() method inside the CSUIExtensions object that would be orphaned into your module.  To the config assoc, you would add something like this:

Assoc config

Assoc myConfig

myConfig.FeatureEnabled = TRUE

config.("mymodule/commands/rename.command/rename/rename.command") = myConfig

-Hugh