Control-S: Importing SOCOTEC inspection reports

The SOCOTEC connector carries the integration class allowing the import of SOCOTEC data into CARL Source.

This connector defines the technical and functional parameters for report integration.
These elements must not be modified under any circumstances.

This connector specifies the external system EXTSYS_SO referring to the specific SOCOTEC interface.
These elements must not be modified under any circumstances and must keep their default code.

The interface carries SOCOTEC-specific data not accessible via the HMI (memo generation, etc.). These elements must not be modified.

The external system EXTSYS_SO must contain only the SOCOTEC interface.

The specific connection point for SOCOTEC is called SO-SFTP; it uses a handler class to connect to an SFTP server.

If you have your own SFTP server, the handler class of the connection point can be left to the value “Simple File”.

The SOCOTEC add-on was developed for an FTP connection before the implementation of SFTP connections.
Some codes therefore refer to the notion of “FTP” but this is only a CODE naming, it does not block SFTP operation (if the configuration has been properly set for an exchange with an SFTP server).
It is strongly recommended not to change these codes from “*_FTP” to “*_SFTP”.

If you manually import a SOCOTEC XML inspection report via the Import inspection reports action in the Interventions feature (for testing the option), you must create/use a connection point with “Handler class = Simple File” instead of the class dedicated to SFTP exchanges (only for the test duration).

Configuration of provider inspection imports

From the SOCOTEC provider detail sheet added by the SOCOTEC add-on, call the function Configuration of inspection imports.
The SOCOTEC add-on provides a complete configuration that can be adjusted as needed (for an initial installation prior to version 7.2).

If the SOCOTEC provider is not present, you must create a provider with the appropriate configuration. (See "SOCOTEC provider configuration" below)

Connection Point Configuration

On the SO_SFTP connection point, it is necessary to configure:

The URL and access port to the SOCOTEC ADVANTAGE SFTP server.
The input, output, and backup directories accessible by the CARL Source application.
The input and output directories on the SFTP server.
The login and password to use for the connection to the SFTP server.

In the case of a test with a connection point configured as Simple File:

The value for the input and output directory is case-sensitive.
The file extension is also case-sensitive; SOCOTEC provides files with the .XML extension (not .xml).
The temporary file storage directory (UploadTempDir) must be filled in and accessible by the CARL Source application.

Automatic import

In this mode, no visualization through the HMI will be offered.

The processes are then scheduled through an Automatic job to be declared in the system module.

The SOCOTEC add-on provides the process IMPORT_CTRL_SOCOTEC.
The automatic process relies on the class PROVIDCTRLIMPORTJOB.

This process is configured through the following parameters:

Provider code: provider code declared in CARL Source.
Organization code: organization code on which interventions will be generated.
Authentication string: plain (simple:...) or encrypted (crypt:........) password of the user running this process.
Example for password "demo", enter simple:demo or crypt:fe01ce2a7fbac8fafaed7c982a04e229.
Must correspond to a user using internal authentication.

The automatic process can be attached to the configuration by Organization as defined in the provider’s import configuration.
It is necessary to create as many automatic tasks as different Organization configurations to be processed.

The automatic import must be scheduled between 2 a.m. and 6 a.m. from the SOCOTEC SFTP server.

SOCOTEC provider configuration

If there is no default SOCOTEC provider in the application and SOCOTEC import is required, you must configure a dedicated provider:

Create a dedicated provider that can be named "SOCOTEC" (free code and name).
From the provider detail, go to the configuration menu and enable the "Inspection import configuration" menu entry.
Fill in the associated connector "SOCOTEC".
Keep the configuration for all organizations or adapt the following steps for each organization if necessary.
Define a Range with a grouping type diagnostic (e.g., "DIAG") to be used for creating imported interventions.
Define an operation of category "Diagnostic" (mandatory).
Define the default cost center for imported SOCOTEC interventions.
Check the options "Attach document" and "Generate follow-ups".
Indicate the dedicated automatic process IMPORT_CTRL_SOCOTEC.
For connection points, indicate the same SO-SFTP connection point for import and return information.