When you open a WEM Project, the modeler automatically opens the
Home tab. From here you can access all information, workflows, data definitions, navigation, etc. that is part of your application. You can also access information about the project: properties, users, certificates, etc.
Home tab is the only tab you can never close, because it is also the place where you navigate between projects.
This article describes all the features and functions you find in the
At the top of the
Home tab you find the
Project dropdown box. The Project that is currently open is the one that is shown. When clicking on the dropdown box, the modeler lists all Projects that you have access to, sorted by Workspace.
When a Project is selected, that project is loaded into the modeler, so you can work on that project.
Directly below the Projects dropdown box, you find the toolbar with a number of buttons that all relate to management of the selected project:
From left to right you find the following buttons:
If you want to use hyperlinks in your application, you need to define them first. You can do that in two places:
- when you’re working in a user interaction node, you can add hyperlinks from the template-editor toolbar;
- you can add links to the library on the Project level (as explained here).
Wherever you do it, the result is the same: the hyperlink is available anywhere in your application.
To add or manage hyperlinks on the Project level, click on the
manage hyperlinks button. You get the following form:
Here you can manage all your hyperlinks. You can:
- Add/edit/delete hyperlinks;
- View the hyperlinks in a new window;
- Get a list of all locations where a link is used within your application;
- Create/manage folders. This is used to group hyperlinks. If you have a large number of hyperlinks, you can group them in folders, to make it easier to manage all the available links.
To add a new hyperlink, select the folder in which you want to store the link, and simply fill in the details at the bottom of the form:
|Name||This is the name you want to give the hyperlink.|
|Protocol||Select which protocol you want to use:
|What is the protocol you want to use for this link.
– Regular http communication, so any regular website
– Secure https communication
– If this link is connecting to an FTP server, use the ftp protocol
– Used to specify an email address. This link will open your mail application with the email address filled in.
this option will make the link relative within the portal (automatically use the protocol and hostname of the portal)
|URL||The actual URL of the hyperlink you want to add|
Now click on the
Save button, the link is added to the library and can be used in the application.
Editing, deleting or finding out the locations of a hyperlink is straightforward: select the hyperlink and press the button for the action that is required.
The is the library where you can manage all files that are related to this particular project. You can add files, delete files, create folders where you can store files, etc.
When you create multi-lingual applications, you need a place where the various language versions of all applications components are stored (buttons, text, labels, etc.). When you click the
Manage Dictionary button, you get to the place where everything that is related to languages is stored.
Here you manage access of other users to this project. This is only related to the modeler, so user management of your application is done within your application. Project users are the users who have access to your project in the modeler, so they can co-model, co-create, review your app, etc.
When the user management form is open, you see the list of people who have access to this project, including their role. You have the following options:
- Invite more people
You provide a list of people that you want to give access to your project, and if needed you enter the text that should be part of the email to these people. This is very similar to the way Workspaces are managed. The people that are invited get an email message, including a link to this project. They can accept or reject the invitation.
When an invitation is sent to you, you get an email, but there is also a notification at the top of the screen, to the left of your account name (“Invitation Pending”). You can also click on that link to accept the invitation.
When a user accepts an invitation, the project is added to the list of available projects.
- Resend invite
Resend the invitation to a particular user to participate in this project.
First you select a user from the list of project participants, then the option to resend the invitation becomes available.
- Remove from project
Remove the user from the people that have access to this project.
First you select a user from the list of project participants, then the option to remove the user becomes available.
- Leave project
Click on this button if you no longer want access to this project. Once you have executed this command, you no longer have access to this project. If at some moment you need access again, the project administrator needs to re-invite you.
You cannot leave a project when you are the owner of that project.
When you are ready to test your project, you click this button. A separate browser screen/tab will open and your application is available for testing.
When your project is ready to be made available to end-users for acceptance or production, you use this button to get to the functionality where the publishing from one environment to the other takes place.
Publishing a Portal from Modeler (your build/test environment) to Staging, or from Staging to Live (your production environment) is very simple: just click on the arrow that specifies what needs to be published, and then click the
Publish button. Your project is now being published to the desired location.
When you want to look at the history of publish-actions for this project, simple click on the
Show history button and you are presented with a detailed overview of all publish-actions (who, when and which target) of this project.
When you need a copy of your project, use this button.
To delete the project you’re working on, click on this button. After the system asks for confirmation, your project is deleted, including all associated data.
The Project tree
When you open a project, the
home tab displays the Project tree. This is where you navigate to the various components that make up your application.
But this is also the place where you access the settings of the project.
To access a particular area of the WEM Modeler, just click on a node of the tree to get to that functionality. Clicking on the main node (the name of the project), takes you to the Project Settings page.
When changes are made to the project settings: make sure you save the changes (use the
Save changes button at the top of the form).
All your changes to the settings are lost when you forget to save them!
Project settings toolbar
The project setting has a toolbar with four options:
Save changes: hit this button to save any changes you make to the project settings
New portal: if your project needs multiple portals, you can select this option to create new portals. For every portal you create, a settings page is created (under Project settings).
Move project to other workspace: when you select this option, a popup appears where you can select the workspace to which you want to move the project.
Access control rules: here you can restrict access to your project, based on individual IP addresses or IP address ranges. Detailed information on how to use the access rules can be found here.
Project settings – main
|Name||The name you want to give your project|
|Portal Setting||Here you can specify variables that can have different values for every portal in the project. The variables can only contain text.|
|Enabled Languages||These are the languages that your application will support. The selected languages will appear in the Dictionary, so custom translations can be stored.|
Project settings – portal specific settings
Under Project settings, there are is a settings page for every available portal. This page is named after the portal name. When there is only one portal, it is called
Default (unless you have changed the name).
When you select a portal the portal settings toolbar becomes available:
The toolbar gives you access to the following functions:
Save changes– when portal settings are changed, you need to save the changes;
New portal– click here to add a new portal to the project. For every portal you create, a settings page is created (under Project settings);
Delete portal– delete the selected portal from the project;
Manage OData users– specify how the selected portal will expose the application data using the OData protocol. Detailed instructions how to do this can be found here;
Move project to other workspace– when you select this option, a popup appears where you can select the workspace to which you want to move the current project.
Access control rules– in order to control which IP addresses can access your portal (preview, staging or live), you can specify access control rules that give you granular control over access to your portal. Details on how to specify acces control rules are described in this article.
Portal specific settings – base settings
|Name||Here you specify the name of the application. This name appears in the application itself. This is often the same as the Project name (the Name is specified as ‘Default’), but it is possible to have different names.|
|Default language||Select a language from the dropdown list. This is a list of languages that are enabled in the ‘Enabled Languages’ list.||The selected language will be used throughput the application.
Depending on the language strategy, this language may or may not be changed by the user.
|Fixed – your application works in the language specified by the ‘Default language’ setting
Browser default – your applications works in the preferred language of the user’s browser (if that language is enabled for this project, else the default language is used)
User selectable – the user can select a language (and switch between languages) by selecting a language. The user can do this by clicking on a small country flag on the top of the page, that represents the language that has to be used. The default language is the language that is specified by the ‘Default language’ setting.
|Homepage||Select from the specified navigation nodes.||Here you specify the starting point of your application. By specifying a navigation node, the application will start with the URL that is specified by that navigation node.|
Portal specific settings – Custom error handlers
Sometimes an applications runs into an unexpected situation. For several of these situations you want to specify what needs to happen. You can do this by specifying a particular flowchart to which the application should jump when one of these unexpected situations occur. That way you can control what needs to happen in a certain situation. That may be simply displaying a more user-friendly error message, but could also result in executing some workflow/application functionality.
|Page not found||Select a flowchart from the available flowcharts.||Where is the user directed to in case the applications points to a webpage that does not exist or is not available|
|Unauthorized||Select a flowchart from the available flowcharts.||Where is the user directed to in case the user want to access some functionality but doesn’t have the authorization to access that functionality|
|Session expired||Select a flowchart from the available flowcharts.||Specify what should happen when the user-session expires. This can happen if a user makes no action for a long time. When a session expires, the information about what the user has been doing is no longer available.|
Portal specific settings – Portal Settings
All portal settings that you specified in the main project settings are shown here. For every setting, you can enter a value that will be specific for the current portal. If you have multiple portals, the same setting can have a different value for each portal. These portal settings can be used in expressions as
Setting([setting-name]) which will evaluate to the specific value for the actual portal.
Portal specific settings – Templates
For every portal you have, you must specify which template you want to use. The default template is the
Global - Default template.
The template is used to define the look and feel of your application. So changing templates, means changing the way your applications looks.
Depending on the selected template, there can be a number of template configuration settings, that allow you to customize a given template (specify a logo, header text, title to display in browser-bar or tab, background, whether you want a breadcrumb or not, etc.).
Portal specific settings – Staging & Live settings
Before you can use the staging environment (e.g. for acceptance testing) you need to specify the hostname (https://en.wikipedia.org/wiki/Hostname) that is used to access the project.
The same is true for the production environment: you need to specify the hostname that is used to access your project in the production environment.
|Force HTTS||Yes / No||Specify if you will use secure https. This is a security setting and requires SSL-certificates to be installed (see the section about certificates)|
Project Settings – Processes
This form enables you to select one or more process libraries that contain ready-to-use advanced functions, to be available within your application. When you click on the library name on the left hand side of the form, you can read a description of that library and see a list of available functions within the selected library.
Once you have ticked a checkbox for one or more libraries and saved the settings, these functions will become available in the WEM Modeler. You can immediately start using these functions in your flowcharts using the
This form also has a button labeled ‘Show usages’. This button is enabled when a library is selected. When you click on this button, you get an overview of where the processes in this library are being used in your application.
Project Settings – Query Parameters
Query parameters are parameters that are used in URLs (https://en.wikipedia.org/wiki/URL). Let’s look at this URL:
This URL contains two parameters:
action. Both have values associated with them. If this URL was actually used, the flowchart that is associated with the navigation point
queryparam, has direct access to these parameters and their values. To make this possible, you need to add a query parameter:
For each parameter you specify the query parameter name (
uid in our example) and you have to select the data field to which the parameter is mapped.
Now the flowchart has direct access to the value of the parameter, through the data field to which the parameter is mapped. Query parameters defined here can be used on all navigation items and the flows behind them. On navigation items you can also define query parameters which will only be available on that specific navigation item and the flowchart and url associated with it.
Project – other options
When you right-click on the Project in the tree node (right-clicking on the project name), you get a popup menu with three different options:
XML mapping definitions...
Project – Widget Libraries
When you select
Widget libraries… you can select which Widget libraries you want to use in your project:
These libraries are mainly used in the Interaction Node to create richer user interfaces. In the Interaction Node you will see that after adding one or more libraries you will have a lot of additional components available in the toolbar that you can use to create a rich user interface.
Simply select the library, hit the
Ok button and the library is available in your project.
Project – Service certificates
When you select
Service certificates… you are taken to a form that manages all certificates that are used in your project.
Here you can add trusted certificates, add your own certificates (client or server), mail certificates (as attachment to someone who needs to install the public part on their environment), delete certificates, etc.
You can also trace where certificates are being used in your application, by selecting a certificate and then click the
Find usages button.
Project – XML mapping definitions
This functionality will no longer be available in the near future. It is almost never used and will be replaced by newer functionality.
The feature is still available for backwards compatibility, but new Projects should NOT use this.
Next, let’s look at the WEM Modeler Flowcharts