Glossary Item Box

Government Gateway 2.2.0 (MR-01) ISV Developer Help (Doc Version 06/03/08) | Send comments on this topic.

# Gateway Flags and Controls

# What are Gateway Service Flags?

A set to flags (or business rules), configured when the service is setup (and then maintained by live services) that allows service owners to control aspects of the way a service operates, These flags are:

- UniqueIdentifiers. Determines if the service allows one (or multiple) enrolments using the same identifiers. Note even if this flag is reset a credential is still not allowed to enrol in the same service more than once using the same identifiers. It is highly recommend that this flag is set so only a single enrolment is allowed.
- ExclusiveAgent. Determines if a Principal can assign their enrolment in the service to one or multiply Agent.
- AgentExcludesPrincipal. When a principal allocates an enrolment in the service to an Agent, they can be given exclusive use of the enrolment – only the Agent can interact with and send business forms to the service.
- MultipleEnrolments. Determines if a principal can have multiple enrolments, using different identifiers, in the service.
- AutoEnrolment. Determines whether service owners are allowed to auto-enrol users in the service (through the Enrolment Request Admin message). Note this flag is ignored by the equivalent (newer) Admin Interface methods.
- AutoActivationGatewayDefault. Whether auto-activation of a service is enabled for this service.
- AutoActivationMessageOverride. Regardless of AutoActivationGatewayDefault, this flag specifies whether auto-enrolment operations from the service owner (i.e. Admin methods and the Enrolment Request Admin Message will unconditionally cause auto-activation.
- SuppressEnrolEmail. Determines if an email is sent when the user enrols in the service.
- IncludeSubmitterDetailsForTxEAuth. When a document (business form) is submitted through the Transaction Engine from a client/agent (portal or ISV application) or from Department to another Department this flag determines if the Gateway includes additional details about the submitter.
- SendEmail. When a document (business form) is submitted through the Transaction Engine from a client (Portal or ISV application) to a Department, this flag determines if an confirmation email (indicating the submission has been accepted/rejected) is sent to the user. Note: There is a flag for each form type within a service.
- SuppressRegistrationLetter. Determines if a letter is sent to the user when they registers with the Gateway.
- HideFromGatewayUI. Determines whether the service will appear in the Gateway UI. If a service is not offered then users must use the Web portal provided by the service owner.

© Crown Copyright 2008. All rights reserved