Set Up Deployments Using Oracle GoldenGate Studio Configuration Assistant Wizard

Run the GoldenGate Studio Configuration Assistant wizard to set up and access GoldenGate Studio deployments. Perform the following steps to start the wizard and configure the deployment credentials and security:

Note:

You must have Java version 24 or higher installed on your system.
  1. Update the PATH environment variable to use JDK 24: 
    export PATH=$JAVA_HOME/bin:$PATH

    The PATH environment variable is required to run Java commands such as java, javac using the supported JDK package.

  2. From the GoldenGate Studio installation home directory, navigate to the bin directory.

    For example: cd /u01/app/oggstudio/bin

  3. Run ./oggstudioca.sh. This opens the Oracle GoldenGate Studio Configuration Assistant wizard.
  4. On the Administrator Account Credentials screen, specify the Username and Password for your deployment user account, as shown in the following image.


    Administrator Account credentials with strong password policy enabled.

    Use these credentials to log in to Oracle GoldenGate Studio for the first time

    The strong password policy is enabled by default. It's recommended that you use a strong password for your administrator account. The criteria for a strong password includes:
    • 1 uppercase letter (A - Z)
    • 1 lowercase letter (a -z)
    • 1 digit (0 - 9)
    • 1 special character (- ! @ % & * . # _)
    • Password length must be between 8 and 30 characters

    If you need to change the credentials after the deployment setup completes, you can run the setPassword.sh script to modify the credentials of the Administrator Account user. This script is located in the bin directory of the GoldenGate Studio home directory ($STUDIO_HOME). Here are the steps to run this script:

    1. When you run the script, it asks for the existing user name of the Administrator Account. Specify the user name and press enter.

    2. Now, specify the new password for the specified user. The scripts prompts you to confirm the password. After the new password matches, the system displays the following message: 
      The studio.conf file updated successfully.

    Now, you will be able to use the new password to log in to the GoldenGate Studio user interface.

  5. On the Specify Security Options screen, specify a Listening Port Number on which GoldenGate Studio will run.

    Note:

    By default, the Listening Port for the deployment is 8443. You can use different port also.


    Security options configured in the Specify Security Options screen of the GoldenGate Studio Configuration Wizard

  6. GoldenGate Studio allows you to use self-signed certificates or .pem files for authentication.

    If you choose Self-Signed Certificates, then GoldenGate Studio automatically generates a self-signed SSL certificate. This option is useful in a non-production environment where a trusted CA certificate is not required.

    If you choose Upload Custom PEM Files, complete the following fields:
    1. Certificate: This is the public certificate with a .pem extension that will be used to identify the server to clients. Browse and select the certificate file.
    2. Private Key: Browse and select the private key for the certificate.
    3. CA Certificate File: This file contains the certificate(s) of the Certificate Authority (CA) that signed the server/client certificate. The CA file is used to verify that the server certificate is trusted.
    4. Private Key Password: Enter the password for the private key that must be available with the private key file.

    This option is best suited for production environments where an official SSL certificate issued by a trusted CA.

  7. Click Next.
  8. On the Summary screen, review the values that you provided in the previous screens and save the response file to a location of your choice. Click Finish to begin the configuration process.

    The Configure screen shows the progress of the configuration process. After the process completes successfully, it displays the Complete screen, where you can copy the web URL of the GoldenGate Studio.


    GoldenGate Studio Configuration Assistant wizard successfully configures the listening port and displays the web URL required to access the GoldenGate Studio web interface. The format of URL is: https://<hostname>:<port>.

Connect to the GoldenGate Studio User Interface

Connect to the GoldenGate Studio user interface after the GoldenGate Configuration Assistant Wizard completes to verify your installation.

Use the URL generated by the GoldenGate Studio Configuration Assistant Wizard to access the GoldenGate Studio user interface.

To open GoldenGate Studio:

  1. In your web browser, enter the deployment URL generated by the GoldenGate Studio Configuration Assistant Wizard. The GoldenGate Studio login page is displayed.
  2. Enter the Administrater Account login credentials you created while setting up the deployment in theGoldenGate Studio Configuration Assistant Wizard. If your log in is successful, you're brought to the GoldenGate Studio Home page.
  3. On the GoldenGate Studio Home page, you can learn more about the product using the help options, or register a deployment to get started.

Stop/Restart the GoldenGate Studio Server

You can stop and restart the GoldenGate Studio server using the runstudio.sh script, located in the $STUDIO_HOME/bin directory.

To stop GoldenGate Studio server instance, run the following command:
./run-studio.sh stop
To restart the GoldenGate Studio server instance, run the command:
./run-studio.sh