Application

Home » Support Library » User Guides » User Guide - Base Product » Application

The Administration–>Application module includes the following options:

Application Configuration

Application Version

View the version of ArkCase that is running with the Application Version option.

Label Configuration

Use the Label Configuration option to customize the user interface to your business context. A list of the Core ArkCase application labels is provided for each module. Labels are associated with fields, messages, buttons, table titles, table columns, form names, etc.

lebel configuration

The list has four columns, the label IDs (the object-defined identification), the values (the user interface display), the description, and the default value.

Edit the value to change what is shown on the ArkCase application.

Customize Labels

Labels are grouped by module, for example, Admin or Case.

  1. Select the module from the drop-down menu.
  2. Select a language, if applicable.
  3. To change a label, click the current value to open it for editing.

Changing Labels

4.  Type in the new value.

3. Click the check mark to save the change.

Note: Click the X button to cancel the change and close the box.

Reset Labels 

If you add new labels to the application, you need to use the reset function so they are displayed in the application.

1. To reset the labels, click the reset1button. The Reset labels to default window opens.

Resetting Labels/Clear Custom Labels

2. Select the modules to reset and the language if applicable. Click the Reset button.

Lookups Configuration

Use Lookups Configuration to customize the user interface to your business context. A list of the ArkCase lookups is provided for each dropdown menu in the application,

Add a Lookup Value

1. On the Lookups Configuration, choose the lookup you want to modify, for example, addressTypes.

2. To add a lookup value, click the plus button. The Add lookup entry window opens.

2. Enter the Lookup Key, for example Alias. This is the text that will appear in the drop-down menu.

3. Click in the Value field and search for the lookup value type, for example, enter DBA to locate the core.lookups.dbasTypes value.

Note: The Value links to the Label. See Label Configuration above for more details.

4.  Click Save Entry to add the new key to the menu.

Edit a Lookup Value

You can change a lookup value to Primary, edit the description, or choose a different value.

1. To edit a lookup value, click the edit icon. The Edit lookup entry window opens.

2. Click in the Value field to choose the new label value.

3. Enter a description if necessary.

4. Choose the radio button for Set Primary if applicable.

5. Click Save entry.

Move a Lookup Value

To move a lookup value, click and hold the value in the table and drag it to a different position in the table. The values will be displayed in the new order on the related drop-down menu.

Delete a Lookup Value

To delete a value, choose the delete icon next to the value.

Deleting a Lookup Value

Add a New Lookup Table

1. To add a lookup table, click the plus1 button at the top of the Choose Lookup list.

The Add Lookup window opens.

2. Enter the new Lookup Name.

3. Select the Lookup Type:

  • standardLookup
  • inverseValuesLookup
  • nestedLookup

4. Click Save.

Delete a Lookup Table

To delete a lookup table, select the value from the list and click the delete icon.

 

Username Display Configuration

Use the Username Display Configuration option to select how usernames are shown.

1. Check the radio button to select either use full name or user identifier.

User Display Configuration

2. Click the apply button.

Login Configuration

Use the Login Configuration option to specify the length of idle time before users are automatically logged out of ArkCase.

Enter the amount of idle time in milliseconds and then click  apply .

Login Configuration

Audit History

Use the Audit History option to specify the length of time  to retain the audit and notification events in ArkCase.

Update Audit History

Enter the days to retain the audit and notification events and then click the apply button.

Audit History

Holiday Schedule

Use the Holiday Schedule option to specify the holiday schedule in ArkCase.

Add to Holiday Schedule

1. To add to the holiday schedule, click the pop-up  button. The Holiday Schedule window opens.

2. Enter the name of the holiday, select the date and click  save-blue .

Edit Holiday Schedule

To edit a holiday entry on the schedule, click the edit button.

Delete from Holiday Schedule

To delete a holiday entry from the schedule, click the delete button.

Include Weekends at Working Days on the Schedule

Click the “Include Weekends as Working Days” check box and then click the save icon button.

Include Weekends at Working Days on the Schedule

Business Hours Configuration

Use the Business Hours Configuration option to calculate due dates using business day hours. If you choose this option, actions that occur after the end of day are calculated to start at the beginning of the next business day.

To set the business hours calculation, select the checkbox, then enter the hours for start and end of day.

Form Types Configuration

You can specify whether the application uses Angular or Frevvo Forms.

1. Check the radio button to select either use Angular or Frevvo forms.

Update Form Types Configuration

2. Click  apply .

Sequence Configuration

Sequence Configuration allows business users to configure the automatic generation of the sequence numbers on each individual object (Case, Request, Complaint, etc.).

The Sequencing mechanism has the following features:

  • The period for sequencing can be configured (month, week, etc.)
  • The sequence reset start date can be specified
  • A prefix can be added to the automated numbers.

Select Sequence Configuration. The list of existing configurations opens.

Add a Sequence

1.To add a sequence, click +.

The Add/Edit Sequence window opens.

2. Specify the Sequence Name and Description. If enabled, an automatic sequence number will be generated for each new object of that type.The new sequence is shown in the list.

3. Click the Settings icon for the new sequence.

The Sequence Part window opens.  (Sequence Part = how the sequence number will be generated and what each part will be).

sequence part listing table without any sequence part

4. Click +. The Add/Edit Sequence Part window opens.

popup for adding or editing sequence part and all required informations for that

5. Add the name of the first sequence part and then select from the drop-down, to specify the Sequence part type (Sequence Part Type = this is the definition of what type of functionality that will be used for this field. For example, is this part of the sequence a ‘Date’ or is it ‘Text’.)

popup for adding or editing sequence part and selected sequence part type autoincrement

There are 5 different types for defining each part of the sequence number. You can use all, or only few of them.

AUTOINCREMENT

Autoincrement is usually used at the end of the sequence number and defines the pattern for incrementing sequence numbers. For example a 6 digit sequence starting with ‘1’ = ‘000001’, which will increment by 1, so the second number in the sequence would be ‘000002’.

popup for adding or editing sequence part and all required informations for that

Enter the starting number and the increment size (how much the next sequence number will be incremented by from the previous one). Number length defines how many digits will be used for this sequence part (value that will be incremented on each new created object).

Check if skipped sequence values (usually skipped by some error in creating object) should be reused on the next created object.

Enter an Execution condition to define specific cases for which this sequence part should be included or not (ex., Only for Requests of some specific type). SPEL language is used for expressing these conditions.

For example: enter ‘requestType == ‘Appeal’  for this specific sequence to be invoked when an request with the requestType = Appeal is created.

form for adding or editing sequence part and all required information for that

OBJECT_PROPERTY

Use the Object Property, that also requires SPEL expression, to specify conditions for different object types.

For example: The following expression caseType == ‘Gov’ ? ‘G’ : ‘NG’ means that it will add letter “G” as a part of the Case sequence number, if the Case type = “Gov”. If not, it will add “NG”.

popup for adding or editing sequence part and all required informations for that

UUID

This Sequence Part Type will add UUID (universally unique identifier) to the Object Sequence number

popup for adding or editing sequence part and all required information for that

DATE

Use Date to set the Date format that will be added as part of the object sequence number.

If the Date/Time of the object creation should be included in the Object Sequence number, specify the format. For example: “yyyyMMdd” will add the current date to the sequence number, as set of 8 digits “20210506”.

popup for adding or editing sequence part and all required information for that

ARBITRARY_TEXT

Use ARBITRARY_TEXT to add plain text (String) to the Sequence number, as defined in the “Arbitrary text” field. For example, an underscore ( _ ) or hyphen ( – ).

popup for adding or editing sequence part and all required informations for that

Sequence Example

See example below to add a sequence for an object of type Complaint.

  1. Add new Sequence
    • Click +  on the Sequence Configuration table.
    • Enter the Sequence Name and Description fields (any String can be used).
    • Check the Sequence Enabled check-box.

Note: You can make changes later by clicking on the Edit icon for the Sequence Name.

popup for adding or editing sequence and all required information for thatby

The new Sequence is added to the Sequence Configuration table.

sequence configuration table with three configurations and all information and functions about them and last third configuration is selected in red rectangle

  1. Configure Sequence Parts.

sequence part listing table without any sequence part

    • Click +  to add first Sequence Part.
  2. Sequence Part 1 – Current Date at the beginning of the Complaint Sequence.
    • Select  Date  as a Sequence Part Type.
    • Fill in all fields. Define the format of the Date (Ex. yyyyMMdd will show the date in format: 20210516).
    • Include an Execution Condition if you want this part to be implemented only for some specific Complaint objects (not for all).
      • Ex: priority == ‘High’ (means Date will be added as a first Sequence part only for Complaints that are High Priority).

popup for adding or editing sequence part and all required information for that

  1. Sequence Part 2 – Add “-“ after the Date.
    • Choose  ARBITRARY_TEXT  as a type of the second sequence part.
    • In the Arbitrary text field add whatever string you want to appear in the Sequence name, for example, “-“.

popup for adding or editing sequence part and all required information for that

  1. Sequence Part 3 – Autoincrement part
    • Choose AUTOINCREMENT for the third sequence part.
    • Select the number that will be the starting number for the first Complaint created, for example, 100.
    • Select increment size.
    • Checking the “Reuse skipped sequence values” – if a Complaint object is not properly created due to some error , this number will not be lost, the next created Complaint will use the un-used number.
    • Set a Number length to set a maximum for the autoincremented numbers.

form for adding or editing sequence part and all required information for that

The Sequence Configuration Table shows the sequence parts.

one sequence part and all information about that part

The first Complaint created will have the following sequence number: 20210507_000100, the second will have 20210507_000101 (if created on the date of 05/07/2021)

Use the Settings icon for the Autoincrement sequence part is to specify when the increment reset will happen. The sequence can be reset by year or by month, for example.  Number reset is optional. Skip this if not needed.

reset list popup

To reset autoincrement sequence each year on a specific date, click the + sign and enter the reset start date and time.  Check the Repeat reset check box and select how often this reset should happen. For example, October 1st at 12am each year.

reset list popup

 

Object Title Configuration

Use the Object Title Configuration option to specify whether the out of the box title is used for objects, or whether a specific pattern is used.

  1. To change or add an object title configuration, select +. The Object Title Configuration window opens.

2. Select the Object Type from the dropdown menu.

3. Check or uncheck Enable Title Field.

4. Select the title display option for the object.

5. Click Save.

Recycle Bin

Use the Recycle Bin option to restore files that have been deleted. You can also permanently delete files.

Right-click on the value for Original Location, then choose Restore or Delete.

Scheduled Jobs

The scheduled jobs configuration is used to run or pause application jobs from the user interface.

Use the play or pause buttons to run or pause an application.

Reset Configuration

The reset configuration is used to reset all configuration (labels, lookups, titles, sequences, etc.) to the original default configuration.

License Configuration

Use the License Configuration option to upload relevant licenses.