Getting Started with OSLC integration

To create a module:

1. Login to Maximo Real Estate and Facilities and navigate to the Data Modeler.
2. Click Home > Tools > Data Modeler.
3. Click New and then select New Module.
4. Specify the name of the module and then click Save Module.

To create a Business Object:

1. In the newly created module, click New and then click New Business Object.
2. Specify the name of the Business Object and then click SaveBO.
3. Add fields to the BO by either adding them manually or finding them from an existing BO. The fields added to the BO are triControlNumber (Control Number), triNameTX (Text), triDescriptionTX (Text), triRecordIdSY(System Read Only), triRecordNameSY (System Read Only), and triNumber (Number).
4. Add a State Transition family:
   1. Click Tools > BO State Transition. Either set up or import the State Transition.
   2. To import the State Transition, click Import> Import From Business Object> triPeople for both Module and BO.
   3. Click Ok, and then click Save.
5. Create BO Mapping:
   1. Click Tools > BO Mapping. In the following example the BO mapping, set it to show the ControlNumber, then a hyphen followed by Name or to your own requirements.
   2. Click Save Mapping and then click Publish BO.

To create a module:

1. Navigate to Home > Tools > Form Builder.
2. Select the appropriate Module (amOSLCTutorial) and then click New.
3. Select the appropriate BO in the Properties Window. In this example, only one BO amRecord is assigned to this module.
4. Click Apply.
5. Click Add Tab.
6. Specify the name of the tab and then click Apply.
7. On the newly created tab click Add Section, provide a name to the section, and then click Apply.
8. Add the fields required for the form:
   1. On the section created in the previous step, click Add Field.
   2. In the Properties window, select a Data Field from the BO, and then click Apply. In this example, the following fields are added to the form: fields triControlNumber, triNameTX, triDescriptionTX, and triNumber. The form should look something like this:
   3. Click Publish to publish the form.

To create a query:

1. Navigate to Home > My Reports.
2. Click System Reports tab.
3. Click New.
4. Specify the name of the query.
5. On the Business Object tab, click Add Business Object. On the form, select the Module, Business Object, and Form that were created in the previous steps and click OK.
6. Click the Columns tab. Add the fields from the form (ControlNumber, Description, Name, Number) to display in the query.
7. Click Save & Close.

Create a navigation item to access the form and create new records:

1. Navigate to Home > Tools > Navigation.
2. Click Add to bring up Navigation Items Library, and then click Add.
3. In the Navigation Item Editor window, specify the name of the item, and set the Target Type to Master/Detail Default Query.
4. In the Form section, select the Module and Form that was created in the previous sections.
5. In the Action section, add actions to create, update, or delete records, and then click Save & Close.
6. Select the menu to add the navigation item.
7. Click Navigation Items Library, search the recently created Navigation Item, and then Save & Close.
8. Add records to the navigation item by clicking Home > Tools > System Setup.

To create an OSLC resource:

1. Navigate to Home > Tools > System Setup > Integration > OSLC Resource Manager.
2. Click Add.
3. Specify the ID, Resource Name, and Title.
4. In Namespace the prefix spi is used which has the base of http://jazz.net/ns/ism/smarter_physical_infrastructure. The namespace is used to provide unique name to the fields but does not change any logic. You can use any namespace or create your own.
5. In the Module drop-down menu, select the module that was created earlier. The corresponding BO, Form, and Query are now available for selection.
6. In the Properties section, click Import All Fields to set up the fields for the resource based on the BO fields.
7. After the import is completed, click Create.

To create a Service Provider:

• Navigate to Home > Tools > System Setup > Integration > OSLC Manager.
• Click Add.
• On the Service Provider creation form, specify a name, and then click Create.

To create an OSLC service:

1. Open the Service Provider created in the previous section.
2. Under the Service section, click Add.
3. In the new form name the service and set the domain to match what is set in the resource: http://jazz.net/ns/ism/smarter_physical_infrastructure.
4. Click Create.

To create OSLC Query Capability:

1. In the Query Capabilities section of the service form, click Add to bring up the Query Capability form.
2. In the Resource section, click Find.
3. Select the OSLC Resource that was created earlier and then click OK.
4. In the General section, specify a name and title.
   Note: If you want to override the query that is added to the resource, you can select the query from the Query drop-down menu. In this example, the query is already added to the resource so leave the Query field blank.

To create a creation factory:

1. In the Creation Factories section of the service form, click Add.
2. In the Resource section, click Find.
3. Select the OSLC Resource that was created earlier and then click OK.
4. In the General section, specify a name and title.

The first command involves the GET command by using the Query Capability that was created in the previous section. Select the GET option, and then enter your command in the appropriate format. Replace the appropriate values in the command: https://<workspace_id>.facilities.<mas_domain>/oslc/spq/RecordQC Then click Send. You are prompted to enter credentials to sign on to the Maximo Real Estate and Facilities server. Specify the same username and password that you use to login into Maximo Real Estate and Facilities.

The query can also be expanded by using oslc.select and oslc.where. To see the names assigned in the records, oslc.select can be used for viewing the field values in the query. For example, running a GET command on: https://<workspace_id>.facilities.<mas_domain>/oslc/spq/RecordQC?oslc.select=* shows all the fields in the response for all the records. You can also display a specific field by replacing the “*” with a specific field to return all the records with that field. To get all the names assigned in the records, run GET on: https://<workspace_id>.facilities.<mas_domain>/oslc/spq/RecordQC?oslc.select=*. .

The following attributes can be used for displaying information.

• oslc.where=spi:triDescriptionTX="%25MREF%25": Displays any records that have “MREF” anywhere in the description.
• "%25string%25" = string anywhere in the field.
• "%25string" = string ends the field.
• "string%25" =string starts the field.

You can view one of the specific records after running the query from the previous section, which shows a list of all the records of this type with their unique URI indicated by rdf:about. If you run a GET command on any of these URIs, a list with details is displayed. On the Advanced REST Client, you can also click the URI to set it. For example, running the GET command on: https://<workspace_id>.facilities<mas_domain>/sqa/oslc/so/amRecordRS/20029512. This provides the response with the information from the record with specId=20029512. If you click Send, a response is provided with all the information that is gathered about the record.

To create a new record, use a POST command by using the creation factory that is set up. Before sending the request, first set up the header and request body (payload). The header only needs two things:

• The Accept field is used to determine what file formats the browser is trying to get.
• The Content-Type field helps determine how to use the data being received:
  • Header: Accept: application/json
  • Content-Type: application/json;charset=utf-8

The request body allows you to specify the action (State Transition) you want to perform on the record and also set the field values. For example:

{"spi:action":"Create Draft","spi:triNameTX":"Tom Tommyson", "spi:triNumber": "42", "spi:triDescriptionTX":
"This record was made using the advanced rest client" }

This would create a draft for a record with the triNameTX field set to Tom Tommyson, the triNumber field to 42, and the triDescriptionTX field to “This record was made using the advanced rest client”.

You can create a record by running POST on: https://<workspace_id>.facilities<mas_domain> . The status displays 201 Created. You can check to see if this record has is created with the details that you have specified in the request body. One way to do this is to run the query capability again. Ensure to set the command type back to GET if you are running this query. However, simply running this command displays all the records and you might be unable to identify the newly created record. To resolve this problem, you can also use the oslc.select command to get the exact record details. You can write a GET command such as: https://<workspace_id>.facilities.<mas_domain>/oslc/spq/RecordQC?oslc.select=spi:triNameTX

You can then view the record by running a GET command on this new record. In this example, you can run a GET command on: http://triqaapp13.tivlab.usnv.ibm.com:12001/sqa/oslc/so/amRecordRS/20029512. The results in the response display the values that are specified in the record.

The PUT command can also be used to update an existing record.

To confirm that the value has been updated, you can run a GET command on the same URL. Change to the GET option and then click SEND. The response shows the updated number. This update can also be seen on the Maximo Real Estate and Facilities Server where you create and view the records.

While it is possible to delete a record by using the PUT command, you can also use the HTTP DELETE operation. To use delete, you must set the URI to the record that you want to remove. This URI is identical to the one that you would run a GET command to view the record.