Integration SOP Document

High-level Flow

Open

SFTP setup

For any client requiring the Integration service of MS Pro, the following steps will be done at Increff’s end:

• A new user will be created on Increff’s SFTP server.

• The required IP addresses will be whitelisted. Clients may need to share the same.

• Clients will have access only to the irism-$domainName path. You won’t be able to see other organizations’ folders, nor will other organizations see yours.

File Formats

• The file formats need to exactly match the file format used during product upload. Else, the upload will fail.

• They should be uploaded in the directory corresponding to the project to which the data should be uploaded.

  • Sample directory: irism/iris1012

  • Please reach out to Increff Team to get your folder set up for a project.

• File names should be in the following format: $fileName-$date.tsv

  • Following are the filenames:

    • store

    • style

    • sku

    • daily_sales

    • storestock

    • whstock

  • The date is the run date in YYYY-MM-DD format

  • Sample filenames: 

    • store-2021-12-03.tsv

    • daily_sales-2021-12-03.tsv

Data flow setup

Pipelines are already configured to fetch the files and upload them to the product.

The following details will be required for setting up a new client:

• Trigger time: 9 am

• Trigger frequency: Daily, Weekly, etc.

• Mail id to send notifications

Notifications

On completion of the pipeline, a mail will be triggered to the mail id shared by the Client.

A table in the following structure will be sent:

Details to be shared by the client

1. Domain Name

2. Project for which Integration is to be setup

3. Trigger schedule

4. Mail IDs to send notifications

5. IP addresses that are to be whitelisted for SFTP (can also be CIDR)

Details to be shared by Increff

1. SFTP login credentials

2. Folder name for the project