### PathModelCreate Tool Examples

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=model-creating-path-based-data

Examples of how to run the PathModelCreate tool in different modes.

```APIDOC
## Example
The following code sample shows how to run the tool in an interactive mode:
Operating system| Code sample  
---|---  
Linux or UNIX systems| `./configure-repository.sh PathModelCreate`  
Windows| `configure-repository.bat PathModelCreate`  
The following code sample shows how to run the tool in a silent mode. You must enter the command in one line.
```
java com.ibm.content.cm.tools.PathModelCreate -r icmnlsdb -u icmadmin -p password
 -o SCHEMA=ICMADMIN -z true
```
```

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

### GET /plugins

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=navigator-administration-api-reference

Retrieves a list of all installed plug-ins.

```APIDOC
## GET /plugins

### Description
Retrieves a list of all installed plug-ins in IBM Content Navigator.

### Method
GET

### Endpoint
`/[context root]/admin/v1/plugins`

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **plugins** (array) - A list of plug-in objects.
  - **id** (string) - The unique identifier for the plug-in.
  - **name** (string) - The name of the plug-in.
  - **version** (string) - The version of the plug-in.

#### Response Example
```json
{
  "plugins": [
    {
      "id": "pluginABC",
      "name": "Custom Plugin",
      "version": "1.0.0"
    }
  ]
}
```
```

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

### Profile Plug-in Installation URL Formats

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=ins-configuring-sametime-plug-in

These examples show the different formats for specifying the Profile plug-in URL when loading it in the IBM Content Navigator administration tool. It includes both a web URL format and file path formats for Windows and Linux/AIX systems.

```text
http://host_name:port_number/ECMClient_installdir/plugins/ProfilePlugin.jar
```

```text
C:\Program Files\IBM\ECMClient\plugins\ProfilePlugin.jar
```

```text
/opt/IBM/ECMClient/plugins/ProfilePlugin.jar
```

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

### Example URL with Pre-populated Properties

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=navigator-creating-url-pre-populated-entry-template

Illustrates a complete URL parameter for pre-populating an entry template. This example shows how to append the 'itemProperties' parameter with a JSON array containing multiple property-value pairs.

```url
itemProperties=[{"property":"State","value":"Florida"},{"property":"City","value":["Orlando","Tampa"]},
{"property":"semanticType","value":["1","10"]},{"property":"createdTimestamp",
"value":"2014-01-24T00:00:0-08:00"}]
```

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

### Silent Installation Response File Configuration

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=software-running-silent-installation

This configuration sets up the response file for a silent installation of IBM Content Navigator. It specifies that the installation should run without user interaction, that the license and notices have been accepted, and optionally allows for a custom installation directory.

```text
INSTALLER_UI=SILENT
LICENSE_ACCEPTED=true
NOTICES_ACCEPTED=true
# Optional: Specify a custom installation directory
# USER_INSTALL_DIR=/path/to/your/install/directory
```

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

### Example: Move LTPA Key Task to First Position

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=reference-changing-order-tasks-in-configuration-profile-movetask

This example shows how to move the `importltpakey` task to position 5 in the `myprofile` configuration profile. The description implies a desire to configure LTPA security before other tasks, though the example command moves it to position 5, not necessarily the first position.

```bash
configmgr_cl moveTask -task importltpakey -position 5 -profile myprofile
```

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

### Example of Workflow Launch Step Identification

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=otr-external-data-service-integration-into-filenet-p8-workflows

Provides an example of the JSON symbolic name used to identify a workflow launch step.

```json
{"symbolicName": "Data_Field_Workflow.Workflow.LaunchStep"}
```

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

### Configure Silent Installation Response File

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=software-upgrading-content-navigator-silently

Defines the mandatory parameters in the response file to enable silent installation mode and accept license agreements.

```text
INSTALLER_UI=SILENT
LICENSE_ACCEPTED=true
NOTICES_ACCEPTED=true
```

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

### Silent Installation of IBM Navigator Sync Client (Windows Command)

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=components-configuring-sync-services-content-navigator-filenet-p8

This command facilitates the silent installation of the IBM Navigator Sync client on Windows workstations. It includes options for logging the installation process and specifying whether settings should be saved for all users or just the current user. The AgreeToLicense parameter must be set to 'Yes' for the installation to proceed.

```Windows Command
ICNSyncClient.exe /v"/qn /L*v \"C:\\SyncInstallLog.txt\" AgreeToLicense=\"Yes\" SAVE_SETTINGS_FOR_ALL=1"
```

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

### GET /desktops

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=navigator-administration-api-reference

Retrieves a list of all configured desktops.

```APIDOC
## GET /desktops

### Description
Retrieves a list of all configured desktops in IBM Content Navigator.

### Method
GET

### Endpoint
`/[context root]/admin/v1/desktops`

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **desktops** (array) - A list of desktop objects.
  - **id** (string) - The unique identifier for the desktop.
  - **name** (string) - The display name of the desktop.

#### Response Example
```json
{
  "desktops": [
    {
      "id": "desktop123",
      "name": "Default Desktop"
    },
    {
      "id": "desktop456",
      "name": "Custom Desktop"
    }
  ]
}
```
```

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

### Specific ChoiceList Examples

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=lists-choice-custom-properties

These examples demonstrate specific implementations of the choiceList configuration parameter in the cmpathservice.properties file. They cover different scenarios, including item type-specific lists and global lists.

```properties
choiceList.*@myAttGroup.myAttr = val1, val2, val3, val4, val5
```

```properties
choiceList.PageDesign@layout.colors = red, orange, yellow, green, blue, 
purple, brown, black, white
```

```properties
choiceList.MyItemType@oddNumbers = 1, 3, 5, 7, 9
```

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

### Example: Move LDAP Configuration Task

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=reference-changing-order-tasks-in-configuration-profile-movetask

This example demonstrates how to move a specific LDAP configuration task file, `configureldap.xml`, to the first position (position 1) in the `myprofile` configuration profile. This is useful for ensuring LDAP configuration is performed early in the profile execution.

```bash
configmgr_cl moveTask -taskfile configureldap.xml -position 1 -profile myprofile
```

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

### Custom Log File Path for Sync Client Installation

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=components-configuring-sync-services-content-navigator-filenet-p8

This command snippet shows how to specify a custom path for the installation log file when performing a silent installation of the IBM Navigator Sync client. By modifying the /L*v argument, administrators can direct the log output to a desired location on the client's file system.

```Windows Command
/L*v \"fully_qualified_path_of_the_log_file\"
```

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

### Initialization and Loading Methods

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-repositoryconfig

Provides methods for initializing and loading system configurations. These are fundamental for setting up the navigator's state.

```Java
void load() Initializes the superclass default property values map.
protected void resetNonTenantSettings()
```

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

### Initialize TenantRegistrationConfig

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-tenantregistrationconfig

Demonstrates how to instantiate the TenantRegistrationConfig class using a configuration object, ID prefix, and object ID.

```java
TenantRegistrationConfig config = new TenantRegistrationConfig(configuration, "prefix", "objectId");
```

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

### ForwardedMessage Methods (Java)

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmeventmessages-forwardedmessage

Details the methods available for the ForwardedMessage class. These include methods to get and set the action, get message contents, get the message class name, get qualifiers, and convert the message to a JSON string.

```java
public java.lang.String getAction()

```

```java
public void setAction(java.lang.String action)

```

```java
public java.util.Set<java.lang.annotation.Annotation> getQualifiers()

```

```java
public java.lang.String getContents()

```

```java
public java.lang.String getMessageClassName()

```

```java
public java.lang.String toString()

```

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

### Initialize UserConfig Instance

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-userconfig

Demonstrates how to instantiate the UserConfig class using a configuration object and identifier prefixes.

```java
import com.ibm.ecm.configuration.UserConfig;
import org.apache.commons.configuration.Configuration;

// Assuming 'config' is an existing Configuration instance
UserConfig userConfig = new UserConfig(config, "user_prefix", "user_123");
```

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

### Configure Silent Install Response File for IBM ECM CMIS

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=cmis-installing-ecm-software

This snippet shows the essential parameters to configure in the `cmis_fncs_silent_install.txt` file for a silent installation. It includes setting the installer UI mode, accepting the license, and optionally specifying a custom installation directory.

```text
INSTALLER_UI=SILENT
LICENSE_ACCEPTED=true
USER_INSTALL_DIR=/path/to/your/custom/install/CMIS
```

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

### Example of Version Parameter Usage

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=generateconfig-oracle-weblogic-server

Demonstrates the correct syntax for specifying the Oracle WebLogic Server version, including the requirement for single quotes on non-Windows platforms.

```bash
-appserverVersion '12c(12.1.1)'
```

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

### Linux Silent Installation Command

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=software-running-silent-installation

This command initiates the silent installation of IBM Content Navigator on Linux. It requires the path to the response file containing the installation configuration.

```shell
IBM_CONTENT_NAVIGATOR-3.1.0-LINUX.bin -f fully_qualified_path_of_the_response_file/ecmclient_silent_install.txt
```

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

### POST /config/initialize

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-config

Initializes access to the system configuration, supporting either properties file-based or database-based (JNDI) storage.

```APIDOC
## POST /config/initialize

### Description
Initializes the system configuration. Configuration can be loaded from a properties file (typically for development/demo) or from a database via JNDI (for production).

### Method
POST

### Endpoint
/config/initialize

### Parameters
#### Request Body
- **enablePropertiesConfig** (String) - Required - Boolean string identifying if properties configuration is enabled.
- **propertiesFileName** (String) - Required - The name of the configuration file.
- **userDefinedSchema** (String) - Optional - Database schema name.
- **userDefinedJNDI** (String) - Optional - JNDI name for database access.
- **ldapServer** (String) - Optional - LDAP server configuration string.

### Response
#### Success Response (200)
- **status** (String) - Initialization successful.

#### Error Response (500)
- **error** (String) - Exception thrown if initialization fails.
```

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

### AIX Silent Installation Command

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=software-running-silent-installation

This command initiates the silent installation of IBM Content Navigator on AIX. It requires the path to the response file containing the installation configuration.

```shell
IBM_CONTENT_NAVIGATOR-3.1.0-AIX.bin -f fully_qualified_path_of_the_response_file/ecmclient_silent_install.txt
```

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

### Convert GUID Formats

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-config

Utility methods to convert between raw 32-character GUID strings and standard 38-character delimited GUID formats. These methods normalize IDs to lowercase for consistency.

```java
public static java.lang.String idToGuid(java.lang.String id) throws java.lang.Exception;
public static java.lang.String guidToId(java.lang.String guid) throws java.lang.Exception;
```

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

### Run LibraryCreate Tool - Java Command

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=manager-creating-libraries

This snippet shows the basic Java command structure to execute the LibraryCreate tool. It requires specifying the fully qualified class name and any necessary options and their values.

```Java
java com.ibm.content.cm.tools.LibraryCreate -options values
```

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

### Initialize DesktopFeatureConfig

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-desktopfeatureconfig

Demonstrates the constructors available for initializing a DesktopFeatureConfig instance. These constructors allow creating a new configuration based on an existing one or by providing a configuration object with specific ID prefixes.

```java
public DesktopFeatureConfig(java.lang.String id, DesktopFeatureConfig fromConfig);
public DesktopFeatureConfig(org.apache.commons.configuration.Configuration configuration, java.lang.String idPrefix, java.lang.String id);
```

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

### Sample Plug-in Files for Custom Menus

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=components-creating-menu

Provides an overview of sample Java files used in a plug-in to define different types of custom menus (context and toolbar) and their associated actions.

```APIDOC
## Sample Plug-in Files for a Custom Menu

### Description
The following files demonstrate how to create different types of menus (context and toolbar) and actions within a sample plug-in for IBM Content Navigator.

### Sample Files:

*   **`SamplePluginContextMenuMenuType.java`**: Extends `PluginMenuType.java` to define a menu type for a context menu.
*   **`SamplePluginContextMenuMenu.java`**: Extends `PluginMenu.java` to define a context menu. It includes actions like Sample Action, Properties, Help, About, Preview, and Open. Available actions might include 'Custom Checkin' and 'Only For Text Docs'.
*   **`SamplePluginToolbarMenuType.java`**: Extends `PluginMenuType.java` to define a menu type for a toolbar.
*   **`SamplePluginToolbarMenu.java`**: Extends `PluginMenu.java` to define a toolbar menu. It includes actions like Sample Action and Help, About.
*   **`SamplePluginToolbarMenuType2.java`**: Extends `PluginMenuType.java` to define another menu type for a toolbar.
*   **`SamplePluginToolbarMenu2.java`**: Extends `PluginMenu.java` to define a second toolbar menu. It includes actions like Sample Action, Custom Checkin, and Help.
```

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

### Linux for System z Silent Installation Command

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=software-running-silent-installation

This command initiates the silent installation of IBM Content Navigator on Linux for System z. It requires the path to the response file containing the installation configuration.

```shell
IBM_CONTENT_NAVIGATOR-3.1.0-ZLINUX.bin -f fully_qualified_path_of_the_response_file/ecmclient_silent_install.txt
```

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

### Get Protocol (Java)

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-repositoryconfig

Retrieves the protocol string. This method is used to get the communication protocol.

```java
public java.lang.String getProtocol()
```

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

### Java Instantiation for Multiple Configurations

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-databaseconfiguration

Shows how to instantiate DatabaseConfiguration for managing multiple configurations stored in a single table. It provides examples for creating configuration objects for 'config1' and 'config2' and retrieving specific properties from each.

```Java
Configuration config1 = new DatabaseConfiguration(datasource, "myconfigs", "name", "key", "value", "config1");
String value1 = conf.getString("key1");

Configuration config2 = new DatabaseConfiguration(datasource, "myconfigs", "name", "key", "value", "config2");
String value2 = conf.getString("key2");
```

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

### Configuring Desktop Parameters

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=ins-customizing-web-part-behavior-microsoft-sharepoint-pages

Parameter to override the default desktop with a specific custom desktop ID.

```text
&desktop=myCustomDesktopForReviewers
```

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

### Silent Installation of ICNEditClient

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=components-configuring-edit-service-client-content-navigator

This command performs a silent installation of the IBM Content Navigator Edit Service client. It logs installation details to a specified file and accepts the license agreement. The log file path and SSO parameters can be customized.

```bash
ICNEditClient.exe /v"/qn /L*v C:\\EditInstallLog.txt AgreeToLicense=Yes"
```

```bash
ICNEditClient.exe /v"/qn /L*v \"fully_qualified_path_of_the_log_file\" AgreeToLicense=Yes"
```

```bash
ICNEditClient.exe /v"/qn ISSSO=True AgreeToLicense=Yes"
```

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

### Initialize FilenetConfig Instance

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-filenetconfig

Demonstrates the constructor for the FilenetConfig class, requiring an Apache Commons Configuration object and identifier strings.

```java
public FilenetConfig(org.apache.commons.configuration.Configuration configuration, java.lang.String idPrefix, java.lang.String id)
```

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

### Java Instantiation for Single Configuration

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-databaseconfiguration

Demonstrates how to instantiate the DatabaseConfiguration class to load properties from a database table structured for a single configuration. It shows the creation of a Configuration object and retrieval of a property.

```Java
Configuration config = new DatabaseConfiguration(datasource, "myconfig", "key", "value");
String value = config.getString("foo");
```

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

### Windows Silent Installation Command

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=software-running-silent-installation

This command initiates the silent installation of IBM Content Navigator on Windows. It requires the path to the response file containing the installation configuration. Note that on Windows, colons and backslashes in paths within the response file need to be escaped.

```shell
IBM_CONTENT_NAVIGATOR-3.1.0-WIN.exe -f fully_qualified_path_of_the_response_file/ecmclient_silent_install.txt
```

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

### PluginFeature getHelpWelcomePage Method

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmextension-pluginfeature

Returns the path to the help welcome page for the feature. This specifies the initial help content displayed when a user accesses help for this feature.

```java
public java.lang.String getHelpWelcomePage()
```

Returns a `String` to use the help welcome page for this feature.
```

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

### Get and Set Banner Logo Description - Java

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-themeconfig

Allows for getting and setting the alternative text description for the banner logo, important for accessibility.

```Java
public java.lang.String getBannerLogoDesc()
public void setBannerLogoDesc(java.lang.String bannerLogoDesc)
```

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

### Configure Linux Startup Script for ODApi.jar

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=uowscnc-enabling-access-content-manager-ondemand-repositories-oracle-weblogic-server

Modifies the Linux WebLogic Server startup script to include ODApi.jar and set LD_LIBRARY_PATH, CLASSPATH, and PATH for Content Manager OnDemand integration. This ensures the necessary libraries and JAR files are accessible.

```shell
ODWEK=/opt/ibm/odwek/V9.0/api/ODApi.jar
LD_LIBRARY_PATH=/opt/ibm/odwek/V9.0
CLASSPATH=$ODWEK:$LD_LIBRARY_PATH:$CLASSPATH
PATH=/opt/ibm/odwek/V9.0/lib64:/opt/ibm/odwek/V9.0:$PATH
```

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

### Run Repository Configuration Tool (Interactive Mode)

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=manager-creating-library-groups

This snippet demonstrates how to execute the IBM Content Navigator repository configuration tool in interactive mode. It shows the commands for both Linux/UNIX and Windows operating systems.

```bash
./configure-repository.sh LibraryGroupCreate
```

```batch
configure-repository.bat LibraryGroupCreate
```

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

### Get and Set Navigation Icon Color - Java

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-themeconfig

Allows for getting and setting the color of icons within the navigation panel. This ensures visual consistency.

```Java
public java.lang.String getNavigationIconColor()
public void setNavigationIconColor(java.lang.String navigationIconColor)
```

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

### Displaying DocumentTypeEnable Tool Help

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=manager-extending-document-types

This command shows how to display the help information for the DocumentTypeEnable tool, which includes a list of available extensions and their corresponding numbers for a given repository.

```java
java com.ibm.content.cm.tools.DocumentTypeEnable -?
```

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

### Display execute Command Help

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=reference-running-tasks-in-configuration-profile-execute

Retrieves help content for the execute command, listing all valid parameters and usage options.

```bash
configmgr_cl execute -help
```

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

### Get and Set Login Page Background - Java

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-themeconfig

These methods are used to get and set the background of the login page. This is useful for branding the login experience.

```Java
public java.lang.String getLoginPageBackground()
public void setLoginPageBackground(java.lang.String loginPageBackground)
```

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

### Configure Windows Startup Script for ODApi.jar

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=uowscnc-enabling-access-content-manager-ondemand-repositories-oracle-weblogic-server

Adjusts the Windows WebLogic Server startup script to incorporate ODApi.jar for Content Manager OnDemand access. It uses SET commands to define ODWEK, CLASSPATH, and PATH, with specific instructions for handling paths with spaces.

```batch
set ODWEK=C:\Progra~1\IBM\ONDEMA~1\V9.0\api\ODApi.jar
set CLASSPATH=%ODWEK%;%CLASSPATH%
set PATH=C:\PROGRA~1\IBM\ONDEMA~1\V9.0;C:\PROGRA~1\IBM\ONDEMA~1\V9.0\
lib64;%PATH%
```

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

### Get and Set Banner Text/Icon Color - Java

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-themeconfig

Methods to get and set the color for text and icons within the banner. This ensures consistent visual theming.

```Java
public java.lang.String getBannerTextIconColor()
public void setBannerTextIconColor(java.lang.String bannerTextIconColor)
```

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

### Get Property Value (Double) (Java)

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-configurationobject

Retrieves the double value of a property associated with a given key. This method is used to get double properties from the configuration.

```Java
public double getDoublePropertyValue(java.lang.String key)
```

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

### Get Property Value (Int) (Java)

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-configurationobject

Retrieves the integer value of a property associated with a given key. This method is used to get integer properties from the configuration.

```Java
public int getIntPropertyValue(java.lang.String key)
```

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

### Get Property Value (Boolean) (Java)

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-configurationobject

Retrieves the boolean value of a property associated with a given key. This method is used to get boolean properties from the configuration.

```Java
public boolean getBooleanPropertyValue(java.lang.String key)
```

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

### Convert GUID and ID Formats

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-config

Utility methods to convert between standard GUID format (with delimiters) and the compact ID format used as keys in configuration objects.

```java
String id = ConfigUtil.guidToId("{aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee}");
String guid = ConfigUtil.idToGuid("aaaaaaaabbbbccccddddeeeeeeeeeeee");
```

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

### Generate Configuration Help

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=generateconfig-oracle-weblogic-server

Displays the help menu for the configmgr_cl tool to identify valid parameter values, such as supported WebLogic versions.

```bash
configmgr_cl generateConfig -help
```

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

### Execute Silent Installation Command for IBM ECM CMIS

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=cmis-installing-ecm-software

This snippet provides the command-line syntax for initiating a silent installation of IBM ECM CMIS. It requires specifying the correct installer binary for the operating system and the path to the response file. Note that the version number in the binary should match your IBM Content Navigator version.

```bash
# AIX
IBM_ECM_CMIS_FNCS-3.0.3-AIX.bin -f /path/to/your/response/file/CMIS_FNCS_silent_install.txt

# Linux
IBM_ECM_CMIS_FNCS-3.0.3-LINUX.bin -f /path/to/your/response/file/CMIS_FNCS_silent_install.txt

# Linux for System z
IBM_ECM_CMIS_FNCS-3.0.3-ZLINUX.bin -f /path/to/your/response/file/CMIS_FNCS_silent_install.txt

# Windows
IBM_ECM_CMIS_FNCS-3.0.3-WIN.exe -f C:\\path\\to\\your\\response\\file\\CMIS_FNCS_silent_install.txt
```

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

### Get Servers Method

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-iconstatusconfig

Retrieves the server configuration as a String. Returns the server information associated with the current instance.

```java
public java.lang.String getServers()
```

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

### Get Property Value (Long) (Java)

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmconfiguration-configurationobject

Retrieves the long integer value of a property associated with a given key. This method is used to get long properties from the configuration.

```Java
public long getLongPropertyValue(java.lang.String key)
```

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

### Initialize PluginRepositoryConnection

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=comibmecmextension-pluginrepositoryconnection

Demonstrates how to instantiate the PluginRepositoryConnection class. This constructor requires the repository type, user ID, and display name.

```java
PluginRepositoryConnection connection = new PluginRepositoryConnection("repoType", "user123", "John Doe");
```

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

### HTTP Range Request Header Example

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=specification-partial-content-stream-retrieval-in-http-requests

Demonstrates the syntax for an HTTP range request header. Note that IBM ECM CMIS will only process the first range in this example.

```HTTP
Range: bytes=500-999, 1300-1700
```

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

### Construct Full Search Bookmark URL

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=navigator-creating-url-custom-search-form-search-results

A complete example of a bookmark URL including repository parameters, encoded search criteria, and optional auto-run or auto-open flags.

```http
http://host:port/navigator/bookmark.jsp?desktop=default&repositoryId=P8_or_CM_System&docid=document_ID&template_name=search_name&version=version_number&searchCriteria=[{%22property%22%3A%22City%22%2C%22value%22%3A%22Orlando%22},{%22property%22%3A%22semanticType%22%2C%22value%22%3A%5B%221%22%2C%2210%22%5D},{%22property%22%3A%22createdTimestamp%22%2C%22value%22%3A%222014-01-24T00%3A00%3A0-08%3A00%22}]&autoRunSearch=true&autoOpenItem=true
```

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

### Testing LDAP connection in a profile

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=reference-testing-task-in-configuration-profile-test

Example command to verify the LDAP configuration within a specific profile.

```bash
configmgr_cl test -task configureldap -profile myProfile
```

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

### Retrieve Object Types via GET Request

Source: https://www.ibm.com/docs/en/content-navigator/3.2.0?topic=resource-get-method

This snippet demonstrates the URI structure and the expected JSON response format for the GET /types request. It requires a repositoryId parameter to identify the data source.

```http
GET /types?repositoryId=Repository_ID
```

```json
{
 "types": 
  [
   {
    "symbolicName": "TypeOne"
   }
  ]
}
```