Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

This document provides information on how to authorize a browser or device for the AMPLIFY Platform, an overview of the AMPLIFY Platform home page and how to navigate it, and how to access and navigate the Dashboards.

...

To sign up for access to AMPLIFY Platform and to create an AMPLIFY Platform account:

...

Optionally, enter your SMS-enabled phone number and click Verify. When you click Verify, a text with a verification code is sent to your phone. 

Info

Verifying your phone number is optional but highly recommended for increased security with multi-factor authentication. It must be SMS-capable and will be used to receive activation codes. Standard text-messaging rates apply. The phone number should be entered as digits only. If you do not want to verify a phone number during signup, you can configure this later in your account settings. Refer to Managing Accounts.

Image Removed

...

Select one or more provided options, and then click Continue to the AMPLIFY Platform. You are forwarded to the Change Organization Name page. 

Info

if you select one or more options, required services will be auto provisioned so that you can get started right away.

...

AMPLIFY Platform Sign-in

Use the following sign-in instructions if your organization has the single sign-on (SSO) feature enabled.

To sign into the AMPLIFY Platform using single sign-on:

  1. Navigate to https://platform.axway.com. The Sign In page is displayed.
    Image Removed
  2. Enter the email address associated with your account. If you do not have an AMPLIFY Platform account, click Get started for free and then follow the AMPLIFY Platform Sign-up instructions.
  3. Click Next. Clicking Next will forward you to your organization's Sign-in page.
  4. Enter your organization account password and click Sign In. Clicking Sign In will forward you to the AMPLIFY Platform home page. For an overview of the AMPLIFY Platform, refer to the AMPLIFY Platform Overview.

Use the following sign-in if your organization does not have the single sign-on (SSO) feature enabled.

To sign into the AMPLIFY Platform using your AMPLIFY Platform password:

...

If you are using multi-factor authentication, and the device or browser you are using has not been authenticated, you must provide an authorization code. If requested, enter the authorization code sent to you by email, SMS, or an authenticator app (shown in the example image) associated with your account and click Authorize.

Image Removed

...

Once you are signed into the AMPLIFY Platform, the AMPLIFY Platform home page is displayed. The home page contents are based on your organization's subscriptions and feature trials. What you see on the home page depends on what you selected on the I'm interested in... page and the current capabilities to which your organization has subscribed. If you did not make any selections on the I'm interested in... page and there are no subscribed capabilities, you are taken to the Explore More Products & Services page.

Image Removed

The AMPLIFY Platform home page includes the following:

  • Key Tasks - A list of key tasks with links into Platform services that map to the current capabilities to which the organization is subscribed. 
  • Dashboard Link - A link to the AMPLIFY Platform Dashboard, the AMPLIFY Visibility dashboards, or both depending on your subscribed capabilities.
  • My Capabilities Links - Links to what is currently available to you based on your role and your organization's subscriptions, which are mapped to the key tasks.
  • Explore More Link - A link to the Explore More Products & Services page to view the AMPLIFY Platform service offerings and products. A list of available products and services to which you do not have a subscription are provided with various pointers and actions to get you started. You can learn more, start a free trial, or renew an expired subscription. Also, you can click Review my organization's subscriptions link at the bottom of the page for subscription details.

AMPLIFY Platform Navigation

The AMPLIFY Platform user interface uses a unified top and bottom navigation. From any page in the Platform, you will see the same navigation.

AMPLIFY Platform Top Navigation

The AMPLIFY Platform includes the following menus and links in the top navigation:

Image Removed

...

  • DocumentationClick to navigate to the Documentation Portal and explore the AMPLIFY Platform documentation.
  • Developer PortalClick to navigate to the Axway Developer Portal to learn about and watch video tutorials on the AMPLIFY Platform capabilities.
  • Community PortalClick to navigate to the Axway Community Portal.
  • Support PortalClick to navigate to the Axway Support Portal (login required).
  • Axway University - Click to navigate to the Axway University Portal.
  • Marketplace - Click to navigate to the Axway AMPLIFY Marketplace.
  • Axway.com - Click to navigate to Axway.com.
  • Developer Blog - Click to navigate to the Axway Developer blog, where you can subscribe to receive blog posts by email.
  • YouTube Channel - Click to navigate to the Axway Developer YouTube channel.

...

  • Account - Click this link to access and manage your account information.
  • Organization - Click this link to mange the selected organization.
  • Switch Org (for accounts with multiple organizations) - Click to switch to a different organization to which you belong.

  • Sign Out - Click this link to sign out of your account.

AMPLIFY Platform Bottom Navigation

The AMPLIFY Platform includes the following links in the bottom navigation:

Image Removed

  • Version - The version for the AMPLIFY Platform and AMPLIFY Platform Dashboard. Click the version to be taken to the Release Notes.
  • Documentation - Click this link to view the latest AMPLIFY Platform documentation.
  • Status - Click this link to open the Axway AMPLIFY Platform Status page.
  • Release Notes - Click this link to open the AMPLIFY Platform release notes directory.
  • Terms - Click this link to view the AMPLIFY Platform Terms of Use.
  • Chat Icon - Click this icon to ask a question, make a suggestion, or report a problem.

The Dashboards

The AMPLIFY Platform provides different dashboards based on your role and capabilities.

  • AMPLIFY Platform Dashboard - provides you full lifecycle visibility and real-time insights for all of your apps and APIs.
  • AMPLIFY Visibility - provide a way to visualize the data that is ingested from various products.

To access the dashboards, click the Dashboard link from the AMPLIFY Platform home page. 

Image Removed

When you click the Dashboard link, one of the following happens depending on your role and capabilities:

  • You are taken to the AMPLIFY Platform Dashboard home page.
  • You are taken to the AMPLIFY Visibility dashboard page.
  • You are taken to the AMPLIFY Platform Dashboard home page and there is a tab in the left navigation to the AMPLIFY Visibility dashboard.

...

The AMPLIFY Platform Dashboard includes a left navigation menu with tabs to:

Info

The available tabs on the Dashboard may vary based on your role and your organization's subscriptions.

...

  • Apps - displays the list of applications for the selected organization.
  • Overview - displays key metric information.
  • Customer Queries - if configured, displays custom query summary information and enables the creation of custom analytics queries.
  • Premium Modules - navigate to the Download Premium Modules page.
  • Visibility - navigate to the AMPLIFY Visibility dashboards.

The left-side in the bottom navigation bar contains a link for enabling Demo Data mode. Click  Demo Data  to populate Dashboard with demonstration data to see how the Dashboard looks if you have several applications and APIs in production.

Apps tab

The Apps tab displays the list of applications for the selected organization. Select the Show only my apps checkbox to limit the displayed list of applications to only display your projects or applications. The list of apps can also be filtered by app type. You can also search the list of apps by app name, ID, or creator and select and pin apps from the list of apps.

Image Removed

To manage an application, select the application to manage from the list of applications.

If you haven't created any applications yet, you will be directed to the You don't have any apps yet! page. Don't worry. It's easy to get started creating apps using the AMPLIFY Platform. It should take you only a few minutes to create an app. Once you do, your Dashboard will have data here. To get started creating applications, click one of the following options:

  • Get the latest tools - You will be forwarded to the Get started with App Builder page where you can select to get started building apps with either Axway Appcelerator Studio or Appcelerator CLI.
  • Register App for Services - You will be forwarded to the Register App for Services page.
  • Create MBS Datasource - If you do not have a subscription, you will be forwarded to the Billing page where you can upgrade your plan to access locked items. Refer to Managing Billing. If you have a subscription, you will be forwarded to the Create Mobile Backend Services Datasource page.

Image Removed

Once you have apps created, you can add new apps from the apps list page. Click the Actions ( ... ) menu in the upper right, and then select Register App for Services or Create MBS Datasource.

App List Filtering

The apps list can be filtered by:

  • All Apps
  • Titanium SDK Apps
  • APS SDK Apps
  • Runtime Services
  • Mobile Backend Services
  • APIs/Microservices
  • Website/Web Apps
  • Other

To filter the apps list by a selected app type:

  1. Select All Apps.
  2. Select an app type from the All Apps down-down menu.

The displayed apps list will be updated and will only display the apps matching the selected application type.

Apps List Sorting

The Name, Type, and Created columns in the apps list can be sorted either in ascending and descending order. Note that pinned apps will always appear at the top of the apps list in the sorted order.

Apps List Paging

The number of displayed applications per page can be selected using the per page drop-down menu.

Image Removed

The number of applications displayed per page can be set to:

  • 10 per page
  • 25 per page (default)
  • 50 per page
  • 100 per page

Select Favorite Apps

To pin an app or add an app as a favorite:

  1. Click the Actions (...) menu associated with the app to pin.
  2. Select pin

The app will be updated to indicate it is pinned and it will be displayed at the beginning of the apps list.

To unpin an app or remove an app as a favorite:

  1. Click the Actions (...) menu associated with the app to unpin.
  2. Select unpin.

The app will be unpinned and will display alphabetically in the apps list.

Delete Apps

You must have the administrator role for the organization or team to see the Delete option and to delete apps.

To delete a single app:

  1. Click the Actions (...) menu associated with the app to delete.
  2. Select Delete.
  3. Enter the name of application or datasource to delete.
  4. To confirm the deletion, click I understand that this a permanent and irreversible action. Continue.

To delete multiple apps:

  1. Select the apps to delete by using multi-select methods for your Operating System.
  2. Click the Actions (...) menu located at the upper right of the apps list page.
  3. Enter your AMPLIFY Platform password.
  4. To confirm the deletion, click I understand that this a permanent and irreversible action. Continue.

Overview tab

The Overview tab displays key metric information. For additional information on the key metrics, refer to Viewing Metrics.

Image Removed

Custom Queries tab

The Custom Queries tab displays custom query summary information and enables the creation of custom analytics queries. For information on creating custom queries, refer to Creating Custom Queries.

Image Removed

Premium Modules tab

The Premium Modules tab takes you to the Download Premium Modules page. 

Image Removed

To download a premium module, click the module download button associated with your current Titanium SDK installation. The following premium modules are available for download:

  • Appcelerator Crash Analytics - Enables Appcelerator Crash Analytics. Appcelerator Crash Analytics allows you to identify and troubleshoot crashes in your mobile applications.
  • SQLite Database Encryption Module - Provides transparent, secure 256-bit AES encryption of SQLite database files.
  • Appcelerator Crypto Module - Provides access to the CCCrypt symmetric encryption interfaces such as AES128, DES, RC2, and RC4.
  • Appcelerator Geofence Module - Enables monitoring of regional boundaries and alerts when specified boundaries are entered.
  • Appcelerator HTTPS Module - Provides SSL Pinning support to prevent man-in-the-middle (MITM) attacks.
  • Appcelerator LDAP Module - Provides access to LDAP directory servers by utilizing the UnboundID LDAP SDK for Java, allowing for binding and searching against the service.
  • ti.cloudpush - Enables Mobile Backend Services Push Notifications for Android applications.

Visibility tab

The Visibility tab takes you to the AMPLIFY Visibility Dashboards. 

AMPLIFY Visibility Dashboards

 The AMPLIFY Visibility dashboards provide a way to visualize the data that is ingested from various products. These dashboards are identified by AMPLIFY Visibility  site name on the page. The AMPLIFY Visibility dashboards comprise  API Dashboard Event Viewer , and  Search Audit . Each dashboard is customized to provide relevant details about the product's data. Depending on the product, you can use the dashboards to:

  • Filter a large amount of data
  • Display a subset of data using graphs
  • Display a summary of information

Access to the AMPLIFY Visibility dashboards is based on AMPLIFY Platform roles and capabilities, where you will see one or more of the dashboards. Since the Platform roles are mutually exclusive, not all combinations of dashboards will be visible.

AMPLIFY Visibility Dashboard Roles

The AMPLIFY Visibility dashboards meet the needs of different users and therefore are linked to one or more AMPLIFY Platform user roles. You can be assigned different AMPLIFY Platform roles that grant you the rights to the AMPLIFY Visibility dashboards associated with your assigned roles. The dashboards are available to you with the following Platform roles.

DashboardRole
API DashboardCentral Role: Analytics Specialist
Event ViewerPlatform Role: Developer
Search AuditPlatform Role: Auditor

AMPLIFY Visibility Dashboard Left Navigation

The AMPLIFY Visibility dashboards left navigation includes the following tabs:

Info

The available tabs on the AMPLFY Visibility Dashboard may vary based on your role and your organization's subscriptions.

 

Image Removed

  • API Dashboard
  • Event Viewer Dashboard
  • APP Builder link
  • API Observer link

And another left navigation for the Search Audit Dashboard.

Image Removed

API Dashboard

Click the API Dashboard tab to access the API Report - Health and Usage dashboard. You must be assigned the Analytics Specialist Central Role to access the API Dashboard tab. The API Report - Health and Usage dashboard shows a summary of the data ingested inside the platform

Image Removed

The API Dashboard displays the top 10 performance values:

  • Top 10 most performance APIs - by processing time - The results include the API Name with the Min (ms), Max (ms), and Average (ms) processing times
  • Top 10 most requested APIs - by number of calls - The results include the API Name with the Number of calls and Number of failures
  • Top 10 least performance APIs - by processing time - The results include the API Name with the Min (ms)Max (ms), and Average (ms) processing times
  • Top 10 least requested APIs - by number of calls - The results include the API Name with the Number of calls and Number of failures

The data can be filtered by the following time options:

Info

The displayed values do not include the data ingested during the current day. For example, when choosing 'Last day', the data is based on the events received starting with the previous day at the start of day (00:00) until yesterday at end of day (23:59), given your time zone.

  • Last day

  • Last week
  • Last month

Event Viewer Dashboard

Click the Event Viewer tab to access the Event Viewer AMPLIFY Visibility dashboard. You must be assigned the Developer Role to access the Event Viewer tab. The Event Viewer dashboard is used to display a large number of events that displays the Event Time and Event Message

Image Removed

Scroll down the page to dynamically load more events.  

Filter and search the event data using the options located at the top of the dashboard. You can filter the data by any of the fields contained in the event:

  • Body
  • Header
  • Metadata
  • System (@index and @knowledge_time)

You can also narrow event search results by using the pre-defined time intervals or adding a custom time filter: 

  • 5 minutes
  • 30 minutes
  • 1 hour
  • 6 hours
  • 1 day
  • 1 week
  • Custom time

You can search events by a keyword. Finally, you can use the available options to display event metadata and auto refresh the results to load the newest events every five seconds.

Search Audit Dashboard

Click the Search Audit tab to view the Search Audit AMPLIFY Visibility dashboard. You must be assigned the Auditor Role to access the Search Audit tab. The Search Audit dashboard is used to display audit events showing sensitive data that is most relevant to an auditor.

Image Removed

The following event audit details are displayed:

  • Knowledge Time
  • Time
  • Id
  • User
  • Organization ID
  • Operation
  • Initial value
  • New value
  • Capability name
  • IP address
  • Comment

Scroll down the page to dynamically load more events. 

Filter and search the event data using the options located at the top of the dashboard. You can filter the data by any of the fields contained in the event:

  • Body
  • Header
  • Metadata
  • System (@index and @knowledge_time)

You can also narrow event search results by using the pre-defined time intervals or adding a custom time filter: 

  • 5 minutes
  • 30 minutes
  • 1 hour
  • 6 hours
  • 1 day
  • 1 week
  • Custom time

You can search events by a keyword. Finally, you can use the available option to auto refresh the results to load the newest events every five seconds.

APP Builder and API Observer tabs

Click the APP Builder Image Removed or API Observer Image Removed tabs to redirect you into the product specific dashboard. You must be assigned the Analytics Specialist Role to access the API Observer tab. If you are not  an Axway administrator you will see these tabs, and then when selected, you will be redirected away from the AMPLIFY Visibility dashboard and into the product specific dashboard.

The Getting Started documentation includes the following topics:

Children Display