Skip to content

Latest commit

 

History

History
123 lines (72 loc) · 6.01 KB

OIC_logs.md

File metadata and controls

123 lines (72 loc) · 6.01 KB

OIC logs: FTP unzipping to embedded File Server + Object Storage

Intro

In this lab, you will download OIC's auditlogs and interact with it via the REST and FTP adapters.

The audit log which "Contains all the changes users have made on design-time artifacts such as integrations, connections, adapters, and so on. Contains information for all integrations."

You will learn how to unzip files downloaded from REST endpoints and subsequently store them via FTP and to object storage. Nothing besides a configured OIC instance is required to complete this article.

Additional links

Official OIC Documentation

My OIC Repo

OIC File Server + GEN 2

ERP with OIC

Pre-requisites

Configure OIC File Server Filezilla or cyberduck

Workshop

Integration export + video

my .iar export

To use the export, you need to edit the connections, FTP directories, and REST url of object storage, along with any mappings that display a warning symbol. See monitoring for any errors during development. Be sure to track the payload when activating your integration for troubleshooting.

Video explanation

You will need to edit the following after importing, detailed below.

  • FTP, OIC REST, OCI REST connections
  • FTP connections and OCI Object storage REST connection on canvas -Any mapper that gains a wanring symbol

Connect to file server with FTP adapter

FTP adapter documentation

You can use a ssh key you upload for your user or their password. On the adapter page, you need to set the SFTP connection selectBox to yes. You can get your IP address and port from the Settings -> File Server page in your OIC instance. Make sure your user is enabled and has write access. Inside your integration, you need to use the folder for which your user has write access.

Ensure your integration users have sufficient permissions

Connect to OIC API with REST Adapter

To authenticate to OIC’s API with the REST adapter, simply base the url of your instance before /ic/home ; and use the basic auth security with the user you are logged in with, or another IDCS user that has the ’Service Administrator’ role for your OIC instance.

Connect OCI with REST adapter

Official documentation on REST adapter & signature policy

Object storage with OIC:

Part 1

  • This article shows you how to use PUT via REST in OIC, which is how we upload files to object storage in OIC.

Part 2

  • You can also use the GET verb to download files from object storage, not used in this article.

Create the scheduled integration

You can import my .iar export to get to this part.

The getOICLogs connection uses this endpoint below. You can change the id to get different files.

Download OIC logs this API endpoint

id: string
Log file identifier. Specify which file to download. 

Types:
icsflowlog: Contains information about what is happening during runtime, for active integrations that have tracing enabled.
icsdiagnosticlog: Contains information for all integrations about how the system is working. This log can be useful when you are analyzing an issue.
icsauditlog: Contains all the changes users have made on design-time artifacts such as integrations, connections, adapters, and so on. Contains information for all integrations.

You will need to change the directories in the FTP connections to write to a directory for a user you have enabled for the file server.

Within for each loop

You will need to change the directories on these two FTP adapters in the for each loop, and then for 'writeToObject' you will need to change the url to use your tenancy namespace and desired bucket.

Monitoring

After proper configuration, you should see a 'Succeeded' run of your integration in tracking.

While the for each loop shows 3 files, only 2 are written to object storage because I have the switch statement ignore the 'environment.txt' file in the unzipped folder.

In your object storage bucket, you should see files with the current date-time attached at the beginning of the file names.

What to do with your logs

You can call this OIC endpoint, and have your OIC logs stored on your embedded FTP server and/or sent to object storage for analysis by your security platform of choice, such as Oracle Management Cloud.

Congrats, you now know how to use OIC to: Download a zip file from REST API Unzip that zip file Write the contents to an FTP Server Send the contents to object storage

Connect to embedded OIC file server Use OCI object storage