apn-app-manager 0.2.1 → 0.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,7 +12,7 @@ The functionality provided by this tool is not supported nor endorsed by Appian.
|
|
|
12
12
|
|
|
13
13
|
Importing an application export modified by this tool should be done at your own discretion.
|
|
14
14
|
|
|
15
|
-
Latest compatible Appian platform version for which
|
|
15
|
+
Latest compatible Appian platform version for which this has been tested against: **22.3**.
|
|
16
16
|
|
|
17
17
|
## Installation
|
|
18
18
|
|
|
@@ -21,7 +21,7 @@ Latest compatible Appian platform version for which we've tested against: **22.3
|
|
|
21
21
|
- `npm i -g apn-app-manager`
|
|
22
22
|
1. Check installation or your current version of this tool by running `npm list -g`.
|
|
23
23
|
1. After installing, you should have access to the command `apn` globally in your terminal.
|
|
24
|
-
- If this command is not recognized, you will need to troubleshoot. Since this is machine-specific, it's something you can Google related to the npm "prefix" config.
|
|
24
|
+
- If this command is not recognized, you will need to troubleshoot. Since this is machine-specific, it's something you can Google related to the npm "prefix" config. To fix this, the comamnd is `npm config set prefix _`, where the `_` is specific to your operating system. Here are helpful links to troubleshoot for [Windows](https://www.google.com/search?q=npm+global+command+not+found+windows) and [Mac](https://www.google.com/search?q=npm+global+command+not+found+mac).
|
|
25
25
|
|
|
26
26
|
## Usage
|
|
27
27
|
|
|
@@ -49,8 +49,10 @@ Used to duplicate all objects of an application, which replaces the namespace of
|
|
|
49
49
|
1. Always inspect your cloned zip before importing to verify that what will be imported matches what you'd expect.
|
|
50
50
|
1. The cloning tool is idempotent meaning it will always return the same output zip run against the same input. This also means you can develop an application, clone it, then enhance the original application, re-clone it, and that second clone will deploy over the first clone with objects being recognized as "Changed" as if you had just modified the clone directly.
|
|
51
51
|
1. It is highly recommended that all objects in your application have the same prefix (including objects that generally aren't prefixed such as applications, groups, process models, etc). Otherwise, the cloning tool will not be able to generate a unique name for these objects, and certain objects are required to have unique names.
|
|
52
|
-
1. Warnings may appear during cloning around UUIDs that weren't recognized. Generally these can be ignored if your inspection looks good, however these may be actual issues that come up due to XML structure changes in future releases. Please reach out to the authors of this tool if you have any questions about this.
|
|
53
52
|
1. Import properties files and SQL files for your application are not supported at this time. These will have to be adjusted manually to align with the cloned objects.
|
|
53
|
+
1. There are two other document generated in the `/out/` folder after cloning:
|
|
54
|
+
- `objects.json` - This contains every attribute of collected metadata from every object in the package, including its current value and new value.
|
|
55
|
+
- `not-cloned-uuids.json` - Warnings may appear during cloning about UUIDs in the package that the tool didn't know how to handle, which will be listed in this file. If no warnings appeared, this file will be empty. Generally these can be ignored if your inspection looks good, however these may be actual issues that come up due to XML structure changes in future releases. Please reach out to the authors of this tool if you have any questions about this.
|
|
54
56
|
|
|
55
57
|
## License
|
|
56
58
|
|