No edit summary |
Anonymous1 (talk | contribs) No edit summary |
||
| Line 6: | Line 6: | ||
Just cut or copy your text to wherever you need it.--> | Just cut or copy your text to wherever you need it.--> | ||
Install PreCheck plug-in | |||
Purpose: | |||
The purpose of this document is to provide an overview on how to create a checker plug-in for SmartSystems Install PreCheck application. | |||
Overview: | |||
The Install PreCheck application make sure all the pre-requisites are met before commencing the installation os SmartSystems server. Plug-ins can be added to the application which are detected at runtime. | |||
Details: | |||
The Install PreCheck application provides 'IChecker' interface. The plug-in class should implement the 'IChecker' interface defined below at the end of this document | |||
The plug-ins will be detected in the runtime based on its inheritance from 'IChecker' interface | |||
Essentially the plug-in class should provide implementation for 'Run' method and update the status of the checking in 'State' property. Also the plug-in class also implement the properties Name, Info, Error which would be displayed on the user interface | |||
If the plug-in is for testing purpose or not to be checked, updating the 'IsActive' property to 'false' will do | |||
IChecker Interface | |||
The interface to provide the information and functionality the individual checker exposes | |||
Namespace: InstallPreCheck.Model | |||
Assembly: InstallPreCheck (in InstallPreCheck.exe) | |||
Syntax | |||
C# | |||
public interface IChecker | |||
Visual Basic | |||
Public Interface IChecker | |||
Visual C++ | |||
public interface class IChecker | |||
The IChecker type exposes the following members. | |||
Methods | |||
Name | |||
Description | |||
Run | |||
Check the pre-requisite | |||
Properties | |||
Name | |||
Description | |||
Error | |||
Error/Warning message | |||
Info | |||
Summary information about the purpose of check | |||
IsActive | |||
Indicate weather the checker is active and needs to be executed | |||
Name | |||
Name of the checker | |||
State | |||
Checker status that indicate the outcome of executing the pre-requisite check | |||
CheckerState Enumeration | |||
The set of possible checker states | |||
Namespace: InstallPreCheck.Model | |||
Assembly: InstallPreCheck (in InstallPreCheck.exe) | |||
Syntax | |||
C# | |||
public enum CheckerState | |||
Members | |||
Member name | |||
Value | |||
Description | |||
NotExecuted | |||
0 | |||
The checker is not executed | |||
NotApplicable | |||
1 | |||
The checker is not applicable for the current environment | |||
InProgress | |||
2 | |||
Checking is in progress | |||
Success | |||
3 | |||
Checking completed successfully | |||
Warning | |||
4 | |||
Checking completed with warning | |||
Error | |||
5 | |||
Checking completed with error | |||
Revision as of 21:49, 25 August 2011
Redirect to:
Install PreCheck plug-in
Purpose:
The purpose of this document is to provide an overview on how to create a checker plug-in for SmartSystems Install PreCheck application.
Overview:
The Install PreCheck application make sure all the pre-requisites are met before commencing the installation os SmartSystems server. Plug-ins can be added to the application which are detected at runtime.
Details:
The Install PreCheck application provides 'IChecker' interface. The plug-in class should implement the 'IChecker' interface defined below at the end of this document
The plug-ins will be detected in the runtime based on its inheritance from 'IChecker' interface
Essentially the plug-in class should provide implementation for 'Run' method and update the status of the checking in 'State' property. Also the plug-in class also implement the properties Name, Info, Error which would be displayed on the user interface If the plug-in is for testing purpose or not to be checked, updating the 'IsActive' property to 'false' will do
IChecker Interface
The interface to provide the information and functionality the individual checker exposes
Namespace: InstallPreCheck.Model
Assembly: InstallPreCheck (in InstallPreCheck.exe)
Syntax
C#
public interface IChecker
Visual Basic
Public Interface IChecker
Visual C++
public interface class IChecker
The IChecker type exposes the following members.
Methods
Name
Description
Run
Check the pre-requisite
Properties
Name
Description
Error
Error/Warning message
Info
Summary information about the purpose of check
IsActive
Indicate weather the checker is active and needs to be executed
Name
Name of the checker
State
Checker status that indicate the outcome of executing the pre-requisite check
CheckerState Enumeration
The set of possible checker states
Namespace: InstallPreCheck.Model
Assembly: InstallPreCheck (in InstallPreCheck.exe)
Syntax
C#
public enum CheckerState
Members
Member name
Value
Description
NotExecuted
0
The checker is not executed
NotApplicable
1
The checker is not applicable for the current environment
InProgress
2
Checking is in progress
Success
3
Checking completed successfully
Warning
4
Checking completed with warning
Error
5
Checking completed with error