Exporting Custom Apps
Export Custom API App
Click on the export button as shown in the below image.
*Not all sensitive data is removed automatically because it may vary based on the customapp, or event URL, or if the 3rd party endpoint is global or specific for each tenant. REVIEW ALL THE DATA EXPORTED BEFORE IMPORTING THEM INTO ANOTHER TENANT.
Enter the below three fields for exporting the template (mandatory)
Title: Enter the title for the custom app
Info: Enter any description info for the custom app
Link: Enter documentation link which you have referred for the custom app
Once all details have been entered, the export button will be enabled.
**Be sure to check for customer-specific data that needs to be updated before importing into another tenant.
Click on the export button and the template file will be downloaded.
2. Export a Custom Syslog App (mapping)
Click on the export button as shown in the below image.
Enter the below two fields for exporting the template (mandatory)
Title: Enter the title for the custom app
Info: Enter any description info for the custom app
Once all details have been entered, the export button will be enabled.
Click on the export button and the template file will be downloaded.
Importing Custom Apps
Click on the “Import Custom App” button.
The below option will appear to add a JSON file.
Note: The Import Custom App functionality supports both generic custom app JSON and syslog custom app JSON files.
Import a Custom API App
Note: When you import a Custom API JSON file, fields like App name, app category, API credentials page details, API config page details, and Mapping page should populate automatically from the file.
Once you upload the Custom API JSON file, you will be able to see the below screen with the populated data from the JSON file.
Enter the required credentials and click on test connection button.
The Save and Next Button will be enabled after the connection is tested and completed successfully, as confirmed but the Successfully authorized message that appears. Click on the Save and Next Button.
After entering the value of Timestamp Filter Param Value, the Save & Next button will be enabled.
Click on the Save & Next button.
We can see mapping data which has pre-populated from the JSON file. If you want to change the mapping, you can do so here. Then click on the Next button.
Once you click on Next, you can the see Summary fields page where you can make changes by dragging and dropping in the Mapped Fields and Selected Summary Fields.
After you click Save & Next, you’ll see a Preview page where you can check the details of the custom app you created.
Click on the Save & Close button. This saves the CustomApp configuration and completes the creation of the app.
2. Import a Custom Syslog App (mapping)
Note: When you import a Custom Syslog JSON file, fields like App name, app category, and Mapping page should populate automatically from the file.
Once you upload a Syslog JSON file, you will be able to see the below screen with data pre-populated from the JSON file.
Once you click on Save & Next, the Mapping page will be shown with pre-populated mapping from the JSON file.
Any changes to mapping can be made here.
Click on the Next Button to see the Summary Fields like below.
Here you can make any changes by dragging and dropping between the 2 windows.
Once you click on Save and Next, the Preview page will be shown with all the details of the Syslog App you created.
Click on the Save & Close button to finalize the app.
How to identify each type of custom app exported
After exporting a custom app as a file, you can edit the file (be careful). We strongly recommend NOT editing the file once you have exported it from USM Anywhere.
If you want to know what type of custom app is reading the file that you exported, opne the file and look at the attributes. If the file contains a Custom Syslog App, the “sysLogAppInfo” attribute will be present in the file. Alternatively, the attribute tagged as “appInfo“ indicates that you are reading a Custom API App.