1. Siebel CRM Desktop for Microsoft Outlook Administration Guide
  2. Other Functions That the SSO Client Object Includes

Other Functions That the SSO Client Object Includes

You can use the following functions in the SSO Client object. Siebel CRM Desktop supports each of these functions starting with Siebel CRM Desktop version 3.7 except for the execute_request function. Support for the execute_request function starts with an earlier release:

  • create_ia_state. Creates and returns a new ia_state object. Siebel CRM Desktop SSO uses this object for initial configuration with interactive authentication to send status information. ia_state is an object, while create_ia_state is a function that creates the ia_state object. For more information, see Interactive State Object.

  • execute_request. Runs the request and returns a reply. It accepts a request from the request_handler function or a request that the create_request function creates. It uses the following format:

    execute_request(request_object)

  • get_sso_username. Gets the user name that the user provides in noninteractive authentication. Siebel CRM Desktop SSO does not use this function for interactive authentication.

  • get_sso_password. Gets the password that the user provides in noninteractive authentication. Siebel CRM Desktop SSO does not use this function for interactive authentication.

  • drop_exception. Drops any exceptions that the connector reports. If the script finishes running after Siebel CRM Desktop SSO calls this method, then Siebel CRM Desktop SSO does not create an exception.

  • raise_not_logged_in_exception. Drops any not_logged_in exceptions that the connector reports and then creates a not_logged_in exception with a description that states it cannot process the login because a problem occurred with the Siebel Server or credentials are not valid. Siebel CRM Desktop SSO does not stop the session flow. The SSO script must finish running correctly before the connector creates the exception.

  • raise_not_valid_exception. Drops any not_valid exceptions that the connector reports and creates a not_valid exception with a description that states the user password is not valid or is missing. Siebel CRM Desktop SSO does not stop the session flow. The SSO script must finish running correctly before the connector creates the exception.

  • raise_cancel_exception. Clears any reported exception. It creates the following exception for the SSO Connector:

    cancelled

    CRM Desktop SSO does not stop the session flow. The SSO script must finish running the request_handler after it creates an exception.