21 Using the Form Version Control Utility

This chapter describes the scope, content, and description of the Form Version Control (FVC) utility. It contains the following topics:

21.1 FVC Utility Scope

The following table provides a scope of the functions that are implemented with this utility:

Functionality Implemented (Yes/No) Comments
Upgrade process form version Yes Ensure that the target form version exists and is the active form version.
Upgrade child form version Yes The child form version is automatically upgraded to the child form attached with the active parent form.
Update values on parent form Yes Ensure that the target form version exists and has the fields whose values you are trying to update.
Update values on child form Yes Ensure that the target child form exists and the user is provisioned with the child form.
Insert values on child form Yes Ensure that fields that you are inserting exist on the child form version that is attached with the active parent form.

21.2 FVC Utility Content

The following table lists and describes the names and paths of the files that comprise the utility.

File Name with Path Description
OIM_DC_HOME\xlclient\lib\xlFvcUtil.jar
This JAR file contains the Form Version Control utility classes required to run it.
OIM_DC_HOME\xlclient\xlFvcUtil.ear
This EAR file contains the Form Version Control utility classes required to run it.
OIM_DC_HOME\xlclient\fvc.properties
This file contains all the configuration properties regarding the source and target form versions, the fields on them, their values, and child form information.
OIM_DC_HOME\xlclient\fvcutil.cmd
OIM_DC_HOME\xlclient\fvcutil_websphere.cmd
These scripts are used to run the Form Version Control Utility on Microsoft Windows systems. When you run this script, you must provide the Oracle Identity Manager administrator user name and password as shown in the following command:

OIM_DC_HOME\xlclient\fvcutil.cmd OIM_ADMINISTRATOR_LOGIN OIM_ADMINISTRATOR_PASSWORD


21.3 FVC Utility Description

The Form Version Control utility is designed to update the version number field of the custom process forms and data in the additional process form fields. The utility is started from the command console, and operates by using command-line parameters to login and a properties file. The parameters in the properties file and validity of user's login and password are verified and appropriate error messages are produced to signify an error when one occurs.

21.4 FVC Utility Features

The following list summarizes the FVC utility:

  • Per system requirements, the utility will update only process forms for objects whose status is not Revoked.

  • The utility has special provisioning for the case where form field values must be updated, but the form version should remain the same. In this case, the version to and version from parameters must be the same. The utility will not create an error, but it will update field values for the version specified without changing the version value itself.

  • The utility does not have any feature that will allow it to insert a child record. A child table record is considered to be a single child table field. Therefore, if the following entries exist in the fvc.properties file, it will create three different rows in the child table, instead of creating and inserting a single child record with the specified values for the three fields:

    Child;UD_CF3_FIELD7;tiger;Insert

    Child;UD_CF3_FIELD8;mad;Insert

    Child;UD_CF3_FIELD9;me2;Insert

  • The utility can only be used to update custom process forms when a value of Active Version is assigned to the ToVersion property in the fvc.properties file.

  • Default values for new fields must be defined in the property files.