apn-app-manager 0.0.11 → 0.1.0

package/.prettierrc

@@ -1,11 +1,11 @@
-{
-  "printWidth": 140,
-  "tabWidth": 2,
-  "useTabs": false,
-  "semi": true,
-  "singleQuote": false,
-  "trailingComma": "es5",
-  "bracketSpacing": true,
-  "jsxBracketSameLine": false,
-  "arrowParens": "avoid"
-}
+{
+  "printWidth": 140,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": false,
+  "trailingComma": "es5",
+  "bracketSpacing": true,
+  "jsxBracketSameLine": false,
+  "arrowParens": "avoid"
+}

package/README.md

@@ -1,26 +1,60 @@
-Node.js: apn-app-manager
-=================
-
-`apn-app-manager` is a command line tool for managing Appian applications
-
-Why?
-----
-
-Todo...
-
-Installation
-------------
-
-    npm i -g apn-app-manager
-
-
-Usage
------
-
-Todo...
-
-
-License
--------
-
-Todo...
+# Node.js: apn-app-manager
+
+`apn-app-manager` is a command line tool for managing Appian applications
+
+## Why?
+
+Todo...
+
+## Installation
+
+1. Download and install [the latest version of node](https://nodejs.org/en/download/) if you don't already have it
+1. Clone this repository
+1. Navigate to `[repo]\node\app-manager` in your command line
+1. Run `npm i`
+1. Run `npm link`
+
+## Building Solutions Application Package
+
+1. First, ensure you have the latest version of this package installed. Within your Git tool, fetch and pull the latest version from master.
+2. Open up your command line and run the command `apn package --prefix <prefix>` where `<prefix>` should be one of the following:
+   - `IO` - Institutional Onboarding
+   - `KYC` - Know your Customer
+   - `RM` - Requirements Management
+   - `WS` - Workforce Safety
+   - `AM` - Award Management
+   - `MS` - (GAM) Management Suite
+3. This should begin the packaging process, and once complete, all of the files will be available to import into your test environment in a new folder called `/out` which will be inside of the folder in which you ran the command
+   - To wipe the existing database tables, first run the SQL file that contains the word `WIPE`, then the other SQL file
+
+#### Notes regarding packaging
+
+- **Important** If the package script fails (it will be obvious), then navigate to the folder in your file explorer, delete the newly generated folder called `out`, and just re-run the packaging command.
+- The little metrics about how many files are mapped/updated are currently inaccurate. Don't pay them attention at this time.
+
+## Renaming Objects in Bulk (currently broken)
+
+1. Download an application package of objects you'd like to rename
+   - If you are renaming CDTs, ensure that all direct dependents of the CDTs are also included in the application package
+1. Navigate to the folder containing the application package in your command line
+1. Run `apn r`
+   - If this doesn't work, there was likely an issue when running `npm link` above
+1. Follow the prompts to select the application package and provide the new namespace
+   - If you are not renaming to a new namespace, just provide the same value for current and new namespace
+1. Modify the Excel file (appears in a new `/out` directory) with the new names for names, descriptions, and any other values
+   - DO NOT modify the structure of the Excel file or modify any columns that do not end in `_new`
+1. Save the Excel file and the resultant application package will appear in the new `/out` directory
+1. Import your new application package to your environment, including [force_update\_.properties](resources/force_update_.properties) as the properties file to ensure the objects are updated
+
+#### Notes regarding renaming
+
+- It is recommend to always test the import against a sandbox site (e.g. CI site) before importing to your actual site - At worst, the tool may not perform as expected, however it shouldn't corrupt any files - For the future notes about unsupported behavior, you can always try it out and see if it works ¯\\_(ツ)_/¯
+- The prompt for current and new namespace will auto-replace all instances of the current namespace to the new namespace, and is meant to be a shortcut to common renaming use cases - As mentioned above, providing the same value for current and new namespace will result in nothing being auto-renamed prior to the Excel output
+- Renaming multiple objects that currently have the same name to each have different names is not currently supported - e.g. Changing the name of a data store entity and a CDT, which are currently the same, to be different - This INCLUDES setting the description on a number of objects whose description is currently null
+- Description fields with special characters (&, carriage returns, etc) are not currently supported
+- Be careful if renaming any fields that are array types (such as data store entity names), maintain the exact same delimination as exists in the Excel file
+- CDTs cannot actual be renamed, instead new CDTs will be created with the new names, and you'll have to manually delete the old CDTs (all references should be updated)
+
+## License
+
+Todo...