Managing Friends

A friend is another web application that allows this application to send requests on behalf of an authorized user. In other words, a friend is a server application that makes its information available for consulting (or possibly creating/updating) to this application using an authorized friend-application user.

Friends are needed to create outgoing Collaboration Links, this means you need to register the CLM Application as a friend of Windchill if you want to create Collaboration Links on Windchill side; keep in mind that additional configuration will be required on the CLM Application side, but for now let's focus on the requirements of this side.

It is worth to mention that a friend is not bound to any particular friend-application user; at the proper working moment, the friend will request the friend-application user credentials to allow this application work on behalf of it (a process known as "user authentication").

Registering a Friend.

  1. Enter to the Configure > Friends page.
  2. Fill out the form to register a new Friend according to the following field descriptions:
    Field Required Description Notes Suggested Value
    Server Yes A logical name for human identification. Commonly the server application name. The CLM Application name.
    Root Services Yes The endpoint of the friend's root services service. Must be provided by the CLM Application administrator and must use the same transfer protocol (HTTP or HTTPS) as the Windchill server. A valid provided root services URL.
    Consumer Key Yes Existing CLM Application Consumer key. Reuse an existing consumer key means you have been already granted with access to the system and therefore, you will be provided with the corresponding consumer's key and secret. Some existing CLM application Consumer Key
    Consumer Secret Yes This application password. How this application will be authenticated on the server. The corresponding Key password.
  3. Click on the Add Friend button.

If everything went ok, a new friend entry will be displayed on the Friends list section; note: only the Server, Root Services fields will be shown.

Removing a Friend.

  1. Enter to the Configure > Friends page.
  2. Locate the Registered OSLC Friends section and table
  3. Choose the friend you want to remove and click on the corresponding trash icon located on the last column of the table.

If everything went ok, the chosen friend will be removed from the system and it will no longer appear on the table.

Updating a Friend.

  1. Follow the Removing a Friend procedure.
  2. Follow the Registering a Friend procedure again with the updated information.