Publishing Scientific Data Management System with Citrix App Layering

by Mani Kumar, CTA & Bay Area CUGC Leader

Creation of OS Layer using Windows Server
Creation of Platform Layer with Hyper-V
Creation of Application Layer for SDMS
Creation of Machine Template for SDMS
Creation of Machine Catalog from Citrix Studio
Creation of Delivery Group from Citrix Studio

1. Creation of OS Layer Using Windows Server

The Operating System Layer consists solely of the basic operating system (along with patches) and VMware Tools. Platform and Application Layers are often where other components are deployed. For any Windows OS, only one OS layer is required. If you support both a Windows desktop OS and a Windows Server OS, for example, establish a separate OS layer for each. The OS layer you use is required by the platform and app layers you create.

When one of the OS layers is updated, the platform and app layers developed with that OS continue to run. Ideally, you should develop a single generic OS layer and use it in all of your layered graphics. Because App and Platform layers only interact with the OS layer that created them, layer maintenance is kept to a minimum. If you need to support both a desktop and a server operating system, this is the way to go. You only need to run Windows Updates on the OS Layer if you install .NET Frameworks in the OS Layer. Office, on the other hand, should always be installed as an Application Layer.

An OS Layer is used to generate the other layers (Platform and Application). These layers are tied to a single OS layer and can’t be utilized on any other. You might have to recreate the Platform Layer if you upgrade the hypervisor tools in the OS Layer.
Any program (such as XenApp 6.5) that creates local users should be put in the OS Layer. Changes to local groups or users are not captured by the Platform Layer or Application Layer.

Before creating the OS Layer, ensure the server has NOT been joined to a domain:

You can download Citrix app layer machine tools from https://www.citrix.com/downloads and install the Citrix App Layering 2102 OS Machine Tools.

The Citrix Optimizer is a Windows application that assists Citrix administrators in optimizing several components of their environment, most notably the operating system with Virtual Delivery Agent (VDA). The program is built on PowerShell, but it also has a graphical user interface.

Citrix Optimizer has three modes of operation:

Analyze: compare the present system to a template and highlight any differences.
Execute (available only in PowerShell mode): apply the template’s optimizations
Rollback (available only in PowerShell mode: revert the previously applied optimization adjustments

Right click on Citrix Optimizer and “Run as administrator.” Disable the unused services using the Citrix Optimizer tool.

In the Citrix Optimizer tool, click on Windows Server 2016, as shown on the example below:

Click the checkbox for “ Select all“ then click “Analyze” as shown in the example below:

When the analysis has completed, click on “Optimize.”

When optimization has completed, switch back to main console as shown below:

In the right-hand template panel, select App Layering Supplement.

Choose the “Select All” check box, then click “Analyze.”

The completed analyses will show most or all the settings as “not optimized.” Click on “Done.”

Click on “Optimize.”

Once the optimization is completed, click “Done.”

Using File Explorer, navigate to: C:\Windows\Setup\Scripts, and scroll down to setup_x64.exe, right-click and select “Run as administrator.”

On the Citrix App Layering Image Preparation Utility window, click “Next.”

On “Specify your answer file” page, leave the defaults and click “Next.”

Click “Finish” to exit the installer.

Shutdown the host.

Copy the VHDX file from the hypervisor storage and paste to the app layering share. (Right-click on vhdx hard disk image file and select Copy.)

Navigate to the app layering console and create the OS Layer. (In the Citrix App Layering console, select the Layers menu on the top left and then select the OS Layers tab.)

Click on “Create OS Layer” as shown below:

Provide the layer details as shown below:

On the connector details page in the create OS Layer Wizard, leave the defaults and click the down arrow to continue.

On the OS disk details page in the Create OS Layer Wizard, click on “Browse.” In the “Choose a disk to import” dialog box, expand the location by clicking on the + icon and select .vhdx. Click “Choose.”

Verify the OS Disk:

On the Icon Assignment page, select the disk icon and click the down arrow to continue.

Click on the Confirm and Complete page, then click on “Create Layer.”

Validate the task progress. On the task section at the bottom of the window, click the Up Arrow to pull up the event viewer.

Click the information icon next to the running task, or double-click anywhere in the task line for more details.

Monitor the task progress and wait for it to complete.

Validate that the status changes to “done,” after the OS disk is imported. Click the X to close the task details pane.

Verify that the Windows Server icon is now labeled as “Deployable.”

Verify Windows Server icon is Deployable

2. Creation of Platform Layer with Hyper-V

First of all we need to install the AppLayering Agent to Hypervisor, GoTo Hypervisor and install the agent so that agent can communicate with ELM Server to create the VMs.
Right-click citrix_app_layering_agent_installer.exe, then click Run as administrator.

In the Citrix App Layering Agent wizard, click “Next.”

On the License Agreement screen, review the terms. If you agree, select “I accept the terms in the license agreement,” then click “Next.”

On the Agent Port screen, leave the default value, then click “Next.”

On the Ready to Install the Program screen, click “Install.”

On the “Register the agent with an Enterprise Layer Manager” screen, enter the ELM Server details and click on “Register.”

On the Install Shield Wizard Completed screen, click “Finish.”

Now open the ELM console and From the System menu on the top left, select the Connectors tab.

From the Actions menu on the right, select “Add Connector Config.”

In the Choose a Connector Type window, click on the drop-down arrow and select Microsoft Hyper-V, and select “New.”

On the Hyper-V Connector page, enter the hypervisor information and Click on Check credentials to verify the connection.

Wait for the message that reads “The username and password have been verified.”

In the Virtual Machine Settings section, type Platform layer machine details and select the network.

Now enter the storage details.

Click on TEST and wait for the message that reads, “The settings have all been verified.” Click on SAVE, then click CLOSE.

Back on the Connectors page, verify that the Hyper-V Connector is visible.

Now go to the Layer section and select the Platform Layers tab and click on Create Platform Layer.

Enter the details of Platform Layer and Click on Drop Down Arrow.

On the OS layer pane, verify the OS Layer of Windows 2016 which we have created earlier, now click on the Down Arrow.

Now on the Connector pane, select the Hypervisor and click on Down Arrow.

Now on the Platform type pane choose the Hypervisor, Provisioning Services and Connection broker details, as shown here:

On the Packaging Disk page, leave defaults and click the Down Arrow to continue.

On the Icon Assignment page, select the disk icon and click the Down Arrow to continue.

On the Confirm and Complete page, review the settings and click Create Layer.

Validate the task progress, click on UP Side Arrow Icon.

Click the information icon next to the running task for more details. Monitor the task progress and wait for it to complete, Wait for the status to change to Action Required.

At this stage, the Platform Layer Icon: PLF Layer Win Server 2016 is in Editing state.

Now Verify if the Platform Layer Packaging machine is created on Hypervisor.

Now Login to the Platform Layer Packaging VM and Install the VDA.

Now select the Virtual Delivery agent for multi session OS.

On the Environment screen, confirm that Create a master MCS image is selected and click Next.

Now on Core Component page leave default and click on Next.

Now on the Additional Components page, select Citrix Profile manager and WMI Plugin and click Next.

Now on Delivery Controller page, enter the Broker Server, click on test connection and click on Next.

Now on the Features page select the features and click Next.

On the Firewall page, verify that the “Automatically” option is selected for configuring the firewall rules. Click Next.

Now click on Install.

Click on Restart Machine and Finish and wait for the machine to restart. Once started, log in to Platform Layer Packaging VM and Verify the VDA install status under the application wizard.

Now press Win+R and type Sysdm.cpl and hit Enter.

Now enter the domain and click OK. It will prompt for Admin Credentials, so enter the domain admin credentials and click OK again.

On the Computer Name/Domain Changes notification window, click OK.

Now click on Restart so that changes will take place. Once restarted, verify if machine joined with domain.

Double-click Shutdown for Finalize icon on the desktop.

Now login on ELM console and goto Platform layer and right click on Platform Layer and Finalize.

On the Finalize Layer Wizard, click Finalize.

Validate the task progress. On the task section at the bottom of the window, click the Up Arrow to pull the event viewer. Monitor the task progress and wait for it to complete.

After the layer finalization process has completed, click X to close the event information details, Validate that the status of the Platform layer now shows as Deployable.

3. Creation of Application Layer for SDMS

Now Open the ELM Server Console.
From the Layers menu on the top left, select the App Layers tab.

From the Actions menu on the right, select Create App Layer.

On the Layer Details page in the Create App Layer Wizard, enter the App Layer Information, and click on Down Arrow to continue.

On the OS layer page, select the OS which we have created earlier and click on Down Arrow to continue.

On Prerequisite Layers, leave the default setting. Click the Down Arrow to continue.

On the Connector page, select the connector. Click Down Arrow to continue.

On the Platform Layer, leave the default values. Click the Down Arrow to continue.

On the Packaging Disk, leave the default values. Click the Down Arrow to continue.

On Icon Assignment page, select the disk icon. Click the Down Arrow to continue.

On the Confirm and Complete page, review the settings and click Create Layer.

In the Tasks menu at the bottom monitor the state of the currently running task. Click the information icon for more details.

Monitor the task progress and wait for the status to change to Action Required. ( It will take approx. 20-30 mins).

Now Switch to Hypervisor and you will see a new virtual machine look like SDMS-Date-Time. Right-click the new VM in Hyper-V, then select Connect to this machine. From the Action menu, select the Ctrl+Alt+Delete option and log on with the credentials:

Let’s start the installation of Waters Oracle Client. Select NuGenesis 8 Base Madia Kit, Select Nugenisis Oracle client as below:

Install, Oracle 11g client as below:

Install NuGenesis SDMS client component as below:

Install NuGenesis 8 SDMS Oracle client.

Now Click next on Oracle Client 11g.

On the license agreement page, Accept the agreement by clicking on Yes.

Now Provide the Company and Username and Click next.

Select the Language as English and click Next.

Now on Choose Destination page, leave defaults and click Next.

On the Start Copying file, click on Next.

On the page of Enter Oracle Server Host Name or IP Address, put the hostname and click Next.

Now provide the Oracle Service Name and click Next.

Now it will ask for Restart so click on “Yes, I want to restart my computer now” and click on Finish. As shown below:

Once Restarted, start the installation of NuGenesis SDMS Administrator Installation, click Next:

On the license agreement page, accept the license by clicking Yes.

On the Customer Information page, enter the User Name and Company Name, and click Next.

On the Language Options page, select the English and click Next.

On The Choose Destination Location, leave defaults and click Next.

On the page of Choose Temporary Storage Location, leave defaults and click on Next.

On the Start Copying Files, click Next.

Now on The Select Program Folder choose the existing folder named Accessibility and click on Next.

On the Start Copying file, click Next.

Now it will prompt for Language, select the language click OK.

Wait for completion of installation.

It will prompt for Data Adapter Package, will Install Separately. Click on OK.

On the TEMP Drive Space Warning, click Next.

Now finish the installation.

Now install the NuGenesis SDMS data adapter, now open the folder and click on Setup.exe.

Now on NeGenesis SDMS Data Adapter page click on Install SDMS 8 Data Adapters.

On the License Agreement page, accept the license by clicking on the Accept button.

Select the features Select Data Capture and click Next.

Select the Packages and click Next to continue.

Once all the packages are installed, click Next to continue.

Now on the Waters Data Adapter Configuration page, click on the dropdown menu and select the Dionex Chromeleon Data Adapter v6.5 and click Ok.

Now on the Waters Data Adapter Configuration page. click on the dropdown menu and select the Empower-3 Data Adapter and click Ok.

Now on the NeGenesis SDMS Adapter Install Engine v8.0, click on Finish as the installation has completed.

Now run the setup again and accept the License agreement by clicking on Accept.

Select the Data Conversation Feature and click on Next.

Select the Waters Corp. Sci-Data Converter and click on Install button.

On the Install/ Uninstall Action pending page, leave defaults and click on Install.

Once it’s done, click Finish.

Now accept the license agreement by clicking on the Accept button.

Now select the data store feature and click Next.

Now leave default values and click on Install.

Once it’s done, click Finish.

Installation for SDMS Audit Reports. Now go to NuGenesis LMS Client application .exe file double click on that and On Install Shield Wizard, click on Next to continue.

Now Accept the license agreement and click Next to continue.

Select the features and click Next to continue.

On the Start Copying page click Next to continue.

Wait for setup process to finish.

On the NuGenesis LMS SDMS Transfer Application, click Next to continue.

Accept the License agreement by clicking Yes.

On the Customer Information page, click Next to continue.

Now on the Language Information page, select language as English and click Next to continue.

On the Existing NuGensis Installation Found page it will look for existing file information. Now click Next to continue.

Now on Choose Temporary Storage Location, select defaults and click Next.

On The InSpector Installation, select the Install InSpector checkbox and click Next to continue.

On the Start Copying file, click Next.

Now wait for Setup to complete.

Select the Language and click OK.

Wait for Installation to complete.

Now on NuGenesis LMS SDMS SDK Runtime, click Next to continue.

Accept the License by clicking Yes.

On The Customer Information page, click Next to continue.

On the Existing NuGenesis Installation page it will look for existing directory, click Next to continue.

On the Start Copying Files page, click Next to continue.

On the Setup Status wait for Process to be completed.

Accept the license Agreement by clicking Yes.

On the Choose Destination Location, leave defaults and click Next to continue.

On the UNIFY Web Remote Server Config File Location, select Default and click on Next and wait for installation to finish.

On SR2 Installation, Click on Setup File and on the NuGenesis LMS SDMS Software Development Kit click on OK.

Accept the License Agreement by clicking Yes.

On Customer Information page, click Next to continue.

Select the Components and click Next.

On The Existing NuGenesis SDK setup click Next.

On the Start Copying File, select Next to continue and wait for installation to be completed.

Once All the SDMS Components are installed, then goto the Applayer Wizard and Seal the Layer.
- Inside the VM console window, scroll down to the bottom of the screen.
- Right-click Start menu > Shut down or sign out > Restart.

Once started, login to AppLayer Machine and double-click Shutdown For Finalize icon on the desktop.

Now login to the ELM Console and Right Click and Finalize.

On the Script path page in Finalize Layer Wizard, click the Down Arrow.

On the Confirm and Complete page, click Finalize.

Validate that the status of the App Layer now shows as Deployable.

4. Creation of Machine Template for SDMS

Now logon on ELM/App Layering Console.
In the top-left pane, select the Images menu.

From the Actions menu on the right, select Create Template.

Now Provide the Name and Description page. In the Choose section, select the disk icon, then click the Down Arrow to continue.

Now Select the OS Layer and Click the Down Arrow to continue.

On the Application Assignment page, select the box next to SDMS, turning it green. Click the Down Arrow to continue

On the Connector page, select Microsoft Hyper-V – NYC-Hyper-V. Click the Down Arrow to continue.

On the Platform Layer, select PLF Layer Win Srv 2016 – 1. Click the Down Arrow to continue

On the Confirm and Complete page, click Create Template.

Verify that the Windows Server 2016 SDMS template is labelled as Publishable.

Right-click the Windows Server 2016 SDMS template and select Publish Layered Image.

On Confirm and Complete page on Publish Layered Image Wizard, click Publish Layered Image, and wait for process to be completed.

5. Creation of Machine Catalog from Citrix Studio

Go to Studio Console and click on Machine Catalog in left pane.

On the right pane, click Create Machine Catalog.

On the Introduction page, click Next to continue the Machine Catalog creation wizard.

On the Operating System page, select Server OS and then click Next to continue the Machine Catalog creation wizard.

On the Machine Management page, verify that the following options are selected:
- Machines that are power managed (for example, virtual machines or blade PCs)
- Citrix Machine Creation Services (MCS)
- Click Next to continue the Machine Catalog creation wizard.