Skip to main content
Kinetic Community

Remedy Bridge in CE for people search

Overview

The example in this article will cover configuring an Ars Bridge in Bridgehub,  testing the bridge in Bridgehub using the CTM:People record,  configuring the Ars Bridge in Request CE, creating a model and mappings to retrieve the people record, creating a bridge resource on a CE form, and doing a Set Field example to display the results of the bridge call.

Configuring Ars Bridge in Bridgehub

  1. open Brigehub
  2. select the Bridges tab (this should be the default tab bridgehub opens to)
  3. click the Add Bridge button
  4. select Ars Bridge from the Bridge Adapter dropdown


    This is what the screen should look like after you have selected Ars Bridge.
  5. Give the bridge a Name
    • I have given my bridge the name "Ars Bridge"
  6. Give the bridge a Slug (slugs must be lower case and not contain spaces; typically we use - for a space)
    • I have given my bridge a slug of ars-bridge
  7. Add the servers that can access this bridge (optionally a * will allow access to all servers ip's)
  8. Give the Username (this is a Remedy user account)
  9. Give the Password (this is the password for the user to access Remedy)
  10. This is the Server that the Remedy instance is running on
  11. This is the Port number to access the Remedy instance
  12. Prognum (can normally leave a default value of 0)
  13. Save the configuration 

Test the Ars Bridge

once you have saved the bridge configuration you will be returned to the default bridges tab

  1. To the right of the newly created bridge select the Test option

  2. Select a Method to execute
    • Count (retrieve the number of results)
    • Retrieve (retrieves one record, will throw a 500 if multiple records are retrieved)
    • Search (retrieves multiple records)
  3. Add a Structure (this is a Remedy form name)
    • I am using the CTM:People form for this example
  4. Add Fields (this is a comma separated list, no spaces between entries, that matches database field names on the Remedy form)
    • I am doing a Retrieve for the first name, last name and Remedy login id
  5. Add a Qualification (a qualification is used to find the specific record you are searching for)
    • The qualification I am using is matching the Remedy Login Id to a known users login id 
  6. Click the Test Bridge button
  7. The results display below the button.
    • A Status Code of 200 means that the request was successful.  The desired results should display.

Configure Ars Bridge in Request CE

  1. From the Management Console in Request select the Kapp where you want to configure the bridge
  2. Select the Bridging option
  3. Click the Add Bridge button
  4. Give the bridge a Name (this does not need to match the name in bridgehub, although this is a common practice)
    • I am naming the bridge Ars Bridge


      For this bridge we do not have to give a Key or Secret so they can be left blank
  5. Add a URL (this can be found in Bridgehub)
    1. Go to Bridgehub and the Bridges tab
    2. Select your Ars Bridge from the list
      • Remember I named my bridge Ars Bridge

    3. The URL field in CE is populated with the Bridge Path that can be found in Bridgehub
  6. Save the bridge configuration

Create a bridge Model

  1. From the Management Console select the Bridging option
  2. Select the Models option from the horizontal list
  3. Give the model a Name
    • I gave my model the name Remedy Test Bridge
  4. Click the Add Model button
  5. Select the newly created model Name
    • By clicking the name Remedy Test Bridge from the model list I opened the newly created model
  6. Create a new Qualification
    1. Give it a name
      • This will be used by Remedy to retrieve records
      • I am going to use the First Name filed to retrieve a users First Name and Remedy Login Id
      • I gave my qualification the name By First Name
    2. select a Result Type
      • I am looking to retrieve a single record so I set the Result Type to single
      • Note for my test I know that I am going to get one record back for the first name I am going to test.  Only set a result type to single if you believe that you should only get one record back.  Normal usage would be to have a qualification by Login Id to retrieve a single record, using a first name as a qualification will most likely returns multiple records so the Result Type should be set to Multiple. 
    3. click the Add Qualification button
  7. Create a new Attributes (this will be used in the Mappings)
    • I have created First Name and Remedy Login Id attributes
  8. Click the Add Attribute button


     
  9. Click on the Parameters link to open the Bridge Parameters modal
  10. Create a new parameter by giving it a Name (this is used in the bridge resource configuration section of the form)
    • For this example name the parameter "First Name"
  11. Click the Add Parameter button
  12. Click the Close button to close the modal

Create a new Mapping

  1. Select the Mappings option from the horizontal list
  2. From the dropdown menu select the newly created model
    • Remember I named my model Remedy Test Bridge


      In the image I have already completed the configuration for my mappings the numbers point to where you should add yours
  3. Give the mapping a Name
    • I have named my mapping Remedy Test Bridge (it is not necessary to match the model name and the mapping name)
  4. From the dropdown select the appropriate bridge
    • Remember in step 4 of the Configure Ars Bridge in Request CE section I named my bridge Ars Bridge
  5. Set the Structure for the mappings (this will match the remedy form)
    • I am using the CTM:People form as I did in the bridge test section
  6. Click the Add Mapping button
  7. Select the name to open the Attribute Mappings and Qualification Mappings configuration section
    • I selected Remedy Test Bridge


      The Attributes and Qualifications that were created during the Create a bridge Model section will be displayed
  8. Click the Add Attribute button to map the attribute
  9. Click the Add Field button
  10. Enter the data base field names on the remedy form
    • In the image above I am mapping Remedy Login ID to my attribute Remedy Login Id; the names do not have to match
  11. Click the Add button (this will wrap the field name with ${fields(' ')} )
    • As you can see in the image I have already mapped the First Name remedy data base field to my First Name attribute
  12. Click the check mark button to add the attribute mapping


    Parameter that were created in Create a bridge Model section will be options to choose
  13. Click the Add Qualification Mapping button
  14. Create the qualification (an example provided matches a remedy query)
    • This example is going to search the remedy data base First Name field using the First Name parameter
    • Remember that the parameter was set up in step 10 of the Create a bridge Model section
  15. Click the check mark button to add the qualification mapping

Create a Bridge Resource in a CE form

  1. From the Management Console create a new Form or choose a Form to add a bridge resource too
    • For this example have a text field on the form named "Name Input"
    • For this example have a text fields on the form named "Login Id" and "First Name"
  2. Select the Form Settings element
  3. Click the Add Bridged Resource button (this will bring up the New Bridged Resource modal)
  4. Give the bridged resource a Name
    • I am giving my bridged resource the name Remedy Test Bridge
  5. Select the appropriate model from the Model dropdown
    • Remember on step 3 of the Create a bridge Model section I gave my model the name Remedy Test Bridge
    • It is not required to keep the names the same, but it does help track back through the steps
  6. Select the desired qualification from the Qualification dropdown (the qualification dropdown is populated after a model is selected)
    • Remember in the Create a bridge Model  section step 6 substep 1 I created a qualification and gave it the name By First Name
  7. Once the Qualification is selected the Parameters can be configured (the parameter appears after a qualification is selected)
    • Remember on step 10 of the Create a bridge Model section I created a new parameter and gave it the name First Name
  8.  Set the First Name parameter to the Name Input field
    • The syntax to get a value from a field is ${values(' ')}
    • Use the Variable dropdown to select the field
      • Select Name Input from the Values section (the "Name Input" field must exist on the form already)
    • Alternatively you could type ${values('Name Input')} into the field

Create a Set Field event on a Field

  1. Select the field to set the event on
    • In this example I am using a field with the name "Name Input"
  2. Drop down the EVENTS menu
  3. Click the Add Event button

  4. The Edit Event modal will open after clicking on the Add Event button
  5. From the Type dropdown select Change
    • This sets a change event listener on the field
  6. Give the event a Name
    • I have named my event Set Fields
  7. Select the desired Action
    • This example we are trying to set fields after a bridge has been called so select the Set Fields action
  8. Select the Bridged Resource to use when the change event fires
    • I am going to use the bridged resource that was setup in the Create a Bridge Resource in a CE form section named Remedy Test Bridge

  9. When Set Fields is selected from the Action dropdown a mapping section appears at the bottom of the modal
  10. Select a field to map
    • I've selected the First Name and Login Id field (these fields must exist on the form)
  11. To choose what to map to a field use the Variables dropdown
    • I have mapped the Remedy Test Bridge model attributes to corresponding fields
    • the syntax for mapping to a bridged resource is ${resources(' <bridge resource name>: <attribute> ')}
  12. Click the + button to add the mapping
  13. Click the Save button inside of the modal
  14. Click the Save button on the form
  15. Select the preview option from the form Actions dropdown
  16. Test the Set Fields event and Remedy Test Bridge bridged resource by typing a name into the Name Input field and clicking outside of the field
  17. If all worked correctly the First Name and Login Id fields should be populated with values.