Merge pull request #73 from oracle-samples/add-button-using-workflow

Add button using workflow

Author: bmcgeeOR

suitecloud-legacy-solutions-catalog/add-button-using-workflow/.gitignore

@@ -0,0 +1,11 @@
+# dependencies
+**/node_modules/**
+
+# ides
+**/.idea/**
+
+# test coverage folder
+**/coverage/**
+
+# suitecloud
+project.json

suitecloud-legacy-solutions-catalog/add-button-using-workflow/LICENSE.txt

@@ -0,0 +1,35 @@
+Copyright (c) 2024 Oracle and/or its affiliates.
+
+The Universal Permissive License (UPL), Version 1.0
+
+Subject to the condition set forth below, permission is hereby granted to any
+person obtaining a copy of this software, associated documentation and/or data
+(collectively the "Software"), free of charge and under any and all copyright
+rights in the Software, and any and all patent rights owned or freely
+licensable by each licensor hereunder covering either (i) the unmodified
+Software as contributed to or provided by such licensor, or (ii) the Larger
+Works (as defined below), to deal in both
+
+(a) the Software, and
+(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+one is included with the Software (each a “Larger Work” to which the Software
+is contributed by such licensors),
+
+without restriction, including without limitation the rights to copy, create
+derivative works of, display, perform, and distribute the Software and make,
+use, sell, offer for sale, import, export, have made, and have sold the
+Software and the Larger Work(s), and to sublicense the foregoing rights on
+either these or other terms.
+
+This license is subject to the following condition:
+The above copyright notice and either this complete permission notice or at
+a minimum a reference to the UPL must be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

suitecloud-legacy-solutions-catalog/add-button-using-workflow/README.md

@@ -0,0 +1,50 @@
+<p align="center"><a href="#"><img width="250" src="assets/oracle_netsuite_logo.png"></a></p>
+
+
+# Summary
+This SuiteScript sample implements a custom workflow on the sales order record that uses a workflow action script for additional processing. The workflow adds two custom buttons, and implements different actions based on which button is clicked. The workflow action script updates a field on the customer record based on values in the sales order record, and is triggered when the user clicks one of the custom buttons. Clicking either button will also update a field on the sales order record.
+
+# Key Concepts
+This sample demonstrates the following concepts:
+
+* **SuiteFlow** - This is used to create and execute workflows in NetSuite. A workflow is the definition of a custom business process for a standard or custom record. For more information, see [SuiteFlow Overview](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/chapter_4068260113.html). 
+
+* **SuiteScript 2.1** – This SuiteScript version is the latest available version and includes new language features that are not part of SuiteScript 2.0. This sample uses some SuiteScript 2.1 features, such as arrow functions. For more information, see [SuiteScript 2.1](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/chapter_156042690639.html#SuiteScript-2.1).
+
+* **Workflow Action script type** – This script type is used to create custom workflow actions that are defined on a record in a workflow. Custom actions can range from simple record operations to complex ones that are beyond what is supported by the built-in workflow actions. For more information, see [SuiteScript 2.x Workflow Action Script Type](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_4460429314.html).
+
+# SuiteScript Version
+This sample uses SuiteScript 2.1. For more information about this SuiteScript version, see [SuiteScript 2.1](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/chapter_156042690639.html#SuiteScript-2.1).
+
+# Loaded Modules
+This sample loads and uses the following SuiteScript modules:
+
+* **N/record** – To load and work with records. For more information, see [N/record Module](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_4267255811.html#N%2Frecord-Module).
+
+# Script Type and Entry Points
+This sample uses a user event script type with the following entry points:
+
+* `onAction` – Defines a WorkflowAction script trigger point. This executes when conditions for the defined custom action in the workflow is satisfied.
+
+# Customization Details
+The customization for this use case includes:
+
+* A workflow on the sales order record that does the following:
+  * Creates 2 custom buttons
+  * Transitions to two states, depending on which button is clicked
+  * Defines actions for each state:
+    * Updates record fields to indicate which button was clicked 
+    * Calls a workflow action script if a specific button was clicked
+* A workflow action script that updates another record
+
+# Test the Solution
+1. Create a sales order by going to Transactions > Sales > Enter Sales Orders
+2. When the record is saved, verify that the last two buttons are labeled as 'Approve' and 'Reject'
+3. Click the Reject button and verify that the Memo field has the value 'Record is rejected.'
+4. Repeat Step #s 1 and 2
+5. Click the Approve button, and verify that the Memo field has the value 'Record is approved.' 
+6. Open the customer record by clicking on the customer link
+7. In the customer record, the Comments field should be updated to: 'Items ordered: x', where x is the number of lines in the sales order's item sublist.
+
+## [License](./LICENSE.txt)
+Copyright (c) 2024 Oracle and/or its affiliates The Universal Permissive License (UPL), Version 1.0.