​

Intro

• Required grants
• Access Code Engine
• Home page
  • Code Engine Repository List
• Create a custom package
  • Create a new package version
  • Code Editor
    • Package information/action bar
    • Permissions
    • Side navigation
    • Function Configuration
    • Package Information
  • Test a function
• Code Engine Library
  • codeengine.sendRequest
  • codeengine.getAccount
  • codeengine.axios

​

Required Grants

• Manage Code Engine Packages — Allows you to perform any action on any Code Engine package in the instance. This grant should be given to admins or anyone who helps manage Code Engine.
• Create Code Engine Packages — Allows you to create a new Code Engine package. This grant should be given to anyone who needs to create and add new function packages to the Code Engine repository in your instance.
  Note: Contact your Domo account team to enable either of these grants for your instance. For information about the available permissions for non-instance admin users, see the Permissions section of this article.

​

Access Code Engine

In the left navigation, select Code Engine.

​

Home Page

​

Code Engine Repository List

• Package Name/Description — Displays the title of the package and a brief description.
• Owned By — Displays the package creator/owner’s name and avatar.
• Runtime — Displays the runtime (or programmatic language) the package is using.
• Last Saved — Provides the date when the package was last updated.
• Created — Provides the date when the package was created.

​

Create a Custom Package

1. Select + New Package. If the option is disabled, make sure you have the required grants. If you do have the grants and still can’t create a new package, reach out to your Domo account team or contact Domo Support .
   
   The Create New Package modal displays.
   
2. (Required) Fill in the Package Name and Package Description fields.
3. (Required) Choose an option from the Select a Language dropdown. The options are JavaScript and Python.
   
4. (Optional) You can upload a thumbnail for increased package visibility.
   
5. Select Create New Package to display the package in the code editor or Cancel to return to the home page.

​

Create a New Package Version

1. Open the package in the code editor.
2. Select Expand > Create New Version to display the new version modal.
   
   
3. In the Version to Copy From dropdown, select a target version of the package to copy all of its contents into the new version. This includes syntax, variables, and any metadata.

4. In the Version field, enter the version number you want, according to Semantic Versioning (see the official spec ). The field contains a default value, but you can change it.
   
5. (Optional) Enter any details in the Version Description field.
6. Select Create New Version to save your changes and create a new version of the package. The new version becomes the package’s default version, but if you want to access an earlier version, you can open the package in the code editor and choose another version from the version list.

​

Code Editor

​

Package Information/Action Bar

• Back arrow — Redirects to the Code Engine home page.
• Package thumbnail — The image associated with the package.
• Package Title/Description — The title and description given to the package when it was created.
• Last Saved — The date the package version was last saved.
• Runtime/Language — The programming language used to write the script.
• Owner thumbnail — The avatar for the package owner.
• Share button — Opens the permissions modal.
• Dark Mode toggle — Enables/disables dark mode for the code editor.
• Version list — Allows you to select which version of the package you want to view/edit.
• Save — Allows you to save your changes to the package if code syntax and variables are valid.
• Save options — Provides the following options for the package:
  • Create New Version — Displays the Create New Version modal. See Create New Version for more information.
  • Delete Current Package — Permanently deletes the package.
  • Delete Current Version — Permanently deletes the version.
  • Save and Deploy — If code syntax and variables are valid, your changes are saved and the new version of the package deploys. This disables editing for the deployed version and makes it available for use by other Domo features, such as Workflows.
    

​

Permissions

• Admin — Allows a user to perform any action on the package. This permission is different from the Manage Code Engine Packages grant, which gives access to all packages in the instance.
• Delete — Allows a user to delete a package or a version of a package.
• Read — Allows a user view-only access to package metatdata and its versions.
• Write — Allows a user to edit a package.
• Share — Allows a user to grant another user equal or lesser access to a package.
• Execute — Allows a user to run a function in a package.
• Read Content — Allows a user view-only access to the code content of a package and its versions.
• Update Content — Allows a user to edit the code content and metadata of a package and its versions.

1. In the package information/action bar, select Share to display the permissions modal.
   
   The permissions modal contains a search bar, a list of People With Access to the package, and a list of People Without Access to the package. By default, the owner of the package always has Admin permission to the package.
2. In the search bar, enter the name of a person or group for which you want to edit permissions. If the user or group is found in the instance, the name displays at the top of the list of People Without Access. The permissions menu displays next to the user or group name; the default permission is No Access.
3. Select the permission you want to grant the user or group.
4. Select Save to save your changes.

​

Side Navigation

• Function Configuration
• Package Information

​

Function Configuration

Input Variables and Return Type

• Account (This data type has slightly different handling. See Account Data Type below.
• Boolean
• DataSet
• Date
• Datetime
• Decimal
• Duration
• Group
• Number
• Object
• Person
• Text
• Time

Advanced Editing for Parameters

Account Data Type

List Type

Object Type

• Open — You can store any type of data in an Open Object, but what is stored in the object is not explicitly defined. This is useful for operating on APIs that return complex data.
• Defined Object — For a Defined Object, you define child properties of the object by selecting Add Child Property in the modal.
  
  When you add a child property, a row opens for each child property on the Object. Here, you can define the parameter name and data type for each child property of the Object. For example, you may have an Address Object that has child properties for the street, city, state (all TEXT type), and postal code (NUMBER type).
  

​

Package Information

• Name — The function name.
• Created — The date the package version was created.
• Last Deployed — The date the package version was deployed.
• Language — The programming language the script is written in.
• Owner — The name and avatar of the package owner.
• Description — A brief description of the package.

​

Test a Function

​

Prerequisites

In the code editor, select Start Function to open the start modal.

Note: If you want to change any default values permanently, you need to select > Advanced Edit for that variable in the Function Configuration section of the side navigation.

​

Code Engine Library

​

codeengine.sendRequest

const codeengine = require("codeengine");

/**
 * Retrieves the metadata for the specified dataset.
 *
 * @param dataSetId string The dataset id
 * @returns {} The dataset metadata
 */
function getDataSetMetadata(dataSetId) {
 const url = `api/data/v3/datasources/${dataSetId}?part=core,permission,status,pdp,rowcolcount,certification,functions`;

 return codeengine.sendRequest("get", url).catch(console.error);
}

​

codeengine.getAccount

const codeengine = require("codeengine");  
  
function accountExample(twilioAccount) {  
const account = await codeengine.getAccount(twilioAccount.id);  
const {accountSID, password} = account.properties;  
}

const codeengine = require("codeengine");  
  
async function sendSMS(twilioAccount, to, from, body) {  
// get the account by account id  
const account = await codeengine.getAccount(twilioAccount.id);  
// access the properties of the account. These will vary from account type so it's   
// important to check what is returned. In this case it's `accountSID` and `password`  
const {accountSID, password} = account.properties;  
  
const url = `https://api.twilio.com/2010-04-  
01/Accounts/${accountSID}/Messages.json?To+${to}&From=${from}&Body=${encodeURIC  
omponent(body)}`;  
  
const apiBody = {  
To: to,  
From: from,  
Body: body,  
};  
  
const requestOptions = {  
headers: {  
'Content-Type': 'application/x-www-form-urlencoded;charset=utf-8',  
Authorization:  
'Basic' + Buffer.from(`${accountSID}:${password}`).toString('base64'),  
},  
};  
  
try {  
await axios.post(url, apiBody, requestOptions)';  
  
return true;  
} catch (error) {  
console.error(error);  
throw error;  
}  
}

​

codeengine.axios

const codeengine = require(“codeengine”);

async function sendTwilioSms(to, from, body) {
  const account = await codeengine.getAccount(“Twilio”).then(a => {
    return a.properties;
  });

  const url = `https://api.twilio.com/2010-04-01/Accounts/${account.properties.SID}/Messages.json`;

  const data = new URLSearchParams();
  data.append(‘To’, to);
  data.append(‘From’, from);
  data.append(‘Body’, body);

  const requestOptions = {
    method: ‘POST’,
    headers: {
      ‘Content-Type’: ‘application/x-www-form-urlencoded;charset=utf-8’,
      ‘Authorization’: ‘Basic ‘ + Buffer.from(`${SID}:${TOKEN}`).toString(‘base64’)
    },
    data
  };

  try {
    const response = await codeengine.axios(url, requestOptions);
    const jsonResponse = await response.data;

    if (response.ok) {
      console.log('SMS sent successfully:', jsonResponse);
      return jsonResponse;
    } else {
      console.error('Error sending SMS:', jsonResponse);
      throw new Error(jsonResponse.message);
    }
  } catch (error) {
    console.error('Error:', error);
    throw error;
  }

  return jsonResponse;
}