ASIM (Omni Integration Api Simulator)

Purpose

ASIM is a tool created by Increff to aid clients in testing their integration with Increff’s standard set of APIs known as Omni Magic and any other integrations that interact with Increff Omni. It will provide the clients a platform to trigger and test their end APIs, in initial phases of testing. This way the clients can independently test out their flows of ERP or Ecommerce without being dependent on Increff.

Video Tutorial

ERP Flow
Sign In and Sign Up
Using ASIM for Integrations
E-commerce Configurations
E-commerce Handover
E-commerce Inventory
E-commerce Manifest
E-commerce Order Processing
E-commerce Return Flow
E-commerce Schedulars
E-commerce Search Order
ERP - Posting Interfaces

Registration

ASIM Url: https://staging-asim.increff.com/asim/ui

To login:

Go to the above URL and click on Sign Up.
Fill in the details and submit.
Verification mail will be sent to you.
Create users for your organization to sign in to ASIM.

Add Users

Account Server Url: https://services.increff.com/account/

Application Name: asim

For allowing people from your organisation to login into asim, their respective user needs to be created in the account server.

Go to the above url and use the above given application name and submit.
Now enter the org Id which was given at the time of registration.
Login using the admin account
Go to user and click on create new user.
Fill the user details and select the login method( google account or (username/password))
After successful user creation, click on the username and give the standard role.

Login

ASIM Url: https://staging-asim.increff.com/asim/ui

To login:

Go to the above URL and click on Sign In.
Next enter your organization Id.
Enter user details - username and password.

Omni Magic Configurations `

Magic URL Configuration

Client URL Configurations: All the endpoints that the client is creating for Omni Magic to hit need to be configured in Magic URL configuration screen

Nuances

Please note the following points in regards to ASIM:

It is just to test the integration workflows and is not the representation of the Increff Omni system.
It does not maintain any object states like pack, cancelled, manifested statuses.
It is a system that just triggers integration workflows based on input given for helping with client testing.
History feature is to give the client a record of the inputs and outputs of the actions performed and these are not to be treated as system logs.

Common Flows

Article Master Creation

This screen does the following:

Allows clients to upload client master data from UI.
Gives visibility of the clients of the article masters created. (This can be via the Omni Magic article master API or the UI here)
History against each article master like creation data and update data.

E-Commerce Flows

Configuration

This UI screen enables the client to create their E-Commerce channel with the name they want and enter credentials in the form of key value pair that will be used by the integration for authentication with client side APIs. Please note that this is a one time process for the integration you are testing. If the organization wishes to test another integration as well from this account they can create a new channel.

Configuration Detail View

From the configuration screen you can select the channel whose detailed view you want to see and you will be redirected to the detail view screen. This screen has four sections as mentioned below:

Channel details like channel name and channel type.
Channel Login Credentials - these are the credentials the integration will use to authenticate with the client side. Also,in case of integrations other than Omni Magic you can trigger the test credentials call from here to ensure that dynamic credentials are getting generated.
Increff Login Credentials - these are the credentials clients can use to push data to the integration.
Locations - these are the location Ids or warehouse Ids against which orders can be created in the integration. A client can add these locations from this screen itself.

Inventory

This screen allows one to update inventory against a specific location. One can select a channel, enter a warehouse Id and upload a csv file which takes in channel sku code, channel serial number and quantity to update to the e-commerce portal. The csv template can be downloaded from this screen itself. On submitting this data client side update inventory call will be triggered.

Integration Schedulers

This screen is to trigger all the bulk order calls that are available in CIMS in the form of schedulers. This is to be used only in integrations other than Omni Magic. To trigger these calls you need to select the channel and submit to fetch relevant channel data. The following flows can be triggered from this screen by selecting the location:

Fetch new orders - to get new orders from the integration to ASIM.
Fetch pending orders - to get pending/missed orders from the integration to ASIM.
Fetch cancelled orders - to get cancelled orders from the integration to ASIM.
Sync order statuses - to sync order parameters from the integration to ASIM. For this call to be triggered you need to attach an order Id file as well besides selecting the location. File format can be downloaded from the screen itself/
Force sync orders - sync a specific order from integration by providing a specific order Id and location.

Search Outward Orders

This screen is to view the details of the orders that the client has created against any channel successfully. You can look for a particular order, you can search for it using channel order id or channel name. The following details are visible:

Order details like order code, location code, order time, channel name.
For details of SLA, start processing time, line item details one can click on order to see more granular data.
History of order that is all the operations that happened against the order can also be seen from here.

Process Outward Orders

This screen is to process the orders that the client has created in ASIM. You need to enter the order code of the order you want to process. All orders with the searched order Id will be displayed along with their channel name. On clicking the order the following options are available:

History: of order that is all the operations that happened against the order can also be seen from here.
Order Actions:
- Trigger order acknowledgement.
- Sync order status from channel.
- Trigger seller cancellation, you can give the cancellation quantity as input at an item level
Pack Order:
- Trigger pack order call with the required quantity as input.
Order Pack Slip:
- Get Shipment: this will take shipment code as input and trigger invoice, shipping label details call and also fetch the document into the ASIM system.
- Download Shipping Label: It will download the last shipping label document fetched against the order, and will throw an error in case there is no document present.
- Download Invoice: It will download the last invoice document fetched against the order, and will throw an error in case there is no document present.

Manifest

This screen is to create manifest and view the details of the created manifest created by the client. If you are looking for a particular already created manifest you can search for it as well.

Manifest Creation:

Client needs to select channel name followed by entering the transporter name, location code and then add the order details of the orders that need to be associated in the manifest.
On submission, a create manifest call will be triggered from Omni Magic to the E-Commerce channel.

The following details are visible once you search for a created manifest:

Get Manifest: This button will trigger the get manifest call from Omni Magic to the E-Commerce channel.
Download Invoice: It will download the last manifest document fetched against the manifest Id, and will throw an error in case there is no document present.
History of the manifest that is all the operations that happened against the manifest.

Handover

This screen is to create a handover and view the details of handovers already triggered. History of the recent handovers triggered from ASIM can be seen by selecting the channel and then on the History button click.

Handover Creation:

Client needs to select channel name followed by entering the transporter name, location code and then add the order details of the orders that need to be associated in the handover.
On submission, a handover call will be triggered from Omni Magic to E-Commerce channel.

Search Return Orders

This screen is to view the details of the returns orders that the client has created in ASIM successfully. If you are looking for a particular return order you can search for it as well using return order Id or channel name. The following details are visible:

Return Order details like return order code, order code, location code, return order time.
For details of tracking Id, transporter, return line item details one can click on return order to see more granular data.
History of the return order that is all the operations that happened against the return order can also be seen from here.

Process Return Orders

This screen is to process the orders that the client has created in ASIM. You need to enter the order code of the order you want to process. On clicking the order the following options are available:

History: of order that is all the operations that happened against the order can also be seen from here.
Return Order Acknowledgement: is triggered on the button click.
Return Order Items Acknowledgement: It takes QC status of item as input that is Pass or Fail and triggers return order item ack call from Omni Magic to E-Commerce channel.

ERP Flows

Configuration

This UI screen enables the client to create their ERP channel with the name they want and enter credentials in the form of key value pair that will be used by the integration for authentication with client side APIs. Please note that this is a one time process for the integration you are testing. If the organization wishes to test another integration as well from this account they can create a new channel.

Configuration Detail View

From the configuration screen you can select the channel whose detailed view you want to see and you will be redirected to the detail view screen. This screen has four sections as mentioned below:

Channel details like channel name and channel type.
Channel Login Credentials - these are the credentials the integration will use to authenticate with the client side. Also,in case of integrations other than Omni Magic you can trigger the test credentials call from here to ensure that dynamic credentials are getting generated.
Increff Login Credentials - these are the credentials clients can use to push data to the integration.
Locations - these are the location Ids or warehouse Ids against which orders can be created in the integration. A client can add these locations from this screen itself.
ERP Channel Mapping - these are the ERP customer mappings against marketplaces needed at the time of data posting from integration to ERP. A client can add these channel mappings from this screen itself.

Inward Orders

This screen is to view the details of the orders that the client has created in ASIM successfully. If you are looking for a particular order you can search for it as well using inward order Id or channel name. The following details are visible:

Order details like order code, channel name, location code, warehouse code.
For details of line items, partner data one can click on order to see more granular data.
History of order that is all the operations that happened against the order can also be seen from here.

GRN Posting

This screen is to trigger FRN data posting against inward orders that the client has created in ASIM successfully. You can search for the inward order you want to trigger an update for. History of all the GRN postings against that inward order can also be seen from here.The following types of GRN postings can be triggered on csv upload from here:

Order Wise
Gate Entry Wise
Notifications

B2B Outward Order

This screen is to view the details of the orders that the client has created in ASIM successfully. If you are looking for a particular order you can search for it as well using inward order Id or channel name. The following details are visible:

Order details like order code, channel name, location code, warehouse code.
For details of line items, partner data one can click on order to see more granular data.
One can upload a csv which has the pack quantity and the corresponding B2B order posting will be triggered to ERP.

(Note: for posting b2c order posting, a channel mapping has to be created in the configuration page for the erp channel as this b2b order came for the erp channel. So a channelCode is to be provided against the erp channel name which was created on initialize and is visible in the erp config page as well)

History of order that is all the operations that happened against the order can also be seen from here.

B2C Sales Posting

This screen is to trigger sales posting against marketplaces to client ERP. The process is as follows:

Select and submit the ERP channel from the dropdown to fetch channel details.
Next the client needs to select the channel mapping from the dropdown and the locationCode against which they want to take the b2c posting.
The rest of the B2C order details are picked up and an update is triggered to ERP.

B2C Returns Posting

This screen is to trigger return sales posting against marketplaces to client ERP. The process is as follows:

Select and submit the ERP channel from the dropdown to fetch channel details.
Next the client needs to select the channel mapping from the dropdown and the locationCode against which they want to take the b2c posting.
The rest of the return B2C order details are picked up and an update is triggered to ERP.