https://github.com/oracle/tax-reporting-framework-cli
Tax Reporting Framework CLI is a tool for generating boilerplate codes to quickly setup and deploy your reports using Tax Reporting Framework SuiteApp in NetSuite.
https://github.com/oracle/tax-reporting-framework-cli
cli netsuite reports tax tax-reporting-framework trf
Last synced: about 1 year ago
JSON representation
Tax Reporting Framework CLI is a tool for generating boilerplate codes to quickly setup and deploy your reports using Tax Reporting Framework SuiteApp in NetSuite.
- Host: GitHub
- URL: https://github.com/oracle/tax-reporting-framework-cli
- Owner: oracle
- License: upl-1.0
- Created: 2021-10-18T02:23:25.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-08-29T13:13:15.000Z (almost 3 years ago)
- Last Synced: 2025-03-24T13:21:27.592Z (about 1 year ago)
- Topics: cli, netsuite, reports, tax, tax-reporting-framework, trf
- Language: JavaScript
- Homepage:
- Size: 298 KB
- Stars: 5
- Watchers: 4
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Security: SECURITY.md
Awesome Lists containing this project
README
# Tax Reporting Framework CLI
Tax Reporting Framework CLI is a tool for generating boilerplate codes to quickly setup and deploy your reports using Tax Reporting Framework SuiteApp in NetSuite.
## What is Tax Reporting Framework?
Tax Reporting Framework is a powerful reporting framework that uses JSON schema for report definition, freemarker templates for report output and supports Saved Searches and SuiteQL as data source. It was previously named *SuiteTax Reports* but with the recent support for Legacy environment it was renamed to **Tax Reporting Framework**.
## Installation
### Installation using NPM
```
npm install -g @oracle/tax-reporting-framework-cli
```
### No installation required using NPX
```
npx @oracle/tax-reporting-framework-cli create
```
## Usage
```
Usage: trf [options] [command]
🚀 TRF CLI 🚀
Options:
-V, --version output the version number
-h, --help output usage information
Commands:
create create new TRF project 😎
```
## Sample
```
trf create
? Select project type. TAF
? Select search type. suiteql
? Enter project name. (The project ID must not be empty and can contain only lowercase alphabetic and numeric characters)
localization-ireland
? Enter report country. IE
------------------
🚀 TRF CLI 🚀
------------------
Project Name: localization-ireland
Project Type: TAF
Country: IE
✨ Done in 0.005s!
```
## Account Customization Project Additional steps to replace SDF Installer
Since **run** tag in **deploy.xml** is not supported in SuiteCloud Account Customization Project
Manually run the installation scripts to install the localization Bundle, Report, SavedSearch in TRF
#### Account Customization Project Manual Bundle Record Installation
Go to **Customization** > **Scripting** > **Scripts**
1. Go to filters type select **Scheduled**
2. View **STR Bundle Installer SS**
3. Go to **Deployments** tab
4. Select 1 deployment and edit
5. Go to **Parameters tab**
6. Populate the parameters as follows: GUID: Project GUID, Filename: str_localized_bundle.json
7. Trigger **Save and Execute**
#### Account Customization Project Manual Report Installation
Go to **Customization** > **Scripting** > **Scripts**
1. Go to filters type select **Map/Reduce**
2. View **ReportSchema Installer MR**
3. Go to **Deployments** tab
4. Select 1 deployment and edit
5. Go to **Parameters tab**
6. Populate the parameters as follows: UUID: Project GUID, Filename: str_localized_report_list.json
7. Trigger **Save and Execute**
#### Account Customization Project Manual SavedSearch Installation
Go to **Customization** > **Scripting** > **Scripts**
1. Go to filters type select **Map/Reduce**
2. View **STR Search Installer MR**
3. Go to **Deployments** tab
4. Select 1 deployment and edit
5. Go to **Parameters tab**
6. Populate the parameters as follows: UUID: Project GUID, Filename: str_localized_searches.json
7. Trigger **Save and Execute**
## Contributing
This project is not accepting external contributions at this time. For bugs or enhancement requests, please file a GitHub issue unless it’s security related. When filing a bug remember that the better written the bug is, the more likely it is to be fixed. If you think you’ve found a security vulnerability, do not raise a GitHub issue and follow the instructions in our [security policy](./SECURITY.md).
## Security
Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process
## License
Copyright (c) 2021 Oracle and/or its affiliates The Universal Permissive License (UPL), Version 1.0.