How do I register a new custom widget in OpenText

Greg Skipworth

Below the process I'm following to create a widget:
====================================

# Ignore this first part its Ubuntu only
# On a fresh ubuntu machine.
# curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -
# sudo apt-get install -y nodejs

 
# Remove sudo for Windows. Also refer to the original readme.md for the generator.
sudo npm install -g grunt-cli
sudo npm install -g yo
unzip generator-csui-extension-16.2.4.zip
cd generator
sudo npm link
cd ..

 
# Widget skeleteon.
mkdir example1
cd example1
yo csui-extension

# The output -->
? CS module name: greetings
? CS module description: CS UI greetings extension module
? RequireJS module prefix: greet

grunt --force
yo csui-extension:widget
 
# The output -->
? Widget directory name: hello
? Widget class name prefix: Hello
? Widget CSS class name: -hello
? Widget manifest title: Hello
? Widget manifest descriotion: Welcomes the current user.
? Widget target bundle: greet-all
Writing the widget to "src/widgets/hello"...
   create src/widgets/hello/hello.manifest.json
   create src/widgets/hello/hello.md
   create src/widgets/hello/hello.view.js
   create src/widgets/hello/impl/hello.css
   create src/widgets/hello/impl/hello.hbs
   create src/widgets/hello/impl/hello.model.factory.js
   create src/widgets/hello/impl/hello.model.js
   create src/widgets/hello/impl/nls/lang.js
   create src/widgets/hello/impl/nls/root/lang.js
   create src/widgets/hello/test/hello.mock.js
   create src/widgets/hello/test/hello.spec.js
   create src/widgets/hello/test/index.html
conflict src/greet-extensions.json
? Overwrite src/greet-extensions.json? overwrite
    force src/greet-extensions.json
conflict src/bundles/greet-all.js
? Overwrite src/bundles/greet-all.js? (ynaxdH) y
>> overwrite

grunt --force

# compress the whole example1 directory and copy to Windows Server with oclipse installed.
# Now on the windows server create a OScript project.
# called project greeting_proj
# OTHOME = E:\OPENTEXT

# Now import out-module from first process as file import.

Into greeting_proj/srcmodules import out-module.
Right click greeting_proj/srcmodules/greetings and select "Build Module"
Below is the tree views of what in greeting_proj and the staging directory of opentext after “Build Module”
 

PS H:\> tree /f E:\eclipse_workspace\greeting_proj
Folder PATH listing for volume New Volume
Volume serial number is 5ACD-15C2
E:\ECLIPSE_WORKSPACE\GREETING_PROJ
│   .livelink
│   .project
│
├───ospaces
└───srcmodules
    └───greetings
        │   greetings.ini
        │
        ├───GREETINGS
        │       Configure.os
        │       CSUIExtension.os
        │       GREETINGSGlobals.os
        │       GREETINGSRequestHandlerGroup.os
        │       GREETINGSRoot.os
        │       GREETINGSWebModule.os
        │
        └───support
            │   greet-extensions.json
            │
            └───bundles
                    greet-all-rtl.css
                    greet-all.css
                    greet-all.js
                    greet-all.js.map
                    greet-index.js
                    greet-index.js.map
                    greet-index.json
                                                    
                                                        

PS H:\> tree E:\eclipse_workspace\greeting_proj
Folder PATH listing for volume New Volume
Volume serial number is 5ACD-15C2
E:\ECLIPSE_WORKSPACE\GREETING_PROJ
├───ospaces
└───srcmodules
    └───greetings
        ├───GREETINGS
        └───support
            └───bundles

PS H:\> tree /f E:\OPENTEXT\staging\greetings_1_0_0
Folder PATH listing for volume New Volume
Volume serial number is 5ACD-15C2
E:\OPENTEXT\STAGING\GREETINGS_1_0_0
└───ospace
        greetings.oll

 

# Where is my widget please?

Ferdinand Prantl

Your source directory of the CS module "E:\ECLIPSE_WORKSPACE\GREETING_PROJ" is complete. However, the staging directory "E:\OPENTEXT\STAGING\GREETINGS_1_0_0" generated by Oclipse lacks the "support" subdirectory with the Smart UI extension.

I noticed it recently, but I haven't figured out yet, how to make Oclipse deploy a module with the Smart UI extension completely. I recommend you the following as a workaround:

1. Copy the content of the "support" subdirectory from your source project to "E:\OPENTEXT\STAGING\GREETINGS_1_0_0\SUPPORT" and to "E:\OPENTEXT\SUPPORT\GREETINGS".
2. Restart the server running in Oclipse.

You should be able to use the "Hello" widget then.

Notes to your workflow:

If you swap the globally installed nodejs deb package with the user-local nvm packages, you will be able to:

• Get rid of sudos.
• Install multiple nodejs versions and switch among them, depending on the project, which you're working on.

You would uninstall the nodejs, install nvm and add node 6 or 8 as the default version. I recommend you the latest LTS version - 8.

And you should run "grunt" instead of "grunt --force". If you see some errors, they are to be fixed; not ignored :-)