Connect OpenFin apps with ServiceNow

npm install @openfin/servicenow

// Import the OpenFin ServiceNow integration.
import { connect } from '@openfin/servicenow';

try {
  // Update the below statements for your target instance
  const instanceUrl = 'https://YOUR_INSTANCE_NAME.service-now.com';
  const clientId = 'YOUR_CLIENT_ID';

  // Initiate the authorization flow to connect to the instance
  const serviceNowConnection = await connect(instanceUrl, clientId);

  // If connection succeeded, output connection info to the console
  const { currentUser, instanceUrl: connectedInstance } = serviceNowConnection;

  // You are now connected to ServiceNow.
  console.log(`Connected to ${connectedInstance} as ${currentUser.user_name}`);
} catch (err) { 
  // If connection failed, output error info to the console
  console.error('Connection failed: ', err.message);
}

// Get the current user's active Cases.
try {
  // Create the query parameters to return the current user's active cases
  const queryParams = new URLSearchParams();
  queryParams.set(
    'sysparm_query',
    `assigned_to=${serviceNowConnection.currentUser.sys_id}^active=true^ORDERBYDESCsys_updated_on`
  );
  queryParams.set(
    'sysparm_fields',
    'sys_id,sys_class_name,task_effective_number,short_description,state,sys_updated_on'
  );
  queryParams.set('sysparm_limit', '30');
  queryParams.set('sysparm_display_value', 'true');

  // Execute the request to ServiceNow's Table API passing the expected response type as a parameter along with the request URI.
  const response = await serviceNowConnection.executeApiRequest<ServiceNowEntities.CSM.Case[]>(`/api/now/v2/table/sn_customerservice_case?${queryParams.toString()}`);

  // Parse the response from the TableAPI.
  const { data: myActiveCases } = response;

  // In this sample, we write log entries for the number of cases, and some details from each case.
  console.log(`Found ${myActiveCases!.length} cases`);
  myActiveCases!.forEach((activeCase) => {
    console.log(`Case ${activeCase.task_effective_number} is ${activeCase.state}`);
  });
} catch (err) {
  // Make sure to properly handle any errors that might occur when executing API requests.
  if (err instanceof AuthTokenExpiredError) {
    console.error('Connection expired, re-connect then try again');
  } else if (err instanceof ApiRequestError) {
    console.error(`Request failed: ${err.message}`);
  } else {
    console.error(err);
  }
}

// Specify the specific Financial Services Case ID to retrieve.
const caseId = '850057664b874cbdb7ad18d535960380';

// Create the query parameters.
const queryParams = new URLSearchParams();
queryParams.set('sysparm_exclude_reference_link', 'true');
queryParams.set('sysparm_display_value', 'true');

// Call the ServiceNow TableAPI to get the specific Financial Services Case.
const response = await serviceNowConnection.executeApiRequest<ServiceNowEntities.FSO.FinancialServicesCase>(`/api/now/v2/table/sn_bom_financial_service/${caseId}?${queryParams.toString()}`);

// Parse the case.
const { data: fsoCase } = response;

// Log the result.
console.log(`Case ${fsoCase!.task_effective_number} is ${fsoCase!.state}`);

// Create the query parameters.
const queryParams = new URLSearchParams();
queryParams.set('sysparm_fields', 'sys_id,task_effective_number');

// Call the ServiceNow TableAPI to POST the case.
const response = await serviceNowConnection.executeApiRequest<ServiceNowEntities.FSO.FinancialServicesCase>(
  `/api/now/v2/table/sn_bom_financial_service?${queryParams.toString()}`,
  'POST',
  { short_description: 'New case for customer' } as ServiceNowEntities.FSO.FinancialServicesCase
);

// Parse the response.
const { data: newFsoCase } = response;

// Log the result.
console.log(`Created new Financial Services Case with ID: ${newFsoCase!.sys_id}`);

// Specify the case ID to add a comment to.
const caseId = 'dfa83216971eb110d16bf1d11153af8c';

// Call the ServiceNow TableAPI to add the comment to the case.
await serviceNowConnection.executeApiRequest(
  `/api/now/v2/table/sn_bom_financial_service/${caseId}`,
  'PATCH',
  {
    comments: 'Currently investigating this case',
  } as ServiceNowEntities.FSO.FinancialServicesCase,
  true // Suppress the response body for this request as it is not needed
);

// Specify the case ID to close.
const caseId = 'dfa83216971eb110d16bf1d11153af8c';

// Call the ServiceNow TableAPI to close the case.
await serviceNowConnection.executeApiRequest(
  `/api/now/v2/table/sn_bom_financial_service/${caseId}`,
  'PATCH',
  {
    comments: 'The case has been resolved.',
    state: '3',
  } as ServiceNowEntities.FSO.FinancialServicesCase,
  true // Suppress the response body for this request as it is not needed
);

// Disconnect from ServiceNow.
await serviceNowConnection.disconnect();