Best practices for customizing Data Management jobs

This topic explains how to add custom fields to an out-of-the-box (OOTB) job, transformations, spreadsheets, and update load forms workflow. You can use the following end-to-end example and add custom fields to extend any OOTB job to support your customizations. 

The following example describes how to add a second Company field to the Location spreadsheet and its related Pentaho jobs. However, this process can be used to add a custom field or fields to extend an OOTB job.

For custom forms

You can also use the same end-to-end process example to create a job or transformation to push data to your custom form, but you must create a load form and supporting workflows to complete the process.

The following steps will explain how to add the Company column in the Location, People, and PeopleOrg spreadsheets and customize their related Pentaho transformations. 

Complete the following steps in the order shown:

  1. Create a custom spreadsheet to support multi-company data loads
  2. Create a custom transformation
  3. Create a custom Atrium Integrator job
  4. Register the custom Atrium Integrator job with the Data Management Job Console
  5. Use the Spreadsheet Management Console to attach the multi-company support spreadsheet
  6. Create a custom Data Management job template
  7. Run the newly created multi-company job
  8. Review the transformations that can be modified for multi-company support
  9. Modify workflow to promote custom fields

Create a custom spreadsheet to support multi-company data loads

  1. Download the spreadsheet from Spreadsheet Management:
    1. From Mid Tier, select Applications > Data Management > Spreadsheet Management and make the following selections from the list:
      • Spreadsheet Type: BMC Template
      • Spreadsheet Category: Foundation
    2. Select the spreadsheet (Location in this example).
    3. Click Download.

      01 Download Location Spreadsheet.png
  2. Add the Company column to the spreadsheet:
    1. Rename the Location.xlsm spreadsheet to Multi_Company_Location.xlsm.
    2. Open Multi_Company_Location_xlsm.
    3. Add Company as the last column in the following worksheets:
      • SIT_LoadSiteGroup
      • SIT_LoadSiteCompanyAssoc
      • CTM_LoadRegion
    4. Save your changes.

Create a custom transformation

  1. Using the BMC Atrium Integrator Spoon client, connect to the AR System server by specifying server name and AR System server admin credentials.
  2. Select File > Open.
  3. In the Select Repository Object window, scroll down the list to the Location object with type Transformation and select it.
  4. Click OK.

    02 Select Repository Object window.png

    The transformation opens in a new window:

    03 Location transformation.png
  5. Select File > Save As and name the transformation Multi company support.
    A new copy of the transformation is created.

    04 Save transformation as Multi company support.png

  6. In the Multi company support transformation, add a field to SIT_LoadSiteGroup:

    1. Double-click the SIT_LoadSiteGroup icon.
    2. Select the Fields tab.
    3. Add a Company file with the following values:

      • Name: Company
      • Type: String
      • Length: -1
      • Precision: -1
      • Trim type: none
      • Repeat: N
      • Click OK.
        05 Add field to SIT_LoadSiteGroup.png
  7. Repeat step 6 for CTM_LoadRegion and SIT_LoadSiteCompanyAssoc. 
  8. Double-click SIT:LoadSiteGroup and open the Field Mapping tab.

    1. Use the pull-down menu to change the Company mapping from JobCompany to Company, then click OK.
      06 SIT LoadSiteGroup change JobCompany to Company.png 
    2. Repeat Step 8 and 9 for CTM:LoadRegion and SIT:LoadSiteCompanyAssoc.
  10. Select File > Save to save the entire transformation.

Create a custom Atrium Integrator job

  1. Open the Location job and select File > Open.
  2. Scroll to Location with type Job, then click OK.

    07 Select Location Job.png

    The Location job opens:

    08 Location Job.png
  3. Select File > Save As and name the job Multi-company support.
    A copy of the job is created.
  4. Select the Multi company support repository object:
    1. Double-click the Location icon:
      09 Double-click Location.png
    2. Click the Select a Transformation button (next to Specify by name and directory):
      10 Click Select a Transformation button.png
    3. Select the Multi company support transformation and click OK:
      11 Select Repository Object.png
    4.  Click OK.  
  5. Select File > Save to save the entire job.

Register the custom Atrium Integrator job with the Data Management Job Console

  1. From the BMC Remedy Mid Tier, log on as a user with DMT Admin permissions.
  2. Select Applications > Data Management > Job Console > Other Function > Atrium Integrator Job.
  3. Click Create.
  4. Complete the form:

    • Atrium Integrator Job: Multi_Company_Support 

      Do not use spaces in the Job name, use underscores instead.

    • Type: job
    • Directory: /
    • Log Level: Minimal
    • Select Attachment Required
    • Data Tag: cust

      13 Complete AI Job Form.png
  5. Click Save.

Use the Spreadsheet Management Console to attach the multi-company support spreadsheet

  1. From the BMC Remedy Mid Tier, log on using a user name with DMT Admin permissions.
  2. Select Applications > Data Management > Spreadsheet Management.
  3. Click Create and complete the form:
    • Description: Support Multi-company upload for Location
    • Company: Name of the company for which you want to make this spreadsheet available
    • Spreadsheet Type: Custom Template
    • Spreadsheet Category: Foundation
    • Spreadsheet Group: Location
    • Attach the Multi_Company_Location.xlsm spreadsheet.

      14_ Create Spreadsheet Information.png 

Create a custom Data Management job template

  1. From the BMC Remedy Mid Tier, log on with UDM Admin permissions.
  2. Select Applications > Data Management > Job Console > Other Function > Search template.
  3. Search for Location.
  4. When the Location template is available, select Copy template. 
  5. Complete the form: 
    • Template Name: Multi-company location support
    • Template Description: Multi-company
    • Category: Foundation
    • Template Type: Custom Template

      15_Copy template.png
  6. Click Save.
  7. View the job template that you just created:
    1. Click New Search for the job template for the Multi-company location support job.
    2. Open the template in Modify mode.
    3. Expand the Load step.
    4. Select the Load Location step.
    5. Click View.

      16_Template Details.png 
    6. Change Atrium Integrator Name to Multi_Company_Support and click Save.

      17_Step Details.png 

Run the newly created multi-company job

  1. Log on as a user with DMT Admin permission with unrestricted access.
  2. Populate data with Multi_Company_Location_xlsm.
  3. Select Application > Data Management > Job Console > Job Function > Create Job.
  4. Specify the job name and select a company, then click Save.
  5. Select Step > Create > Using BMC template and select the Multi Company location support template.

    18_Create Job Template.png 
  6. In the Load step, do the following:
    • Attach the spreadsheet.
    • Change job status from Draft to Built.
    • Run the job to load the data.

Extend load forms workflow to add custom fields

If you have used the above steps 1-8  to add custom fields to the spreadsheet and transformation, then you need to follow the additional steps mentioned in Making data load work with Foundation data customizations. These additional steps are required if you have to modify the workflow that updates the data from the staging forms to the target forms.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*