This document provides instructions for updating endpoints in xCP 2.x without redeploying the application. It describes how to retrieve an endpoint's object ID from the repository, view its metadata including property names and values, update a specific property value, save the changes, and restart relevant servers. An example is given for updating an email server endpoint's hostname property. An appendix lists the property names and labels for various endpoint types like database, email, FTP, HTTP, JMS, repository, web service, and xPression.

1. 1© Copyright 2015 EMC Corporation. Allrights reserved.
xCP Endpoint Update
EMCENTERPRISE CONTENT DIVISION
Brayden Han
30 November 2015

2. 2© Copyright 2015 EMC Corporation. Allrights reserved.
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

3. 3© Copyright 2015 EMC Corporation. Allrights reserved.
xCP 2.x Endpoint
 Parameterizes endpoint information
– Specified at deployment time so that independent
of the application
– Via the use of Run Configurationsin 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 differentenvironment

4. 4© Copyright 2015 EMC Corporation. Allrights reserved.
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

5. 5© Copyright 2015 EMC Corporation. Allrights reserved.
Update Endpoint: example for new email server
1. Log in toDocumentumAdministrator or anyAPI tools.
2. On theApi Tester page, select Single Line Command Entry.
3. In theCommand field, type
retrieve,c,dmc_xcp_app_config wherenamespace=’<namespace>’and config_name=’<endpoint-system-name>’
where<namespace>isthenamespaceoftheapplication and<endpoint-system-name>isthesystem
nameof theendpoint you want toupdate.
4. LeavetheData field blank andclick Execute.
Thesystem retrievestheendpoint object ID from therepositoryand displaysit in theResults text box as
shown in thefollowing example:
API Command>retrieve,c,dmc_xcp_app_config where namespace=’testapp’ and config_name= ‘emailserver’
...
08003039801096cb

6. 6© Copyright 2015 EMC Corporation. Allrights reserved.
5. In theCommand field, type
dump,c,<r_object_id>
where<r_object_id> istheendpoint object ID obtained from thepreviouscommand.
6. LeavetheData field blank andclick Execute.
Thesystem lists themetadatafor theendpoint object. Themetadataincludestworepeatingattributes,
property_nameandproperty_value, andan index number associatedwith theattributes.
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
Update Endpoint: example for new email server

7. 7© Copyright 2015 EMC Corporation. Allrights reserved.
Update Endpoint: example for new email server
7. In the Command field, type
set,c,<r_object_id>,property_value[<index>]
where<r_object_id> istheendpoint object ID and <index>isthe index numberof theproperty_nameand
of theproperty_valueyou want toupdate.
8. In theData field, type
<value>
For example, new email server host, thecorresponding property_nameisHOSTNAMEat index number 0.
In theCommand field type,
API Command> set,c,08003039800fba74,property_value[0]
Data> new hostname (or IP)

8. 8© Copyright 2015 EMC Corporation. Allrights reserved.
Update Endpoint: example for new email server
9. Click Execute.
10. After you finish updating thevaluesfor theendpoint object, in theCommand field, type
save,c,08003039800fba74
where<r_object_id> istheendpoint object ID for which you want tosavetheupdatedvalueor values.
11. Clear theData field and click Execute.
12. Click OK.
13. Log out of Document Administrator or other API tools.
14. Restart thefollowing:
a. Java Method Server
b. For tcServer, theapplicationserver instancewhereyou deployed Process Integratorand xCP application.
For Tomcat, theapplicationserver whereyou deployed Process Integrator and xCP application.

9. 9© Copyright 2015 EMC Corporation. Allrights reserved.
Appendix: Endpoint property name and label
Endpoint/property_name Label in theEndpoint Editor
Database
DRIVER_CONFIG_PARAM JDBC Driver
DB_URL_CONFIG_PARAM Connection string
USERNAME_CONFIG_PARAM Username
PASSWORD_CONFIG_PARAM Password
Email
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)
HTTP
URL Parameters URL
HTTP_USERNAME Username
HTTP_PASSWORD Password
Endpoint/property_name Label in theEndpoint 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 (Contextfactory)
JMS_INIT_CONTEXT_PASSWORD_CONFIG_PARAM Password (Context factory)
JMS_DESTINATION_ADDITIONAL_PROPERTIES Additional properties
JMS_DESTINATION_TYPE_CONFIG_PARAM Queue/Topic (Connectiontype)
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 epository
DOCBROKER_HOST Docbroker Hostname
DOCBROKER_PORT Docbroker Port
DOCBASE_CONFIG_PARAM Repository Name
USERNAME_CONFIG_PARAM Username
PASSWORD_CONFIG_PARAM Password
DOCBASE_DOMAIN Domain
Webservice
WSDL_URL_CONFIG_PARAM WSDL URL
AUTHENTICATION_USERNAME_CONFIG_PARAM Username
AUTHENTICATION_PASSWORD_CONFIG_PARAM Password
xPression
XPRESSION_SERVERURL xPression URL
USER_NAME Username
PASSWORD Password