1). Define the new activity
Activities are defined to CatTools via ini files in the \Activities folder. Each ini file represents a separate activity. To add a new activity, you create an ini file defining the activity characteristics. The easiest way to do this is to copy an existing activity ini file that bears some resemblance to the new activity and make the required changes to the internal settings.
Go to the CatTools \Activities folder and make a copy of an activity such as Report.ARP table.ini file. Rename the file to reflect the new activity, ie Report.BEEP table.ini .
Choose a unique new id number for the activity from the custom range of 5000 to 5999.
2). Add new Main and Client activity specific scripts
The scripts used for activities are located in the \Scripts sub folder and are called by the name of the activity as defined in the activity ini file. There are two scripts required for an activity, a Main oriented script which does all the preparatory work and actually launches the CatTools client, and the Client script that is run by the CatTools client program. The script files are called the same name as you called the activity in its ini file, with an extension of .txt instead of .ini, and a prefix of Main. for the main script and Client. for the client script.
The easiest way to do this is to create copies of existing script file such as the Main . and Client. Report.ARP table.txt files and rename them to the correct name.
You can see from the copied Main script file that it checks activity options, prepares folders and files, sets variables, calls ct.MarshalThreads to activate the CatTools Clients, and does any post processing of results required.
The Client. script communicates with a specific device, logging in and issuing whatever commands are required to make the activity work.
3). Save the new scripts
Before CatTools can access the scripts you have built you must save them in the \Scripts folder. Normally you do not have to stop and restart CatTools, but there may be occasions during testing that you have to do this to get new script code recognised.
4). Test the new scripts
Once you have the scripts set up you can test the new activity with CatTools by setting it up activities against a device.
5). Send us your working scripts
If you wish we appreciate it if you send your script and ini files to support@kiwisyslog.com to have it added to CatTools as a standard activity.