The ConfigEngine.sh script is used to add, remove and validate entries in the Portal configuration engine. Refer to IBM Portal - Configuring wkplc.properties for the steps on how to configure the workplace properties file (wkplc.properties) so that ConfigEngine.sh can make a connection to Portal.

Before using wp-update-federated-ldap-attribute-config to add or update an LDAP property, you may want to use the wp-validate-federated-ldap-attribute-config option to ensure the attribute has not already been added to the Portal configuration engine. Or, you can review the /opt/WebSphere/AppServer<version>/profiles/<your profile>/config/cells/<your cell>/wim/config/wimconfig.xml and ensure the property is not listed.

<config:attributeConfiguration>
  <config:attributes name="userPassword" propertyName="password"/>
    <config:attributes name="mail" propertyName="email">
    <config:entityTypes>PersonAccount</config:entityTypes>
      <config:entityTypes>Group</config:entityTypes>
    </config:attributes>
    
    <config:attributes name="createTimestamp" propertyName="createTimestamp">
      <config:entityTypes>PersonAccount</config:entityTypes>
      <config:entityTypes>Group</config:entityTypes>
    </config:attributes>
  
    <config:attributes name="fullName" propertyName="fullName">
      <config:entityTypes>PersonAccount</config:entityTypes>
      <config:entityTypes>Group</config:entityTypes>
    </config:attributes>

The wp-update-federated-ldap-attribute-config option is used to add or update an LDAP property. The ConfigEngine.sh script will get the new property to add from the /opt/WebSphere/AppServer<version>/profiles/<your profile>/ConfigEngine/properties/wkplc.properties file. In this example, the LDAP fullName attribute will be added.

la.propertyName=fullName
la.entityTypes=PersonAccount
la.dataType=String
la.multiValued=false

You would then invoke ConfigEngine.sh like this.

/opt/WebSphere/AppServer/profiles/your_profile/ConfigEngine/ConfigEngine.sh wp-update-federated-ldap-attribute-config

If the update is successful, BUILD SUCCESSFUL should be included at the end of the output.

cleanup-config:
     [echo] executing post-configuration tasks
BUILD SUCCESSFUL

update-registry-sync-property:
     [echo] updated RegistrySynchronized in file wkplc.properties with value: true

If the update is unsuccessful, BUILD FAILED should be included at the end of the output. In this scenario, review the failureyyyy-mm-dd-hh.mm.ss.log to get an idea behind why the update failed. After resolving the issue identified in failureyyyy-mm-dd-hh.mm.ss.log, run the wp-add-property command again until BUILD SUCCESSFUL is returned.

cleanup-config:
     [echo] executing post-configuration tasks
BUILD FAILED

print-final-message:
isIseries currently set to: null
Creating failure log in directory: /opt/WebSphere/AppServer/profiles/<your profile>/ConfigEngine/log
traceFile created /opt/WebSphere/AppServer/profiles/<your profile>/ConfigEngine/log/failureyyyy-mm-dd-hh.mm.ss.log
basepath = /opt/WebSphere/ConfigEngine

The wp-validate-federated-ldap-attribute-config should show that the property has been added.

Restart the Portal application servers for this change to take effect.