Application Parameters¶
Application Parameters are defined per Aurena Native Applications and are categorized. They are either system defined or App defined.
Administrator can define the parameter value for each parameter from a given drop down or free text entry.
System Defined Parameters¶
The following parameters are system defined and available in all Aurena Native apps. Observe that not all of the parameters are used in all apps, due to that a certain app might not have the required functionality built into the app.
Device Parameters¶
The following parameters are used to configure the Aurena Native applications on the device.
General Device Parameters¶
The following parameters are used to configure general settings of the Aurena Native application on the device.
| Parameter | Description | Default Value |
|---|---|---|
| SEND_LOGS_WITH_DATA_DEFAULT | Send Device Logs Default Setting. | FALSE |
| TREE_STRUCTURE_MAIN_ACTION | Tree structure app setting. | PinNode |
Data Synchronization Parameters¶
The following parameters are used to configure the way data is synchroinzed between IFS Cloud and the Aurena Native application devices.
| Parameter | Description | Default Value |
|---|---|---|
| DEFAULT_SYNC_INTERVAL | Identifies the interval before the next synchronization with IFS Cloud | 60 |
| DATA_CHUNK_SIZE | Maximum data chunk size before data is split | 100 |
| SERVER_CAPABILITIES | Server Capabilities. | ConnectMedia^ |
| SYNC_DATA_TRANSFER_MODE | Sync Data Transfer Mode. | GROUPED |
Device Barcode Scanning Parameters¶
The following parameters are used to configure the Aurena Native applications barcode scanning capabilities on the devices.
| Parameter | Description | Default Value |
|---|---|---|
| BARCODE_SCANNING_ENABLED | Determines whether to enable barcode scanning for all text data using the command. | TRUE |
| SCANDIT_APP_KEY_ANDROID | Android App Key for Scandit Barcode Scanner provided by Scandit | |
| SCANDIT_APP_KEY_IOS | iOS App Key for Scandit Barcode Scanner provided by Scandit | |
| SCANDIT_APP_KEY_WINDOWS | Windows App Key for Scandit Barcode Scanner provided by Scandit |
Note 1: If the Scandit License Key is set then Scandit will be used for scanning bar codes
Note 2: If the Scandit License Key is invalid then it will be impossible to scan bar codes.
Note 3: To see what Barcode Foint is supported, see Supported Barcode Fonts
Device Location Parameters¶
The following parameters are used to configure the device location settings used within the Aurena Native applications.
| Parameter | Description | Default Value |
|---|---|---|
| LOCATION_TRACKING_MODE | Whether the app should continually track location and, if so, how accurate the locations should be. | COARSE |
| LOCATION_TRACKING_INTERVAL_MIN | The length of time between updates when continually tracking location. | 15 |
| LOCATION_ON_DEMAND_MODE | Whether the app should be able to obtain the device location when requested and, if so, how accurate the location should be. | FINE |
Embedded Maps Parameters¶
The following parameters are used to configure embedded maps
| Parameter | Description | Default Value |
|---|---|---|
| EMBEDDED_MAPS_ANDROID | Specifies if and what embedded map is used within the Aurena Native app on Android. | Disabled |
| EMBEDDED_MAPS_IOS | Specifies if and what embedded map is used within the Aurena Native app on iOS. | Disabled |
| EMBEDDED_MAPS_WINDOWS | Specifies if and what embedded map is used within the Aurena Native app on Windows. | Disabled |
Device Security Parameters¶
The following parameters are used to configure the device security settings used within the Aurena Native applications.
| Parameter | Description | Default Value |
|---|---|---|
| PIN_AUTHENTICATION | PIN authentication enabled. | FALSE |
Picture Handling Parameters¶
The following parameters are used to configure picture handling used within the Aurena Native application devices.
| Parameter | Description | Default Value |
|---|---|---|
| PICTURE_MAX_DIMENSION | Maximum picture dimension when synchronizing. Any larger sizes than stated value would be resized to value entered. | 2000 |
| PICTURE_MAX_BYTES | Maximum picture bytes when synchronizing. Any larger sizes than stated value would be resized to value entered. | 1048576 |
| EXISTING_DEVICE_MEDIA_ALLOWED | Allow selecting of existing media from the device's camera roll or gallery to upload. | TRUE |
| COMPRESS_IMAGES_ON_DOWNLOAD | Compress images on download. | NO_COMPRESSION |
Input Masks Parameters¶
These parameters are used for Input Masks Control
| Parameter | Description | Default Value |
|---|---|---|
| ALLOW_ACCENTED_CHARS | Allow accented characters in masked fields. | FALSE |
Inactive Device Parameters¶
These parameters is used for Inactive Device Parameter
| Parameter | Description | Default Value |
|---|---|---|
| DEVICE_INACTIVE_DAYS | No of days after device goes to inactive. | 7 |
Synchronization Process Parameters¶
The following parameters are used to control the synchronization process.
Database Process Parameters¶
The following parameters are used to configure the database processes used to collect and send data to the Aurena Native application devices.
| Parameter | Description | Default Value |
|---|---|---|
| GROUPED_PUSH_DATA_INTERVAL | Grouped Push data restartup interval (seconds) | 10 |
| GROUPED_PUSH_ENABLED | Grouped Push data available | ON |
| MAX_PUSH_EVENTS_ERROR_COUNT | Maximum number of error lines display when retry create push triggers | 10 |
| PUSH_DATA_INTERVAL | Push data restartup interval (seconds) | 10 |
| PUSH_ENABLED | Push data available | ON |
| SERVER_LOG | Database Extended logging | OFF |
Push Notification Parameters¶
The following parameters are used to configure the push notifications to be sent to the Aurena Native application devices.
| Parameter | Description | Default Value |
|---|---|---|
| NOTIFICATION_HUB_PATH | Notification Hub Path. | |
| NOTIFICATION_HUB_URL | Notification Hub URL. |
Note: An Azure Notification Hub is used to deliver Push Notifications from IFS Cloud to the IFS Aurena Native Apps. It is possible to create your own Azure Notification Hub for sending of Push Notifications. To do this the NOTIFICATION_HUB_PATH must be set to the Azure Notification Hub Name and the NOTIFICATION_HUB_URL must be set to the Connection String relating to the Access Policy Name "DefaultFullSharedAccessSignature".
Grouped Push Parameters¶
If the Aurena Native application uses the Synchronization Rule Delivery Method of Grouped Push then the following system parameters will be available.
Note: With the exception of Trace Level and Clean Up Parameters the default values of the Grouped Push Parameters are adequate for all installations. It is therefore only recommended to change Grouped Push Parameters with full understanding of these parameters and potential impact on the installation.
Trace Level Parameters¶
These parameters control the information collected in the Grouped Push Transaction Traces
| Parameter | Description | Default Value |
|---|---|---|
| BATCH_TRACE_LEVEL | Trace level for Grouped Push main task | WARNING |
| INIT_TRACE_LEVEL | Trace level for Grouped Push INIT sub-task | WARNING |
| TRIGGER_TRACE_LEVEL | Travel level for Grouped Push triggers | WARNING |
These parameters can be set with one of the following trace levels:
- WARNING - only warnings and error messages are inserted
- STAT - one database row per background operation within the Grouped Push process
- INFO - one database row per important event within an operation, including SQL statements
- TRACE - additional information about OBJKEYs, user IDs, device IDs, etc
- DEBUG - maximum debug level: propagation of trigger events, fetched column values, etc.
Note: Trace levels INFO, TRACE and DEBUG may generate huge number of records in Grouped Push Transaction Traces. It is therefore recommended to not leave these parameter set to any value other than STAT or WARNING for longer than a few hours.
Fetch Size Parameters¶
These parameters control the number of rows fetched to PL/SQL memory in one SQL call within the Grouped Push process. Changing these affects the trade-off between execution time and memory usage:
| Parameter | Description | Default Value |
|---|---|---|
| FETCH_SIZE_DATA | Number of entity data rows without LOB columns fetched from the database to PL/SQL memory in one SQL call | 2000 |
| FETCH_SIZE_LOB_DATA | Number of entity data rows containing LOB columns fetched from the database to PL/SQL memory in one SQL call | 500 |
| FETCH_SIZE_LOG | Number of transaction log rows fetched from the database to PL/SQL memory in one SQL call | 5000 |
| FETCH_SIZE_OBJKEY | Number of OBJKEYs fetched from the database to PL/SQL memory in one SQL call | 10000 |
Schedule and Interval Parameters¶
These parameters control teh frequency of background operations within the Grouped Push process
| Parameter | Description | Default Value |
|---|---|---|
| CONFIG_REPEAT_INTERVAL | Configuration cache tables will be refreshed when the configuration is changed, but not more often than the value of this parameter (in seconds) | 10 |
| INIT_SCHEDULE | Scheduling expression for creation of INIT transactions in background (MobileSyncRule Syntax or Oracle Scheduler Calendaring Syntax) | FREQ=DAILY; BYHOUR=1 |
| INIT_REPEAT_INTERVAL | INIT transactions are created according to schedule, but not more often than the value of this parameter (in seconds) | 60 |
| REFRESH_REPEAT_INTERVAL | Refresh transactions are created according to schedule, but not more often than the value of this parameter (in seconds) | 60 |
| TRANSACTION_RETRY_INTERVAL | Background processing of a failed transaction will be retried, but not more often than the value of this parameter (in seconds) | 60 |
| TRANSACTION_MOVE_INTERVAL | All unprocessed (Grouped) transactions will be moved to current SCN time when the first one becomes older than the value of this parameter (in seconds) | 3000 |
Validity Lifetime Parameters¶
These parameters define the maximum lifetime of database rows within the Grouped Push process
| Parameter | Description | Default Value |
|---|---|---|
| CONFIG_VALID_LIFETIME | Configuration cache tables will be refreshed not less often than the value of this parameter (in hours) | 24 |
| TRACE_STAT_LIFETIME | Tracing data in table MOBILE_TRANSACTION_STAT_TAB older than the value of this parameter (in days) will be deleted by cleanup background job | 30 |
Clean Up Parameters¶
These parameters control the background process deleting outdated Grouped Push data. Committing too many rows in one transaction may lead to unnecessary usage of rollback segments.
| Parameter | Description | Default Value |
|---|---|---|
| CLEANUP_FETCH_SIZE | Number of ROWIDs fetched from the database to PL/SQL memory in one SQL call when deleting outdated transactions | 1000000 |
| CLEANUP_COMMIT_CHUNK | Number of rows to delete in one commit chunk when deleting outdated transactions | 10000 |
| CLEANUP_COMMIT_MESSAGE_CHUNK | Number of rows to delete in one commit chunk when deleting outdated JSON messages | 100 |
Grouped Push Processing Parameters¶
These parameters are used in the Grouped Push Processing
| Parameter | Description | Default Value |
|---|---|---|
| MAX_MESSAGE_SIZE | Maximum size in KB of uncompressed JSON data message sent to offline database | 1000 |
| MAX_TASK_EXECUTION_TIME | Background task quits when there is nothing to do, or, when execution time becomes longer than the value of this parameter (in seconds) | 60 |
| PARALLEL_INIT_ENTITIES | List of entities to generate PARALLEL query hint for during creation of INIT transaction: |
Note: In Oracle you can run a select with a hint to make it run in parallel over multiple cores utilising Oracle Parallel Query which can be used by the Group Push process by changing the PARALLEL_INIT_ENTITIES parameter. By default the Group Push process runs on a single core.