Archive Model

Product  Previous  Next

Performance Intelligence > Products > PIReporter for zOS > PIReporter for Batch > View and Models > Archive Model

Archive Batch History

The Archive model allows you to save old information to an archive database or delete old information from a production database.

Parameters:

 
Production Database Selection

PIReporter for Batch Production Management populates a historical database stored in SQL Server. In order to access the data stored in this database - a connection to the database needs to be established between the analysis application and the physical data.

The connection to the database depends on several factors:

  • How database authorization and authentication is implemented in your installation
  • Were is the Database physically stored on the network
  • Where is the BIModel Server - (The location where the analysis applications are executing) is physically located on the network
  • What database connection technology is used
Database authorization and authentication can be defined (by your database administrator at the SQL Server level) to be carried by Windows (using the standard Domain technology) or by SQL Server itself. The following is a technical explanation of database authentication methods.

When authorization is carried by Windows, the Windows user that is executing the analysis application needs to be authorized to access the database. All analysis applications executed in BIModel Server are executing under the SYSTEM account of the machine where the server is installed (This was done to ensure maximum security). It does, however, offer a challenge when database authorization is carried by Windows across machine boundaries, because by default the SYSTEM account is not authorized to access network resources. If SQL Server and BIModel Server share the same physical machine - Windows authorization is easy to implement and should be easy to implement. If, however, SQL Server is installed on a separate machine from the machine where BIModel Server is installed, and you want to use Windows authorization - you need to authorize the SYSTEM account of the executing application to access the database on the remote machine. Under Windows 2000 and later - the SYSTEM account of a machine is known on the network as an account with the name Domain\Machine - where Domain is the name of the network Domain and Machine is the name of the computer in the network. Please notice that if the network is configured to use the old NT 4 or earlier security model - the SYSTEM account can not gain network privileges and you can not use Windows Authorization to cross machine boundaries

If your installation prefers to use SQL Server authorization, or you can not use Windows authorization because of one of the reasons mentioned above, you need to consider how SQL Server performs it's authorization. Users can be defined in SQL Server, and a password and privileges can be assigned to them. Communication to SQL Server can be performed using several transport methods. The two most popular ones are "Named Pipes" - a Windows interprocess communication method, and "TCP/IP" - the Standard Internet packet based communication layer. Because "Named Pipes" is a Windows resource - it is protected using the same authorization and authentication methods that are performed using "Windows" authorization. TCP/IP on the other hand - is a transport mechanism that does not use Windows authorization and authentication, and thus can be used to connect between machines and circumvent the problems associated with granting the SYSTEM account network privileges. Using TCP/IP - we can pass a user-id and password between machines for SQL Server authorization from a SYSTEM account on a remote machine. The analysis application provided with PIReporter for Batch Production Management take advantage of this capability.

Finally - before discussing the specific PIReporter for Batch Production Management database connection implementation - we need to discuss the database technology used to connect to the data source. There are two standard database methods in Windows - ODBC and ADO/OLEDB. ODBC is the older technology - it is usually easier to setup, but is not as fast and capable as ADO/OLEDB. The analysis models allow you to choose between ODBC and ADO/OLEDB connection. When you select ODBC, you are actually still using ADO to connect, but you do it via an extra layer of software that bridges between ODBC and the analysis model. The sample reports that ship with PIReporter for Batch Production Management use the ODBC connection that is automatically defined for you during setup. However - this connection assumes that the analysis applications and SQL Server are installed on the same machine. If this is not the case(*), you will have to switch to the ADO/OLEDB connection. * - Please notice that for performance reasons, even if the same machine is used for SQL Server and BIModel Server - the ADO/OLEDB connection could be faster.

The Analysis models include several parameters you need to define in order to establish a connection to the history database. By default, the connection parameters assume that you will connect using the ODBC technology using the ODBC Data Source Name BPMTHIST that is automatically set for you during the installation process. This assumes that the applications (and BIModel Server) are installed on the same machine where SQL Server is installed. If, however, this is not the case - you will need to do one of the following:
  1. Define the correct connection with the ODBC Data Sources Control Panel Applet and provide the correct Windows authentication privelages over the network.
  2. Define the "Connection Type" paramter in the Models to "ADO String" and set the "Computer Network Address", "Database Name", "User ID" and "Password" parameters that will build a TCP/IP SQL authorization connection string.
Connection Type
The database connection technology that will be used. If ODBC is selected the application will connect via an ODBC System DSN that is taken from the "Database Name" parameter. If ADO String is selected, the application will connect to the server defined in the "Computer Network Address" parameter, the database defined in the "Database Name" parameter using the "User ID" and "Password" parameters for access authorization.
Values can be selected from the list of allowed values.
Predefined Values:
  • ODBC (ODBC) - This value is selected by default
  • ADO String (NULL)
Database Name
If the "Connection Type" parameter is set to ODBC - The name of the Database DSN that will be queried. This allows you to have multiple databases with different information in them. For example - by default the Setup program installs a history database for your data (BPMTHIST) and a sample database to experiment with (containing fictional data) BPMTSAMP. If the "Connection Type" parameter is set to ADO String - The name of the database in SQL Server
Values can be selected from the list or typed.
Predefined Values:
  • BPMTHIST (BPMTHIST) - This value is selected by default
  • BPMTSAMP (BPMTSAMP)
User ID
The User ID used to establish a connection to the database, if "ADO String" is selected in the "Connection Type" parameter. (This will be used for authorization by SQL over the TCP/IP transport)
Values can be selected from the list or typed.
Predefined Values:
  • B33UIDB_User (B33UIDB_User) - This value is selected by default
  • sa (sa)
Password
The Password used to establish a connection to the database, if "ADO String" is selected in the "Connection Type" parameter. (This will be used for authorization by SQL over the TCP/IP transport)
Values can be selected from the list or typed.
Predefined Values:
  • Default (B33UIDB_USER) - This value is selected by default
Computer Network Address
The name or network address (IP Value) of the machine where SQL Server is installed, if "Ado String" is selected for the "Connection Type" parameter.
Values can be selected from the list or typed.
Predefined Values:
  • 127.0.0.1 (127.0.0.1) - This value is selected by default
 
Archive Database Selection

PIReporter for Batch Production Management populates a historical database stored in SQL Server. In order to access the data stored in this database - a connection to the database needs to be established between the analysis application and the physical data.

The connection to the database depends on several factors:

  • How database authorization and authentication is implemented in your installation
  • Were is the Database physically stored on the network
  • Where is the BIModel Server - (The location where the analysis applications are executing) is physically located on the network
  • What database connection technology is used
Database authorization and authentication can be defined (by your database administrator at the SQL Server level) to be carried by Windows (using the standard Domain technology) or by SQL Server itself. The following is a technical explanation of database authentication methods.

When authorization is carried by Windows, the Windows user that is executing the analysis application needs to be authorized to access the database. All analysis applications executed in BIModel Server are executing under the SYSTEM account of the machine where the server is installed (This was done to ensure maximum security). It does, however, offer a challenge when database authorization is carried by Windows across machine boundaries, because by default the SYSTEM account is not authorized to access network resources. If SQL Server and BIModel Server share the same physical machine - Windows authorization is easy to implement and should be easy to implement. If, however, SQL Server is installed on a separate machine from the machine where BIModel Server is installed, and you want to use Windows authorization - you need to authorize the SYSTEM account of the executing application to access the database on the remote machine. Under Windows 2000 and later - the SYSTEM account of a machine is known on the network as an account with the name Domain\Machine - where Domain is the name of the network Domain and Machine is the name of the computer in the network. Please notice that if the network is configured to use the old NT 4 or earlier security model - the SYSTEM account can not gain network privileges and you can not use Windows Authorization to cross machine boundaries

If your installation prefers to use SQL Server authorization, or you can not use Windows authorization because of one of the reasons mentioned above, you need to consider how SQL Server performs it's authorization. Users can be defined in SQL Server, and a password and privileges can be assigned to them. Communication to SQL Server can be performed using several transport methods. The two most popular ones are "Named Pipes" - a Windows interprocess communication method, and "TCP/IP" - the Standard Internet packet based communication layer. Because "Named Pipes" is a Windows resource - it is protected using the same authorization and authentication methods that are performed using "Windows" authorization. TCP/IP on the other hand - is a transport mechanism that does not use Windows authorization and authentication, and thus can be used to connect between machines and circumvent the problems associated with granting the SYSTEM account network privileges. Using TCP/IP - we can pass a user-id and password between machines for SQL Server authorization from a SYSTEM account on a remote machine. The analysis application provided with PIReporter for Batch Production Management take advantage of this capability.

Finally - before discussing the specific PIReporter for Batch Production Management database connection implementation - we need to discuss the database technology used to connect to the data source. There are two standard database methods in Windows - ODBC and ADO/OLEDB. ODBC is the older technology - it is usually easier to setup, but is not as fast and capable as ADO/OLEDB. The analysis models allow you to choose between ODBC and ADO/OLEDB connection. When you select ODBC, you are actually still using ADO to connect, but you do it via an extra layer of software that bridges between ODBC and the analysis model. The sample reports that ship with PIReporter for Batch Production Management use the ODBC connection that is automatically defined for you during setup. However - this connection assumes that the analysis applications and SQL Server are installed on the same machine. If this is not the case(*), you will have to switch to the ADO/OLEDB connection. * - Please notice that for performance reasons, even if the same machine is used for SQL Server and BIModel Server - the ADO/OLEDB connection could be faster.

The Analysis models include several parameters you need to define in order to establish a connection to the history database. By default, the connection parameters assume that you will connect using the ODBC technology using the ODBC Data Source Name BPMTHIST that is automatically set for you during the installation process. This assumes that the applications (and BIModel Server) are installed on the same machine where SQL Server is installed. If, however, this is not the case - you will need to do one of the following:
  1. Define the correct connection with the ODBC Data Sources Control Panel Applet and provide the correct Windows authentication privelages over the network.
  2. Define the "Connection Type" paramter in the Models to "ADO String" and set the "Computer Network Address", "Database Name", "User ID" and "Password" parameters that will build a TCP/IP SQL authorization connection string.
Connection Type
The database connection technology that will be used. If ODBC is selected the application will connect via an ODBC System DSN that is taken from the "Database Name" parameter. If ADO String is selected, the application will connect to the server defined in the "Computer Network Address" parameter, the database defined in the "Database Name" parameter using the "User ID" and "Password" parameters for access authorization.
Values can be selected from the list of allowed values.
Predefined Values:
  • ODBC (ODBC) - This value is selected by default
  • ADO String (NULL)
Database Name
If the "Connection Type" parameter is set to ODBC - The name of the Database DSN that will be queried. This allows you to have multiple databases with different information in them. For example - by default the Setup program installs a history database for your data (BPMTHIST) and a sample database to experiment with (containing fictional data) BPMTSAMP. If the "Connection Type" parameter is set to ADO String - The name of the database in SQL Server
Values can be selected from the list or typed.
Predefined Values:
  • BPMTARCH (BPMTARCH) - This value is selected by default
User ID
The User ID used to establish a connection to the database, if "ADO String" is selected in the "Connection Type" parameter. (This will be used for authorization by SQL over the TCP/IP transport)
Values can be selected from the list or typed.
Predefined Values:
  • B33UIDB_User (B33UIDB_User) - This value is selected by default
  • sa (sa)
Password
The Password used to establish a connection to the database, if "ADO String" is selected in the "Connection Type" parameter. (This will be used for authorization by SQL over the TCP/IP transport)
Values can be selected from the list or typed.
Predefined Values:
  • Default (B33UIDB_USER) - This value is selected by default
Computer Network Address
The name or network address (IP Value) of the machine where SQL Server is installed, if "Ado String" is selected for the "Connection Type" parameter.
Values can be selected from the list or typed.
Predefined Values:
  • 127.0.0.1 (127.0.0.1) - This value is selected by default
 
Date Selection - Period 1
The Summary from Data Warehouse model offers date selection based on the Job Start Date (JDJSDATE) field and works with selection windows.

A selection window is an intersection of date and time coordinates. Think of the time as a two diemnsional grid with the dates on the X axis and the hours of the day on the Y axis. Imagine that your database contains information for the entire year and you want to view all the jobs that ran between July 4 and October 14 during peak work hours (9:00AM to 2:30PM)

In order to define this time window - we set the From Date parameter to July 4th, the To Date parameter to October 14, the Time Window Start parameter to 09:00 and the Time Window End parameter to 14:30.

Sometimes you might want to create a time window that spans over night - for example - you want to see all the jobs that executed between 9:00PM and 5:00AM. In order to achieve a time window that spans overnight you will need to use both Period 1 and Period 2 time windows.

Assume for example that you want to see all the jobs that executed over last night. You will set the parameters as follows:
  • Period 1 - Start Date = Yesterday, End Date = Yesterday, Time Window Start = 21:00, Time Window End = End of the Day
  • Period 2 - Start Date = Today, End Date = Today, Time Window Start = Start of the Day, Time Window End = 5:00
If you want to check the overnight performace for a range of days you will set the Time Window Start and End of Period 1 and 2 as in the previous example, but you will set the Start Date and End Date of the 2nd Period to one day later than the Start Date and End Date of the 1st Period. (For example if you want all the overnight time periods that started in August you will set the parameters as follows: Period 1 Start Date = Aug 1, End Date = Aug 31, Period 2 Start Date = Aug 2, End Date = Sep 1).
From Date - Period 1
Defines the first date in the time window. Only jobs (or intervals) that fall into the time window are included in the data analyzed. Notice that you can perform date calculation arithmetic on the value selected with the "From Date - Calculation Unit" and "From Date - Calculation Amount" parameters.
Values can be selected from the list of allowed values.
Optional and Allowed values will be retrieved from an external source like a database or on-line system.
Predefined Values:
  • First Day (NULL)
  • Today (Today)
  • Yesterday (Yesterday) - This value is selected by default
  • Start of This Work Week (StartOfThisWorkWeek)
  • Start of Previous Work Week (StartOfPrevWorkWeek)
  • End of Previous Work Week (EndOfPrevWorkWeek)
  • Start of This Month (StartOfThisMonth)
  • Start of Previous Month (StartOfPrevMonth)
  • End of Previous Month (EndOfPrevMonth)
  • Start of This Quarter (StartOfThisQuarter)
  • Start of Previous Quarter (StartOfPrevQuarter)
  • End of Previous Quarter (EndOfPrevQuarter)
  • Start of This Year (StartOfThisYear)
  • Start of Previous Year (StartOfPrevYear)
  • End of Previous Year (EndOfPrevYear)
  • Sunday (Sunday)
  • Monday (Monday)
  • Tuesday (Tuesday)
  • Wednesday (Wednesday)
  • Thursday (Thursday)
  • Friday (Friday)
  • Saturday (Saturday)
From Date - Calculation Unit
Use this parameter to determine what unit is going to be used for date arithmetic on the "From Date - Period 1" parameter.

e.g. - If "From Date - Period 1" is set to "Today", "From Date - Calculation Unit" is set to "Months" and "Fron Date - Calculation Amount" is set to "-1" - the From Date value that will be used will be one month before the execution day.

Values can be selected from the list of allowed values.
Predefined Values:
  • No Calculation (NULL) - This value is selected by default
  • Days (DAYS)
  • Weeks (WEEKS)
  • Months (MONTHS)
  • Quarters (QUARTERS)
  • Years (YEARS)
From Date - Calculation Amount
Use this parameter to determine what unit is going to be used for date arithmetic on the "From Date - Period 1" parameter.

e.g. - If "From Date - Period 1" is set to "Today", "From Date - Calculation Unit" is set to "Months" and "Fron Date - Calculation Amount" is set to "-1" - the From Date value that will be used will be one month before the execution day.

Values can be selected from the list or typed.
Predefined Values:
  • 0 (0) - This value is selected by default
To Date - Period 1
Defines the last date in the time window. Only jobs (or intervals) that fall into the time window are included in the data analyzed. Notice that you can perform date calculation arithmetic on the value selected with the "To Date - Calculation Unit" and "To Date - Calculation Amount" parameters.
Values can be selected from the list of allowed values.
Optional and Allowed values will be retrieved from an external source like a database or on-line system.
Predefined Values:
  • Last Day (NULL)
  • Today (Today)
  • Yesterday (Yesterday) - This value is selected by default
  • Start of This Work Week (StartOfThisWorkWeek)
  • Start of Previous Work Week (StartOfPrevWorkWeek)
  • End of Previous Work Week (EndOfPrevWorkWeek)
  • Start of This Month (StartOfThisMonth)
  • Start of Previous Month (StartOfPrevMonth)
  • End of Previous Month (EndOfPrevMonth)
  • Start of This Quarter (StartOfThisQuarter)
  • Start of Previous Quarter (StartOfPrevQuarter)
  • End of Previous Quarter (EndOfPrevQuarter)
  • Start of This Year (StartOfThisYear)
  • Start of Previous Year (StartOfPrevYear)
  • End of Previous Year (EndOfPrevYear)
  • Sunday (Sunday)
  • Monday (Monday)
  • Tuesday (Tuesday)
  • Wednesday (Wednesday)
  • Thursday (Thursday)
  • Friday (Friday)
  • Saturday (Saturday)
To Date - Calculation Unit
Use this parameter to determine what unit is going to be used for date arithmetic on the "To Date - Period 1" parameter.

e.g. - If "To Date - Period 1" is set to "Today", "To Date - Calculation Unit" is set to "Months" and "To Date - Calculation Amount" is set to "-1" - the To Date value that will be used will be one month before the execution day.

Values can be selected from the list of allowed values.
Predefined Values:
  • No Calculation (NULL) - This value is selected by default
  • Days (DAYS)
  • Weeks (WEEKS)
  • Months (MONTHS)
  • Quarters (QUARTERS)
  • Years (YEARS)
To Date - Calculation Amount
Use this parameter to determine what unit is going to be used for date arithmetic on the "To Date - Period 1" parameter.

e.g. - If "To Date - Period 1" is set to "Today", "To Date - Calculation Unit" is set to "Months" and "To Date - Calculation Amount" is set to "-1" - the To Date value that will be used will be one month before the execution day.

Values can be selected from the list or typed.
Predefined Values:
  • 0 (0) - This value is selected by default
Time Window Start - Period 1
The start of the time window within the selected date window. The Job Start Time (JDJSTIME) field will be compared to the value you provide for this parameter.
Values can be selected from the list or typed.
Predefined Values:
  • Start of the Day (00:00) - This value is selected by default
Time Window End - Period 1
The end of the time within the selected date window. The Job Start Time (JDJSTIME) field will be compared to the value you provide for this parameter.
Values can be selected from the list or typed.
Predefined Values:
  • End of the Day (00:00) - This value is selected by default
 
Analysis Selection
Analysis Type
Determine the records subtypes that will be selected:
  • Job Analysis - for subtype 4
  • Interval Analysis - for subtypes 2,3
Values can be selected from the list of allowed values.
Predefined Values:
  • Job Analysis (JOB)
  • Interval Analysis (INTVAL)
  • All (ALL) - This value is selected by default
 
Job Selection
System ID
The Identifier(s) of the system(s) that will be queried. The SMFID field will be compared to the value(s) you provide for this parameter.
Values can be selected from the list of allowed values.
Optional and Allowed values will be retrieved from an external source like a database or on-line system.
You can select up to 50 values for this parameter.
Predefined Values:
  • All (ALL) - This value is selected by default
Job Name
The name(s) of the job(s) that will be selected. The JDJNAME field will be compared to the value(s) you provide for this parameter. A Logical OR is performed between the values defined for this parameter and the values defined for the Job Selection Pattern parameter.
Values can be selected from the list of allowed values.
Optional and Allowed values will be retrieved from an external source like a database or on-line system.
You can select up to 50 values for this parameter.
Predefined Values:
  • All (ALL) - This value is selected by default
Job Selection Pattern
A Set of selection patterns that will be used to compare the JDJNAME field for selection.
  • Patterns can be separated with a comma, e.g. - Pattern1,Pattern2
  • Use * to define a set of 0 or more "any" characters in the pattern.
  • Use ? to to define a place holder for exactly 1 "any" character in the pattern.
e.g. - XYZ* will match all the job names that start with the letters XYZ including XYZ while XYZ? will match every 4 letters job name that starts with XYZ, but will not match the job name XYZ.
A Logical OR is performed between the values defined for this parameter and the values defined for the Job Name parameter.
Values can be selected from the list or typed.
Job Class
The Job Class(es) that will be queried. The SMF30CL8 field will be compared to the value(s) you provide for this parameter.
Values can be selected from the list of allowed values.
Optional and Allowed values will be retrieved from an external source like a database or on-line system.
You can select up to 50 values for this parameter.
Predefined Values:
  • All (ALL) - This value is selected by default
Exclude Jobs
A set of selection patterns that will be used to reject rows when comperd to the JDJNAME field.
The values for this parameter use the same pattern convention as the "Job Selection Pattern" parameter.
e.g. - If you want to select all the jobs that start with ZZ but exclude the job ZZ123 and all the jobs that start with ZZ6, you will enter ZZ* in the "Job Selection Pattern" parameter and ZZ123,ZZ6* in the "Exclude Jobs" parameter.
Values can be selected from the list or typed.
Step Name
The name(s) of the step(s) that will be selected. The JDJSNAME field will be compared to the value(s) that you provide for this parameter.
Values can be selected from the list of allowed values.
Optional and Allowed values will be retrieved from an external source like a database or on-line system.
You can select up to 50 values for this parameter.
Predefined Values:
  • All (ALL) - This value is selected by default
Proc Name
Define the Procedure(s) (Field JDSPROC) that will be included. Only entries that match the value of this parameter will be included in the data analyzed.
Values can be selected from the list of allowed values.
Optional and Allowed values will be retrieved from an external source like a database or on-line system.
You can select up to 50 values for this parameter.
Predefined Values:
  • All (ALL) - This value is selected by default
Work Type Indicator
Defines the Work type indicator(s) for the address space that will be selected. The SMF30WID field will be compared to the value(s) that you provide for this parameter.
Values can be selected from the list of allowed values.
Optional and Allowed values will be retrieved from an external source like a database or on-line system.
You can select up to 50 values for this parameter.
Predefined Values:
  • All (ALL) - This value is selected by default
Service Class Name
The Service Class(es) that will be queried. The SMF30SCN field will be compared to the value(s) you provide for this parameter.
Values can be selected from the list of allowed values.
Optional and Allowed values will be retrieved from an external source like a database or on-line system.
You can select up to 50 values for this parameter.
Predefined Values:
  • All (ALL) - This value is selected by default
 
Options
Archive Selected Source Rows
Determine if the data is inserted into the target (archive) database.
Values can be selected from the list of allowed values.
Predefined Values:
  • Do Not Archive (NULL)
  • Archive (YES) - This value is selected by default
Delete Selected Source Rows
Determine if the source data is deleted from the production database.
Values can be selected from the list of allowed values.
Predefined Values:
  • Do Not Delete (NULL)
  • Delete (YES) - This value is selected by default
Drop Source Index Before Operation
Determine if the index is dropped from the source database before the archive operation begins. Only performance tests will reveal if this makes sense for your scenario - but we would suggest leaving this option off by default.
Values can be selected from the list of allowed values.
Predefined Values:
  • Do Not Drop (NULL) - This value is selected by default
  • Drop Indices (YES)
Build Source Index After Operation
Determine if index will be built on the source database after execution ends. This makes sense only if you dropped the index prior to execution or if you know that no index exists on this database.
Values can be selected from the list of allowed values.
Predefined Values:
  • Do Not Build (NULL) - This value is selected by default
  • Build Indices (YES)
Drop Archive Index Before Operation
Determine if the index is dropped from the target database before the archive operation begins. Only performance tests will reveal if this makes sense for your scenario - but we would suggest leaving this option off by default.
Values can be selected from the list of allowed values.
Predefined Values:
  • Do Not Drop (NULL) - This value is selected by default
  • Drop Indices (YES)
Build Archive Index After Operation
Determine if index will be built on the archive database after execution ends. This makes sense only if you dropped the index prior to execution or if you know that no index exists on this database.
Values can be selected from the list of allowed values.
Predefined Values:
  • Do Not Build (NULL) - This value is selected by default
  • Build Indices (YES)
Command Timeout
The amount of time to wait for an archive or delete command before a timeout occures. Use 0 for no timeout.
Values can be selected from the list or typed.
Predefined Values:
  • 45 (45) - This value is selected by default