1. SuiteCloud Platform
  2. SuiteCloud Development Framework
  3. Developing SDF Custom Objects
  4. Plug-ins
  5. Financial Institution Connectivity Plug-ins as XML Definitions

Financial Institution Connectivity Plug-ins as XML Definitions

Note:

Financial Institution Connectivity Plug-in objects in SuiteCloud Development Framework (SDF) only support SuiteScript 2.0. SuiteScript 2.1 is not supported.

You can create and manage a Financial Institution Connectivity Plug-in implementation in a SuiteCloud project and deploy it to a target NetSuite account. The Financial Institution Connectivity Plug-in enables you to directly connect to financial institutions and automatically receive bank data imports, daily. For information about how these plug-ins are used, see Financial Institution Connectivity Plug-in Interface Overview.

You can also import a Financial Institution Connectivity 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 Financial Institution Connectivity Plug-in implementation in a SuiteCloud project, you must create a plug-in implementation script file. For details, see Create a Financial Institution Connectivity Plug-in Implementation Script File.

To run a Financial Institution Connectivity Plug-in, you must configure and save a format profile record in the NetSuite account that uses the plug-in implementation. Invoking the plug-in is only possible in the NetSuite UI, since SDF does not support format profile records.

For details on running the plug-in, see Conditions for Running a Financial Institution Connectivity Plug-in. For information about format profile setup, see Creating Format Profiles for Bank Reconciliation.

Note:

If you have the administrator role, you can uninstall an SDF SuiteApp containing a Financial Institution Connectivity Plug-in implementation that is already used in a format profile. This is true even if the format profile has been used to import data. After you uninstall the SDF SuiteApp, NetSuite does the following:

  • Removes the plug-in reference from the format profile. The Connectivity Method field in the format profile is changed to Manual Import.

  • Inactivates the format profile. You can reactivate the format profile if it contains a parser plug-in, but the record will be configured for manual import unless you change the connectivity method.

    Important:

    Format profiles configured to import expense data do not currently support manual import. Before reactivating a Corporate Card Expenses format profile, ensure that you configure the record for automatic import. See Creating Format Profiles for Expense Reporting.

    If the format profile does not contain a parser plug-in, you must select one before you can reactivate the format profile. See Modifying Format Profiles. If you no longer need the format profile, you should delete it. See Deleting a Format Profile.

Financial Institution Connectivity Plug-in implementations in SDF are represented with the ficonnectivityplugin object. To define this SDF custom object, see the following sections:

Create a Financial Institution Connectivity Plug-in Implementation Script File

You need to have a Financial Institution Connectivity Plug-in implementation script either in the target account, or in the same SuiteCloud project as your SDF custom object. For more information, see Creating a Financial Institution Connectivity Plug-in Script File and SuiteScript Files in SuiteCloud Projects.

Financial Institution Connectivity Plug-in Implementation Required Fields

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

Element

Type

Description

name

string

A user-friendly name for the Financial Institution Connectivity Plug-in implementation. The name is seen by administrators when they activate or deactivate the Financial Institution Connectivity 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 Financial Institution Connectivity Plug-in.

This field must reference a .js file.

Financial Institution Connectivity Plug-in Implementation Object Example

The following is an XML definition example of a Financial Institution Connectivity Plug-in implementation object in a SuiteCloud project.

The Financial Institution Connectivity 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 retrieve bank data from a financial institution.

Note:

Each ficonnectivityplugin SDF custom object requires a scriptfile field reference to a SuiteScript file that implements interface functions. For more information, see Creating a Financial Institution Connectivity 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.

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

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

Related Topics

General Notices