Create an incident/notify when a file transfer fails from MID server to SFTP server

[vdsvds]

Hey folks, 

I have a requirement to create an incident whenever an error occurs while transferring a .csv file from MID server to an SFTP server which is in a different network. I am using Export sets functionality and MID server script include to transfer the file. 

I have taken this article as a reference material for the development :

https://www.servicenow.com/community/in-other-news/using-export-sets-for-sftp-file-transfer/ba-p/228...

I have tested the file transfer and it was successful, however I'm finding it hard to create incidents when I tried this method below. Please let me know If there's a way to create incidents. I also understand this transfer will be encrypted till it reaches the sftp server (while in transit). I'm attaching few blocks of code for you guys to understand:

fileTransfer: function() {
        // transferring the file to the sftp server
        var shortDescription = '';
        var description = '';

        try {
            var localFileName = this.MIDSERVER_FILE_PATH + '/' + this.MIDSERVER_FILE_NAME;
            var remoteFileName = this.targetPath + '/' + this.MIDSERVER_FILE_NAME;
            this.log("Copying from local file of MID Server: " + localFileName);
            this.sftpFile(this.targetServer, this.targetUsername, this.targetPassword, localFileName, remoteFileName);
        } catch (e) {
            this.log("Error in writing file to SFTP server: " + e);
            shortDescription = 'Error in writing file to SFTP server';
            description = 'An error occured while attempting to write the file to the SFTP server: ' + this.targetServer + ' with an error: \n\n' + e;
            this.createIncident(shortDescription, description);
            this.log("Created an Incident for the error encountered");
        }
    },


    sftpFile: function(hostName, userName, password, localFileName, remoteFileName) {
        var shortDescription = '';
        var description = '';


        this.log('sftpFile(): attempting to connect to ' + hostName);
        var ssh = new Packages.com.sshtools.j2ssh.SshClient();
        var ignoreHost = new Packages.com.sshtools.j2ssh.transport.IgnoreHostKeyVerification();
        if (!this.targetPort) {
            this.targetPort = 22;
        }
        this.log('sftpFile(): attempting to connect to ' + hostName + " on port " + this.targetPort);

        try {
            ssh.connect(hostName, this.targetPort, ignoreHost);
            this.log("Connected to the host successfully");
        } catch (e) {
            this.log('Connection failed to the host ' + e);
            shortDescription = 'Connection failed to the host';
            description = 'An error occured while attempting to connect to the server: ' + hostName + ' with an error: \n\n' + e;
            this.createIncident(shortDescription, description);
            this.log("Created an Incident for the error encountered");
        }

        pwd = new Packages.com.sshtools.j2ssh.authentication.PasswordAuthenticationClient();
        var authPassword = new Packages.com.glide.util.Encrypter().decrypt(password);
        pwd.setUsername(userName);
        pwd.setPassword(authPassword);

        // Get full path of filename

        this.log('sftpFile(): attempting to copy ' + localFileName + ' to ' + remoteFileName);
        try {
            if (ssh.authenticate(pwd) == new Packages.com.sshtools.j2ssh.authentication.AuthenticationProtocolState().COMPLETE) {
                try {
                    sftp = ssh.openSftpClient();
                    this.log('Connection Established to the client');
                } catch (e) {
                    this.log('Unable to connect to the client ' + e);
                    shortDescription = 'Unable to connect to the client';
                    description = 'An error occured while establishing a connection to the client with an error: \n\n' + e;
                    this.createIncident(shortDescription, description);
                    this.log("Created an Incident for the error encountered");
                }
                try {
                    sftp.put(localFileName, remoteFileName);
                    this.log("File successfully copied to targert path\n\n");

                    if (this.deleteAfterUpload == "true") {
                        this.log("deleteAfterUpload -> " + this.deleteAfterUpload + ", deleting local file...");
                        new this.File(localFileName)["delete"]();
                    }

                } catch (e) {
                    this.log('FILE NOT FOUND ' + remoteFileName + ' or error: ' + e);
                    shortDescription = 'File not found error';
                    description = 'An error occured while attempting to copy file from MID server: ' + localFileName + ' to target path of the SFTP server' + remoteFileName + ' with an error: \n\n' + e;
                    this.createIncident(shortDescription, description);
                    this.log("Created an Incident for the error encountered");
                }
                sftp.quit();

                try {
                    // kill connection
                    ssh.disconnect();
                } catch (e) {
                    this.log('Manual connection kill not successful with error: ' + e);
                }
            }
        } catch (e) {
            this.log('User authentication Failed ' + e);
            shortDescription = 'User uthentication Failed';
            description = 'An error occured while authenticating with the server: ' + hostName + ' with an error: \n\n' + e;
            this.createIncident(shortDescription, description);
            this.log("Created an Incident for the error encountered");

Please let me know your inputs,

Thank you,

Suhail

[tirtha1]

Hi Suhail,

Could you share more details on the createIncident function getting called on the mid server script include here? It is a function defined on the same script or another mid sever script include all together?  

Regards,

Tirtho

[vdsvds]

createIncident: function(shortDescription, description) {
        var inc = new GlideRecord('incident');
        //inc.addEncodedQuery('sys_created_onONToday@javascript:gs.beginningOfToday()@javascript:gs.endOfToday()^short_descriptionLIKEBatch Integration Failure');
        //inc.query();
        //if (!inc.next()) {
            inc.initialize();
            inc.caller = '';
            inc.assignment_group = '';
            inc.description = description;
            inc.short_description = 'Batch Integration Failure - ' + shortDescription;
            inc.priority = '';
            inc.insert();
        //}

We moved away from doing a Batch integration due to security concerns. This is what I had written at the time, you can modify it as per your needs. Remember to always check for any incidents already created, if not then create an incident.

[Sharma7]

Hi 
I am also trying to do this Integration. I have seen your code and also the community post you have attached, but every time I'm getting "The Transport Protocol thread failed
java.io.IOException: The socket is EOF" error. Could you pls help with this.

[Sharma7]

Hi
I'm also trying this and I have followed all the steps but it's not working for me.
getting this error: The Transport Protocol thread failed
java.io.IOException: The socket is EOF