Setting up AgilePoint Server to Run as a Windows Service

Navigation

  1. On the AgilePoint Server machine, click Start > All Programs > AgilePoint > AgilePoint Server Manager.

Instructions

  1. On the AgilePoint Server Manager window, click the Add (+) button to create an instance of the AgilePoint Server service.
  2. In the right pane, complete the fields as required.
    Field Name Definition

    Service Name

    Definition:
    Specifies the name you want to use to identify the Windows service associated with the AgilePoint Server instance.
    Allowed Values:
    A single line of text.
    Default Value:
    None
    Display Name
    Definition:
    Specifies the name you want to display to users to identify the AgilePoint Server instance.
    Allowed Values:
    A single line of text.
    Default Value:
    None
    Location
    Definition:
    Specifies the path to the AgilePoint Windows Service instance.
    Allowed Values:
    A valid absolute file path.
    Default Value:
    None

    WSHttp Port

    Definition:
    A free, unique port AgilePoint Server can use for WSHttp binding.

    This field is required.

    Allowed Values:
    Specifies a valid WSHttpPort number.
    Default Value:
    None

    TCP Port

    Definition:
    Specifies a free, unique port AgilePoint Server can use for TCP binding.

    This field is required.

    Allowed Values:
    A valid TCP port number.
    Default Value:
    None

    BasicHttp Port

    Definition:
    A free, unique port AgilePoint Server can use for BasicHttp binding.

    This field is required.

    Allowed Values:
    A valid port number.
    Default Value:
    None

    Web HTTP Port

    Definition:
    Specifies a free, unique port AgilePoint Server can use for REST API calls.

    To access this field, click the Rest Port Information tab.

    Allowed Values:
    A valid HTTP port number.
    Default Value:
    None

    Service Factory Binding

    Definition:
    Specifies the path to the service factory binding.

    To access this field, click the Rest Port Information tab.

    Allowed Values:
    A valid path.
    Default Value:
    Deselected

    Use Secure Connection (SSL)

    Definition:
    The common name (CN) or domain name or fully qualified domain name associated with your SSL certificate.

    To access this field, click the SSL Settings tab.

    Allowed Values:
    An appSettings key in the following format:
    • Selected - SSL encryption is enabled.
    • Deselected - SSL encryption is disabled.
    Default Value:
    Deselected

    Domain Name

    Definition:
    The common name (CN) or domain name or fully qualified domain name associated with your SSL certificate.

    To access this field, click the SSL Settings tab.

    Allowed Values:
    An appSettings key in the following format:

    A text string representing your common name or domain name.

    Default Value:
    None
    Example:
    mydomain.com

    Check Availability of Ports

    Function:
    Tests the specified ports to ensure they are free.

    UserName

    Definition:
    Specifies the user name for the AgilePoint service account.
    Allowed Values:
    A valid user name in the format domain\username.
    Default Value:
    None
    Example:
    MYDOMAIN\APServiceUser
    Password
    Definition:
    The password for the authentication account.
    Allowed Values:
    A valid password.
    Default Value:
    None
    Site
    Definition:
    Specifies the web site from the list you created for AgilePoint during pre-installation.
    Allowed Values:
    A valid web site name.
    Default Value:
    AgilePointWebsite
    Virtual Directory
    Definition:
    Specifies the name you want to use for the virtual directory that contains the files for the Enterprise Manager web application.
    Allowed Values:
    A valid virtual directory name.

    The name EnterpriseManager is suggested.

    Default Value:
    None

    Application Pool

    Definition:
    Specifies the IIS application pool for the Enterprise Manager web application you want to run.
    Allowed Values:
    A valid application pool.
    Default Value:
    AgilePointAppPool

    Add ()

    Creates a new AgilePoint Windows Service instance.

    Start ()

    Function:
    Starts the selected AgilePoint Windows Service instance.

    Stop ()

    Function:
    Stops the selected AgilePoint Windows Service instance.

    Delete ()

    Function:
    Deletes the selected AgilePoint Windows Service instance.

    Refresh ()

    Function:
    Refreshes the selected AgilePoint Windows Service instance.

    Server Configuration ()

    Function:
    Opens the AgilePoint Server Configuration window for the selected AgilePoint Windows Service instance.

    Enterprise Manager ()

    Function:
    Opens Enterprise Manager for the selected AgilePoint Windows Service instance.

    Update

    Function:
    Saves changes to an AgilePoint Windows Service instance configuration.
  3. When you have finished, click Update.
  4. If you are prompted to activate the AgilePoint Server, follow the prompts to activate your AgilePoint Server software.
  5. The AgilePoint Configuration window opens. Follow the procedure to Configure AgilePoint Server.
Note: Do not close the AgilePoint Configuration window before you complete the configuration. You must complete the configuration before you close this window for the installation to complete successfully.

More Information