Creating task help

You can create user assistance for a task and its task actions that can be displayed in a pop-up window in the Administration Services UI when the administrator runs a task by using the task help wizard. The wizard creates a help template that contains predefined sections for user assistance. You can then edit this template to update task help details that includes task description, task action, task parameters, and cross-references.

Procedure

In the Project Explorer view, select the help subdirectory of the task or any other directory in which you want to create the help file,
Right-click and select New > Other > Administration Services > Task help.
In the File name field, enter the name for the static HTML file, such as index.html; click Finish.

Add the name and description of the task to the body of the task help file.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 
									"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
	<title>Help_Title</title>
	<style type="text/css">
		@import "../../../css/styles.css";
	</style>
</head>
<body>

<p><b>name_of_task</b></p>
<p><b>Description:</b> description_of_task</p> 

</body> 
</html>

To describe the health check task action, ensure that you use the anchor HTML tag with the healthCheckHelp as the value of the name attribute. The user assistance should also contain a description of the task action, and a description for the task parameters if the administrators need to specify them.

<a name="healthCheckHelp"> 	
	<li><b>Validation task details: </b></a> 		
		<p>description_of_task_action</p> 		
		<p><b>Parameters</b> 		
		<ul> 		
			<li><i>task_parameter_name</i>: description_of_task_parameter</li> 		
			<li><i>task_parameter_name</i>: description_of_task_parameter</li> 	 	
		</ul> 	
	</li>

If your task has an automation task action, ensure that you use the anchor HTML tag with the automationHelp as the value of the name attribute. The user assistance should also contain a description of the task action, and a description for the task parameters if the administrators need to specify them.

<a name="automationHelp"> 	
	<li><b>Automation task details: </b></a> 		
		<p>description_of_task_action</p> 		
		<p><b>Parameters</b> 		
		<ul> 		
			<li><i>task_parameter_name</i>: description_of_task_parameter</li> 		
			<li><i>task_parameter_name</i>: description_of_task_parameter</li> 	 	
		</ul> 	
	</li>

If required, provide cross-references to the management system’s information center or an external site.

<p><b>References</b></p>
<p>For more information about this task, see:</p> 
<ul> 
	<li>link_to_information_center</li> 
	<li>link_to_external_site</li> 
</ul>

Save the file.