Scope
The goal of this document is to provide guidelines on how to build, not code, an SSO script.
Comments
1. A header at the top of the document should specify the Application name that the script is going to interact with,
2. The file path to launch the Application or the URL, of a website or a Web Application.
3. This header should also provide the name of the script Author and the last modified date.
4. More information could be added but those are the basic four pieces of information that should be in every script.
5. Code blocks such as Dialog/Endialog, Site/Endsite and Sub/Endsub should also have a header describing what it what it does.
6. Most code should not need comments, however sometimes when there is some non-standard code then comments would be useful.
Variables and Sub-Procedure Naming
1. Variable names should be meaningful as to describe what kind of data is contained within.
2. Avoid using abbreviations – DepartmentLocation is easier to understand then DeptLoc.
3. The same applies to Sub-procedure naming; it should describe what it does.
The one plus four blocks
As a guideline, and for most scripts, we should have one block of comments at the top,
which I refer to above, and four other blocks these are:
- Login
- Detect incorrect login
- Re-login
- Password change
Think of these as event handlers, and these are the things that we want SSO to handle. There could be more or there could be less. For windows applications the re-login event handler may not be needed. For an application that the agent may have more then one login (representing different roles) we may need another block that would handle the role selection.
Additionally
These are guidelines and bound to change as we move along. If you have any comments please contact jose.f.martins@convergys.com and cc to yogesh.balodi@convergys.com
