Quick Start Guide

This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Quick Start Guide

WSO2 App Manager provides secure and self-service access to Web and mobile applications through a single-stop app store. It helps IT teams to effectively manage, deploy, and secure business apps, and it helps CIOs, and administrators to measure usage, productivity, and business statistics. The App Store facilitates single sign-on (SSO) to create a seamless user experience (single login to all apps), which reduces help desk and administrative costs.

This guide walks you through the following main use cases of WSO2 App Manager.

Starting WSO2 App Manager

Follow the steps below to start WSO2 App Manager.

  1. Download WSO2 App Manager. For more  information on downloading WSO2 AppM, see Downloading the Product.

  2. Install Oracle Java SE Development Kit (JDK) version 1.6.24 or later or 1.7.*. For more information on other required prerequisites for WSO2 AppM, see Installation Prerequisites.

  3. Set the JAVA_HOME environment variable. For more information on installing WSO2 AppM, see Installing the Product.

  4. Using the command line, navigate to the <APPM_HOME>/bin/ directory, and execute the command for your operating system as follows.

    • wso2server.bat (for Windows)

    • wso2server.sh (for Linux)

When the App Manger server is started, you see the message "WSO2 Carbon started in 'n' seconds." It indicates that the server started successfully. To stop the App Manager, simply hit Ctrl-C in the command window. For more information on running WSO2 AppM, see Running the Product.

Creating users

In addition to the common users in enterprises such as the publisher and subscriber, you can create custom users. Given below is the list of users and their roles which you need to create to use this guide. 

Username

Role

Description

creator

internal/creator

This provides access to:

  • create apps and to submit them for reviewing before they are published into the App Store.

  • add documentation to apps, version apps, delete apps, and manage app security.

publisher

internal/publisher

This provides access to:

  • manage and maintain the life cycle of an application by approving/rejecting, publishing/unpublishing, and deprecating/deleting them. 

  • app statistics and usage patterns.

subscriber

internal/subscriber  

This provides access to the App Store to subscribe to published applications, view the documentation, and rate/comment on the apps. 

 Follow the steps below to create the above users, and assign user roles to them. For more information on users and roles, see User Management.

  1. Log in to the management console ( https://<IP_ADDRESS>:9443/carbon ) of the App Manager using admin/admin credentials.

  2. Click Users and Roles in the Configure menu.

  3. In the User Management screen, click Users.

  4. Click Add New User.

  5. Enter the username and password, and click Next. 

  6. Select the role(s) you want to assign to the user, and click Finish

Managing applications

WSO2 App Manager provides a simple Web interface called App Publisher for Web and mobile application creation, publishing, and management. You need a user with the internal/publisher role or the admin role to log in to the App Publisher.

Managing Web applications

WSO2 App Manager facilitates creating, publishing, and managing Web applications.

Deploying a Web Application

Follow the steps below to deploy a Web app in WSO2 AppM.

Step 1 - Creating a Web application

In this guide, you work with a sample Web application (e.g. Plan Your Trip), which you need to host in Apache Tomcat, WSO2 Application Server, or any other app server. Follow the steps below to create a new Web application in the App Publisher.

  1. Access the App Publisher using a Web browser (https://<IP_ADDRESS>:9443/publisher).

  2. Log in as the creator user you created above, or as the administrator using admin/admin credentials. 

  3. Click Add New Web Application.

  4. In the Overview screen, enter information as follows. For more information on this section, see Step 1 - Overview.

    The descriptions of the fields in the above screen are as follows.

  5. Click Create. The created Web app will appear in the Web Applications list as follows. 

    list of added Web apps
    list of added Web apps
  6. Click Submit for Review as shown below, to change the status of the Web app from CREATED to IN-REVIEW

Step 2 - Publishing a Web application

Follow the steps below to publish a created Web application.

  1. Log in as the publisher user you created above, and click on the Plan Your Trip Web application. (Skip this step if you are already logged in as the admin or publisher user).

  2. Click Approve as shown below, to change the status of the Web app from IN-REVIEW to APPROVED.

  3. Click Publish as shown below, to change the status of the Web app from APPROVED to PUBLISHED.

    You view the current status as PUBLISHED as shown below.

Step 3 - Subscribing to a Web application

The Web applications that you published are available in the App Store. Follow the steps below to subscribe to a Web application using the App Store Web interface.

  1. Access the App Store using a Web browser (https://<hostname>:9443/store), and click Sign In.

  2. Enter the username of any user with 'internal/subscriber' role and a password (you can use the subscriber user you created above), and click Sign In, to log in to the App Store.

  3. Click on an application to subscribe to it. 

  4. Click Subscribe Me. You see a pop-up message if the subscription is successful. Now, you can access and use the app by invoking it as described in the next section.

Step 4 - Invoking a Web application

Follow the steps below to invoke a Web application.

  1. Log in to the App Store as the subscriber user you created above, if you are not already logged in. 

  2. Click My Subscriptions, to see subscribed applications. 

  3. Click on the application which you need to invoke. 

  4. Click on the Gateway Endpoint URL, to invoke the Web application as shown below.

  5. Provide subscriber credentials to sign-in to the application. Now, you are redirected to the Web application.