Starting and Stopping Appian

Starting and stopping the system properly is very important for maintaining the highest levels of system availability.

In this document <JBOSS_HOME> refers to the directory in which you installed JBoss. If you are using an application server other than JBoss, replace the steps that instruct you to start or shutdown JBoss with the appropriate steps for your application server.

Important: Always verify that Appian is properly shut down before attempting a restart.

Improper Shutdown: Improper shutdown may result in services not resuming properly, which may lead to a delay in restoring your services.

Bootstrap Language: If you want to change the startup language and timezone used by the system, this must be changed prior to the first time you log into the system. The default language for all users remains accessible through the user interface, at all times.

Starting the Application Suite on Windows

  1. (If restarting) verify that the suite is completely shut down.

  2. Execute <APPIAN_HOME>\server\_scripts\start-suite.bat — OR — If you are running Windows services, use the Microsoft Management Console to start the Appian services.

    • When running Windows services, a process named jbosssvc.exe appears in the task manager. This controls the Appian Engines. If you are running JBoss as a service on the same machine, the jbosssvc.exe process appears twice.
  3. Once all Appian services have been started, start your search server. Execute <APPIAN_HOME>\search-server\bin\start.bat

    • If running multiple instances of the search server, start all of them in any order before proceeding to the next step. You do not need to wait for one instance of the search server to complete startup before starting another instance.
  4. Once your search server has been started, start your application server.

    • JBoss - execute <JBOSS_HOME>\bin\standalone.bat.
    • WebLogic - follow the startup procedure for the application server as documented by the application server vendor.

If you have multiple application servers, the first time you start Appian (either after a fresh installation or update), start only one server and wait for it to complete startup before starting the rest. The remaining application servers may be started simultaneously. For subsequent restarts of Appian on the same version you may start all application servers at the same time.

Stopping the Application Suite on Windows

  1. Stop the application server(s)

    • JBoss - execute <JBOSS_HOME>\bin\shutdown.bat
    • WebLogic - follow the shutdown procedure for the application server as documented by the application server vendor.
  2. Stop the search server. Execute <APPIAN_HOME>\search-server\bin\stop.bat.

  3. Stop the Appian engines. Execute <APPIAN_HOME>\server\_scripts\stop-suite.bat.

  4. Execute the checkengine.sh script to verify that all Appian services have stopped. It may take several minutes for all engines to stop as they conduct a checkpoint procedure as part of the standard shutdown.

    cd <APPIAN_HOME>\server\_scripts\diagnostic\
    checkengine.bat
    
  5. Ensure all Appian engines display an Fatal status, indicating that they are no longer running.

To verify that all Appian processes have stopped running, complete the following:

  1. Open the Windows Task Manager.
  2. Click the Processes tab.
  3. Make sure that there are no active k.exe or java.exe processes (and jbosssvc.exe processes if you're running Windows services).

Stopping Windows Services

  1. (Optional) Prior to stopping Windows Services that are installed with the quick stop option, we recommend performing an engine checkpoint to ensure that your engines take the minimum amount of time when restarting. Engines that are not checkpointed before shutdown take longer to start.
    1. Open the Windows Task Manager.
    2. Note the CPU usage of your Appian processes.
    3. Run <APPIAN_HOME>/server/_scripts/checkpoint-suite.bat.
    4. Wait for the CPU usage of your processes to return to prior levels.
  2. Open the Windows Services management console.
  3. Select the Appian service.
  4. Click Stop.

Starting the Application Suite on Linux

For Linux, use Bash 3.0 or later.

  1. If restarting, type the following commands to ensure that no Appian processes are active:

    ps -ef | grep /k
    ps -ef | grep /java
    
  2. Follow the stopping procedures to shut down any processes that are still active before proceeding.

  3. Change directories to <APPIAN_HOME>/server/_scripts/.

  4. Execute ./start-suite.sh.

  5. Execute the checkengine.sh script to verify that all Appian services have started correctly.

    cd <APPIAN_HOME>/server/_scripts/diagnostic/ ./checkengine.sh
    
  6. Ensure all Appian engines display an Okay status.

  7. Once all Appian services have been started, start your search server. Execute <APPIAN_HOME>/search-server/bin/start.sh

    • If running multiple instances of the search server, start all of them in any order before proceeding to the next step. You do not need to wait for one instance of the search server to complete startup before starting another instance.
  8. Once your search server has been started, start the application server.

    • JBoss - execute <JBOSS_HOME>/bin/standalone.sh.
    • WebLogic - follow the startup procedure for the application server as documented by the application server vendor.

If you have multiple application servers, the first time you start Appian (either after a fresh installation or update), start only one server and wait for it to complete startup before starting the rest. The remaining application servers may be started simultaneously. For subsequent restarts of Appian on the same version you may start all application servers at the same time.

Stopping the Application Suite on Linux

  1. Stop the application server(s)

    • JBoss - execute <JBOSS_HOME>/bin/shutdown.sh
    • WebLogic - follow the shutdown procedure for the application server as documented by the application server vendor.
  2. Stop the search server. Execute <APPIAN_HOME>/search-server/bin/stop.sh.

  3. Stop the Appian engines. Execute <APPIAN_HOME>/server/_scripts/stop-suite.sh.

  4. Execute the checkengine.sh script to verify that all Appian services have stopped. It may take several minutes for all engines to stop as they conduct a checkpoint procedure as part of the standard shutdown.

    cd <APPIAN_HOME>/server/_scripts/diagnostic/ ./checkengine.sh
    
  5. Ensure all Appian engines display an Fatal status, indicating that they are no longer running.

  6. Type the following commands to verify that no Appian processes are running:

    ps -ef | grep /k
    ps -ef | grep /java
    
  7. If processes continue to run, repeat the shutdown procedures for the remaining running processes. If you are not able to shut down following the documented procedures, kill the remaining processes only after verifying that the CPU usage of those processes is consistently at 0% for several minutes and verifying that the corresponding .kdb file is not being written.

Logging In

Using one of the supported web browsers, use one of the following URLs to access the Appian Designer interface:

  • http://SERVER_NAME:SERVER_PORT/suite/design

  • For JBoss, the SERVER_PORT is typically 8080.

  • For WebLogic, the port number is typically 7001.

Initial Login

When logging in for the first time, use the Administrator account with the password admin.

After logging in, you are automatically prompted to change the Administrator password.

Troubleshooting

What if my Appian services start, but my application server does not?

If your application server starts and stops abruptly, you may have a port conflict that is preventing the application server from running. You can diagnose and resolve such issues in the following manner:

  1. Check for port conflicts using a network utility such as TCPView.
  2. If you discover a conflict, identify the application that is preventing the application server from starting (check the local address).
  3. Stop the offending application, and configure it to use a different port number — OR — If the application is an Appian service, start and stop Appian.
  4. If you encounter a recurring Appian conflict, designate the port numbers that Appian uses in a custom appian-topology.xml file.

See also: Port Usage and Server Configuration Topologies

What if I've checked for for port conflicts with my application server, but I still can't identify a problem?

Verify your Java configuration settings.

It is possible to experience issues when attempting to run the application server as a Windows service, if the JAVA_HOME location includes a space in the file path (such as when your JDK is installed in C:/Program Files/).

17.1

On This Page

FEEDBACK