External Apps

External Apps allows to set how external applications interact with SSP. These external apps are not part of the main core of SSP, but use the SSP WebService to start tickets in selected processes. This section does not explain you how to build applications like this, but does explain how the fields are defined that enter SSP. Any external app will basically replace a Form in SSP, so it sends over data to the WorkFlow engine, to start off one or more processes. The WebStore is considered an external application, for example.

The External Apps screen is opened by clicking on the External Appsbutton in the Admin Panel.

Admin Page

The External Apps administration page shows a list of all current defined external applications in SSP.

clip0102

• Edit : Change the details of the selected External App.

• Delete : Delete the selected External App.

• Cancel : Use the button to return to the overview page of the Administration section.

• Add New External App : Use this button to open the dialog window for entering a new External App.

General Settings

The General Settings tab of an External App allows you to :

clip0103

• Name : enter the name of the External App.

• Item Field : Enter the internal label of the field containing the value that should be displayed in the search drop down containing all the search items, e.g.: ShopName. Buttons:

• Cancel : disregards any changes and returns you to the main screen of External Apps.

• OK: Saves any changes and returns you to the overview screen of External Apps.

• Save : clip0020: Saves any changes but remains on the current page.

Fields

The Fields tab of an External App allows you to define the list of fields (data) that is sent over from the external application towards SSP, and how it is called in SSP.

The list shows all fields, with the following information:

• Sequence: defines the order of the fields.

• Label : the name of the field as it is used in SSP.

• [External App] Label : the label of the field, as it is known in the external application. In between the brackets [] the name of the External App is shown in the column header.

• Field Type: the field type of this data.

• Action :

  • Edit : Change the details of the selected field.

  • Delete : Delete the selected field.

When clicking on the EDIT button (), the details of the field appear below the list of all fields :

Options:

• Internal Label : the name of the field as it is used in SSP.

• Label : the label of the field, as it is known in the external application.

• Show on Overview : If check marked this field will be shown on the Overview page.

• Field Type : the field type of this data which can be as follows: Text field (single line); Text area (multiple lines); Radio button (yes/no); Upload field; Date field; Date & Time field; Password field; Drop down list field; Check box list field; Radio button list field; HTML field; Numeric field.

! The list of fields for the Service Catalog can be refreshed using Admin > General Settings > Service Catalog - refresh external app fields (button at the bottom of the page).