This custom function can be used to add two values and save the return value in a custom field.
The sum will be dynamically updated in the custom field after this function is executed.
Business Scenario
Helen is the head of Procurement Management at her organization. Once the individual purchase cost of all the materials is approved by Helen, the total cost can be calculated and saved by executing this function.
Steps to configure the custom function
Before executing this custom function, you will have to configure the arguments, add custom field values (if required), and authorizate connections. Follow the below steps to configure the function.
1. Configure the Arguments
First, configure Argument Values for all the parameters used in the custom function. You can either specify the Custom Value or choose a Layout Field from the dropdown. Layout fields capture dynamic values from job fields corresponding to the custom function.
orgName : Specify your organization’s name. This will be available in Orchestly’s URL (orchestly.zoho.com/blueprint/<orgName>/<module>).
param1 : Either enter a value here or map a custom field.
param2 : Either enter a value here or map a custom field.
jobID : Choose the Job ID Layout Field here. You can also specify the ID of the job. This will be available in the Job URL ( orchestly.zoho.com/blueprint/<org-name>/<job>/<jobID>).
2. Add custom field values
To provide values for custom fields in the job, add the below syntax to the function. This is optional and can be included only if there is a need to provide values to the custom fields.
Syntax:
paramMap.put("column_name of the custom field","value of the custom field");
The 'column_name of custom field' can be obtained using APIs:
2. Navigate to the Reference tab and select Layouts on the left panel.
3. Execute the Get layout details function by clicking Try Now.
4. Choose your organization and configure the URL by entering the Layout ID. This will be available in the Layout URL ( orchestly.zoho.com/blueprint/<org-name>/<layout>/<layoutID>).
5. Click Execute.
6. Press Ctrl+F on your keyboard and search for your custom field name. You can find it listed as an alias_name.
7. Find the column_name linked to this custom field. It will be listed just above the alias_name.
The column_name can be used in the syntax specified above to add custom field values.
3. Provide authorization using Connections
Connections helps you authenticate the API call for specific scopes of Orchestly and other internal Zoho applications used in the custom function.
1. Invoke Connections to authorize your Orchestly account.
Click +Connections button in Custom Functions . A new tab will open in your browser.
Click Add Connection in the top-right corner.
Choose Zoho Oauth on the Pick Your Service tab.
Enter a Connection Name and choose the 'Orchestly.job.ALL' scope to connect.
2. After successful authentication, include the connection details in the invokeurl block of the custom function.
e.g: connection: <Connection-name>
Once the above steps are configured, you are all set to execute the custom function.
Computing_Field_Values is a part of Orchestly's pre-define custom functions available in Function Gallery. However, you can also write your own custom functions in Orchestly.