The Suitelet

To download the script, click here.

/**
* @NApiVersion 2.1
* @NScriptType Suitelet
* @NModuleScope Public
*/

/* 

------------------------------------------------------------------------------------------
Script Information
------------------------------------------------------------------------------------------

Name:
External Search Utility

ID:
_external_id_search

Description
A utility for searching transactions and entities based on an external ID.


------------------------------------------------------------------------------------------
MIT License
------------------------------------------------------------------------------------------

Copyright (c) 2022 Timothy Dietrich.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


------------------------------------------------------------------------------------------
Developer(s)
------------------------------------------------------------------------------------------

Tim Dietrich
• timdietrich@me.com
• https://timdietrich.me


------------------------------------------------------------------------------------------
History
------------------------------------------------------------------------------------------

20220822 - Tim Dietrich
• Initial version.

20220828 - Tim Dietrich
• Added support for items.

*/


var 
	log,
	query,
	serverWidget;


define( [ 'N/log', 'N/query', 'N/ui/serverWidget' ], main );


function main( logModule, queryModule, serverWidgetModule ) {

	log = logModule;
	query= queryModule;
	serverWidget = serverWidgetModule;				
	
    return {
    
    	onRequest: function( context ) {
    	
			var form = serverWidget.createForm(
				{
					title: 'External ID Search Utility',
					hideNavBar: false
				}
			);		
			
			form.addSubmitButton( { label: 'Search' } );
			
			var idField = form.addField(
				{
					id: 'custpage_field_externalid',
					type: serverWidget.FieldType.TEXT,
					label: 'External ID'
				}								
			);				
			
			idField.isMandatory = true;	
											
			if ( context.request.method == 'POST' ) {	
			
				idField.defaultValue = context.request.parameters.custpage_field_externalid;

				formProcess( context, form );
			
			}
			
			context.response.writePage( form );	
			
        }
        
    }

}


function formProcess( context, form ) {	

	var externalID = context.request.parameters.custpage_field_externalid;

	var theQuery = `
			SELECT
				*
			FROM
				(
	
					SELECT
						'<a href="/app/accounting/transactions/transaction.nl?id=' || ID || '" target="_transaction" || ID || ">View</a>' 
							|| ' | ' ||
							'<a href="/app/accounting/transactions/transaction.nl?id=' || ID || '&e=T" target="_transaction" || ID || ">Edit</a>' 
							AS Links,
						ExternalID,
						TranDisplayName AS Name,
						CreatedDate AS DateCreated,												
						BUILTIN.DF( Type ) AS RecordType,
						ID AS InternalID,
						TranID AS RecordID									
					FROM
						Transaction
					WHERE
						ExternalID LIKE ?

					UNION

					SELECT
						'<a href="/app/common/entity/entity.nl?id=' || ID || '" target="_entity" || ID || ">View</a>' 
							|| ' | ' ||
							'<a href="/app/common/entity/entity.nl?id=' || ID || '&e=T" target="_entity" || ID || ">Edit</a>' 
							AS Links,
						ExternalID,
						EntityTitle AS Name,
						DateCreated,						
						'Entity' AS RecordType,
						ID AS InternalID,
						EntityID AS RecordID				
					FROM
						Entity
					WHERE
						ExternalID LIKE ?
						
					UNION
					
					SELECT
						'<a href="/app/common/item/item.nl?id=' || ID || '" target="_item" || ID || ">View</a>' 
							|| ' | ' ||
							'<a href="/app/common/item/item?id=' || ID || '&e=T" target="_item" || ID || ">Edit</a>' 
							AS Links,
						ExternalID,
						FullName AS Name,
						CreatedDate AS DateCreated,												
						BUILTIN.DF( ItemType ) AS RecordType,
						ID AS InternalID,
						ItemID AS RecordID
					FROM
						Item
					WHERE
						ExternalID LIKE ?

				)
			ORDER BY
				ExternalID,
				RecordType,
				RecordID
		`;
	
	try {

		var queryResults = query.runSuiteQL(
			{
				query: theQuery, 
				params: [ externalID, externalID, externalID ]
			}
		); 				
	
		var records = queryResults.asMappedResults();				
	
		if ( records.length > 0 ) {	

			var resultsSublist = form.addSublist(
				{ 
					id : 'results_sublist', 
					label : ` External ID References for `, 
					type : serverWidget.SublistType.LIST 
				}
			);

			var columnNames = Object.keys( records[0] );

			for ( i = 0; i < columnNames.length; i++ ) {

				resultsSublist.addField(
					{ 
						id: 'custpage_results_sublist_col_' + i,
						type: serverWidget.FieldType.TEXT,
						label: columnNames[i]
					}
				);

			}

			for ( r = 0; r < records.length; r++ ) {

				var record = records[r];

				for ( c = 0; c < columnNames.length; c++ ) {

					var column = columnNames[c];

					var value = record[column];
					
					if ( value != null ) {
					
						value = value.toString();
						
						if ( value.length > 300 ) {			
							value = value.substring( 0, 297 ) + '...';			
						}

						resultsSublist.setSublistValue(
							{
								id : 'custpage_results_sublist_col_' + c,
								line : r,
								value : value
							}
						);        

					}	
					
				}

			}			

		} else {
		
			var errorField = form.addField(
				{
					id: 'custpage_field_error',
					type: serverWidget.FieldType.TEXT,
					label: 'Error'
				}								
			);		
			
			errorField.defaultValue = 'No references were found for: ' + context.request.parameters.custpage_field_itemid;					
		
		}

	} catch( e ) {	
	
		var errorField = form.addField(
			{
				id: 'custpage_field_error',
				type: serverWidget.FieldType.LONGTEXT,
				label: 'Error'
			}								
		);		
	
		errorField.defaultValue = e.message;			
		
	}

}