About

The FacilityTaskExchaneApi is the link between the SonWIn Installation Management Electricity Service and the PartnerPortal. 
It serves as the accesspoint for the SonWIn application to send data to the portal. 

The service is hosted in Azure and transfers incomming data to teh integration api, which handles the further communication with the backend.

Configuration

In order to configure the service, use the guide for viewing and editing a file (Found in this document) and open  the file named Config.Json

In the left view you can see the content of the file and edit it if you need to do so. 
BE AWARE THAT THE APPLICATION SAVES YOUR CHANGES AUTOMATICLY, DONT CHANGE ANYTHING WITHOUT BEING SURE.

The configuration file have the following elements :

KeyValuesDescriptionComment
LogTypeFILEType of logging
LogFileMaxDaysnThe number of days that the log file  lives before it is archived by renaming it, after wich a new log file is created.
GDPRLogFileMaxDaysnNumber of days before log files are deleted
FullXmlLogTRUE/FALSEIf true, then logs the full xml reveived to the log file. (Helpfull for debugging but takes a log of space in the log file)
InputValidationTRUE/FALSEValidate the input comming from SonWin
ApiCommunicationTypePRODUCTION/DEBUGSend data to the integration api for production. (Adding to the database etc, DEBUG is only used when developing)
ApiBaseAdressURLThe adresse of the endpoint to communicate to (Integration Api)
ApiExceptionHandlingTRUE/FALSEIf true then the service will throw an exception to the client if anything goes wrong, causing the client to try to resend the message.
IntegrationApiTokenString token

This is the token that have to be used when communicating to the integration api. 

The service will not function without it.



After having made a change to the configuration, it will be a good idea to restart the service. 
Restarting the service is done by clicking the Menu point Overview and then clicking the menu point in the ribbon named Restart

A restart normally takes app 10 seconds MAX.

Log

If logging have been enabled in the configuration file, the service will log to a file located in the hosting environment named FacilityTaskExchangeApi.Log. 
To view the logfile, use the App Service Editor and click the file in teh root view: 

App Service Editor (File Editor)

In order to view and edit files on the server, one can use the App Service Editor. 
It is found in the following way:

To view the content of a file, please navigate to it by following this procedure:

  1. Open http://portal.azure.com
  2. Log in with your credentials
  3. Locate the environment that you want to access and (Usually PROD)
  4. Click the FacilityTaskExchangeApi

  5. In the left most menu pane, scroll down untill you reach the menu named DevelopmentTools, open it and click the sub-menu named App Service Editor

  6. In the window to the right click the link named Open Editor

  7. In the window that opens select the file ypou want to view

Ip Whitelisting

For a client machine to connect to, and communicate with teh service, the sending machine public ip adress should be added to the whiletist, otherwise it will be rejected. 

To add a new Ip adress to the service whitelist follow this procedure:

  1. Open http://portal.azure.com
  2. Log in with your credentials
  3. Locate the environment that you want to access and (Usually PROD)
  4. Click the FacilityTaskExchangeApi
  5. In the left most panel, locate and expand the menu item named Settings then click the sub-menu item Networking

  6. In the opened view, click the link shown in the picture:

  7. Scroll to the bottom and check if an element matching your machine is in the list. 
    1. If present
      1. Click the element of your machine
      2. In the panel that appears, change the ip adress in the field named IP Address Block
      3. Click Update Rule
    2. If not:
      1. Click Add
      2. Fill out the fields in the panel that apears to the right
        (ALWAYS FILL IN A NAME THAT MAKES SENCE SINCE MAINTAINING WILL BE IMPOSSIBLE IF YOU DONT - PLEASE FOLLOW THE ONES ALLREADY MADE)
      3. Click Add rule
  8. Scroll to the top of the main page
  9. Click SAVE

A restart should not be nessesary but it never killed anyone to do so.

Services in the hosted environments

The services have different names regarding what environment they are hosted in. 

Here is a list of the names: 

HostingService name
PRODFacilityTaskExchangeApiPROD
TESTFacilityTaskExchangeApiTEST
STAGINGFacilityTaskExchangeApiSTAG
DEVFacilityTaskExchangeApiDEV