3. Compare function

3.1. Compare function overview

This document aims to explain how to use ITA's compare function.
The Compare function can be used to compare parameter sheets created with the ITA menu creation function and output any differences.

This function only supports "Parameter sheet (Host/with operation）".
For more information regarding parameter sheets, see "Parameter sheet creation function".

3.1.1. Compare function overview figure

The following figure illustrates a standard workflow using Compare function.
Collect function overview figure.

図 3.17 Collect function overview figure.

3.1.2. Compare function process diagram

The following figure illustrates the Compare function's process.
Compare results are output following the conditions specified in Comparison settings and Comparison advanced settings.
Compare function process figure

図 3.18 Compare function process figure

3.1.3. Compare function definition figure

The following figure illustrates paremeter sheet links and comparison results.
Fore more information regarding the Comparison settings and Comparison advanced settings settings, see Operating the Compare function.

・Parameter sheet links (When the parameter sheet items matches)
Comparison where parameter sheet items matches

図 3.19 Comparison where parameter sheet items matches


・Parameter sheet links (When the parameter sheet items don't match)
Comparison where parameter sheet items don't match

図 3.20 Comparison where parameter sheet items don't match

3.1.3.1. Standard date/time

If the corresponding operation has been executed in the past, the "Standard date/time" will be the "Last executed date/time".
If it has not been executed before, the "Standard date/time" will be the "Scheduled execution date/time".
For more information regarding "Standard date/time, see "Parameter sheet creation function".
Standard date/time diagram

図 3.21 Standard time/date diagram

Tip

The following is an example of a search result when a search is performed in the "For Reference" menu group using dates ① through ③ as "Standard date/time"
① At 1/1, no values are configured, meaning there are no search results. "Blank".
② At 3/15, the values set to Operation 1 will be displayed in the search results. "ParameterA:100".
③ At 5/15, the values set to Operation 4 will be displayed in the search results. "ParameterA:200".

3.1.3.2. Comparing parameter sheets

The Compare function uses the item information of the linked parameter sheets in the Comparison settings and Comparison advanced settings to compare values.

3.1.4. Compare function requirements

The following ITA settings must be configured in order to use the Compare function.
  • A Parameter sheet (Host/With operation) must be created in the Create/define Parameter sheets menu.
  • The target parameter sheets must have a link configured in the Comparison settings menu.
  • The target items must have a link configured in the Comparison advance settings menu.

注釈

Useres can only configure Comparison advanced settings if the Detailed settings flag in Comparison settings are set to "True".
If the comparing parameter sheet item number and item names matches, (Comparison advanced settings = False), the user does not have to configure Comparison advanced settings.

3.1.5. Comparison execution parameters

The following can be configured as parameters and be compared.
For more information regarding Comparison settings, see "Comparison settings".
Submenu page（Comparison execution）

図 3.22 Submenu page(Comparison execution)

表 3.15 Comparison execution parameters
Parameter
Description
Input required
Input format
Restrictions
Select Comparison settings
Select settings for the comparison.
○
List selection

Standard date/time 1
Input a date/time for Comparison settings' Parameter 1's "Standard date/time".

Manual
If nothing is input, the newest standard date/time will be applied.
Standard date/time 2
Input a date/time for Comparison settings' Parameter 2's "Standard date/time".

Manual
If nothing is input, the newest standard date/time will be applied.
Select host
Select a target host
Default: No filter. (Displays all comparison targets.)

List selection

3.2. Compare function target items

3.2.1. Comparison target parameter sheet items

The parameter sheet items that can be used by the Compare function are as following.
表 3.16 Parameter sheet comparison target items
Item type
Restrictions
String(single line)

String(multiple lines)

Integer

Decimal

Time/date

Date

Pulldown selection
Compares the lists' values.
Will display "ID conversion failure(X)" if the reference record has been deleted.
File upload
Compares both file name and file contents if both items are File upload.
Link

Parameter sheet reference
Compares the parameter sheets' values.
Will display "ID conversion failure(X)" if the reference record has been deleted.

3.2.2. Comparison target item combinations

The following list contains all item combinations that can be compared.
表 3.17 Comparison target item pattern combinations

String
(single line)
String
(multiple lines)
Integer
Decimal
Time/date
Date
Pulldown
selection
File
upload
Link
Parameter sheet
Reference
String
(single line)
○
○
○
○
○
○
○
○※1
○
○
string
(multiple lines)
○
○
○
○
○
○
○
○※1
○
○
Integer
○
○
○
○
○
○
○
○※1
○
○
Decimal
○
○
○
○
○
○
○
○※1
○
○
Pulldown
selection
○
○
○
○
○
○
○
○※1
○
○
File
upload
○※1
○※1
○※1
○※1
○※1
○※1
○※1
○
○※1
○※1
Link
○
○
○
○
○
○
○
○※1
○
○
Parameter sheet
Reference
○
○
○
○
○
○
○
○※1
○
○

注釈

※1 Comparison targets will be displayed as having differences even if only the file name or the contents are different. Items other than File uploads will not have their contents compared.

3.3. Compare function menu structure

This section explains the Compare function's menu structure.
The Compare function's menus are as following.
Compare menu list

図 3.23 Compare menu list

表 3.18 Compare page list
No
Menu group
Menu/Page
Description
1
Comparison
Comparison settings
Create configuration name for the comparison.
Configure link between target parameter sheets.
Setting the "Advanced settings" flag to "true" will make the "Comparison advanced settings" available.
2
Comparison
Comparison advanced settings
Configure link between the target items within the linked parameter sheets.
3

Comparison execution
Execute comparisons configured
in the "Comparison settings" and "Comparison advanced settings" menus.

3.4. Compare function step-by-step guide

This section explains how to use the Compare function in a step-by-step format.
A standard operation flow for the Compare function is as following.

3.4.1. Compare function execution flow

The following is a standard flow from start to comparing parameter sheets.

  • Operation flow details and references

    1. Creating parameter sheets
      Creae parameter sheets from the Create parameter sheet▶ Define/create parameter sheet menu.
      For more information, see "Parameter sheet creation function"
    2. Registering data to parameter sheets
      Register data to the parameter sheets created in the previous step.
      For more information, see "Parameter sheet creation function"
    3. Configuring Comparison settings
      Configure Comparison settings from the Compare▶ Comparison settings menu.
      For more information, see "Comparison settings"
    4. Configuring Comparison advanced settings
      Configure Comparison advanced settings from the Compare▶ Comparison advanced settings menu.
      For more information, see "Comparison advanced settings"
    5. Executing Comparison
      Execute the Comparison from the Compare▶ Comparison execution menu.
      For more information, see "Comparison execution"

3.5. Operating the Compare function

This sections explains the menus used by the Compare function.

3.5.1. Comparison settings

  1. The Comparison settings menu allows users to register and update links between parameter sheets that they want to compare.
    Submenu page（Comparison settings）

    図 3.24 Submenu page(Comparison settings)

  2. Press List ▶ Register or Edit to register Comparison settings.
    Registration/Edit page\(Comparison settings)

    図 3.25 Registration/Edit page(Comparison settings)

The items in the Comparison settings menu are as following.
表 3.19 Comparison settings item list
Item
Description
Input required
Input method
Restrictions
Comparison name
Input comparison name.
○
Manual
Maximum length: 255 bytes
Parameter sheet 1
Select a target parameter sheet.
○
List selection

Parameter sheet 2
Select a target parameter sheet.
○
List selection

Detailed settings flag
Select if the target parameter sheets' item names and
item numbers matches.
False: Will not require Comparison advanced settings.
True: Will require Comparison advanced settings.
-
List selection
※1
Remarks
Free description field.
-
Manual

注釈

※1 If the "Advanced settings flag" is set to "False", "Comparison advanced settings" will not be required. However, the items in the selected parameter sheets must have matching item numbers and item names.

3.5.2. Comparison advanced settings

  1. Configure links between the target parameter sheet's items in the Comparison advanced settings menu.
    Submenu page\(Comparison advanced settings\)

    図 3.26 Submenu page(Comparison advanced settings)

  2. Register comparison items with List ▶ Register or Edit.
    Registration/Edit page\(Comparison advanced settings\)

    図 3.27 Registration/Edit page(Comparison advanced settings)

The items in the Comparison item value management page are as following.
表 3.20 Registration page item list (Comparison settings)
Item
Description
Input required
Input format
Restrictions
Comparison name
Select comparison settings
○
List selection
※1
Comparison item name
Input a display name for the item.
This name will be used for the item in Comparison results.
○
Manual
Max length is 255 bytes
Target item 1
Select a target item.
○
List selection
※2
Target item 2
Select a target item.
○
List selection
※3
Display order
Input the display order.
Decides the display order in the Comparison results.
○

Input range is 0～2,147,483 and 647.
Remarks
Free description field
-


注釈

※1 All comparisons with the Advanced settings flag in the Comparison settings set to "True" will be displayed.
※2 Select items from the Target parameter sheet 1 registered in Comparison settings.
※3 Select items from the Target parameter sheet 2 registered in Comparison settings.

3.5.3. Comparison execution

The Comparison execution menu allows users to compare parameter sheets using the information defined in the Comparison settings and Comparison advanced settings menu.
・ The Comparison name registered in Comparison settings is displayed.
・ Pressing the Compare button starts the comparison process where the target parameter sheets and items are compared to each other.
・ Parameter sheet comparisons using bundles compares items that have the same names or the same input order set in "Comparison advanced settings".
Comparison execution page

図 3.28 Comparison execution page

表 3.21 Comparison execution requirements
Parameter
Description
Input required
Input format
Restrictions
Select Comparison settings
Select settings for the comparison.
○
List selection

Standard date/time 1
Input a date/time for Comparison settings' Parameter 1's "Standard date/time". ※1

Manual
If nothing is input, the newest standard date/time will be applied.
Standard date/time 2
Input a date/time for Comparison settings' Parameter 1's "Standard date/time". ※1

Manual
If nothing is input, the newest standard date/time will be applied.
Select host
Select a target host.
Default: No filter. (Displays all comparison targets.)※2
-
List selection
-

注釈

※1 If a standard date/time is input, the newest data from the specified date/time will be compared. If nothing is input, the newest data will be compared.
※2 Hosts cannot be filtered by default. The comparison results from all the hosts from the parameter sheets linked within the Comparison settings menu will be output.
Comparison results
  • Comparing parameter sheets
Comparison execution page\(Comparison results\)

図 3.29 Comparison execution page (Comparison results)

  • Comparing parameter sheets (When using bundles)
Comparison execution page \(Comparison results: when using bundles\)

図 3.30 Comparison execution page (Comparison results: when using bundles)

  • Comparing parameter sheets (File upload item)
Comparison execution page \(Comparison results: file upload item\)

図 3.31 Comparison execution page (Comparison results: file upload item)

Tip

Details regarding file differences
  • It is possible to see differences between the contents of 2 text based files.
  • Do note that it is not possible to see the differences between the contents of failes that contains binary data.
Comparison results
  • Target host
    Displays comparison results per host.
    Selecting a target will display more detailed comparison results.
表 3.22 Target host output list
Item
Description
Restrictions
Target host
Displays the Target host name.

Difference(s)
Displays comparison results. If there are differences, "✓" will be displayed.

  • Comparison results
    In the comparison results, the selected host name will be displayed together with detailed results.
表 3.23 Comparison result display content list
Item
Description
Restrictions
Item
Displays item name.
Difference(s)
Displays items' comparison results.
Displays "✓" if there are differences.
Comparison target parameter sheet 1
Displays the values from target parameter sheet 1.
Displays parameter sheet name in the header.
Comparison target parameter sheet 1
Displays the values from target parameter sheet 2.
Displays parameter sheet name in the header.
Remarks
Displays other information when items are compared.
File upload: Displaysa button for checking the file content comparison results.

Tip

Comparisons using bundles
  • Comparison items are displayed in the following format: (Name[Substitute order]).
  • Items with the same name or the same substitute order set in the Comparison advanced settings can be compared.
  • The following items are not displayed: Item number, Host name, Operation name, Standard date/time.