Documentation

On this page:

FAQs

Where can I find the software for download?

Software builds for download can be found in the Nexus Repository for your deployment. If you do not have access to the repository, contact your Itential Account representative to obtain the necessary credentials.

Which browsers are supported by Itential Automation Platform (IAP)?

Presently, Itential Automation Platform (IAP) is compatible with the most current version of the following browsers:

  • Chrome
  • Firefox
  • Edge
  • IE11

If you are unsure what version you are actually running, be sure to check.

Use the following table to better understand the type of user action that is required for various form fields in IAP. Depending on the browser, the message prompt for user input will vary.

Browser Field Type Message Prompt Required User Action
Chrome Text None Enter required text in the field.
Chrome Numerical None Enter the required numerical value.
Chrome Dropdown Menu Please select an item in the list. Select the appropriate item from the dropdown list.
Firefox Text None Enter required text in the field.
Firefox Numerical Please enter a number. Enter the required numerical value.
Firefox Dropdown Menu Please select an item in the list. Select the appropriate item from the dropdown list.
IE11 Text This is a required field. Enter required text in the field.
IE11 Numerical This is a required field. Enter the required numerical value.
IE11 Dropdown Menu You must choose an item from the list. Select the appropriate item from the dropdown list.

Using the Itential Service Desk to Create a Support Ticket

How to Access the Itential Service Desk

Support Ticket generation requires an Itential Service Desk (ISD) access account. To request access to the Itential Service Desk, contact your Itential Account representative.

Customers with a Service Desk account can access the Itential Service Desk and other related support tools via the https://itential.atlassian.net/servicedesk/customer/portals link.

How to Create a Product Support Ticket

To generate a Product Support ticket:

  1. Click the Login button in the upper-right corner of the screen.

  2. Upon login, users will find a card display for the Service Desk and other related areas.

    alt text

  3. Click the Itential Service Desk card to access the Service Desk portal.

  4. Select the appropriate category for the ticket that needs to be generated. Use the Ticket Category table below.


    Note: Product support tickets generated outside of the Itential Service Desk against any other portals will be cancelled.


    alt text

    Ticket Category Description
    General Questions Questions about the software, configuration, or other knowledge-seeking inquiries not otherwise covered on the https://docs.itential.io site.
    Report a Problem There is an active issue or a potential software bug that needs resolution.
    Common Requests This is a general category that covers topics like “New Features” Itential customers would like to see in future updates.
    Note: New Feature Requests are reserved for Itential Core products only. If you have a request for any custom code or open-source components (including adapters and pre-builts), please open an issue directly in the repo location containing the code.
  5. Select the appropriate ticket ticket.

  6. Click the appropriate item under the label “What can we help you with?”

  7. Complete the ticket fields. Fields marked with red asterisks are required.

  8. Click Send to submit the ticket.

Impact Field Values and Definitions

The Impact field is displayed on the Service Desk portal page when the user selects "Report a software problem". To help you select the appropriate value for the Impact field, use the following definitions.

Impact Type Definition
Extensive / Widespread Complete failure of the Application and no existing workaround is present; this may include executable crashes or situations where a major feature of the Application is inoperable.
Significant / Large Complete failure of the Application and an existing workaround is present; failure of a non-critical feature.
Moderate / Limited Failure of a minor feature or an Application usability problem.
Minor / Localized Non-performance related issues, i.e. appearance of the Application.

Share With Field

The Share with field at the bottom of the ticket is important and exists to ensure that SLAs for your organization are followed. Some members of a deployment may be contractors or other external delivery providers which provide services to more than one Itential customer. In these cases, the contractor generating the ticket will need to specify the organization to which the request relates (e.g. “Share with Acme Corp”).

Report a Production System Outage

Within the Report a Problem category, there is an option to report a Production System Outage. Please note, this option should only be used if your PRODUCTION system is actively experiencing an outage. General software problems in development or lab systems are not considered outages.


Note: When reporting a Production System Outage, your conference bridge information is required and must be provided.


Request Types

User related information (including tickets generated) can be found by clicking the Requests menu option next to your avatar in the upper-right corner of the screen.

alt text

To help you select the appropriate request type, use the following definitions.

Request Type Description
Created by me This will display all tickets you have generated.
(Organization Name) This will display a list of tickets generated for your associated organization.
Note: Depending on your company affiliations, you may have more than one organization name available to you.
All This will display a list of tickets for all organizations to which you belong.

Ticket Status Options

When viewing a ticket list, the default status type will be "Open requests". You may change the status by clicking the associated drop-down menu and selecting a status from the list.

alt text

Status Updates and Comment History

Once a ticket has been created through the Service Desk portal, continue using the portal to view status updates and related conversation (comment history) threads. This is the primary method by which status updates are made available and communicated.

In the event that you receive an email update and you are away from your computer or logged out of the Service Desk Portal, you may respond to the email and your comments will be added to your ticket.

Does Pronghorn (Itential Automation Platform) track user activity out-of-box?

At this time, the Itential Automation Platform does not track specific user activity such as when users:

  • Access an application.
  • Select a specific form.
  • Make a specific API call.

Does Pronghorn (Itential Automation Platform) have a log file for errors and other important information?

The Itential Automation Platform (Pronghorn) log files are typically stored in the /var/log/pronghorn directory. If the log files are not found in that directory then check the $PRONGHORN_BASE/properties.json file. Look at the value of the loggerProps.log_directory to locate the log files.

Log messages can also be found in the systemd journal using the following command.

sudo journalctl -f

See the manual (man) pages of journalctl for more details.

Does the NSO adapter have to be restarted to reflect a service pack upgrade in NSO?

Yes. The NSO adapter will read and compile the service model yang files at startup (APIs such as runAction and getDevices will continue to work even without an adapter restart).

If you are using the NSO adapter for service operations (i.e., Service Manager, Form Builder, etc.), restart the adapter after updating the NSO service models and the adapter will re-read the yang files. If you have forms linked to the updated service models, you will likely have to rebuild some parts of these forms in addition to restarting the adapter to ensure the forms are aligned with the updated service model.

How do I generate the "showsupport" output for my environment?

The showsupport command-line utility is executed as the pronghorn process user. Use the following steps to generate the output:

  1. SSH to your Itential host and login as the pronghorn process user.

  2. Execute the following commands.

    cd /opt/pronghorn/current
    ./showsupport
    ls -l ./showsupport*.gz
  3. Download and attach the showsupport file to your Service Desk Ticket.

How do I generate a blueprint for my environment?

The blueprint is a generated JSON document of what is installed on the system, including out-of-box apps, adapters, as well as any custom apps and adapters, along with installed versions.

From the IAP home page:

  1. Click Admin Essentials in the left navbar to open the application.

    alt text

  2. Click Blueprints in the Quick Start card and a dropdown menu displays.

  3. Select Download to auto-generate and download the blueprint to your local machine to attach to your support ticket.

  4. Alternately, use the Copy option to paste the contents in the Blueprint Output field on your support ticket.

  5. Always include the contents of the Blueprint when you open ISD support tickets.

    alt text