Versions Compared

Key

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

Installing 1E Catalog

You can install 1E Catalog in the following ways:

Using Tachyon Setup, please

Multiexcerpt include
MultiExcerptNamecat10-install-note
PageWithExcerptPreparation

Please refer to Tachyon 5.0 - Tachyon Setup for

more details.
  • Interacting with the 1E Catalog installation wizard, please refer to Using the interactive installation wizard below.
  • Using the 1E Catalog installer command-line, please refer to Using the installer command-line for more details.
  • installing 1E Catalog on a Tachyon 5.0 server.

    The following methods are only supported for SLA Platform 3.3, or for a remote Catalog server that is part of a Tachyon 5.0 system:

    Table of Contents
    maxLevel3
    minLevel3
    includeUsing.*
    indent20px
    absoluteUrltrue

    Using the interactive installation wizard

    Start a command prompt with elevated rights and navigate to your downloaded copy of 1ECatalog.msi then run it using the following command-line:

    Code Block
    > msiexec /i 1ECatalog.msi /l*v catinstall.log REBOOT=REALLYSUPPRESS



    Advanced Panelboxes for Confluence
    namegrey
    titleOn this page:
    Table of Contents
    maxLevel4
    minLevel2
    indent20px
    absoluteUrltrue



    Panel
    bgColor#FDFDFD
    titleBGColor#FAFAFA

    Welcome

    The welcome screen, just click Next to continue.



    Panel
    bgColor#FDFDFD
    titleBGColor#FAFAFA

    License Agreement

    Read and accept the license information by clicking I accept the terms in the license agreement then click Next.


    Licence agreement


    Panel
    bgColor#FDFDFD
    titleBGColor#FAFAFA

    Destination Folder

    The next screen lets you to choose where to install 1E Catalog, by default this is:

    Code Block
    %programfiles%\1E\Catalog

    Or you can browse to a new folder using Change...

    When you have set the installation folder, click Next to continue.


    Destination Folder


    Panel
    bgColor#FDFDFD
    titleBGColor#FAFAFA

    Service account

    Anchor
    serviceAccount
    serviceAccount

    Select Specify user account or Use Network Service account.

    If you select Specify user account you must then enter the Username and Password for an existing domain account to run the 1E Catalog Update Service.

    If you select Use Network Service account the Username will be set to NT Authority\Network Service.

    Whichever option you choose must follow the permissions described under Preparation: Accounts needed to install the Catalog.

    Click Next to continue.


    Service account


    Panel
    bgColor#FDFDFD
    titleBGColor#FAFAFA

    1E Catalog configuration

    Anchor
    cat11-databaseServer
    cat11-databaseServer
    Set the SQL server instance name where you want to install the 1E Catalog database, and the name of the database catalog.

    Database server you are installing to:

    Enter the SQL server instance name for the 1E Catalog database. The default is (local). Click Browse... to select the SQL Server instance, if the SQL Server Browser service is running on your SQL Server.

    If the SQL Browser service is not enabled and running then you will need to enter the database instance by hand using the following format:

    Code Block
    <SQLInstance>, <Port>

    For example:

    Code Block
    ACME-SQL01\CATINSTANCE, 5035

    Name of database catalog:

    Using the default 1ECatalog name is recommended. Click Browse... to select an existing database, if you have already specified the name of the SQL Server instance.

    AI Auto-curation

    To support the AI Powered Auto-curation feature in SLA, 1E Catalog can be configured to download the model file updates that are used by the AI engine. To do this check the Enable download of model file updates checkbox.

    Note

    You should only check this box if you are using 1E Catalog with Tachyon 5.0 or later. For more information on this feature, please refer to Preparation: Enabling AI Powered Auto-curation downloads.

    Click Next to continue.



    Panel
    bgColor#FDFDFD
    titleBGColor#FAFAFA

    Prerequisite Checks

    Anchor
    cat11-prereqs-check
    cat11-prereqs-check
    Check you have configured every requirement.

    If any checks fail, click the Back button to fix the issue. Click Next to run the checks again.

    If any checks currently show as Failed when you click Next on the Prerequisite Checks screen, a notification dialog displays and the installer closes without attempting the install.

    Note

    The installer now checks that the installation account has dbcreator and securityadmin rights on the database instance where the 1E Catalog database will be installed. These replace the sysadmin permissions that were previously required.

    Once every check is Passed, click Next to continue.


    Prerequisite Checks


    Panel
    bgColor#FDFDFD
    titleBGColor#FAFAFA

    Ready to Install the Program

    Click Back if you need to review or change any options. Once you're satisfied with your selected options, click the Install button.

    After install, click Finish.


    Ready to Install the Program

    Using the installer command-line

    Anchor
    catlogunattendedmode
    catlogunattendedmode
    You can install the 1E Catalog in non-interactive mode using installer properties on the installer command-line:

    Code Block
    languagenone
    > msiexec /i 1ECatalog.msi 
         SQLSERVER=<SQL Server instance name>
         SVCUSER=<Service account name>
         SVCPASSWORD=<Service account password>
         /qn /l*v catinstall.log

    Refer to the Installer properties page for details and optional installer properties.

    Anchor
    Verify the 1E Catalog Installation
    Verify the 1E Catalog Installation
    Verifying the 1E Catalog installation

    To verify the 1E Catalog installer is installed and configured correctly:

    1. Browse to the install location, the default installation folder is %programfiles%\1E\Catalog - you should see:

      FolderNotes
      CatalogUpdateServiceContains binaries used by the 1E Catalog update service.
      CatalogWebUIContains files used by the 1E Catalog web service.
      DatabaseContains binaries for configuring the SQL database. Using complete code to manage SQL configuration enables you to patch 1E Catalog using Windows Installer patches (.msp files).




    1eolstart
    startat2


    1eli
    Start IIS Manager open the Application Pools node, verify the CatalogWeb application pool is started using the service account specified during install. 



    IIS Manager Application Pools


    1eolstart
    startat3


    1eli

    Locate the CatalogWeb web application. By default this is under the Default Web Site.



    IIS Manager CatalogWeb


    1eolstart
    startat4


    1eli

    Make sure you can browse to the application website. By default this will be Browse *:80 (http) which should open Internet Explorer with URL http://localhost/CatalogWeb. If your server is configured to prevent browsing on the server, open a browser on a remote computer and copy the URL, making sure you're logged on as the 1E Catalog installation account.



    1E Catalog Products


    1eolstart
    startat5


    1eli

    Start services.msc and confirm the 1E Catalog Update Service is running.



     confirm the 1E Catalog Update Service is running


    1eolstart
    startat6


    1eli

    Start SQL Server Management Studio and expand the 1ECatalog database. Check the 1E Catalog service account has been added as a user and the database role RoleCatalogUser is created, then check the service account is a member of RoleCatalogUser


    1eli

    Browse to the logpath location, the default install folder is C:\ProgramData\1E\Catalog - open and review Catalog.UpdateService.log for errors.



    Database role RoleCatalogUser

    Upgrade the 1E Catalog

    Please consider the following when upgrading 1E Catalog:

    • Upgrade is supported from 1E Catalog 1.2.0 and later.
    • You only need to upgrade 1E Catalog to 2.0 if you intend to use it with Tachyon 5.0 and associated applications. 
    • If you are currently using SLA Platform 3.3 this will need to be upgraded to the SLA provided with Tachyon 5.0 in order to take advantage of the new 1E Catalog features.
    • The 1E Catalog 2.0 installer comes as part of Tachyon 5.0 and this should be installed or upgraded via the Tachyon Setup. Please refer to Tachyon 5.0 - Tachyon Setup for more details.

    Before upgrading

    Note

    If you are upgrading using a different installation account to the previous installation, you must set the new installation account as db_owner on the existing 1E Catalog database prior to running the upgrade.


    Multiexcerpt
    MultiExcerptNameDisconnectFirst


    Note

    Before re-installing or upgrading 1E Catalog, backup its:

    • Database

    • Installation folder

    In particular make sure you have backups for the following files, if they have been customized:

    • Web.config - located in C:\Program Files\1E\Catalog\CatalogWebUI\
    • CatalogUpdateService.exe.config - located in C:\Program Files\1E\Catalog\CatalogUpdateService\

    Before running the upgrade, make sure all existing connections to the 1E Catalog database are closed, otherwise the upgrade hangs when connecting to the database.

    1. Close SQL Server Management Studio.
    2. Stop all SLA Platform services - if you have the SLA Platform installed and running.
    3. Stop all AppClarity services - if you have AppClarity 5.2 installed and running.
    4. Stop the 1E Catalog Update Service.

    If you have problems during the upgrade, refer to Upgrade issues.


    Upgrading using the stand-alone installer

    To upgrade your existing 1E Catalog to the latest version using the stand-alone installer:

    1. Download the installer from the Support portal: https://1eportal.force.com/s/1ecatalogtopicdetail
    2. Start a command prompt with elevated rights, navigate to the location where you downloaded the 1ECatalog.msi and run it with:

      Code Block
      > msiexec /i 1ECatalog.msi /l*v catinstall.log REBOOT=REALLYSUPPRESS

      The subsequent upgrade steps are the same as for the install.



    1eolstart
    startat3


    1eli

    On the 1E Catalog configuration screen:

    • In the Name of the 1E Catalog database field enter the name of your existing 1E Catalog - do not select Drop old database

      Note
      iconfalse

      If you do select Drop old database, the 1E Catalog data will be rebuilt and you will lose all your site-defined data after the upgrade completes.



    1eli

    When the upgrade is done, verify the installation. Please refer to Verifying the 1E Catalog installation.


    1eli

    As part of the upgrade any customizations found to the following settings will be retained:

    FileSettings

    C:\Program Files\1E\Catalog\CatalogWebUI\Web.config

    Admins
    C:\Program Files\1E\Catalog\CatalogUpdateService\CatalogUpdateService.exe.configResyncFrequency

    If no applicable settings are found in older configuration files or the values for these settings are blank, default values will be applied.

    Any other customizations to these files must be re-applied post-upgrade.


    1eli

    Restart the SLA Platform and AppClarity services if they're installed and being used.


    1eli

    Rebuild your Catalog data by resynchronizing at least one of the inventory connectors in your SLA Platform. Please refer to Rebuilding the 1E Catalog: Rebuilding your Catalog data.