Configuration profile concepts

The information for a profile is collected in XML files in the form of properties and values that describe the associated configuration and deployment tasks. You must provide values for the profile properties that are specific to each configuration at your site, such as the application server name.

The XML files are stored in a directory that is unique to a given profile. Because the profile name is used for both the directory name and the configuration file name, you must provide a profile name that is a valid directory name for your operating system. By default, the profiles are stored in the ../csgraphQLtool/configure/profiles directory.

If needed, you can create multiple profiles, each of which supports a unique CCX-GQL instance. These instances can be located on the same server or on different servers, depending on your deployment preferences, and your clustering or high-availability requirements.

Use IBM Content Cortex GraphQL Configuration and Deployment tool to perform the following tasks that are associated with a CCX-GQL configuration profile:

  • Set the application server properties. CCX-GQL is deployed as an application on the application server. You must specify the application server type, the software version number, the server name, the administrative username and password, and other settings. The application server type determines some of the properties and their default values. All profiles include the application server properties. By default, the application server properties are stored in the <csgql_installation_path>/csgraphQLtool/configure/profiles/myprofile/applicationserver.xml file, where myprofile is the name of your profile.
  • Update the Content Cortex Client Connector Files. When you install CCX-GQL, a version of the Content Engine client connector files is installed on the CCX-GQL application server. The version of the files on the CCX-GQL application server must match the version of Content Engine or Content Platform Engine that you are running.

    The CCX-GQL installation program includes information about the version of the Content Engine client connector files that are installed with CCX-GQL. This task is mandatory when you need to connect to Content Platform Engine server to download the client connector file (Jace.jar) and then use the file later to associate with traditional IBM WebSphere® Application Server shared library. This task downloads and installs the Jace.jar under ../<csgql_installation_path>/csgraphQLtool/configure/CE_API folder.

    If the version of the files that are installed with CCX-GQL do not match the version of the files on your Content Engine or Content Platform Engine server, this task returns a Version Mismatch error.

    By default, the Content Platform Engine connection information is stored in the <csgql_installation_path>/csgraphQLtool/configure/profiles/myprofile/downloadcejars.xml file, where myprofile is the name of your profile.

  • Configure Shared Library. Before you deploy the CCX-GQL application on traditional IBM WebSphere Application Server, the Jace.jar needs to be created as a shared library. Later, this shared library path is associated with the CCX-GQL application.
    Note: The Configure Shared library task is no longer a separate task in CDT. The downloaded Jace.jar file is configured as a shared library when you run the Deploy Application task.
  • (Optional) Import your Content Engine LTPA Keys. If the Content Cortex GraphQL application server and the Content Platform Engine server are on different traditional WebSphere Application Server instances, you must import your Content Platform Engine LTPA keys to the CCX-GQL application server to enable CCX-GQL to authenticate to the Content Platform Engine server.
    Note: You can skip this task:
    • If Content Platform Engine and Content Services GraphQL instances are co-located in the same WebSphere Application Server cell.
    • Or, if you have already imported your Content Engine LTPA keys to the traditional WebSphere Application Server instance that hosts CCX-GQL application.

    By default, the settings for importing the LTPA key are stored in the <csgql_installation_path>/csgraphQLtool/configure/profiles/myprofile/importltpakey.xml file, where myprofile is the name of your profile.

  • (Optional) Configure Content Cortex GraphQL LDAP Server. You need to ensure identical LDAP configuration between the traditional WebSphere Application Server CCX-GQL instance and the traditional WebSphere Application Server Content Platform Engine instance. The instances need to be configured to use federated and standalone LDAP repositories.
    Note: You can skip this task:
    • If Content Platform Engine and Content Services GraphQL instances are co-located in the same WebSphere Application Server cell.
    • Or, if you have already configured the LDAP settings in the traditional WebSphere Application Server instance that hosts CCX-GQL application.

    By default, the LDAP properties are stored in the <csgql_installation_path>/csgraphQLtool/configure/profiles/myprofile/configureldap.xml file, where myprofile is the name of your profile.

  • Deploy the CCX-GQL application instance. The CCX-GQL and the Content Platform Engine instances can be deployed within the same traditional WebSphere Application Server cell or on the same node. Each application needs to run in a distinct JVM, so they cannot share the traditional WebSphere Application Server instance. You can deploy a Content Cortex GraphQL Server instance on the traditional WebSphere Application Server in this task. Deploying makes the Content Cortex GraphQL application available for use. Any time that you update the properties for an existing deployed CCX-GQL instance, you must redeploy for the changes to take effect. By default, the deployment properties are stored in the <csgql_installation_path>/csgraphQLtool/configure/profiles/myprofile/deployapplication.xml file, where myprofile is the name of your profile.
  • Generating the configuration XML files for a CCX-GQL instance. The configuration XML files contain the properties and values for the various configuration tasks that are associated with a profile. From the command line, you can generate all of the XML files at the same time, or you can generate a single configuration XML file at a time.
  • Editing the configuration XML files for a CCX-GQL instance. You must edit the generated configuration XML files to provide the property values for your environment.
  • Running the configuration XML files. Running the configuration XML files applies the settings. From the command line, you can run all of the XML files at the same time, or you can run a single configuration XML file at a time.
  • Check the status of a particular configuration task. Status messages are displayed when you run a task. You can also explicitly display the task status any time after you run the task. See Checking the completion status of CCX-GQL configuration tasks for details.