aParams Section

The aParams section is where the action happens. This is where you set the parameters for the option you have selected. The parameters tell the option how to do what they need to do.

Parent: aOption.

1100 Check Positions Options

The New Ranking (nr) option is the only option available for the Check Positions task. All parameters for this option are optional. If no parameters are provided, the default values from the Start a Ranking dialog box are used. Below is a sample section for a new ranking.

<std::map second="natural" first="name" />

<std::map second="4" first="se_category_id" />

<std::map second="2" first="keywords_category_id" />

</aParams>

First	Second
name	An optional name to give to the ranking. If this is left blank the program will use the "Untitled" name for the ranking.
se_category_id	An optional search engine category ID to indicate what search engines to use for this ranking. When not provided, the program will attempt to use the last search engine category used, otherwise it will default to the Active Library. To find the IDs for your search engine categories, run the By Category Only Quick Report from the Check Position task.
keywords_category_id	An optional keyword category ID to indicate what keywords to use for this ranking. When not provided, the program will attempt to use the last keyword category used, otherwise it will default to the Library. To find the IDs for your keyword categories, run the By Categories Only Quick Report from the Keywords task.

1200 Reporting Options

The Report (report) option is the only option available for the Reporting task. All parameters listed below are required along with at least one action parameter (depends on the action you select).

<std::map second="email" first="action" />

<std::map second="html" first="format" />

<std::map second="1" first="group_id" />

<std::map second="1" first="custom_id" />

</aParams>

First

Second

action

The action parameter allows you to specify which action you want to use. Reports can either be saved to disk or emailed. This parameter must be supplied.

Actions

•	save Use this action to generate and save the report to disk.

•	email Use this action to generate and email the report as an attachment.

format

The format parameter allows you to specify how you want the report formatted. Reports can be formatted for display or for importing in various formats. This parameter must be supplied.

Report Formats

•	html Use this format to output the report in HTML.

•	csv Use this format to output the report in CSV.

•	xml Use this format to output the report in XML.

•	sql Use this format to output the report in SQL statements.

group_id

The group_id parameter tells Website-Manager which report group the report is located in that you want to run. The parameter must be supplied.

Reporting Group IDs

1 = Ranking report group.

2 = News report group.

3 = Shopping report group.

4 = Blog report group.

custom_id

The custom_id parameter allows you to specify the report that you want to run. Because reports in the system get assigned unique IDs at runtime, they can vary from project to project. To get the ID of the report you want to run, you will need to run a query using the Project Browser task under the Support module.

First determine what reporting group the report you want to run is under and look up the group ID in the list below. Once you have the ID, go to the Project Browser under the Support module and enter the following query: select name, custom_report_id from rk_custom_reports where standard_report_id=X. Substitute your group ID for 'X' in the query.

You will now have a list of reports in that group with their respective IDs. Use the ID for the report you want to run for this parameter.

Reporting Group IDs

1 = Position Summary reports.

2 = Best Positions reports.

3 = Not used.

4 = Top Positions reports.

5 = Top Pages reports.

6 = Indexed Pages reports.

7 = Competitor Summary reports.

8 = Keyword Competition reports.

9 = Spelling Suggestions reports

10 = Search Engine Summary reports.

11 = Sponsored Listings reports

12 = Position Change reports

100 = Article Summary reports.

101 = Indexed Articles reports.

200 = Product Summary reports.

201 = Indexed Products reports.

300 = Blog Summary reports.

301 = Indexed Blogs reports.

Save Action Parameters

When saving a report to disk the only parameter needed is the file name to save the report to. If the file exists, it will be overwritten if it is not read-only and the user has permissions to write to that file. If the file doesn't exist, it will be created.

<std::map second="C:\Documents and Settings\kevin\My Documents\sophtware.wsm" first="filename" />

First	Second
filename	The file name can have a full or relative path, or just the file name. If it's just the file name, the report is written to the working directory (usually the program directory). Otherwise it is written to the path specified. If a full or relative path is specified, it must exist. No attempt is made to create missing directories.

Email Action Parameters

All email values are optional. Missing parameters are pulled from either the custom report or, in the case of the mail server parameters, pulled from the Email tab on Preferences dialog box. The report is sent as an attachment to this email. In addition, all parameter value fields are parsed for tokens. Any tokens in the Global Options section are parsed, plus these extra tokens: [[first_date]], [[last_date]], [[query]], [[title]], and [[sub_title]].

<std::map second="michael@sophtware.com" first="from" />

<std::map second="michael@websitemanagementtools.com" first="to" />

<std::map second="michael@topdogsoftware.biz" first="cc" />

<std::map second="[[title]] Report" first="subject" />

<std::map second="Your project '[[project]]' was completed at [[datetime]]." first="message" />

<std::map second="mail.sophtware.com" first="smtpserver" />

<std::map second="kevin" first="username" />

<std::map second="3eJgu4hh" first="password" />

First	Second
from	Who this email is coming from.
to	Who is to receive the email. More than one email address can be entered separated by a comma or semicolon.
cc	Same as the to field but sent in the cc list.
subject	A short subject for this email.
message	A short message for this email. HTML is not available in this field.
smtpserver	This parameter specifies or overrides the SMTP server used to send the email. It is highly recommended that you specify the SMTP server in Website-Manager on the Email tab of the Preferences dialog box. Entering a SMTP server here will expose your password as plain text in this scheduling file. While Website-Manager keeps your password encrypted.
username	The user name to log into the SMTP server with.
password	The password for the user. This password is stored plain text and is therefore not secure.

Global Options

Global options can be used within any task options section.

Notify Action Parameters

The Notify (notify) option is the only global option available at this time. This option is used to send an email notification when something is completed in the scheduling file and can send more than one notification. No attachments are send with a notification. You can use this feature to send your cell phone a text message when a project is completed.

All of the Email Action parameters apply to this option. In addition these tokens can be used in any of the parameter fields: [[project]], [[datetime]], [[time]], [[date]], [[connection]], [[company]], [[first_name]], [[last_name]], [[contact]], [[email]], [[project_name]], and [[project_path]].

Execute Action Parameters

The Execute (exec) option allows you to run an external program at any point during the scheduled process. You can set the working directory for the program and pass up to 20 arguments to the program. All the tokens processed in the Notify option are processed on the arguments passed in.

This example starts the Window's FTP command client in the working directory. Then uses the .ftp file as input for user name, password, a change directory command, and puts files to the server.

<std::map second="ftp.exe" first="run" />

<std::map second="C:\Documents and Settings\michael\My Documents\My Rankings" first="working_directory" />

<std::map second="-s:[[project_name]].ftp" first="arg1" />

<std::map second="www.sophtware.com" first="arg2" />

First	Second
run	The file name of the program to run. A full or relative path can also be provided.
working_directory	Sets the working directory for the program ran.
argX	An argument to pass to the program, where X is a number from 1 to 20.
wait	Include this argument to have the application wait for the program to complete. The default, when wait is included, is to wait up to one hour. Or, you can set the number of seconds the program should wait before continuing on with the next option.