Ivanti Neurons for ITSM

https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/
Admin
Ivanti Neurons for ITSM is an IT Service Management application that enables administrators to...
Tokens:558,522
Snippets:7,837
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### BeginningOfQuarter Function Example

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Reference/Functions/BeginningOfQuarter.htm

This example demonstrates how to use the BeginningOfQuarter function to get the beginning of the previous quarter. Note the potential one-hour discrepancy due to daylight saving time issues mentioned in the documentation.

```itsm
$(BeginningOfQuarter(-1))
```

--------------------------------

### TrimStart Function Example

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Reference/Functions/TrimStart.htm

Demonstrates trimming characters from the start of a string, regardless of their order in the trim text. The function removes any occurrence of 'c', 'b', or 'a' from the beginning of the input string.

```text
$(TrimStart('abcergzxy','cba'))
Returns this value: ergzxy
```

--------------------------------

### Connect Web Method Example

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/Develop/Connect.htm

This example demonstrates how to call the Connect web method and check the connection status. Ensure you have valid credentials and tenant information.

```csharp
FRSHEATIntegration frSvc = new FRSHEATIntegration();
FRSHEATIntegrationConnectionResponse connectresponse = frSvc.Connect(username, password, tenantId, role);
if (connectresponse.connectionStatus == "Success")
{
...
}
```

--------------------------------

### Get Business Object by Filter

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/API/Get-Business-Object-by-Filter.htm

Fetches business object records based on the defined filter values. For example, you can define to get only active incidents.

```APIDOC
## GET /api/odata/businessobject/{business object name}?$filter={filter field} eq {field value}

### Description
Fetches business object records based on the defined filter values. For example, you can define to get only active incidents.

### Method
GET

### Endpoint
https://{tenant url}/api/odata/businessobject/{business object name}?$filter={filter field} eq {field value}

### Parameters
#### Query Parameters
- **$filter** (string) - Required - Specifies the filter condition. Format: `{filter field} eq {field value}`.

### Notes
Ensure the business object name is suffixed with an "s".
```

--------------------------------

### Basic Expression Syntax Examples

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Reference/Expressions/Using_Expressions_in_Quick_Actions.htm

These examples demonstrate the basic syntax for using expressions in Quick Actions, including field references, cross-object references, and simple arithmetic.

```text
$(FieldName)
```

```text
$([Problem#]Category)
```

```text
$(2+2)
```

--------------------------------

### Substring Function Example

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Reference/Functions/Substring.htm

Extracts a substring from the 'Symptom' field. The extraction starts at the 21st character and continues for 7 characters. Ensure the start position is 1-based.

```Expression Language
$(Substring(Symptom, 21, 7))
```

--------------------------------

### Accept Task Quick Action

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/API/Quick-Actions-API.htm

Example of how to accept a task using a quick action. This includes the URL, method, headers, and a request payload specifying the action and task details, including record IDs.

```APIDOC
## Accept Task Quick Action

### Description
Executes the 'Accept_Task' quick action for a specific task.

### Method
POST

### Endpoint
https://{tenant url}/api/odata/businessobject/tasks('{Task Rec ID}')/Accept_Task

### Headers
- **Authorization**: JTW Token/Session Key/REST API Key

### Request Body
```json
{
  "ActionId": "e383dc0e-28b4-4e7a-9ac2-66248f991d71",
  "ShouldSave": true,
  "ActionParams": {
    "GridParams": {
      "actionId": "e383dc0e-28b4-4e7a-9ac2-66248f991d71",
      "recordIds": [
        {
          "RecordId": "C6CCA4CEC8094724900EF60993662A44",
          "ObjectType": "Task#Assignment"
        }
      ]
    },
    "FormParams": null
  },
  "PromptParams": null
}
```

### Response
#### Success Response (200)
Indicates the quick action was processed successfully.
```

--------------------------------

### Get Beginning of Week - Neurons for ITSM

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Reference/Functions/BeginningOfWeek.htm

Use this function to get the start of the current week (Sunday) in UTC. If no parameters are provided, it defaults to the current date and time with an interval of 0 weeks.

```Neurons for ITSM
$(BeginningOfWeek(0))
```

--------------------------------

### PromptAndExecuteAction Example

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Reference/Functions/PromptAndExecuteAction.htm

This example demonstrates how to use PromptAndExecuteAction to prompt the user with a question related to an incident and then execute either 'Resolve Incident' or 'New TaskAssignment' quick actions based on the answer. Note the specific syntax for the objectRef parameter.

```ivanti_script
$(PromptAndExecuteAction( '$(Parent(Incident#.Rev3))', 'Task belongs to an incident with no other unfinished tasks. Select [Yes] to set incident to resolved, select [No] to create a new task, or select [Cancel] to cancel the task and save the operation.', 'Resolve Incident', 'New TaskAssignment'))
```

--------------------------------

### Increment and Get Counter Value

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Reference/Functions/GetNextCounter.htm

Use this function to increment a counter and retrieve its updated value. For example, to get the next account number, pass 'AccountNumberCounter' as the counter name. The function returns the incremented value.

```Script
$(GetNextCounter("AccountNumberCounter"))
```

--------------------------------

### Submit Service Request Example

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/Develop/SubmitRequest.htm

This example demonstrates how to retrieve a subscription ID and then submit a service request with specified parameters. It includes handling the response and logging any errors.

```csharp
string strSubscrRecId = frSvc.GetSubscriptionId(authSessionKey, tenantId, "Domain Password Reset").subscriptionId;
List<FRSHEATServiceReqParam> srparamListItems = newList<FRSHEATServiceReqParam>();
srparamListItems.Add(newFRSHEATServiceReqParam
{
strName = "RequesterDepartment",
strValue = "IT"
});
srparamListItems.Add(newFRSHEATServiceReqParam
{
strName = "Requester",
strValue = "Ashley Simon"
});
FRSHEATSubmitRequestResponse srResponse = frSvc.SubmitRequest(authSessionKey, tenantId, strSubscrRecId, srparamListItems.ToArray(), loginId);
FRSHEATServiceReqRequest srres;
if (srResponse.status == "Success")
{
srres = srResponse.reqData;
}
else
{
if (srResponse.exceptionReason != null)
{
Console.WriteLine("Error: " + srResponse.exceptionReason);
}
}
```

--------------------------------

### Retrieve Incidents with Filter

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/API/Get-Business-Object-by-Filter.htm

This example demonstrates how to retrieve incidents where the 'Owner' field is null using a GET request.

```APIDOC
## GET /api/odata/businessobject/incidents?$filter=Owner eq '$NULL'

### Description
Retrieves a list of incidents that match the specified filter criteria. This example specifically filters for incidents where the 'Owner' field is null.

### Method
GET

### Endpoint
https://{tenant url}/api/odata/businessobject/incidents?$filter=Owner eq '$NULL'

### Headers
- **Authorization**: JTW Token/Session Key/REST API Key

### Response
#### Success Response (200)
Returns a JSON object containing a list of incidents that match the filter. The response includes metadata like `@odata.context` and `@odata.count`, followed by an array of incident objects in the `value` field.

### Response Example
```json
{
  "@odata.context": "https://ism-mastertest-tenant2.ivanticlouddev.com/api/odata/$metadata#incidents",
  "@odata.count": 243,
  "value": [
    {
      "ActualCategory_Valid": "4A550AD1778746FCBA65A19A630AC2C9",
      "ActualCategory": "Printer Failure",
      "Category_Valid": "4A550AD1778746FCBA65A19A630AC2C9",
      "Category": "Printer Failure",
      "CauseCode_Valid": "E2489F3F7DA34B898CCD9569CA5541F2",
      "CauseCode": "Other",
      "ClosedBy": "JClerk",
      "ClosedDateTime": "2011-03-31T21:09:37Z",
      "ClosedDuration": 6451200,
      "CreatedBy": "Admin",
      "CreatedDateTime": "2011-03-25T20:42:37Z",
      "Email": "sharon.lowe@saasitdemo.com",
      "FirstCallResolution": true,
      "Impact_Valid": "1AFFC174C7EA4AB79CCA6B15EB67006D",
      "Impact": "Medium",
      "IncidentNumber": 10073,
      "IsNotification": true,
      "IsVIP": false,
      "IsWorkAround": false,
      "LastModBy": "JClerk",
      "LastModDateTime": "2011-03-31T21:09:37Z",
      "Phone": "+1 925.398.1800\r\n",
      "Priority_Valid": "29CD5D78E16F4D82916C3E933A600096",
      "Priority": "3",
      "ProfileFullName": "Sharon Lowe",
      "ProfileLink_Category": "Employee",
      "ProfileLink_RecID": "0B2C886035FB4A0D837273226EAE5DE4",
      "ProfileLink": "0B2C886035FB4A0D837273226EAE5DE4",
      "RecId": "030F0DA291EC46C9953817F0E22F188E",
      "Resolution": "Resolved with user"
    }
    // ... more incident objects
  ]
}
```
```

--------------------------------

### Instantiate and Use CustomService

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/ImportExportData/Web-Service-Methods.htm

This example shows how to create an instance of the CustomService, log in, and then retrieve endpoint data if the login is successful. It logs errors if login fails.

```javascript
var service = new CustomService('https://www.example.com', 'userName', 'password');
service.login();
if (service.isAuthenticated()) {
var endpoints = service.getAllEndPoints('default,excluded');
console.debug(endpoints);
}
else
console.error('Login failed for user userName.');

```

--------------------------------

### Sample Web Service Integration Script

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/ImportExportData/Using-Web-Services.htm

This script demonstrates how to prepare and execute a web service call, including authentication and method invocation. It uses predefined variables for WSDL address, user credentials, and service call details.

```javascript
// --------------------------------------------------------------------
// Demo integration script
// --------------------------------------------------------------------
// prepare service call
console.info("Script starts: Demo integration.Internal service.Address -FRSHEATIntegration - GetRolesForUser");
var wsdlAddress = "Demo integration.Internal service.Address";
var userId = "Demo integration.Internal service.Login";
var pwd = "Demo integration.Internal service.Password";
var serviceCall = "FRSHEATIntegration";
var serviceInstance = GetWebServiceFromUrl(wsdlAddress,serviceCall, "", "");
var tenantId;
var sessionKey;
var authResponse = serviceInstance.InvokeMethod("AuthenticateUser", [userId, pwd, tenantId]);
if (authResponse.authenticationStatus != "Success")
console.info("Script error: Access Denied Demointegration.Internal service.Address - FRSHEATIntegration -GetRolesForUser");
else
{
> // call web service
> sessionKey = authResponse.authenticationSessionKey;
> console.info("Script executes: Demo integration.Internalservice.Address - FRSHEATIntegration - GetRolesForUser");
> var methodCall = "GetRolesForUser";
> var paramValues = [sessionKey, tenantId ];
> // result "hover" on "Script Snippet" or "Script" label for info
> var result = serviceInstance.InvokeMethod(methodCall, paramValues);
> console.info("Script result: " + result.roleList[0].Name + "Demointegration.Internal service.Address - FRSHEATIntegration -GetRolesForUser");
}
```

--------------------------------

### Fetch Metadata for Incidents

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/API/Metadata.htm

This example demonstrates how to retrieve the metadata for the 'incidents' business object using a GET request.

```APIDOC
## GET /api/odata/incidents/$metadata

### Description
Retrieves the OData metadata for the 'incidents' business object.

### Method
GET

### Endpoint
https://{tenant url}/api/odata/incidents/$metadata

### Headers
- Authorization: JTW Token/Session Key/REST API Key

### Response
#### Success Response (200)
Returns an XML document containing the OData metadata. The response payload includes details about entities, properties, navigation properties, and actions.

### Response Example
```xml
<?xml version="1.0" encoding="utf-8"?>
<edmx:Edmx Version="4.0" xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx">
  <edmx:DataServices>
    <Schema Namespace="MetaData" xmlns="http://docs.oasis-open.org/odata/ns/edm">
      <EntityType Name="frs_knowledge">
        <Key>
          <PropertyRef Name="RecId" />
        </Key>
        <Property Name="FRS_KnowledgeType" Type="Edm.String" MaxLength="30" Unicode="false" />
        <Property Name="RecId" Type="Edm.String" Nullable="false" MaxLength="32" Unicode="false" />
        <Property Name="LastModDateTime" Type="Edm.DateTimeOffset" />
        <Property Name="LastModBy" Type="Edm.String" MaxLength="200" />
        <Property Name="CreatedDateTime" Type="Edm.DateTimeOffset" />
        <Property Name="CreatedBy" Type="Edm.String" MaxLength="200" />
        <Property Name="OwnerType" Type="Edm.String" MaxLength="30" Unicode="false" />
        <Property Name="Owner_Valid" Type="Edm.String" MaxLength="32" Unicode="false" />
      </EntityType>
      <EntityType Name="employee">
        <Key>
          <PropertyRef Name="RecId" />
        </Key>
        <EntityType Name="frs_myitem">
          <Key>
            <PropertyRef Name="RecId" />
          </Key>
          <Property Name="RecId" Type="Edm.String" Nullable="false" MaxLength="32" Unicode="false" />
          <Property Name="LastModDateTime" Type="Edm.DateTimeOffset" />
          <Property Name="LastModBy" Type="Edm.String" MaxLength="200" />
          <Property Name="CreatedDateTime" Type="Edm.DateTimeOffset" />
          <Property Name="CreatedBy" Type="Edm.String" MaxLength="200" />
          <Property Name="OwnerType" Type="Edm.String" MaxLength="30" Unicode="false" />
          <Property Name="Owner_Valid" Type="Edm.String" MaxLength="32" Unicode="false" />
          <Property Name="Owner" Type="Edm.String" MaxLength="200" />
          <Property Name="OwnerTeam_Valid" Type="Edm.String" MaxLength="32" Unicode="false" />
        </EntityType>
        <EntityType Name="journal">
          <Key>
            <Function Name="My_Team's_Active_Incidents_All_Tasks_Completed">
              <Parameter Name="ActionId" Type="Edm.String" Nullable="false" Unicode="false">
                <Annotation Term="Org.OData.Core.V1.OptionalParameter">
                  <Record>
                    <PropertyValue Property="DefaultValue" String="c5d882f8-918d-466a-9048-02c3449bc7f0" />
                  </Record>
                </Annotation>
              </Parameter>
              <ReturnType Type="Edm.ComplexType" />
            </Function>
            <NavigationProperty Name="IncidentAssociatedEscalationWatch" Type="Collection(MetaData.frs_data_escalation_watch)">
              <OnDelete Action="Cascade" />
            </NavigationProperty>
            <NavigationProperty Name="IncidentContainsTask" Type="Collection(MetaData.task)">
              <OnDelete Action="Cascade" />
            </NavigationProperty>
            <NavigationProperty Name="IncidentAssociatesCI" Type="Collection(MetaData.ci)">
              <OnDelete Action="Cascade" />
            </NavigationProperty>
            <NavigationProperty Name="IncidentAssociatedSoftwareAction" Type="Collection(MetaData.softwareaction)">
              <OnDelete Action="Cascade" />
            </NavigationProperty>
          </Key>
          <Action Name="New_Document_Article">
            <Parameter Name="ActionId" Type="Edm.String" Nullable="false" Unicode="false">
              <Annotation Term="Org.OData.Core.V1.OptionalParameter">
                <Record>
                  <PropertyValue Property="DefaultValue" String="1e16a70f-cea5-4e56-bb6c-000eecfa5e42" />
                </Record>
              </Annotation>
              <Parameter Name="ActionParams" Type="Edm.ComplexType">
                <Annotation Term="Org.OData.Core.V1.OptionalParameter" />
              </Parameter>
              <Parameter Name="PromptParams" Type="Edm.ComplexType">
                <Annotation Term="Org.OData.Core.V1.OptionalParameter" />
              </Parameter>
            </Action>
            <Action Name="Create_Assignment">
              <Parameter Name="ActionId" Type="Edm.String" Nullable="false" Unicode="false">
                <Annotation Term="Org.OData.Core.V1.OptionalParameter">
                  <Record>
                    <PropertyValue Property="DefaultValue" String="0d260a06-d203-4c72-8929-22a09038cefc" />
                  </Record>
                </Annotation>
                <Parameter Name="ActionParams" Type="Edm.ComplexType">
                  <Annotation Term="Org.OData.Core.V1.OptionalParameter" />
                </Parameter>
              </Parameter>
            </Action>
            <Action Name="Resolve_Incident">
              <Parameter Name="ActionId" Type="Edm.String" Nullable="false" Unicode="false">
                <Annotation Term="Org.OData.Core.V1.OptionalParameter">
                  <Record>
                    <PropertyValue Property="DefaultValue" String="43a31840-2689-405f-88cc-a63a2539be99" />
                  </Record>
                </Annotation>
                <Parameter Name="ActionParams" Type="Edm.ComplexType">
                  <Annotation Term="Org.OData.Core.V1.OptionalParameter" />
                </Parameter>
              </Parameter>
            </Action>
          </Action>
        </EntityType>
      </EntityType>
    </Schema>
  </edmx:DataServices>
</edmx:Edmx>
```
```

--------------------------------

### Get Counter Value Example

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Reference/Functions/GetCounterValue.htm

Retrieves the current value of the 'IncidentNumberCounter'. This function is enabled for various business rule types and services.

```ism
$(GetCounterValue("IncidentNumberCounter"))
```

--------------------------------

### TrimStart Function Usage

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Reference/Functions/TrimStart.htm

Demonstrates how to use the TrimStart function with different scenarios, including removing specific characters, handling repeated characters, and trimming characters regardless of their order.

```APIDOC
## TrimStart(inputText, trimText)

### Description
Trims specified characters from the start of a text string. Each character in the modifier is evaluated, regardless of order, and repeated characters are removed.

### Parameters
#### Path Parameters
- **inputText** (string) - Required - The input string from which to trim characters.
- **trimText** (string) - Required - The characters to be trimmed from the beginning of the `inputText`.

### Return Value
Returns a string that does not contain the `trimText` from the start of the `inputText`.

### Example
```
$(TrimStart('abcergzxy','cba'))
```

### Example Output
```
ergzxy
```
```

--------------------------------

### Using NextDays Function

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Reference/Functions/NextDays.htm

This example demonstrates how to use the NextDays function to get a date a specified number of days in the future. Note that this function is deprecated.

```text
$(NextDays(9))
```

--------------------------------

### Example: Switch Function for Virtual Machine Type

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/ImportExportData/About-Field-Mapping.htm

Shows a switch function structure used to map 'VirtualMachineType' to an 'ExecutionEnvironment'. This pseudo-code example defines cases for '1' (Physical), '2' (VMWare), and '3' (Virtual), with the last entry acting as a default.

```pseudocode
switch (VirtualMachineType)
> case '1': ExecutionEnvironment = Physical
> case '2': ExecutionEnvironment = VMWare
> case '3': ExecutionEnvironment = Virtual
```

--------------------------------

### Get Length of Literal String

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Reference/Functions/Len.htm

Returns the length of a hardcoded text string. This example demonstrates that Len includes trailing spaces in its count.

```Ivanti Script
$(Len("This is an example "))
```

--------------------------------

### DatePart Function Example

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Reference/Functions/DatePart.htm

A general example illustrating the usage of the DatePart function. This snippet serves as a placeholder for further specific examples or usage scenarios.

```ivanti-script
DatePart()
```

--------------------------------

### Get Software GUIDs from List

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/ImportExportData/Web-Service-Methods.htm

Extracts DSMSoftwareGUIDs from a list of software objects. Ensures the input is an array before processing. Returns null if the input is not an array.

```javascript
function GetSoftwareGUID(softwareList)
{
if (Object.prototype.toString.call(softwareList) !== '[object Array]')
return null;
var array = [];
for (var i = 0; i < softwareList.length; i++) 
array.push(softwareList[i].Fields.DSMSoftwareGUID);
return array;
}
```

--------------------------------

### Accept Task Quick Action

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/API/Quick-Actions-API.htm

This snippet demonstrates how to accept a task. It includes the action ID, save preference, and grid parameters specifying the record IDs and object type for the task assignment.

```json
{ "ActionId": "e383dc0e-28b4-4e7a-9ac2-66248f991d71", "ShouldSave": true, "ActionParams": { "GridParams": { "actionId": "e383dc0e-28b4-4e7a-9ac2-66248f991d71", "recordIds": [ { "RecordId": "C6CCA4CEC8094724900EF60993662A44", "ObjectType": "Task#Assignment" } ] }, "FormParams": null }, "PromptParams": null }
```

--------------------------------

### Establishing Connection and Selecting Role

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/Develop/Web Service.htm

Describes how to establish a connection using the Connect web method and how to retrieve a list of available roles using the GetRolesForUser web method.

```APIDOC
## Establishing Connection and Selecting Role

### Description
This section details the process of establishing a connection to the web service using the `Connect` method and retrieving a list of available roles for a user via the `GetRolesForUser` method.

### Methods
- `Connect`
- `GetRolesForUser`
```

--------------------------------

### BeginningOfHour Function Example

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Reference/Functions/BeginningOfHour.htm

This example demonstrates how to use the BeginningOfHour function with no parameters to get the beginning of the current hour in UTC. If today is August 10, 2014 at 11:15:00 AM local time in Pacific time, this function returns August 10, 2014 at 6:00:00 PM UTC.

```itsm
$(BeginningOfHour(0))
```

--------------------------------

### Get Current User Role

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Reference/Functions/CurrentUserRole.htm

Use this function in expressions to retrieve the current user's role. For example, if the user is an administrator, it returns 'Admin'.

```Expression Language
$(CurrentUserRole())
```

--------------------------------

### BeginningOfMinute Function Example

Source: https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Reference/Functions/BeginningOfMinute.htm

This example demonstrates how to use the BeginningOfMinute function with a specified number of minutes. If today is August 10, 2014 at 11:15:00 AM local time and your time zone is Pacific time (UTC-7), this function returns August 10, 2014 at 6:27:00 PM UTC time.

```itsm
$(BeginningOfMinute(12))
```
Tokens:
Raw