Updating customer range field IDs

BMC Cloud Lifecycle Management uses specific field IDs in the BMC Cloud Lifecycle Management Portal applications and the CMDB extension forms. If you created custom fields as part of your customizations with these same field IDs and you try to upgrade to 4.x or apply an extension, the upgrade will fail.

Note

You do not need to run the ARFieldUpdater and archgid utilities with a new installation of version 4.x BMC Cloud Lifecycle Management. When you download the version 4.x executables from the BMC EPD site and install BMC Cloud Lifecycle Management, the field IDs are in the correct range. 

This topic covers the following information:

Before you begin

BMC uses two utilities to fix all the field IDs that are incorrectly used from version 2.1.x until the present.

UtilityDescription

ARFieldUpdater.zip

New utility that connects to the AR System server, detects all fields provided by BMC that are in the Customer ID range and resets the IDs for those fields. These are fields that were created before 4.1.x and can cause potential conflicts in the future.

Download the ARFieldUpdater zip file from the BMC Software FTP site

archgid.exe

Existing utility that fixes field IDs in version 4.x. Run this utility before you run the 4.x install planner to upgrade your environment.

This utility is available in the <AR System installed directory> (for example, C:\Program Files\BMC Software\ARSystem).

Note

  • These utilities address current issues and will help you avoid such failures in the future. You only need to apply the following fix to cloud upgrades; the fix does not apply to new installations of version 4.x.
  • These utilities specifically fix only field IDs consumed in previous versions of the the BMC Cloud Lifecycle Management solution. Even though BMC Cloud Lifecycle Management is integrated with ITSM and CDMB, you do not use these utilities to fix the field IDs in these BMC applications.

Make sure that you meet the following prerequisites:

  • Oracle JRE 1.7 64-bit is installed.
  • You must have at least 3GB free RAM to run the utility. 
  • You must have access to the VMs where Enterprise-AR and Cloud-AR are installed.

To extract the AR field updater utility

This section provides basic information about the ARFieldUpdater utility and describes how to extract it.

  1.  From the BMC Software FTP site, download the ARFieldUpdater zip file.

  2. Extract the ARFieldUpdater jar file to an accessible location.
    For example:
    C:\ARFieldUpdated 

    Note

    If you are upgrading Enterprise-AR and Cloud-AR, extract this utility on both VMs. 

    The zip file contains the following artifacts:

    • ARFieldUpdater.jar – Main executable jar.
    • 3rdParty – Libraries used for this utility and ARFieldUpdater.jar depends on this.  
    • attribute_config.json – Entries for all the field IDs that need to be updated. The configuration attributes are self-explanatory. 
    • config_files directory – Directory of input files for archgid utility.
    • readme – Basic information about the utility
  3. (Linux only) To run the utility, set the LD_LIBRARY_PATH to point to the <AR Install directory>/bin directory. 
    For example:
    "export LD_LIBRARY_PATH=/data1/bmc/arsystem/bin"

To update field IDs on single AR systems

Note

The following steps apply only to version 3.1 and 4.0 environments that run a single AR server.

Run the ARFieldUpdater utility on any cloud configuration where there is a separate Cloud-AR server. If you do not have a separate Cloud-AR server (because you are running version 4.x of BMC Cloud Lifecycle Management or you are using Compact Deployment), then run the utility on the Enterprise-AR server. 

  1. From the BMC Software FTP site, download the ARFieldUpdater zip file  to the AR server and extract it to an accessible location (for example, C:\ARFieldUpdated).
  2. Open a command window on the single AR server and change directories to the extracted location.
  3. Run the following command to start the ARFieldUpdater utility:
    java -jar ARFieldUpdater.jar
    The utility prompts you to enter the Enterprise-AR  login information. 
  4. At the prompt, enter the location of the file that contains the attribute information.
    For example:
    C:\ARFieldUpdated\attribute_config.json

    The utility shows you the progress for each attribute updated. For example:

    Microsoft Windows [Version 6.1.7601]
    Copyright (c) 2009 Microsoft Corporation.  All rights reserved.
    C:\Users\Administrator>cd C:\ARFieldUpdater_08142014
    C:\ARFieldUpdater_08142014>java -jar ARFieldUpdater.jar
    Please enter configuration details below.
    Press Enter key to choose the default values as specified in []
    Server name [localhost]:
    Port number [0]:
    User Name [Demo]:
    Password [Press Enter key for empty password]:
    File containing attribute information:
    C:\ARFieldUpdater_08142014\attribute_config.json
    INFO: Authentication to the AR server is successful.
    INFO: Processing Attribute Ipv4DnsName...
    INFO: Updating following attribute definition:
    {1=000000000001654, 400009700=Ipv4DnsName, 400004800=536871915, 400079600=BMC_COMPUTERSYSTEM, 400109800=BMC.CLOUD}
    INFO: Updated to following attribute definition:
    {1=000000000001654, 400009700=Ipv4DnsName, 400004800=530072916, 400079600=BMC_COMPUTERSYSTEM, 400109800=BMC.CLOUD}

     

  5. After the ARFieldUpdater utility is finished, change directories in the command window to the <AR System installed directory> (for example, C:\Program Files\BMC Software\ARSystem).
    Now you must run the archgid utility. Choose the config files, based on the version of BMC Cloud Lifecycle Management from which you are upgrading. Each directory has two or more config files and you must run the utility on them sequentially, first updatefid_1, updatefid_2, and so on. 
  6. Run the archgid command the first time, pointing the utility to the first config file of the version you are upgrading.

    Note

    For tracking purposes, the archgid command output was directed to a log file by appending the following option:
    > <log file name along with path>

    For example: 
    archgid.exe -x <AR Server name> -t <AR Port no> -u <Administrator User or Demo> -p <password> -c 10003 -F <config file path along with name>  > <Directory and name of log>
    archgid.exe -x vw-aus-asp-dv53 -t 0 -u Demo -p "" -c 10003 -F C:\ARFieldUpdated\archgid\4.1\4_1_updatefid_1.txt > C:\ARFieldUpdater_08142014\4_1_updatefid_1.log

  7. Review the log file to see which field IDs were updated and where they were updated (for example, the script updated form CMF:LogicalDataCenter_v with the old field ID 536870913 to the new field ID 304339301 during Phase 1).
  8. Run the archgid command again, pointing the utility to the next config file of the version you are upgrading.
    For example:
    archgid.exe -x vw-aus-asp-dv53 -t 0 -u Demo -p "" -c 10003 -F C:\ARFieldUpdated\archgid\4.1\4_1_updatefid_2.txt > C:\ARFieldUpdater_08142014\4_1_updatefid_2.log 

  9. When you finish running the archgid utility against all the available config files. review the log file to see which field IDs were updated and where they were updated (for example, the script updated form CMA:SOICLContract_FCRSCS_Dep_Join with the old field ID 536870914 to the new field ID 304399291 during Phase 1).

To update field IDs in dual Enterprise-AR and Cloud-AR environments

These steps apply to BMC Cloud Lifecycle Management environments running dual Enterprise-AR and Cloud-AR servers.

Updating Cloud-AR

Note

  • The following Cloud-AR steps apply only to version 4.0 environments. They are not required for earlier versions.
  • Make sure that the Cloud-AR server is running.
  1. Download the ARFieldUpdater zip file to the Cloud-AR server and extract it to an accessible location (for example, C:\ARFieldUpdated).
  2. Open a command window on Cloud-AR and change directories to the extracted location.
  3. Run the following command to start the ARFieldUpdater utility:
    java -jar ARFieldUpdater.jar
  4. At the prompts, enter the required settings.
    For example, enter the location of the file that contains the attribute information:
    C:\ARFieldUpdated\attribute_config.json

    The utility shows you the progress for each attribute updated.

    Microsoft Windows [Version 6.1.7601]
    Copyright (c) 2009 Microsoft Corporation.  All rights reserved.
    C:\Users\Administrator>cd C:\ARFieldUpdater_08142014
    C:\ARFieldUpdater_08142014>java -jar ARFieldUpdater.jar
    Please enter configuration details below.
    Press Enter key to choose the default values as specified in []
    Server name [localhost]:
    Port number [0]:
    User Name [Demo]:
    Password [Press Enter key for empty password]:
    File containing attribute information:
    C:\ARFieldUpdated\attribute_config.json
    INFO: Authentication to the AR server is successful.
    INFO: Processing Attribute Ipv4DnsName...
    INFO: Processing Attribute Ipv6DnsName...
    INFO: Processing Attribute ProbingPort...
    INFO: Processing Attribute ProbingPath...
    INFO: Processing Attribute Sequence...
    INFO: Processing Attribute IsEnabled...
    INFO: Processing Attribute IsPublic...
    INFO: Processing Attribute AddressBlock...
    INFO: Processing Attribute AddressVisibility...
    INFO: Processing Attribute Id...
    INFO: Processing Attribute IpAddress...
    INFO: Processing Attribute User...
    INFO: Processing Attribute AutonomousSystemNumbe
    INFO: Processing Attribute BackEndProtocol...
    INFO: Processing Attribute IsDefault...
    INFO: Processing Attribute FrontEndProtocol...
    INFO: Processing Attribute Id...
    INFO: Processing Attribute AvailableCapacity...
    INFO: Processing Attribute IsDefault...
    INFO: Processing Attribute ProbingProtocol...

     

  5. After the ARFieldUpdater utility is finished, change directories in the command window to the <AR System installed directory> (for example, C:\Program Files\BMC Software\ARSystem).
    Now you must run the archgid utility at least two times (for example, for 4_0_updatefid_1.txt and then for 4_0_updatefid_2.txt).

  6. Run the archgid command the first time, pointing the utility to the first config file of the version you are upgrading.

    Note

    For tracking purposes, you can redirect the archgid command output to a log file by appending the following option:
    > <log file name along with path>

    For example: 
    archgid.exe -x <CAR Server name> -t <CAR Port no> -u <Administrator User or Demo> -p <password> -c 10003 -F <config file path along with name>  > <Directory and name of log>
    archgid.exe -x vw-aus-asp-dv53 -t 0 -u Demo -p "" -c 10003 -F "C:\ARFieldUpdated_09092014\config_files\Two AR\CAR\4.0\cmdb\4_0_updatefid_1.txt" 

  7. Review the log file to see which field IDs were updated and where they were updated.
  8. Run the archgid command again, pointing the utility to the next config file of the version you are upgrading.
    For example:
    archgid.exe -x vw-aus-asp-dv53 -t 0 -u Demo -p "" -c 10003 -F "C:\ARFieldUpdated_09092014\config_files\Two AR\CAR\4.0\cmdb\4_0_updatefid_2.txt" > C:\ARFieldUpdater_09092014\4_0_updatefid_2.log
  9. When you finish running the archgid utility against all the available config files. review the log file to see which field IDs were updated and where they were updated.

Updating Enterprise-AR

Note

  • The following Enterprise-AR steps apply to 2.1, 3,0. 3.1 and 4.0 environments. 
  • Make sure that the Enterprise-AR server is running.
  1. Download the ARFieldUpdater zip file to the Enterprise-AR server and extract it to an accessible location (for example, C:\ARFieldUpdated).
  2. Open a command window on Enterprise-AR and change directories to the <AR System installed directory> (for example, C:\Program Files\BMC Software\ARSystem).
    Now you must run the archgid utility. Choose the config files, based on the version of BMC Cloud Lifecycle Management from which you are upgrading. Each directory has two or more config files and you must run the utility on them sequentially, first updatefid_1updatefid_2, and so on. 
  3. Run the archgid command the first time, pointing the utility to the first config file of the version you are upgrading.

    Note

    For tracking purposes, you can redirect the archgid command output to a log file by appending the following option:
    > <log file name along with path>

    For example: 
    archgid.exe -x <EAR Server name> -t <EAR Port no> -u <Administrator User or Demo> -p <password> -c 10003 -F <config file path along with name>  > <Directory and name of log>
    archgid.exe -x vw-aus-asp-dv53 -t 0 -u Demo -p "" -c 10003 -F "C:\ARFieldUpdated_09092014\ARFieldUpdated_09092014\config_files\Two AR\EAR\3.1\3_1_updatefid_1.txt"

  4. Review the screen or the log file to see which field IDs were updated and where they were updated:

    Updating form CMA:SOICLContract_FCRSCS_Join with field ID 536870914 to new I
     304399291
    **   Updating fieldId in data dictionary tables
         *   field
         *   schema_list_fields
         *   schema_sort
         *   field_dispprop
         *   field_int
         *   field_real
         *   field_diary
         *   field_char
         *   field_enum
         *   field_enum_values
         *   field_permissions
         *   field_attach
         *   field_table
         *   field_column
         *   field_dec
         *   join_mapping
         *   field_view
         *   field_display
         *   view_mapping
  5. Run the archgid command again, pointing the utility to the next config file of the version you are upgrading.
    For example:
    archgid.exe -x vw-aus-asp-dv53 -t 0 -u Demo -p "" -c 10003 -F "C:\ARFieldUpdated_09092014\ARFieldUpdated_09092014\config_files\Two AR\EAR\3.1\3_1_updatefid_2.txt"
  6. When you finish running the archgid utility against all the available config files. review the screen or log file to see which field IDs were updated and where they were updated.

    Phase 3
        Updating form CMA:SOICLContract_FCRSCS_Dep_Join with field ID 536870914 to n
    ew ID 304399291
     **   Updating join and DB view of joins using this form
          *   Updating form CMA:SOICLContractFCRSCSCC_Join
              - updated the join qualification
           Successful
        Updating form CMA:SOICLContract_FCRSCS_Dep_Join with field ID 536870915 to n
    ew ID 304297150
     **   Updating join and DB view of joins using this form
          *   Updating form CMA:SOICLContractFCRSCSCC_Join
              - updated the join qualification
           Successful

     

  7. Run the BMC Cloud Lifecycle Management use cases to verify that your environment works as expected. 

Troubleshooting archgid errors

Sometimes archgid (the field updater utility) fails with the following error message in the output:

** Updating all fieldIds in active link definitions

**** Cannot open catalog; Message number = 93 (UNKNOWN 93)

<machine-name>

This error occurs because an API operation has timed out.

If you see this error, perform the following workaround: 

  1. Set the ARAPILOGGING environment variables:
    export ARAPILOGGING=24
    This action automatically generates the arapires.log and arapicmd.log files.
  2. Open the resulting arapires.log file and review which operation timed out and the amount of time it took to complete that operation before it timed out.
  3. After this. adjust the ARAPITIMEOUTS environment variable to extend the timeout amount. 
    export ARAPITIMEOUTS=<timeouts>
    For example:
    export ARAPITIMEOUTS=500:1200:1800
    The defaults are 120:300:1800For more information, see https://kb.bmc.com/infocenter/index?page=content&id=S%3AKA291887&actp=search&viewlocale=en_US&searchid=1414500837369
  4. Run the archgid utility again.

 

Where to go next

Performing the upgrade

Was this page helpful? Yes No Submitting... Thank you

Comments