Bank Statement Parser Plug-ins as XML Definitions

Note:

Bank Statement Parser Plug-in objects in SuiteCloud Development Framework (SDF) only support SuiteScript 2.0.

You can create and manage a Bank Statement Parser Plug-in implementation in a SuiteCloud project and deploy it to a target NetSuite account. The Bank Statement Parser Plug-in enables you to create and upload your own parsers for different bank and credit card statement formats and store them in NetSuite. The plug-in translates the information from unsupported file formats into account statements or transactions that NetSuite can understand and use. This enables you to import other file formats and then use downstream matching and reconciliation features.

For information about how these plug-ins are used, see Bank Statement Parser Plug-in Interface Overview.

You can also import a Bank Statement Parser Plug-in implementation from a NetSuite account into a SuiteCloud project. For more information about importing objects, see Account Component Imports to SuiteCloud Projects.

Customizing a plug-in implementation object from your SuiteCloud project is the equivalent of editing or making a new plug-in implementation from the NetSuite UI. For example, select Customization > Plug-ins > Plug-in Implementation > New from a NetSuite account.

To create a Bank Statement Parser Plug-in implementation in a SuiteCloud project, you must create a plug-in implementation script file. For details, see Create a Bank Statement Parser Plug-in Implementation Script File.

To run a Bank Statement Parser Plug-in, you must do the following:

Configure a format profile record that uses a Bank Statement Parser Plug-in implementation. See Creating Format Profiles for Bank Reconciliation.
Import your bank data into the NetSuite account. See Bank Data Import.

Note:

You can only invoke the Bank Statement Parser Plug-in from the NetSuite UI.

Bank Statement Parser Plug-in implementations in SDF are represented with the bankstatementparserplugin object. To define this object, see the following sections:

Create a Bank Statement Parser Plug-in Implementation Script File
Bank Statement Parser Plug-in Implementation Required Fields

Create a Bank Statement Parser Plug-in Implementation Script File

You need to have a Bank Statement Parser Plug-in implementation script either in the target account, or in the same SuiteCloud project as your XML object. For more information, see Creating a Bank Statement Parser Plug-in Script File and SuiteScript Files in SuiteCloud Projects.

Bank Statement Parser Plug-in Implementation Required Fields

The following table contains fields that are required for bankstatementparserplugin objects. For a list of all available fields, see bankstatementparserplugin.

Element	Type	Description
`name`	string	A user-friendly name for the Bank Statement Parser Plug-in implementation. The name is seen by administrators when they activate or deactivate the Bank Statement Parser Plug-in implementation. This field value can be up to 40 characters long.
`scriptfile`	filereference	The script file (`.js`) that contains the implementation for the Bank Statement Parser Plug-in. This field must reference a .js file.

Element

Type

Description

name

string

A user-friendly name for the Bank Statement Parser Plug-in implementation. The name is seen by administrators when they activate or deactivate the Bank Statement Parser Plug-in implementation.

This field value can be up to 40 characters long.

scriptfile

filereference

The script file (.js) that contains the implementation for the Bank Statement Parser Plug-in.

This field must reference a .js file.

Bank Statement Parser Plug-in Implementation Object Example

The following is an XML definition example of a Bank Statement Parser Plug-in implementation object in a SuiteCloud project.

The Bank Statement Parser Plug-in implementation object, customscript1, creates a new plug-in that is in TESTING status. Debugging messages are logged when the script is run. The owner of the object is notified whenever an error is thrown. The customscript1.js script is called when NetSuite receives a request to parse bank data.

Note:

Each bankstatementparserplugin SDF custom object requires a scriptfile field reference to a SuiteScript file that implements interface functions. For more information, see Creating a Bank Statement Parser Plug-in Script File. This script file can be in the target account or in the same SuiteCloud project as your plug-in implementation object.

            <bankstatementparserplugin scriptid="customscript1">
    <description></description>
    <isinactive>F</isinactive>
    <loglevel>DEBUG</loglevel>
    <name>Your Parser</name>
      <notifyadmins>F</notifyadmins>
    <notifyemails></notifyemails>
    <notifyowner>T</notifyowner>
    <notifyuser>F</notifyuser>
    <runasrole></runasrole>
    <scriptfile>[/SuiteApps/com.netsuite.yourapp/src/parser/your_parser.js]</scriptfile>
    <status>TESTING</status>
</bankstatementparserplugin>

For more information about the fields in the preceding example, see bankstatementparserplugin.

Create a Bank Statement Parser Plug-in Implementation Script File

Bank Statement Parser Plug-in Implementation Required Fields

Bank Statement Parser Plug-in Implementation Object Example

Related Topics