Basic Script & Log File
Anatomy:
Basic
Script File: Below is a basic script file that connects and sends files to another
computer. We have added numbers to each
line in our example (which are not really in a script file) to help you know which
line we are referring to in the following analyses.
1 {The
following options are the default values used for this script file}
2 logging
3 logging = on
4 log file name = Results to Cairo.log
5 add current date to logfile name = yes
6 append new entries = yes
7 logfile details = full
8 end
logging
9 exit
10 when exiting script file = hangup existing
connection(s)
11 end
exit
12 {End
of default values used for this script file}
13 connect
14 connection = User:Cairo
15 end
connect
16 transfer
files
17 transfer type = copy
18 transfer method = smart
19 transfer option = (send all files) copies
all files or folders you select to the destination pc.
20 if file exists on destination computer = replace
the existing file if it is older
21 mirror image backup = no
22 include subfolders = yes
23 folder name on my computer = c:\results\*.*
24 folder name on other computer =
\\cairo\c\update
25 end
transfer files
26 disconnect
27 connection = User:Cairo
28 end
disconnect
29 retry
failures
30 if failure(s) occur during connection(s),
retry it = 5 times
31 time to wait between retry of failure(s)
= 3 minute(s)
32 if failure(s) still occur after retries =
continue script file
33 end
retry failures
a) Lines 1 through 12 are the default (control) values section. You can change these values using the iClose-Up Editor or your
word processor.
Line 3:
Logging can be On or Off. If On an iClose-Up Log File will be created as specified in Line 4.
If Off no Log
file will be created.
Line 4:
By default the Log file will have the name that you save your Script file with. (In our example our script file has the name “Results to
Cairo”). The Log will be saved by
default in a folder named Script Logs which is in the folder Log Files, which is in the folder iClose-Up, which is in the folder Program
Files on your “C” drive (C:\Program Files\iClose-Up\Log Files\Script Logs). You can change the default name and
location, as you specify in Line 4.
Line 5:
“Add current date to log file name” can be Yes or No. If Yes the date your Script File ran will be
appended to the end of the Log File name.
If No then no
date will be added.
Line 6:
“Append new entries” can be Yes or No. If Yes a new Log will be appended to the existing. If No a new
Log will overwrite the old Log.
Line 7:
“Logfile details” can be Full or Summary. If Full the Log created will give details of
each action taken as well as the results of those actions. If Summary the Log created will have a short summary.
Lines 9 through 11: Are the exit section which controls modem to modem
connections (not ISP Internet connections).
To modify the exit section line 10, click the Next
key. When exiting the script file you
can choose “Hangup existing connection(s)” which tells iClose-Up to hang up the modem when the script is
finished. Or you can choose “Leave existing connection(s) connected” which tells
iClose-Up to not hang up the modem when the script is finished.
b) Next we jump to Lines 29 through 33 which is
the Retry Failures section. To modify
this section, click the Next key. When problems occur
(usually only on Internet connections, rarely on modem to modem connections)
the iClose-Up Script will retry the connection and transfer or procedure
again. This Retry Failures section is usually the last
section in an iClose-Up script.
Occasionally multiple Retry Failure sections are used, see “Line 33” below for a description of this.
Line 30:
“If failures occur during
connection, retry it”. The default value is 5 times.
On a modem to modem connection a value of 1 or 2 is probably all that is
needed. On an Internet connection
higher values can sometimes be needed.
Factors to be considered are how much data (how many bytes) need to be
transferred. How important is it to get
the data through. How bad is the
Internet at the time of the transfer.
What is the speed of the Internet (ISP) connection at both
ends. If you were transferring a lot of
data through slow connections to the Internet, then you would use a higher
value in this option. (Remember that
the speed of an Internet connection is defined by the slowest of the two
connections, at each end of the transfer.)
Some iClose-Up users find when transferring over 75 or 100 megabytes, at
56K or slower, through the Internet, that setting this value higher worked
well.
Line 31:
“Time to wait between retry of
failures”.
The default value is 3 minutes.
This value was defaulted to 3 minutes because some modems can take this
long to reset and stabilize. Many
iClose-Up users have found that setting this value down to 1 minute worked
well.
Line 32:
“If failures still occur after
retries”.
The default is “Continue script file” which is generally the way you will always want to set this
option.
The other
option is to “Abort script file”. This option is used when you
have a script that is transferring to multiple locations. Say the script first Fetches (retrieves) an inventory file from
location A, and
then Sends the inventory
file to locations B through Z.
If the script can’t Fetch the inventory file from location A then there is no reason to go on and execute the Send commands to locations B through Z. Therefore in the script right
after the Disconnect section that goes with the Fetch section (before the Connect section that goes with the Send sections) you would put in a Retry
Failures section set to “Abort script file”. This would then abort your script if it could not Fetch the inventory file successfully. Note, you would still want to put in one
other Retry Failure section at the end of your script set to
“continue script file” to retry any of the sends to locations B through Z that failed for one reason or another the first time through.
There is no
limit to the number of Retry Failure sections you can have in a script.
See Aborting
a Script with a Failed Transfer section to see an example.
Click Next to start creating your script file.
c) Next lines 13 through 15 are the Connect section. In the iClose-Up
creation wizard you choose your connection from all the entries in the
iClose-Up List.
d) Next lines 16 through 25 are the Transfer section.
Line 17:
“copy”. The default is to copy files verses a “move”.
A “move” copies
like the “copy” command
but then deletes the original files. To
set this to “move” use
iClose-Up editor or your word processor and replace the word “copy” with “move”.
Line 18:
“smart”. The iClose-Up wizard will
put in smart if you are transferring to another iClose-Up computer, and will put in
Mach 1 if sending to
a computer that does not have iClose-Up on it.
Smart allows iClose-Up to choose the best type of transfer method and the
best type of compression depending on the information in the file and the speed
of the connection.
Line 19:
You can pick Send, Fetch, or Synchronize. You then can select “all files” or “common
files”. In our
example we picked Send.
Send all files sends all the files in the folder
you select.
Send common files sends only files that have the
same name on both PC’s. (Files Common
to both sides.) Lets look at an example
to further illustrate this choice. My
home PC#1 has a folder with a lot of files a, b, d, e, f, g, h, I, j, k, l, m,
and my office PC#2 has a folder with files b, c, now I don’t want all my home
files sent to my office PC, so when I use “Send common files”. Then only file “b” which is common to both
PC’s will be sent to the other side.
Line 20:
“if file exists on destination
computer”.
If you are sending a file and it already exists on the other computer
what action should be taken.
“Replace the existing file if it is older”. This is the default and is the option used
most often.
If the file
name you are sending already exists on the other computer and your file’s time
and date is newer, then delete the old file on the other computer and send your
file.
“Replace the existing file always”. If the file name you are sending already
exists on the other computer, then delete the file on the other computer, and
then send your file.
“Do not copy the file”. If the file name you are sending already exists on the other
computer, then do not send the file.
File time and date are ignored.
“Rename the existing file if it is older”. If the file name you are sending already
exists and is older on the other computer, then rename the file on the other computer,
and then send your file.
“Rename the existing file always”. If the file name you are sending already
exists on the other computer, then rename the file on the other computer, and
then send your file.
Line 21:
“Mirror Image Backup”. You can choose Yes or No. You will generally only
choose Yes if you
are making a Script to do an offsite Backup.
This option works on Sends and Fetches but not on Synchronizes.
iClose-Up will
take any extra files or folders on your destination computer that do not exist
on the source computer and move them to the iClose-Up Deleted Files Archive folder in the root directory.
iClose-Up will append the date and time to the file or folder
moved. This option works only when one
or more folders are selected for transfer and works only on those folders
selected, if just a file or multiple files and no folders are selected for
transfer then this option will not delete and move any files.
Mirror Image
Backup is useful when you are backing up on an ongoing basis data from one
computer to another. With this option
any files or folders that have been deleted from the source computer will be
deleted from the destination computer’s folder and moved to the iClose-Up Deleted Files Archive folder. As an example say you backup the office
fileserver to your home computer. Each
day people at the office delete files and folders on the fileserver. After a few days or a few months you can see
that your folders at home would have many extra “deleted” files and folders and
not be a mirror image of the office fileserver. By turning on Mirror Image Backup your home computer will always
be a mirror image of the office fileserver.
Any files or folders that get deleted at the office will be deleted from
that directory on your home computer and moved to the iClose-Up Deleted
Files Archive folder.
In addition iClose-Up will append the date and time to the file or
folder deleted and moved.
Then if someone
at the office says they deleted a file or folder 6 months ago and they now
desperately need it, you can find it instantly in the iClose-Up Deleted
Files Archive folder.
Line 22:
“Include subfolders”. You can choose Yes or No.
Line 23:
“Folder name on my computer”. This line gives the path,
folder and file names you have chosen to transfer. In our example we are sending all files in the folder with a star
dot star “*.*”.
Line 24:
“Folder name on other computer”. This line gives the path,
and folder you have chosen to send files to.
e) Next lines 26 through 28 are the Disconnect section. The iClose-Up creation wizard will put in a disconnect section to
match the connect section, lines 13 through 15.
Log
File: Below is an iClose-Up Log file that was created by running the above
basic Script File. We have added numbers
to each line in our example to help you know which line we are referring to in
the following analyses.
1 (10:00:03
PM) Script started on Monday, 4/16/01
2 (10:00:03
PM) C:\Program Files\iClose-Up\Script Files\Results to Cairo.cupscr
3 (10:00:03
PM) 1.1.1.382
4 (10:00:03
PM) Operations Summary Total
Operations:4
5 (10:00:03
PM) Connections: 1 Disconnections: 1
Net LogIns: 0 Net LogOuts: 0
6 (10:00:03
PM) File Transfers: 1 Deletions: 0 Local Executes: 0 Remote Executes: 0
7 (10:00:03
PM) Waits: 0 Retries: 1
8 (10:00:03
PM) Dialing User:Cairo...
9 (10:00:04
PM) ---------------------------------------------
10 (10:00:04
PM) Will log into RAS Server using User ID: 987654321@worldnet.att.net.
11 (10:00:04
PM) Will log into remote network using User ID: Richard.
12 (10:00:04
PM) Will attempt to use the following network protocols to connect to the
remote computer:
13 (10:00:04
PM) TCP/IP
14 (10:00:04
PM) Will attempt to log into the following networks:
15 (10:00:04
PM) Microsoft Family Logon
16 (10:00:04
PM) Microsoft Network
17 (10:00:04
PM) iClose-Up
18 (10:00:09
PM) Opening communications port
19 (10:00:09
PM) Communications port opened successfully
20 (10:00:09
PM) Dialing . Please wait...
21 (10:00:33
PM) Modems connected
22 (10:00:33
PM) Sending Username and password to Dial-Up Server for Authentication...
23 (10:00:34
PM) Username and password verified on Dial-Up Server
24 (10:00:34
PM) Attempting to log into the remote network with Username Richard
25 (10:00:43
PM) Successfully logged into the remote network with UserName Richard
26 (10:00:43
PM) Protocols successfully negotiated:
TCP/IP
27 (10:00:43
PM) TCP/IP Address = This Computer:
12.72.158.141 RAS Server:
165.238.121.71
28 (10:00:43
PM) You are now connected to AT&T ISP
29 (10:00:44
PM) Registering with Close-Up Internet Name Server, Please wait...
30 (10:00:45
PM) Successful registration with Close-Up Internet Name Server
31 (10:00:45
PM) Connecting to Cairo, Please wait...
32 (10:00:52
PM) Connection to Cairo Successful.
33 (10:01:03
PM) Connected to Cairo
34 (10:01:35
PM) Sending c:\results\ to \\cairo\c\update\
35 (10:01:39
PM) Sending c:\results\History.dat to
\\cairo\c\update\History.dat.
36 (10:10:58
PM) Smart Transfer complete.
Approximate Transfer Rate: 34,370 bytes per second.
37 (10:10:58
PM) Sending c:\results\Invitems.dat to
\\cairo\c\update\Invitems.dat.
38 (10:13:39
PM) Smart Transfer complete.
Approximate Transfer Rate: 73,367 bytes per second.
39 (10:13:39
PM) Sending c:\results\Invnotes.dat to
\\cairo\c\update\Invnotes.dat.
40 (10:17:52
PM) Smart Transfer complete.
Approximate Transfer Rate: 29,512 bytes per second.
41 (10:17:52
PM) Sending c:\results\Pohist.dat to
\\cairo\c\update\Pohist.dat.
42 (10:18:35
PM) Smart Transfer complete. Approximate
Transfer Rate: 65,274 bytes per second.
43 (10:18:35
PM) Sending c:\results\Poinfo.dat to
\\cairo\c\update\Poinfo.dat.
44 (10:20:44
PM) Smart Transfer complete.
Approximate Transfer Rate: 87,704 bytes per second.
45 (10:20:44
PM) Sending c:\results\Poitems.dat to
\\cairo\c\update\Poitems.dat.
46 (10:23:51
PM) Smart Transfer complete.
Approximate Transfer Rate: 59,479 bytes per second.
47 (10:23:51
PM) Sending c:\results\Shipping.dat to
\\cairo\c\update\Shipping.dat.
48 (10:24:30
PM) Smart Transfer complete.
Approximate Transfer Rate: 38,312 bytes per second.
49 (10:24:52
PM) ***7 Files transferred (65,073,926 bytes) 0 Files skipped, 0 Items Moved,
and 0 Errors.
50 (10:24:52
PM) Summary Count
51 (10:24:52
PM) Smart : 7 Requests 7
Transfers 0 Errors
52 (10:24:52
PM) Mach 3 : 0 Requests 0 Transfers 0 Errors
53 (10:24:52
PM) Mach 2 with afterburners : 0 Requests 0 Transfers 0 Errors
54 (10:24:52
PM) Mach 2 : 0 Requests
0 Transfers 0 Errors
55 (10:24:52
PM) Mach 1 : 0 Requests 0 Transfers 0 Errors
56 (10:24:52
PM) Disconnecting from Cairo
57 (10:24:55
PM) Operations Summary Total
Operations:4
58 (10:24:55
PM) Connections: 1 Disconnections: 1
Net LogIns: 0 Net LogOuts: 0
59 (10:24:55
PM) File Transfers: 1 Deletions: 0 Local Executes: 0 Remote Executes: 0
60 (10:24:55
PM) Waits: 0 Retries: 1
61 (10:24:55
PM) *** Script Processing Complete. Beginning clean-up. ***
a) Line 1 shows when the script started. Line 2 shows where the Script File is located and it’s name. Line 3 shows the internal version number of the iClose-Up program that
created this Log file.
b) Lines 4 through 7 shows the number of different operations that this Script File was set
to do.
c) Next lines 9 through 32 are the Connection Log created by the iClose-Up Dialer. You can find this log in the “Connection Logs” folder in the “Log Files” folder in the “iClose-Up” folder in the “Program Files” folder. C:\Program Files\iClose-Up\Log
Files\Connection Logs.
To view it, right click on the red iClose-Up triangles in the
lower right of your screen and select View
iClose-Up Logs then select View Script Logs and select your script log.
d) Next lines 34 through 48 show the what files were sent and there bytes per second transfer
rate.
e) Line 49 shows that 7 files were transferred, we
transferred 65 million bytes, no files were skipped, no files were moved
(because the option in line 21 above “Mirror
Image Backup” was set to No) and there were no errors.
f) Next lines 50 through 55 gives a summary count..
g) Lines 56 shows when the script disconnected from
Cairo.
h) Next lines 57 through 60 shows the number of operational sections the script performed.