Create and manage NIM variables
Configuration guide
Store reusable values once, then use them consistently across automation, reporting, and notification workflows.
Where variables are usedDirect link to Where variables are used
Variables are available in auditing queries, notification templates, filter parameters, and custom JavaScript columns. System variables are built in and cannot be edited; user-defined variables are configurable. Session variables supply values for the current app user.
This guide covers creating reusable variables, loading session variables, and reading variables in JavaScript.
Create a variableDirect link to Create a variable
Add the variableDirect link to Add the variable
Go to Configuration > Variables, select Add, then enter a descriptive name and category—for example, DateTimeMonthStart in date-time.
Choose a typeDirect link to Choose a type
Select Constant for a fixed string, or JavaScript for code that returns a calculated value. The return type must match how the variable is used; a shared helper variable can return a class for use by custom JavaScript columns. For JavaScript variables, use Test before saving.
const now = new Date();
now.setDate(0);
now.setHours(0, 0, 0, 0);
return now.toISOString();
Make it understandableDirect link to Make it understandable
Add a description that explains the value’s purpose, then save. Use a clear category and description so other administrators can safely reuse it.
Edit or remove a variableDirect link to Edit or remove a variable
Edit user-defined values directly in the grid; JavaScript variables can be updated in the JavaScript Code pane. Select Remove Variable only after checking every query, template, filter, or script that might reference it.
Use Copy Object to reuse a variable; NIM adds a numbered suffix such as _01. To rename one, select Rename Object, enter the new name, and press Enter.
Configure session variablesDirect link to Configure session variables
Session variables load user-specific data for the active app session. Configure a filter to find the signed-in user's record, then map a result column to a named session value.
Find the user dataDirect link to Find the user data
Create a filter such as Session_AD_User_View with the directory users table as its start table. Add a parameter that uses sessionUserName, then match that parameter to the user-name column, such as sAMAccountName.
Add the session variableDirect link to Add the session variable
In Configuration > Variables > Session, add an entry. For example, use sessionADmail as the name, select Session_AD_User_View as the filter, select mail as the filter column, choose string as the data type, and add a description.
Confirm the value is availableDirect link to Confirm the value is available
Sign in with a test user and confirm the session variable resolves to the expected value before using it in an app condition, action, or display.
Read variables in custom JavaScriptDirect link to Read variables in custom JavaScript
In a custom JavaScript system or filter column, call variableGetValue(variable_name) and return the result. This lets you maintain a value centrally instead of hardcoding it in each column.
return variableGetValue('test_variable');
Test the column after changing a variable, especially when its value affects filters or provisioning logic.
Related guidesDirect link to Related guides
- Filter parameters can use a configured variable.
- Custom JavaScript filter columns can read variable values.