Appboard/2.4/builder/data processing scripts - Revision history

imported>David.moore: /* Applying a Data Processing Script */

2014-03-30T18:48:15Z

Applying a Data Processing Script

← Older revision		Revision as of 18:48, 30 March 2014
Line 27:		Line 27:
	#Click through the wizard to finish		#Click through the wizard to finish
	#View the appropriate data collection (re-query if necessary) to see if data is being updated		#View the appropriate data collection (re-query if necessary) to see if data is being updated

			{{Note\|If you have a Sub-Query based on a data source that is using a Data Processing Script, in order for the Sub-Query to have access to any new attributes created by the script, you must first query the data collection of the data source with the script prior to configuring or editing the Sub-Query.}}

	== Examples ==		== Examples ==

imported>Jason.nicholls at 06:51, 14 December 2013

2013-12-14T06:51:03Z

← Older revision		Revision as of 06:51, 14 December 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:Data Processing Scripts}}		{{DISPLAYTITLE:Data Processing Scripts}}
			[[Category:AppBoard 2.4]]

	Data Processing Scripts are a method of processing data returned from Data Sources before it's made available to the rest of the system. This is a very flexible method to transform data in order to meet the specific needs of a solution.		Data Processing Scripts are a method of processing data returned from Data Sources before it's made available to the rest of the system. This is a very flexible method to transform data in order to meet the specific needs of a solution.

imported>Jason.nicholls at 09:03, 11 December 2013

2013-12-11T09:03:52Z

← Older revision		Revision as of 09:03, 11 December 2013
Line 35:		Line 35:
	AppBoard ships with an example <tt>SessionEnrichment.groovy</tt> which automatically adds additional fields with the session information listed above.		AppBoard ships with an example <tt>SessionEnrichment.groovy</tt> which automatically adds additional fields with the session information listed above.

			'''SessionEnrichment.groovy'''
			<code>[java,N]
			import com.edgetech.services.ServiceRequestFacade
			import com.edgetech.services.ServiceResponseFacade
			import com.edgetech.services.GenericRecord
			import com.edgetech.services.Association
			import com.edgetech.services.DataAdapter;
			import com.edgetech.services.GenericRecord;
			import com.edgetech.services.NamespaceService;
			import com.edgetech.services.model.EntityDef;
			import com.edgetech.services.model.Query;

			import java.util.Collection;
			import java.util.Iterator;
			import java.util.HashMap;

			ServiceResponseFacade serviceResponse = responseFacade;
			ServiceRequestFacade serviceRequest = requestFacade;

			Collection<GenericRecord> records = serviceResponse.getOrderedGenericRecords();
			if ( ( records != null ) && !records.isEmpty() ) {

			Iterator<GenericRecord> recIter = records.iterator();
			while ( recIter.hasNext() ) {

			GenericRecord rec = recIter.next();

			rec.setAttributeValue( "_session_user", serviceRequest.getSessionContext().getActor().getUser().getID() );
			rec.setAttributeValue( "_session_domain", serviceRequest.getSessionContext().getActor().getUser().getDomain().getName() );
			rec.setAttributeValue( "_session_role", serviceRequest.getSessionContext().getRole().getName() );
			try {
			rec.setAttributeValue( "_session_var_bob", serviceRequest.getDataAdapter().performSubstitution("\${shim:session.var.get('bob')}" ) );
			} catch (Exception e) {
			rec.setAttributeValue( "_session_var_bob", "undef" );
			}
			}
			}
			</code>

	=== Trim Whitespace ===		=== Trim Whitespace ===

imported>Jason.nicholls: /* Examples */

2013-12-11T09:02:04Z

Examples

← Older revision		Revision as of 09:02, 11 December 2013
Line 28:		Line 28:

	== Examples ==		== Examples ==

			=== Enrich with Session Information ===

			In AppBoard there are many places where it may be useful to have access to session information such as action filters, icon/color/shape filters, labels, and a variety of actions. A way to do this is to enrich the data response with session information such as the username, domain, role, and session variables.

			AppBoard ships with an example <tt>SessionEnrichment.groovy</tt> which automatically adds additional fields with the session information listed above.


	=== Trim Whitespace ===		=== Trim Whitespace ===

imported>Jason.nicholls at 08:55, 11 December 2013

2013-12-11T08:55:56Z

← Older revision		Revision as of 08:55, 11 December 2013
Line 27:		Line 27:
	#View the appropriate data collection (re-query if necessary) to see if data is being updated		#View the appropriate data collection (re-query if necessary) to see if data is being updated

	== ~~Data Processing Script Example~~ ==		== Examples ==

			=== Trim Whitespace ===

			In this example extra leading and trailing whitespace is removed from the <tt>SITE_CODE</tt> field. It also creates a new field <TT>SITE_CODE2</tt> which is a concatenation of the <tt>SITE_CODE</tt> and <tt>STATE</tt> fields.

	'''TrimSiteCode.groovy'''		'''TrimSiteCode.groovy'''

imported>Andy.hopper: /* Applying a Data Processing Script */

2013-10-16T13:22:34Z

Applying a Data Processing Script

← Older revision		Revision as of 13:22, 16 October 2013
Line 10:		Line 10:
	#Select the data source to be affected and click the "Edit" button		#Select the data source to be affected and click the "Edit" button
	#Advance through the data source wizard to the "Query" stage for database, IBM Omnibus/Netcool, or ServiceNow adapters, or the "Explore" stage otherwise.		#Advance through the data source wizard to the "Query" stage for database, IBM Omnibus/Netcool, or ServiceNow adapters, or the "Explore" stage otherwise.
			#Next, access the "Data Processing Script" area:
	#*For database, IBM Omnibus/Netcool, or ServiceNow adapters click the table you want to transform and click the "Edit" button.		#*For database, IBM Omnibus/Netcool, or ServiceNow adapters click the table you want to transform and click the "Edit" button.
	#*Otherwise, select the table you want to transform and then click the "Advanced" button.		#*Otherwise, select the table you want to transform and then click the "Advanced" button.

imported>Andy.hopper: /* Applying a Data Processing Script */

2013-10-16T13:20:30Z

Applying a Data Processing Script

← Older revision		Revision as of 13:20, 16 October 2013
Line 9:		Line 9:
	#Open the AppBoard Builder and click on "Data Sources"		#Open the AppBoard Builder and click on "Data Sources"
	#Select the data source to be affected and click the "Edit" button		#Select the data source to be affected and click the "Edit" button
	#Advance through the data source wizard to the "~~explore~~" stage		#Advance through the data source wizard to the "Query" stage for database, IBM Omnibus/Netcool, or ServiceNow adapters, or the "Explore" stage otherwise.
	#~~Select~~ the table you want to transform and then click the "Advanced" button		#*For database, IBM Omnibus/Netcool, or ServiceNow adapters click the table you want to transform and click the "Edit" button.
			#*Otherwise, select the table you want to transform and then click the "Advanced" button.
			# Click "Add" in the Data Processing Script section.
	#Configure the Data Processing Script		#Configure the Data Processing Script
	##Input the path name of the script		##Input the path name of the script

imported>Jason.nicholls: moved appboard/2.4/builder/data processing script to appboard/2.4/builder/data processing scripts

2013-10-02T06:07:40Z

moved appboard/2.4/builder/data processing script to appboard/2.4/builder/data processing scripts

← Older revision	Revision as of 06:07, 2 October 2013
(No difference)

imported>Jason.nicholls: /* Data Processing Script Example */

2013-10-02T06:04:11Z

Data Processing Script Example

imported>Jason.nicholls: /* Data Processing Script Example */

2013-10-02T06:01:27Z

Data Processing Script Example

← Older revision		Revision as of 06:01, 2 October 2013
Line 27:		Line 27:

	'''TrimSiteCode.groovy'''		'''TrimSiteCode.groovy'''
	<~~pre~~>import com.edgetech.services.ServiceRequestFacade		<code>[java,N]
			import com.edgetech.services.ServiceRequestFacade
	import com.edgetech.services.ServiceResponseFacade		import com.edgetech.services.ServiceResponseFacade
	import com.edgetech.services.GenericRecord		import com.edgetech.services.GenericRecord
Line 60:		Line 61:
	}		}
	}		}
			</code>
	</~~pre~~>

← Older revision		Revision as of 06:04, 2 October 2013
Line 44:		Line 44:
	ServiceRequestFacade serviceRequest = requestFacade;		ServiceRequestFacade serviceRequest = requestFacade;

	Collection recordsToClean = serviceResponse.getOrderedGenericRecords();		Collection recordsToClean = serviceResponse.getOrderedGenericRecords();
	if ( ( recordsToClean != null ) && !recordsToClean.isEmpty() ) {		if ( ( recordsToClean != null ) && !recordsToClean.isEmpty() ) {
	for ( GenericRecord recordToClean:recordsToClean ) {		for ( GenericRecord recordToClean:recordsToClean ) {
	String siteCode = recordToClean.getAttributeValueAsString("SITE_CODE");		String siteCode = recordToClean.getAttributeValueAsString("SITE_CODE");
	if ( siteCode != null ) {		if ( siteCode != null ) {
	recordToClean.setAttributeValue("SITE_CODE", siteCode.trim());		recordToClean.setAttributeValue("SITE_CODE", siteCode.trim());
	String stateCode = recordToClean.getAttributeValueAsString("STATE");		String stateCode = recordToClean.getAttributeValueAsString("STATE");
	if ( stateCode != null ) {		if ( stateCode != null ) {
	recordToClean.setAttributeValue("SITE_CODE2", siteCode.trim() + stateCode.trim());		recordToClean.setAttributeValue("SITE_CODE2", siteCode.trim() + stateCode.trim());
	}		}
	}		}
	String region = recordToClean.getAttributeValueAsString("REGION");		String region = recordToClean.getAttributeValueAsString("REGION");
	if ( region != null ) {		if ( region != null ) {
	recordToClean.setAttributeValue("REGION", region.trim());		recordToClean.setAttributeValue("REGION", region.trim());
	}		}
	}		}
	}		}
	</code>		</code>