@contrail/flexplm 1.4.0 → 1.5.0-alpha.14a4f1b

package/lib/util/data-converter-spec-mockData.js

@@ -31,12 +31,26 @@ exports.mapping = {
                 }
             }
         }
+        // flex2vibe: {
+        //   LCSRevisableEntity: {
+        //     getMapKey: (object) =>{ return object;}
+        //   },
+        //   LCSLast: {
+        //     getMapKey: (object) => {return object;}
+        //   },
+        //   LCSMaterial: {
+        //     getMapKey: (object) =>{ return object;}
+        //   },
+        //   LCSBusinessObject: {
+        //     getMapKey: (object) => {return object;}
+        //   }
+        // },
     },
     LCSProduct: {
         vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
         vibe2flex: {
             getClass: () => 'LCSProduct',
-            getSoftType: (entity) => {
+            getSoftType: (entity /*, dependencies*/) => {
                 const prodType = entity['prodType'];
                 let val = '';
                 switch (prodType) {
@@ -61,7 +75,7 @@ exports.mapping = {
                 vibeIQIdentifier: 'itemNumber'
             },
             valueTransform: {
-                transformEx: (row) => {
+                transformEx: (row /*, dependencies*/) => {
                     return row['otherProp'] + 'xxx';
                 }
             }
@@ -79,7 +93,7 @@ exports.mapping = {
         vibeOwningKeys: ['itemNumber', 'lifecycleStage'],
         vibe2flex: {
             getClass: () => 'LCSSKU',
-            getSoftType: (entity) => {
+            getSoftType: (entity /*, dependencies*/) => {
                 const prodType = entity['prodType'];
                 let val = '';
                 switch (prodType) {

package/lib/util/data-converter.d.ts

@@ -19,21 +19,123 @@ export declare class DataConverter {
     getFlexPLMObjectDataFromEvent(event: any, dataToSkip: string[]): Promise<{}>;
     getFlexPLMObjectData(newData: any, dataToSkip: string[], inflateObjRef: boolean): Promise<{}>;
     getFlexPLMValue(prop: any, newData: any, inflateObjRef: boolean): Promise<any>;
+    /** Returns the display values for list properties (choice & multi_select)
+     *
+     * @param prop
+     * @param newData
+     * @returns
+     */
     getEnumerationValue(prop: any, nd: any): any;
     getObjectReferenceValue(prop: any, newData: any, inflateObjRef?: boolean): Promise<any>;
+    /** (Deprecated) Use TypeConversionUtils.getMapKey()
+     * Will return the class to use to get mapping.
+     * This is needed because mappings will be different for different sub types
+     * of custom-entity
+     *
+     * @param obj: Entity being checked
+     * @param mapping: The whole mapping file
+     */
     getMappingClass(entity: object, mapping: any): string;
+    /** Sets entity values from FlexPLM data passed in
+     * Assumes the entity has a VibeIQ typeId and 'roles' value to filter if necessary.
+     * @param entity the entity to update
+     * @param data the FlexPLM data
+     * @param keysToSkip properties to skip
+     * @returns the modified entity with VibeIQ values
+     */
     setEntityValues(entity: any, data: any, keysToSkip?: string[]): Promise<any>;
+    /** Gets the entity values from FlexPLM data
+     * Assumes there isn't a VibeIQ typeId, so uses FlexPLM data to determine type
+     * @param objectClass FlexPLM object class
+     * @param data object data
+     * @param keysToSkip type properties to not process
+     * @returns object with VibeIQ values
+     */
     getEntityValues(objectClass: string, data: any, keysToSkip?: string[]): Promise<{}>;
+    /** Gets the VibeIQ value for the property from data
+     *
+     * @param prop the VibeIQ property
+     * @param data the FlexPLM data
+     * @returns value to be set in VibeIQ
+     */
     getEntityValue(prop: any, data: any): Promise<any>;
     setEnumerationKeys(prop: any, nd: any, matchByDisplay: any): any;
+    /** Compares the potential changes to the entity and returns only the actual differences.
+     *
+     * @param entity the full entity
+     * @param changes the potential changes
+     * @returns only the change values that are different from the entity's value
+     */
     getPersistableChanges(entity: object, changes: object): object;
+    /** Sets object reference value from FlexPLM data passed in
+     *
+     * @param prop the VibeIQ property
+     * @param nd the VibeIQ data
+     * @returns the object reference id from VibeIQ
+     */
     setObjectReferenceValue(prop: any, nd: any): Promise<any>;
+    private applyInboundTransformMap;
+    private buildObjectReferenceContext;
+    private lookupObjectReferenceViaIdentityService;
+    private lookupObjectReferenceViaQuery;
+    private pickSingleResult;
+    /**
+     * Retrieves all object references of a specified entity type based on the provided criteria.
+     * This function handles pagination and asynchronously fetches object references until there are no more pages.
+     * @param {string} entityType - The type of entity for which object references are to be retrieved.
+     * @param {object} rootTypeCriteria - The criteria used to filter object references.
+     * @returns {Promise<Array>} A Promise that resolves to an array containing all object references.
+     */
     getAllObjectReferences(entityType: string, rootTypeCriteria: any, postProcessCriteria?: any): Promise<any[]>;
+    /**
+     * Checks if all keys and values of a given object are present in an array of objects.
+     * @param {Object} criteria - The object whose keys and values are to be checked in the array of objects.
+     * @param {Array<Object>} arrayOfObjects - The array of objects to be searched for matching keys and values.
+     * @param {string} entityTypePath - The type / subtype for the property; objects must be this type or a sub type of it.
+     * @returns {(Object|boolean)} Returns the array of objects that matches all keys and values of the provided object.
+     *                             If no match is found, returns empty array.
+     */
     checkKeysAndValues(criteria: any, arrayOfObjects: any, entityTypePath: any): any[];
+    /** Filters out archived and trashed entities from the provided array of entities.
+     *
+     * @param entities
+     * @returns
+     */
     filterOutArchivedAndTrashedEntities(entities: any[]): any[];
+    /** Sets userListId value from FlexPLM data passed in
+     *
+     * @param prop the VibeIQ property
+     * @param nd the VibeIQ data
+     * @returns the modified entity with FlexPLM values
+     */
     setUserListValue(prop: any, nd: any): Promise<any>;
+    /** Makes batch calls of 1000 of user-org entities until
+     * it find one with userEmail of passed in nd.email.
+     * Maxes out after querying for 15,000 user-org entities
+     *
+     * @param nd
+     * @returns
+     */
     getUserByEmail(nd: any): Promise<any>;
+    /** Shows warning if user email address not present in group associated to property
+     *
+     * @param prop the VibeIQ property
+     * @param userEmail user email address
+     */
     processGroupMemberCheck(prop: any, userEmail: any): Promise<void>;
+    /** Gets the VibeIQ value for the userList property from data
+     *
+     * @param prop the VibeIQ property
+     * @param newData the FlexPLM data
+     * @returns value to be set in VibeIQ
+     */
     getUserListValue(prop: any, newData: any): Promise<any>;
+    /** Makes batch calls of 1000 of user-org entities until
+     * it find one with user.id of passed in userId.
+     * Maxes out after querying for 15,000 user-org entities
+     *
+     * @param userId
+     * @returns
+     */
     getUserById(userId: any): Promise<any>;
 }

package/lib/util/data-converter.js

@@ -7,6 +7,7 @@ const app_framework_1 = require("@contrail/app-framework");
 const util_1 = require("@contrail/util");
 const type_conversion_utils_1 = require("./type-conversion-utils");
 const map_utils_1 = require("./map-utils");
+const config_defaults_1 = require("./config-defaults");
 class DataConverter {
     static clearStaticUserCache() {
         DataConverter.staticUserCache = {};
@@ -44,16 +45,22 @@ class DataConverter {
         if (this.isVerboseDebugOn()) {
             console.debug('newData: ' + JSON.stringify(newData));
         }
+        //Using event to get propertyDiffs to find emptied values
+        //Add standard atts to skip
         dataToSkip = dataToSkip.concat(['updatedOn', 'updatedById', 'createdOn', 'createdById', 'modifiedAt', 'orgId', 'createdAt', 'id', 'typeId', 'workspaceId']);
+        // const oldData = event.oldData;
         const data = {};
         const typeId = newData?.typeId;
         if (!typeId) {
-            return;
+            return; // Don't have a type; so can't process
         }
         data['typePath'] = newData['typePath'];
         const type = await this.typeUtils.getTypeById(typeId);
         const typeProps = this.typeUtils.filterTypeProperties(type, newData);
         for (const prop of typeProps) {
+            // if(this.logger.isTraceOn()){
+            //   this.logger.log('prop: ' + JSON.stringify(prop));
+            // }
             const slug = prop['slug'];
             if (dataToSkip.includes(slug)) {
                 continue;
@@ -69,6 +76,7 @@ class DataConverter {
         const propertyType = prop['propertyType'];
         const slug = prop['slug'];
         const nd = newData[slug];
+        // console.log('getFlexPLMValue: ' + propertyType + ', ' +slug + ', ' + nd + ', ' + od);
         let value;
         if (['string', 'text'].includes(propertyType)) {
             value = nd || '';
@@ -79,6 +87,10 @@ class DataConverter {
         else if ('date' === propertyType) {
             if (nd) {
                 value = nd;
+                // const d = new Date(nd);
+                // console.log('Date.getTimezoneOffset(): ' + d.getTimezoneOffset());
+                // value = d.toISOString();
+                // console.log('date: ' + nd + ' -- ' + value);
             }
             else {
                 value = null;
@@ -100,11 +112,13 @@ class DataConverter {
             }
         }
         else if ('image' === propertyType) {
+            // console.log('image-TODO');
         }
         else if ('formula' === propertyType) {
             value = nd;
         }
         else if ('json' === propertyType) {
+            // console.log('json-TODO');
             value = nd;
         }
         else if ('userList' === propertyType) {
@@ -115,6 +129,12 @@ class DataConverter {
         }
         return value;
     }
+    /** Returns the display values for list properties (choice & multi_select)
+     *
+     * @param prop
+     * @param newData
+     * @returns
+     */
     getEnumerationValue(prop, nd) {
         const propertyType = prop['propertyType'];
         let value;
@@ -198,6 +218,14 @@ class DataConverter {
         this.objRefCache[entityId] = value;
         return value;
     }
+    /** (Deprecated) Use TypeConversionUtils.getMapKey()
+     * Will return the class to use to get mapping.
+     * This is needed because mappings will be different for different sub types
+     * of custom-entity
+     *
+     * @param obj: Entity being checked
+     * @param mapping: The whole mapping file
+     */
     getMappingClass(entity, mapping) {
         const entityTypePath = entity['typePath'];
         const typeMapKey = mapping['typeMapKey'];
@@ -211,11 +239,22 @@ class DataConverter {
         }
         return objClass;
     }
+    /** Sets entity values from FlexPLM data passed in
+     * Assumes the entity has a VibeIQ typeId and 'roles' value to filter if necessary.
+     * @param entity the entity to update
+     * @param data the FlexPLM data
+     * @param keysToSkip properties to skip
+     * @returns the modified entity with VibeIQ values
+     */
     async setEntityValues(entity, data, keysToSkip = []) {
+        // this.logger.log('setEntityValues: ' + JSON.stringify(entity));
+        // this.logger.log('data: ' + JSON.stringify(data));
         const type = await this.typeUtils.getTypeById(entity.typeId);
         keysToSkip = keysToSkip.concat(['updatedOn', 'updatedById', 'createdOn', 'createdById', 'modifiedAt', 'orgId', 'createdAt', 'id', 'typeId', 'typePath', 'workspaceId']);
         let typeProps = this.typeUtils.filterTypeProperties(type, entity);
         typeProps = typeProps.filter(prop => !keysToSkip.includes(prop['slug']));
+        //Only process properties that had a value sent; to not accidentally clear out values
+        //for properties that weren't sent.
         const dataKeys = Object.getOwnPropertyNames(data);
         typeProps = typeProps.filter(prop => dataKeys.includes(prop['slug']));
         for (const prop of typeProps) {
@@ -226,16 +265,24 @@ class DataConverter {
                 keyName = slug + 'Id';
             }
             entity[keyName] = await this.getEntityValue(prop, data);
+            // console.log('entity[slug]: ' + entity[slug]);
         }
         return entity;
     }
+    /** Gets the entity values from FlexPLM data
+     * Assumes there isn't a VibeIQ typeId, so uses FlexPLM data to determine type
+     * @param objectClass FlexPLM object class
+     * @param data object data
+     * @param keysToSkip type properties to not process
+     * @returns object with VibeIQ values
+     */
     async getEntityValues(objectClass, data, keysToSkip = []) {
         const entityValues = {};
         const tco = await this.typeUtils.getEntityTypeClientOptionsUsingMapping(this.transformMapFile, this.mapFileUtil, data);
         const type = await this.typeUtils.getByRootAndPath(tco);
         const typePath = type['typePath'];
         if (typePath && (typePath.startsWith('item') || typePath.startsWith('project-item'))) {
-            if (['LCSProduct', 'LCSProductSeasonLink'].includes(objectClass)) {
+            if (['LCSProduct', 'LCSProductSeasonLink', 'LCSMaterial'].includes(objectClass)) {
                 entityValues['roles'] = ['family'];
             }
             else {
@@ -253,10 +300,17 @@ class DataConverter {
         }
         return entityValues;
     }
+    /** Gets the VibeIQ value for the property from data
+     *
+     * @param prop the VibeIQ property
+     * @param data the FlexPLM data
+     * @returns value to be set in VibeIQ
+     */
     async getEntityValue(prop, data) {
         const propertyType = prop['propertyType'];
         const slug = prop['slug'];
         const nd = data[slug];
+        // this.logger.log('getValue: ' + propertyType + ', ' +slug + ', ' + nd);
         let value;
         if (['string', 'text'].includes(propertyType)) {
             value = nd;
@@ -266,6 +320,11 @@ class DataConverter {
         }
         else if ('date' === propertyType) {
             if (nd) {
+                // const offset = new Date(nd).getTimezoneOffset() * 60 * 1_000;
+                // this.logger.log('nd: ' + nd);
+                // this.logger.log(offset);
+                // this.logger.log('No Offset: ' + new Date(nd).toISOString());
+                // const d = new Date(nd + offset);// Take system Timezone into account.
                 const d = new Date(nd);
                 value = d.toISOString();
             }
@@ -286,10 +345,13 @@ class DataConverter {
             value = await this.setObjectReferenceValue(prop, nd);
         }
         else if ('image' === propertyType) {
+            // console.log('TODO-image');
         }
         else if ('formula' === propertyType) {
+            // console.log('TODO-formula');
         }
         else if ('json' === propertyType) {
+            // console.log('TODO-json');
         }
         else if ('userList' === propertyType) {
             value = await this.setUserListValue(prop, nd);
@@ -297,12 +359,14 @@ class DataConverter {
         else if ('size_range' === propertyType) {
             value = nd;
         }
+        // console.log(value);
         return value;
     }
     setEnumerationKeys(prop, nd, matchByDisplay) {
         const propertyType = prop['propertyType'];
         let value;
         if (['choice', 'multi_select'].includes(propertyType)) {
+            //If there are no options, use empty array to not error out and don't set anything
             const options = prop['options'] || [];
             if ('choice' === propertyType) {
                 if (nd) {
@@ -332,6 +396,12 @@ class DataConverter {
         }
         return value;
     }
+    /** Compares the potential changes to the entity and returns only the actual differences.
+     *
+     * @param entity the full entity
+     * @param changes the potential changes
+     * @returns only the change values that are different from the entity's value
+     */
     getPersistableChanges(entity, changes) {
         const entityCompareValues = {};
         for (const key of (Object.getOwnPropertyNames(changes))) {
@@ -346,31 +416,58 @@ class DataConverter {
         }
         return diffValues;
     }
+    /** Sets object reference value from FlexPLM data passed in
+     *
+     * @param prop the VibeIQ property
+     * @param nd the VibeIQ data
+     * @returns the object reference id from VibeIQ
+     */
     async setObjectReferenceValue(prop, nd) {
-        let objectReferenceId = "";
         if (!nd) {
-            return objectReferenceId;
+            return "";
+        }
+        nd = await this.applyInboundTransformMap(nd);
+        const ctx = await this.buildObjectReferenceContext(prop, nd);
+        if (!ctx) {
+            return "";
+        }
+        if (this.objRefCache[ctx.cacheKey]) {
+            if (app_framework_1.Logger.isDebugOn()) {
+                console.debug(`object reference cache hit: ${ctx.cacheKey}`);
+            }
+            return this.objRefCache[ctx.cacheKey];
         }
-        if (this.transformMapFile) {
-            const mapKey = await type_conversion_utils_1.TypeConversionUtils.getMapKeyFromObject(this.transformMapFile, this.mapFileUtil, nd, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION);
-            nd = await map_utils_1.MapUtil.applyTransformMap(this.transformMapFile, this.mapFileUtil, nd, mapKey, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION);
+        const objectReferenceId = ctx.useIdentityService
+            ? await this.lookupObjectReferenceViaIdentityService(ctx, nd)
+            : await this.lookupObjectReferenceViaQuery(ctx);
+        if (objectReferenceId) {
+            this.objRefCache[ctx.cacheKey] = objectReferenceId;
         }
+        return objectReferenceId;
+    }
+    async applyInboundTransformMap(nd) {
+        if (!this.transformMapFile) {
+            return nd;
+        }
+        const mapKey = await type_conversion_utils_1.TypeConversionUtils.getMapKeyFromObject(this.transformMapFile, this.mapFileUtil, nd, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION);
+        return map_utils_1.MapUtil.applyTransformMap(this.transformMapFile, this.mapFileUtil, nd, mapKey, type_conversion_utils_1.TypeConversionUtils.FLEX2VIBE_DIRECTION);
+    }
+    async buildObjectReferenceContext(prop, nd) {
         const entityType = prop['referencedTypeRootSlug'];
         const entityTypePath = prop['referencedTypePath'];
         const entityKeys = Object.keys(nd);
         const identifierKeys = await type_conversion_utils_1.TypeConversionUtils.getIdentifierPropertiesFromObject(this.transformMapFile, this.mapFileUtil, nd);
         const hasAllIdentifiers = identifierKeys.every(key => entityKeys.includes(key));
-        if (identifierKeys.length == 0 || !hasAllIdentifiers) {
+        if (identifierKeys.length === 0 || !hasAllIdentifiers) {
             console.warn(`The inbound ${entityType} for prop '${prop['slug']}' doesnt have all "identifier" properties, so there is no processing. Identifier properties: ${identifierKeys}`);
-            return objectReferenceId;
+            return null;
         }
         const rootType = await this.typeUtils.getByRootAndPath({ root: entityType });
         const rootTypeProps = this.typeUtils.filterTypeProperties(rootType, nd);
-        let rootTypeCriteria = {};
-        let typeCriteria = {};
+        const rootTypeCriteria = {};
+        const typeCriteria = {};
         identifierKeys.forEach(keyName => {
-            const foundInObjects = rootTypeProps.some(obj => obj.slug === keyName);
-            if (foundInObjects) {
+            if (rootTypeProps.some(obj => obj.slug === keyName)) {
                 rootTypeCriteria[keyName] = nd[keyName];
             }
             else {
@@ -379,31 +476,51 @@ class DataConverter {
         });
         const combinedCriteria = { ...rootTypeCriteria, ...typeCriteria, typePath: entityTypePath };
         const cacheKey = Object.values(combinedCriteria).join('_');
-        if (this.objRefCache[cacheKey]) {
-            if (app_framework_1.Logger.isDebugOn()) {
-                console.debug(`object reference cache hit: ${cacheKey}`);
-            }
-            return this.objRefCache[cacheKey];
-        }
-        let arrObjectReferences = await this.getAllObjectReferences(entityType, rootTypeCriteria);
-        if (entityType !== entityTypePath) {
-            arrObjectReferences = this.checkKeysAndValues(typeCriteria, arrObjectReferences, entityTypePath);
-        }
-        if (arrObjectReferences.length) {
-            if (arrObjectReferences.length === 1) {
-                objectReferenceId = arrObjectReferences[0].id;
-            }
-            else {
-                console.warn(`The passed in object reference criteria has duplicate records found ${JSON.stringify(combinedCriteria)}.`);
-            }
+        const rolesIsTypeDiscriminator = entityType === 'item' || entityType === 'project-item';
+        const identityLookupKeys = rolesIsTypeDiscriminator
+            ? identifierKeys.filter(key => key !== 'roles')
+            : identifierKeys;
+        const useIdentityService = config_defaults_1.ConfigDefaults.isPropertyTrue(this.config?.search?.[entityType]?.useIdentityServiceForInboundData)
+            && identityLookupKeys.length === 1;
+        return { entityType, entityTypePath, rootTypeCriteria, typeCriteria, combinedCriteria, cacheKey, useIdentityService, identityLookupKeys };
+    }
+    async lookupObjectReferenceViaIdentityService(ctx, nd) {
+        const propertyName = ctx.identityLookupKeys[0];
+        const propertyValue = nd[propertyName];
+        const poolKey = await type_conversion_utils_1.TypeConversionUtils.getUniquenessPoolKeyFromObject(this.transformMapFile, this.mapFileUtil, nd);
+        const identityResults = await new sdk_1.Entities().get({
+            entityName: 'identity',
+            criteria: { poolKey, propertyName, propertyValue }
+        }) ?? [];
+        const match = this.pickSingleResult(identityResults, ctx.combinedCriteria);
+        return match ? match.entityReference.split(':')[1] : "";
+    }
+    async lookupObjectReferenceViaQuery(ctx) {
+        let arrObjectReferences = await this.getAllObjectReferences(ctx.entityType, ctx.rootTypeCriteria);
+        if (ctx.entityType !== ctx.entityTypePath) {
+            arrObjectReferences = this.checkKeysAndValues(ctx.typeCriteria, arrObjectReferences, ctx.entityTypePath);
         }
-        if (!objectReferenceId) {
+        const match = this.pickSingleResult(arrObjectReferences, ctx.combinedCriteria);
+        return match ? match.id : "";
+    }
+    pickSingleResult(results, combinedCriteria) {
+        if (!results.length) {
             console.warn(`The passed in object reference criteria ${JSON.stringify(combinedCriteria)} didn't match any entities.`);
-            return objectReferenceId;
+            return undefined;
         }
-        this.objRefCache[cacheKey] = objectReferenceId;
-        return objectReferenceId;
+        if (results.length > 1) {
+            console.warn(`The passed in object reference criteria has duplicate records found ${JSON.stringify(combinedCriteria)}.`);
+            return undefined;
+        }
+        return results[0];
     }
+    /**
+     * Retrieves all object references of a specified entity type based on the provided criteria.
+     * This function handles pagination and asynchronously fetches object references until there are no more pages.
+     * @param {string} entityType - The type of entity for which object references are to be retrieved.
+     * @param {object} rootTypeCriteria - The criteria used to filter object references.
+     * @returns {Promise<Array>} A Promise that resolves to an array containing all object references.
+     */
     async getAllObjectReferences(entityType, rootTypeCriteria, postProcessCriteria = null) {
         const entities = new sdk_1.Entities();
         let loads = [];
@@ -459,6 +576,14 @@ class DataConverter {
         }
         return loads;
     }
+    /**
+     * Checks if all keys and values of a given object are present in an array of objects.
+     * @param {Object} criteria - The object whose keys and values are to be checked in the array of objects.
+     * @param {Array<Object>} arrayOfObjects - The array of objects to be searched for matching keys and values.
+     * @param {string} entityTypePath - The type / subtype for the property; objects must be this type or a sub type of it.
+     * @returns {(Object|boolean)} Returns the array of objects that matches all keys and values of the provided object.
+     *                             If no match is found, returns empty array.
+     */
     checkKeysAndValues(criteria, arrayOfObjects, entityTypePath) {
         let arrOfMatchObjects = [];
         for (let i = 0; i < arrayOfObjects.length; i++) {
@@ -482,6 +607,11 @@ class DataConverter {
         }
         return arrOfMatchObjects;
     }
+    /** Filters out archived and trashed entities from the provided array of entities.
+     *
+     * @param entities
+     * @returns
+     */
     filterOutArchivedAndTrashedEntities(entities) {
         if (!entities || !Array.isArray(entities) || entities.length === 0) {
             return [];
@@ -492,6 +622,12 @@ class DataConverter {
             return !isArchived && !isTrashed;
         });
     }
+    /** Sets userListId value from FlexPLM data passed in
+     *
+     * @param prop the VibeIQ property
+     * @param nd the VibeIQ data
+     * @returns the modified entity with FlexPLM values
+     */
     async setUserListValue(prop, nd) {
         if (!nd?.email) {
             return "";
@@ -512,6 +648,13 @@ class DataConverter {
         }
         return userId;
     }
+    /** Makes batch calls of 1000 of user-org entities until
+     * it find one with userEmail of passed in nd.email.
+     * Maxes out after querying for 15,000 user-org entities
+     *
+     * @param nd
+     * @returns
+     */
     async getUserByEmail(nd) {
         let userOrg = undefined;
         let count = 0;
@@ -528,6 +671,11 @@ class DataConverter {
         } while (!userOrg && size == getOptionsCriteria.take && count < 15);
         return userOrg?.user;
     }
+    /** Shows warning if user email address not present in group associated to property
+     *
+     * @param prop the VibeIQ property
+     * @param userEmail user email address
+     */
     async processGroupMemberCheck(prop, userEmail) {
         let arrUserList = [];
         if (this.userRefCache[prop.typePropertyUserListId]) {
@@ -550,6 +698,12 @@ class DataConverter {
             }
         }
     }
+    /** Gets the VibeIQ value for the userList property from data
+     *
+     * @param prop the VibeIQ property
+     * @param newData the FlexPLM data
+     * @returns value to be set in VibeIQ
+     */
     async getUserListValue(prop, newData) {
         const slug = prop['slug'];
         if (app_framework_1.Logger.isDebugOn()) {
@@ -578,6 +732,13 @@ class DataConverter {
         }
         return value;
     }
+    /** Makes batch calls of 1000 of user-org entities until
+     * it find one with user.id of passed in userId.
+     * Maxes out after querying for 15,000 user-org entities
+     *
+     * @param userId
+     * @returns
+     */
     async getUserById(userId) {
         let userOrg = undefined;
         let count = 0;