Save the date! Join us on October 16 for our Product Ops launch event. Register here.
Jun 02, 2020 06:36 PM
A common theme we are seeing with project management bases is the desire to have project and task templates. When you create a new project, it can then generate the corresponding set of tasks, and maintain the basic details about those tasks, including the relationships and dependencies amongst those tasks.
This is similar to Creating Tasks from a Template with a few differences. When creating projects, we often find we create a new record in our projects table, and then want to link it to a set of metadata (a project template). From there, each project template should know its associated set of tasks. This allows us to add more project templates over time, and change the set of tasks required to complete each of those projects.
Additionally, the script will ensure that the dependencies between the task templates are maintained when creating the tasks for a new project.
You can see examples of the base:
Full code below
// when a new asset is created,
// there are a certain number of tasks that must be completed
// these tasks are dependent on the type of asset
// Given a list of project and task templates,
// when a new asset is created and has a project template assigned
// we can then create corresponding set of tasks for that asset
// define some of our initial variables
// these are the basic table, field and view names to define to create the script
const project_table_name = 'Projects';
const new_project_view_name = 'New Projects';
const project_template_link_field_name = 'Project Template';
const task_table_name = 'Tasks';
const task_project_link_field_name = 'Projects';
const task_dependency_field_name = 'Followed By';
const task_primary_field_name = 'Task Name';
const task_to_template_link_field_name = '_task_template_id'; // this is used to assist with creating the links between tasks after they are created. We don't need to maintain a true linked record relationship, but temporarily storing the template's ID is helpful
const project_template_table_name = 'Project Templates';
const task_template_table_name = 'Task Templates';
const proj_temp_task_temp_link_field_name = 'Tasks';
const task_temp_dependency_field_name = 'Followed By';
const task_temp_primary_field_name = 'Task Name';
/********************************************************/
output.markdown('# Creating tasks for new assets and assigning dependencies');
// create our table objects
const project_table = base.getTable(project_table_name);
const task_table = base.getTable(task_table_name);
const project_temp_table = base.getTable(project_template_table_name);
const task_temp_table = base.getTable(task_template_table_name);
// get all new projects that have been assigned a template
// but do not yet have tasks
const new_project_view = project_table.getView(new_project_view_name);
const new_project_results = await new_project_view.selectRecordsAsync();
// pull all of our project templates and all task templates
const project_temp_results = await project_temp_table.selectRecordsAsync()
const task_temp_results = await task_temp_table.selectRecordsAsync();
// build a map of projects to tasks
output.markdown('### Setting up');
output.markdown('Building map of project templates and task templates');
var project_task_temp_map = {};
for (let r of project_temp_results.records) {
let temp_tasks = r.getCellValue(proj_temp_task_temp_link_field_name);
project_task_temp_map[r.id] = temp_tasks.map((t)=>{
return t.id;
})
}
output.inspect(project_task_temp_map);
// also build a map of task template to task template so we can resolve dependencies
output.markdown('Creating map of templated tasks to dependent tasks');
var task_temp_dependency_map = {};
for (let r of task_temp_results.records){
let next_task = r.getCellValue(task_temp_dependency_field_name);
if(next_task !== null) {
task_temp_dependency_map[r.id] = next_task[0].id;
} else {
task_temp_dependency_map[r.id] = null;
}
}
output.inspect(task_temp_dependency_map);
// for each new project
// get the set of tasks and create the creation payloads
// we will need to do a second pass of all of these records to then _update_
// the tasks with the corresponding dependencies
//
// THIS IS THE PART OF THE SCRIPT WHERE YOU ASSIGN WHAT DATA YOU WANT IN YOUR NEWLY CREATED TASKS
//
output.markdown('### Creating new tasks')
output.markdown(`Found **${new_project_results.records.length}** projects which need task assignment`)
var payloads = [];
for(let r of new_project_results.records){
// there should only ever be one project template linked
// so just take the first one
let p_id = r.getCellValue(project_template_link_field_name)[0].id;
let task_temp_ids = project_task_temp_map[p_id];
let task_temps = task_temp_ids.map((i)=>{
return task_temp_results.getRecord(i);
});
for(let t of task_temps) {
payloads.push({
fields: {
[task_project_link_field_name]: [{id: r.id}],
[task_primary_field_name]: t.getCellValueAsString(task_temp_primary_field_name),
[task_to_template_link_field_name]: t.id
}
});
}
}
// create all of the new tasks
// we should hold on to the created IDs
output.markdown(`Creating **${payloads.length}** tasks across these projects`);
var new_tasks = [];
while(payloads.length > 0){
let n = await task_table.createRecordsAsync(payloads.slice(0,50));
new_tasks = [...new_tasks, ...n];
payloads = payloads.slice(50);
}
output.markdown('### Creating dependencies between new tasks');
output.markdown('Pulling newly created tasks')
// refetch these tasks so that we can update the dependencies
const task_results = await task_table.selectRecordsAsync({
fields: [
task_primary_field_name,
task_project_link_field_name,
task_to_template_link_field_name,
task_dependency_field_name
]
});
// pull out only the newly created tasks
const tasks_to_update = new_tasks.map((t)=>{
return task_results.getRecord(t);
});
output.markdown('Creating map of new tasks to templated task ids to resolve dependencies')
// create a map of new task to templated task ids
// and templated tasks to new task ids
// group them by project since any given project may be using the same set of templated tasks
var new_task_to_template_map = {};
for(var r of tasks_to_update){
let p = r.getCellValue(task_project_link_field_name)[0].id;
let temp_t = r.getCellValue(task_to_template_link_field_name);
if(new_task_to_template_map[p] === undefined){
new_task_to_template_map[p] = {
task_to_template: {},
template_to_task: {}
};
}
new_task_to_template_map[p].task_to_template[r.id] = temp_t;
new_task_to_template_map[p].template_to_task[temp_t] = r.id;
}
output.inspect(new_task_to_template_map);
// now go back through the tasks one more time and actually build out the payloads to establish links
// not all tasks will have a dependent task
// we can filter these out afterwards
payloads = tasks_to_update.map((r)=>{
let p = r.getCellValue(task_project_link_field_name)[0].id;
let temp_task = r.getCellValue(task_to_template_link_field_name);
let temp_task_dependency = task_temp_dependency_map[temp_task];
let dependent_task_id = new_task_to_template_map[p].template_to_task[temp_task_dependency];
if(dependent_task_id === undefined) {
return undefined;
}
return {
id: r.id,
fields: {
[task_dependency_field_name]: [{id: dependent_task_id}]
}
}
}).filter((r)=>{
return r !== undefined;
});
output.inspect(payloads);
output.markdown(`Updating **${payloads.length}** tasks with required dependencies`);
while(payloads.length > 0) {
await task_table.updateRecordsAsync(payloads.slice(0,50));
payloads = payloads.slice(50);
}
output.markdown(`### Done`);
Aug 30, 2020 04:46 PM
This is the section of code where you define what the “live” tasks should look like after they are duplicated from your templates. This example only fills in the basic values that we need:
for(let t of task_temps) {
payloads.push({
fields: {
[task_project_link_field_name]: [{id: r.id}],
[task_primary_field_name]: t.getCellValueAsString(task_temp_primary_field_name),
[task_to_template_link_field_name]: t.id
}
});
}
You can add additional fields after this as well, such as a start date and end date, or a single select field for tagging the task. Assuming that this data lives in your task templates table, the changes to the script would look something like:
payloads.push({
fields: {
[task_project_link_field_name]: [{id: r.id}],
[task_primary_field_name]: t.getCellValueAsString(task_temp_primary_field_name),
[task_to_template_link_field_name]: t.id,
"My Single Select Field": {name: t.getCellValueAsString("my template single select field"},
"Link to Task Template Field": [{id: t.id}]
}
});
The bulk of the script logic deals with creating the shell project and tasks and then linking all of those records together. For modifying what data is contained in the outputted tasks, this should be the only section you need to modify.
Aug 31, 2020 11:09 AM
Sorry Gio. Still a bit confused. Is there a way to set the Deliverable type to a single select option?
Sep 01, 2020 06:40 AM
Extremely helpful … and I’m grateful for your suggestions. Works like a charm. And, I even got it to run via an automation. So cool.
Sep 01, 2020 02:32 PM
Ok I am getting so much closer I just got this error when running the code.
S: Can’t create records: invalid cell value for field ‘Deliverable Type’.
Cell value has invalid format: must be an object
Single select field value must be an object with at least one of ‘id’ or ‘name’ as a property.
at main on line 109
Sep 01, 2020 03:59 PM
For single select values, you have to structure the data as an object where the object either contains the option ID or the name you see in the product. In practice, I generally use the single select name (since a single select does not allow duplicate values).
For example, if I have a single select for “Status” and the options in that single select are Started, Completed, Abandoned, and I want to set the Status of a record to Completed, I would do:
var payload = {
id: "recXXXXXX",
fields: {
"Status": {name: "Completed"}
}
}
So in this script it would be something like:
payloads.push({
fields: {
[task_project_link_field_name]: [{id: r.id}],
[task_primary_field_name]: t.getCellValueAsString(task_temp_primary_field_name),
[task_to_template_link_field_name]: t.id,
"My Single Select Field": {name: t.getCellValueAsString("my template single select field"}
}
});
I think in a previous response I had the single select in an array, which was wrong. That is for multi-selects. For single selects, you just pass the {name:value} object.
So I would change your line 109 to match the {name: value} format.
Sep 01, 2020 04:40 PM
Oh man I am so close. So if 109 is payloads = payloads.slice(50);
how do I change that to equal name:value
Mar 02, 2021 03:26 PM
This script is already so helpful, however, I cannot get single select fields to copy from the template.
Where does the following code go?
I’ve tried this every which way. Also, in the example codes, there is a parenthesis missing, I think: ““My Single Select Field”: {name: t.getCellValueAsString(“my template single select field”)}”
Jan 22, 2022 04:00 PM
This is great @Giovanni_Briggs ,
I am working on a method for this with button pushes and using the input fields too. Especially when we have many complicated projects going at different stages, or are closed off and we want tasks not to be created.
I would like to bring your attention to the issue that SelectRecordsAsync is now deprecated. Anyone using this could fix it however that assumes they know how to code you and you saved them the time, rather than someone just using this script without any prior knowledge.
Jan 24, 2022 12:00 AM
You will need to create some constants. This makes your code easier to setup for using in other bases etc.
const task_status_field_name = 'Status';
const task_temp_status_field_name = 'Status';
You will then create the line to push:
[task_status_field_name]: {name: t.getCellValueAsString(task_temp_status_field_name)}
You might find your Status field has a different name. That will need to be resolved. You have lots of quotes in your code. That will have to be removed.
Also if you have any tasks in your template which have no single select field selected it will cause an error.
Jan 24, 2022 12:04 AM
@Giovanni_Briggs would you have any suggestions for doing multiple dependency linking for the generated tasks?
It looks like if the template task has multiple dependencies then the resulting created task will only link to the first dependency on that list.