Custom Code
Prerequisites
You should have a basic understanding of JS (Javascript), including variables, functions, loops, and conditionals.
Adding Custom Code
Currently, the “Custom Code” node in Momen Actionflow only supports JS.
.png)
Configure Custom Code
After adding a code block, you can rename it and write JS code in the code editor on the right. Click the expand button in the upper right corner for a larger editing area.
.jpeg)
Configuring and Getting Inputs
If your code block needs to process user input (the top-level “Input” of the Actionflow) or data from previous nodes, you must first define the required input in the code block.
For example, to process phone number masking:
First, declare an input parameter named phone_number at the input node, which can be bound by all other nodes within the actionflow. This allows you to pass parameters into the Actionflow from the page.
.jpeg)
Next, configure the input in the Custom Code node. This tells the code block which value to use.
Note: The input name must match the parameter name used in the code.
.jpeg)
To access the input parameter in code, use the Momen built-in context.getArg("input parameter name") function.
const thing1 = context.getArg('thing1')
const thing4 = context.getArg('thing4')
const date2 = context.getArg('date2')
const accountId = context.getArg('accountId')
const data = { thing1: thing1, date2: date2, thing4: thing4 }
const gql = `mutation publishWechatMessage($data: Map_String_StringScalar,$accountId:Long!){
publishWechatMessage(
accountId: $accountId
data: $data
miniprogramState: FORMAL
page: "pages/lil7gbne/lil7gbne"
lang: CN
templateId: "RQH7FafxS4_jQsRSN6ujLLKUoWuXpC3uLvYP1WL75Ys"
)
}`
context.runGql(
'publishWechatMessage',
gql,
{ data, accountId },
{ role: 'admin' }
)Configuring and Returning Output
If you want to pass the result of the code block to downstream nodes, configure the output parameter in the code block and use the appropriate context.setReturn statement in your code, such as context.setReturn('outputName', outputValue) function.
const phone_number = context.getArg('phone_number')
const result = `${phone_number.substring(0, 3)}****${phone_number.substring(7, 11)}`
context.setReturn('result_phone', result)Configure the output in the Custom Code node to specify the output name and type.
Note: The output name must match the name used in context.setReturn() in your code. Otherwise, the code block will fail to execute at runtime.
.png)
Configure the output in the Actionflow to make the result available to the frontend. After this step, when the frontend page calls this Actionflow, all outputs will be available within subsequent actions’ “result data” sections.
.jpeg)
If you encounter any issues, join our Forum for assistance.
Running GraphQL in a Custom Code
Prerequisite: Understand the GraphQL basics below.
Basic Code Structure
# GraphQL content
const gql = `query findPaymentTransactionById ($paymentTransactionId: bigint!){
response: payment_transaction_by_pk(id:$paymentTransactionId) {
id
status
currency
amount
description
order_id
account_id
payment_method
}
}`;
# Run GraphQL query
context.runGql('findPaymentTransactionById', gql, { paymentTransactionId: 1 }, { role: 'admin' });runGql Parameter Description
context.runGql( operationName , gql , variables , permission );
- operationName: is the name of the gql.
- operationName: the name of the gql, it needs to be the same as the name inside the gql, e.g. the name after the query in the above gql is the name of the gql.
- gql: the content of the gql, e.g. the request in the symbol is the result of the keystroke above the tab key in English input mode
- variables: If gql uses a parameter declaration, the parameter cannot be null.
- permission: The permission for calling gql can only be set to ‘admin’.
GraphQL Basics
GraphQL is a data query language developed by Facebook.
Momen’s APIs based on the GraphQL specification.
By embedding GraphQL in Actionflow, you can perform arbitrarily complex data manipulation, such as batch operations.
Altair Interface
Altair GraphQL Client is a tool for debugging gql. Download and open Altair as shown below:
.png)
Altair Debugging gql Configuration Content
- Set Headers and Method
- Add GraphQL server URL
- Click “Docs” to view documentation for the entire GraphQL server’s schema.
- Configure variables
Configuring the Request URL and Headers
Let’s move on to an example demonstrating how to debug Momen’s API with Altair.
- In Momen, create a new project and a data table called
reference, add thecontentfield, and update the backend. - Press F12 to open your browser’s console, then click on “Network” and clear it. Next, in the Zion editor, open the “Database” tab and navigate to the
reference table. You’ll then see the request for the refer table data in the console.
- Copy the Request URL in Headers and paste it into Altair, and set the request method to POST.
- Copy the Authorization string from Request Headers and paste it into Altair’s request header.
How to View Documentation
Click “Docs” on the right in Altair, type “reference” to see available requests. Select one to view parameters, types, and fields. Click any field for more details.
Parameters for Data Requests
When requesting data, you can configure the following parameters:
- where: Specifies conditions for filtering data.
- order_by: Defines sorting criteria.
- distinct_on: Sets deduplication conditions.
- offset: Indicates the starting index for data retrieval.
- limit: Specifies the number of records to retrieve.
Selecting Parameters
- Click a parameter to view its configuration options.
- Click on content to see available operators.
Basic Comparison Operators
_eq: Equal to_gte: Greater than or equal to_lte: Less than or equal to_and: Logical AND_or: Logical OR_not: Logical NOT_gt: Greater than_lt: Less than_in: In a list_nin: Not in a list_like: Matches a pattern_nlike: Does not match a pattern_ilike: Case-insensitive match_inc: Increment_dec: Decrement
Null in databases is typically used to represent a missing or unknown value. It’s important to note that it doesn’t signify an empty string or zero.
In GraphQL queries, null can be used to filter data. Here are some common usages:
-
_is_null: false: Returns data where the field is not null. -
_is_null: true: Returns data where the field is null. -
_not: { _is_null: false }: Returns data where the field is null. -
_eq: nullor_neq: null: These conditions are specially handled by Momen and is equivalent totrue.
Sorting Options
-
asc: Ascending order.
-
asc_nulls_first: NULL values appear before non-NULL values.
-
asc_nulls_last: NULL values appear after non-NULL values.
-
-
desc: Descending order.
-
desc_nulls_first: NULL values appear before non-NULL values.
-
desc_nulls_last: NULL values appear after non-NULL values.
-
Type and Fields
- TYPE: Type of return value
- FIELDS: Specific fields within the return value
Requests
Query Basic Scenarios
- According to the filter conditions, get the data in the one-to-one association table: get the personal information of the current user.
query getAccount($accountID: bigint) {
account(where: { id: { _eq: $accountID } }) {
id
profile {
id
name: ud_xingming_e1693e
gender: ud_xingbie_7644ed
phone_number: ud_shoujihaoma_e3188e
}
}
}- Based on the filter conditions, get the data in the one-to-many association table: get the registration record of this event in the event table, get the media - image data.
# Request sign-up records for a specific activity
query getsign_record($activityID: bigint) {
activity(where: {}, order_by: [{}], distinct_on: [id], offset: 1, limit: 1) {
id
name
image {
url
}
sign_record(where: { activity_id_activity: { _eq: $activityID } }) {
id
activity_id_activity
ud_account_id_zhanghu_999f9c
}
}
}- Request aggregated data: Search the query request for “table_aggregate” in Documentation to request aggregated data for this table.
# Request aggregate information from the reference table
query getReferenceAggregate {
reference_aggregate {
aggregate {
count(columns: [id, content], distinct: true)
max {
id
}
}
}
}- Requests the count of a related table to sort and displays the count of the related table, for example, to display the content of an event in descending order based on the number of registrations for the event.
# Request activity information ordered by sign-up count in descending order
query activity_order_by_sign_count {
activity(order_by: [{ sign_record_aggregate: { count: desc } }]) {
id
name
image {
url
}
sign_record_aggregate {
aggregate {
count
}
}
}
}Query - Query Request Search for a table name in Documentation, find a query request for that table, and click on it to go to the request Documentation.
Adding a Request
When the mouse hovers over the top table name, on the right side you can click ADD QUERY, which will automatically populate the request code to the left side (so you don’t actually have to write the gql yourself), and in the left editing area you can delete/increase the conditions, fields, and associated table content, keeping the condition you want.
Basic Structure of the Request
# Query
query commandName($argumentName1: type) {
tableName(
where: {
field1: { comparisonMethod: comparisonValue }
field2: { comparisonMethod: comparisonValue }
}
order_by: [{ field: sortingMethod }]
distinct_on: [distinctField]
limit: 1
) {
alias: desiredReturnField
}
}when: Used to configure request conditions and is an object.
order_by: Used to configure sorting conditions and is an array. The array contains individual objects specifying sorting criteria.
distinct_on: Used to set deduplication conditions and is an array. The array contains fields for deduplication.
limit: Used to set the number of data records to be requested and is an integer.
To tailor the returned data fields based on your needs and set request parameters:
- After the query’s “command name,” add a pair of parentheses. Inside the parentheses, provide the request parameter name and type, like this: $argumentname1: parameter type
In the editing interface, click on 【VARVARLABES】 to expand the parameter editing window. Start by entering a pair of curly braces . Inside the curly braces, specify the content of the parameters. The parameter names within this content should still begin with a dollar sign $. Since this parameter is an object, if you configured multiple parameters in the command name, you can set multiple parameter contents here.
To execute the request:
Click on the “send query” button located above the request. The execution of the request will then take place, and you can view the results on the right side of the interface.
Mutation - Insert Request
Search for insert_tableName in Documentation, find the mutation request for that table, and click on it to go to the request Documentation.
Adding a request
When hovering over the top table name, you can click ADD QUERY on the right side, which will automatically copy the request code on the left side.
Basic structure of the request
mutation commandName {
insert_tableName(
objects: [
{ data1_field1: value1, data1_field2: value2 }
{ data2_field1: value1, data2_field2: value2 }
]
on_conflict: {
constraint: constraintName
update_columns: [updateField1, updateField2]
}
) {
# You can ignore this section; it's for more advanced users. Beginners don't need to worry about it.
whatever: anything
}
}objects: Used to specify the data to be inserted, in the form of an array. Each item in the array represents a set of data and is structured as an object.
on_conflict: Used to determine the actions to be taken when there is a conflict in data insertion. It is an object type, and if there are no constraints, it may not need to be configured.
constraint: Specifies the name of the constraint causing the conflict.
update_columns: Specifies the fields that should be updated in the event of a conflict.
Mutation - Update Request
To search for or add an update request:
In the documentation, search for update_tableName.
Locate the mutation request associated with the table you’re interested in.
Click on the specific update request to navigate to the request documentation.
Follow the same approach as described above for adding requests.
Basic structure of the request
mutation commandName {
update_tableName(
_set: { field1: value1, field2: value2 }
where: {
field1: { comparisonMethod: comparisonValue }
field2: { comparisonMethod: comparisonValue }
}
) {
# You can ignore this section; it's for more advanced users. Beginners don't need to worry about it.
whatever: anything
}
}_set: Used to define the fields and their corresponding values that need to be updated. It is of object type.
where: Used to configure the conditions for the update. It is also of object type.
Mutation - Delete Request
To search for or add a delete request:
In the documentation, search for delete_tableName.
Locate the mutation request associated with the table you’re interested in.
Click on the specific delete request to navigate to the request documentation.
Follow the same approach as described earlier for adding requests.
Basic Structure of the Request:
mutation commandName {
delete_tableName(
where: {
field1: { comparisonMethod: comparisonValue }
field2: { comparisonMethod: comparisonValue }
}
) {
# You can ignore this section; it's for more advanced users. Beginners don't need to worry about it.
whatever: anything
}
}where: Used to configure the conditions for deleting data. It is of object type.
Invoking external API in Custom Code
Prerequisite: The API must be added and debugged in Momen.
callThirdPartyApi(‘$operationId’, $args): Call the API.
$operationId: API id$args: API parameters, e.g.{fz_body:{"appKey": "f46dce7fa0566f0c"}}
context.callThirdPartyApi('$operationId', {
body: { appKey: 'f46dce7fa0566f0c', sign: 'OTljNjYyNXXX==' },
})How to Find the API id:
In Altair Documentation, search for “operation” to find the relevant request. If you have multiple APIs, click each to view configuration parameters and identify the correct one.
