#1227: regroup source/destination fields

Accenture · Apr 15, 2024 · 569e18a · 569e18a
1 parent 0890dbb
commit 569e18a
Show file tree

Hide file tree

Showing 10 changed files with 129 additions and 68 deletions.
diff --git a/lib/metadataTypes/ImportFile.js b/lib/metadataTypes/ImportFile.js
@@ -198,8 +198,9 @@ class ImportFile extends MetadataType {
  */
  static async deploy(metadataMap, deployDir, retrieveDir) {
  if (
- Object.values(metadataMap).filter((item) => item.c__destinationType === 'SMS').length >
- 0
+ Object.values(metadataMap).filter(
+ (item) => item.destination.c__destinationType === 'SMS'
+ ).length > 0
  ) {
  Util.logger.info(`Caching dependent Metadata: dataExtension (source for SMS imports)`);
 
@@ -225,61 +226,69 @@ class ImportFile extends MetadataType {
  * @returns {Promise} Promise
  */
  static async preDeployTasks(metadata) {
- const fileLocation = cache.getByKey('fileLocation', metadata.r__fileLocation_name);
+ const fileLocation = cache.getByKey('fileLocation', metadata.source.r__fileLocation_name);
  if (!fileLocation) {
  throw new Error(`fileLocation ${metadata.r__fileLocation_name} not found in cache`);
  }
 
  metadata.fileTransferLocationId = fileLocation.id;
  metadata.fileTransferLocationTypeId = fileLocation.locationTypeId;
- delete metadata.r__fileLocation_name;
+ delete metadata.source.r__fileLocation_name;
 
- switch (metadata.c__destinationType) {
+ switch (metadata.destination.c__destinationType) {
  case 'DataExtension': {
- if (metadata.r__dataExtension_CustomerKey) {
+ if (metadata.destination.r__dataExtension_CustomerKey) {
  metadata.destinationObjectId = cache.searchForField(
  'dataExtension',
- metadata.r__dataExtension_CustomerKey,
+ metadata.destination.r__dataExtension_CustomerKey,
  'CustomerKey',
  'ObjectID'
  );
- delete metadata.r__dataExtension_CustomerKey;
+ delete metadata.destination.r__dataExtension_CustomerKey;
  } else {
  throw new Error('Import Destination DataExtension not defined');
  }
  break;
  }
  case 'List': {
- if (metadata.r__list_PathName) {
+ if (metadata.destination.r__list_PathName) {
  metadata.destinationObjectId = cache.getListObjectId(
- metadata.r__list_PathName,
+ metadata.destination.r__list_PathName,
  'ObjectID'
  );
  // destinationId is also needed for List types
- metadata.destinationId = cache.getListObjectId(metadata.r__list_PathName, 'ID');
- delete metadata.r__list_PathName;
+ metadata.destinationId = cache.getListObjectId(
+ metadata.destination.r__list_PathName,
+ 'ID'
+ );
+ delete metadata.destination.r__list_PathName;
  } else {
  throw new Error('Import Destination List not defined');
  }
  break;
  }
  case 'SMS': {
- if (metadata.c__codeKeyword) {
+ if (metadata.destination.c__codeKeyword) {
  // code
  const codeObj = cache.getByKey(
  'mobileCode',
- metadata.c__codeKeyword.split('.')[0]
+ metadata.destination.c__codeKeyword.split('.')[0]
  );
  if (!codeObj) {
- throw new Error(`mobileCode ${metadata.c__codeKeyword} not found in cache`);
+ throw new Error(
+ `mobileCode ${metadata.destination.c__codeKeyword} not found in cache`
+ );
  }
  metadata.code = codeObj;
 
  // keyword
- const keywordObj = cache.getByKey('mobileKeyword', metadata.c__codeKeyword);
+ const keywordObj = cache.getByKey(
+ 'mobileKeyword',
+ metadata.destination.c__codeKeyword
+ );
  if (!keywordObj) {
  throw new Error(
- `mobileKeyword ${metadata.c__codeKeyword} not found in cache`
+ `mobileKeyword ${metadata.destination.c__codeKeyword} not found in cache`
  );
  }
  metadata.keyword = keywordObj;
@@ -293,25 +302,27 @@ class ImportFile extends MetadataType {
  metadata.destinationObjectId = '00000000-0000-0000-0000-000000000000';
  metadata.destinationObjectType = 'MobileSubscription';
  // source
- if (this.dataExtensionsLegacy[metadata.c__sourceObjectKey]) {
+ if (this.dataExtensionsLegacy[metadata.source.r__dataExtension_CustomerKey]) {
  metadata.sourceObjectId =
- this.dataExtensionsLegacy[metadata.c__sourceObjectKey].id;
+ this.dataExtensionsLegacy[metadata.source.r__dataExtension_CustomerKey].id;
  metadata.sourceObjectName =
- this.dataExtensionsLegacy[metadata.c__sourceObjectKey].dataExtensionName;
- delete metadata.c__sourceObjectKey;
+ this.dataExtensionsLegacy[
+ metadata.source.r__dataExtension_CustomerKey
+ ].dataExtensionName;
+ delete metadata.source.r__dataExtension_CustomerKey;
  }
 
  Util.logger.debug(
  ` - importFile ${metadata[this.definition.keyField]}: Import Destination Type ${
- metadata.c__destinationType
+ metadata.destination.c__destinationType
  } not fully supported. Deploy might fail.`
  );
  break;
  }
  default: {
  Util.logger.debug(
  ` - importFile ${metadata[this.definition.keyField]}: Import Destination Type ${
- metadata.c__destinationType
+ metadata.destination.c__destinationType
  } not fully supported. Deploy might fail.`
  );
  }
@@ -323,10 +334,13 @@ class ImportFile extends MetadataType {
  }
  // When the destinationObjectTypeId is 584 it refers to Mobile Connect which is not supported as an Import Type
  metadata.destinationObjectTypeId =
- this.definition.destinationObjectTypeMapping[metadata.c__destinationType];
+ this.definition.destinationObjectTypeMapping[metadata.destination.c__destinationType];
  metadata.subscriberImportTypeId =
  this.definition.subscriberImportTypeMapping[metadata.c__subscriberImportType];
  metadata.updateTypeId = this.definition.updateTypeMapping[metadata.c__dataAction];
+
+ delete metadata.destination;
+ delete metadata.source;
  return metadata;
  }
 
@@ -337,7 +351,9 @@ class ImportFile extends MetadataType {
  * @returns {MetadataTypeItem} parsed metadata
  */
  static postRetrieveTasks(metadata) {
- metadata.r__fileLocation_name = cache.searchForField(
+ metadata.destination = {};
+ metadata.source = {};
+ metadata.source.r__fileLocation_name = cache.searchForField(
  'fileLocation',
  metadata.fileTransferLocationId,
  'id',
@@ -346,14 +362,14 @@ class ImportFile extends MetadataType {
  delete metadata.fileTransferLocationId;
 
  // * When the destinationObjectTypeId is 584 it refers to Mobile Connect which is not supported as an Import Type
- metadata.c__destinationType = Util.inverseGet(
+ metadata.destination.c__destinationType = Util.inverseGet(
  this.definition.destinationObjectTypeMapping,
  metadata.destinationObjectTypeId
  );
- switch (metadata.c__destinationType) {
+ switch (metadata.destination.c__destinationType) {
  case 'DataExtension': {
  try {
- metadata.r__dataExtension_CustomerKey = cache.searchForField(
+ metadata.destination.r__dataExtension_CustomerKey = cache.searchForField(
  'dataExtension',
  metadata.destinationObjectId,
  'ObjectID',
@@ -368,7 +384,7 @@ class ImportFile extends MetadataType {
  }
  case 'List': {
  try {
- metadata.r__list_PathName = cache.getListPathName(
+ metadata.destination.r__list_PathName = cache.getListPathName(
  metadata.destinationObjectId,
  'ObjectID'
  );
@@ -383,14 +399,14 @@ class ImportFile extends MetadataType {
  if (this.smsImports[metadata.name]) {
  const smsImport = this.smsImports[metadata.name];
  // code + keyword
- metadata.c__codeKeyword =
+ metadata.destination.c__codeKeyword =
  smsImport.code?.code + '.' + smsImport.keyword?.keyword;
  // source dataExtension
  if (smsImport.sourceObjectKey) {
- metadata.c__sourceObjectKey = smsImport.sourceObjectKey;
+ metadata.source.r__dataExtension_CustomerKey = smsImport.sourceObjectKey;
  }
  } else {
- Util.logger.debug(
+ Util.logger.warn(
  ` - ImportFile ${metadata.customerKey}: Could not find mobile code and keyword nor source for this SMS import activity.`
  );
  }

diff --git a/lib/metadataTypes/definitions/ImportFile.definition.js b/lib/metadataTypes/definitions/ImportFile.definition.js
@@ -255,25 +255,37 @@ export default {
  retrieving: true,
  template: true,
  },
- r__dataExtension_CustomerKey: {
+ 'destination.c__codeKeyword': {
  isCreateable: false,
  isUpdateable: false,
  retrieving: true,
  template: true,
  },
- c__destinationType: {
+ 'source.r__dataExtension_CustomerKey': {
  isCreateable: false,
  isUpdateable: false,
  retrieving: true,
  template: true,
  },
- r__list_PathName: {
+ 'destination.r__dataExtension_CustomerKey': {
  isCreateable: false,
  isUpdateable: false,
  retrieving: true,
  template: true,
  },
- r__fileLocation_name: {
+ 'destination.c__destinationType': {
+ isCreateable: false,
+ isUpdateable: false,
+ retrieving: true,
+ template: true,
+ },
+ 'destination.r__list_PathName': {
+ isCreateable: false,
+ isUpdateable: false,
+ retrieving: true,
+ template: true,
+ },
+ 'source.r__fileLocation_name': {
  isCreateable: false,
  isUpdateable: false,
  retrieving: true,

diff --git a/...ckRoot/deploy/testInstance/testBU/importFile/testExisting_importFile.importFile-meta.json b/...ckRoot/deploy/testInstance/testBU/importFile/testExisting_importFile.importFile-meta.json
@@ -24,8 +24,12 @@
  "standardQuotedStrings": true,
  "c__blankFileProcessing": "Process",
  "c__dataAction": "AddUpdate",
- "c__destinationType": "DataExtension",
  "c__subscriberImportType": "DataExtension",
- "r__dataExtension_CustomerKey": "testExisting_dataExtension",
- "r__fileLocation_name": "ExactTarget Enhanced FTP"
+ "destination": {
+ "c__destinationType": "DataExtension",
+ "r__dataExtension_CustomerKey": "testExisting_dataExtension"
+ },
+ "source": {
+ "r__fileLocation_name": "ExactTarget Enhanced FTP"
+ }
 }
diff --git a/test/mockRoot/deploy/testInstance/testBU/importFile/testNew_importFile.importFile-meta.json b/test/mockRoot/deploy/testInstance/testBU/importFile/testNew_importFile.importFile-meta.json
@@ -21,9 +21,13 @@
  "name": "testNew_importFile",
  "sendEmailNotification": false,
  "standardQuotedStrings": true,
- "r__fileLocation_name": "ExactTarget Enhanced FTP",
- "c__destinationType": "DataExtension",
- "r__dataExtension_CustomerKey": "testExisting_dataExtension",
  "c__subscriberImportType": "DataExtension",
- "c__dataAction": "AddUpdate"
+ "c__dataAction": "AddUpdate",
+ "destination": {
+ "c__destinationType": "DataExtension",
+ "r__dataExtension_CustomerKey": "testExisting_dataExtension"
+ },
+ "source": {
+ "r__fileLocation_name": "ExactTarget Enhanced FTP"
+ }
 }
diff --git a/test/resources/9999999/importFile/build-expected.json b/test/resources/9999999/importFile/build-expected.json
@@ -2,7 +2,6 @@
  "allowErrors": true,
  "c__blankFileProcessing": "Skip",
  "c__dataAction": "AddUpdate",
- "c__destinationType": "DataExtension",
  "c__subscriberImportType": "DataExtension",
  "customerKey": "testTemplated_importFile",
  "dateFormatLocale": "en-US",
@@ -21,8 +20,13 @@
  "maxFileAgeScheduleOffsetHours": 0,
  "maxImportFrequencyHours": 0,
  "name": "testTemplated_importFile",
- "r__dataExtension_CustomerKey": "testTemplated_dataExtension",
- "r__fileLocation_name": "ExactTarget Enhanced FTP",
  "sendEmailNotification": false,
- "standardQuotedStrings": true
+ "standardQuotedStrings": true,
+ "destination": {
+ "c__destinationType": "DataExtension",
+ "r__dataExtension_CustomerKey": "testTemplated_dataExtension"
+ },
+ "source": {
+ "r__fileLocation_name": "ExactTarget Enhanced FTP"
+ }
 }
diff --git a/test/resources/9999999/importFile/get-expected.json b/test/resources/9999999/importFile/get-expected.json
@@ -2,7 +2,6 @@
  "allowErrors": true,
  "c__blankFileProcessing": "Skip",
  "c__dataAction": "AddUpdate",
- "c__destinationType": "DataExtension",
  "c__subscriberImportType": "DataExtension",
  "createdDate": "2022-11-09T05:32:30.533",
  "customerKey": "testExisting_importFile",
@@ -23,8 +22,14 @@
  "maxImportFrequencyHours": 0,
  "modifiedDate": "2022-11-17T07:13:03.95",
  "name": "testExisting_importFile",
- "r__dataExtension_CustomerKey": "testExisting_dataExtension",
- "r__fileLocation_name": "ExactTarget Enhanced FTP",
+
  "sendEmailNotification": false,
- "standardQuotedStrings": true
+ "standardQuotedStrings": true,
+ "destination": {
+ "c__destinationType": "DataExtension",
+ "r__dataExtension_CustomerKey": "testExisting_dataExtension"
+ },
+ "source": {
+ "r__fileLocation_name": "ExactTarget Enhanced FTP"
+ }
 }
diff --git a/test/resources/9999999/importFile/get-sms-expected.json b/test/resources/9999999/importFile/get-sms-expected.json
@@ -1,9 +1,6 @@
 {
  "allowErrors": true,
  "c__dataAction": "AddUpdate",
- "c__codeKeyword": "4912312345678.TESTEXISTING_KEYWORD",
- "c__destinationType": "SMS",
- "c__sourceObjectKey": "testExisting_dataExtension",
  "c__subscriberImportType": "DataExtension",
  "createdDate": "2022-11-24T03:29:01.05",
  "customerKey": "testExisting_importFileSMS",
@@ -69,7 +66,14 @@
  "modifiedDate": "2023-07-19T23:06:33.577",
  "name": "testExisting_importFileSMS",
  "notificationEmailAddress": "joern.berkefeld@accenture.com",
- "r__fileLocation_name": "ExactTarget Enhanced FTP",
  "sendEmailNotification": true,
- "standardQuotedStrings": false
+ "standardQuotedStrings": false,
+ "destination": {
+ "c__destinationType": "SMS",
+ "c__codeKeyword": "4912312345678.TESTEXISTING_KEYWORD"
+ },
+ "source": {
+ "r__dataExtension_CustomerKey": "testExisting_dataExtension",
+ "r__fileLocation_name": "ExactTarget Enhanced FTP"
+ }
 }
diff --git a/test/resources/9999999/importFile/patch-expected.json b/test/resources/9999999/importFile/patch-expected.json
@@ -2,7 +2,6 @@
  "allowErrors": true,
  "c__blankFileProcessing": "Process",
  "c__dataAction": "AddUpdate",
- "c__destinationType": "DataExtension",
  "c__subscriberImportType": "DataExtension",
  "createdDate": "2022-11-09T05:32:30.533",
  "customerKey": "testExisting_importFile",
@@ -23,8 +22,13 @@
  "maxImportFrequencyHours": 0,
  "modifiedDate": "2023-07-18T09:11:26.19",
  "name": "testExisting_importFile",
- "r__dataExtension_CustomerKey": "testExisting_dataExtension",
- "r__fileLocation_name": "ExactTarget Enhanced FTP",
  "sendEmailNotification": false,
- "standardQuotedStrings": true
+ "standardQuotedStrings": true,
+ "destination": {
+ "c__destinationType": "DataExtension",
+ "r__dataExtension_CustomerKey": "testExisting_dataExtension"
+ },
+ "source": {
+ "r__fileLocation_name": "ExactTarget Enhanced FTP"
+ }
 }