Getting Started
Welcome to SAGE! This guide will walk you through the initial steps to get the application setup for your use.
SAGE (STEP API Gateway Engine) is an application designed specially for Stibo STEP to help developers monitor, maintain, and performs tasks on STEP systems they manage. It does so using various APIs, integrations, and features that STEP itself provides, bringing them all together in one cohesive and easy to use package.
Pro Tip: SAGE is a responsive web app. This means that it will scale itself appropriately depending on which device it's used on. Try accessing it from your phone or tablet!
To use SAGE, you'll need an account. The application supports user registration, which may be enabled or disabled by the application administrator.
Creating Your Account
If registration is open, you can create an account by following these steps:
- Navigate to the homepage and click the Register button, or find it under the "Account" dropdown in the navigation bar.
- Fill out the registration form with your desired username, a valid email address, and a secure password.
- Click the
Register button to create your account.
Important for Administrators: The very first user to register in the application is automatically assigned the Admin role. This role has extra privileges, including access to the Admin dashboard. All subsequent users will be standard users.
Logging In
Once your account is created, you can log in using either your username or your registered email address, and your password. Successful login will take you to your personalized homepage.
After your first login, you need to configure SAGE to connect to your Stibo STEP systems. This involves three main areas:
Navigate to the
Systems page. Here you can add each of your STEP instances (e.g., Development, QA, Production). You will need to provide basic information like a system name and its URL. For more details on the different fields, please refer to the
Core Features documentation.
For SAGE to communicate with a STEP system, it needs credentials. When adding or editing a system, you must provide a STEP User ID and Password. It is highly recommended to create a dedicated service account within STEP for SAGE, with only the necessary permissions required for the features you intend to use.
Your STEP systems must be network-accessible from the server where SAGE is running. If you are on the SaaS version of STEP, you need to whitelist SAGE's server IP in the self service portal. For On-prem, it might be your firewall or cloud security group rules, if any.
If you are an Admin user, you can find the public IP address of the SAGE server on the Admin page, which should help your network team with the whitelisting process.
After configuring your first system, it's time to verify that everything is working correctly. This simple test will confirm if SAGE can communicate with your STEP instance.
- Go to the Systems page.
- Find the system you just added and click the Select button next to it. The button will turn green, indicating it's the active system.
- Navigate back to the Homepage by clicking the SAGE logo in the top-left corner.
- You will see a "System Details" card. Initially, it might show "No Data".
- Click the
Refresh button on this card.
- If the connection is successful, the card will populate with details from your STEP system, such as the version, license information, and more.
Success! If you see the system details, your setup is complete. You can now explore all the other features of SAGE.
Troubleshooting: If it fails, please double-check the system URL, user credentials, and network whitelisting as described in the Configuration section.
Once you have installed and configured SAGE, you are ready to explore its features. Here are some suggestions: