Miscellaneous

Transport Apps

It is recommended at the minimum run an Unvired Development Server and a separate Production Server (larger landscapes should run Development, Quality/Test and Production separately). Any process agents that are developed are first configured and tested on the development server and then deployed to the production server. In order to help quickly create these configurations across Unvired server systems, manual Import and Export of settings or automatic Transport of settings and application is permitted. Export of settings also helps to maintain a backup of the configurations.

Transport

The “Transport” menu option displays the Transport console. You can transport both the configuration and the Process Agent binaries automatically from Development to Quality and then on to Production. This allows an automated and safe mechanism to move applications across the landscape. The Transport tab displays a list of all the existing UDEP systems that are a part of the landscape.

Add System

Click on the Add System button to add a new UDEP system into the landscape. Depending on the current system type (Development/Quality/Production) downstream servers can be configured. For e.g. Production can only be added to a Quality system. Enter the target system details and click on “Validate and Add”.

Once the credentials are validated the system will be added to the list. Please note that credentials are not stored and are used to validate only, administrators will be required to enter the credentials for each transport.

Edit System

The systems can be selected and either modified or deleted as required.

Transporting Applications & Configuration

Select the target system and click on the Transport button to transport applications from one UDEP system to another. A list of applications that can be transported is now displayed. Select the application and click Next. The target system credentials now need to be entered. Once validated the transport can be started. If the validation is successful, a confirmation is displayed. Transport is permitted from Development to Test and Production and from Quality to Production only.

Click on the Start button to start the transport. The progress is displayed and final confirmation. The target system has now the complete application and its binaries transported.

Compare

Selecting the target system and clicking on the Compare button enables administrators to compare applications and their configuration across systems. Once the comparison is complete a detailed report is displayed as below.

Manual: Export Settings

The “Transport” menu option by default displays the configured transports. Select the Export tab and then select the application or applications that you want to export and click on the “Export Selected Objects” button. This exports entries that have been selected The system will prompt for a password to encrypt and protect the exported file since sensitive settings may be present in the exported file. After export, the file can be immediately downloaded.

Manual: Import Settings

The “Transport” menu option by default displays the configured transports. Select the Import tab to manually import applications. Upload a previously exported and downloaded transport file and enter the password to import. The following can be imported:

Logical (Backend) systems
Backend ports
Functions
Frontends
Applications
Groups
Users
Choose the file to be imported (previously exported as explained in the earlier export settings section from a different UDEP system) or drag and drop it in the browser.
Click on “Import” button, enter the password on prompt. If the password is correctly imported all the settings will be imported and a final confirmation displayed.

Unvired Modeler

When development is done using the Unvired Modeler in Eclipse, transport to Development is handled within the Eclipse Modeler itself. Transport as described above is primarily required to move Applications & Configuration to Quality and Production from Development.

Scheduler

UDEP Server can refresh data periodically by invoking process agent functions on a schedule and pushing the data to a group of users. To configure these, click on the “Scheduler” menu.

Add Scheduler

The “Schedulers” tab displays all the schedules that are currently configured in the Unvired server. You can add a new schedule and edit or delete the selected schedule to suit your requirements.

Click on “Add” to add a new schedule.

Choose the type of schedule
- Repetitive – Repeat execution at every hour at the minute specified. For e.g. at 11:05, 12:05 etc
- Specified – Repeat execution at the specified times (more flexible)
Choose the “Group” for which you are creating the schedule. If there are no existing groups you can add a group by following the details in the group section.
Choose the application and function to execute periodically.
Use Client Credentials – If the function being scheduled to run requires credentials to be propagated by the client, select this option. UMP will queue a message to the client to send the credentials for execution in this case. If not selected, the function will be executed directly on the server with credentials that are configured either at the Port level or at the backend user.
Run on selected days only – If the schedule has to be execute only on selected days (for example on working days Monday to Friday only), select this option and the required days
Ignore message – If this option is set, when the function is executed and the message to the device is to be queued a further check is made to ascertain if the message from the previous run is still pending. If the message is pending then the message is ignored and the new message queued. If the option is switched off then the message is queued in addition to the older message.
Run this scheduler for the individual user – If the function that is being executed returns the same data for all the users in the group then this option can be unchecked. Only one call for the entire group is then made. However if the function returns specific data for each user in the call then this option has to be selected so that one call for each user is then made.

Admin Notifications

The UDEP generates notifications automatically for administrators whenever system errors occur. For example if an SAP connection fails a notification is generated automatically. The process agents can also generate notifications for administrators using the SDK.

These notifications are recorded in the “Notifications” monitor. Additionally if the administrator is equipped with the “Unvired Administrator” mobile application, these notifications will be “pushed” to the device so the administrator is aware of the errors and can take action immediately.

The administrators can also login to the UAC and click on the “Notifications” menu option in the navigation tree to display all the pending notifications.

Notification Configuration

The UDEP generated notifications are sent to only those administrators who have subscribed to it. The different categories of notifications are:

UDEP Database error – Any errors due to UDEP system database.
Backend Connection error – Any errors due to connectivity or other technical failures of the backend systems.
Frontend error – Any errors due to frontend failures (push etc)
Technical error – Any other technical errors
Process Agent error – Any errors that are notified by the process agent
Miscellaneous error – All other errors

The method to subscribe to notifications is as follows:

Create a group and add the administrators who are to get the notifications to that group. Any number of groups may be created.
Click on the “Recipient” icon for the selected category. - Select all the groups who are to be notified and save.
Choose the level for the notifications desired. The options available are to notify only Error or Error and Warnings.
Choose the type of notification desired. The options available are Mail, Notification (Push to Unvired Administrator Application) or Mail and Notification. If notification is not desired leave the combo at “Select”.

Email Configuration

All notifications from the Unvired server are sent via Email. You can configure the email settings by clicking on the “Email” menu option in the navigation tree. Unvired server supports email notifications via any SMTP server including SSL enabled email services such as GMail (Google Apps also) and Amazon Simple Email Service.

The required configurations are:

Property	Details
Name sent as	Set the email sender’s name here
Mail sent as	Set the email sender’s email here
SMTP Host	IP address or host name of the SMTP server
SMTP Port	SMTP Port number
Use SMTP Authentication	If the SMTP server being configured requires authentication before any email is sent then set this option to “YES” else to “NO”.
SMTP User	User name for SMTP authentication
SMTP Password	Password for SMTP authentication
Use Secure Connection	If the server is a standard SMTP server set to No, else if SSL or TLS (like GMail) is required please set it accordingly.
Send Test Mail	Set the email id to send a test mail

Email Templates

Email templates can be configured in UDEP for use by both the platform and the applications. Access the Email Configuration menu option to navigate to the templates section.

Message

Configure each of the messages for system events here. For e.g. the Create User message is used to mail a new user about their user ID being created in the system. The standard template (explained below) is used to send these messages. The message will be sent only if it is enabled.

Standard Template

Under the “Template” tab, the standard template can be configured. This template is used for all system generated and application generated messages and is common across all applications. The standard template is used for all predefined messages (see above)

Other Templates

When applications require their own templates for messages that are sent for individual application related events, multiple custom templates can be defined. Each template is identified with a template name and is associated with an Application, the subject to use and additionally the message.

Variable Substitution

The template can have variables (placeholders) that are substituted at run time with the corresponding values. Variable are included in two variants, as {$variable} or as {${variable}}. The difference between the two is that in the case of {$variable} the value is substituted directly and in {${variable}} the value is URL encoded before it is substituted. For e.g. if the variable is part of a URL (that is included in the template) then it is recommended to use the {${variable}} variant so that the URL is safely encoded.

Supported substitution variables are:

Property	Variable	Details
1.	$username	The Unvired ID or user name of the user
2.	$firstname	The user’s first name
3.	$lastname	The user’s last name
4.	$authkey	The system generated auth token (or private access token)
5.	$password	The system generated password (if it has to be included in email)
6.	$link or $linkbutton (deprecated)	The link that is auto generated for resetting password etc.
7.	$verifyToken or $resetToken (deprecated)	The token to reset password etc.
8.	$application	The application the user is using
9.	$email	The user’s email ID
10.	$company	The company (or domain) the user belongs to
11.	$message or $bodyStart (deprecated)	The actual message
12.	$subjectDetails	The subject of the email (in case it needs to be included in the message)

System Properties

The “System Properties” icon displays and allows to configure advanced properties of the Unvired Server. Any changes made to the system properties should be done carefully as it can hamper the working of the system. The Root company SA user will be able to configure a lot more properties than the other companies. The screenshot below displays the Root user login.

General

The system properties that are read only are displayed in the first tab called General for information.

Application Server – The host name or the IP address of the Unvired server
UDEP Home – The home folder for the Unvired server. All process agents, related data and other temporary files of the Unvired server are stored in this folder.
Company Data Folder – The private folder where the root company’s data is stored (configured during post installation)
Installation Number – System assigned installation number
System ID – System assigned identifier
Security Level – Unvired server can be configured to operate in different security levels.
- 100 – HTTP with authentication. This should be used for development and test systems only
- 200 – HTTPS with authentication. This is the default operating mode for production servers
- 300 – HTTPS with authentication but with restricted admin access. This is high security mode (for compliance with requirements of HIPAA etc.) wherein Super Administrator login is highly restricted.
Type config version – The version of the configuration file currently installed.

Custom

Password policy – The user password policy is set here. The available options are:
- No conditions – Should be used only on development or quality systems.
- Alphabets, Digits & Special characters - Password needs to contain alphabets (upper and lower case), digits and special characters and of minimum length of 8.
- Alphabets & Digits – Password needs to contain alphabets (upper and lower case) and digits and of minimum length of 8.
- Alphabets - Password needs to contain alphabets (upper and lower case) and of minimum length of 8.
Two factor authentication for Login – If this is enabled, the Admin Cockpit login is further protected with a two factor token generated by Google Authenticator (or other compliant apps like Authy).
Two factor authentication for Data – If this is enabled, the data view for SA user on an UDEP production instance is further protected with a two factor token generated by Google Authenticator (or other compliant apps like Authy).
Reload Type Configuration –The types of Systems and Frontends supported by UDEP is determined by a “Type Configuration”. This configuration is embedded in the platform and may be updated from time to time. The updates may be to do with new configuration parameters that have been made available with UDEP system connectors or new systems that are now supported etc. Only SA user of Root company has access to this information and can update the type configuration. Click on the button to reload the configuration with the new values. This is typically required when upgrading UDEP versions.
Clear UMP Cache - For performance reasons UDEP caches user and application information. To clear this cache click on the button and confirm. This does not cause any harm to the system and can be used safely. The cache will be automatically rebuilt.
Reprocess pending messages - In the unlikely event that UDEP has been restarted while users requests where being received, these requests would stay in the processing or pending state. Clicking on this button will initiate a repost of all these messages so that they can be processed fully. Note that its possible that these messages have already been processed at backend and only the UDEP processing didn’t complete, so use with care.

After an upgrade, on SA user login the platform will automatically prompt to import any Type Configuration changes. Click the button to import and then wait for the confirmation message.

The other options are:

Support Login – Available only if Production UDEP set up with security mode 300. In this mode, the Unvired* (SA Support user) can only login to the system during the exact duration configured.
Debug – Available only if Production UDEP. In this mode, debug of process agent functions is allowed only during the exact duration configured.
Run Mode – Available on all landscapes of UDEP. Set the Run Mode to Halted to temporarily disallow REST API and Mobile calls to the platform. (Running calls are not affected, only future calls are prohibited). The configured message will be returned to the caller.

Plan Details

Displays the currently active plan for the company.

Personalization

Click on the “Personalization” tab to set up some personalization options for your login.

Rows to display – The maximum number of rows to display in tables.
Start Page – The page to display after login
Upload your profile picture

File Explorer

Click on the “File Explorer” tab to display the UDEP Home folder for backup or for restoring / working with the file system in case of any issues. Please note that this backup is not a replacement for a full server backup as detailed in the Unvired Mobile Platform – Backup Guide. This is a simple means to back up the security key, license key, process agent files etc. to recover from a loss of these files. This option is enabled only if the administrator login is “SA”.

In order to download a backup, drag the required files and/or folders to the cart. A “Make Zip” button is now enabled. Click on the Make Zip button to zip all files selected and then download using the link displayed. Please safeguard the files (especially the UNI_Shared.key file as the data is encrypted using this key and should not be compromised) in a secure location for reuse in case of disaster.

System Information

This screen displays the system information snapshot along with the health of the system. The information displayed is:

Database - Type of database used with this UDEP (MySQL, MSSQL, Oracle, PGSQL, H2) and its connection status
Redis HA server – Redis availability details (Redis Sentinel, Master and Slaves)
Vault - For higher security requirements like HIPAA etc., optionally a Vault server can also be configured in the landscape to store and provide the credentials.
UDEP Nodes and Heartbeat – The number of UDEP nodes in this landscape and the heartbeat information
Current Instance – In a multi instance landscape, the current instance information is displayed here along with connectivity to Redis and the Quartz Scheduler run status

Reports

The “Reports” menu displays a simple report with details of the number of messages sent by a user, the amount of data transmitted and received etc. can be displayed. The report can be generated for all users or a selected user for a time duration.

Note: Custom reports are planned and not available.

Export Data

Any list of data that is displayed in the UDEP can be exported to Excel format. For e.g from the list of applications click on the Excel icon at the bottom of the list. A list of columns that can be exported are displayed. Select the columns to export. If the “Select All Pages” option is checked then all rows (both displayed and not displayed) will be exported. Click on “Download in Excel Format” to now download the file.

Keyboard Shortcuts

Helpful Keyboard Shortcuts

The Unvired Admin Cockpit can be used with keyboard shortcuts to quickly navigate across options. Type Alt+M to open the menu and Alt+H to show all the short cuts.

The shortcuts are:

Shortcut	Details
`Alt + M`	Display the menu
`Alt + H`	Display all the shortcuts once the menu is open
`Alt + R`	Refresh a table
`Alt + U`	Users
`Alt + F`	Frontends
`Alt + B`	Backends
`Alt + L`	Scheduler
`Alt + Y`	System Properties
`Alt + T`	Transport
`Alt + N`	Notifications
`Alt + S`	Sync Messages
`Alt + A`	Async Messages
`Alt + V`	Device
`Alt + C`	Attachments
`Alt + E`	REST API
`Alt + O`	Logout

Knowledge Base

In addition to this guide, Unvired publishes Upgrade and other information in the secure Knowledge Base, Please access the KB at https://support.unvired.com/projects/kb/knowledgebase/articles for more information.