IBM Analytics Content Hub

https://www.ibm.com/docs/en/bae/ach
Admin
IBM Analytics Content Hub is an enterprise analytics platform that provides data management,...
Tokens:73,480
Snippets:913
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Run Installer Script (Bash)

Source: https://www.ibm.com/docs/en/bae/ach/2.3_topic=23-upgrading-analytics-content-hub-release-linux

Executes the installer script for IBM Analytics Content Hub. This script guides the user through the installation process.

```bash
./setup.sh
```

--------------------------------

### Start Older PostgreSQL Server (Shell Script)

Source: https://www.ibm.com/docs/en/bae/ach/2.3_topic=23-upgrading-analytics-content-hub-release-linux

Starts the older PostgreSQL server, likely a bundled or local instance, as part of the migration process. This might be a temporary step before fully migrating to the new instance.

```bash
./postgres.sh -start
```

--------------------------------

### PostgreSQL Initialization Error Example

Source: https://www.ibm.com/docs/en/bae/ach/2.4_topic=troubleshooting-postgresql-database-fails-install

This is an example of the error message encountered when the PostgreSQL database initialization fails due to a missing configuration file. The error points to a specific build file and the missing 'postgresql.conf'.

```plaintext
Build file 'C:\\ach\\theia.gradle' line: 196
*What went wrong:
Execution failed for task ':initializeDatabase'
>java.io.FileNotFoundException: c:\\ach\\ContentStore\\data\\postgresql.conf (The system cannot find the file specified)
```

--------------------------------

### Install PostgreSQL (Bash)

Source: https://www.ibm.com/docs/en/bae/ach/2.3_topic=23-upgrading-analytics-content-hub-release-linux

Installs the PostgreSQL database system on Ubuntu. This command enables the PostgreSQL repository and installs the latest available version.

```bash
sudo apt install postgresql
```

--------------------------------

### File System Connector Path Examples for Windows and UNIX/Linux

Source: https://www.ibm.com/docs/en/bae/ach/2.3_topic=system-adding-file-connector

Examples of correct path patterns for specifying a file system connector's base URL in IBM Analytics Content Hub, catering to different operating systems.

```shell
file:///C:/example_folder
```

```shell
file:///home/theia/example_folder
```

--------------------------------

### Start Analytics Content Hub Application (Shell Script)

Source: https://www.ibm.com/docs/en/bae/ach/2.3_topic=23-upgrading-analytics-content-hub-release-linux

Starts the Analytics Content Hub application services after the PostgreSQL upgrade and configuration changes are completed. This command should be run from the Analytics Content Hub root directory.

```bash
./startAll.sh
```

--------------------------------

### Extract TAR Archive (Bash)

Source: https://www.ibm.com/docs/en/bae/ach/2.3_topic=23-upgrading-analytics-content-hub-release-linux

Command to extract the contents of a .tar.gz archive. This decompresses and unpacks the installer files into the current directory.

```bash
gunzip IBM-ACH-2024.3.1_linux-x64.tar.gz
tar -xvf IBM-ACH-2024.3.1_linux-x64.tar
```

--------------------------------

### Start Planning Analytics Server (PowerShell)

Source: https://www.ibm.com/docs/en/bae/ach/2.4_topic=troubleshooting-planning-analytics-content-fails-load-in-analytics-content-hub

This PowerShell command initiates the Planning Analytics server after configuration changes have been made to the `paw.ps1` file. This action is necessary to apply the updated security settings.

```powershell
/Start.ps1
```

--------------------------------

### Open TM1 Application Truststore with ikeyman

Source: https://www.ibm.com/docs/en/bae/ach/2.2_topic=cpa-configuring-pa-components-ssl-cam-security-after-enabling-ssl-cognos-analytics-planning-analytics

Opens the TM1 Application truststore using the `ikeyman.exe` utility, typically located within the Planning Analytics installation directory. This is used to manage certificates for TM1 Applications.

```batch
"<Planning_Analitics_install_location>\ibm\cognos\TM1_64\jre\bin\ikeyman.exe"
```

--------------------------------

### Configure Linux System Limits for Analytics Content Hub

Source: https://www.ibm.com/docs/en/bae/ach/2.1_topic=linux-analytics-content-hub-preinstallation-steps

This snippet shows how to modify the limits.conf file to increase system resource limits for 'nofile' (number of open files) and 'nproc' (number of processes) for the Analytics Content Hub installation user. It also sets unlimited memory locking. These settings are crucial for applications that require high resource availability.

```shell
* soft nofile 65536 
* hard nofile 65536
* soft nproc 2048
* hard nproc 4096
* soft memlock unlimited
* hard memlock unlimited
```

--------------------------------

### Run Certificate Processing Script (Linux Shell)

Source: https://www.ibm.com/docs/en/bae/ach/2.1_topic=co-configuring-pa-components-ssl-cam-security-after-enabling-ssl-cognos-analytics-planning-analytics

This script processes CA certificates on a Linux OS. It requires the PAW installation location to be specified. Ensure the script is placed in the correct directory before execution.

```bash
<paw_install_location>/scripts/process_certs.sh
```

--------------------------------

### Register PostgreSQL Content Store on Windows

Source: https://www.ibm.com/docs/en/bae/ach/2.4_topic=troubleshooting-postgresql-database-fails-install

This command registers the 'ach Content Store' for PostgreSQL on Windows. It requires the path to the Content Store's data directory. Ensure the specified paths are correct before execution.

```batch
c:\\ach\\ContentStore\\bin\\pg_ctl.exe register -N "ach Content Store" -D c:\\ach\\ContentStore\\data -w
```

--------------------------------

### Apply Linux Updates (Bash)

Source: https://www.ibm.com/docs/en/bae/ach/2.3_topic=23-upgrading-analytics-content-hub-release-linux

Updates the package list and fetches the latest version of available packages on Ubuntu systems. This is a prerequisite for installing new software or updating existing packages.

```bash
sudo apt-get update
```

--------------------------------

### Run Certificate Processing Script (Windows PowerShell)

Source: https://www.ibm.com/docs/en/bae/ach/2.1_topic=co-configuring-pa-components-ssl-cam-security-after-enabling-ssl-cognos-analytics-planning-analytics

This script processes CA certificates on a Windows Server OS. It requires the PAW installation location to be specified. Ensure the script is placed in the correct directory before execution.

```powershell
<paw_install_location>/scripts/process_certs.ps1
```

--------------------------------

### Create Analytics Content Hub User and Database

Source: https://www.ibm.com/docs/en/bae/ach/2.4_topic=linux-installing-postgresql

Creates a dedicated user and database for the Analytics Content Hub. This includes setting a password for the new user and granting all permissions on the database to the user.

```bash
sudo -u postgres psql template1
```

```sql
create user achadmin password 'password_example';
```

```sql
create database analyticscontenthub;
```

```sql
grant all on database analyticscontenthub to achadmin;
```

--------------------------------

### Create Analytics Content Hub User and Database

Source: https://www.ibm.com/docs/en/bae/ach/2.3_topic=linux-installing-postgresql

Creates a dedicated user ('achadmin') and database ('analyticscontenthub') for the Analytics Content Hub. This includes setting a password for the user and granting necessary permissions.

```bash
sudo -u postgres psql template1
create user achadmin password 'password_example';
create database analyticscontenthub;
grant all on database digitalhive to dhadmin;
alter role dhadmin with CREATEROLE;
```

--------------------------------

### Create Qlik Server Keystore with keytool

Source: https://www.ibm.com/docs/en/bae/ach/2.0_topic=sense-generating-java-keystore

This command imports a certificate file (root.cer) into a JKS keystore file (root.jks) to create a server keystore. It specifies the alias, keystore file, certificate file, store password, and suppresses prompting. Ensure the certificate file path and password are correct.

```bash
C:\AnalyticsContentHub\Java\bin\keytool.exe -import -alias QlikCA -keystore "root.jks" -file "root.cer" -storepass secret -noprompt
```

--------------------------------

### Viewing Keystore Contents

Source: https://www.ibm.com/docs/en/bae/ach/2.0_topic=options-importing-certificates

Lists the contents of the Analytics Content Hub keystore in verbose mode. This command helps to verify that certificates have been imported correctly and to view their details.

```bash
c:\\AnalyticsContentHub\\Java\\bin\\keytool -list -v -keystorec:\\AnalyticsContentHub\\app\\node1\\tomcat\\conf\\keystore.jks
```

--------------------------------

### Configure User Limits with limits.conf

Source: https://www.ibm.com/docs/en/bae/ach/2.4_topic=linux-completing-preinstallation-steps

This snippet demonstrates how to modify the `/etc/security/limits.conf` file to set increased limits for open file descriptors, processes, and memory locking for all users. These settings are crucial for applications that require handling a large number of files or processes, such as the Analytics Content Hub.

```shell
sudo vi /etc/security/limits.conf
```

```text
soft nofile 65536
* hard nofile 65536
* soft nproc 8192
* hard nproc 8192
* soft memlock unlimited
* hard memlock unlimited
```

--------------------------------

### Restart Server

Source: https://www.ibm.com/docs/en/bae/ach/2.4_topic=linux-completing-preinstallation-steps

This command is used to restart the server after applying system configuration changes. A reboot is necessary for the updated kernel parameters and user limits to take full effect, ensuring the Analytics Content Hub can operate within the new constraints.

```shell
sudo reboot
```

--------------------------------

### Update contentSecurityPolicy in theia.properties

Source: https://www.ibm.com/docs/en/bae/ach/2.2_topic=certificates-enabling-http-analytics-content-hub

This example shows how to update the motio.theia.contentSecurityPolicy parameter in theia.properties. It involves commenting out the existing line and adding a new one that includes 'http://*:*' to the default-src directive, allowing HTTP access.

```properties
#motio.theia.contentSecurityPolicy=default-src 'self' 'unsafe-eval' 'unsafe-inline' https://*:* img-src http: https: blob: data:
motio.theia.contentSecurityPolicy=default-src 'self' 'unsafe-eval' 'unsafe-inline' https://*:* http://*:*; img-src http: https: blob: data:
```

--------------------------------

### Comment out Security Constraint in web.xml

Source: https://www.ibm.com/docs/en/bae/ach/2.0_topic=hub-enabling-http-analytics-content

This code snippet demonstrates how to comment out the security-constraint section within the web.xml file. This is typically done to disable specific security measures for the application. No external dependencies are required for this configuration change.

```xml
<!--
   <security-constraint>
        <web-resource-collection>
            <web-resource-name>Entire Application</web-resource-name>
            <url-pattern>/*</url-pattern>
        </web-resource-collection>
        <user-data-constraint>
            <transport-guarantee>CONFIDENTIAL</transport-guarantee>
        </user-data-constraint>
    </security-constraint> 
-->
```

--------------------------------

### Create Qlik Client Java Keystore with keytool

Source: https://www.ibm.com/docs/en/bae/ach/2.0_topic=sense-generating-java-keystore

This command imports a PKCS12 keystore file (client.pfx) into a JKS keystore file (client.jks). It requires the source and destination keystore types, source and destination passwords, and the path to the keytool executable. Ensure the certificate paths and passwords are correct.

```bash
C:\AnalyticsContentHub\Java\bin\keytool.exe -importkeystore -srckeystore "client.pfx" -srcstoretype pkcs12 -destkeystore "client.jks" -deststoretype JKS -srcstorepass secret -deststorepass secret -noprompt
```

--------------------------------

### Run PostgreSQL Migration Script (Shell Script)

Source: https://www.ibm.com/docs/en/bae/ach/2.3_topic=23-upgrading-analytics-content-hub-release-linux

Executes the main script responsible for migrating the PostgreSQL content store. The '--apply' flag indicates that the migration should be performed.

```bash
./migrate-postgres-content-store.sh --apply
```

--------------------------------

### Comment out Cookie Processor in context.xml

Source: https://www.ibm.com/docs/en/bae/ach/2.0_topic=hub-enabling-http-analytics-content

This code snippet shows how to comment out the CookieProcessor directive in the context.xml file. This action is usually performed to modify or disable specific cookie handling, such as sameSiteCookies settings. This is a configuration change within the context.xml file.

```xml
<!-- <CookieProcessor sameSiteCookies="none" /> -->
```

--------------------------------

### View Keystore Contents using keytool

Source: https://www.ibm.com/docs/en/bae/ach/2.1_topic=options-importing-certificates

Lists all entries within a specified Java keystore in verbose mode, displaying details about each certificate and key alias. Useful for verifying imported certificates.

```bash
c:\AnalyticsContentHub\Java\bin\keytool -list -v -keystore c:\AnalyticsContentHub\app\node1\tomcat\conf\keystore.jks
```

--------------------------------

### Configure Both SharePoint and Power BI Online for Automatic OAuth Credential Creation

Source: https://www.ibm.com/docs/en/bae/ach/2.2_topic=providers-creating-renewing-oauth-user-credentials-automatically

This JSON configuration enables automatic OAuth user credential creation for both SharePoint Online and Power BI Online connectors in IBM Analytics Content Hub. It ensures that the system attempts to utilize existing OAuth sessions for a streamlined login experience. This setup is crucial for systems using OAuth as their primary authentication source.

```json
{
  "connectors":{
    "powerBI": {
      "warmupCooldown": {
        "attemptWarmup": true,
        "oauthAutoCreateCredential":true
      }
    },
    "sharePoint": {
      "warmupCooldown": {
        "attemptWarmup": true,
        "oauthAutoCreateCredential":true
      }
    }
  }
}
```

--------------------------------

### Configure Source and Target DB Settings (Properties)

Source: https://www.ibm.com/docs/en/bae/ach/2.3_topic=23-upgrading-analytics-content-hub-release-linux

Defines connection and user details for both the source (existing) and target (new external) PostgreSQL instances within the migration properties file. This includes passwords, hostnames, ports, and database names.

```properties
source.db.password=example_password
target.db.host=example_host
target.db.port=example_port
target.db.admin.user=postgres
target.db.admin.password=example_password
target.db.database=postgres
target.db.user=example_username
target.db.password=example_password
target.db.name=example_db_name
```

--------------------------------

### Import Certificate using Keytool Command

Source: https://www.ibm.com/docs/en/bae/ach/2.1_topic=options-importing-certificates

This command imports a specified certificate file into the cacerts keystore. Ensure you have administrative privileges and adjust the file paths to match your environment. The 'alias' parameter provides a unique name for the certificate within the keystore. You will be prompted for the keystore password, which is 'changeit' by default.

```shell
c:\AnalyticsContentHub\Java\bin\keytool -import -keystore c:\AnalyticsContentHub\Java\lib\cacerts -file c:\certificates\paw_cert.cer -alias paw
```

--------------------------------

### Viewing Keystore Contents using keytool

Source: https://www.ibm.com/docs/en/bae/ach/2.2_topic=certificates-importing

This command lists the contents of the Analytics Content Hub keystore in verbose mode. It's useful for verifying imported certificates and checking their details. The command requires specifying the keystore file path.

```bash
c:\AnalyticsContentHub\Java\bin\keytool -list -v -keystorec:\AnalyticsContentHub\app\node1\tomcat\conf\keystore.jks
```

--------------------------------

### Import .pfx Certificate using keytool

Source: https://www.ibm.com/docs/en/bae/ach/2.1_topic=options-importing-certificates

Imports a PKCS12 (.pfx) certificate, which contains both private and public keys, into the Java keystore for Analytics Content Hub. Requires specifying source and destination keystore paths and passwords.

```bash
c:\AnalyticsContentHub\Java\bin\keytool -importkeystore -srckeystore c:\certificates\ach_cert.pfx -srcstoretype pkcs12 -destkeystore c:\AnalyticsContentHub\app\node1\tomcat\conf\keystore.jks -deststoretype jks -destkeypass theia_pass
```

--------------------------------

### Importing .pfx Certificate using keytool

Source: https://www.ibm.com/docs/en/bae/ach/2.2_topic=certificates-importing

This command imports a .pfx certificate, which contains both private and public keys along with the full chain, into the Analytics Content Hub keystore. It's used to secure the SSL listener. The command requires specifying source and destination keystore types and passwords.

```bash
c:\AnalyticsContentHub\Java\bin\keytool -importkeystore -srckeystore c:\certificates\ach_cert.pfx srcstoretype pkcs12 -destkeystore c:\AnalyticsContentHub\app\node1\tomcat\conf\keystore.jks -deststoretype jks -destkeypass theia_pass
```

--------------------------------

### Configure Linux Kernel Parameters for Analytics Content Hub

Source: https://www.ibm.com/docs/en/bae/ach/2.1_topic=linux-analytics-content-hub-preinstallation-steps

This snippet demonstrates how to update the sysctl.conf file to adjust the 'vm.max_map_count' kernel parameter. This is often required by Elasticsearch, a component of Analytics Content Hub, to manage memory mapping efficiently. Increasing this value prevents potential memory-related errors.

```shell
#Added for Elastisearch 
vm.max_map_count=262144
```

--------------------------------

### Restart Planning Analytics Workspace Service

Source: https://www.ibm.com/docs/en/bae/ach/2.1_topic=co-configuring-planning-analytics-connector-display-tm1-applications-content

This command restarts the Planning Analytics Workspace environment after certificate updates. It is a critical step to ensure that the new certificate chain is loaded and active. The command is executed from the environment's root directory.

```shell
./paw.sh restart
```

--------------------------------

### Import Certificate to Cacerts using Keytool

Source: https://www.ibm.com/docs/en/bae/ach/2.0_topic=options-importing-certificates

This command imports a certificate into the cacerts keystore. Ensure you replace the placeholder paths with your actual file locations. The command requires administrator privileges to modify the keystore. The default password for cacerts is 'changeit'.

```bash
c:\\AnalyticsContentHub\\Java\\bin\\keytool -import -keystore c:\\AnalyticsContentHub\\Java\\lib\\cacerts -file
```

--------------------------------

### Register Certificate Chain Script

Source: https://www.ibm.com/docs/en/bae/ach/2.1_topic=co-configuring-planning-analytics-connector-display-tm1-applications-content

This script is used to register the certificate chain after the PEM file has been copied to the configuration directory. It navigates to the scripts directory and executes the processing script. No specific inputs or outputs are detailed, but it's essential for activating the new certificate.

```shell
cd /opt/ibm/cognos/paw_2_0_89_1174/scripts/process_certs.sh
```
Tokens:
Raw