Search Results for 'script'

[Sam Moffatt]

Thanks @daniel_leu! It’s picking up on what you did and extending it! I only learned about the string interpolation/string template feature recently when I picked Javascript up again with Tap Forms. I was looking for a better way of building larger templated strings because I figured there had to be something by now in Javascript and turns out there was! ES6 brought the language a long way.

[Daniel Leu]

I really should learn Javascript… Thank you, Sam, for showing and explaining how to make the code more elegant and robust!

Cheers, Daniel

---
See https://lab.danielleu.com/tapformspro/ for scripts and tips&tricks

[Sam Moffatt]

You might want to use a form script though depending on what you are doing. The way I think of things is:

• script fields update when the fields they refer to update and change their value based on that. They are useful for setting their own static value or even setting other fields. I use script fields to do stuff like take a notes field, parse it and then fill in other fields in a form. Script fields for me are the sort of thing that you should be able to run multiple times and they should have roughly the same output. Script fields are a little magical which is good and bad.*
• form scripts I use for instances where I need a manual interaction OR the side effect of the script is in a sense variable. I use these for doing quick data entry, creating new records based on existing data or to automate mistake fixing.* The other use case is for building function libraries which allows re-usable code.

In your case I think I’d actually model this as form scripts, create a form for logging and then when you generate your emails you put them in the log. In the log form you have the weblink to create the email and use that to send the email based on the log. That way you have a record of what you generated and when you sent it from within Tap Forms and you don’t have to go to your email to see what you sent.

Then in terms of automating this I’d look to use form scripts with the prompter to ask for input. You could actually build a full state machine in the scripting engine and then use the log form mentioned above to be your audit trail as you go through everything. You could do some of this with script fields that watch and update a state field somewhere (and a previous state field as well) but in this case it sounds like you a form script with explicit intent is better than implicit state management.

* When I say script fields are magical and I use form scripts for mistake fixing…I have a set of script fields that automatically propagate changes for like shipping dates into or from other records. Doing that means that I can’t simply change those fields because it detects those changes, runs it’s validation and then tries to undo the changes I just made because it makes the state inconsistent. To work around this, I have a few form scripts that reset these fields in a way that disables the script field updates so that I can change everything without my own automation undoing the changes.

[john cesta]

It looks like I could make a script as a field type and the result would be the email body. What’s ever in the fields within the script would be available for me to simply copy into an email.

I think that’s possible.

[john cesta]

Thanks Sam. I’ve started with just getting and setting one field. What I have is a form called written biz and want to send the client an email for each phase of the policy. In the email I put the policy number, their name, and a few other fields in the record. So what’s ever In the record will go when I send the email.

It works the same for every one and every policy. So while the calculation may be too weak
Th script would certainly do it.

I understand the complexity of a partial feature set. I didn’t think of the iPhone aspect though.

John

[Sam Moffatt]

The challenge with porting some of that stuff over to iOS is whilst it makes sense for iPad it isn’t as useful on iPhone. That means it’s something useful for only half of the iOS market now that iOS apps are on both form factors. Perhaps an extra unlock for that as a feature so that those who only use an iPhone don’t have to pay for a feature they can’t use. That then leads to complications in the UI around enabling and disabling functionality based on the purchases which has their own challenges (and the inevitable restore purchases button). There’s also the other challenge that there is only one Brendan.

I think you can use a calculation field to create the text you want and if you’re not doing a whole bunch of them at once, you can use the process Daniel Leu suggested as well. If you look at the bottom of the Calculations documentation, there is an example of formatting an address using a calculation field. You could use that as the basis of building out a fully formatted body. Alternatively you could use a script to build the template as well for creating the email link. Using a script, you’d put your template inside of the script and you can use variables inside of it.

You can use a script to set multiple field values, setFieldValue or setFieldValues from the JS API can help you out there. Once you set a value, you also need to save those changes with document.saveAllChanges() otherwise they might not persist.

On my iPad I did a quick test to build a form with a standard address layout and then made a script field to populate a “Web Site” field for me. The script looks like this:

var name = record.getFieldValue('fld-f3d753238cf4457cb2ccd5c0eaa96b0f');
var email = record.getFieldValue('fld-b1b7229002144634ae174c861b78ae72');
var address_1 = record.getFieldValue('fld-ba8218dbc15741428af68f3e80c29fea');
var address_2 = record.getFieldValue('fld-d11947b80b7a4592aa1815588275ef8e');
var city = record.getFieldValue('fld-c22af0fe9d1a4fd3a587d96a83b352e5');
var postcode = record.getFieldValue('fld-10d06c4cd8564b5a87ed365c5a307740');
var state = record.getFieldValue('fld-35f71f806348488e8f755be48b8ce2f2');
var country = record.getFieldValue('fld-0b6fe598592c428bab1010755d4bfa89');
var text = record.getFieldValue('fld-8b5d1c927eca4daa89c7750848bd02c2');

var addressLines = [];
name ? addressLines.push(name) : null;
address_1 ? addressLines.push(address_1) : null;
address_2 ? addressLines.push(address_2) : null;
addressLines.push(`${city} ${state} ${postcode}`);
country ? addressLines.push(country) : null;
var address = addressLines.join('\n');

var subject = encodeURIComponent(`Hello ${name}! We missed you!`);
var body = encodeURIComponent(`Hello ${name},

We haven't seen you for a while and we wanted to 
reach out to you. We don't  have a phone number 
on file for you but we do have your address:
${address}

If this isn't correct, please let us know so we 
can keep in touch. 

Thanks in advance!

Your Friends`);

var linkText = `mailto:${email}?subject=${subject}&body=${body}`;
var send_email_template_id = 'fld-f03ed31415304eab814d9f137db2f598';
record.setFieldValue(send_email_template_id, linkText);
document.saveAllChanges();

• The first chunk of the script gets all of the fields I care about via getFieldValue, that’s relatively straight forward.
• The next section does a simple address composition as an example of how empty/unset fields could be handled (it’s not perfect, I took a shortcut on the City/State/Postcode line). It uses the Javascript ternary operators to determine if it should add to an array and then does a join on what was added to the array.
• The next piece uses the Javascript backtick string interpolation feature to template the values out. It’s similar to the bracket format above except it uses a dollar sign and curly braces to wrap the variable. These values map to variables defined within the script itself. The first line is easy, it’s just the subject line. The second one shows how you can turn that into a multiline string to splice in values. Of note here I use encodeURIComponent to escape the text so that if you put in a special character it doesn’t munge the email.
• The last few lines compose the link text that makes the email. This is essentially the process Daniel Leu suggested though not encapsulated as well as he has done.

As you change the referenced fields, the web site field will update with the new values and then you can just tap on the globe icon and Tap Forms (after it asks “are you sure?”) will spin up Mail on the iPad prefilled with your email.

Edit: Forgot that the backticks are special on Brendan’s forum too. I used an online HTML entity encoder/decoder to fix it up.

Edit: I wrapped some of the lines in the message to better fit in the forum. Where you put line breaks in the script is where they will show up in the email. I’d generally want to manually wrap lines when doing plain text emails at less than 70 columns but that’s just me.

[john cesta]

I looked Daniel and responded thanks.

Brendan is determined to make me buy a Mac. I just bought my daughter a Mac and myself an iPad Pro. So I have to wait.

If it wasn’t too much trouble for tapforms I think some would be willing to pay more (I would) for an iPad versus in that contained even some of the Mac features like calendar and or the pdf fields feature.

I know it could be a lot of work porting it but what do I know?

Is there a way, perhaps with a script, to set values on multiple fields at once. After I mail to a few hundred people I’d like to set a field with the name of the mailing and date.

I use a child form to store the mailing content now.

[Sam Moffatt]

The result should be stored in the script field and it won’t change the original field. The reason for this is if you change the original field via the script, it’ll break the UI selection because it will trigger as you select the options.

My intent was that if you were using a layout to just use the script field in place of the editable field. You could flag the script field as hidden to remove the script field from the default layout but then use the script field on the layouts. This also means the UI will still work properly with the original field.

===

The other thing to do would be to take the script and turn it into a form script that instead of returning the value at the end, sets the value of the field. If you bind it to a keyboard shortcut, you can then press that once you’re done with your edits to clean the field.

To make it into a form script, change this line:

return cleaned.join(' ');

To:

record.getFieldValue('fld-6d04efdd9e334ad29399bc3c4aef4f06', cleaned.join(' '));

That’ll reset the field to the new value for you. You will also need to put document.saveAllChanges() somewhere in your script to make the change persist.

If you have many of these fields that you want to mutate this way and you went for a form script, you could do an array of the field ID’s.

First step of that is to change the Restructured method to accept a parameter:

function Restructured() {
	// Replace this with the field that stores your pick list.
	var sentence = record.getFieldValue('fld-6d04efdd9e334ad29399bc3c4aef4f06');

Is rewritten into

function Restructured(field_id) {
	// Replace this with the field that stores your pick list.
	var sentence = record.getFieldValue(field_id);

Update the setFieldValue at the bottom to use field_id as well.

Then when you call into Restructured, you can just set the field ID’s into an array:

Change:

Restructured();

To:

['fld-1', 'fld-2'].map(Restructured);
document.saveAllChanges();

Replacing in the list of fields you need to clean up. The beauty of this particular approach is that once the 1: placeholders are gone, assuming you don’t use colons elsewhere the field is stable so you can run it multiple times and it won’t break fields already updated. Though as I’m sure you’re aware, as soon as you rewrite that field the UI selection options will break.

Full script:

// This cleans out the Tap Forms comma and space delimiter.
function cleanString(input)
{
	// I had an input length check because the first array
	// element is going to actually be empty but then I put
	// in a filter and this if statement ended up being redundant.
	if (input.length)
	{
		// What we're looking for is a space OR comma multiple
		// times at the end of the string (the dollar sign means
		// end of string) and we want to replace that with an
		// empty string.
		return input.replace(/[\s,]*$/, "");
	}
}

// Boilerplate :D
function Restructured(field_id) {
	// Replace this with the field that stores your pick list.
	var sentence = record.getFieldValue(field_id);
	
	// Step 1: take the sentence and split it based on "Number: ", e.g. "1: ".
	var cleaned = sentence.split(/[0-9]*: /)
	// Step 2: Filter removes elements from an array that don't match.
	//         In this case, if the string length is greater than zero, keep it.
	//         The 'x' here is short hand for the array element and this could
	//         have also been implemented as another function.
		.filter(x => x.length > 0)
	// Step 3: Map executes a function per element and creates a new array with
	//         the new values. What we're doing is using "cleanString" to clean
	//         the values and remove the Tap Forms delimeters. This could also
	//         have been done inline too: .map(x => x.replace(/[\s,]*$/, ""))
		.map(cleanString);

	// Last but not least we return the value to our caller. In this case
	// we're joining the array with a single space however you could also do
	// this with a new line character (e.g. '\n') or any other string that
	// makes sense for your use case.
	record.setFieldValue(field_id, cleaned.join(' '));
}

['fld-6d04efdd9e334ad29399bc3c4aef4f06'].map(Restructured);
document.saveAllChanges();

[Daniel Leu]

I’m using TapForms as a simple CRM tool and once in a while, I need to send emails using content from a record. Using a field with the type ’email’ opens the mailtool, but doesn’t provide a way to add a subject or message content.

But I found that I can trick Tapforms into launching the email tool using a “mailto:” web link! And with “mailto:” I can set the email subject and body as well.

So in my form, I have a field called “Send Email” of the type ‘Web Site’. Using a script, I set this field with a mailto link and additional content derived from my customer record. The mailto link then looks like “mailto:email@company.com?subject=…@body=…”.

Then I have a script field called ‘Create Email’ which contains following code:

// Create Email URL String
function createEmailURL( recipient, subject, message) {

	var subject_field = subject ? "subject=" + subject : "set subject";
	var message_field = message ? "&body=" + message: "";

	var url = "mailto:" + recipient + "?" + subject_field + message_field;
	
	return url;
}

function Script() {
	var send_email_id = 'fld-c3fbfda318c5412fb5be8ecf2e0e7e3a';
	var name = record.getFieldValue('fld-00336938a7d340a58d47a7231fe497dd');
	var email = record.getFieldValue('fld-09e0ebeccf814d4b920e4021cf824997');

	var message = "Dear " + name;
	message += "\n\nThis is my message for you!";
	message += "\n\nRegards - Daniel";

	var url = createEmailURL(email, "Member update", message);

	record.setFieldValue(send_email_id, url);
	document.saveAllChanges();
	
	return url;
}

Script();

Whenever I update a field used in my script, the Send Email field is updated. Perfect! Unfortunately, I have to do a cmd-R (Refresh Selected Record) to have the GUI reflect the update as well. It would be so good to have a Record.Refresh() function to do this from a script (Brendan, are you listening? :)!

Once done, clicking on the Web Site link, the mailtool is opened with the prepared email.

This is not efficient if one needs to send hundreds of emails, but it is perfect for one or just a few.

Cheers, Daniel

---
See https://lab.danielleu.com/tapformspro/ for scripts and tips&tricks

[Chris Ju]

Thank you very much, Sam!

The script works! But the result is not stored in the field! What am I doing wrong?

It would be great, if you could give me an advice!

Thanks!
Chris

[Sam Moffatt]

I’ve been dwelling on this a little and one of the challenges is how the pick lists are stored. It’s essentially still a text field, even with the multiple select, which is why you can tick them and also manually type items in. If you get it exactly correct, it’ll match as the pick list too. I’m not sure Brendan can easily change that using the existing field type, it needs to be a new field type dedicated to the pick list.

As is often my solution here on the forums, you can use a script field to help you out. To make this work I did some minor tweaks, for the pick list I prefixed it with a number and colon sort of format and use that to split apart the string from the pick list. The pick list values I used look like this:

– 1: Something, I think, that will help.
– 2: This is, to be sure, the right path!
– 3: The path of caution, butterfly.

This is something that looks ok, doesn’t feel too janky but gives me a character to work with: the colon! If you need to use colons, I’d actually suggest using a pipe character (|) which is an old favourite of mine because not many people use that character in ordinary sentences.

This has comments inline that should explain as it goes:

// This cleans out the Tap Forms comma and space delimiter.
function cleanString(input)
{
	// I had an input length check because the first array
	// element is going to actually be empty but then I put
	// in a filter and this if statement ended up being redundant.
	if (input.length)
	{
		// What we're looking for is a space OR comma multiple
		// times at the end of the string (the dollar sign means
		// end of string) and we want to replace that with an
		// empty string.
		return input.replace(/[\s,]*$/, "");
	}
}

// Boilerplate :D
function Restructured() {
	// Replace this with the field that stores your pick list.
	var sentence = record.getFieldValue('fld-6d04efdd9e334ad29399bc3c4aef4f06');
	
	// Step 1: take the sentence and split it based on "Number: ", e.g. "1: ".
	var cleaned = sentence.split(/[0-9]*: /)
	// Step 2: Filter removes elements from an array that don't match.
	//         In this case, if the string length is greater than zero, keep it.
	//         The 'x' here is short hand for the array element and this could
	//         have also been implemented as another function.
		.filter(x => x.length > 0)
	// Step 3: Map executes a function per element and creates a new array with
	//         the new values. What we're doing is using "cleanString" to clean
	//         the values and remove the Tap Forms delimeters. This could also
	//         have been done inline too: .map(x => x.replace(/[\s,]*$/, ""))
		.map(cleanString);

	// Last but not least we return the value to our caller. In this case
	// we're joining the array with a single space however you could also do
	// this with a new line character (e.g. '\n') or any other string that
	// makes sense for your use case.
	return cleaned.join(' ');
}

Restructured();

This function makes use of Javascript’s chaining functionality. That is where you immediately use the object returned from the earlier method with the next method. The Restructured() method itself could actually be one line completely chained but I broke it up a little to help with the explanation. Put this into a script field and it’ll automatically reformat the pick list field to what I think you actually want. You will have to mutate your pick list to the format it expects (again that number, followed by a colon and ending with a space) though you could tweak the script not to care so much about that too.

Attachments:

You must be logged in to view attached files.

[john cesta]

I need to send emails to members. I have a form which contains various pieces of text I routinely send mostly when there is no phone number associated with a members information.

I’d like to include fields from the record in the email like…

Dear [firstName]

Your address is [city] [state] [zip]

Well, you get the idea.

Is there a way to do this in tapforms? Perhaps thru a calculation field or a script?

Thanks,

[Sam Moffatt]

Thanks! It turned out to be reasonably straight forward, the Javascript API having the flexibility to do it all is the neat bit for me. If there were document level scripts then you could have it run on any form without having to add it per form.

[Sam Moffatt]

I couldn’t resist giving this a chop. I ended up going with something that just did a copy, you could add a delete in though but I’d want to verify the new record first. YMMV. I posted it over on the Script Talk forum.

[Sam Moffatt]

Over on the main forum is a topic about move records from one form to another which I was curious about being able to solve.

This gives the user a list of forms excluding the currently selected one, checks to see if at least each of the fields in the source record are available in the destination and then creates a new record. In my limited testing it seems to work properly though by design it only copies records, it doesn’t delete the original so you need to do that after verification (trust, but verify).

I went through and put some comments in it that will hopefully make sense. There are two functions: the copyHandler is a callback that does the heavy lifting and the Copy_Record_To_Form function sets up the initial form list and prompter.

// Handler for prompter callback
var copyHandler = function()
{
	// Validate that we got a form name passed in.
	if (typeof formName == 'undefined' || formName.trim() == '')
	{
		console.log('Empty or undefined formName sent, cancelling.');
		return;
	}

	// Mapping of source field to target field
	// - the key will be source field and the value will be target field.
	var fieldMap = {};

	// List of fields in the source form that weren't found in the target form.
	var missingFields = [];

	// We shouldn't be here but let's check again.
	if (form.name == formName)
	{
		Utils.alertWithMessage('Unable to copy record to self', 'Please use the duplicate button to create a new record in the same form');
		return;
	}

	// Get the target form.
	var target = document.getFormNamed(formName);
	
	// Get the source fields.
	var sourceFields = form.getFields();
	
	// Iterate through each of them.
	for (sourceId in sourceFields)
	{
		// Look for a target field with the same name as the source field.
		var targetField = target.getFieldNamed(sourceFields[sourceId].name);
		if (targetField == null)
		{
			// If a targetField is missing, add the source field to the missing field list.
			missingFields.push(sourceFields[sourceId].name);
		}
		else
		{
			// Map the source field ID to the target field ID.
			fieldMap[sourceFields[sourceId].getID()] = targetField.getID();
		}
	}
	
	// If we had any missing fields.
	if (missingFields.length)
	{
		// Prompt a message with the missing fields and let the user know it's aborted.
		var fullMessage = ["The following fields weren't found in the target form:", "", ...missingFields];
		Utils.alertWithMessage('Copy Aborted!', fullMessage.join("\n"));
		return;
	}
	
	// Create the record data object and start to iterate through the field map.
	var recordData = {};
	for (sourceFieldId in fieldMap)
	{
		// Set in the record data the field ID of the target field as the key
		// and then get the current value of the source field.
		recordData[fieldMap[sourceFieldId]] = record.getFieldValue(sourceFieldId);
	}
	
	// Don't know if this works, set a secret value to the original record URL for linking.
	recordData['copy-source'] = record.getUrl();
	
	// Add a new record to the target form.
	var targetRecord = target.addNewRecord();
	
	// Set the field values for the newly created record.
	targetRecord.setFieldValues(recordData);
	
	// Save the data and log some values for reference.
	document.saveAllChanges();
	console.log('Original URL: ' + record.getUrl());
	console.log('Destination URL: ' + targetRecord.getUrl());
}

function Copy_Record_To_Form() {	
	// Get all of the forms.
	var forms = document.getForms();
	
	// A place to store a list of form names for the prompter.
	var formNames = [];

	// Iterate through all of the forms.
	for(var formId in forms)
	{
		// Ignore the currently selected form from the list.
		if (forms[formId].name == form.name)
		{
			continue;
		}
		
		// Append this form name to the list of form names for the prompter.
		formNames.push(forms[formId].name);
	}
	
	// Create a new prompter anddisplay the form list.
	var formPrompter = Prompter.new();
	formPrompter.cancelButtonTitle = 'Cancel';
	formPrompter.continueButtonTitle = 'Copy record';
	formPrompter.addParameter('Destination Form: ', 'formName', 'popup', formNames)
		.show('Select form to copy record: ', copyHandler);
}

Copy_Record_To_Form();