FieldContext Object Members for SuiteScript Workbook Columns

TL;DR

FieldContext object members are critical for managing table columns in SuiteScript, enabling developers to define field context names and parameters when using the Workbook module.

What is the FieldContext Object?

The FieldContext object in SuiteScript is used for creating and managing table column contexts. This object is particularly useful in scenarios where developers need to control how data is displayed or integrated into custom forms and reports.

What Members Does the FieldContext Object Have?

The FieldContext object consists of two primary members:

How to Create a FieldContext Object

To create a FieldContext object, utilize the workbook.createFieldContext(options) method with the appropriate options. Here’s how:

1// Creating a basic FieldContext
2d:
3var myFieldContext = workbook.createFieldContext({
4    name: 'My Field Context'
5});
6 
7// Creating a complete FieldContext with parameters
8var myFieldContextWithParams = workbook.createFieldContext({
9    name: 'My Field Context',
10    parameters: {
11        parm1: 'ABC'
12    }
13});

Accessing FieldContext Properties

When working with a workbook that has already been defined, it is possible to access the FieldContext properties as shown in the example below:

1// Load an existing workbook
2var myWorkbook = workbook.load({
3    id: myWorkbookId
4});
5 
6// Accessing FieldContext properties
7var myFieldContext = myWorkbook.tables[0].columns[0].fieldContext;
8 
9log.audit({
10    title: 'FieldContext.name = ',
11    details: myFieldContext.name
12});
13log.audit({
14    title: 'FieldContext.parameters = ',
15    details: myFieldContext.parameters
16});

Important Notes

• The FieldContext.name property must be a string; otherwise, a WRONG_PARAMETER_TYPE error will be thrown.
• The parameters object can hold additional configurations, enhancing the flexibility and functionality of the FieldContext.

Key Benefits

• Effective management of field contexts aids in dynamic data presentation and functionality in custom scripts.
• Reduces manual errors by leveraging defined properties and parameters for tables and forms.

Who This Affects

• Developers: Managing SuiteScript workbooks in custom applications.
• Administrators: Implementing and maintaining custom scripts involving table definitions.

Key Takeaways

• The FieldContext object is crucial for defining column attributes in SuiteScript workbooks.
• Custom parameters enhance the use of field contexts in tailored applications.
• Ensure string type is maintained to avoid runtime errors.