Skip to main content
insightsoftware Documentation insightsoftware Documentation
{%article.title%}
Published:
Was this article helpful?
0 out of 0 found this helpful

History

Use this command to record commands executed by a procedure document to a history file.

Copy

Syntax

HISTORY ON|DETAIL "FileName"
HISTORY ON|DETAIL
HISTORY TIMERRUN|TIMEROFF
HISTORY TIMERSTART|TIMERSTOP
HISTORY OFF                                            

where:

Value

Description

ON

To record commands run from a Procedure document. Your computer may experience delays.

The first time you use HISTORY ON or HISTORY DETAIL, you must specify a value for "FileName". For subsequent uses of HISTORY ON or HISTORY DETAIL, "FileName" is optional.

If you use HISTORY ON without the "FileName" parameter after a HISTORY OFF command, HISTORY ON resumes recording commands in the history file specified by the last "FileName" parameter.

DETAIL

The DETAIL option can be used instead of the HISTORY ON command. It prompts the system to insert detailed messages useful for diagnostic purposes into the designated history file. DETAIL messages are identifiable by the ">>>" prefix. All DETAIL messages end with a statement of the amount of memory, in kilobytes, consumed by the operation. If HISTORY DETAIL is used in conjunction with the HISTORY TIMERUN command, DETAIL messages are headed by a time stamp indicating when the operation occurred.

The first time you use HISTORY ON or HISTORY DETAIL, you must specify a value for "FileName". For subsequent uses of HISTORY ON or HISTORY DETAIL, "FileName" is optional.

If you use HISTORY DETAIL without the "FileName" parameter after a HISTORY OFF command, HISTORY DETAIL resumes inserting detailed messages in the history file specified by the last "FileName" parameter.

"FileName"

An ASCII file in which the history details will be saved. If the file name includes spaces, enclose it in double quotation marks; for example:

"C:\My Documents\My filename.txt"

If the ASCII file does not exist, your system creates it. If the file exists, the history details are added to the end of the existing file.

TIMERRUN

To record the time taken by each command for the rest of the session or until TIMEROFF.

It can be used only if preceded by HISTORY ON or HISTORY DETAIL.

It writes a time stamp for each command that indicates the total time elapsed since HISTORY TIMERRUN was first called. Once it is called, the time it keeps remains in effect for the rest of the session.

TIMEROFF

To stop recording time taken by each command for the rest of the session.

TIMERSTART

To start recording the time elapsed for a certain series of Events.

It can be used only if preceded by HISTORY ON or HISTORY DETAIL.

If HISTORY TIMERSTART is called after HISTORY TIMERRUN, the time stamp displayed for each command thereafter is the time elapsed since TIMERSTART was called. Once HISTORY TIMERSTOP is called, all commands thereafter will display the total elapsed time.

TIMERSTOP

To stop recording the time elapsed for a certain series of Events.

OFF

Turns off the recording of commands run from a Procedure document. This is the default.

The following messages are output for the following commands when HISTORY DETAIL is used:

Command

Messages

UPLOAD

  • >>> Total number of values in the DataArea:
  • >>> Total number of values uploaded:

DOWNLOAD

  • ">>> DOWNLOAD peak memory usage (MemKb)"—gives peak memory usage during DOWNLOAD command
  • ">>> Populated DATAAREA with N values (MemKb)"—tells how many values were added to the DATAAREA

RUN MODEL

  • ">>> DATAAREA contains N values (before) (MemKb)"—tells size of DATAAREA before Model execution
  • ">>> Executing on N X N X N X N ... X N = N nodes (MemKb)"—for each CALCULATIONBLOCK, tells size of block (in dimension index order), and total number of nodes on which statements will be executed
  • ">>> (line N) statement (MemKb)"—echoes out each line of the Model prior to execution
  • ">>> ...processed N records... (MemKb)"—reports every 10,000,000 nodes of execution
  • ">>> DATAAREA contains N values (after) (MemKb)"—tells size of DATAAREA after Model execution
Copy

Syntax example

HISTORY ON history.txt            
Published:

History

Use this command to record commands executed by a procedure document to a history file.

Copy

Syntax

HISTORY ON|DETAIL "FileName"
HISTORY ON|DETAIL
HISTORY TIMERRUN|TIMEROFF
HISTORY TIMERSTART|TIMERSTOP
HISTORY OFF                                            

where:

Value

Description

ON

To record commands run from a Procedure document. Your computer may experience delays.

The first time you use HISTORY ON or HISTORY DETAIL, you must specify a value for "FileName". For subsequent uses of HISTORY ON or HISTORY DETAIL, "FileName" is optional.

If you use HISTORY ON without the "FileName" parameter after a HISTORY OFF command, HISTORY ON resumes recording commands in the history file specified by the last "FileName" parameter.

DETAIL

The DETAIL option can be used instead of the HISTORY ON command. It prompts the system to insert detailed messages useful for diagnostic purposes into the designated history file. DETAIL messages are identifiable by the ">>>" prefix. All DETAIL messages end with a statement of the amount of memory, in kilobytes, consumed by the operation. If HISTORY DETAIL is used in conjunction with the HISTORY TIMERUN command, DETAIL messages are headed by a time stamp indicating when the operation occurred.

The first time you use HISTORY ON or HISTORY DETAIL, you must specify a value for "FileName". For subsequent uses of HISTORY ON or HISTORY DETAIL, "FileName" is optional.

If you use HISTORY DETAIL without the "FileName" parameter after a HISTORY OFF command, HISTORY DETAIL resumes inserting detailed messages in the history file specified by the last "FileName" parameter.

"FileName"

An ASCII file in which the history details will be saved. If the file name includes spaces, enclose it in double quotation marks; for example:

"C:\My Documents\My filename.txt"

If the ASCII file does not exist, your system creates it. If the file exists, the history details are added to the end of the existing file.

TIMERRUN

To record the time taken by each command for the rest of the session or until TIMEROFF.

It can be used only if preceded by HISTORY ON or HISTORY DETAIL.

It writes a time stamp for each command that indicates the total time elapsed since HISTORY TIMERRUN was first called. Once it is called, the time it keeps remains in effect for the rest of the session.

TIMEROFF

To stop recording time taken by each command for the rest of the session.

TIMERSTART

To start recording the time elapsed for a certain series of Events.

It can be used only if preceded by HISTORY ON or HISTORY DETAIL.

If HISTORY TIMERSTART is called after HISTORY TIMERRUN, the time stamp displayed for each command thereafter is the time elapsed since TIMERSTART was called. Once HISTORY TIMERSTOP is called, all commands thereafter will display the total elapsed time.

TIMERSTOP

To stop recording the time elapsed for a certain series of Events.

OFF

Turns off the recording of commands run from a Procedure document. This is the default.

The following messages are output for the following commands when HISTORY DETAIL is used:

Command

Messages

UPLOAD

  • >>> Total number of values in the DataArea:
  • >>> Total number of values uploaded:

DOWNLOAD

  • ">>> DOWNLOAD peak memory usage (MemKb)"—gives peak memory usage during DOWNLOAD command
  • ">>> Populated DATAAREA with N values (MemKb)"—tells how many values were added to the DATAAREA

RUN MODEL

  • ">>> DATAAREA contains N values (before) (MemKb)"—tells size of DATAAREA before Model execution
  • ">>> Executing on N X N X N X N ... X N = N nodes (MemKb)"—for each CALCULATIONBLOCK, tells size of block (in dimension index order), and total number of nodes on which statements will be executed
  • ">>> (line N) statement (MemKb)"—echoes out each line of the Model prior to execution
  • ">>> ...processed N records... (MemKb)"—reports every 10,000,000 nodes of execution
  • ">>> DATAAREA contains N values (after) (MemKb)"—tells size of DATAAREA after Model execution
Copy

Syntax example

HISTORY ON history.txt            
For an optimal Community experience, Please view on Desktop