A software development kit (SDK) is a collection of software utilities and tools programmers use to develop custom applications for specified platforms. SDKs include a compiler, a debugger, and application programming interfaces.

The EGL software development kit (SDK) is a feature that allows generating output in a batch environment, and it contains a set of tools that developers can use to build applications without having to develop code from scratch.

To invoke the EGL SDK, we can use the command EGLSDK in a batch file or the command prompt. The command calls can be one of two forms:

• By specifying an EGL file and build descriptor, we need to write multiple commands for multiple generations.
• By appertaining an EGL command file that includes the information necessary for one or more generations.

Steps to create and deploy Rich UI project :

Step-1: Create an RUI project with an RUI widget.

Follow the below steps to create an RUI project:

1. Navigate to File-->New-->EGL project.

2. EGL Project window will appear.

3. Enter the Project name.

4. Select the Rich UI Project option.

6. click Next and then Finish.

7. Right-click the EGL source in the Rich UI project.

8. Go to New-->Rich UI Handler.

9. Enter the Package name and Handler name.

10. Click Finish.

11. Handler is created successfully.

Step-2: Specify the below values for eglpath (For reference - EGLSDK varbles.txt)

Path parameter :

C:\Program Files\IBM\IBMIMShared\plugins\com.ibm.etools.egl.batchgeneration_latest_version\runtime\eglbatchgen.jar

C:\Program Files\IBM\SDP961\bin\EGLSDK

Class path:

C:\Program Files\IBM\SDP961\plugins\org.eclipse.equinox.launcher_lastest_version.jar

C:\Program Files\IBM\IBMIMShared\plugins\com.ibm.etools.egl.batchgeneration_latest_version\runtime\eglbatchgen.jar

Step-3: Specify the build descriptor option genDirectory.

Note: The genDirectory option should be specified on both the RUI project and the RUI widget Build Descriptor.

Step-4: Verify the Java EGLSDK connection.

Follow the below steps to verify the Java EGLSDK connection:

1. Go to the search bar and type system environmental variables.

2. Select and open environmental variable.

3. Verify Whether class and path variables are added.

Note: If variables are not added, repeat Step-2 to add variables.

4. Open the command prompt and type java EGLSDK command to generate the SDK file.

Step-5: Create a target project for deployment.

Follow the below steps to create a target project for deployment:

1. Double-click egldd(deployment descriptor).

2. Click the Overview tab and then New.

3. Enter the Project name.

4. Select Add project to an EAR checkbox.

5. Click Finish.

Note: The target project should be specified on the RUI widget Deployment Descriptor.

Step-6:

A. Generation process & Create a Command File.

Follow the below steps for the Generation process and creating a Command File:

1. Select and right-click the RUI and Widget files.

2. Select Generate with Wizard.

3. Generate window will appear.

4. Click Next.

5. Browse the required EGL Command File location.

6. Click Finish.

Note: The location specified should be the RBD workspace where the EGLSDK project was created.

B. For verification:

1. Open the File Explorer

2. Navigate to the Location & Check Command file created under the project.

Step-7: Generate the Command File from the prompt.

Follow the below steps to generate the command file:

1. Go to the command file created directory "${workspace}.”

2. Type cmd.

3. Give Java EGLSDK "Command file name" (e.g., java EGLSDK "commandfile1.xml" ) and press Enter Key.

4. The code has been generated successfully.

Step-8: Deployment process

Follow the below steps for the deployment process:

1. Go to the command file created directory "${workspace}"

2. Type CMD

3. Enter java EGLSDK deploy -genDirectory "${workspace}\gen" -targetDirectory "${workspace}" -deploymentDescriptorFile "${workspace}\RUIProject\EGLSource\RUIProject.egldd" -sourceDirectories "${workspace}\RUIProject;${workspace}\com.ibm.egl.rui_4.3.6" -javaRuntimeDirectory "C:\Program Files\ibm\IBMIMShared\plugins\com.ibm.etools.egl.java.runtime-newversion" -javascriptRuntimeDirectory  "C:\Program Files\ibm\IBMIMShared\plugins\com.ibm.etools.egl.rui_new_version"

4. Go to the workspace location (C:\Users\User_name\IBM\rationalsdp1\EGLSDK2023)

5. Click on the target file (target1)

6. Select the web content folder

7. Right-click the “ruihandlers-en_US.html”

8. Select Open with Google Chrome.

This way, the Deployment of the RUI widget is successful. It also helps in the continuous enhancement of the product.

Dionne A Nerissa

QA - Senior Software Engineer