Install-WashDC-Now-Assist-All copy.js

// WARNING: ONLY USE THIS SCRIPT IF YOU WANT TO INSTALL ALL APP ENGINE PRODUCTS! 

var upgradeUtil = Class.create();
upgradeUtil.prototype = {
    initialize: function () {

        // Batch Install Plan Notes;
        this.notes = 'Requested via bg script from https://github.com/dalestubblefield/sn-package-upgrade-util'

        this.log = [];

        // how many packages to process, SN only has less than 3000
        this.limit = 20000;

        this.verbosity = 2;
        /* 
         * 0 - only errors
         * 1 - extra details
         * 2 - debug
         */
    },


    upgradeAllAvailable: function (loginType, loginKey) {

       // Check if any inputs are missing
        if (!loginType) {
            (this.verbosity >= 0) && this.log.push("\nNo inputs were provided. Please provide the required inputs.");
            (this.verbosity >= 0) && this.log.push("\nLike this:\ninstallSpecificAppsUtah('admin','password')");
            (this.verbosity >= 0) && this.log.push("\n\nOr this:\ninstallSpecificAppsUtah('alias','sys_id')");
            (this.verbosity >= 0) && gs.info(this.log);
            return;
        }

        // Define package details array
        var packages = [
            {
                id: '2de9433ac33121101b074f877840dd60',
                load_demo_data: true,
                notes: 'Chat Summarization for Virtual Agent',
                requested_version: '1.2.0',
                type: 'application'
            },
            {
                id: '7cc4ec81533121106b38ddeeff7b12ee',
                load_demo_data: true,
                notes: 'Generative AI Controller',
                requested_version: '5.1.2',
                type: 'application'
            },

            {
                id: '8178fec0ce0431105a7c9305875b2dca',
                load_demo_data: true,
                notes: 'Now Assist for Creator',
                requested_version: '25.0.0',
                type: 'application'
            },

            {
                id: '7c395aaa53003110453cddeeff7b123c',
                load_demo_data: true,
                notes: 'Now Assist for Creator',
                requested_version: '2.1.1',
                type: 'application'
            },

            {
                id: '78b3f864eb703110da1861c59c522871',
                load_demo_data: true,
                notes: 'Now Assist for Platform',
                requested_version: '3.0.1',
                type: 'application'
            },

        ];

        /////////
        // check login type: username or Connection & Credential Alias
        /////////

        var basicUserName = '';
        var basicPassword = '';

        if (loginType === "") {
            this.log.push("\n ERROR: loginType is blank");
            gs.info(log);
            makeCreds();
            return;
        }

        if (loginType == "alias") {
            this.log.push("\n\n --> AUTHTYPE: Connection & Credential Alias");
            var aliasId = loginKey;

            (this.verbosity >= 2) && gs.info("\nDEBUG");

            if (!aliasId) {
                this.log.push("\n --> WARNING: C&C Alias not provided, attempting to use default");
                aliasId = '752a91887740001038e286a2681061fb'; // This is the default CICD C&C Alias
            }

            // Set basic authentication using a username and password
            var provider = new sn_cc.ConnectionInfoProvider();
            var connectionInfo = provider.getConnectionInfo(aliasId);
            if (connectionInfo != null) {
                basicUserName = connectionInfo.getCredentialAttribute("user_name");
                basicPassword = connectionInfo.getCredentialAttribute("password");

                if (!basicUserName || !basicPassword) {
                    this.log.push("\n ERROR: Connection Alias username or password issue");
                    gs.info(log);
                    makeCreds();
                    return;
                }
            } else {
                this.log.push("\n --> Connection Alias unknown issue - ABORTING!!!");
                gs.info(log);
                makeCreds();
                return;
            }
        } else {
            this.log.push("\n\n --> Authentication will be with an account");
            basicUserName = loginType.toString();
            basicPassword = loginKey.toString();
            this.log.push("\n --> User will be => " + basicUserName);
        }

        if (basicUserName == '' || basicPassword == '') {
            this.log.push("\n --> credentials not found.");
            gs.info(log);
            return;
        }


        ////////////////////////////////////////////////////////////////////////////////
        // for each package, call the API and create a Batch Install Plan per package:w
        ////////////////////////////////////////////////////////////////////////////////
        var limit = Math.min(packages.length, limit);

        // Iterate through packages array
        for (var i = 0; i < limit; i++) {
            var packageDetails = packages[i];

            // Create the payload object
            var payload = {
                name: '',
                notes: '',
                packages: [packageDetails]
            };

            // Check if package is already installed or needs an upgrade
            var packagesGr = new GlideRecord('sys_package');
            if (packagesGr.get(packageDetails.id) || packagesGr.get('source', packageDetails.id)) {
                var currentVersion = packagesGr.getValue('version');
                if (currentVersion != packageDetails.requested_version) {
                    this.log.push("\n[ ] " + packageDetails.notes + " <<< Upgrade requested ");
                    payload.name = 'Upgrade ' + packageDetails.notes + ' to ' + packageDetails.requested_version;
                    payload.notes = scriptName;
                } else {
                    this.log.push("\n[✓] " + packageDetails.notes);
                    continue;
                }
            } else {
                this.log.push("\n[ ] " + packageDetails.notes + " <<< Install requested ");
                payload.name = 'Install ' + packageDetails.notes + ' to ' + packageDetails.requested_version;
                payload.notes = scriptName;
            }

            

            // Send the payload
            var allBatchPlans = this._callAPI(payload, basicUserName, basicPassword);

            if (allBatchPlans) {
                this.log.push("\n\n --> Batch Plans: \n\n" + allBatchPlans);
            }
        }

        gs.info(this.log);

        return;
    },

        ////////////////////////////////////////////////////////////////////////////////
    // Call the API
    ////////////////////////////////////////////////////////////////////////////////
    _callAPI: function (payload, basicUserName, basicPassword) {

        //(this.verbosity >= 2) && this.log.push("\nStarting _callAPI()");
        

        var request = new sn_ws.RESTMessageV2();

        var instanceName = gs.getProperty('instance_name');
        if (instanceName.indexOf("nowlearning") !== -1) { // need to add .lab to URL
            instanceName = instanceName + ".lab";
        }

        request.setEndpoint('https://' + instanceName + '.service-now.com/api/sn_cicd/app/batch/install');
        request.setHttpMethod('POST');

        // Set basic authentication using a username and password
        request.setBasicAuth(basicUserName, basicPassword);

        // Set the request headers to accept JSON
        request.setRequestHeader("Accept", "application/json");

        // Set the request body to the JSON payload
        request.setRequestBody(JSON.stringify(payload));

        // Execute the REST API call and log the response body
        var response = request.execute();
        var statusCode = response.getStatusCode();

        // Lookup object for status code descriptions and error messages
        //         var statusMessages = {
        //             200: "200 SUCCESS: Successful. The request was successfully processed.",
        //             400: "400 ERROR: Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing).",
        //             401: "401 ERROR: The user credentials are incorrect.",
        //             403: "403 ERROR: Forbidden. The user is not an admin or does not have the sn_cicd.sys_ci_automation role.",
        //             405: "405 ERROR: Invalid method. The functionality is disabled."
        //         };

        var statusMessages = {
            200: "200 SUCCESS",
            400: "400 ERROR: Bad Request response status code",
            401: "401 ERROR: The user credentials are incorrect.",
            403: "403 ERROR: Forbidden. The user is not an admin or does not have the sn_cicd.sys_ci_automation role.",
            405: "405 ERROR: Invalid method. The functionality is disabled."
        };

        // Check if the status code exists in the lookup object
        if (statusMessages.hasOwnProperty(statusCode)) {
            if (statusCode === 200) {
                //this.log.push("... Batch Install Plan Submitted successfully.");
                this.log.push(" | Upgrade requested");
            } else {
                (this.verbosity >= 0) && this.log.push("...ERROR: Request failed with unknown status code " + statusCode + "\n");
                (this.verbosity >= 0) && gs.info(this.log);
                return;
            }
        } else {
            // Unknown status code
            (this.verbosity >= 0) && this.log.push("...ERROR: Request failed with unknown status code " + statusCode + "\n");
            (this.verbosity >= 0) && gs.info(this.log);
            return;
        }

        var responseBody = response.getBody();
        var responseBodyJSONObj = JSON.parse(responseBody);

        var responseBodyResultLinkResults = responseBodyJSONObj.result.links.results;
        for (var property in responseBodyResultLinkResults) {
            if (responseBodyResultLinkResults.hasOwnProperty(property)) {
                var value = responseBodyResultLinkResults[property];
                if (property == "id") {
                    var batchUrl = 'https://' + instanceName + '.service-now.com/nav_to.do?uri=sys_batch_install_plan.do?sys_id=' + value;
                    var allBatchPlans = 'https://' + instanceName + '.service-now.com/now/nav/ui/classic/params/target/sys_batch_install_plan_list';

                    // this.log.push("\n\n --> Batch Plan URL: \n" + batchUrl + "\n");
                    // this.log.push("\n\n --> All Batch Plans URL: \n" + allBatchPlans + "\n");
                }
            } else {
                this.log.push("\n --> UNKNOWN ERROR! responseBodyResultLinkResults.hasOwnProperty(property) did not have any properties");
            }
        }
        return allBatchPlans;
    },

    type: 'upgradeUtil'
};

////////////////////////////////////////////////////////////////////////////////
var upgradeUtil = new upgradeUtil();

// OPTION 1: DEFINE YOUR OWN CREDENTIALS
//upgradeUtil.upgradeAllAvailable('admin', 'password');

// OPTION 2: USE A CONNECTION ALIAS
upgradeUtil.upgradeAllAvailable('alias', '752a91887740001038e286a2681061fb'); // sn_cicd_spoke.CICD

// For more info => https://docs.servicenow.com/csh?topicname=cicd-api.html&version=latest