Install components

This article explains what Semarchy xDI components are, and how to manage them from Designer.

Overview

In Semarchy xDI, a component is a package that contains the resources needed to work with a given technology. Some components are installed by default, while others need to be installed.

A component may contain resources such as these:

  • Technology definitions

  • Metadata definitions

  • Templates

  • Modules

  • Sample projects

Components may also require a specific license to use. You can install components not included in your xDI license, but they are not usable unless your license allows it.

For more details, and the full list of available components, refer to the component documentation section.

Install components

To install components, or install an update to a component, follow these steps:

  1. Open the Help menu, and go to Help  Install New Software to open the Install dialog.

  2. In the Work with drop-down list, select an update site serving the components. The primary entry usually follows the naming convention https://download-xdi.semarchy.com/components/<version_number>/.

  3. Wait for the list of components to refresh.

  4. Select the components that you want to install, and click Next.

  5. Review the list of components to install, and click Next.

  6. Review and accept the license terms that appear, and click Finish.

  7. Wait for the install process to finish.

  8. Restart Designer at the prompt to finish the installation.

Install from your own file or repository

If you host components yourself, you can install them from your own source. Follow these steps:

  1. Follow the previous instructions to open the Install dialog.

  2. Click the Add button next the Work with drop-down list to open the Add Repository dialog.

  3. In the Add Repository dialog, add your source:

    1. If your source is a local ZIP or JAR file, click on the Archive…​ button. Find and select the file, and click the Open button.

    2. If your source is a directory, click on the Local…​ button. Find and select the directory, and click the Select Folder button.

    3. If your source is a URL, enter it in the Location field.

  4. Click the Add button to add your source and return to the Install dialog.

  5. Wait for the list of components to refresh, and continue the installation.

Review installed components

To see what components are installed in Designer, open the Installation Details dialog:

  1. Open the Help menu, and go to Help  About Semarchy xDI Designer to open the About dialog.

  2. Click on the Installation Details button to open the Installation Details window.

This window shows all installed Designer features. Installed components are labeled with Component, and show other ones they may depend on.

From that dialog, you can also selectively uninstall Components.

Uninstall components

To uninstall a component from Designer, follow these instructions:

  1. Open the Installation Details window, as in the instructions to review installed components.

  2. Select one more components to uninstall, then click on the Uninstall…​ button. The Uninstall window opens..

  3. Click the Finish button to confirm your selection.

  4. Wait for the uninstall process to finish.

  5. Restart Designer at the prompt to finish the uninstallation.

Component updates

To update a component, install a later version.

If you install a component to update an existing one, Install and manage modules using the component update their internal resources automatically. However, you must update any third-party libraries you added yourself.