Cloud Inventory® Documentation

About system settings

System settings are global parameters that affect your entire Mobile Enterprise Platform solution.

General

The General tab enables you to define the default language, force activity logging to disk, and encrypt device databases for your Mobile Enterprise Platform system.

Email

The Email tab allows you to define the email account and server from which the system sends emails. The settings you specify are used for the Send Email source element, the user registration welcome email, password recovery emails, and AIM server error messages. The system does not verify the validity of these settings.

Email for on-premise customers

You must define email settings to allow the system to send emails.

After these settings are defined, email addresses can be assigned in event handling and error handling to communicate system activity messages.

Email for cloud customers

Beginning in Cloud Inventory® Platform 9.0 SP11, you can override some email settings for cloud implementations of Cloud Inventory® Platform. This allows you to define a connection to your company's SMTP compatible email server, if your email server is available externally. Previously, this tab was only available for on-premise implementations. If you do not configure these settings on a cloud implementation, the system will use the default email settings.

For example, your company uses the Send Email source element in an app to notify a customer that their delivery is on the way. If you keep the default email settings, the email is sent from Cloud Inventory® Platform. If you specify your company's email server, the email is sent from your company.

For cloud implementations of Cloud Inventory® Platform, the error and event handling features use the default email settings.

Device Location

The Device Location tab provides options to define the location polling interval, location reporting interval, and Google API Key for your Mobile Enterprise Platform system.

Mobile Client Deployment

The Mobile Client Deployment tab provides the ability to pre-configure Mobile Client settings, particularly communication settings, for new Mobile Client users to quickly and easily incorporate into a new Mobile Client implementation.

Note:Nextworld users without access to a specific warehouse zone do not see the zone on the mobile client. Users without access who try to access the warehouse zone receive an error message explaining the access limitation.

Device Testing

The Device Testing tab enables communication between Mobile Enterprise Platform and an app testing service for use when you are packaging an app for the Apple App Store or Google Play Store. Currently, Mobile Enterprise Platform supports the Amazon Web Services (AWS) Device Farm for testing. You acquire the Access Key and Secret Key when you set up an AWS Device Farm account.

Analytics

The Analytics tab shows defined settings for the Analytics tool. This tab is only active if your Mobile Enterprise Platform instance is licensed for Analytics. Settings displayed here are: Base URL, Site name, Workbook, and Dashboard.

Platform Metrics

The Platform Metrics tab on the System Settings page shows defined settings for the Analytics tool. This tab is only active if your Mobile Enterprise Platform instance is licensed for Platform Metrics. Settings available here are: Send Metrics frequency, Allow user to opt out of Platform Metrics, and Metrics categories.

Storage

Beginning in 9.0 SP4, Advanced Inventory Cloud customers can add support for cloud storage to a registered instance. This allows you to store files in the cloud without a Advanced Inventory Cloud Connect Gateway. An AWS S3 bucket can be provided upon request as part of your Advanced Inventory Cloud solution. A user can capture a signature image, photo, or other file, and then store that file in the AWS S3 bucket. The stored file can then be attached to a data record in in your ERP system. You can select destinations for files and signatures. The Storage tab is only enabled if AWS S3 settings have been entered for a registered instance, or if gateways have been registered. Settings available on this tab include: File drop location, Signature drop location, and File Retention.

Chatbot

Beginning in 9.0 SP6, you can register any chatbots associated with your Amazon Lex account, and then add them to an app in Application Studio. Before you can register a chatbot, you must create an Amazon Cognito Identity Pool that has access to Amazon Lex. The Chatbot tab on the System Settings page allows you to specify the Identity Pool ID and region that the system uses to register chatbots.

Privacy

Beginning in 9.0 SP5, you can define a privacy statement to outline the data you will gather about users in Mobile Client and Advanced Inventory Platform Manager. This privacy statement enables your organization to meet GDPR requirements. Additionally, you can set a different privacy statement in each supported language.

This statement displays the first time a user logs in to Mobile Client or Platform Manager after their account is created, or the first time they log in after "Personal data privacy terms accepted" is deselected on their user profile.

All users must accept the privacy statement before they are able to log in. After a user accepts the privacy statement, the message only displays again if you edit the statement, or if "Personal data privacy terms accepted" is manually deselected on the user's profile profile. You may only edit the Customer Privacy Statement, you may not edit the Advanced Inventory Privacy Statement.

Define system settings

System settings are global parameters that affect your entire Mobile Enterprise Platform instance. These settings can be defined when setting up the system, or editing system operations.

To define system settings, complete the following procedures in Platform Manager.

Define general system settings

The General settings let you define the default language, force activity logging to disk, and encrypt device databases for your Mobile Enterprise Platform system. These settings affect your entire Mobile Enterprise Platform instance. They can be defined when setting up the system, or editing system operations.

To define general system settings, complete the following steps in Platform Manager.

Go to Admin > Configuration > System Settings > General.
For Language, select the default language to be assigned to new user profiles.

Step Information

Note:You can specify a different language for an individual user in that user's profile.
To force the system to write all errors, alerts, and events to an activity log, select Force activity logging to disk.
To enable an Agent Confirmation prompt when you start and stop agents in System Monitor, select Show agent confirmation prompt.
For Maximum number of rows for Data Viewer, enter the maximum number of table rows you want to display in the Registered Table Data Viewer.

Step Information

Note:You can enter a maximum of 10000 rows in this field.
Select Save.

Define email settings

The Email tab allows you to define the email account and server from which the system sends emails. These settings affect your entire Mobile Enterprise Platform instance. Mobile Enterprise Platform does not verify the validity of these settings. Beginning in Mobile Enterprise Platform instancePlatform 9.0 SP11, you can define email settings for cloud implementations of the Platform. Previously, this tab was only available for on-premise implementations. If you leave these settings blank on a cloud implementation, the system will use the default email settings. Beginning in Mobile Enterprise Platform does not verify the validity Platform 9.0 SP11, you can define email settings for cloud implementations of DSI Platform. Previously, this tab was only available for on-premise implementations. If you leave these settings blank on a cloud implementation, the system will use the default email settings. Beginning in DSI Platform 9.0 SP11, you can define email settings for cloud implementations of DSI Platform. Previously, this tab was only available for on-premise implementations. If you leave these settings blank on a cloud implementation, the system will use the default email settings.

To define settings for email, complete the following steps in Platform Manager.

Go to Admin > Configuration > System Settings > Email.
For Server name, enter the name of the SMTP email server through which email messages pass.
Step Information
Note:

You can enter a maximum of 65 alphanumeric characters in this field.

For cloud implementations, you must use an email server that is available externally.

Configure the SMTP Server Relay Restrictions to allow access to the Mobile Client and/or the Mobile Enterprise Platform host servers.
For Server port, enter the IP connection port of the SMTP email server.

Step Information

Note:You can enter a maximum of 5 numeric digits in this field.
For From domain, enter the domain portion of the email address.

Step Information

Note:You can enter a maximum of 50 alphanumeric characters in this field.

Example

Example: dsiglobal.com
For User ID, enter the email address you want the system to use when sending emails.

Step Information

Note:You can enter a maximum of 50 alphanumeric characters in this field.
For Password, enter the password to authenticate the User ID with the email server.

Step Information

Note:You can enter a maximum of 50 alphanumeric characters in this field.
Select Save.

Result: The system uses the server and account specified when sending the following messages.

Emails triggered when a user runs an app that contains the Send Email source element
User registration welcome emails
Password recovery emails
AIM server error messages

Define device location settings

Location settings are used when your apps require GPS functionality. You can define the location polling interval, location reporting interval, and Google API Key.

Prerequisite: Obtain a Google API key to allow more views on the Device Tracker page.

To define device location settings, complete the following steps in Platform Manager.

Go to > Configuration > System Settings > Device Location.
For Location polling interval (minutes), enter the interval, in minutes, for GPS to be captured on devices.
For Location reporting interval (minutes), enter the interval, in minutes, for devices to send GPS back to the server.
For Google API key, enter your Google API key to allow more views on the Device Tracker page.
Select Save.

Define Mobile Client deployment settings

The Mobile Client Deployment settings allow you to configure settings for Mobile Client. You can use these settings to configure Mobile Client for new users.

To define Mobile Client communication settings, complete the following steps in Platform Manager.

Go to Admin > Configuration > System Settings > Mobile Client Deployment.
In the Mobile Client Communication Settings section, complete the following substeps.
1. For Host name/IP address, enter the host name or IP address of the server to which Mobile Client devices connect.
2. For TCP/IP port, enter the port number that the Mobile Enterprise Platform server uses to communicate with Mobile Client devices via TCP/IP.
  
  Step Information
  
  Note:This is often the port number configured as the ‘Listening port for devices' in the Full Client section of the Communication Agent settings. It may be a different port number if external network routing configurations use a different port number for communication with the Mobile Enterprise Platform server.
3. For HTTP port, enter the port number that the Mobile Enterprise Platform server uses to communicate with Mobile Client devices via HTTP.
  
  Step Information
  
  Note:This is often the port number configured as the ‘Listening port for devices' in the HTTP Client section of the Communication Agent settings. It may be a different port number if external network routing configurations use a different port number for communication with the Mobile Enterprise Platform server.
4. For Default response time-out (seconds), enter the time in seconds for the Mobile Client to wait for short running messages and acknowledgments from the Mobile Enterprise Platform server.
5. For Default communications time-out (seconds), enter the time in seconds for the Mobile Client device to wait for a message reply when it communicates with the Mobile Enterprise Platform server.
6. For Default device license type, select the license type you want to assign to the Mobile Client device.
7. Optional. To automatically configure the communication settings of a Mobile Client device, copy the URI from the Client Comm Configuration URI field, and then send the link to a mobile device user.
  
  Step Information
  
  Note:This is a read only field that is populated from the settings above.
In the Mobile Client User Registration Link section, complete the following substeps.
1. For MEP external web port, enter the external web port number that you can use for self-registration.
2. To require encrypted communication, select SSL.
3. Optional. To allow users to self register, copy the contents of the URL field, and then send it to users.
  
  Step Information
  
  Note:This is a read only field that is populated from the settings above.
In the Mobile Client Download section, for URL, enter the URL of the location on Mobile Enterprise Platform where a user can download Mobile Client.
Optional. To send the Mobile Client Deployment settings in a welcome email, in the Welcome Email Content section, complete the following substeps.
1. For Reply to, enter the email address to which the recipient of the welcome email can respond.
2. For Subject, enter the subject of the welcome email.
3. For Body, enter the content of the welcome email.
4. To insert the URL of the location on Mobile Enterprise Platform where a user can download Mobile Client, select Insert Client Download URL.
5. To insert a URI that automatically configures the communication settings of a Mobile Client device, select Insert Client Comm Configuration URI.
6. To preview the email, select Preview Welcome Email.
7. Select Close.
Select Save.

Define device testing settings

The device testing settings allow you to define settings that will be used with AWS Device Farm. This allows you to test an app when you package it for the Apple App Store or Google Play Store. You acquire the Access Key and Secret Key when you set up an AWS Device Farm account.

Prerequisite: You must have previously set up an AWS Device Farm account.

Note:The AWS (Amazon Web Services) Device farm is an app testing service with which you enable communication prior to packaging an app. For more information on the AWS Device farm, refer to About packaging and testing an app for an app store.

To define device testing settings, complete the following steps in Platform Manager.

Go to Admin > Configuration > System Settings > Device Testing.
For Access Key, enter the alphanumeric key you receive from AWS Device Farm when you set up an account.
For Secret Key, enter the alphanumeric key you receive from AWS Device Farm when you set up an account.
Select Validate to verify the information.
Select Save.

Define Insights settings

The Insights settings allow you to define settings for the Insights tool. These settings are only available for users that have an Analytics license. You can use these settings to define the names of the Workbook and Dashboard.

To define analytics settings, complete the following steps in Platform Manager.

Go to Admin > Configuration > System Settings > Insights.
For Dashboard, enter the ID of the report for Insights. This is provided by the Customer Success Center and represents the main dashboard of your installation.
For Admin page URL, enter the ID of the Admin Settings page for Insights.
Select Save.

Define platform metrics settings

The Platform Metrics settings allow you to define settings for the Analytics tool. This tab is only available for users with a Platform Metrics license. You can use these settings to adjust the frequency with which metrics are sent, allow users to opt out of Platform Metrics, and set up metrics categories.

To define platform metrics settings, complete the following steps in Platform Manager.

Go to Admin > Configuration > System Settings > Platform Metrics.
In the Platform Metrics Settings section, complete the following substeps.
1. For Send metrics frequency (minutes), enter the frequency for metrics to be sent.
  
  Step Information
  
  Note:Metrics frequency must be in whole minutes, with a minimum frequency of 0, and a maximum frequency of 1440.
2. To allow users to opt out of data collection, select Allow user to opt out of Platform Metrics.
To determine which categories of metrics will be sent to the dsiPlatformMetrics table, in the Metrics Categories section, select any of the following filter options.
- To collect metrics for elements, select Element.
- To collect metrics at the system level, select System.
- To collect metrics at the custom level, select Custom.
- To collect metrics for errors, select Error.
Select Save.

Define privacy settings

Beginning in 9.0 SP5, you can define a privacy statement to outline the data you will gather about users. The message displays in Mobile Client or Platform Manager the first time a user logs in, or when the user logs in after you changed the privacy settings.

To define privacy settings, complete the following steps in Platform Manager.

Go to Admin > Configuration > System Settings > Privacy.
For Language, select the language for which you want to enter a privacy statement.
For Customer Privacy Statement, enter the privacy statement you want your users to accept.

Step Information

Note:You may only edit the Customer Privacy Statement. The Privacy Statement will display below it in the Privacy Terms window.
Select Save.

Expected Result

Result: A warning displays, informing you that saving changes to this page will reset the "Personal data privacy terms accepted" flag for all user profiles.
To verify that you want to save your changes and reset the "Personal data privacy terms accepted" flag for all user profiles, select Proceed.

Step Information

Note:If you select Cancel, your changes are not saved, and you are redirected to the Configuration page.

Result: The new privacy statement displays in Mobile Client or Platform Manager the next time each user logs in. All users must accept the new statement before they can log in. After a user accepts the privacy statement, the message will only display again if you edit the statement, or if "Personal data privacy terms accepted" is manually deselected on their user profile.

System settings fields

System settings are global parameters that affect the entire system. These settings can be defined when setting up the system, or editing system operations.

General

Language

Specifies the default language for user interface text in a new user's profile. You can specify a different language for an individual user in that user's profile.

Force activity logging to disk

When selected, writes all activity messages to an activity log file in the logging folder, and places them in the message queue. This option will force the system to write all errors, alerts, and events to the log for verification.

Show agent confirmation prompt

Enables an Agent Confirmation dialog box when you start and stop agents in System Monitor.

This is disabled by default.

Maximum number of rows for Data Viewer

Specifies the maximum number of table rows to be displayed in the Registered Table Data Viewer.

You can enter a maximum of 10000 rows in this field.

Advanced InventoryAdvanced Inventory

Email

Note:The system does not validate these settings.

Server name

Specifies the name of the SMTP e-mail server through which email messages pass.

You can enter a maximum of 65 alphanumeric characters in this field.

Server port

Specifies the IP connection port of the SMTP email server.

You can enter a maximum of 5 numeric digits in this field.

From domain

Specifies the domain portion of the email address that identifies the owner and type of entity owning the address. For example, dsiglobal.com.

You can enter a maximum of 50 alphanumeric characters in this field.

User ID

Specifies the the email address you want the system to use when sending emails.

You can enter a maximum of 50 alphanumeric characters in this field.

Password

Specifies the password of the user account to be authenticated with the email server.

You can enter a maximum of 50 alphanumeric characters in this field.

Device Location

Location polling interval (minutes)

Specifies the interval, in minutes, for GPS to be captured on devices.

Location reporting interval (minutes)

Specifies the interval, in minutes, for devices to send GPS back to the server.

Google API key

Allows more views on the Device Tracker page.

Mobile Client Deployment

Mobile Client Communication

Host name/IP address

Specifies the host name or IP address of the server to which Mobile Client devices connect.

TCP/IP port

Specifies the port number that the Mobile Enterprise Platform server uses to communicate with Mobile Client devices via TCP/IP.

This is often the port number configured as the ‘Listening port for devices' in the Full Client section of the Communication Agent settings. It may be a different port number if external network routing configurations use a different port number for communication with the Mobile Enterprise Platform server.

HTTP port

Specifies the port number that the Mobile Enterprise Platform server uses to communicate with Mobile Client devices via HTTP.

This is often the port number configured as the ‘Listening port for devices' in the HTTP Client section of the Communication Agent settings. It may be a different port number if external network routing configurations use a different port number for communication with the Mobile Enterprise Platform server.

Default response time-out (seconds)

Specifies the time in seconds for the Mobile Client to wait for short running messages and acknowledgments from the Mobile Enterprise Platform server.

Default communications time-out (seconds)

Specifies the time in seconds for the Mobile Client device to wait for a message reply when it communicates with the Mobile Enterprise Platform server.

Default device license type

Specifies the license type to be assigned to the Advanced Inventory Mobile Client device.

You can select Full Access Device, Casually Connected Device, or None.

Client Comm Configuration URI

Displays the URI that is created from TCP/IP, HTTP Port, Default Communications Timeout, and Default Device License Type. You can use this URI to automatically configure the communication settings of a Mobile Client device.

This is a read only field that is populated from the settings above.

Mobile Client User Registration Link

MEP external web port

Specifies the external web port number that you can use for self-registration.

SSL

When selected, encrypted communication is required.

URL

Specifies the Web site URL for the location on the Mobile Enterprise Platform where a Mobile Client user can self-register.

This is a read only field that is populated from the settings above.

Mobile Client Download

URL

Specifies the URL of the location on Mobile Enterprise Platform where a user can download Mobile Client.

Welcome Email Content

Reply to

Specifies the email address to which the recipient of the welcome email can respond.

Subject

Specifies the subject of the welcome email.

Body

Specifies the content of the welcome email.

Device Testing

Access Key

Specifies the alphanumeric access key you receive from AWS Device Farm when you set up an account.

Secret Key

Specifies the alphanumeric secret key you receive from AWS Device Farm when you set up an account.

Insights

Base URL

Displays the base URL for the Analytics server.

This field is read only, and populates when Analytics Agent is started.

Site name

Displays the site name inside the Analytics server to which data will be extracted.

This field is read only, and populates when Analytics Agent is started.

Workbook

Specifies the name of the collection of reports for the Dashboard.

Dashboard

Specifies the name of the reports for Analytics.

Platform Metrics

Send metrics frequency (minutes)

Specifies the frequency for metrics to be sent.

Metrics frequency must be in whole minutes, with a minimum frequency of 0, and a maximum frequency of 1440.

Allow user to opt out of Platform Metrics.

When selected, allows users to opt out of data collection.

Metrics Categories

Element

When selected, metrics will be collected for elements.

System

When selected, metrics will be collected at the system level.

Custom

When selected, metrics will be collected at the custom level.

Error

When selected, metrics will be collected for errors.

Chatbot

Identitypool ID

Specifies the Identitypool ID that the system will use to register chatbots.

To receive this ID, you must create an Amazon Cognito Identity pool with enabled access to unauthenticated identities, and assign the appropriate permissions for Amazon Lex.

Amazon Lex region

Specifies the AWS region that the system will use to register chatbots.

Amazon Lex is currently only available for the US East (Virginia) region.

Privacy

Language

Specifies the language in which the privacy statement is written. You can create a different privacy statement for each supported language.

Advanced Inventory Privacy Statement

You may not edit this field. Advanced Inventory's Privacy Statement will display below the Customer Privacy Statement you create.

Customer Privacy Statement

Defines your privacy statement. Each user must accept this statement to log in.