For CS21.4 is there a clean way to install the SDK???

HFCDev · 2021-11-20T20:27:23+00:00

There was an error rendering this rich post.

Hi,

I'm revisiting this after a year. I gather in CS 21.2 the SDK was messed up. So I've waited until CS 21.4 was released to try again. Is there an OUT OF BOX way to install the SDK? I'm following the instructions inside the Readme.md file contained within the CSUI SDK download. Here is what I did:

1. Install NodeJS 12 (any recent NodeJS version should work)

I installed NodeJS 16.13.0 ( the current stable release)

2. Install Grunt: "npm i -g npm grunt-cli"

This worked.

3. Change directory to the unpacked SDK root

4. Run "npm ci"

This hangs. Here is a screenshot of the point where it hangs:

It never advances beyond this point. I googled it a bit and discovered that ci stands for Continuous integration, and that it's a glorified npm install, so next I tried npm install --verbose. Similarly it gets to a point then hangs:

I did notice that just like a year ago, the package.lock.json file contains a whole bunch of Internal OpenText links (i.e. https://opentext.net) which are not resolvable outside the OT corporate intranet.

5. Run "npm start"

I tried this on the off chance that maybe it installed everything it needed. No such luck!!

As I recall a year ago, I was able to get past this point, but had to be constantly switching between versions of nodeJS. Is that still the case? CS 21.4 was not released long ago.

Is there a set of instructions I should follow to install the SDK, the generator, yeoman, and all the other tools I need to start working on this? If I didn't know better, I'd say that OpenText was not serious about wanting anyone to be able to develop with smart UI.

-Hugh

Find more posts tagged with

Comments

HFCDev

I got the basic build to work by doing the following:

1) Use NVS so I can select my version of node;

2) Used nodeJS 12.27.x (the last of the node v12);

3) Installed globally grunt-cli and yo (npm install -g grunt-cli yo)

4) Ran npm install in the csui folder (created from the csui zip file)

5)Ran npm link from the generator folder

6) ran yo csui-extensions from my empty project folder

7) ran yo csui-extensions:widget from the same.

This all basically worked. I was able to get a basic widget going. Now here are some things I'd like to see if I can get ironed out:

* grunt compiles everything fine when I use 'define' but as soon as I try to run it in Content Server, I need it to be csui.define. This means that I have to use grunt --force;

* grunt is no longer giving me an out-module directory. For the most part, I can work around this because I already had the necessary object from another project and I just revived it. However, for those starting out, this could be a problem.

* grunt running chrome headless always crashes. So it looks like the tests fail.

Can anyone comment on the above? Also what is the highest version of node that this has worked for anyone?

-Hugh

David Henshaw

Hi Hugh - been a while since I used the Smart View SDK "from scratch" (i.e. build a new solution), but if I recall correctly, isn't the out-module generated when you use the yeoman generator, rather than during the actually grunt build? i.e. steps 6 and 7 ?

HFCDev

If it's yo generating the out-module directory, that ain't happening anymore. But you're probably right - it's only a small stub you actually need any oscript for (effectively, something to populate a registry so that your JS code gets found), and it doesn't vary.

I'll take a peek at the Yeoman file to see if I can find it. But the question still remains - where's my out-module directory? I did run yeoman.

-Hugh

Abdelfattah Hussein

Hello Hugh Ferguson,

for solving this problem, what can i do?

Regards,

Abdulfattah Hussein

Appu Nair

There’s a very detailed walk through by Mathew Barben . As recently as a month or two months one of my colleagues having trouble with Ot official documentation told me his walk through worked. I think I had a link for his project here in case you can’t find it try to see if this would work

https://medium.com/driver-lane/smart-ui-with-a-sprinkle-of-ci-cd-c591bcd77214

Hari Prasad Dontu

We had the same problem (in earlier version) and even in 21.4. We resolved this by changing the node version to 12. (latest patch of 12). You can try with "nvm" for different node versions.

Ferdinand Prantl

You can ignore the warning about a different verison of the package lock. NPM handles it with backwards and forwards compatibility.

You can ignore the *.opentext.net links in the package.lock. They point to the NPM registry to proxy-cache the NPM communication. The URL is replaced by the NPM registry URL used on your machine.

When you run "npm ci --verbose", what is the end of the console output, which is hanging?

If "npm ci" or "npm i" failes, they will roll back all what they did. It does not make sense running any other commands, as longas the node_modules installation does not succeed.

Ferdinand Prantl

Q: grunt compiles everything fine when I use 'define' but as soon as I try to run it in Content Server, I need it to be csui.define. This means that I have to use grunt --force;

A: I have never seen a case, when the --force helped. It applies to all tasks and hides error further in the pipeline. If some task fails and it is not the critical one, you can edit the Gruntfile and disable it temporarily.

Q: grunt is no longer giving me an out-module directory. For the most part, I can work around this because I already had the necessary object from another project and I just revived it. However, for those starting out, this could be a problem.

A: Ignore it. It did not work as intended. Instead, the SDK documentation should describe how to create a new Oclipse project. See other post about the out-module too.

Q: grunt running chrome headless always crashes. So it looks like the tests fail.

A: What is the error?

Q: Also what is the highest version of node that this has worked for anyone???

A: I start with the current Node.js. If something fails, I downgrade the Node.js to the version used during the development of the particular version of Smart UI, which means half a year before the release. The development window of 21.4 was May-August 2021. We used Node.js 12. Some people started using Node.js 16 for development of 22.1. 22.2 was developed with Node.js 16.

I switch among the Node.js versions using a version manager to survive with many projects on a single machine. I do it globally, because most projects with with the current LTS. I used nvm for a long time on Linux and Mac. I switched to fnm because bash begun to start too slowly wit nvm. Earlier I used nvs and later nvm-windows on Windows.