Configuring the Content Services GraphQL API

You can configure and deploy all of your CSGQL instances with the CSGQL Configuration and Deployment Tool. The CSGQL Configuration and Deployment Tool prepares the CSGQL application for deployment on the application server. A single CSGQL application instance equates to one deployed application on your application server.

About this task

Configuration is a multiple step process. You must provide information about your CSGQL application environment, apply the settings by running the configuration tasks, and deploy the application. You can configure multiple instances before you deploy any of them, or you can configure and deploy one instance at a time. 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.

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.

You must provide values for the profile properties that are specific to each configuration at your site, such as the application server name.

You use the CSGQL Configuration and Deployment Tool to define the following information for the CSGQL instance:
Update the FileNet® P8 Client Connector Files
When you install CSGQL, a version of the Content Engine client connector files is installed on the CSGQL application server. The version of the files on the CSGQL application server must match the version of Content Engine or Content Platform Engine that you are running.

The CSGQL installation program includes information about the version of the Content Engine client connector files that are installed with CSGQL. 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 ../CEClient/csgraphQLtool/configure/CE_API folder.

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

(Optional) Configure Shared Library
For a standard traditional IBM WebSphere Application Server deployment, the downloaded Jace.jar file is configured as a shared library before you deploy the Content Services GraphQL 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 Services 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 CSGQL application server to enable CSGQL 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 CSGQL application.
(Optional) Configure Content Services GraphQL LDAP Server
You need to ensure identical LDAP configuration between the traditional WebSphere Application Server CSGQL instance and the traditional WebSphere Application Server Content Platform Engine instance. The instances need to be configured to use federated and standalone LDAP repositories.

For more information about the configuration of directory services for Content Platform Engine in traditional WebSphere Application Server, see Configuring Content Platform Engine application server authentication (LDAP) settings.

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 CSGQL application.
Deploy the CSGQL application instance
The CSGQL 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 Services GraphQL Server instance on the traditional WebSphere Application Server in this task. Deploying makes the Content Services GraphQL application available for use.
Remember the following points when you prepare to configure CSGQL:
  • You can use the CSGQL Configuration and Deployment Tool to configure and deploy the CSGQL software only if the CSGQL Configuration and Deployment Tool is running with the same application server.
  • For best results, configure no more than one CSGQL application instance in a WebSphere profile.
  • CSGQL Configuration and Deployment Tool can connect to a remote WebSphere Application Server stand-alone server or Network Deployment Manager if a matching WebSphere Application Server installation is available where CSGQL Configuration and Deployment Tool runs.
  • If you need an accessible software version of CSGQL Configuration and Deployment Tool for people with disabilities, use the command-line version of Configuration and Deployment Tool.
  • To upgrade and configure your upgraded CSGQL instances, see topic Upgrading the Content Services GraphQL application.