Add docs to approval-workflow

Author: sagelga

docs/.vuepress/config.js

@@ -66,15 +66,18 @@ module.exports = {
               path: '/approval-workflow/docs/overall/',
               children: [
                 'docs/overall/requirement/',
+                'docs/overall/install/',
                 'docs/overall/start/',
-                'docs/overall/run/',
+                'docs/overall/status/',
+                'docs/overall/how-it-works/',
               ],
             },
             {
               title: 'Develop',
               path: '/approval-workflow/docs/develop/',
               children: [
                 'docs/develop/',
+                'docs/develop/configuration/',
                 'docs/develop/module/',
               ],
             },

docs/approval-workflow/docs/develop/README.md

@@ -1 +1,8 @@
-# Develop
+# Develop
+This is the documentation for developers to develop or edit my script. There will be sections below to choose from, range from editing the configurations to changing the workflow.
+
+## Configuring
+- [Configuring CONFIG file]()
+
+
+## Create-your-own approval workflow

docs/approval-workflow/docs/develop/configuration/README.md

@@ -0,0 +1,87 @@
+# Configuration File
+This object contains the settings to compute up the script.
+
+::: tip PREVIEW
+Preview code at [https://github.com/sagelga/approval-workflow/blob/master/src/Config.js](https://github.com/sagelga/approval-workflow/blob/master/src/Config.js)
+:::
+
+### CONFIG.`headerRow`
+
+`Number`
+
+How many rows that works as `header` row. Last row (if defined more than one) will be used as sheet "attribute".
+
+Unit: row(s)
+
+Default: 1
+
+### CONFIG.`responseTimeout`
+
+`Number`
+
+How many days since request has been sent, until counted as 'Timeout'.
+
+Unit of time: day(s)
+
+Default : 14
+
+### CONFIG.`flow_step`
+
+`Number`
+
+How many steps of approval that you need.
+
+::: danger DANGER
+Script currently supports 2 steps of approval.</br>
+Dynamic steps is not being developed yet.
+:::
+
+Unit: step(s)
+
+Default: 2
+
+### CONFIG.`header_sheet`
+
+`String`, `case sensitive`
+
+What is the header sheet name.
+
+### CONFIG.`inbound_sheet`
+
+`String`
+
+What is the inbound sheet name
+
+Inbound = Receiving approval result
+
+### CONFIG.`form_column_range`
+
+`String`
+
+In the key `form_column_range`, there is a `start` and `stop` key.
+
+In the `start` key, type in string that is a column character (starts with A) that is the first column that is a information range.
+
+Similar to `stop` key, type in string that is the last column of the information range.
+
+A column that is in between (includes the `start` and `stop` ) is included* in the response summary table.
+
+### CONFIG.`approval_form_url`
+
+`String`, `case sensitive`
+
+URL to the form (**with a Response ID Parameter**)
+
+### CONFIG.`admin_email_address`
+
+`String`
+
+Email address that will receives a failure notification
+
+### CONFIG.`email`
+
+Contains information about the prefix of the email (as noted as `CONFIG.email.step0.subject.request.prefix`)
+
+In the diagram described below, one node represents a dot notation. A leaf node represents value (`String`).
+
+![](./src/emailObject.png)

docs/approval-workflow/docs/develop/configuration/src/emailObject.png

@@ -1,4 +1,4 @@
-# Order of module
+# Function Module
 Each function will be separated by its functionality or part of work. Each function is mostly independent from each other, but might requires data (such as Object) to complete any transaction.
 
 ::: tip NOTE

docs/approval-workflow/docs/develop/module/README.md

@@ -0,0 +1 @@
+# Email Function Module

docs/approval-workflow/docs/develop/module/email-function/README.md

@@ -0,0 +1 @@
+# Email Module

docs/approval-workflow/docs/develop/module/email/README.md

@@ -0,0 +1 @@
+# Functions Module

docs/approval-workflow/docs/develop/module/functions/README.md

@@ -0,0 +1 @@
+# Inbound Sheet Module

docs/approval-workflow/docs/develop/module/inbound-sheet/README.md

@@ -0,0 +1 @@
+# Main Module

docs/approval-workflow/docs/develop/module/main/README.md

@@ -0,0 +1 @@
+# Sheets Module

docs/approval-workflow/docs/develop/module/sheets/README.md

@@ -0,0 +1 @@
+# Utility Module

docs/approval-workflow/docs/develop/module/utility/README.md

@@ -1,4 +1,5 @@
 # Overall
 - [Requirement](./requirement)
 - [Start](./start)
-- [Run](./run)
+- [Install](./install)
+- [Status](./status)

docs/approval-workflow/docs/overall/README.md

@@ -0,0 +1,24 @@
+# How it works
+*Tag : how-it-works*
+
+This page will show you how the approval workflow works in real time. We still recommends you to read the code in `approvalProcess()` function.
+
+## How the script works
+1. Script will runs from Row n+1 (n = number of header row)
+2. Checks the `Step 1 Approver Status` of the current row
+   1. If it is `blank`, it will identifies as `New Request` and start the `New Request` process. Then repeats (2) with next row.
+   2. If it is `Waiting`, it will checks the `Inbound` sheet data that holds the same Request ID and updates the corresponding status when there is a response. Then repeats (2) with next row.
+   3. If the Status is `Approved`, the process repeats (2). But with `Step 2 Approver Status` and `Request Step 2 Approval`.
+   4. Otherwise (as in case of `Reject` or `Skipped`), script will repeats (2) with next row.
+3. When the status has reached to the last approver, (2) will starts again. But this time for `Approved`, it will sends an email to responder to do what the approver wants to do. Then the status will be updated as `Finished`.
+
+### New Request
+Script will do as following to requests that has been tagged as `New Request`.
+1. Send email to requester to notifies that the request is being processed.
+2. Send email to `Step 1 Approver`, as determined by the requester.
+
+### Checking the inbounds
+Script will do as following to request that has been tagged as `Check for inbounds`.
+1. Retrives the `Reqest ID` from the request.
+2. Match `Request ID` with `Request ID` in inbounds. First response (order by Time) that contains the same `Request ID` will be chosen.
+3. Chosen Response status are applied to the request.

docs/approval-workflow/docs/overall/how-it-works/README.md

@@ -0,0 +1,28 @@
+# Install the script
+*Tags: Github, Repository*
+
+Before you can start using the script, here's something you need to install and manually setup.
+
+First thing you need to do is to install the script. The script will allows you to run the flow.</br>
+To use the script, you must have acesss to items that is defined on [System Requirement](./requirement) and do the following step(s) to complete the installation.
+
+1. Visit [https://github.com/sagelga/approval-workflow](https://github.com/sagelga/approval-workflow)
+</br>![](./src/repo1.png)
+2. Select "Clone" (noticeable by the bright green button)
+</br>![](./src/repo2.png)
+3. Select "Download ZIP"
+</br>![](./src/repo3.png)
+4. After extrating the `.zip` file, there will be multiple `.js` file in `src/`.
+</br>![](./src/repo4.png)
+5. Go to your Target sheet (optional)
+6. In Tool Bar, select Tools > Script editor
+</br>![](./src/sheets2.png)
+7. You will be directed to Target sheet's script editor.
+</br>![](./src/appscript1.png)
+8. For each file, do as following
+    1. Open the file using any Text Editor application (i.e. Visual Studio Code)
+    2. Copy all of its content
+    3. Paste it to the Target Google Apps Script script page.
+    4. (Optional) Create a new script file by clicking a <img src="./src/outline_add_black_24dp.png" style="height:1em">
+    5. Repeat the process until you copied all of the files.
+9. Done.

docs/approval-workflow/docs/overall/install/README.md

@@ -1,47 +1,7 @@
-# Before you start
-Before you can start using the script, here's something you need to install and manually setup.
-
-## Install the script
-*Tags: Github, Repository*
-
-First thing you need to do is to install the script. The script will allows you to run the flow.</br>
-To use the script, you must have acesss to items that is defined on [System Requirement](./requirement) and do the following step(s) to complete the installation.
-
-1. Visit [https://github.com/sagelga/approval-workflow](https://github.com/sagelga/approval-workflow)
-</br>![](./src/repo1.png)
-2. Select "Clone" (noticeable by the bright green button)
-</br>![](./src/repo2.png)
-3. Select "Download ZIP"
-</br>![](./src/repo3.png)
-4. After extrating the `.zip` file, there will be multiple `.js` file in `src/`.
-</br>![](./src/repo4.png)
-5. Go to your Target sheet (optional)
-6. In Tool Bar, select Tools > Script editor
-</br>![](./src/sheets2.png)
-7. You will be directed to Target sheet's script editor.
-</br>![](./src/appscript1.png)
-8. For each file, do as following
-    1. Open the file using any Text Editor application (i.e. Visual Studio Code)
-    2. Copy all of its content
-    3. Paste it to the Target Google Apps Script script page.
-    4. (Optional) Create a new script file by clicking a <img src="./src/outline_add_black_24dp.png" style="height:1em">
-    5. Repeat the process until you copied all of the files.
-9. Done.
-
-## Start the script
+# Start the script
 Here's some options you can run the script
 
-When you start the script, Google will ask your permission to
-- Send emails as you
-- See, edit, create, delete your spreadsheets in Google Drive
-
-If you decline to give us the permission, this script will be unable to send email to approver or run. Prompt will ask for your permission again if it fails to acquire your permission.
-
-::: warning
-After you authorized your account to the script, the script will run on your behalf.
 
-If you like to use other account to send the emails and running the workflow, please authorize this step with that account.
-:::
 
 ### Option 1 Manually via UI
 1. Open the `sheet`
@@ -66,8 +26,20 @@ Running the script manually is too hard work for you. We recommended you to set
         - Time-based (e.g. Hourly, Daily)
         - Event-based (e.g. After new Form sent)
     - and for other parameter, you can leave it as is.
+    ::: tip
+    We recommend you to read Google Documentations on what each options differs on
+    :::
 4. After you done configuring, press "Save"
 
-::: tip
-We recommend you to read Google Documentations on what each options differs on
+## Permission Request
+When you start the script, Google will request your permission to
+- Send emails as you
+- See, edit, create, delete your spreadsheets in Google Drive
+
+If you decline to give us the permission, this script will be unable to send email to approver or run. Prompt will ask for your permission again if it fails to acquire your permission.
+
+::: warning
+After you authorized your account to the script, the script will run on your behalf.
+
+If you like to use other account to send the emails and running the workflow, please authorize this step with that account.
 :::

docs/approval-workflow/docs/overall/start/src/appscript1.png renamed to docs/approval-workflow/docs/overall/install/src/appscript1.png

@@ -0,0 +1,43 @@
+# Approval Status
+*Tags : Status*
+
+## Script's Status
+For each of the approval request, it will only contains one of the four status listed below
+
+1. **Approved**</br>
+    Approver of that level has approved the request. The request will either
+    1. Send to the team that are response of doing what the approver wants to
+    2. Elevate the request to another approver. This will restart the process, but with a `Step [current_step + 1]` approver.
+2. **Rejected**</br>
+    Any approver on any level rejects the request. Requester will be notified as the request has been rejected.
+3. **Waiting**</br>
+    Request still waiting for approver's approval. Waiting request will either
+    1. Continue to wait
+    2. Resend the request via an email again after xx days of no response
+4. **Skipped** or **[anything else]**</br>
+    Request is skipped by either
+    1. Sheet Manager forced to skip this approval request.
+    2. Script forces the request to skip this request flow (i.e. Request has been Completed and Fulfilled).
+    2. Script ran to an issue, as it cannot understand the status of that request.
+5. **Finished**</br>
+   Request has been approved. E-mail has been sent to responders and everything works perfectly. Script will acts this response in the same way as 'Skipped'.
+
+Script will runs and actively refreshing the status only to status that are either 'Waiting' or 'Approved'. 'Rejected' and 'Skipped' request will be skipped immedietely.
+
+## Edit the status
+Editing the status is possible, but please make sure that the status format matches [System's Status](#script-s-status) by different method defined below:
+
+### Option 1 Edit status manually
+Works with all status type
+1. Go to the response row that you want to override
+2. Go to the 'current step' of approval (marked with 'Waiting') or any step that will not get skipped. For more information about response status, please visit the link below.
+3. Edit the status of that cell to any valid status value
+4. Starts or wait for script to run
+Make sure that you are typing in the correct format of approval status. If the status is incorrect, it will fallback and tries to roll back to the previous status.
+
+### Option 2 Faking up Response
+Loophole behind this allows you to Approve or Reject any Response. Only works when the status is in `Waiting`.
+1. Copy the Request ID from the request that you want to edit
+2. Go to Target Response Form
+3. Send a form with the Request ID and a status that you want
+4. Script will picks the Respose as valid and continues with the script.