2023-10-26 13-27-42
Isaac Wangombe
27Views
7Comments
Solved
when to use required scripts client variable vs required scripts on screen level
Question
JavaScript

I have noticed you can either define the script required for your JavaScript at the screen level in the "Required Scripts" section, or you can use the Client Action "Required Scripts" to call it inside your action.
Is there a best practice on when you should use one over the other and is there an advantage to using the client action over describing it at screen level? (Because I would assume defining it at screen level would make it more reusable)

Thank you in advance

0
0
09 Nov
Solution

Hi @Isaac Wangombe ,

i think putting the scripts you need in the required scripts section of a screen or block is the default way of doing this.  It is what the documentation suggests you do, and if you look at components made by OS, like the default layout blocks, or the Outsystems UI blocks, that's what these also do.

The reasons i could imagine for doing it in a client action instead : 

  • you only occasionally need the script, and don't want it to load unless needed
  • you have several interrelated scripts that need to happen in a very specific sequence

see this section on javascript in the documentation, with this chapter on using scripts.

Or see this learning material.

Dorine

See solution in context
1
0
09 Nov

Hi Isaac Wangombe,

It is not advisable to use javascript in screen level or Actions level until unless it is really necessary.

If we use a heavy javascript on a screen level it may create performance issues.

Client Action level javascript can access the screen HTML elements and also we can pass the dynamic ID. 

We need to make it lighter and re-usable scripts with lesser dependency of other components.

Hope it helps.

0
0
09 Nov

Hi @亗『ＡＲＡＶＩＮＤ』亗 ,

I'm not sure I understand this answer, do you mean it is advisable to have large scripts under the script section as opposed inside a javascript node ?  Agree, but I think Isaac is already doing that.  Or do you mean someting else ?

I think his question is about how to indicate that you need a given script in a given screen or block.

Dorine

0
0
09 Nov

Replying to Dorine Boudry's comment on 09 Nov 2023 07:40:42

Hi Dorine,

I was saying that, using js unnecessarily without experiencing platform widgets may leads to performance issues.

0
0
09 Nov

Thank you so much for your response Aravind,
So when using the scripts, it is more advisable to use this:

As opposed to this:

0
0
09 Nov

Yeah, require scripts for Online JS URL.
Second option is offline.

0
0
09 Nov
Solution

Hi @Isaac Wangombe ,

i think putting the scripts you need in the required scripts section of a screen or block is the default way of doing this.  It is what the documentation suggests you do, and if you look at components made by OS, like the default layout blocks, or the Outsystems UI blocks, that's what these also do.

The reasons i could imagine for doing it in a client action instead : 

  • you only occasionally need the script, and don't want it to load unless needed
  • you have several interrelated scripts that need to happen in a very specific sequence

see this section on javascript in the documentation, with this chapter on using scripts.

Or see this learning material.

Dorine

1
0
09 Nov

Thank you @Dorine Boudry,

This is exactly what I was wondering

0
0
23 Nov
Community GuidelinesBe kind and respectful, give credit to the original source of content, and search for duplicates before posting.