Adding NetSuite Data to the Template File

To add NetSuite data to your HTML report template, use FreeMarker, a Java library used to generate text outputs based on templates and dynamic data. FreeMarker interpolations will enable you to include NetSuite content in the template. An interpolation is an expression, such as ${record.entity} which is replaced in the output with the actual value of the expression. For complete information about FreeMarker, see the FreeMarker documentation

Every template consists of a number of cells with IDs that you create yourself. Valid Cell ID must start with a letter (A-Z) and it must not contain white spaces. Also, it must only consist of alphabetic characters, numeric characters, or the underscore (_) symbol. Finally, it must be unique (you cannot have multiple variables with the same Cell ID in one report).

Note that to comply with the FreeMarker syntax rules, all variables in your template must be prefixed with the $ sign. Therefore, follow these conventions when adding different types of variables to your cells:

• Cells containing text – If you want to use a variable containing text only in your cell, use the "name" attribute. The math part of such variable will be ignored. To learn more about variables created by the Country-Specific Reports SuiteApp, see Variables in Country-Specific Reports.

  The following example shows how the text variable with cell ID MY_VARIABLE should look like in your template:

                <p>${VAR.MY_VARIABLE.name}</p> 
  
              

• Cells containing math operations – If you want to use a variable containing sums and differences in your cell, use the "value" attribute (or "value2" if your report uses the second comparative column). The text part of such variable will be ignored. To learn more about variables created by the Country-Specific Reports SuiteApp, see Variables in Country-Specific Reports.

  The following example shows how the math variable with cell ID MY_VARIABLE should look like in your template:

                <p>${VAR.MY_VARIABLE.value}</p> 
  
              

  Note:

  If your variable has both text (Name) and math operations (Sum of Values) defined, you can apply it as both a text variable and as a math variable (in different cells of your report). To do so, use a different attribute (“name” or “value”) as shown in the examples above.

• Cells containing system variables -System variables add various information to your report drawing data from the NetSuite system. These variables must be added directly to your template and must start with a prefix SYS (for example, SYS.companyaddress). To learn more about the system variables (and to view the list of all system variables available), see System variables.

  The following example shows how the system variable User Name should look like in your template:

                <p>${SYS.username}</p> 
  
              

  Note:

  Unlike standard variables, the system variables are added directly to your HTML/XML report template. It means that you don’t have to create separate NetSuite records for them.

• Cells containing filter variables -Filter variables contain information about filters currently selected in the report. This is particularly important in exported files -the data in them depend on selected filters. These variables must be added directly to your template and must start with a prefix FLT (for example, FLT.subsidiary). To learn more about the filter variables (and to view the list of all filter variables available), see Filter variables. To learn more about filters in the Country-Specific Reports SuiteApp, see Filters in Country-Specific Reports.

  The following example shows how the filter variable Subsidiary Context should look like in your template:

                <p>${FLT.subsidiary}</p> 
  
              

  Note:

  Unlike standard variables, the filter variables are added directly to your HTML/XML report template. It means that you don’t have to create separate records for them.

General Notices