Invite user
Invite users to log in to your Grexx application. By default, an email containing a unique URL is sent to the invitee. When the user follows the link and completes the registration process, a new User case is added to your application in the relevant DTAP environment. An alternative to inviting users is open registration.
If it is not available as standard in your Studio, you can import this system service from Grexx Marketplace. This includes the Invite user wrapper casetype, the System service - Invite user casetype, and several related items.
Invite user casetype
The Invite user casetype wraps around the System service - Invite user casetype. This is because creating a user is an asynchronous process: it is not known if and when the invitee will follow the link in the invitation and complete the process. A separate case must be created for each invitation to accommodate the data of the new User case.
Input
Use a casetype activity to add inputs to the Start invite user form.
| Attribute | Data type | Mandatory? | Description |
|---|---|---|---|
| Name | String | Yes | Name of the invitee. This name is added to the User case that is created and can also be used in the invitation itself. |
| Email to | String | Yes* | The email address to which an invitation will be sent. *See Invite without email below for more information. |
| Attachments | File | No | Files attached to the invitation email. |
| Additional Security Profile | Case ID (multivalue) | No | Security profiles to be applied on first login. |
| Invited by | String | No | The case ID of the user who sent the invitation. |
| Invite email template caseid | Case ID | No | Case ID of the template used for the email. If not specified, the supplied Basic invite email template is used. |
| Body invite text caseid | Case ID | No | Case ID of template with HTML. |
| Subject | String | No | Subject of the invitation email. |
| Mail from | String | No | Sender email address. By default, emails are sent from [email protected]. To send emails from a different address, configure Grexx Platform to send emails from your domain. |
| Mail from name | String | No | The display name of the sender. |
| Return to CaseID | Case ID | No | A CaseID from the DTAP environment that the invitation is sent from. The user will be redirected to this case after following the invitation link. |
| Return to View | Case ID | No | The CaseID of a view of the casetype specified in Return to CaseID. The user will be sent to this view of the case in Return to CaseID. |
| Existing user | Case ID | No | Enter an existing User case that does not yet have an XXID filled in. When the invitation is completed, no new User case is created, but the specified user is used. |
| SPF Tenant Key(s) | String | No | SPF tenant key(s) from your DNS record (for multi-tenant environments). |
| Number of days invite is valid | Integer | No | The validity period for the invitation. The default is seven days. The maximum is 90 days. |
Output
Outputs are added to the Result invite user form when the Invite user case is closed.
| Attribute | Data type | Mandatory? | Description |
|---|---|---|---|
| User caseID | Case ID | Yes | As soon as the user accepts the invitation and logs in, the user's case ID is returned. You can then use the ID again by putting the ID in an attribute and giving someone a role. |
| New user | Boolean | No | Indicates whether the user already exists on the platform. Used in casetype invite user to determine whether the email and name must be filled in. This data will not be adjusted for existing users. |
| Status | String | No | Status of the invite. The possible statuses are: created, sent, accepted, and canceled. |
| Hostname | String | No | The hostname that the user returns to after logging in to XXID. |
Invite without email
It is possible to create an Invite user case without supplying the invitee's email address. If no email address is provided, you can retrieve the invite URL from the casedata during the On submit stage of the activity. You can then distribute the URL by some other means, such as via the API or by sending it to the user directly. You can also use this to send the invite URL using the Send email via custom SMTP system service, instead of the default Send email system service.
If the user then registers via XXID with an email address and password, the user will receive an email with which they can verify their email address. If the user registers using a third party authentication option (such as Google or Microsoft), no verification email will be sent.
System service - Invite user
The Systemservice - Invite user casetype should never be called directly, but always via the Invite user casetype.
System service inputs
| Attribute | Date type | Mandatory? | Description |
|---|---|---|---|
| Name | String | No | Name of the invitee. This name can be found in the User case that is created when the invitation is accepted. You can also use the name in the invitation itself. |
| Email to | String | No | The email address to which an invitation will be sent. |
| Attachments | File | No | Attachments included in the invitation email. |
| Additional Security profile | Case ID | No | Security profiles to be applied on first login. |
| Invited by | Case ID | No | The case ID of the user who sent the invitation. |
| Invite email template inline | Inline template | No | Body of the invite email. |
| Invite email template caseid | Case ID | No | Case ID of the template used for the email. If not specified, the supplied Basic invite email template is used. |
| Invite body text caseid | Case ID | No | Case ID of template with HTML. |
| Subject | String | No | Subject of the invitation email. |
| Email from | String | No | Sender email address. By default, emails are sent from [email protected]. |
| Email from name | String | No | The display name of the sender. |
| Invite URL | String | No | The URL to XXID with which the invite can be used. |
| Existing user | Case ID | No | Include an existing user case that has not yet filled in an XXID. |
| SPF Tenant IDs | String | No | IDs for multi-tenant SPF. |
System service outputs
| Attribute | Date type | Mandatory? | Description |
|---|---|---|---|
| User case | Case ID | Yes | As soon as the user accepts the invitation and logs in, the user's case ID is returned. You can then use the ID again by putting the ID in an attribute to give someone a role. |
| Initial session data | JSON | No | Can be used to store data already created by a user who is not logged in (e.g. shopping cart). |
| Is a new user | Boolean | No | Indicates whether the user already exists on the platform. Used in the Invite user casetype to determine whether the email and name must be filled in. This data will not be adjusted for existing users. |
| Body HTML | String | No | Body of the email in HTML. |
| Body text | String | No | Body of the email in text. |
| Invite URL | String | No | The generated URL for the invitation. |
| Valid until | Datetime | No | Date until which the invitation can be used. The date must be no more than 90 days in the future, otherwise an error message will appear. If the date is in the past, an error message will also appear. |
| Message ID | String | No | Message ID of the sent email. |
| Sent status invite email | String | No | The sending status of the invitation. The possible statuses are: OK and Sending emails is disabled. |