Linked Apps

Key Info  
Purpose:

Manage configuration for the Linked Apps module.
Related Module(s):

Linked Apps
Accessed From:

Maintenance > System> Linked Apps
Window(s):

Linked Apps

Linked App Station Access

Linked App Level Access

Dependencies:

None.

Linked Apps Window

The Linked Apps module is an axiUm+ module that allows your institution to integrate software with axiUm quickly and easily.

Each linked app will have unique requirements regarding the specific parameters that should be passed to the application, as well as the formatting and order of these parameters.

The Linked Apps module uses custom functions that allows axiUm to generate this string of parameters and pass it to the application when launched.

You can also configure Linked Apps to authenticate users in third-party integrations via Single Sign-On (SSO). This functionality allows you to use secure token-based authentication to pass user credentials and be fully authenticated in the linked app once it launches from axiUm.

Important: CAPI version 2.13.0+ is required to use SSO authentication.

The Linked Apps window allows you to manage Linked App integrations.

Important: Each linked app requires an Oracle function to be created in your database. For more information on working with functions, please contact axiUm Support.

Field Description
Name

A field that uniquely identifies the linked app.

Description

A field that indicates a description of the linked app, which is displayed in the Nav Panel and menu bar.
Link Type

A drop-down list that indicates the type of app link:

  • Application (Command Line): The linked app uses command line to launch.
  • Website (URL): The linked app uses a URL to launch.
  • Custom: The linked app uses SSO to launch and authenticate the user.
File Path / Custom Type / URL

Note: The field that displays varies depending on which entry is selected from the Link Type field.

A field or drop-down list that indicates the path to the file, custom type, or address of the web page that is used by the linked app.

Important: If the Custom Type field displays and CAPI version 2.13.0+ is not installed, the custom entries cannot auto-populate.
Function / Options

Note: The field that displays varies depending on which entry is selected from the Link Type field.

A field that indicates the Oracle function or default options used for this linked app. The return value of the function is automatically appended to the File Path / URL field when the app is launched.

Note: The name must exactly match the name of the function in the database.

Next to the Options field, a button that displays the Expanded Text (Additional Information) window and allows you to modify the json defaults as necessary to enter your values.
Require patient selection to run app

A checkbox that, when selected, indicates that the linked app requires a patient to be selected in axiUm before launching.

Note: If selected and a patient is not selected when this linked app is launched, axiUm prompts the user to select a patient.

Restrict app access to certain workstations

A checkbox that, when selected, indicates that the linked app can only be launched from workstations that have been granted access.

When selected, axiUm will use both user level and workstation access to determine whether the app displays in the Nav Panel.

Note: If selected, the Station Access () icon is enabled, and you must specify workstations that can be used with this linked app.

Tip: If the app can be launched regardless of workstation, deselect this checkbox. When deselected, only user level access determines whether the app displays in the Nav Panel.

Task Procedure
Add Linked Apps
  1. Click the Clear Data () icon.
  2. Complete the fields as necessary and click the Add a new Record () icon.
Manage Linked App Station Access
  1. Select a listed entry and click the Station Access () icon to display the Linked App Station Access window.
  2. Make any necessary changes and close the window.
Manage Linked App Level Access
  1. Select a listed entry and click the Level Access () icon to display the Linked App Level Access window.
  2. Make any necessary changes and close the window.
Edit Linked Apps
  1. Select a listed entry.
  2. Make any necessary changes and click the Modify Record () icon.
Reorder Linked Apps
  1. Select a listed entry.
  2. Click the Up and Down buttons to move the selected entry within the list.
Inactivate Linked Apps
  1. Select a listed entry.
  2. Select Mark app as inactive checkbox and click the Modify Record () icon.
Delete Linked Apps
  1. Select a listed entry and click the Delete Record () icon.
  2. When prompted, click Yes to confirm the deletion.

Linked App Station Access Window

(Maintenance > System > Linked Apps > Station Access)

The Linked App Station Access window allows you to specify workstations that can launch the selected linked app.

Tip: This window is only available when the Restrict app access to certain workstations checkbox is selected for the linked app.

Field Description
Name

A read-only field that identifies the linked app.
Criteria

A text field that is used to enter your search criteria.

Tip: You can enter the first few characters of the word, or enter an underscore (_) to return all results.

Search On

A drop-down list that indicates the field to search on:

  • Station Id
  • Terminal Name
Task Procedure
Add Workstation Access
  1. Specify the Criteria and Search On fields and click the Search button to locate the applicable workstations.
  2. Select one or more workstations from the Stations (Not Assigned) list and click the > button to move the stations to the Stations (Assigned) list.

    3. Tip: You can also select an entry in the Station Groups list and click the > button to move all workstations within the selected group(s).

Remove Workstation Access

  1. Select one or more workstations from the Stations (Assigned) list and click the < button to move the stations to the Stations (Not Assigned) list.

Linked App Level Access Window

(Maintenance > System > Linked Apps > Level Access)

The Linked App Level Access window allows you to manage access to the selected link. It displays when you open the Linked Apps window, select a listed link and click the Level Access () icon.

Field Description
Name

A read-only field that identifies the linked app.
Level

A read-only field that indicates the selected user level(s).

Tip: You can select multiple levels to save time. If multiple are selected, a comma and ellipsis (, ...) display after the first level.
Can Access

A drop-down list that indicates access for the selected user level(s):

  • No
  • Yes
Task Procedure
Configure Linked App Level Access

  1. Select one or more user levels that should have the same access.

  2. Set the access fields as necessary and click the Modify Record () icon.

  3. Repeat the steps for all necessary user levels.