Browsing the Project Repository

You can browse and edit files in the project repository using an FTP client. Most standard FTP clients that support UTF-8 character encoding are compatible.

Caution: Making changes to the folders, files, or file content directly in the ProjRep directory, not via an FTP client, will cause irreversible damage to the project repository.

Verified FTP clients

The following clients are verified:

  • Filezilla

  • Total Commander Built-in FTP client

  • FlashFXP

Back to top

Considerations before editing files via FTP clients

When making changes to repository files via an FTP client, consider the following:

  • It is safe to edit repository files via an FTP client. This will not damage the integrity of the optimized repository.

  • Deleting a file will result in missing content in ALM entities.

  • Renaming folders and files may result in missing content in ALM entities.

Back to top

Browse the project repository

  1. Start the FTP service. Add and configure the FTP_PORT parameter in the Site Configuration tab. For details, see Setting ALM Configuration Parameters.

  2. Connect to the FTP server. In an FTP client, use the following connection values:

    Field

    Value

    Host

    The name or IP of the ALM server to which you want to connect.

    Port

    The FTP port. This should be the same value that you used for the FTP_PORT site parameter.

    User

    The username or API key of an ALM site administrator.

    In SSO mode, you can only enter API key.

    Password

    If you use username in the User field, enter the password of the ALM site administrator.

    If you use API key in the User field, enter the API key secret of the ALM site administrator.

  3. Browse and edit repository files. After you connect to the FTP service, a list of the site domains is displayed. Select a domain, and then select a project. The FTP client displays the project repository directories.

Back to top

Enable secure FTP connections

You can connect to the FTP server using a secure connection.

To enable a secure FTP connection:

  1. On the ALM server machine, generate a keystore a key file. Using the command line, go to <ALM installation path>\java\bin.

    To generate a keystore file, type:

    keytool -genkey -keyalg RSA -alias client -keystore client.keystore -storepass changeit -storetype jks

    To generate a key file, type:

    keytool -certreq -alias client -keyalg RSA -file client.csr -keystore client.keystore

    Note that client and changeit are used as examples.

  2. Create an XML file, using the following format:

                                    <ssl>                          
                                    <keystore file="<keystore file path>" password="<keystore password>"/>                            
                                    </ssl>
                                

    where <keystore file path> is the directory and file name of the keystore file, and <keystore password> is the password you defined for the keystore.

    Save the XML file as sslkeystore.xml.

  3. Place the sslkeystore.xml file in the following directory: C:\ProgramData\Micro Focus\ALM\webapps\qcbin.

  4. Reconfigure the FTP_PORT site parameter.

  5. Restart the FTP server by restarting the ALM service.
  6. In the FTP client, select the FTPS or SSL option. If you are using FileZilla, go to File > Site Manager and click New Site. For Protocol, select FTP-File Transfer Protocol, and for Encryption, select Require implicit FTP over TLs, and click connect.

Back to top