The Semarchy xDM architecture includes the following components:
A web browser. The Application Builder and data steward applications run in a browser such as Google Chrome, Firefox, Safari or Microsoft Edge.
A Java EE Application Server (Tomcat, Oracle WebLogic, Glassfish, etc) running the Semarchy xDM Application.
A database instance (Oracle, PostgreSQL or SQL Server) containing the Repository (where xDM stores its metadata) and one or more data locations (where xDM stores your organization's data).
xDM on AWS Marketplace is launched as a single AWS EC2 Instance, containing a pre-configured PostgreSQL Database with ready-to-use schemas for the repository and the data locations. It also starts up a Tomcat application server where the Semarchy xDM application is already installed and configured.
While xDM on AWS Marketplace is perfect for completing tutorials, it is not suitable for production.
An xDM production environment on AWS should normally use the Amazon Relational Database Service (RDS). The benefits of using RDS include resizable capacity and automated DBA tasks, such as backups and patching.
A Key Pair is required to create the EC2 Instance running xDM. In this step, we will create this key pair.
☆ For Advanced Users
If you already have a key pair defined in your AWS account, you can skip this task and move on to the next section, Launch an xDM Instance.
Why a Key Pair?
You use a key pair to establish secure connections to the EC2 Instance in order to:
Issue operating system commands using Secure Shell (SSH).
Issue database commands to the PostgreSQL database, using a database connections over SSH.
For the purposes of following the Semarchy tutorials, you are unlikely to need to SSH into the EC2 machine.. However, AWS requires you to choose a key pair to associated with your EC2 server, which is why we are going through the process of creating one so that you can launch the Semarchy AMI on AWS Marketplace in the next section of this tutorial.
Furthermore, the key pair allows secure connections so it is handy to have in case you want to use SSH with the EC2 machine the future.
In the navigation pane, under NETWORK & SECURITY, select Key Pairs.
Click the Create Key Pair button.
Give a Name to identify your key pair, and then click Create.
The key pair is created. The private key file is downloaded, and the key pair should appear now in the list of key pairs in the EC2 Management Console.
Semarchy xDM is available as a standalone Amazon Machine Image (AMI) in the AWS Marketplace. In this step, we will create an EC2 Instance from this AMI.
This section explains how to launch an EC2 instance and configure your networking options appropriately.
☆ For Advanced Users
You must launch an EC2 instance based on the Semarchy AMI.
You must open port 80 to access xDM.
You may open port 22 to have SSH access.
If you're familiar with the AWS console, you are welcome to launch this instance from the standard AWS console rather than from the AWS Marketplace Wizard. Then proceed to the next step, Connect to xDM.
Find xDM on AWS Marketplace
First, find the Semarchy xDM product in the AWS Marketplace:
Click the button below to navigate to AWS Marketplace. xDM on AWS
Click the Continue to Subscribe button on the right side.
On the page Subscribe to this software, review the Terms and Conditions and then click the button Continue to Configuration.
Select the Version and Region
On the page Configure this software, make your selections then click the button Continue to Launch.
Configure and Launch the Instance
On the page Launch this Software, choose the action "Launch from Website".
Make relevant selections for the rest of the networking options. Note: If you create a new Security Group based on seller settings, the wizard will open port 80.
In the Security Group Settings, click the Create New Based on Seller Settings button.
Provide a Name and a Description for your security group.
Configure the HTTP Connection method. We recommend selecting My Ip in the Source (IP of Group) field, which limits HTTP connections to your location only.
In the Key Pair Settings, select the key pair that you previously created.
Review your configuration and click the Launch button to start the new instance:
Click the link EC2 Console to open the list of instances in the EC2 Management Console.
Check that Instance is Started
The new instance is visible, in a Running Instance State.
As a best practise, change the instance Name. Provide a meaningful name for the instance.
Well done. You should now have a running EC2 instance built from the Semarchy AMI, which contains a pre-installed Tomcat instance, a preconfigured PostgreSQL with appropriate schemas, and the latest version of Semarchy xDM.
In the next step, you will learn how to connect to xDM and log in.
Now that the instance is running, you can access Semarchy xDM. Browse to the relevant IP address or hostname and log in as "semadmin". Follow the detailed steps below.
In the navigation pane, under INSTANCES, select Instances.
Select your instance.
In the Details pane at the bottom of the page, take note of the values for the Public DNS (IPv4) and Instance ID fields.
The Public DNS is the machine address on the Internet. Due to the Security Group that you configured when you launched that instance, this address may only be accessed from your own IP address.
The Instance ID is set as the default password for all the user logins (semadmin, businessuser, datasteward, etc) that you will use during the tutorials to connect xDM. Note that this Instance ID is only visible from the EC2 Console.
Copy the Public DNS (IPv4) and paste it in the URL of a new browser tab. The browser opens the xDM welcome page. You should bookmark it.
On the welcome page, scroll down and click the LOGIN button at the bottom of the Start Here card.