Row script

From Resco's Wiki
(Redirected from Row Script)
Jump to navigation Jump to search
Rules and examples

Row script.png Row script rules are executed for each row when a view is loading or refreshing. If your view includes multiple row designs, you can use row script to define conditions when a specific row design should be used. Another use case for row script is defining custom variables and placing them on the view.

An additional example of row script use is available on our blog: blog post Blog

Dos and don'ts

  • Always initialize shared variables before using them. If you use multiple shared values, initialize them in order. This applies to all rules but can be particularly critical in the case of views, where uninitialized shared variables may cause the app to crash.
  • Do not use LoadFetch, LoadReference, and NewInstance in row scripts, even if Woodford allows you to configure them. These asynchronous operations do not work in this context and can cause problems.

Multiple views example

In the following example, we will create a second row with a red background, this will be used when the field Name does not contain data.

Create a new style with red background

  1. Click Edit Styles to display the Style editor.
  2. Select primary from the style list, and then click Add. This creates a clone of the primary style.
  3. Change the BackColor (background), ForeColor (text color), and rename the style (for example Red Primary).
  4. Click Save & Close to close the styles editor and return to the view designer.

Create a second row

You have multiple options for creating rows:

  • Click Clone Row to create a copy of the row selected in the Properties pane. Then rename the row, for example to RedRow.
  • Click Add Row to create an empty row, where you can add fields and design it from scratch.
  • You can also click Copy Design to copy the design of any view from any entity.

In the new row, select a cell and change the style from Primary to Red Primary.

Create a row script

To define when and how the different the row designs are used, you need to set up a row script. Row script is a combination of steps and conditions (what should happen and when).

  1. Click Row Script to open the script editor.
  2. Add the following conditions and steps.
    If entity.name does not contain data
    Then Step TemplateIndex Assign RedRow
    Else Step TemplateIndex Assign Default
  3. Click Save & Close.

Custom field on the view

In this example, we create a custom field to add to the Order view row. First, we add a new string variable where we concat the fields we wish to have in the row.

Custom field on the view step 1

Next, we add this variable to our row.

Custom field on the view step 2

This is how it looks in the application.

Custom field on the view step 3

Custom label for Calendar activities

The calendar is divided into four views: Agenda, Day, Week, and Month. While the Agenda view displays all fields from the selected entity view, the other calendar views show only the information from the first field with Primary style. In this example, we create a custom field to display multiple fields in the rest of the Calendar views.

Start by creating a new view either for Activity or any activity entity type.

Custom label for Calendar activities: New view step 1

In the View editor, Click the Row script in the topbar panel. Create a new string variable by choosing the “Format Text” option from the available actions. In the text field, type what you want to see on the label.

  • For entity records, use curly brackets and insert field logical (not Display) name, e.g. {Entity.name} or {Entity.regardingobjectid}.
  • For new lines, use \n.
  • For additional text that's not part of the data; just type into a string.

String used in this example: {Entity.name}\nRegarding: {Entity.regardingobjectid}\n{Entity.scheduledstart}
Custom label for Calendar activities: Custom field string in Row Script step 2

Save the Row script and add the custom field into your view.
As mentioned in the beginning, Calendar (other than the Agenda view) shows only the information from the first field with the Primary style. Therefore, make sure that the custom field has the style set to Primary.

Custom label for Calendar activities: add custom field into view and check style step 3

This is how the final result looks in the app:

Custom label for Calendar activities: in-app result step 4

Change style on view dynamically

Since version 10.1, there is also a different option in changing the field style on view dynamically, based on its value or other conditions instead of creating a different row design. It is also possible to change the field’s style by using Row Script directly.

To learn more about this approach, please check this part of WEBINAR and HERE to see the setup and see it in action. Webinar

Was this information helpful? How can we improve?