Create application form

Back to Perun main page

Back to Use cases

Introduction

Short introduction to application form

Application types

All modifications described here are in the Application form section below your VO. There are two types of application form: initial and for extension. Both can be customized in one GUI under Settings button (don't confuse with the settings tab) according to needs of VO/group manager.

• Initial application serves to first contact with VO/group
• Extension serves to extend your already existing account in VO/group.

There are two ways to accept application form

• Manual - when user submits his application form, email notification to administrator is sent, admin can accept or reject in GUI, it is default option
• Automatic - when user submits his application form, application is accepted automatically

Creating a form

As VO or group manager, select your VO/group and in the left menu click on Application form (in list of advanced setting). If it is first time, you create an application form, note "Form doesn`t exists, do you wish to create new one?" is shown. Click on Create.

There are two ways to fill a form with content.

• Copy it. Button Copy from VO... serves to copy application form from other VOs to what you have an access. Do not forget to edit copied form before you actually use it. :)

• Do it on your own. Fill form by items creating them one by one.

Creating an item

Button Add serves to add new item to the form. First you need to fill these pieces of information:

• Short name serves as short name, or is displayed in the form if no language label is inserted.
• Type serves to select one of the several types of item from drop down menu.
• Insert after is to specify the place after which is new item inserted.

After clicking on Create button, menu with more options appears.

• Short name - same as short name from previous window
• Input widget - same as Type from previous window
• Display on application - item will be displayed on initial form, extension or both (tick what you want)
• Required - when checked, item is required to fill and marked by asterisk (*)
• Destination attribute - attibute into which value of item will be stored
• Federation attribute - attribute which value can be prefilled with data from user's federation
• Regular expression - regexp that validates item value

Other tabs are the language ones. For each item and each language fields:

• Label: is used instead of short name of attribute
• Help: help for each item
• Error: plain text of error, which appear when item is required but not filled, or does not match with regular expression. It should solve as information for user what is wrong.

Click on the Save to save an item.

To see the preview, use Preview button. All changes are only temporary, to save whole form, press Save.

Please note: If you close form without saving, the all changes made in form are lost.

E-mail notification

Button Notification serves to create an email notifications to users about application form. There are several types of notification.

• Created/user - mail that will be sent to user after his registration to VO/group
• Mail validation/user - mail that will be sent to user to validate his email provided in application form
• Created/manager - notification to manager that new user wants to be a member of VO/group
• Approved/user - mail to user that his application was approved by manager
• Rejected/user - mail to user that his application was rejected by user
• Invitation/user - mail to user invitation to join this VO/group

There are two language version (czech and english) to fill text of each notifications. For each type of application form (initial, extension) you have to have separate notification.

Many tags serves as variables enabling insert system values in notification text, for example: {voName} inserts name of your VO. Whole list is here or mentioned in GUI.

Good examples of email notification

• Created/user - initial
• Mail validation/user - initial
• Created/manager - initial
• Approved/user - initial
• Rejected/user - initial
• Invitation/user - initial
• Created/user - extension
• Mail validation/user - extension
• Created/manager - extension
• Approved/user - extension
• Rejected/user - extension

Example of application form

The purpose of this section is to give a simple schedule to help new manager to design new application form with all important items without deep knowledge.

All application form should contain these items:

• Introduction item with type Custom HTML text to explain some basic information about your VO/Group, contact to you ...etc.
• Personal information section (do not forget to structure your application form for better understanding)
  • Name - it can be visibly taken from federation (item with type: Input text field pre-filled from external source, destination attribute displayName and federation attribute "cn") or manually inserted (item with type Input text multi-line field)
  • Email - it should be obtained from federation hidden (item with type: Hidden input text pre-filled from external source, destination attribute mail, federation attribute mail)
  • Preffered email - it must be type Input text field for email, after submitting the form, email with link to validate email is sent to preffered email and user must validate it by clicking on the link. (destination attribute mail, federation attribute mail)
  • Organization - value can be taken from federation, (destination attribute organization, federation attribute "o")
  • PrefferedLanguage - Single value selection from list with czech or english (destination attribute prefferedLanguage)

• Login and password section
  • Username - type Input text field for username, destination attribute login-namespace:(your_namespace)
  • Password - type Input text field for passowrd, destination attribute login-namespace:(your_namespace)

• Details of membership section
  • reason why user wants to be member of your group, type Input text multi-line field, destination attribute registrationNote
  • research group where user works
  • in case of extension form, reason of extension should be provided as Input text multi-line field item

• Submit button, type Custom submit button

Do not forget to save it.

Links to application forms

Registration forms are displayed to users by own application called Registrar. User which wants to register must get link either by "invitation notification" defined in a VO or Group or it must by provided by VO/Group manager some other way. All links have following URL format:

https://hostname/authz_type/registrar/?vo=vo_short_name&group=group_name

If you are not sure, ask perun support to help you choose most suitable type of authetication for your users.

If you wish to handle registration only in a VO, omit group parameter in URL. Based on users authentication and current membership state, application display user proper form(s).

Example URL (registration to Metacentrum NGI):

https://perun.cesnet.cz/fed/registrar/?vo=meta

Form editation

Each item can be edited, moved or removed.

• Edit returns you to the window of creating an item.
• Move by clicking on arrows you can move an item one step up or one step down in a form.
• Delete removes an item from form.

Please note: If you close form without saving, all unsaved changes are lost.

Redirections

If you wish, you can add custom redirections to registration process. They appear as "continue" buttons below registration summary. Redirection must be a part of URL provided to user and following parameters are supported:

targetnew = redirect when user submits new registration (initial)
targetextended = redirect when user submits membership extension (extension)
targetexisting = redirect, when user is a member of VO/Group and can't submit any initial or extension form.

You can use any combination of 3 parameters to fully support your users workflow. If a value of parameter contains any ? or &, it must be URL escaped.

Example URL (registration to cloud group of Metacentrum NGI with redirection to seznam.cz):

https://perun.cesnet.cz/fed/registrar/?vo=meta&group=metacloud&targetnew=https://seznam.cz

Please note: How application form works in detail is described in the page Create an application form -- long version