App Connector Examples

This article contains the following topics:

Dell Warranty Check

The Dell warranty check connector allows you to connect to dell support and retrieve warranty information of an asset.

Follow these steps:

1. From the New App Connector page, enter the following information:
   • App Connector Name: Dell Warranty Check
   • Description (Optional)
   • Connectivity Type: On Cloud
   • Base URL: https://api.dell.com/support/v2/assetinfo
   • API Format: XML
   • Authentication: None
2. From the Operation pane, click New Operation and enter the following information:
   1. Basic Properties tab:
      • Operation Name: Get Asset Warranty Details
      • Description (Optional)
      • URL: warranty/tags.xml
      • Method: GET

   2. Input Parameters tab:

      URL Parameters	Value	User Identifiable Name
      svctags	C9CX7W1	Service Tag
      apikey	d676cf6e1e0ceb8fd14e8cb69acd812d	API Key

   3. Output Parameters tab:

      1. Click Validate, The output is generated in a dialog.

      2. Select the following parameters:

         XPath	Parameter	User Identifiable Name
         /GetAssetWarrantyResponse[1]/GetAssetWarrantyResult[1]/a:Response[1]/a:DellAsset[1]	a:CustomerNumber[1]	Customer Name
         /GetAssetWarrantyResponse[1]/GetAssetWarrantyResult[1]/a:Response[1]/a:DellAsset[1]	a:MachineDescription[1]	Machine Description
         /GetAssetWarrantyResponse[1]/GetAssetWarrantyResult[1]/a:Response[1]/a:DellAsset[1]/a:Warranties[1]/a:Warranty[1]	a:EndDate[1]	Warranty 1 End Date
         /GetAssetWarrantyResponse[1]/GetAssetWarrantyResult[1]/a:Response[1]/a:DellAsset[1]/a:Warranties[1]/a:Warranty[1]	a:ServiceLevelDescription[1]	Warranty 1 Name
         /GetAssetWarrantyResponse[1]/GetAssetWarrantyResult[1]/a:Response[1]/a:DellAsset[1]/a:Warranties[1]/a:Warranty[2]	a:EndDate[1]	Warranty 2 End Date
         /GetAssetWarrantyResponse[1]/GetAssetWarrantyResult[1]/a:Response[1]/a:DellAsset[1]/a:Warranties[1]/a:Warranty[2]	a:ServiceLevelDescription[1]	Warranty 2 Name
         /GetAssetWarrantyResponse[1]/GetAssetWarrantyResult[1]/a:Response[1]/a:DellAsset[1]/a:Warranties[1]/a:Warranty[3]	a:EndDate[1]	Warranty 3 End Date
         /GetAssetWarrantyResponse[1]/GetAssetWarrantyResult[1]/a:Response[1]/a:DellAsset[1]/a:Warranties[1]/a:Warranty[3]	a:ServiceLevelDescription[1]	Warranty 3 Name
         /GetAssetWarrantyResponse[1]/GetAssetWarrantyResult[1]/a:Response[1]/a:DellAsset[1]/a:Warranties[1]/a:Warranty[4]	a:EndDate[1]	Warranty 4 End Date
         /GetAssetWarrantyResponse[1]/GetAssetWarrantyResult[1]/a:Response[1]/a:DellAsset[1]/a:Warranties[1]/a:Warranty[4]	a:ServiceLevelDescription[1]	Warranty 4 Name

3. Save and publish the connector. The Dell warranty check connector is created and ready for use.

Rally 2.0 Connector

Rally is a platform to manage your agile development ecosystem. Rally provides APIs for managing releases, iterations, stories, and defects. The Rally 2.0 connector enables you to automate the creation of releases and iterations in Rally from the application.

Follow these steps:

1. From the New App Connector page, enter the following information:
   • App Connector Name: Rally 2.0 Connector
   • Description (Optional)
   • API Version: 2.0
   • Connectivity Type: On Cloud
   • Base URL: https://rally1.rallydev.com/slm/webservice/v2.0
   • API Format: JSON

   • Authentication

     Filed	Value
     Authentication Type	Advance Authentication
     Login URL	https://rally1.rallydev.com/slm/webservice/v2.0/security/authorize
     Uses Basic Authentication	True
     Username	Your Rally username (example: SuperAdmin@domain.com)
     Password	Your Rally password
     Logout URL	https://rally1.rallydev.com/slm/webservice/v2.0/security/authorize
     Output	Click View test output and select parameters, and enter the following values: Parse String: OperationResult.SecurityToken Name to Identify: Secure Token

2. From the Operation pane, click New Operation and enter the following information:
   1. Create an iteration:
      
      1. Basic Properties tab:
         • Operation Name: Create Iteration
         • Description (Optional)
         • URL: iteration/create
         • Method: Post

      2. Input Parameters tab:

         Fields	Value
         URL Parameters	URL Param: key Value: -- (Value should be empty) User Identifiable Name: Secure Token (Name should match the Name to Identify value in the authentication output.)
         Body	Raw Data
         Payload	Copy and past the following code: Note: Change the project id with the existing code. { "Iteration": { "Name": "{{Iteration Name:Iteration A}}", "Notes": "{{Iteration Notes:test}}", "PlannedVelocity": {{Iteration velocity:15}}, "Project": "https://rally1.rallydev.com/slm/webservice/v2.0/project/projectid", "StartDate": "{{Iteration Start Date:2014-09-23T06:00:00.000Z}}", "State": "Planning", "EndDate": "{{Iteration End Date:2014-10-29T06:59:59.000Z}}" } }

      3. Output Parameters tab:

         1. Click Validate, The output is generated in a dialog.

         2. Select the following parameter:

            Parameter	User Identifiable Name
            CreateResult.Object.ObjectID	Iteration ID

   2. Create a release: Click New Operation and enter the following information:
      1. Basic Properties tab:
         
         • Operation Name: Create Release
         • Description (Optional)
         • URL: release/create
         • Method: Post

         
         

      2. Input Parameters tab:

         Fields	Value
         URL Parameters	URL Param: key Value: -- (Value should be empty) User Identifiable Name: Secure Token (name should match the Name to Identify value in the authentication output.)
         Body	Raw Data
         Payload	Copy and past the following code: Note: Change the project id with an existing project id. { "Release": { "Name": "{{Release name:Release B}}", "Notes": "{{Release Notes:test}}", "PlannedVelocity": {{Release planned velocity:30}}, "Project": "https://rally1.rallydev.com/slm/webservice/v2.0/project/projectid", "State": "Planning", "ReleaseDate": "2014-09-30T06:59:59.000Z", "ReleaseStartDate": "2014-09-23T07:00:00.000Z" } }

      3. Output Parameters tab:

         1. Click Validate, The output is generated in a dialog box.

         2. Select the following parameters:

            Parameter	User Identifiable Name
            CreateResult.Object.ObjectID	Release ID

3. Save and publish the connector. The Rally 2.0 Connector is created and ready for use.

Process Automation Connector

A Process Automation is designed to speed the delivery of IT services and help eliminate manual errors. You can eliminate manual errors by automating and orchestrating processes across organizational silos that use contrasting systems. This connector leverages its ReST APIs and allows starting a workflow, fetching a list of request forms, initiating an automation workflow request, and querying for the status of a request.

Follow these steps:

1. From the New App Connector page, enter the following information:
   • App Connector Name: Process Automation Connector
   • Description (Optional)
   • API version: 4.2
   • Connectivity Type: On Cloud
   • Base URL: http://hostname:7000/node/rest (hostname is the name of the host where ITPAM is installed.)
   • API Format: XML

   • Authentication

     Filed	Value
     Authentication Type	Basic Authentication
     Username	Your PAM username
     Password	Your PAM password

2. From the Operation pane, click New Operation and enter the following information:
   1. Start a workflow:
      
      1. Basic Properties tab:
         • Operation Name: Start Workflow
         • Description (Optional)
         • URL: CA:00074_CA:00074:01/_ops/Start
         • Method: Post

      2. Input Parameters tab:

         Fields	Value
         Body	Raw Data
         Payload	Copy and past the following code: <StartRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="p1:StartRequest" xmlns:p1="http://ns.ca.com/2011/09/pam-ops" > <EntityID> <MdrElementID><context path execute workflow></MdrElementID> </EntityID> </StartRequest>

      3. Output Parameters tab:

         1. Click Validate, The output is generated in a dialog.

         2. Select the following parameter:

            Parameter	User Identifiable Name
            /usm-core:EntityID[1]/usm-core:MdrElementID[1]	Start Request ID

   2. Fetch request forms: Click New Operation and enter the following information:
      
      1. Basic Properties tab:
         
         • Operation Name: Fetch Request Forms
         • Description (Optional)
         • URL: CA:00074_CA:00074:01/_ops/QueryStartRequestForms
         • Method: Post

      2. Input Parameters tab:

         Fields	Value
         Body	Raw Data
         Payload	Copy and past the following code: <QueryStartRequestFormsRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="p1:QueryStartRequestFormsRequest" xmlns:p1="http://ns.ca.com/2011/09/pam-ops" ><Filter><LookUpPath>/mehni03</LookUpPath> <IsRecursive>true</IsRecursive></Filter></QueryStartRequestFormsRequest>

      3. Output Parameters tab:

         1. Click Validate, The output is generated in a dialog.

         2. Select the following parameter:

            Parameter	User Identifiable Name
            /QueryStartRequestFormsResponse[1]/StartRequestForm[1]/Description[1]	Form Description

   3. Submit as request: Click New Operation and enter the following information:
      
      1. Basic Properties tab:
         
         • Operation Name: Submit Request
         • Description (Optional)
         • URL: CA:00074_CA:00074:01/_ops/SubmitStartRequestForm
         • Method: Post

      2. Input Parameters tab:

         Fields	Value
         Body	Raw Data
         Payload	Copy and past the following code: Note: Payload is based on the form that is configured to execute the workflow. <SubmitStartRequestFormRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xsi:type="p1:SubmitStartRequestFormRequest" xmlns:p1="http://ns.ca.com/2011/09/pam-ops" > <Name>CasaTestForm</Name> <Path>/mehni03</Path> <Arguments> <Argument> <Name>Var_0</Name> <Value>val0</Value></Argument><Argument> <Name>Var_1</Name> <Value>true</Value> </Argument> <Argument> <Name>Var_2</Name> <Value>val2</Value></Argument></Arguments></SubmitStartRequestFormRequest>

      3. Output Parameters tab:

         1. Click Validate, The output is generated in a dialog.

         2. Select the following parameter:

            Parameter	User Identifiable Name
            /pam-ops:SubmitStartRequestFormResponse[1]/StartRequestStatus[1]/Instance	Instance ID

   4. Get the request status: Click New Operation and enter the following information:
      
      1. Basic Properties tab:
         
         • Operation Name: Get Request Status
         • Description (Optional)
         • URL: CA:00074_CA:00074:01/_ops/QueryStartRequests
         • Method: Post

      2. Input Parameters tab:

         Fields	Value
         Body	Raw Data
         Payload	Copy and past the following code: Note: Note: Form ID (For example: CasaTestForm_120) varies according to the PAM setup. <QueryStartRequestsRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="p1:QueryStartRequestsRequest" xmlns:p1="http://ns.ca.com/2011/09/pam-ops" > <Instance>{{INSTANCE:CasaTestForm_120}}</Instance> <IsArchived>false</IsArchived></QueryStartRequestsRequest>

      3. Output Parameters tab:

         1. Click Validate, The output is generated in a dialog.

         2. Select the following parameter:

            Parameter	User Identifiable Name
            /pam-ops:QueryStartRequestsResponse[1]/StartRequestInstances[1]/StartRequestInstance[1]/State	Process State

3. Save and publish the connector. The Process Automation Connector is created and ready for use.