Difference between revisions of "RPC HELP TVistaLogin PromptDivision"
From VistApedia
(Created page with "<h2>PromptDivision Property</h2> Example <h3>Applies to</h3> TVistaLogin class <h3>Declaration</h3> proper...") |
|||
| Line 12: | Line 12: | ||
The '''PromptDivision''' property is available at run-time only. It should be set to True, if the user should be prompted for Division during [[RPC_HELP_Silent_Login|Silent Login]]. The prompt will only occur if the user has multi-division access. This property should be set to False, if the prompt should not be displayed due to the manner in which the application is running. However, if set to False and multi-division access is a possibility, then the application must handle it in another way. For example, the application developer would do the following: | The '''PromptDivision''' property is available at run-time only. It should be set to True, if the user should be prompted for Division during [[RPC_HELP_Silent_Login|Silent Login]]. The prompt will only occur if the user has multi-division access. This property should be set to False, if the prompt should not be displayed due to the manner in which the application is running. However, if set to False and multi-division access is a possibility, then the application must handle it in another way. For example, the application developer would do the following: | ||
# Set Login.PromptDivision to False. | # Set Login.PromptDivision to False. | ||
| − | # Set the [[ | + | # Set the [[RPC_HELP_TRPCBroker_Connected|Connected]] property to True to signon. |
| − | # On return, check whether the [[ | + | # On return, check whether the [[RPC_HELP_TRPCBroker_Connected|Connected]] property was set to True or check whether the Login.[[RPC_HELP_TVistaLogin_ErrorText|ErrorText]] property was non-null (and especially "No Division Selected"). |
# If the connection was successful, there is no problem. Otherwise, proceed to Steps 5 - 8. | # If the connection was successful, there is no problem. Otherwise, proceed to Steps 5 - 8. | ||
# Check the Login.[[RPC_HELP_TVistaLogin_MultiDivision|MultiDivision]] property and see if it was set to True (which is what would be expected). | # Check the Login.[[RPC_HELP_TVistaLogin_MultiDivision|MultiDivision]] property and see if it was set to True (which is what would be expected). | ||
# If the Login.[[RPC_HELP_TVistaLogin_MultiDivision|MultiDivision]] property is set to True, then check the Login.[[RPC_HELP_TVistaLogin_DivList|DivList]] property for a list of the available divisions (remember the first entry is the number of entries that follow) and, in whatever method was available to the application, have the user select the correct division. | # If the Login.[[RPC_HELP_TVistaLogin_MultiDivision|MultiDivision]] property is set to True, then check the Login.[[RPC_HELP_TVistaLogin_DivList|DivList]] property for a list of the available divisions (remember the first entry is the number of entries that follow) and, in whatever method was available to the application, have the user select the correct division. | ||
# Set the Login.[[RPC_HELP_TVistaLogin_Division|Division]] property to the selected Division. | # Set the Login.[[RPC_HELP_TVistaLogin_Division|Division]] property to the selected Division. | ||
| − | # Set the [[ | + | # Set the [[RPC_HELP_TRPCBroker_Connected|Connected]] property to True, so the connection would be attempted to be established again. |
Latest revision as of 18:43, 8 July 2015
PromptDivision Property
Applies to
TVistaLogin class
Declaration
property PromptDivison: Boolean;
Description
The PromptDivision property is available at run-time only. It should be set to True, if the user should be prompted for Division during Silent Login. The prompt will only occur if the user has multi-division access. This property should be set to False, if the prompt should not be displayed due to the manner in which the application is running. However, if set to False and multi-division access is a possibility, then the application must handle it in another way. For example, the application developer would do the following:
- Set Login.PromptDivision to False.
- Set the Connected property to True to signon.
- On return, check whether the Connected property was set to True or check whether the Login.ErrorText property was non-null (and especially "No Division Selected").
- If the connection was successful, there is no problem. Otherwise, proceed to Steps 5 - 8.
- Check the Login.MultiDivision property and see if it was set to True (which is what would be expected).
- If the Login.MultiDivision property is set to True, then check the Login.DivList property for a list of the available divisions (remember the first entry is the number of entries that follow) and, in whatever method was available to the application, have the user select the correct division.
- Set the Login.Division property to the selected Division.
- Set the Connected property to True, so the connection would be attempted to be established again.
