How to Debug Javascript in Vidispine Using Eclipse

How to Debug Javascript in Vidispine Using Eclipse by Patrik May 31, 2016 Tips & Tricks

Vidispine uses Javascript to handle more complex workflows than what can be handled with the out-of-the-box solution. When involving a language you also want to be able to debug what you write. It's simple to set up Eclipse to debug Javascript in Vidispine. It's also possible to debug Javascript inside a shape or during a transcode.

While Vidispine can manage a lot situations straight of the box, most users will sooner or later have to customise parts of their workflow, and do custom integrations. With Vidispine you can use Javascript to extend operations in for example job tasks, transcode presets or naming scripts. The export template functionality is also an example of where Javascript is needed. When you extend beyond the most simple scripts you will probably need to debug your system, and add automatic regressions testing.

Setting up Eclipse to debug Javascript in Vidispine has been available since version 4.0.3. It's straightforward and covered well in the API documentation. Just make sure that you enable the Remote JavaScript configuration option in Eclipse.

When you want to debug scripts on shape tags you should use the test script endpoint on shapes GET /shape-tag/(tag-name)/item/(item-id)/shape/(shape-id), which executes the script against a specific item/shape and return the resulting transcode preset, which can then be verified. This method can also be used to set up regression tests/automatic tests for your transcode presets.

The JavaScript debugging also works with transcode preset scripts. Set debugJavaScript to true , then transcode using your preset. The transcode job will block once the script is executing and you can connect using the debugger. Use GET /javascript/session to list the active debugging sessions, which helps you find the right session and port to attach to.

What about all the generic code I have in several places

Ok, now you have written a bunch of Javascript snippets, and you realise that you have the same code in several places. For example, you have the same re-naming script on several different storages. We have a solution for that as well. You can register generic Javascript code in a type of global library. The code in the global library will be executed before the specific code. Best is to keep the code in the library are functions only. The generic Javascript is created using configuration properties of the form javascript-{extension} , where extension is any suffix.

LINK:	http://howto.vidispine.com/insight/how-to-debug-javascript-in-vidispin...
	See more stories from vidispine

Most recent headlines