emc documentum - xcp.x updating endpoint

1 © Copyright 2015 EMC Corporation. All rights reserved.

xCP Endpoint Update

EMC ENTERPRISE CONTENT DIVISION

Brayden Han 30 November 2015


Contents xCP 2.x Endpoint

Brief steps to update endpoint without redeployment

Update Endpoint: example for new email server

- Appendix: Endpoint property name and label


xCP 2.x Endpoint

Parameterizes endpoint information – Specified at deployment time so that independent

of the application – Via the use of Run Configurations in the Designer

by developer

Externalized into the xml configuration file which is paired up with war file.

– Called App Configuration – Can use different xml configuration file

for different environment


Brief steps to update Endpoint without redeployment

1. Retrieve the endpoint object ID for the endpoint from the repository

2. Retrieve the metadata for the endpoint

3. Set a new property value for the endpoint

4. Save your changes



1. Log in to Documentum Administrator or any API tools.

2. On the Api Tester page, select Single Line Command Entry.

3. In the Command field, type retrieve,c,dmc_xcp_app_config where namespace=’<namespace>’ and config_name=’<endpoint-system-name>’ where <namespace> is the namespace of the application and <endpoint-system-name> is the system name of the endpoint you want to update. 4. Leave the Data field blank and click Execute. The system retrieves the endpoint object ID from the repository and displays it in the Results text box as shown in the following example: API Command>retrieve,c,dmc_xcp_app_config where namespace=’testapp’ and config_name= ‘emailserver’ ... 08003039801096cb


5. In the Command field, type dump,c,<r_object_id> where <r_object_id> is the endpoint object ID obtained from the previous command.

6. Leave the Data field blank and click Execute. The system lists the metadata for the endpoint object. The metadata includes two repeating attributes, property_name and property_value, and an index number associated with the attributes. namespace : testapp config_type : ENDPOINT config_name : emailserver config_label : EmailServer config_description : property_value [0]: 10.xx.xx.xx [1]: None [2]: [3]: [4]: 25 [5]: property_name [0]: HOSTNAME [1]: USE_ENCRYPTION [2]: EMAIL_SERVER_TYPE [3]: USER_NAME [4]: PORT_NUMBER [5]: PASSWORD




7. In the Command field, type set,c,<r_object_id>,property_value[<index>] where <r_object_id> is the endpoint object ID and <index> is the index number of the property_name and of the property_value you want to update.

8. In the Data field, type <value> For example, new email server host, the corresponding property_name is HOSTNAME at index number 0. In the Command field type, API Command> set,c,08003039800fba74,property_value[0] Data> new hostname (or IP)



9. Click Execute.

10. After you finish updating the values for the endpoint object, in the Command field, type save,c,08003039800fba74 where <r_object_id> is the endpoint object ID for which you want to save the updated value or values.

11. Clear the Data field and click Execute. 12. Click OK. 13. Log out of Document Administrator or other API tools.

14. Restart the following: a. Java Method Server b. For tc Server, the application server instance where you deployed Process Integrator and xCP application. For Tomcat, the application server where you deployed Process Integrator and xCP application.


Appendix: Endpoint property name and label Endpoint/property_name La bel in the Endpoint Editor D a tabase DRIVER_CONFIG_PARAM JDBC Driver DB_URL_CONFIG_PARAM Connection string USERNAME_CONFIG_PARAM Username PASSWORD_CONFIG_PARAM Password Ema il HOSTNAME Hostname PORT_NUMBER Port number USER_NAME Username PASSWORD Password USER_ENCRYPTION Encryption EMAIL_SERVER_TYPE Protocol (if server connection is incoming only) F TP FTP_SERVER_TYPE Protocol FTP_HOST Hostname FTP_PORT Port number FTP_USER_NAME Username FTP_PASSWORD Password FTP_BASE_DIR Base folder path SFTP_USE_PUBLIC_KEY_AUTHENTICATION Authentication (Basic or Public key authentication) H TTP URL Parameters URL HTTP_USERNAME Username HTTP_PASSWORD Password

Endpoint/property_name La bel in the Endpoint Editor JMS JMS_INIT_CONTEXT_FACTORY_CONFIG_PARAM Context factory JMS_INIT_CONTEXT_PROVIDER_URL_CONFIG_PARAM Provider URL JMS_INIT_CONTEXT_USERNAME_CONFIG_PARAM Username (Context factory) JMS_INIT_CONTEXT_PASSWORD_CONFIG_PARAM Password (Context factory) JMS_DESTINATION_ADDITIONAL_PROPERTIES Additional properties JMS_DESTINATION_TYPE_CONFIG_PARAM Queue/Topic (Connection type) JMS_CONNECTION_FACTORY_CONFIG_PARAM Connection factory JMS_DESTINATION_NAME_CONFIG_PARAM Queue/Topic name JMS_DESTINATION_USERNAME_CONFIG_PARAM Username (Connection factory) JMS_DESTINATION_PASSWORD_CONFIG_PARAM Password (Connection factory) R e pository DOCBROKER_HOST Docbroker Hostname DOCBROKER_PORT Docbroker Port DOCBASE_CONFIG_PARAM Repository Name USERNAME_CONFIG_PARAM Username PASSWORD_CONFIG_PARAM Password DOCBASE_DOMAIN Domain We bservice WSDL_URL_CONFIG_PARAM WSDL URL AUTHENTICATION_USERNAME_CONFIG_PARAM Username AUTHENTICATION_PASSWORD_CONFIG_PARAM Password x Pression XPRESSION_SERVERURL xPression URL USER_NAME Username PASSWORD Password

emc documentum - xcp.x updating endpoint

Software