Applies To

SharePoint Online

Description:

NITRO Studio components provide a variety of features for configuring business process flows in SharePoint. Sometimes an error can occur during execution due to various reasons like invalid configurations or data, intermittent connectivity or Office 365 issues, NITRO issues etc.

NITRO Custom Actions component has a feature to log details of error and related data in a list in the site. This data can be used by administrators to investigate the issue and correct the configurations. For NITRO issues, these can be submitted by administrators to Crow Canyon for further investigation and fixes as required. This feature will be added to other NITRO components in upcoming releases.

This article describes the process of submitting these errors and investigation thereafter. When an error is detected by NITRO, logged-in user is shown an option to report the error.  Site administrator (Full Control) will get a notification along with link to the details of the error.

Note: This feature is available in NITRO 2.x and is already included as part of the NITRO Applications package. It will be made available soon in NITRO 3.x.

Summary of steps:

1. Install NITRO Extensions setup
2. Report Error to administrator
3. Report Error to Crow Canyon

Detailed Steps:

1. Install NITRO Extensions setup

Step 1: Navigate to root site of the site collection -> Crow Canyon NITRO Studio app -> click on NITRO Applications as shown below:

Please go to Updates tab in NITRO Applications -> click on NITRO Extensions as shown below

Select the required NITRO site and click Ok to finish the setup as shown below.

Once the above setup is complete, a new list called “NITROErrorLog” will be created in the site. This list helps track all errors reported by users. The Application administrator can use it to monitor and manage issues.

A workflow can also be set up to send automatic notifications when a new item is created. After the issue is resolved—either by the administrator or Crow Canyon Support—it can be marked as Completed.

The list includes columns to capture detailed error information and comes with pre-configured actions for administrators to manage and respond to issues efficiently.

To access the list, please go to Site Contents -> NITROErrorLog

– If the administrator wants to get notification, they can configure the workflow on NITROErrorLog list when the item is created. This workflow creation to get notification is an optional step.

Go to site settings -> Administration -> Crow Canyon NITRO Apps -> Crow Canyon NITRO Workflows app -> Create a new workflow on NITROErrorLog list on item added event to notify administrator.

2. Report Error to administrator

When any error in encountered during custom action execution, a link to submit the error details is shown to user:

On clicking this link a popup is shown with below options:

– After the report is submitted, a message is shown to user as shown in the screenshot below. Error details along with optional information is created as an item in the ‘NITROErrorLog’ list.

3. Report Error to Crow Canyon

Users with Site Administration (Full Control) permission can take the following actions on error log items:

• Send to Crow Canyon
• Mark Completed

These actions are created by the Application in the ‘NITROErrorLog’ list.

1. Administrators can navigate to the item from the notification (as configured in Step 2 above), review details, and decide the next steps whether to “Send to Crow Canyon” or work on it and “Mark Completed”.
2. If error was temporary or fixed by configuration changes, administrator can mark the item as ‘Completed’.
3. If the error is consistent and the administrator is not able to find the root cause, request assistance by using the ‘Send to Crow Canyon’ action. The error details will then be sent to the Crow Canyon support team.

These actions can be updated as required.

Custom Action Functionality

Send to Crow Canyon

This custom action is used to escalate an error to Crow Canyon Support when the issue is in a “Pending” state.

Functionality:

• Condition: The action runs only if the item’s status is set to “Pending”. It is available to all users.
• Update Work Log: A pop-up opens for the administrator to add a comment or note in the Work Log field to provide context or details about the issue. Here you can describe the steps already tried and whether the issue is consistent across users/browsers, etc. You can also include browser console logs/network traces during the issue.

• Send Email to Crow Canyon: On clicking ‘Ok’, an email is automatically sent to Crow Canyon Support with the item’s error details.
• Update Status: The item’s status is updated from “Pending“ to “Sent to Crow Canyon“ to indicate escalation.

Mark Completed

This custom action is used when the issue has been reviewed and resolved, either by the administrator or by the Crow Canyon support team.

Functionality:

• Condition: Executes only if the item’s status is not set to “Completed“. It is available to all users.
• Update Work Log: Administrator can add the description of the fix or any other relevant details for future reference.
• Gateway Condition:
  • If the item’s Status = “Sent to Crow Canyon”, a “Completed” notification email is sent to Crow Canyon Support.
  • If not, the Work Log column is updated with the value “Completed” (no email is sent).
• Send Completion Email (if applicable): Uses a predefined mail template to notify Crow Canyon Support of the completion.