Unable to register greetings widget in PerspectiveManager

Please, advise where to look in case of absence of sample widget after successfully module deployment? I built greetings module with default names, got some warnings, but no errors - see log attached.
I built and installed greetings module from /out-module folder. So I can see the successfull loading of greetings module in OClipse console log on startup, and there is an \OPENTEXT\support\greetings folder in place.
And even see something about greetings in "bundleIndexes" assoc in logs when i open PerspectiveManager page.
But there is nothing new in PerspectiveManager.
Can somebody give any suggestions, where should I look at?

CS UI Building.log

Oclipse Console.log

support_greetings.png

PerspectiveManager.png

Find more posts tagged with

Comments

Ian_Whitfield

Hi Alexander,

In general it looks like you have deployed the application in the correct location and that the bundle is being picked up on the system.

You can check http://server/cgi/cs.exe/app/confg to see the Smart UI configuration of your Content Server instance.

I would expect to see the greetings app listed in the path definitions at the top of the /app/config page and some further references in the page depending on which components are loaded as part of your app.

There is some extra configuration that is required for the Perspective Manager to see the widget you have created. This is documented in the SDK under /doc/csui/models/widget/widget.discussion/index.html

The main piece of configuration you need is to add your widget to the widget collection in your extensions json file. An example might be:

"csui/models/widget/widget.collection": {
"widgets": {
"greet": [
"greet/widgets/mywidget"
]
}
}

The Perspective Manager queries this collection to display available widgets on the Configure page.

If this is already present or doesn't resolve the issue can you post any references to greetings you find at /app/config in the forum to help identify what might be missing.

Regards
Ian

Alexander Poltavtsev

Hello, Ian!

Thank you for your replay.

Yes, I could see this entry in my config, it was already there.

Please, find my config attached.

app_config.txt

Ian_Whitfield

Hi Alexander,

Looks like the widget collection extension is registered but there is no manifest file defined in your bundle for the widget.

For each widget you want to make available in the Perspective Manager you have to have a manifest file and this also has to be referenced in your bundle index. This manifest file defines the basic information about your widget the Perspective Manager needs and also any options you want to specify. If you don't have a file already for this then the spec is defined in the SDK doc I mentioned in my previous post. If you do have a manifest file at the same level as your hello.view you just need to update your bundle file to reference it. See the following examples for the core csui widgets in the /app/config:

  "json!csui/widgets/favorites/favorites.manifest.json",  "json!csui/widgets/myassignments/myassignments.manifest.json",  "json!csui/widgets/placeholder/placeholder.manifest.json",  "json!csui/widgets/recentlyaccessed/recentlyaccessed.manifest.json",  "json!csui/widgets/shortcut/shortcut.manifest.json",  "json!csui/widgets/welcome.placeholder/welcome.placeholder.manifest.json",

e.g.

"greet/bundles/greet-all": [  "greet/widgets/hello/hello.view",  "json!greet/widgets/hello/hello.view.manifest.json"]

There should also be a corresponding json file for the manifest under the nls area to support localization. This is detailed in the SDK doc too.

Regards
Ian

Ferdinand Prantl

As Ian guessed, the problem is in the missing manifest. According to the log you just generated a new project and tried to deploy it. Logs showed no problem, but there is a known bug in the 16.0.3 SDK - missing manifest for the hello widget.

We'll fix it in the upcoming 16.0.4 SDK update. You can fix the generated project, as described in the related post.

If you suspect, that something goes wrong in Perspective Manager, or somewhere else in Smart UI, open the console from the browser developer tools and have alook, if you can see some errors. In this case, the missing manifest file would be logged as a missing file access (404).

How to investigate extension loading problems

Sanity check of your module, if a widget does not turn up, where it should:

1. "<cgi url>/app/config" contains path to your extension module (OScript registration succeeded):

    csui.require.config({      paths: {        ...        'greet': '/otcssupport/greet'      }

2. "<cgi url>/app/config" contains the main bundle index of your extension module ("bundles/greet-all.json" was found, parsed and applied):

    csui.require.config({      ...      bundles: {        ...        "greet/bundles/csui-data": [          "greet/widgets/hello/hello.view",          ...        ]

3. "<cgi url>/app/config" contains the estension point registration for your module ("greet-extensions.json" was found, parsed and applied):

    csui.require.config({      ...      config: {        "csui/models/widget/widget.collection": {          "widgets": {            "greet": [              "greet/widgets/hello",              ...            ]          }        },        ...      }

If these declarations, which come:

The CSUI::Extension orphan
The file "bundles/greet-all.json" from the support directory (built to out-release)
The file "greet-extensions.json" from the support directory (built to out-release)

are all in place and complete in the script response of the URL "<cgi url>/app/config" , you should "hope" to see some error on the console. The console is what I open first, whene something appears to go wrong :-)

Alexander Poltavtsev

Hi, Ian!

Thank you for pointing me to the right direction! And for rtfm advise.

To fix missing manifest issue, I copied ..\my-extension\src\widgets\hello folder to the C:\OPENTEXT\support\greetings\widgets\

and add to the file C:\OPENTEXT\support\greetings\bundles\greet-index.json manifest registration row: "json!greet/widgets/hello/hello.view.manifest.json", so now it looks exactly like you provided.

And that's works!

Thank you so match!

Alexander Poltavtsev

Hello, Ferdinand!

Thank you for this post. I'll try to generate my extension module again with all three advises from there:
а) correct greet-all.js
b) some new samples
c) different module name and prefix

_____________________________

And yes - I have seen 404 error in console for hello widget manifest. So from now I know where to look too. ))
Thank you!

P.S. Bonus stupid question: where is lives cgi/app/config file in file system?