Installing Tax Reporting Framework through TRF CLI

Installing the TRF CLI enables you to create new tax reports using the command line.

Prerequisites for Installing Tax Reporting Framework CLI

To install the Tax Reporting Framework Command Line Interface (TRF CLI), you must install the Node Package Manager on your computer. To install Node Package Manager (NPM), see NodeJS Downloads.

Installing the Tax Reporting Framework CLI

To install the TRF CLI, you need to run the following commands in your command line:

• Using NPM:

                  npm install -g @oracle/tax-reporting-framework-cli 
  
                

• Using NPX:

                  npx @oracle/tax-reporting-framework-cli create 
  
                

Creating a New Project in TRF CLI

Installing the TRF CLI enables you to create a new report using the command line.

To create a new report using TRF CLI:

1. Open your command line.

2. Enter the following commands:

                     trf create 
   
                   

3. Using the arrow keys on your keyboard, select an option from the interactive menu and press enter to make a selection:

   • Project Type. Select TAF.

   • Select SDF Project Type. Select either SuiteApp or Account Customization.

   • Select Search Type. Select either Search or SuiteQL.

   • Enter project name. Enter your project’s name.

   • Enter report country. Enter the country you want to create the report for. Use the the ISO 3166 Alpha-2 codes format. See the Glossary for ISO 3166 page for more details.

After you create a new report, you can edit the report files in customizing the report. See Updating and Modifying the Country Tax Report for details.

Downloading and Extracting the Tax Reporting Framework Archive

If you plan to start the project without installing the TRF CLI, you can download and extract the project files manually instead. To do this, you need to copy the files from the Country Tax Report (CTR) project ZIP file into your project folder. The Country Tax Reports (CTR) project ZIP file contains the necessary structure and sample code for you to modify and configure to generate the tax reports you need to make.

Before you download the contents of the folder, check whether you have access to the project folder. Go to the project archive and download the project file depending on the type of report you are building.

For Tax Audit Files, download the following zip files:

• tafsearch.zip – Download this zip file if your project uses Saved Searches. For more information, see Saved Searches.

• tafsuiteql.zip – Download this zip file if your project uses SuiteQL. For more information, see SuiteQL.

For VAT reports, download the vat.zip file.

After you download the project ZIP file, you should find the following files in the folder:

Files in tafsearch.zip

• deploy.xml

• manifest.xml

• FileCabinet (folder)

  SuiteApps (folder)

  com.netsuite.tafsearch (folder)

  • src (folder)

    • components (folder)

      tafsearch_installer.js

    • processors (folder)

      pre (folder)

      SearchPreProcessor.js

    • records (folder)

      • str_localized_bundle.json

      • str_localized_reports_list.json

      • str_localized_searches.json

    • schemas (folder)

      • TAF_SEARCH.json

      • TAF_SEARCH_META.json

    • templates (folder)

      TAF_TEMPLATE.ftl

  • UUID_FILE

• Objects (folder)

  customscript_tafsearch_installer.xml

Files in tafsuiteql.zip

• deploy.xml

• manifest.xml

• FileCabinet (folder)

  SuiteApps (folder)

  com.netsuite.tafsuiteql (folder)

  • src (folder)

    • builders (folder)

      SuiteQLBuilder.js

    • components (folder)

      tafsuiteql_installer.js

    • processors (folder)

      pre (folder)

      SuiteQLPreProcessor.js

    • records (folder)

      • str_localized_bundle.json

      • str_localized_reports_list.json

      • str_localized_searches.json

    • schemas (folder)

      • TAF_SUITEQL.json

      • TAF_SUITEQL_META.json

    • templates (folder)

      TAF_TEMPLATE.ftl

  • UUID_FILE

• Objects (folder)

  customscript_tafsuiteql_installer.xml

Copy the contents of the folder in its entirety to your project folder. If you do this, ensure you replace all instances of “ com.netsuite.tafsearch” or “ com.netsuite.tafsuiteql” with the correct project id/name.

Files in vat.zip

• src

  • builder

    CustomerQueryBuilder.js

  • entry_point

    • bi

      bundle_installation.js

    • si

      sdf_installation.js

    • images

      image_of_logo.png

    • processor

      GeneralDataProcessor.js

    • records

      • str_localized_bundle.json

      • str_localized_reports_list.json

      • str_localized_searches.json

    • schema

      • BASE_VAT_DETAILS.json

      • BASE_VAT_META.json

      • BASE_VAT_SUMMARY.json

    • templates

      • STR_BASE_VAT_PDF.xml

      • STR_BASE_VAT.html

    • constants.js

• UUID_FILE

• Objects/script

  customerscript_trf_base_report_sdfinstall.xml

• deploy.xml

• manifest.xml

Related Topics

Downloading and Extracting the Country Tax Reports Project Files

General Notices