Administration

The Administration Cockpit is a web application that helps administer and troubleshoot the UDEP.

Upgrade

For additional Upgrade and other information please refer the KnowledgeBase

Login

Login

The Unvired Admin Cockpit (UAC) is a web application and Administrators can login from any browser. Only Super Admin, Administrator and Support Admin type of users can login to the Admin Cockpit to access the portal. However depending on the type of user the operations available to the users vary.

Unvired ID

Administrators can login with their Unvired ID and password.

Microsoft Active Directory Use

Administrators can also use their Microsoft Domain User (ADS). Configure the “ME” system properties (described later) to use AD Login and then enter your AD user ID and password. The Unvired ID of the Administrators should be mapped to their AD user to perform a successful login.

However the “SA” user (Super Admin) is not mapped to ADS to ensure that the system is available even when the MS ADS server is not accessible.

At the bottom of the page, the build version, build date and the type of server/database is also displayed.

Note: To reset a forgotten password click on the “Forgot Password” option. This option is available only for Unvired Users and requires the email configuration to be complete.

Security

The login to the UAC is using a user id and password. It can be additionally secured by requiring a one time use token from applications like the Google Authenticator etc.

The password complexity, password history, number of attempts before lock out, time before the locks are automatically released etc are all configurable via properties on the ME system.

Manage Companies

The company created during the post-installation is termed the “Root” company and is the “owner” of the platform or infrastructure. Administrators of the root company only can create companies and assign plans. This hierarchy of companies is useful to partition access across departments (for e.g. root company is the company and child companies are departments), locations, subsidiaries etc.

Create & Edit

Click on Companies to display the list of companies maintained in the system. You can click on Add to add new company or edit them. Depending on the edition (Data Center, AWS, Google Cloud etc) additional parameters may need to be configured.

Create & Assign Plans

Once a Company is created, a Plan needs to be assigned. The plan determines the resources that the company can have access to. Click on plans and all the standard plans are displayed.

If needed custom plan can also be created to finely tune the plan by clicking on the Custom Plan tab. Once the plan is created, click on the Company Plan tab. Select the company and click on Search. All configured plans are displayed.

Click on Add and add a standard or custom plan for the company. Remember to select and activate it after adding it.

Note: A company can have only one active plan.

Manage Backend Systems

Backend Systems List

The “Backends” menu option in the navigation tree displays all the backend systems that have been created in the UDEP landscape. As already explained elsewhere, applications in UDEP can connect to configured backend systems securely and the credential management and security protocols for connection are all managed by UDEP.

From this screen you can:

• Create new Systems
• Edit or View existing Systems
• Delete Systems that are not required anymore. Before deleting a system you should ensure that there are no applications that are using the System. (Refer the Applications help section). Deleting the system will also delete the associated ports and functions.
• Setup System downtime by using the maintenance option. If your SAP or other backend systems are due for a downtime due to maintenance or other activities, you can setup the maintenance window in UDEP so that mobile devices which post data to UDEP will receive appropriate messages and data will be held for later processing. (If a system is under maintenance it is also displayed in the list).
• Refresh the list by clicking on the Refresh icon.

Maintenance

When the system is going to be down for maintenance or updates etc, you can configure UDEP to inform users about the downtime. Whenever the users submit a transaction for the system under maintenance, an appropriate message is sent back so that the user can resubmit later.

When maintenance is scheduled the indicator is Red and when the system is being used normally the indicator is Green. Once the maintenance is scheduled the details are shown in the list. You can also cancel a scheduled maintenance (downtime) by selecting the system for which maintenance has been scheduled, click on the “Maintenance” button and then “Cancel Maintenance”.

ME Backend Systems

“ME” or “Self” is a special acronym to indicate the UDEP system itself. All the properties for UDEP are configured in the special ME system. ME is automatically created during post-installation and cannot be deleted. A few properties can be configured on the ME system. Below a screen shot example of how these and other properties appear in the Admin Cockpit and how they can be configured.

Note: Please be very careful when modifying the properties of “ME” as this affects the running of the system and can make it inaccessible to users if the wrong configuration is done. Also some parameters are available only for “SA” user of the root company and other properties are available to “SA” user of all companies.

The different parameters available are dependent on type of Company (Root or others):

Property	Availability	Details
APP_SERVER	ROOT	The hostname or IP address of the UDEP server. If UDEP is deployed behind a load balancer, set this to the load balancer’s DNS name or IP address. The mobile app will be provided with this URL to connect to the platform on activation.
SYNC_PORT	ROOT	The port on which UDEP server is listening to requests from the mobile clients and administration cockpit. Typically this is 8080 or 8443 for JBoss/Wildfly. For installing on standard ports such as 80 (HTTP) or 443 (HTTPS) a load balancer / forwarder will usually be required.
SERVER_TYPE	ROOT	DEVELOPMENT, QUALITY or PRODUCTION. Set during installation and cannot be modified.
SHARED_KEY_ALGORITHM	ROOT	Set by the system to AES (cannot be modified).
SERVER_ID	ROOT	Indicates the unique SERVER_ID that has been allocated to this UDEP instance. This is system generated and cannot be changed. Mobile devices use this to ensure that they communicate with the correct servers on which they have been authenticated.
PASSPHRASE_FOR_SHARED_KEY	ROOT	The passphrase that was created during installation (cannot be modified).
SECURITY_LEVEL	ROOT	Displays the configured security level for this UDEP instance. The different values supported are: 100 – HTTP with authentication (recommended for Development and Test instances of UDEP) 200 – HTTPS with authentication (recommended for Production instances) 300 – HTTPS with HIghest security suitable for hosting HIPAA compliant applications. Please be careful while modifying this value as the HTTP protocol is affected. Additionally it will only take effect after all clients reactivate.
INSTALLATION_DATE	ROOT	The date the UDEP system was installed, system generated and cannot be modified.
INST_NR	ROOT	The Installation number for UDEP, system generated and cannot be modified.
SYS_NR	ROOT	The System number for UDEP, system generated and cannot be modified.
USAGE_LIMIT_TOLERANCE	ROOT	Internally used to check license validity, cannot be modified.
MESSAGE_UNIT_SIZE	ALL	Size of the largest message that can be individually delivered to the device. Set this value (in bytes) based on the amount of data that the device can accept without any performance issues, the default setting is 262144 or 256 Kbytes. Note that this is also the maximum size of a single business object that can be sent to the device as a message needs to be made up of at least 1 business object (partial data is not allowed).
MESSAGE_TOTAL_SIZE	ALL	Size of the total message that can be delivered to the device (Note that large messages will be split into smaller messages of size MESSAGE_UNIT_SIZE each). Set this value (in bytes) based on the amount of data that the device can accept without any performance issues, the default setting is 2097152 or 2 Mbytes.
ENABLE_REST_API	ALL	Controls access to UDEP using the REST APIs. The REST APIs allow external systems to interact with UDEP and can be enabled or disabled based on requirement.
REST_API_LOGIN_EXPIRY	ALL	Controls the expiry of REST API login. The accepted values are Never (no expiry) or expiry after 1 Hour, 1 Day, 1 Week or 1 Month.
REST_API_MULTIPLE_SESSION	ALL	Controls whether each user is allowed to have multiple sessions via the REST API. If multiple is disabled, each user can have at most one “application” using REST APIs. If multiple is enabled, the login session is shared across multiple logins and can enable the usage of multiple applications built with the REST API.
REST_API_LIMIT	ALL	Limits that number of REST API calls that an Unvired user can execute within a minute. Note: These limits are not imposed yet and are included as a failsafe.
REST_API_CORS	ALL	Enable Cross Origin Resource Sharing(CORS) for REST API. List all the domains you want to permit comma separated. While * is a valid value, it is generally discouraged for security.
MESSAGE_DISPLAY_LIMIT	ALL	The data stored for each message can be very large sometimes. This setting controls the maximum message size in KB that will be displayed in the Admin Cockpit. Messages larger than this can only be downloaded and viewed offline.
APP_STORE	ROOT	If set to PUBLIC anybody can view and install apps without authentication from the Store, if PRIVATE only logged in users will be provided access to the store. Note: While UDEP does provide a basic store, customers are encouraged to use public App stores or Moble Device Management or MDM systems to deploy apps.
PASSWORD_CHANGE_ON_RESET	ALL	If this setting is enabled, if an Administrator resets a password the user will be required to change the password immediately on login.
PASSWORD_EXPIRY_DAYS	ALL	Number of days after which a password expires and has to be reset. Can be set to “No Expiry” or specific number of days.
PASSWORD_HISTORY	ALL	Number of password (1-5) to maintain in history. Users will need to select passwords taht are not present in the history.
AC_LOGIN_MODULE	ALL	Enables login to UAC via Unvired ID or MS ADS user ID. Note that the SA user cannot be mapped to any ADS user.
LOGIN_ATTRIBUTE	ALL	(Optional) If LOGIN_MODULE is set to LDAP or ADS (For application login or Admin Cockpit login), the LOGIN_ATTRIBUTE determines which field from the LDAP or ADS needs to be mapped to the value set in the Unvired user’s Federation ID. For example to use the Windows domain login name, this field can be set to sAMAccountName.
LOCK_LOGIN_ATTEMPTS	ALL	The number of unsuccessful login attempts after which the user will be temporarily locked out from Admin Cockpit.
LOCK_SECONDS	ALL	The number of seconds to lock the user, after the expiry of this the user is automatically unlocked.
CACHE_LOCATION	ALL	The cache location on the UDEP server file system where the attachments are cached. Enter the full path for eg: C:ÞP_HOMEttachments and make sure that the service login user has full access to this folder.
ENCRYPT_CACHE	ALL	Encrypt attachment files or store as is in the cache
NO_OF_PARALLEL_DOWNLOAD_JOBS	ALL	Number of download of attachments to handle in parallel. It is recommended to have a smaller number so that attachment downloads do not “overload” the UDEP server or increase CPU usage.
CALL_LOG	ALL	For future use. Enables or disables detailed call log.
CACHE_LOCATION	ALL	Enter the folder location where the attachments have to be cached. Do not start with a / as the path is relative to the company’s data store.
ENCRYPT_CACHE	ALL	If enabled the cached files are encrypted. Use with caution as this can cause performance issues if large files are exchanged over the network.
AC_SESSION_TIMEOUT	ROOT	Default inactivity timeout for the Admin Cockpit
GOOGLE_MAPS_API_KEY	ALL	Google maps API key to be used for map view of all devices.
BROWSER_KEEP_ALIVE	ALL	The time interval in seconds for the UDEP server to keep the connection to the browser alive, 0 to disable. This is useful for browser apps that register for push notifications to keep the session alive.
LOGENTRIES_TOKEN	ALL	LogEntries TCP Token to send logs to LogEntries.com
LOGGLY_TOKEN	ALL	Loggly API Token to send logs to Loggly.com
SCHEDULER	ROOT	Enable or disable the distributed scheduler. If scheduled execution of functions is not required you can safely disable this for better perfornance.
GRPC	ROOT	For later use. Support GRPC for JavaScript.

Template Systems

Typically systems are only available within the company or domain within which they are created. However for standard applciations that can be used by other companies also (like the TurboForms application), marking the systems as template systems allows child companies to change the configuration of these systems.

For e.g. if a root company configures a template database to an IP address 192.168.0.1, the child company can configure this to mymssql.azure.microsoft.com for their landscape.

Create

Clicking on the “Add” button allows adding or creating a new Backend System in the UDEP landscape. Enter the name of the system (remember no spaces allowed), a description to identify the system and the system type and press the Next arrow button.

The different system types supported are:

System Type	Details
SAP	Any SAP system that is running the ABAP engine like SAP S4/HANA, SAP ECC, SAP CRM, SAP SCM etc which UDEP needs to access.
LDAP Server	Any LDAP server that you need for authenticating your users.
Web Server	Any Web server that may be providing Web Services for your applications using http or https.
Relational Database	Connection to a database to extract and update data.
FTP Server	Any FTP server that you need to upload or download files.
Windows Active Directory Server	Windows ADS for authenticating.
Oracle EBS	Oracle E-Business Suite

Note: For server addresses hostname is generally preferred. If you do not have a DNS to resolve or have assigned static IP addresses to your servers you can also enter IPV4 addresses here. Based on the system type chosen, a set of parameters as detailed below will be accepted.

SAP

Create an SAP System if ABAP function modules need to be executed to fulfill the mobile functionality. Some examples of SAP ABAP systems are SAP S4/HANA, SAP ERP (ECC), SAP CRM, SAP SCM etc.

Note: You will need to request the below details from your SAP administrator.

You will need to create an SAP ABAP System if you need to execute ABAP function modules to fulfill the mobile functionality. Some examples of SAP ABAP systems are SAP ERP (ECC), SAP CRM, SAP SCM etc.

The different parameters for SAP ABAP systems are:

Property	Details
Connection Type	If you are using a single instance SAP Application server that you connect to directly, then choose “Custom Application Server” and if you are using a Group server then choose the option “Group Server”.
MSHOST	Valid if “Group Server” is chosen. Enter the SAP Message server details here.
GROUP	Valid if “Group Server” is chosen. Enter the group SAP Application server here.
ASHOST	Valid if “Custom Application Server” is chosen. Enter the SAP Application server details here (hostname or IP address).
R3NAME	Enter the 3 letter R/3 Name assigned to your system.
SYSNR	Enter the 2 digit System number of the system you are connecting to.

LDAP Server

Create an LDAP Server if you need to connect to LDAP servers to authenticate users from UDEP.

The different parameters are:

Property	Details
SERVER	Enter the DNS name of the ADS server or its IP address

Press the next arrow and review the information. On pressing “Save” the system will be created in the UDEP landscape.

Web Server

Create a Web Server if you need to connect to Web Services (SOAP or REST) on these servers. Good examples of such systems are SugarCRM, Workday etc.

The different parameters are:

Property	Details
SERVER	Enter the server details here (hostname or IP address).
ALLOW_INSTANCE_URL_OVERRIDE	For OAuth dependent systmes like SFDC, the system URL is known only after login and hence requires the App to be able to overrride the preconfigured URL. Enable this setting for such servers only.

Relational Database

Create a Relational Database Server if you need to connect to a database server. You can connect to Microsoft SQL Server, Oracle, MySQL, Postgresql and SAP HANA databases.

The different parameters are:

Property	Details
SERVER	Enter the DNS name of the database server or its IP address
Press the next arrow and review the information. On pressing “Save” the system will be created in the UDEP landscape

FTP Server

Create an FTP Server if you need to connect to an FTP server to upload or download files for your process agents.

The different parameters are:

Property	Details
SERVER	Enter the DNS name of the FTP server or its IP address
Press the next arrow and review the information. On pressing “Save” the system will be created in the UDEP landscape.

Windows Active Directory Server (ADS)

Create a Windows Active Directory Server if you need to authenticate against it (Admin Cockpit or Mobile Application)

The different parameters are:

Property	Details
SERVER	Enter the DNS name of the ADS server or its IP address
Press the next arrow and review the information. On pressing “Save” the system will be created in the UDEP landscape.

Oracle EBusiness Suite

Create an Oracle EBusiness Server if you need to connect to an EBS system from the process agent to execute transactions.

The different parameters are:

Property	Details
SERVER	Enter the DNS name of the EBS server or its IP address
Press the next arrow and review the information. On pressing “Save” the system will be created in the UDEP landscape.

Backend Ports List

After clicking on the “Backends” menu option in the navigation tree, click on the “Ports” tab to configure the backend ports in the UDEP landscape. Ports are specific for a Backend System. From the dropdown list select the Backend system and the Ports connected to that system will be displayed. New Ports for the selected system may also be added.

From this screen you can:

• Create new ports
• Edit or View existing ports

Create Backend Port

Clicking on the “Add” button allows adding / creating a new Backend port for a Backend system in the UDEP landscape. Select the name of the system to configure from the dropdown list. Depending on the type of Backend System specific Ports may be created (attached) to the systems.

The table below lists the allowed ports for each type:

Sl. No.	Backend System Type	Allowed Backend Ports	Comment
1.	ME	Java	Allows invoking all process agent functions that have been uploaded to UDEP. Please refer the Development Guide for more details on Process Agents. This port is created during post-install and does not require any administration.
	ME	JavaScript	For later use to allow JavaScript functions to be executed via GRPC.
2.	Active Directory Server	ADS	Allows to look up information from an MS ADS server
3.	LDAP	LDAP	Allows to look up information from an LDAP server
	FTP Server	FTP	Allows connections to the FTP server
4.	Relational Database	MSSQL	Allows connections to MS SQL database
		MYSQL	Allows connections to MySQL database
		ORACLE	Allows connections to Oracle database
		HANA	Allows connections to SAP HANA database
5.	Web	REST	Allows connecting to REST (HTTP/HTTPS) services
		ODATA	Allows connecting to ODATA services
		SOAP	Allows connecting to SOAP services
6.	Oracle EBS Server	ORACLE_EBS	Allows connections to the Oracle EBS server
7.	SAP ABAP	RFC	Allows invoking any BAPIs or RFCs on an SAP Backend System.

Based on the system port chosen, a set of parameters as detailed below will be accepted.

Java Port

A Java port is auto created by the UDEP post-install and attached to ME Backend System (UDEP). All Java functions that are part of the Process Agent need to be created on the Java Port of the ME system. For more details on Process Agents please check the Unvired Developer Guide.

Java ports do not have any configurable parameters.

RFC Port

Create an RFC port on an SAP ABAP System if ABAP function modules need to be executed to fulfill the mobile functionality. Some examples of SAP ABAP systems are SAP ERP (ECC), SAP CRM, SAP SCM etc.

The different parameters are:

Property	Details
CLIENT	Enter the SAP Client number to connect to. This is a 3 digit number that your SAP administrator can provide. For eg IDES clients are on 800.
USER	This is an optional parameter. If all connections to the SAP system need to be made with a common User ID (for example an RFC Communication User), then the User ID can be entered here. (Note: Please ensure that you are meeting all of SAPs licensing requirements before making this entry. You can get more info on licensing from your SAP account manager)
PASSWD	This is an optional parameter. If you have entered a User ID, then enter the User’s password here.
LANG	Enter the SAP Logon language. This is the 2 Digit short form that you need to enter here similar to the code entered while login via SAPGUI.
MAX_ASYNC_CONNECTIONS	Use this setting to manage the (additional) load on the SAP backend system due to calls from the mobile application executed in an Asynchronous fashion. (Asynchronous calls are those originating on the device where after successful posting of the request to the server the application does no wait for a result but retrieves it later.) For example if set to 50, at most 50 simultaneous calls can be made by UDEP to the SAP backend system. Beyond that the calls will be automatically queued and executed when the connections are freed up. Enter -1 to impose no limit on connections in this parameter.
ASYNC_CONNECTIONS_TIMEOUT	The timeout (in seconds) while waiting for a connection to be available.
MAX_SYNC_CONNECTIONS	Use this setting to manage the (additional) load on the SAP backend system due to calls from the mobile application executed in a Synchronous fashion. (Synchronous calls are those originating on the device where after successful posting of the request to the server the application waits for an immediate result and does not allow the user to navigate out of the screen) For example if set to 20, at most 20 simultaneous calls can be made by UDEP to the SAP backend system. Beyond that the calls will result in errors being returned to the mobile application with a request to try again later. Enter -1 to impose no limit on connections in this parameter.
USE_CLIENT_CREDENTIALS	Use this setting if the mobile users will be entering the User ID and Password for the Backend System on the device (as opposed to entering it above in parameters USER and PASSWD or at the User level explained in the User section). If USE_CLIENT_CREDENTIALS is set to YES, then the device application will prompt the user to enter the system User ID and Password on the device and the device propagates the credentials to UDEP as and when required.

SOAP Service Port

Create this port on Web Server if SOAP Services need to be executed to fulfill the mobile functionality.

The different parameters are:

Property	Details
PROTOCOL	Select http or https based on the remote server protocol.
PORT	The port to connect on (for e.g. 80, 443 etc)
AUTHENTICATION_TYPE	Two modes of authentication are supported BASIC and APPLICATION. If the Web Service requires the User ID and Password to be propagated as part of the HTTP Header for authentication set it to BASIC else if the Web Service internally handles the authentication set this to APPLICATION.
USER	The User ID to be used if the Authentication type is BASIC.
PASSWORD	Set this Password if the USER has been provided for BASIC authentication.
SOAP_VERSION	Set this to the correct SOAP version (you can get this from the WSDL) to be used SOAP11 (SOAP v1.1) or SOAP12 (SOAP v1.2).
PROXY_HOST	(Optional) If a Proxy is to be used, set the proxy hostname or IP address here.
PROXY_PORT	(Optional) If a Proxy is to be used, set the proxy port here.
PROXY_USER	(Optional) If the Proxy server requires authentication set the proxy user name here.
PROXY_PASSWORD	(Optional) If the Proxy server requires authentication set the proxy password here.
MAX_ASYNC_CONNECTIONS	Use this setting to manage the (additional) load on the backend system due to calls from the mobile application executed in an Asynchronous fashion. (Asynchronous calls are those originating on the device where after successful posting of the request to the server the application does no wait for a result but retrieves it later.) For example if set to 50, at most 50 simultaneous calls can be made by UDEP to the backend system. Beyond that the calls will be automatically queued and executed when the connections are freed up. Enter -1 to impose no limit on connections in this parameter.
ASYNC_CONNECTIONS_TIMEOUT	The timeout (in seconds) while waiting for a connection to be available.
MAX_SYNC_CONNECTIONS	Use this setting to manage the (additional) load on the backend system due to calls from the mobile application executed in a Synchronous fashion. (Synchronous calls are those originating on the device where after successful posting of the request to the server the application waits for an immediate result and does not allow the user to navigate out of the screen) For example if set to 20, at most 20 simultaneous calls can be made by UDEP to the backend system. Beyond that the calls will result in errors being returned to the mobile application with a request to try again later. Enter -1 to impose no limit on connections in this parameter.
USE_CLIENT_CREDENTIALS	Use this setting if the mobile users will be entering the User ID and Password for the Backend System on the device (as opposed to entering it above in parameters USER and PASSWD or at the User level explained in the User section). If USE_CLIENT_CREDENTIALS is set to YES, then the device application will prompt the user to enter the system User ID and Password on the device and the device propagates the credentials to UDEP as and when required.

REST Service Port

Create a REST port on Web Server if REST Services or simple HTTP or HTTPS calls need to be executed to fulfill the mobile functionality.

The different parameters are:

Property	Details
PROTOCOL	Select http or https based on the remote server protocol.
PORT	Enter the port number on which the remote server is listening for external calls. For example default HTTP port is 80, HTTPS port is 443, alternate HTTP port is 8080 etc
USER	The User ID to be used.
PASSWORD	Set this Password if the USER has been provided.
USE_CLIENT_CREDENTIALS	Use this setting if the mobile users will be entering the User ID and Password for the Backend System on the device (as opposed to entering it at the User level explained in User section). If USE_CLIENT_CREDENTIALS is set to YES, then the device application will prompt the user to enter the system User ID and Password on the device and the device propagates the credentials to UDEP as and when required.
MAX_ASYNC_CONNECTIONS	Use this setting to manage the (additional) load on the backend system due to calls from the mobile application executed in an Asynchronous fashion. (Asynchronous calls are those originating on the device where after successful posting of the request to the server the application does no wait for a result but retrieves it later.) For example if set to 50, at most 50 simultaneous calls can be made by UDEP to the backend system. Beyond that the calls will be automatically queued and executed when the connections are freed up. Enter -1 to impose no limit on connections in this parameter.
ASYNC_CONNECTIONS_TIMEOUT	The timeout (in seconds) while waiting for a connection to be available.
MAX_SYNC_CONNECTIONS	Use this setting to manage the (additional) load on the backend system due to calls from the mobile application executed in a Synchronous fashion. (Synchronous calls are those originating on the device where after successful posting of the request to the server the application waits for an immediate result and does not allow the user to navigate out of the screen) For example if set to 20, at most 20 simultaneous calls can be made by UDEP to the backend system. Beyond that the calls will result in errors being returned to the mobile application with a request to try again later. Enter -1 to impose no limit on connections in this parameter.
AUTHENTICATION_TYPE	None, Basic (for HTTP basic) or OAuth (v1 or v2) and Custom.
OAUTH_PROVIDER	The OAuth provider name (for e.g. Salesforce, Google etc). This property as well as Scope, ClientID and Secret are required only if the Required only if the Authentication type is OAuth v1 or v2.
OAUTH_SCOPE	The scope from a list that the OAuth provider has pre-defined and UDEP is requesting for on behalf of the user
OAUTH_CLIENT_ID	The OAuth ClientID (also called API Key) for the OAuth provider. You will be required to create an application at the OAuth provider and copy over the ClientID from there. Do not share this with any other application.
OAUTH_CLIENT_SECRET	The OAuth ClientSecret for the OAuth provider. You will be required to create an application at the OAuth provider and copy over the Client Secret from there. Do not share this with any other application.
USER_PARAMETER_NAME	If custom authentication type is chosen, the name of the User parameter for UDEP to substitute with the user value. This is automatically added to the HTTP header by UDEP.
PASSWORD_PARAMETER_NAME	If custom authentication type is chosen, the name of the Password parameter for UDEP to substitute with the password value. This is automatically added to the HTTP header by UDEP.
PROXY_HOST	(Optional) If a Proxy is to be used, set the proxy hostname or IP address here.
PROXY_PORT	(Optional) If a Proxy is to be used, set the proxy port here.
PROXY_USER	(Optional) If the Proxy server requires authentication set the proxy user name here.
PROXY_PASSWORD	(Optional) If the Proxy server requires authentication set the proxy password here.

ODATA Service Port

Create this port on a Web Server if Odata Services need to be executed to fulfill the mobile functionality.

The different parameters are:

Property	Details
PROTOCOL	Select http or https based on the remote server protocol.
PORT	Enter the port number on which the remote server is listening for external calls. For example default HTTP port is 80, HTTPS port is 443, alternate HTTP port is 8080 etc
USER	The User ID to be used.
PASSWORD	Set this Password if the USER has been provided.
USE_CLIENT_CREDENTIALS	Use this setting if the mobile users will be entering the User ID and Password for the Backend System on the device (as opposed to entering it at the User level explained in User section). If USE_CLIENT_CREDENTIALS is set to YES, then the device application will prompt the user to enter the system User ID and Password on the device and the device propagates the credentials to UDEP as and when required.
MAX_ASYNC_CONNECTIONS	Use this setting to manage the (additional) load on the backend system due to calls from the mobile application executed in an Asynchronous fashion. (Asynchronous calls are those originating on the device where after successful posting of the request to the server the application does no wait for a result but retrieves it later.) For example if set to 50, at most 50 simultaneous calls can be made by UDEP to the backend system. Beyond that the calls will be automatically queued and executed when the connections are freed up. Enter -1 to impose no limit on connections in this parameter.
ASYNC_CONNECTIONS_TIMEOUT	The timeout (in seconds) while waiting for a connection to be available.
MAX_SYNC_CONNECTIONS	Use this setting to manage the (additional) load on the backend system due to calls from the mobile application executed in a Synchronous fashion. (Synchronous calls are those originating on the device where after successful posting of the request to the server the application waits for an immediate result and does not allow the user to navigate out of the screen) For example if set to 20, at most 20 simultaneous calls can be made by UDEP to the backend system. Beyond that the calls will result in errors being returned to the mobile application with a request to try again later. Enter -1 to impose no limit on connections in this parameter.

LDAP Port

Create this port on LDAP Server for authenticating users.

The different parameters are:

Property	Details
PORT	Enter the port number on which the LDAP server is listening for queries. Default LDAP port is 389.
LDAP_BASE_DN	Enter the LDAP Base Distinguished Name here. Contact your administrator to get these values. For example: DC=unvired,DC=com
AUTHENTICATION_TYPE	The authentication supported by the LDAP server. For example Microsoft Active Directory uses DIGEST-MD5.
USER	The User ID to be used.
PASSWORD	Set this Password if the USER has been provided.

MSSQL (Database) Port

Create this port on a Database Server to connect to a Microsoft SQL server database from the Unvired platform.

The different parameters are:

Property Name	Details
PORT	Port number on the database server to connect to
DATABASE	Name of the database to connect to
INSTANCE	Optional parameter. If the MSSQL server is configured on a named instance, the instance name can be provided here
USER	Optional parameter. User ID to use to connect to the database. All connections to the database will be made with the same credentials.
PASSWORD	Optional parameter. Password to use to connect to the database.
CONNECTION_PARAMETERS	Additional connection parameters that are appended to the connection string. Used for specifying character set UTF-8 etc.
USE_CLIENT_CREDENTIALS	Use this setting if the mobile users will be entering the User ID and Password for the database System on the device (as opposed to entering it at the User level explained in User section). If USE_CLIENT_CREDENTIALS is set to YES, then the device application will prompt the user to enter the system User ID and Password on the device and the device propagates the credentials to UDEP as and when required.
MAX_ASYNC_CONNECTIONS	Use this setting to manage the (additional) load on the backend system due to calls from the mobile application executed in an Asynchronous fashion. (Asynchronous calls are those originating on the device where after successful posting of the request to the server the application does no wait for a result but retrieves it later.) For example if set to 50, at most 50 simultaneous calls can be made by UDEP to the backend system. Beyond that the calls will be automatically queued and executed when the connections are freed up. Enter -1 to impose no limit on connections in this parameter.
ASYNC_CONNECTIONS_TIMEOUT	The timeout (in seconds) while waiting for a connection to be available.
MAX_SYNC_CONNECTIONS	Use this setting to manage the (additional) load on the backend system due to calls from the mobile application executed in a Synchronous fashion. (Synchronous calls are those originating on the device where after successful posting of the request to the server the application waits for an immediate result and does not allow the user to navigate out of the screen) For example if set to 20, at most 20 simultaneous calls can be made by UDEP to the backend system. Beyond that the calls will result in errors being returned to the mobile application with a request to try again later. Enter -1 to impose no limit on connections in this parameter.

Oracle (Database) Port

Create this port on a Database Server to connect to an Oracle server database from the Unvired platform.

The different parameters are:

Property Name	Details
PORT	Port number on the database server to connect to (Listener port)
DATABASE	Service name or the Service identifier (SID) to connect to
USER	Optional parameter. User ID to
use to connect to the database. All connections to the database will be made with the same credentials.
PASSWORD	Optional parameter. Password to use to connect to the database.
USE_CLIENT_CREDENTIALS	Use this setting if the mobile users will be entering the User ID and Password for the database System on the device (as opposed to entering it at the User level explained in User section). If USE_CLIENT_CREDENTIALS is set to YES, then the device application will prompt the user to enter the system User ID and Password on the device and the device propagates the credentials to UDEP as and when required.
MAX_ASYNC_CONNECTIONS	Use this setting to manage the (additional) load on the backend system due to calls from the mobile application executed in an Asynchronous fashion. (Asynchronous calls are those originating on the device where after successful posting of the request to the server the application does no wait for a result but retrieves it later.) For example if set to 50, at most 50 simultaneous calls can be made by UDEP to the backend system. Beyond that the calls will be automatically queued and executed when the connections are freed up. Enter -1 to impose no limit on connections in this parameter.
ASYNC_CONNECTIONS_TIMEOUT	The timeout (in seconds) while waiting for a connection to be available.
MAX_SYNC_CONNECTIONS	Use this setting to manage the (additional) load on the backend system due to calls from the mobile application executed in a Synchronous fashion. (Synchronous calls are those originating on the device where after successful posting of the request to the server the application waits for an immediate result and does not allow the user to navigate out of the screen) For example if set to 20, at most 20 simultaneous calls can be made by UDEP to the backend system. Beyond that the calls will result in errors being returned to the mobile application with a request to try again later. Enter -1 to impose no limit on connections in this parameter.

SAP HANA (Database) Port

Create this port on a Database Server to connect to an SAP HANA database from the Unvired platform.

The different parameters are:

Property Name	Details
PORT	Port number on the database server to connect to (Listener port)
DATABASE	Service name or the Service identifier (SID) to connect to
USER	Optional parameter. User ID to use to connect to the database. All connections to the database will be made with the same credentials.
PASSWORD	Optional parameter. Password to use to connect to the database.
CONNECTION_PARAMETERS	Additional connection parameters that are appended to the connection string.

Note: The parameters configured at the System and Port level for a database server are finally used to make connection strings as indicated below: (Example - to connect to a System called db.unvired.com and Database DEMO, the connection strings depending on the mechanism to connect are)

DB	Using	Connection String made internally by UDEP
Oracle	Service Name	jdbc:oracle:thin:@//db.unvired.com:1527/DEMO
	SID	jdbc:oracle:thin:@//db.unvired.com:1527/SID
MS SQL		jdbc:sqlserver://db.unvired.com:1433;databaseName=DEMO;
	Named instance	jdbc:sqlserver://db.unvired.com:1433;instanceName=INST;databaseName=DEMO;
MySQL		jdbc:mysql://db.unvired.com:3306/DEMO

FTP Port

Create this port on FTP Server for connecting to the FTP server. Only Active mode is supported.

The different parameters are:

Property	Details
PORT	Enter the port number on which the FTP server is listening for connections. Default FTP port is 21.
USER	Optional parameter. User ID to use to connect to the FTP server. All connections to the ftp server will be made with the same credentials.
PASSWORD	Optional parameter. Password to use to connect to the FTP server.
PROXY_TYPE	None, HTTP or SOCKS
PROXY_SERVER	Enter the proxy server if the FTP server can be accessed only via a proxy
PROXY_PORT	Enter the proxy server port if the FTP server can be accessed only via a proxy

Microsoft Active Directory Server Port

Create this port on ADS Server for connecting to the ADS server.

The different parameters are:

Property	Details
PORT	Enter the port number on which the ADS server is listening for queries. Default ADS port is 389.
AUTHENTCATION_TYPE	The authentication supported by the ADS server. For example Microsoft Active Directory uses DIGEST-MD5, Simple etc
BASE_DN	Optional: Enter the ADS Base Distinguished Name here. Contact your administrator to get these values. For example: DC=unvired,DC=com
USER	Optional parameter. User ID to use to bind to the ADS server. All connections to bind to the ADS server will be made with this user but actual authentication will be performed with the user’s credentials.
PASSWORD	Optional parameter. Password to use to bind to the ADS server. All connections to bind to the ADS server will be made with this password but actual authentication will be performed with the user’s password.

Oracle EBusiness Port

Create an Oracle EBS port on EBS Server for connecting to the EBS server.

The different parameters are:

Property	Details
PORT	Enter the listener port number on which the EBS server is listening for external calls.
DATABASE	Service Name or Service identifier (SID)
AUTHENTICATION	Enter the authentication type for the Sharepoint server. This is typically “Windows” authentication (use the Domain user). You can also use “Office 365” if you are connecting to an Office 365 hosted instance of Sharepoint.
USE_CLIENT_CREDENTIALS	Use this setting if the mobile users will be entering the User ID and Password for the Backend System on the device (as opposed to entering it at the User level explained in Usersection). If USE_CLIENT_CREDENTIALS is set to YES, then the device application will prompt the user to enter the system User ID and Password on the device and the device propagates the credentials to UDEP as and when required.

Functions List

Click on the “Functions” tab to configure the various functions in the UDEP landscape. Functions are specific for a Backend System – Port combination. From the dropdown list select the Backend system. The ports on that system are displayed in a second dropdown list. Once the port is selected, an additional dropdown list with a list of applications is displayed. (If Library is selected then list of functions from libraries will be displayed)

• When no application is selected all functions that are not mapped to any application or library are displayed.
• When an application or library is selected only functions of that application or library will be displayed.
• Functions can be edited or new Functions for the selected System - Port may also be added.
• If the server type is Development, an additional column “Enable Test” is displayed for all functions configured on “ME”. Test mode is explained in detail later.

The function details are displayed as above. Functions that are not mapped to an application are shown in red and other functions in black. From this screen you can:

• Create new functions
• Edit or View existing functions

Create Backend Function

Clicking on the “Create” button allows creating a new Backend function for a Backend System – Port combination in the UDEP landscape. Select the name of the system to configure from the dropdown list.

Based on the Backend System chosen, the connected Ports will be displayed and the existing functions will also be displayed.

Sl. No.	Backend System	Backend Port	Functions that can be invoked from the Process Agents.
1.	ME	Java	Allows creating process agent functions that have been uploaded to UDEP. Please refer the Development Guide for more details on Process Agents.
		JavaScript	For later use.
2.	SAP ABAP	RFC	Allows creating functions for any BAPIs or RFCs on an SAP Backend System.
3.	LDAP	LDAP	Create a single function for all calls.
4.	Web	REST	Allows creating functions for any Web URL including REST Services.
		SOAP	Allows creating functions for any SOAP Web Services.
		ODATA	Allows creating functions for any ODATA Services.
5.	Database	MSSQL, MYSQL, ORACLE or SAP HANA	Create a single function for all calls.
6.	FTP Server	FTP	Create a single function for all calls.
7.	Microsoft ADS Server	ADS	Create a single function for all calls

Based on the type of function chosen, a set of parameters as detailed below will be accepted. The different parameters for creating any function are:

Property	Details
NAME	Enter a unique name for the function. Spaces are not allowed, you can use ’–’ or ’_’ to create meaningful names.
DESCRIPTION	Provide a detailed description for the function so you can identify the functionality later.
TYPE	Set this to APPLICATION. SYSTEM is for Unvired use only.
STORE MESSAGE DATA	Setting the STORE MESSAGE DATA property to On will ensure that data for this function will be stored in the Sync or Async message store irrespective of the application level setting. Remember to switch the flag Off when not required. This property is very useful if the need is to store the data of only some functions (for e.g. create sales order) as compared to application level property wherein data for all functions is stored.
OVERRIDE	This property is available only for Application functions. If you want to override the function and provide a new implementation, define an override function in a library, upload it and associate with the application. Then when the dropdown is clicked, the list of override functions are shown and the correct function can be selected. Deselect the function to remove the override.

Note: When creating Library functions, the function type can be chosen as “OVERRIDE” if an application is to be overridden or as “LIBRARY” if additional functionality is being developed.

Java Function

Create a Java function on the UDEP (System ME also called as Self and Java port) that can be executed from the mobile device or via the REST API.

The different parameters are:

Property	Details
PROCESS_AGENT_CLASS	Enter the Java class that will be executed whenever this function is called. Please set this value carefully.
RETURN_TYPE	Mostly all functions that are called will return some data as a result to the mobile device (Return type is String). However there may be special cases wherein the function does not return any data to the mobile device like maybe to execute a taks in the server but is independent of the processing on the mobuile.. In such cases set the return type to Void.
REMOTE_ENABLE	If you require that these functions may also be executed by an external system using the Unvired REST APIs then set the REMOTE_ENABLE flag to YES. If the function is only going to be called by the mobile device leave it at the default value of NO.

Test Mode for Process Agent (Java/JavaScript) Functions

In development servers a special Test Mode is enabled for Java functions. This is useful when your application is under development and the backend functions are not available yet, choose test mode and upload / set the data that you want to return. When the client application makes a call to this function, rather than invoking the process agent function UDEP will return the test data as the output of the function to the mobile application. This permits the development of the mobile and server applications in parallel without any disruptions or dependencies. It is also useful when repetitive tests are to be conducted with the same data or when data creation on the backend system is time consuming.

To enable test mode, select the function and choose Edit. Then Click on Enable Test and then click on the Set Output button.

The output can be proper result data or an error can be simulated. Select “Set Output” or “Set Error” based on what the function should return. The Standard XML / JSON checkbox can be selected if standard Unvired Business XML or JSON data is to be returned and if unchecked any custom XML / JSON format can also be returned.

When output is chosen, the actual XML/JSON data to be returned can be entered in the text box or alternatively a file with the XML/JSON result data can be uploaded. Choose Save to save the settings.

When error is chosen, different types of errors can be simulated. Choose the right option and Save.

Note: After testing, remember to uncheck the “Enable Test” mode so that the real functions can be executed. This is also displayed in the functions list with a tick mark in the test mode to draw attention.

JavaScript Function (Preview)

Preview only, not generally available. Not recommended for production use.

SAP ABAP Function (RFC)

Create an SAP ABAP function on the UDEP (System SAP_ABAP and RFC port) to create a link to an ABAP function that can be executed from other Java process agents. These backend functions provide the business functionality that the process agent needs to execute.

The different parameters are: Property

Details

BAPI_NAME

Enter the name of the BAPI/RFC that will be executed whenever this function is called. Please set this value carefully.

TRANSACTION_HANDLING

There are some RFCs/BAPIs that require an explicit call to BAPI_TRANSACTION_COMMIT or BAPI_TRANSACTION_ROLLBACK based on the success/failure of the RFC/BAPI called. If the RFC/BAPI that you have configured in this function requires this explicit call set the TRANSACTION_HANDLING flag to YES else it can be set to NO.

REST Function

Create a function on the UDEP (System Web Server and REST port) to create a link to a REST API that can be executed from other Java process agents. These functions provide the business functionality that the process agent needs to execute.

Note that only one function needs to be created to make requests to that system/port. There are also no additional configurable parameters for a REST function that needs to be executed. The Java Process Agent development SDK provides the required methods to execute different functions and HTTP/S verbs via the API itself. This is done to ease the process of URL redirection that some HTTP/S systems also utilize.

OData Function

Create a single function on the UDEP (System Web Server and OData port) to create a link to an OData API that can be executed from other Java process agents. These functions provide the business functionality that the process agent needs to execute.

Note that only one function needs to be created to make requests to that system/port. There are also no additional configurable parameters for an OData function that needs to be executed. The Java Process Agent development SDK provides the required methods to execute different functions and HTTP/S verbs via the API itself. This is done to ease the process of URL redirection that some HTTP/S systems also utilize.

SOAP Function

Create a SOAP function on the UDEP (System Web Server and SOAP port) to create a link to a REST API that can be executed from other Java process agents. These functions provide the business functionality that the process agent needs to execute.

Note: The WSDL for the functions you are configuring is required, please keep that handy.

The different parameters are:

Property	Details
SERVICE	Enter the Service name, this is the value of the Name attribute of the Service tag in the WSDL.
SERVICE_EN	Enter the Service name endpoint, this is the value of the Location attribute of the Service tag in the WSDL. Remember to remove the URL (including port if any) from the location tag before setting this value as the Protocol, URL and port are already configured at the System and Port level.
PORT_NAME	Enter the port name for the Web Service, this is the value of the Name attribute of the PortType tag from the WSDL.
END_POINT	The name of the Web Service function to call, this is the value of the Name attribute of the Operation tag in the WSDL.
USE_SOAP_ACTION	Set to YES if a Soap action is to be included else NO.
SOAP_ACTION	Optional value. If a Soap action has been defined for the Web Service being configured, set the value here.

LDAP Function

Note

Create a single function for all LDAP queries.

There are no configurable functions or parameters here.

Database Function

Create a function on the UDEP (System Database and MYSQL, MSSQL, ORACLE or HANA port) to create a link to a database query or stored procedure that can be executed from other Java process agents. These functions provide the business functionality that the process agent needs to execute.

Note

You need to create only one function to connect to a specific database.

There are no configurable parameters for a database function that needs to be executed. The Unvired Java Process Agent development SDK provides the required methods to execute different functions via the API itself. This is done to simplify the configuration and avoiding creating functions to access each stored procedure or query.

FTP Function

Note

Create a single function for all FTP commands.

There are no configurable functions or parameters here. The Unvired Java Process Agent development SDK provides the required methods to execute different functions via the API itself. This is done to simplify the configuration and avoiding creating functions to access each FTP command.

ADS Function

Note

Create a single function for all ADS queries.

There are no configurable functions or parameters here. The Unvired Java Process Agent development SDK provides the required methods to execute different functions via the API itself. This is done to simplify the configuration and avoiding creating functions to access each LDAP query.

Manage Frontends (Devices)

Frontends List

The “Frontends” menu option in the navigation tree displays all the Frontends (device types) that have been created in the UDEP landscape.

The frontend details are displayed as above. From this screen you can:

• Create new frontends
• Edit or View existing frontends

Note: The Test Adapter Frontend is reserved only for Unvired Internal use.

iPhone & iPad

The frontend for iPhone/iPad provides for data push via APNS (Apple Push Notification) to iPhones/iPads (for iPod Touch use iPhone adapter).

The different parameters are:

Property	Details
APNS_GATEWAY	The APNS gateway to use PRODUCTION or SANDBOX. If the application is still under development / testing you will need to use SANDBOX for testing the application. For all applications available on the AppStore set it to PRODUCTION.
FID_IDENTIFIER	The tag to use to identify the communicating iPhone. This value can be configured to UUID (iPhone Unique ID), IMEI (iPhone IMEI number) or CUSTOM. While the UUID and IMEI code will be automatically sent when the device is communicating, the CUSTOM tag will identify the device using the value configured for that front end user in User Management explained in the User configuration section. Note that UUID is not accessible on AppStore applications but possible to be configured for enterprise apps that are installed with Apple Enterprise customer keys.
DATA_PUSH_NOTIFICATION_INTERVAL	If 0, async data notifications will always be sent. If interval is a non zero value, if a notification has already been sent and the device has not consumed it another notification will only be sent after the expiry of DATA_PUSH_NOTIFICATION_INTERVAL seconds
PROXY_HOST	Set Proxy Host if APNS has to be accessed via a proxy (optional)
PROXY_PORT	Set Proxy server Port if Proxy Host specified (optional)
PROXY_USER	Proxy server user (optional)
PROXY_PASSWORD	Proxy server password (optional)

Android Phone& Tablet

The frontend for Android provides for data push via FCM (Firebase Cloud Messaging) to phones and tablets running the Android operating system. Unlike iOS devices, Android devices don’t need to be differentiated and a single frontend can handle both phones and tablets.

The different parameters are:

Property	Details
FID_IDENTIFIER	The tag to use to identify the communicating Android device. This value can be configured to ANDROID_ID (Android Unique ID), IMEI (IMEI number) or CUSTOM. While the ANDROID_ID and IMEI code will be automatically sent when the device is communicating, the CUSTOM tag will identify the device using the value configured for that front end user in User Management explained in the User configuration section.
DATA_PUSH_NOTIFICATION_INTERVAL	If 0, async data notifications will always be sent. If interval is a non zero value, if a notification has already been sent and the device has not consumed it another notification will only be sent after the expiry of DATA_PUSH_NOTIFICATION_INTERVAL seconds

Windows Mobile (Legacy)

The frontend for Windows Mobile provides for sending data to ruggedized and other smart devices running Windows Mobile. Note that data will be held on the UDEP server as there are no notification mechanisms supported by Windows Mobile, the device will need to request the server for data.

No configurable parameters.

Windows 8 / Windows 10 Tablets

The frontend for Windows 8 / Windows 10 provides for data push to Windows Tablets using the Windows Notification Service or WNS for Store Apps.

The different parameters are:

Property	Details
FID_IDENTIFIER	The tag to use to identify the communicating Windows device. This value can be configured to UNIQUE_ID (WP Unique ID), IMEI (IMEI number) or CUSTOM. While the UNIQUE_ID and IMEI code will be automatically sent when the device is communicating, the CUSTOM tag will identify the device using the value configured for that front end user in User Management explained in the User configuration section.
DATA_PUSH_NOTIFICATION_INTERVAL	If 0, async data notifications will always be sent. If interval is a non zero value, if a notification has already been sent and the device has not consumed it another notification will only be sent after the expiry of DATA_PUSH_NOTIFICATION_INTERVAL seconds

Browser Push

The frontend for client web applications developed with the Unvired REST API. UDEP supports asynchronous browser push based on Server Side Events (SSE).

The different parameters are:

Property	Details
BROWSER_RETRY_TIMEOUT	The time interval in seconds before the browser retries a connection to the Server Side Event (SSE) URL

Server (Machine To Machine) Communication (External systems, IoT etc)

The frontend for web server based flows developed with the Unvired REST API. UDEP supports HTTP endpoint push notifications for this.

The different parameters are:

Property	Details
PROTOCOL	HTTP or HTTPS of the external web endpoint to notify
SERVER_URL	The URL of the external web endpoint to notify. For e.g. extnotif:8080/endpoint. UDEP will write post data to the URL as explained below.
REST_API_LIMIT	For later use

The External URL will receive the following HTTP (request) post parameters at the above-defined endpoint:

Post Parameter	Details
UMP_SERVER_ID	The server ID of the UDEP server initiating the push. Can be used to determine which UDEP server is sending the notification when there are multiple servers in the landscape. (For e.g. Development, Quality or Production)
APPLICATION_NAME	The name of the application initiating the push (For e.g. UNVIRED_SAP_CRM)
CONVERSATION_ID	The Conversation ID of the message that is now processed and available for download. If the server has saved the Conversation ID returned from the Execute REST API it can be used to identify, else use the next parameter EXTERNAL_REFERENCE
EXTERNAL_REFERENCE	The external reference string that was posted to the REST API execute method. This can be used to identify the push notification message uniquely without using the UDEP defined CONVERSATION_ID above.
MESSAGE_COUNT	The total number of messages awaiting delivery

Manage Users

Users List

The “Users” menu option in the navigation tree displays all the users that have been created in the UDEP system.

From this screen you can:

• Search for users by Frontend Type (frontend, user type or user status), Unvired Users, Frontend Users or Federation ID (ADS user, SAP user or LDAP user)
• Add and edit users
• Reset the password for a user
• Enable or Disable a user
• Display the Authentication Keys for all users, Regenerate for a user
• Send notification to a user
• Upload a CSV file to create users in bulk
• Download users in CSV that can be imported into any other UDEP system

Pro Tip

Hovering the mouse over the number of users in the tabular column will provide a quick view of the frontend, backend and federation users as shown below.

Create Unvired User

The Unvired user is the core identity for any user to interact with the Unvired platform. Every user needs to have an Unvired user created. Every device that the user wants to connect to the Unvired platform requires an associated front end user and every backend system that the user wants to connect to will require a backend user.

The first step in Unvired identity management is to create an Unvired user or Master user. Click on the “Add” button to create a new Unvired user.

The different parameters are:

Property	Details
User Name	Entered the desired user name (no spaces allowed).
First Name, Last Name	Enter the First and Last name of the user.
Email	Enter the primary email id. All notifications to the user will be sent to the primary email id.
Alternate Email	Optional value. Enter the alternate email id here
User type	As explained in the User section above, there are multiple user types that are supported. Choose the correct type for the user.
User’s Language	Optional value. Enter the user’s desired language. If not set the main language for the company that the user belongs to will be used. All system messages that are sent to the mobile application will be sent in the configured language.
User’s Time Zone	Optional Value. Select the user’s time zone if required. The timezone is used while scheduling any functions to fetch and push data to the user. By default the company’s time zone is used but if you need to override for specific users it can be done by setting it here.
Password	The password policy that has been configured by the administrator is displayed at the bottom of the screen. Set a password that conforms to the policy and retype / confirm it.

Create Frontend User

In order to add frontend user for an Unvired user currently being created click on the Frontend user tab in the creation screen.

To add a frontend user for an existing Unvired user, select the Unvired user to add a frontend user for and choose “Edit” and select the “Frontend User” tab. You can now Add new frontend user and edit or delete existing frontend users.

While adding a new frontend user the different parameters are:

Property	Details
Select Frontend	Choose the frontend for which a frontend user is to be created.
Frontend user name	Enter the frontend user name. This is determined by the setting at the frontend adapter. For e.g if the configured property is Custom, you can type any unique identifier or for IMEI enter the IMEI number here etc.

For each device that the user wants to use on the landscape a frontend user needs to be created. The Unvired license counts total number of front end users only for active users.

Create Federation ID

The Unvired platform allows the users on the device to login to the application using their Unvired User (default) or alternatively they can use their Microsoft Active Directory credentials (SAML SSO) or SAP Login credentials.

Federation IDs need to be unique in the system and can occur only once (in other words can be mapped to only one Unvired user). Each application for that Unvired user can have a different Federation ID or alternatively all applications can have the same Federation Id. For example, the user can have a different Federation ID to login into the CRM application and a different Federation ID to login into the Purchase Order approval application.

In order to add Federation ID for an Unvired user currently being created click on the Backend user tab in the creation screen. To add a Federation ID for an existing Unvired user, select the Unvired user to add a Federation ID for and choose “Edit” and select the “Federation ID” tab. You can now Add new Federation ID and edit or delete existing Federation IDs.

Federation IDs are optional as they are required only if users will not use their Unvired ID to login to the application.

Note

The actual login mechanism for an application is configured in the Application Properties explained later. If auto provisioning is enabled along with SAML SSO then the federation user is automatically added.

While adding a new Federation ID, the different parameters are:

Property	Details
Application	The application for which the Federation ID is being configured. Different applications can have different Federation IDs. If all applications will use a common Federation ID (for e.g. MS ADS login) select the application as “ALL”.
Federation ID	Enter the Federation ID to use. This Federation ID has to be unique and cannot repeat in the system. However for the same user, the Federation ID can repeat across different applications.

API Tokens

API tokens can be generated for Application Users that include only a Server front end user. This is useful when other systems communicate with UDEP and can be provided API Tokens with a specified expiry and specific access so that they are secure.

API Tokens are generated for the Server user(s) for a specific application and for a specified period. Once the token is created, access to the required functions of that application is configured. Additional functions can be added or existing ones removed whenever required. The API token is valid for the specified period and can either be revoked or extended based on need.

Such API tokens can be used as authentication tokens for the REST API by passing them via a header parameter called apiToken.

Bulk Upload Users

When a number of users need to be created on the Unvired platform, rather than creating them individually it is easier to enter all the desired user information in an Excel sheet and upload to the Admin Cockpit. The format of the Excel sheet is:

Column Name	Details
unvired_user	The desired Unvired user (or master user)
first_name	The First name of the user
Last_name	The Last name of the user
user_type	The desired user type as explained earlier, typically APPLICATION.
password	The desired password (the password needs to satisfy the configured password policy as explained in the System configuration section)
enable	Is the user enabled (1) or disabled (0)?
email	The user’s email id
email-alt	The user’s alternate email id
number_frontend	The number of frontends that this user is to be connected to, typically 1 (more if the users have larger number of devices)
frontend_system_1	The first frontend system for this user. Based on the number_frontend property the import functionality will cycle through and pick up the values for frontend_system_1 to frontend_system_n. The frontend needs to be already existing in the system.
frontend_user_1	The first frontend user. Based on the number_frontend property the import functionality will cycle through and pick up the values for frontend_user_1 to frontend_user_n.
number_backend	The number of backend systems that this user is to be connected to, can be 0 or more.
backend_port_1	The first backend port for this user. Based on the number_backend property the import functionality will cycle through and pick up the values for backend_port_1 to backend_port_n. The backend port needs to be already existing.
backend_user_1	The first backend user. Based on the number_backend property the import functionality will cycle through and pick up the values for backend_user_1 to backend_user_n.
backend_password_1	The first backend user’s password. Based on the number_backend property the import functionality will cycle through and pick up the values for backend_password_1 to backend_password_n.
netweaver_flag_1	If the Unvired platform has been deployed on NetWeaver this flag indicates if a NetWeaver user also has to be created for that user to enable Single Sign On (more details).
number_federation	The number of federation IDs for this user. Based on the number_federation property the import functionality will cycle through and pick up the values for federation_id_1 to federation_id_n.
app_name_1	The first application for mapping the federation_id for the user.
federation_id_1	The first Federation ID for mapping to the app_name_1.
number_deployment	The number of applications to deploy for the user
deploy_app_1	The name of the application to deploy as configured in the admin cockpit
deploy_frontend_user_1	The front end user to deploy the application. The application will be deployed only If the application is available for that frontend.
number_group	The number of groups to add the unvired user to
group_name_1	The name of the group to which the unvired user must be added to. If the group is not existing the group is created.

Note

All columns that have a xxxx_1 column name are interpreted as below (for e.g. with deployment) - number_deployment = 2 means the import will expect deploy_frontend_user_1 and deploy_frontend_user_2

Once the Excel file has been prepared, click on the “Upload” button and execute for all the users to be created. Contact the Unvired support for a template for the above Excel sheet.

Note

You can login to the Unvired Customer Download Portal and download the latest Excel template.

Groups

After clicking on “Users” menu option in the navigation tree, select the “Groups” tab to display all the groups created in the system and to add or edit groups.

Groups in the Unvired platform can be used to setup periodic data refresh from backend systems. This is explained in the Schedulers section later. In addition groups can also be used to deploy applications to all users belonging to a group.

The Unvired REST API also allows push of data and messages to a Group.

While adding a new group the different parameters are:

Property	Details
Group Name	Enter the group name desired, spaces are not allowed.
Description	Enter the group description.

Choose “Next” arrow to move forward in the wizard. In the next step the users belonging to this group can be selected. Note that search can be based on frontend users or master users. Irrespective of which criteria is used, only master users can belong to a group. Users from multiple frontends can be added to a common group or in other words users with different device types can all be added to a same group. Such a grouping allows to also logical select groups based on roles for example a group for all purchasing managers can be created and users assigned.

Property	Details
Select Frontend	Select the frontend whose users are to be added to the group.
Select Users	List of users from the selected frontend are displayed. All users with a Green status icon are available to be added to the group.

Select all users to be added to the and click on the “Next” arrow button, then click on the “Save” button in the confirmation screen to create the group.

Summary

After clicking on “Users” menu option in the navigation tree, select the “Summary” tab to display a summary of users created in the UDEP landscape including the total number of devices (frontend users) created. This summary helps in tracking the number of devices provisioned for eg. to compare with number of licensed devices.

Manage Applications

Applications List

The “Applications” menu option in the navigation tree displays all the applications that have been configured in the Unvired platform.

The application details are displayed as above. From this screen you can:

• Add, Edit, Delete and Ciew applications and librariesPurchase and use Marketplace Apps
• Configure the Process Agent settings (Developer defined, Custom settings on a per-application or per user-application basis)
• Upload the Process Agent binaries for the application. Note if mouse hover over the green tick mark the uploaded process agent information is displayed.
• Bulk deploy the application
• Group deploy the application
• Define administrators for the application
• Configure the Application Properties (UDEP defined, Standard properties on a per-application basis)

Pro Tip

Use the mouse to “hover” over the process agent icon or the count of devices / activated to get a quick overview.

Create Application

Creating an application follows a set of well-defined steps and the web interface provides a wizard to accomplish this. Enter the application details.

Property	Details
Description	Enter the desired application description to describe the application.
Name	Enter the desired application name (no spaces allowed). Please note that this should be a unique name on the Unvired platform.
Vendor	Enter a short name to identify the creator of the application.
Version	Enter the version of the created application. This version number is reserved for later use and is not to be confused with versions of the application binaries that exist on the mobile device or the Unvired platform.

Choose the “Next” arrow button. Select each of the frontends (devices) on which this application will be available from the drop down and click the ”+” button. Based on the type of frontend chosen further data in terms of push configuration will need to be provided. This data is summarized in the table below.

Sl	Frontend	Additional parameters
1.	iPhone and iPad	APNS registration certificate needs to be uploaded along with the password. This is required to enable the Apple Push Notification Service.
2.	Android phone and tablet
Google Server API key and Sender ID need to be entered here. This is required to enable the Google Cloud Messaging.
3.	Windows 8 / 10	No configuration
4.	Machine to Machine	No configuration
5.	Browser	No configuration

Choose the “Next” arrow button. Now the different functions that make up this application need to be selected. Click on the ”+” button to search and select backend functions which are already configured (see section on Backend functions described elsewhere in this document). Please note that only those functions that are a part of this application can be executed by the mobile application or the process agent on the Unvired platform. Select the various functions that comprise this application and click the “Save” button. If no functions have been defined, you can skip this step for now.

Once the function is selected, the following additional parameters can be configured.

Sl	Function Properties	Description
1.	Initial Download	If checked, this function is included in the list of initial download functions. Whenever an “Initial Download” request is sent from the mobile applications, all functions marked as Initial download will be executed and the data sent to the mobile application.
2.	Delete Data	If checked, whenever data is returned from this function the mobile application will delete all existing data (saved from the previous run) and insert the new data. If the data on the mobile application is to be retained, leave this option unchecked.
3.	SSO	If SSO is ticked, SAP NetWeaver SSO ticket is used to execute the function. This is valid only for SAP ABAP functions.
The summary is now displayed for the new application. Choose Save to create the new application.

Note: On Save, the Application Properties window will be shown. Please configure all properties as explained in the Application Properties section.

Note: If using the Unvired Modeler to create the application, the application configuration on UDEP can be done automatically from the tool and manual creation as described above is not required.

Edit Application

Select the desired application and choose the Edit button. This will allow adding new frontends (devices) that are now supported, remove frontends that are not supported anymore, change push settings, add additional functions to the application or remove functions that are not needed anymore.

Mobile Application Deployment

For Android, iOS (Inhouse Apps only) and Windows Mobile devices (that support custom installation routines) the client applications can be uploaded and maintained on the Unvired platform. Mobile users can update to the new applications from within the application itself via push notifications.

The applications that need to be deployed over the air (OTA) can be maintained on the Unvired platform by selecting the device and clicking on the “Upload Application” button. You can upload one application file depending on the type of device and these files will be available for download by the end users. Additionally a history of all apps is maintained so you can revert to older versions whenever required.

UDEP Enterprise Store

For mobile applications that are uploaded into the UDEP Admin Cockpit for deployment, to help users “discover” or “find” these applications, an Enterprise AppStore is built into UDEP.

The enterprise Store is accessible via the URL like https://UDEP_Server:Port/UDEP/store/. The list of applications, screenshots and description are displayed. The user should access the store via their mobile device. Clicking on the required application will allow installation of the application on the mobile device directly.

In order to display the store information, the administrator has to click on the Store menu item (as shown above) and provide the following information.

Sl.	Property	Description
1.	Display Name	The name to be displayed in the Store for this application. Keep this brief and easily recognizable.
2.	Description	The detailed description about the application to be displayed. Enter as much detail as required here.
3.	Listing Image	The icon / image to display in the main listing page and the details page. The recommended size is 120x120.
4.	Screenshots	Upload as many screenshots as required to showcase the application. The recommended size is 500x500.

The Enterprise App Store can be setup with authentication or open. Typically if the UDEP is accessible only with the corporate network or via VPN the App Store can be open, if accessible over the Internet then its secure to configure it as authenticated.

Delete Application

An application that is not required any longer can be deleted if necessary. Please remember that only applications that are not deployed to any active user can be deleted. Also the application should not have any mapped functions. Before deleting any application please Un-deploy the application for all users by following the Un-deploy section later in the document and also remove any mapped functions by editing the application.

Process Agent Settings

Every Unvired application can have configuration settings saved as key-value pairs. These settings can be for an application or for each user of an application. The application settings can be used to save configuration / customization information for the process agent like total number of records to return, backend object reference codes etc.

In addition, the users’ settings for an application can save configurations like the users region, users’ favorite customers etc. Application and user settings thus allow the process agent to store contextual information and provide relevant information to the mobile application.

On clicking the “Application Settings” button a list is displayed. The list of process agent / application settings already configured is displayed. You can add new settings or edit / delete existing settings after selecting the row. Unvired also allows for saving sensitive configuration data. To achieve this choose the “Secure Property” option while adding settings as shown below. Such settings that are configured as “Secure” are not displayed in the Admin Cockpit and can only be edited or deleted. These settings are available ONLY to the process agent application on the UDEP.

Mobile Application Settings

The list of mobile application settings already configured is displayed. You can add new settings or edit / delete existing settings after selecting the row. Unvired also allows saving sensitive configuration data. To achieve this choose the “Secure Property” option while adding a settings as shown below. Such settings that are configured as “Secure” are not displayed in the Admin Cockpit and can only be edited or deleted. These settings are available ONLY to the mobile application. For e.g. if an application wants to control the timeout in connections it can be configured here and UDEP will automatically make it available on the device and the mobile application can then set the preconfigured timeout without user intervention.

Note

Only those settings that are for an application (not meant for a specific user or those that cannot be personalized) are configured here.

Mobile User Settings Template

The list of mobile user settings already configured is displayed. You can add new settings or edit / delete existing settings after selecting the row. Unvired also allows saving sensitive configuration data. To achieve this choose the “Secure Property” option while adding a settings as shown below. Such settings that are configured as “Secure” are not displayed in the Admin Cockpit and can only be edited or deleted. These settings are available ONLY to the mobile application and for personalization by the mobile users.

All the template settings that are configured here are sent to the device so that every user is allowed to set them according to their preferences. These settings persist across sessions. For e.g. the user can be sent a default Theme from the server as configured by the administrator. When the user changes the theme in the application, the theme can be saved back to UDEP so that if the application is reinstalled (for e.g.) the user’s theme can be restored.

In order to ensure that your users can understand these settings use correct descriptions. Each template setting comprises the following:

Property	Details	Description
Key Name	Used by the process agent to retrieve/set the configuration value	The name to be displayed in the Store for this application. Keep this brief and easily recognizable.
Description	Used on the mobile application for the user to identify the configuration	The detailed description about the application to be displayed. Enter as much detail as required here.
Default value	Prefilled on the mobile application as default value	The icon / image to display in the main listing page and the details page. The recommended size is 120x120.
Mandatory	Indicates if the property is to be mandatorily filled by the user	Upload as many screenshots as required to showcase the application. The recommended size is 500x500.
Secure property	Sensitive data, not displayed in the Admin Cockpit

Upload Process Agent

The logic that an application comprises in the Unvired platform is a set of Java (or JavaScript) functions called as a “Process Agent”. In technical terms, the jar file (or zip file with JS files) that is generated/developed can also be referred to as the process agent. Please use the Unvired Development guide and the Unvired Modeller to generate the required process agent and customize it. Once the process agent has been debugged, fixed and tested you can choose the “Upload Process Agent” button to upload the process agent. For security you can additionally obfuscate the jar file if required.

A list of process agents and supporting jar files associated with the application are displayed. You can upload new process agents and jar files that are not present or delete and re-upload existing process agents and jar files. Note: Since the already uploaded process agent may already be executing, it is recommended that on production servers the upload is done during “off” hours. On update/deletion the classes are unloaded from memory and the jar is also overwritten/deleted. This allows a “hot deployment” of process agents without any down time.

Click on the ”+” button to upload a new file. Enter a comment to describe the main changes in the process agent. Drag and drop the file and then click on the “Upload” button. All uploaded process agents and related jar files are displayed. The version number displayed is as set in the MANIFEST.MF file that is part of the process agent jar file.

Note: While updating a process agent jar file please remember to also update the version number in the MANIFEST.MF file. This will help trouble shoot later as it helps identify which version of the process agent is currently uploaded to the server. Also the mobile data model from the metadata.xml file and the date / time of file upload is displayed.

The Revisions button displays the revisions that have been made to the process agent and allows the administrator to know the “history” of the revisions.

Selecting an earlier revision or a deleted process agent enables an option to “Revert” to that revision easily.

Libraries

Clicking on the Libraries option lists all the libraries that are deployed with the application or new libraries that are available to be deployed. Libraries are explained in more detail in an earlier section.

Library available for deployment and those already deployed can be viewed separately. Library Edit screen displays the functions and linkage.

Bulk Deploy and Undeploy

Every Unvired application that is to be used by an Unvired user on the mobile device needs to be first “Deployed” to the user. Please note that deployment is a separate step from the actual installation or deployment on the mobile device. Usually anybody can install an application on their device. However only those users for whom the application has been deployed will be able to login and use the applications.

Applications can be deployed for each user as explained in the deployment section or in bulk. The bulk deployment is a time saver option to deploy the application to multiple frontend users at the same time. Clicking on the “Bulk deploy” button displays a wizard wherein the frontend for which the application needs to be deployed is selected.

Now the users belonging to that frontend are displayed. You can deploy for all users or selected users. The options are available in the Selection Menu. Once the required users are selected click on the Deploy button and confirm the deployment. The deployment is completed and you can now close the window or continue with deploying more users on other frontends etc.

Un-deployment of applications (for those users who should not be able to access the applications any more) can also be performed similarly with the “Bulk Undeploy” option.

Group Deploy

Unvired applications are many times built to fulfill functionality that is meant for specific people in specific roles, for example flow approval is for all managers. Rather than bulk deployment, it may be more appropriate to deploy based on roles or groups.

After clicking the “Group Deploy” button, select the group that has already been created as explained in the group configuration section and click the “Next” button.

You now have the option to deploy to all users in the group by clicking on the “Deploy All” button or to deploy to selected users within the group.

Application Properties

UDEP also mandates that each application has a set of properties. These properties are predefined and need to be set by the administrator for each application. Note that unlike Process Agent Settings, these properties can only be set by the administrator and cannot be changed or deleted.

Sl	Application Property	Description
1.	DATA_FORMAT	Data format to support for the application. XML or JSON can be chosen.
2.	COMPRESS_POST_DATA	Mandates the UDEP device framework to GZIP upload data also (by default all downloads and attachments are compressed). If a lot of data is being uploaded form the application, set this option to YES.
3.	STORE_MESSAGE_DATA	Indicates if the message data is stored after it has been delivered to the device or needs to be cleared out. Typically in production systems this is set to No and in development/quality systems set to Yes for trouble shooting.
4.	STORE_MESSAGE_FORMAT	The format to store the message data: TEXT – Stored as plain text (not recommended) COMPRESSED – Data is compressed and stored (recommended option) ENCRYPTED – Data is encrypted and stored COMPRESSED_ENCRYPTED – Data is compressed, encrypted and stored (recommended for sensitive data)
5.	CALL_FLOW	If Enabled, saves the call flow for each function call and can be viewed in the Call Flow button in the Sync/Async monitor.
6.	LOG_LEVEL	Log level ERROR for errors only or INFO for more verbose logging
7.	ALLOW_APPLICATION_ASSIGNMENT	This option is only available to ROOT company (for e.g. UNVIRED) or partner companies selling applications on the UDEP. Set this to YES to allow other companies to purchase and use the application.
8.	ALLOW_APPLICATION_COPY	This option is only available to ROOT company (for e.g. UNVIRED) or partner companies selling applications on the UDEP. Set this to YES to allow other companies to purchase and copy the application to their namespace (source code needs to be provided for the client app and process agent) so that the customers can modify the app to their needs.
9.	PROVISIONING	This can be set to “Administered” wherein the UDEP administrator can deploy or provision applications for users. Set to “AUTO” for automatic provisioning wherein users can self-register on UDEP and use the application.
10.	EMAIL_DOMAIN_ALLOWED	Domains to be allowed has to be specified as a comma separated list. If * is specified all email domains will be allowed and is not recommended. If left empty no email domains will be allowed.
11.	LOGIN_MODULE	Indicates which login mechanism is to be used for verifying user credentials. By default the “UNVIRED-USER” mechanism is used wherein the user needs to enter their Unvired ID on the mobile device to authenticate. Alternatively login can be via Email ID, SAML2 SSO, LDAP or MS ADS user or even SAP user. Developers can also provide a custom authentication mechanism wherein authentication is delegated by UDEP to a process agent function. See the sample Custom Login module in development guide for an example on how to build custom login modules. Note: For SAML2 SSO additional properties as explained in the SAML Single Sign On Advanced Configuration section will need to be configured.
12.	LOGIN_CLASS	Optional: If LOGIN_MODULE is set to Custom, the class implementing the authentication needs to be specified here.
13.	CREATE_USER_PROCESSOR_CLASS	Optional: If your application requires additional configuration that needs to be performed when a new user is created via API, the class implementing the additional steps needs to be specified here.
14.	ATTACHMENT_PROCESSOR_CLASS	Optional: Determines the class implementing the attachment processing for the process agent. One attachment processor per process agent needs to be specified here. If there are no attachments this field can be left empty.
15.	PASSWORD_RESET_EXPIRY	Password reset token validity in seconds. For e.g. to have a token valid for 1 day use 86,400 seconds, minimum is 10 minutes and max of 1 day.
16.	JWT_TOKEN_EXPIRY	Optional: If JWT token authentication is being used (SAML SSO or web applications for e.g.), the expiry of the issued tokens can be specified in seconds. Default is 86400 seconds or 1 day.
17.	JWT_SSO_APPS	Comma separated list of other Apps that need to be trusted via this JWT token.
18.	JWT_CLAIMS_PROCESSOR_CLASS	Optional: Determines the class implementing the JWT token claims processing. This class is required only if additional (custom) claims need to be included into the JWT token. If not specified, only the standard claims will be included.
19.	MOBILE_REDIRECT_URL	Custom redirect URL for the mobile app like unviredapp://. Redirects to this URL will be captured by the mobile app for performing specialised functions like passwordless login etc.
20.	USE_UNVIRED_ID_AS_FEDERATION_ID	If this property is set to YES, UDEP will not look for a separate Federation ID for that user/application but will default the Federation ID to Unvired ID. This also means that the Federation ID need not be maintained in UDEP.
21.	AUTHENTICATE_MOBILE_APP_INSTALL	When set to YES, a login is required for the user to install Apps from the Unvired Enterprise App Store (typically when UDEP is exposed to the Internet or behind a reverse proxy). Set to NO if everyone is allowed to install (typically if UDEP is accessible only within a VPN or Intranet)
22.	ONE_TIME_TOKEN_CHECK	If ENABLED, every request from the device to the UDEP server is further protected with a one-time use token. This also ensures that the same user logs in to the application on a new device (custom front end id) the old device will automatically stop.
23.	LOCAL_PASSWORD	If set to YES (DEFAULT), when the mobile application starts the user will be prompted for the Unvired User ID and Password for local verification/authentication on the device. If set to NO, the mobile application will start without any password prompt. Recommended value is YES.
24.	APP_LOCK_TIMEOUT	Indicates the timeout interval on the device before prompting for password, if set to 0 the device will not lock.
25.	DUPLICATE_CALL_HANDLING	Decides the rule to apply when duplicate calls are received for functions downloading data to the device. Possible options: CALL_ALWAYS - Make a call irrespective of any pending or completed calls of the same function IGNORE_CALL – Ignore the call if any pending or completed calls of the same function exist DISCARD_DATA_AND_CALL – Discard any results for the previous calls (if any) and call again.
26.	ALLOW_UMP_URL_OVERRIDE	Allow to override the UMP URL to connect to with what is entered by the user in the client application instead of using the URL configured in the ME system properties. This is useful in cases where ME is configured with an internal URL but applications need to use an external URL to connect to the server.
27.	VERIFY_MESSAGE_HASH	Optional: Server includes an additional hash with each message that is sent to the client. This can be checked on client before accepting the data. Recommended on slow / intermittent connectivity networks.
28.	LOCATION_TRACKING	Indicates if the location tracking will available for this application from the device. If set to Enabled, the device will automatically capture the location and transmit to the server.
29.	APP_BASED_LOCATION_TRACKING	Indicates if the location tracking will also record the application information along with the location. If the user has two applications on the mobile device enabled for location tracking, two sets of location information will be available on the server.
30.	LOCATION_TRACKING_INTERVAL	Indicates the interval (in seconds) on the mobile between location checks.
31.	LOCATION_UPLOAD_INTERVAL	Indicates the interval (in seconds) on the mobile when location information collected will be transmitted to the server.
32.	LOCATION_TRACKING_DAYS	Indicates the days of week to track location. Options available are MON-FRI, MON-SAT or MON-SUN
33.	LOCATION_TRACKING_START	Indicates the time to start tracking location (24 Hour,HH:MM).
34.	LOCATION_TRACKING_END	Indicates the time to end tracking location (24 Hour, HH:MM).
35.	ATTACHMENT_CONNECTION	Indicates if the attachments should be transmitted over any connectivity or only over WIFI. Possible options are ANY or WIFI.

Marketplace Applications

The standard applications that Unvired has made available or any other applications that need to be used within the company but needs to be segregated by country or sub division etc. can be achieved by setting applications to template applications via the ALLOW_ASSIGNMENT or ALLOW_COPY application properties. Such applications will appear in the Marketplace Applications list and can be purchased and used as is or copied and customized to specific needs.

For e.g. in the above screen three applications provided by Unvired can be used by the other companies.

Deployment and other tasks

Click on the “Applications” menu option in the navigation tree and then the “Deployment” tab to deploy any of the applications that have been configured in the Unvired platform to mobile users. You have a choice of deploying based on Application Name (used if an application has to be deployed for selected users) or to deploy based on Frontend user or Unvired user (used if multiple applications have to be deployed for the same user).

The legend below the criteria shows how many users are Not-deployed, Deployed, Activated or in Error deployment for the chosen criteria.

Once the application and the frontend have been selected, select the deployment status for more fine-grained control so that it’s easy to select the users to either deploy or un-deploy. Click on the “Search” button and a list of frontend users for whom various operations for the selected application and deployment status can be executed is now displayed.

The different tasks are displayed in the dropdown list and each task is explained in detail below.

Ping

Test if the device is online currently by sending a Ping request from the server. The client will respond with a ping back when it receives it.

Deploy

The application is deployed for use by the selected frontend user. Only users for whom the application has been deployed will be able to download the application and login to use the functionality.

Un-deploy

The application is un-deployed for the selected frontend user. The user for whom the application has been un-deployed will not be able to use the application any longer. Un-deployment is immediate. Even if a user is currently logged in and using the application on the mobile device, after un-deployment the user will not be permitted to use the application and an appropriate message is displayed to the user.

Wipe

When a “Wipe” message is sent to the device, all the data (application and Unvired related) is deleted on the device and the application cannot be used unless the user is authenticated and activated again. A wipe message is useful when both the application and the Unvired system database are corrupted on the device and the application is not usable. The administrator can queue the wipe request for an unattended recovery on the device. It is also useful when user has left the organization and not returned the device or if a device is lost.

Request Log

When a “Request Log” message is sent to the device, all the device logs that are available on the device are immediately sent to the Unvired server. The log information helps the administrator and the developer to troubleshoot any errors in the application without user intervention. These logs can be seen in the “Device Logs and Data” option as explained in the device logs section later.

Request Data Export

When a “Request Data Export” message is sent to the device, all the application data on the device is exported to text form and immediately sent to the server. The exported data helps the administrator and the developer to troubleshoot any errors in the application without user intervention. This data can be seen in the “Device Logs and Data” option as explained in the device data section later.

Erase Log

When an “Erase Log” message is sent to the device, all the device logs that are available on the device are immediately erased. This can be used to remotely clear out logs and then after the error scenario is recreated the logs may be requested again (to avoid cluttered logs).

Log Level (Error or Debug)