Installing the Remote API
This chapter describes how to use the Remote API to automate Windchill Requirements Connector and run it headless as a service. To install the Remote API please refer to the following steps:
1. Install the service via main application by running the PTCIntegrityRequirementsConnector.exe setup file
The scripts to install the IRCService can now be found at <WRC_INSTALL_PATH>\remoteAPI\service
2. Create the following System environment variables:
a. WRC_API_APPLICATION_PATH=[The installation path of PTCIntegrityRequirementsConnectorC.exe, e.g. C:\Program Files\PTC\Windchill Requirements Connector\].
b. WRC_API_SERVICE_PORT=[An open TCP-IP port to be bound to the Windchill Requirements Connector Service]
 |
If this variable is not set, the service will use the default port which is “7654”.
|
c. Optional: c. WRC_API_SERVICE_LOGFILE=[The path of the service log file].
|
|
The default is <WRC_API_APPLICATION_PATH>\remoteAPI\IRCServiceLog.txt
|
3. Open a command prompt window with administrator rights.
a. Navigate to the folder where the service and the batch scripts are located e.g. C:\Program Files\PTC\Windchill Requirements Connector\remoteAPI\service
b. Run the batch script createService.bat, which will install the service
c. Run the batch script startService.bat, which will start the service.
|
|
If the service is started successfully, a log file <WRC_API_APPLICATION_PATH>\remoteAPI\IRCServiceLog.txt will be generated at the system folder or at an user defined location if the variable WRC_API_SERVICE_LOGFILE is set. The Windchill Requirements Connector service will log the information (port and installation path). In addition, the service will log all incoming and outgoing requests. (This Remote API service must be started before using the Remote API client)
|
d. To stop the service, use the stopService.bat script.
e. To uninstall the service, use the deleteService.bat script.
The service is installed successfully.
 |
Note that the service is started manually at this point, meaning that it will not start automatically when the system is restarted. It is the task of the system administrator to configure how to start the service upon system restart.
|
4. The client to be used to communicate with the service can be found at<WRC_INSTALL_Path>\remoteAPI named com.atego.exchange.remote.api.jar
5. During communication with the service, the following jar files need to be available in the classpath located at <WRC_INSTALL_Path>\remoteAPI.
a. istack-commons-runtime-4.0.1.jar
b. jakarta.activation-api-2.0.1.jar
c. jakarta.xml.bind-api-3.0.1.jar
d. jaxb-core-3.0.1.jar
e. jaxb-runtime-3.0.1.jar
License Setup : License Administration
The client and service are ready for usage now.
Related Links
Parent topic