apn-app-manager 2.2.1 → 2.3.0

package/README.md

@@ -12,7 +12,7 @@ The functionality provided by this tool is not supported, nor endorsed by Appian
 
 Importing an application export modified by this tool should be done at your own discretion.
 
-Latest compatible Appian platform version tested against: **25.3**.
+Latest compatible Appian platform version tested against: **26.3**.
 
 ## Installation
 
@@ -76,6 +76,7 @@ Used to duplicate all objects of an application, which replaces the namespace of
    - `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, or if your application code has other UUIDs which are unrelated to Appian design objects. However these may be actual issues that come up due to XML structure changes in future Appian platform releases. Please reach out to the authors of this tool if you have any further questions.
    - `namespaces.json` - This contains a mapping of old-to-new namespaces used when cloning.
    - `problem-terms.json` - Only output if problem terms were identified. This contains a mapping of problem words, where they were found, and what decision was made for them.
+   - `unknown-object-types.json` - This contains new design objects that the tool has not been updated for yet. These objects won't be cloned until a compatible update to the tool is made and released.
    - `options.json` - This contains the options chosen (or used by default) when cloning.
    - `composer/` - This directory contains a JSON file for each application which has "Composer/Requirements/Plan" of the `requirementsCaptureB64` node in JSON format.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apn-app-manager",
-  "version": "2.2.1",
+  "version": "2.3.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },

package/src/actions/cloneAction.js

@@ -37,6 +37,7 @@ const defaultContext = {
 let context;
 const objectMaps = {};
 const uuidCollector = {};
+let unknownCollector = [];
 const skippedObjectCount = {};
 
 // Entry-point
@@ -47,6 +48,7 @@ function main(inputContext) {
   createValidContext(inputContext);
   Object.keys(objectMaps).forEach(key => delete objectMaps[key]);
   uuidCollector.uuids = [];
+  unknownCollector = [];
   skippedObjectCount.skipped = 0;
   util.delFile(cons.outDir);
 
@@ -131,7 +133,7 @@ function promptNamespaceMapAndOptions() {
   util.unzipDir(context.appZipPath, cons.tempDir);
 
   // Second, run extraction
-  obExtract.buildObjectMaps(objectMaps, uuidCollector, context.namespaceMap, cons.tempDir, obProps.usageTypes.CLONE);
+  obExtract.buildObjectMaps(objectMaps, uuidCollector, context.namespaceMap, unknownCollector, cons.tempDir, obProps.usageTypes.CLONE);
 
   // Third, prompt for namespaces
   if (context.contextAlreadyProvided) {
@@ -195,6 +197,7 @@ function executeClone() {
     util.writeJson(path.resolve(cons.debugDir, `client-info.json`), util.clientInfo());
     util.writeJson(path.resolve(cons.debugDir, `objects.json`), objectMaps);
     util.writeJson(path.resolve(cons.debugDir, `not-cloned-uuids.json`), uuidCollector);
+    util.writeJson(path.resolve(cons.debugDir, `unknown-object-types.json`), unknownCollector);
     util.writeJson(path.resolve(cons.debugDir, `namespaces.json`), context.namespaceMap);
     util.writeJson(path.resolve(cons.debugDir, `options.json`), context.options);
     util.writeJson(path.resolve(cons.debugDir, `problem-terms.json`), context.problemWordMaps);

package/src/handlers/objectExtractHandler.js

@@ -13,13 +13,13 @@ const { split } = require("lodash");
 // Exports
 module.exports = {
   // Builds the objectMaps object from the application
-  buildObjectMaps: function (objectMaps, uuidCollector, namespaceCollector, appDir, usageType) {
+  buildObjectMaps: function (objectMaps, uuidCollector, namespaceCollector, unknownCollector, appDir, usageType) {
     specialHandler.updateFilesForExtract(appDir);
     let fileCount = { count: 0 };
     initObjectMaps(objectMaps);
     // Extract the name, uuid, etc. from each object file
     util.handleDirFiles(appDir, ["xml", "xsd"], 2, 2, function (obPath) {
-      extractObProps(objectMaps, uuidCollector, namespaceCollector, fileCount, obPath, usageType);
+      extractObProps(objectMaps, uuidCollector, namespaceCollector, unknownCollector, fileCount, obPath, usageType);
     });
     // Set the datatype UUIDs from their name & namespace
     updateDatatypeUuids(objectMaps);
@@ -55,7 +55,7 @@ function initObjectMaps(objectMaps) {
 }
 
 // Extracts the name, uuid, etc. from a single object file
-function extractObProps(objectMaps, uuidCollector, namespaceCollector, fileCount, obPath, usageType) {
+function extractObProps(objectMaps, uuidCollector, namespaceCollector, unknownCollector, fileCount, obPath, usageType) {
   fileCount.count = fileCount.count + 1;
   const obType = util.getFolderName(obPath);
   let isParsed = false;
@@ -98,6 +98,7 @@ function extractObProps(objectMaps, uuidCollector, namespaceCollector, fileCount
   // Unknown file type
   if (!isParsed) {
     util.printWarning(`WARNING: Unknown object type in package: ${obType}/${path.basename(obPath)}`);
+    unknownCollector.push({ type: obType, file: path.basename(obPath) });
   }
 }
 
@@ -159,7 +160,8 @@ function extractObjectPropertyJsonPath(haulField, object) {
   if (util.isBlank(haulField.jsonPath)) {
     return object;
   }
-  return jp.query(JSON.parse(object), haulField.jsonPath);
+  let result = jp.query(JSON.parse(object), haulField.jsonPath);
+  return haulField.isArray ? result : result[0];
 }
 
 // Does the extractRegex logic of a haul field that requires regex

package/src/objectProps.js

@@ -37,6 +37,9 @@ const obTypes = {
   PROCESSMODELFOLDER: "processModelFolder",
   CONNECTEDSYSTEM: "connectedSystem",
   AISKILL: "aiSkill",
+  AIAGENT: "aiAgent",
+  PHQREPORT: "report",
+  PHQDASHBOARD: "dashboard",
   CONTENT: "content", // obTypes.CONTENT contains: [rule, document, rulesFolder, constant, folder, communityKnowledgeCenter, decision, outboundIntegration, report (process report)]
 };
 
@@ -48,6 +51,11 @@ const fieldNames = {
   VERSION: "version",
   CACHE_VERSION: "cacheVersionKey",
   MODEL_IDS: "modelIds",
+  AGENT_VERSION: "agentVersion",
+  VARIABLE_IDS: "variableIds",
+  TOOL_IDS: "toolIds",
+  TEST_CASE_IDS: "testCaseIds",
+  TEST_CASE_VARIABLE_IDS: "testCaseVariableIds",
   HISTORY_UUIDS: "historyUuids",
   CDT_NAMESPACE: "cdtNamespace",
   CDT_UUID_ENCODED: "cdtUuidEncoded",
@@ -85,6 +93,10 @@ const fieldNames = {
   REQS_ACTIVITY_UUIDS: "composerReqsActivityUuids",
   REQS_STEP_UUIDS: "composerReqsStepUuids",
   REQS_ACTION_UUIDS: "composerReqsActionUuids",
+  REQS_UX_SCREEN_UUIDS: "composerReqsUxScreenUuids",
+  PHQ_REPORT_COLUMN_UUIDS: "phqReportColumnUuids",
+  PHQ_DASHBOARD_FILTER_UUIDS: "phqDashboardFilterUuids",
+  PHQ_DASHBOARD_FILTER_CONFIGURATION_UUIDS: "phqDashboardFilterConfigurationUuids",
 };
 
 const xmlNamespaces = {
@@ -518,6 +530,15 @@ const haulTypes = [
         usage: [usageTypes.CLONE, usageTypes.BUILD],
         isArray: true,
       },
+      {
+        fieldName: fieldNames.REQS_UX_SCREEN_UUIDS,
+        xpath: `applicationHaul/requirementsCaptureB64/node()`,
+        jsonPath: `$.content.uxScreens[*].uuid`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD],
+        isArray: true,
+      },
     ],
   },
   {
@@ -674,51 +695,128 @@ const haulTypes = [
     fields: [
       {
         fieldName: fieldNames.UUID,
-        xpath: `aiSkillRemoteHaul/*[contains(name(), '')]/uuid/node()`,
+        xpath: `aiSkillRemoteHaul/remoteDesignObject/uuid/node()`,
         type: propTypes.UUID,
         forceUuidFormat: true,
         usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
       },
       {
         fieldName: fieldNames.NAME,
-        xpath: `aiSkillRemoteHaul/*[contains(name(), '')]/name/node()`,
+        xpath: `aiSkillRemoteHaul/remoteDesignObject/name/node()`,
         type: propTypes.NAME,
         usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
       },
       {
         fieldName: fieldNames.DESCRIPTION,
-        xpath: `aiSkillRemoteHaul/*[contains(name(), '')]/description/node()`,
+        xpath: `aiSkillRemoteHaul/remoteDesignObject/description/node()`,
         type: propTypes.TEXT,
         usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
         replaceFormat: "description>{VALUE}</",
       },
       {
-        fieldName: fieldNames.INPUT_DESCRIPTION,
-        xpath: `aiSkillRemoteHaul/*[contains(name(), '')]/namedTypedValue/description/node()`,
+        fieldName: fieldNames.VERSION,
+        xpath: `aiSkillRemoteHaul/versionUuid/node()`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD],
+      },
+      {
+        fieldName: fieldNames.HISTORY_UUIDS,
+        xpath: `aiSkillRemoteHaul/history/historyInfo/@versionUuid`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD],
+        isArray: true,
+      },
+      {
+        fieldName: fieldNames.MODEL_IDS,
+        xpath: `aiSkillRemoteHaul/remoteDesignObject/content/node()`,
+        jsonPath: `$.models[*].id`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD],
+        isArray: true,
+      },
+    ],
+  },
+  {
+    haulName: "AI Agents",
+    obs: [obTypes.AIAGENT],
+    fields: [
+      {
+        fieldName: fieldNames.UUID,
+        xpath: `aiAgentRemoteHaul/remoteDesignObject/uuid/node()`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
+      },
+      {
+        fieldName: fieldNames.NAME,
+        xpath: `aiAgentRemoteHaul/remoteDesignObject/name/node()`,
+        type: propTypes.NAME,
+        usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
+      },
+      {
+        fieldName: fieldNames.DESCRIPTION,
+        xpath: `aiAgentRemoteHaul/remoteDesignObject/description/node()`,
         type: propTypes.TEXT,
         usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
         replaceFormat: "description>{VALUE}</",
-        isArray: true,
       },
       {
         fieldName: fieldNames.VERSION,
-        xpath: `aiSkillRemoteHaul/versionUuid/node()`,
+        xpath: `aiAgentRemoteHaul/versionUuid/node()`,
         type: propTypes.UUID,
         forceUuidFormat: true,
         usage: [usageTypes.CLONE, usageTypes.BUILD],
       },
       {
         fieldName: fieldNames.HISTORY_UUIDS,
-        xpath: `aiSkillRemoteHaul/history/historyInfo/@versionUuid`,
+        xpath: `aiAgentRemoteHaul/history/historyInfo/@versionUuid`,
         type: propTypes.UUID,
         forceUuidFormat: true,
         usage: [usageTypes.CLONE, usageTypes.BUILD],
         isArray: true,
       },
       {
-        fieldName: fieldNames.MODEL_IDS,
-        xpath: `aiSkillRemoteHaul/*[contains(name(), '')]/content/node()`,
-        extractRegex: /(?<="models":.*"id":")[A-Za-z0-9-_]{10,}[0-9][A-Za-z0-9-_]{1,}-[A-Za-z0-9-_]{10,}(?=")/g,
+        fieldName: fieldNames.AGENT_VERSION,
+        xpath: `aiAgentRemoteHaul/remoteDesignObject/content/node()`,
+        jsonPath: `$.agentVersion`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD],
+      },
+      {
+        fieldName: fieldNames.VARIABLE_IDS,
+        xpath: `aiAgentRemoteHaul/remoteDesignObject/content/node()`,
+        jsonPath: `$.variables[*].id`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD],
+        isArray: true,
+      },
+      {
+        fieldName: fieldNames.TOOL_IDS,
+        xpath: `aiAgentRemoteHaul/remoteDesignObject/content/node()`,
+        jsonPath: `$.tools[*].toolId`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD],
+        isArray: true,
+      },
+      {
+        fieldName: fieldNames.TEST_CASE_IDS,
+        xpath: `aiAgentRemoteHaul/remoteDesignObject/content/node()`,
+        jsonPath: `$.testCases[*].id`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD],
+        isArray: true,
+      },
+      {
+        fieldName: fieldNames.TEST_CASE_VARIABLE_IDS,
+        xpath: `aiAgentRemoteHaul/remoteDesignObject/content/node()`,
+        jsonPath: `$.testCases[*].variables[*].id`,
         type: propTypes.UUID,
         forceUuidFormat: true,
         usage: [usageTypes.CLONE, usageTypes.BUILD],
@@ -815,6 +913,113 @@ const haulTypes = [
       },
     ],
   },
+  {
+    haulName: "PHQ Reports",
+    obs: [obTypes.PHQREPORT],
+    fields: [
+      {
+        fieldName: fieldNames.UUID,
+        xpath: `reportHaul/report/@a:uuid`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
+      },
+      {
+        fieldName: fieldNames.NAME,
+        xpath: `reportHaul/report/@name`,
+        type: propTypes.NAME,
+        usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
+      },
+      {
+        fieldName: fieldNames.DESCRIPTION,
+        xpath: `reportHaul/report/description/node()`,
+        type: propTypes.TEXT,
+        usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
+        replaceFormat: "description>{VALUE}</",
+      },
+      {
+        fieldName: fieldNames.VERSION,
+        xpath: `reportHaul/versionUuid/node()`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD],
+      },
+      {
+        fieldName: fieldNames.HISTORY_UUIDS,
+        xpath: `reportHaul/history/historyInfo/@versionUuid`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD],
+        isArray: true,
+      },
+      {
+        fieldName: fieldNames.PHQ_REPORT_COLUMN_UUIDS,
+        xpath: `reportHaul/report/configJson/node()`,
+        jsonPath: `$.columns[*].columnUuid`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD],
+        isArray: true,
+      },
+    ],
+  },
+  {
+    haulName: "PHQ Dashboards",
+    obs: [obTypes.PHQDASHBOARD],
+    fields: [
+      {
+        fieldName: fieldNames.UUID,
+        xpath: `dashboardHaul/dashboard/@a:uuid`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
+      },
+      {
+        fieldName: fieldNames.NAME,
+        xpath: `dashboardHaul/dashboard/@name`,
+        type: propTypes.NAME,
+        usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
+      },
+      {
+        fieldName: fieldNames.DESCRIPTION,
+        xpath: `dashboardHaul/dashboard/description/node()`,
+        type: propTypes.TEXT,
+        usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
+        replaceFormat: "description>{VALUE}</",
+      },
+      {
+        fieldName: fieldNames.VERSION,
+        xpath: `dashboardHaul/versionUuid/node()`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD],
+      },
+      {
+        fieldName: fieldNames.HISTORY_UUIDS,
+        xpath: `dashboardHaul/history/historyInfo/@versionUuid`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD],
+        isArray: true,
+      },
+      {
+        fieldName: fieldNames.PHQ_DASHBOARD_FILTER_UUIDS,
+        xpath: `dashboardHaul/dashboard/filters/filter/@a:uuid`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD],
+        isArray: true,
+      },
+      {
+        fieldName: fieldNames.PHQ_DASHBOARD_FILTER_CONFIGURATION_UUIDS,
+        xpath: `dashboardHaul/dashboard/filters/filter/configurations/configuration/@a:uuid`,
+        type: propTypes.UUID,
+        forceUuidFormat: true,
+        usage: [usageTypes.CLONE, usageTypes.BUILD],
+        isArray: true,
+      },
+    ],
+  },
   {
     haulName: "Everything Else",
     obs: [obTypes.GROUP, obTypes.GROUPTYPE, obTypes.PROCESSMODELFOLDER, obTypes.CONNECTEDSYSTEM, obTypes.CONTENT],