case 4504

src/api/biz-role-rights.js

@@ -44,5 +44,6 @@ export default {
   Purchase: { Change: 32842, ReadFullRecord: 65797, Select: 131071 },
   Product: { Change: 32842, ReadFullRecord: 65797, Select: 131071 },
   GZCase: { Change: 32842, ReadFullRecord: 65797, Select: 131071 },
-  VendorNotification: { Change: 32842, ReadFullRecord: 65797, Select: 131071 }
+  VendorNotification: { Change: 32842, ReadFullRecord: 65797, Select: 131071 },
+  Subscription: { Change: 32842, ReadFullRecord: 65797, Select: 131071 }
 };

src/api/gzutil.js

@@ -461,6 +461,9 @@ export default {
         return "$sockiBarCode";
       case window.$gz.type.GZCase:
         return "$sockiCoffee";
+      case window.$gz.type.Subscription:
+        return "$sockiFileContract";
+        
 
       //scroll icon is good one for something
       default:

src/api/initialize.js

@@ -168,6 +168,14 @@ ServiceContractor = 5 */
 
   sub = [];
 
+
+  sub.push({
+    title: "SubscriptionList",
+    icon: "$sockiFileContract",
+    route: "/biz-subscription-list",
+    key: key++
+  });
+
   sub.push({
     title: "GZCaseList",
     icon: "$sockiCoffee",

src/api/socktype.js

@@ -37,7 +37,8 @@ export default {
   Purchase: 96,
   Product: 97,
   GZCase: 98,
-  VendorNotification: 99
+  VendorNotification: 99,
+  Subscription: 100
 };
 /**
  *

src/api/translation.js

@@ -263,7 +263,8 @@ export default {
     "ProductList",
     "PurchaseList",
     "GZCaseList",
-    "VendorNotificationList"
+    "VendorNotificationList",
+    "SubscriptionList"
   ],
 
   ////////////////////////////////////////////////////////

src/router.js

@@ -423,6 +423,18 @@ export default new Router({
       component: () =>
         import(/* webpackChunkName: "biz" */ "./views/biz-gzcase.vue")
     },
+    {
+      path: "/biz-subscription-list",
+      name: "biz-subscription-list",
+      component: () =>
+        import(/* webpackChunkName: "biz" */ "./views/biz-subscription-list.vue")
+    },
+    {
+      path: "/biz-subscription-list/:recordid",
+      name: "subscription-edit",
+      component: () =>
+        import(/* webpackChunkName: "biz" */ "./views/biz-subscription.vue")
+    },
     // //####################### SERVICE GROUP ##############################
     // {
     //   path: "/svc-schedule",

src/views/biz-subscription-list.vue

@@ -0,0 +1,184 @@
+<template>
+  <div>
+    <gz-report-selector ref="reportSelector"></gz-report-selector>
+    <gz-extensions
+      ref="extensions"
+      :aya-type="aType"
+      :selected-items="selectedItems"
+    >
+    </gz-extensions>
+    <gz-data-table
+      ref="gzdatatable"
+      form-key="subscription-list"
+      data-list-key="SubscriptionDataList"
+      :show-select="rights.read"
+      :reload="reload"
+      data-cy="subscriptionsTable"
+      :client-criteria="clientCriteria"
+      :pre-filter-mode="preFilterMode"
+      @selection-change="handleSelected"
+      @clear-pre-filter="clearPreFilter"
+    >
+    </gz-data-table>
+  </div>
+</template>
+
+<script>
+const FORM_KEY = "subscription-list";
+export default {
+  data() {
+    return {
+      rights: window.$gz.role.defaultRightsObject(),
+      aType: window.$gz.type.Subscription,
+      selectedItems: [],
+      reload: false,
+      clientCriteria: undefined,
+      preFilterMode: null,
+      objectId: null,
+      aForType: null,
+      name: null
+    };
+  },
+  created() {
+    this.rights = window.$gz.role.getRights(window.$gz.type.Subscription);
+    window.$gz.eventBus.$on("menu-click", clickHandler);
+
+    //------ pre-filter ----
+    //OPTIONAL "Show All subscriptions of head office" FILTER
+    this.objectId = window.$gz.util.stringToIntOrNull(
+      this.$route.params.objectId
+    );
+    this.aForType = window.$gz.util.stringToIntOrNull(this.$route.params.aType);
+
+    if (this.objectId && this.objectId != 0 && this.aForType) {
+      //OBJECTID,AYATYPE
+      this.clientCriteria = `${this.objectId},${this.aForType}`;
+
+      this.preFilterMode = {
+        icon: window.$gz.util.iconForType(this.aForType),
+        id: this.objectId,
+        socktype: this.aForType,
+        viz: this.$route.params.name,
+        clearable: true
+      };
+    }
+    //------ /pre-filter ----
+    generateMenu(this);
+  },
+  beforeDestroy() {
+    window.$gz.eventBus.$off("menu-click", clickHandler);
+  },
+  methods: {
+    handleSelected(selected) {
+      this.selectedItems = selected;
+    },
+    clearPreFilter() {
+      this.clientCriteria = null;
+      this.preFilterMode = null;
+      this.reload = !this.reload;
+    }
+  }
+};
+
+/////////////////////////////
+//
+//
+async function clickHandler(menuItem) {
+  if (!menuItem) {
+    return;
+  }
+  const m = window.$gz.menu.parseMenuItem(menuItem);
+  if (m.owner == FORM_KEY && !m.disabled) {
+    switch (m.key) {
+      case "new":
+        m.vm.$router.push({
+          name: "subscription-edit",
+          params: { recordid: 0 }
+        });
+        break;
+      case "extensions":
+        {
+          const res = await m.vm.$refs.extensions.open(
+            m.vm.$refs.gzdatatable.getDataListSelection(
+              window.$gz.type.Subscription
+            )
+          );
+          if (res && res.refresh == true) {
+            m.vm.reload = !m.vm.reload;
+          }
+        }
+        break;
+      case "report":
+        {
+          const res = await m.vm.$refs.reportSelector.open(
+            m.vm.$refs.gzdatatable.getDataListSelection(
+              window.$gz.type.Subscription
+            ),
+            m.id
+          );
+          if (res == null) {
+            return;
+          }
+          window.$gz.form.setLastReportMenuItem(FORM_KEY, res, m.vm);
+        }
+        break;
+      default:
+        window.$gz.eventBus.$emit(
+          "notify-warning",
+          FORM_KEY + "::context click: [" + m.key + "]"
+        );
+    }
+  }
+}
+
+//////////////////////
+//
+//
+function generateMenu(vm) {
+  const menuOptions = {
+    isMain: true,
+    icon: "$sockiFileContract",
+    title: "SubscriptionList",
+    menuItems: [],
+    formData: {
+      sockType: window.$gz.type.Subscription
+    }
+  };
+
+  if (vm.rights.change) {
+    menuOptions.menuItems.push({
+      title: "New",
+      icon: "$sockiPlus",
+      surface: true,
+      key: FORM_KEY + ":new",
+      vm: vm
+    });
+  }
+
+  menuOptions.menuItems.push({
+    title: "Report",
+    icon: "$sockiFileAlt",
+    key: FORM_KEY + ":report",
+    vm: vm
+  });
+
+  const lastReport = window.$gz.form.getLastReport(FORM_KEY);
+  if (lastReport != null) {
+    menuOptions.menuItems.push({
+      title: lastReport.name,
+      notrans: true,
+      icon: "$sockiFileAlt",
+      key: FORM_KEY + ":report:" + lastReport.id,
+      vm: vm
+    });
+  }
+
+  menuOptions.menuItems.push({
+    title: "Extensions",
+    icon: "$sockiPuzzlePiece",
+    key: FORM_KEY + ":extensions",
+    vm: vm
+  });
+  window.$gz.eventBus.$emit("menu-change", menuOptions);
+}
+</script>

src/views/biz-subscription.vue

@@ -0,0 +1,550 @@
+<template>
+  <div>
+    <gz-report-selector ref="reportSelector"></gz-report-selector>
+    <div v-if="formState.ready">
+      <gz-error :error-box-message="formState.errorBoxMessage"></gz-error>
+      <v-form ref="form">
+        <v-row dense>
+          <v-col cols="12" sm="6" lg="4" xl="3">
+            <gz-pick-list
+              ref="customerId"
+              v-model="obj.customerId"
+              :aya-type="sockTypes().Customer"
+              show-edit-icon
+              :readonly="formState.readOnly"
+              :label="$sock.t('Customer')"
+              :error-messages="form().serverErrors(this, 'customerId')"
+              :rules="[form().required(this, 'customerId')]"
+              @input="fieldValueChanged('customerId')"
+            ></gz-pick-list>
+          </v-col>
+
+         
+          <v-col cols="12" sm="6" lg="4" xl="3">
+            <v-select
+              ref="pGroup"
+              v-model="obj.pGroup"
+              dense
+              :items="selectLists.pGroups"
+              item-text="name"
+              item-value="id"
+              :readonly="formState.readOnly"
+              :label="$sock.t('ProductGroup')"
+              data-cy="pGroup"
+              :rules="[form().integerValid(this, 'pGroup')]"
+              :error-messages="form().serverErrors(this, 'pGroup')"
+              @input="fieldValueChanged('pGroup')"              
+            ></v-select>
+          </v-col>
+
+ <v-col cols="12" sm="6" lg="4" xl="3">
+            <v-text-field
+              ref="subsite"
+              v-model="obj.subsite"
+              dense
+              :readonly="formState.readOnly"
+              :label="$sock.t('SubSite')"
+              :error-messages="form().serverErrors(this, 'subsite')"
+              data-cy="subsite"
+              @input="fieldValueChanged('subsite')"
+            ></v-text-field>
+          </v-col>
+
+          <v-col v-if="form().showMe(this, 'Notes')" cols="12">
+            <v-textarea
+              ref="notes"
+              v-model="obj.notes"
+              dense
+              :readonly="formState.readOnly"
+              :label="$sock.t('ContractNotes')"
+              :error-messages="form().serverErrors(this, 'notes')"
+              data-cy="notes"
+              auto-grow
+              @input="fieldValueChanged('notes')"
+            ></v-textarea>
+          </v-col>
+
+          <v-col cols="12" sm="6" lg="4" xl="3">
+            <v-checkbox
+              ref="active"
+              v-model="obj.active"
+              dense
+              :readonly="formState.readOnly"
+              :label="$sock.t('Active')"
+              data-cy="active"
+              :error-messages="form().serverErrors(this, 'active')"
+              @change="fieldValueChanged('active')"
+            ></v-checkbox>
+          </v-col>
+          <!-- --------------------------------- -->
+
+          <v-col v-if="form().showMe(this, 'Tags')" cols="12">
+            <gz-tag-picker
+              ref="tags"
+              v-model="obj.tags"
+              :readonly="formState.readOnly"
+              data-cy="tags"
+              :error-messages="form().serverErrors(this, 'tags')"
+              @input="fieldValueChanged('tags')"
+            ></gz-tag-picker>
+          </v-col>
+
+          <v-col v-if="form().showMe(this, 'Attachments') && obj.id" cols="12">
+            <gz-attachments
+              :readonly="formState.readOnly"
+              :aya-type="sockType"
+              :aya-id="obj.id"
+            ></gz-attachments
+          ></v-col>
+        </v-row>
+      </v-form>
+    </div>
+    <v-overlay :value="!formState.ready || formState.loading">
+      <v-progress-circular indeterminate :size="64" />
+    </v-overlay>
+  </div>
+</template>
+<script>
+const FORM_KEY = "subscription-edit";
+const API_BASE_URL = "subscription/";
+const FORM_CUSTOM_TEMPLATE_KEY = "Subscription";
+export default {
+  data() {
+    return {
+      formCustomTemplateKey: FORM_CUSTOM_TEMPLATE_KEY,
+      obj: {
+        id: 0,
+        concurrency: 0,
+        customerId: 0,
+        pGroup: null,
+        active: true,
+        subsite: null,
+        notes: null,
+        tags: []
+      },
+      formState: {
+        ready: false,
+        dirty: false,
+        valid: true,
+        readOnly: false,
+        loading: true,
+        errorBoxMessage: null,
+        appError: null,
+        serverError: {}
+      },
+      rights: window.$gz.role.defaultRightsObject(),
+      sockType: window.$gz.type.Subscription,
+      selectLists: {
+        pGroups: []
+      }
+    };
+  },
+  watch: {
+    formState: {
+      handler: function(val) {
+        if (this.formState.loading) {
+          return;
+        }
+
+        if (val.dirty && val.valid && !val.readOnly) {
+          window.$gz.eventBus.$emit("menu-enable-item", FORM_KEY + ":save");
+        } else {
+          window.$gz.eventBus.$emit("menu-disable-item", FORM_KEY + ":save");
+        }
+
+        if (!val.dirty && val.valid && !val.readOnly) {
+          window.$gz.eventBus.$emit(
+            "menu-enable-item",
+            FORM_KEY + ":duplicate"
+          );
+          window.$gz.eventBus.$emit("menu-enable-item", FORM_KEY + ":new");
+        } else {
+          window.$gz.eventBus.$emit(
+            "menu-disable-item",
+            FORM_KEY + ":duplicate"
+          );
+          window.$gz.eventBus.$emit("menu-disable-item", FORM_KEY + ":new");
+        }
+      },
+      deep: true
+    }
+  },
+  async created() {
+    const vm = this;
+    try {
+      await initForm(vm);
+      vm.rights = window.$gz.role.getRights(window.$gz.type.Subscription);
+      vm.formState.readOnly = !vm.rights.change;
+      window.$gz.eventBus.$on("menu-click", clickHandler);
+      //---------------------------------
+      let setDirty = false;
+      //id 0 means create or duplicate to new
+      if (vm.$route.params.recordid != 0) {
+        //is there already an obj from a prior operation?
+        if (this.$route.params.obj) {
+          //yes, no need to fetch it
+          this.obj = this.$route.params.obj;
+        } else {
+          await vm.getDataFromApi(vm.$route.params.recordid);
+        }
+      } else {
+        //Might be a duplicate and contain another record
+        if (this.$route.params.obj) {
+          this.obj = this.$route.params.obj;
+          this.obj.concurrency = undefined;
+          this.obj.id = 0;
+          this.obj.name = `${this.obj.name} - ${window.$gz.translation.get(
+            "Copy"
+          )}`;
+          setDirty = true;
+        }
+      }
+      window.$gz.form.setFormState({
+        vm: vm,
+        loading: false,
+        dirty: setDirty,
+        valid: true
+      });
+      //----------------------------
+      generateMenu(vm);
+    } catch (error) {
+      window.$gz.errorHandler.handleFormError(error, vm);
+    } finally {
+      vm.formState.ready = true;
+    }
+  },
+  async beforeRouteLeave(to, from, next) {
+    if (!this.formState.dirty || JUST_DELETED) {
+      next();
+      return;
+    }
+    if ((await window.$gz.dialog.confirmLeaveUnsaved()) === true) {
+      next();
+    } else {
+      next(false);
+    }
+  },
+  beforeDestroy() {
+    window.$gz.eventBus.$off("menu-click", clickHandler);
+  },
+  methods: {   
+    openVendorNotification: function() {
+      window.$gz.eventBus.$emit("openobject", {
+        type: window.$gz.type.VendorNotification,
+        id: this.obj.vendorNotificationId
+      });
+    },
+    canSave: function() {
+      return this.formState.valid && this.formState.dirty;
+    },
+    canDuplicate: function() {
+      return this.formState.valid && !this.formState.dirty;
+    },
+    sockTypes: function() {
+      return window.$gz.type;
+    },
+    form() {
+      return window.$gz.form;
+    },
+    fieldValueChanged(ref) {
+      if (
+        this.formState.ready &&
+        !this.formState.loading &&
+        !this.formState.readOnly
+      ) {
+        window.$gz.form.fieldValueChanged(this, ref);
+      }
+    },
+    async getDataFromApi(recordId) {
+      const vm = this;
+      window.$gz.form.setFormState({
+        vm: vm,
+        loading: true
+      });
+      if (!recordId) {
+        throw new Error(FORM_KEY + "::getDataFromApi -> Missing recordID!");
+      }
+      try {
+        window.$gz.form.deleteAllErrorBoxErrors(vm);
+        const res = await window.$gz.api.get(API_BASE_URL + recordId);
+        if (res.error) {
+          if (res.error.code == "2010") {
+            window.$gz.form.handleObjectNotFound(vm);
+          }
+          vm.formState.serverError = res.error;
+          window.$gz.form.setErrorBoxErrors(vm);
+        } else {
+          vm.obj = res.data;
+          generateMenu(vm);
+          window.$gz.form.setFormState({
+            vm: vm,
+            dirty: false,
+            valid: true,
+            loading: false
+          });
+        }
+      } catch (error) {
+        window.$gz.errorHandler.handleFormError(error, vm);
+      } finally {
+        window.$gz.form.setFormState({
+          vm: vm,
+          loading: false
+        });
+      }
+    },
+    async submit() {
+      const vm = this;
+      if (vm.canSave == false) {
+        return;
+      }
+      try {
+        window.$gz.form.setFormState({
+          vm: vm,
+          loading: true
+        });
+        window.$gz.form.deleteAllErrorBoxErrors(vm);
+        const res = await window.$gz.api.upsert(API_BASE_URL, vm.obj);
+        if (res.error) {
+          vm.formState.serverError = res.error;
+          window.$gz.form.setErrorBoxErrors(vm);
+        } else {
+          if (res.data.id) {
+            //POST
+            vm.obj = res.data;
+            this.$router.replace({
+              name: "subscription-edit",
+              params: {
+                recordid: res.data.id,
+                obj: res.data
+              }
+            });
+          } else {
+            //PUT
+            vm.obj.concurrency = res.data.concurrency;
+          }
+          window.$gz.form.setFormState({
+            vm: vm,
+            dirty: false,
+            valid: true
+          });
+        }
+      } catch (ex) {
+        window.$gz.errorHandler.handleFormError(ex, vm);
+      } finally {
+        window.$gz.form.setFormState({
+          vm: vm,
+          loading: false
+        });
+      }
+    },
+    async remove() {
+      try {
+        const dialogResult = await window.$gz.dialog.confirmDelete();
+        if (dialogResult != true) {
+          return;
+        }
+        window.$gz.form.setFormState({
+          vm: this,
+          loading: true
+        });
+
+        if (this.$route.params.recordid == 0) {
+          JUST_DELETED = true;
+
+          this.$router.go(-1);
+        } else {
+          window.$gz.form.deleteAllErrorBoxErrors(this);
+          const res = await window.$gz.api.remove(
+            API_BASE_URL + this.$route.params.recordid
+          );
+          if (res.error) {
+            this.formState.serverError = res.error;
+            window.$gz.form.setErrorBoxErrors(this);
+          } else {
+            JUST_DELETED = true;
+            this.$router.go(-1);
+          }
+        }
+      } catch (error) {
+        window.$gz.errorHandler.handleFormError(error, this);
+      } finally {
+        window.$gz.form.setFormState({
+          vm: this,
+          loading: false
+        });
+      }
+    },
+    duplicate() {
+      this.$router.push({
+        name: "subscription-edit",
+        params: {
+          recordid: 0,
+          obj: this.obj
+        }
+      });
+    }
+  }
+};
+
+/////////////////////////////
+//
+//
+async function clickHandler(menuItem) {
+  if (!menuItem) {
+    return;
+  }
+  const m = window.$gz.menu.parseMenuItem(menuItem);
+  if (m.owner == FORM_KEY && !m.disabled) {
+    switch (m.key) {
+      case "save":
+        m.vm.submit();
+        break;
+      case "delete":
+        m.vm.remove();
+        break;
+      case "new":
+        m.vm.$router.push({
+          name: "subscription-edit",
+          params: { recordid: 0 }
+        });
+        break;
+      case "duplicate":
+        m.vm.duplicate();
+        break;
+      case "report":
+        {
+          const res = await m.vm.$refs.reportSelector.open(
+            {
+              AType: window.$gz.type.Subscription,
+              selectedRowIds: [m.vm.obj.id]
+            },
+            m.id
+          );
+          if (res == null) {
+            return;
+          }
+          window.$gz.form.setLastReportMenuItem(FORM_KEY, res, m.vm);
+        }
+        break;
+
+      default:
+        window.$gz.eventBus.$emit(
+          "notify-warning",
+          FORM_KEY + "::context click: [" + m.key + "]"
+        );
+    }
+  }
+}
+
+//////////////////////
+//
+//
+function generateMenu(vm) {
+  const menuOptions = {
+    isMain: false,
+    readOnly: vm.formState.readOnly,
+    icon: "$sockiFileContract",
+    title: "Subscription",
+    formData: {
+      sockType: window.$gz.type.Subscription,
+      recordId: vm.$route.params.recordid,
+      formCustomTemplateKey: FORM_CUSTOM_TEMPLATE_KEY,
+      recordName: vm.obj.name
+    },
+    menuItems: []
+  };
+
+  if (vm.rights.change) {
+    menuOptions.menuItems.push({
+      title: "Save",
+      icon: "$sockiSave",
+      surface: true,
+      key: FORM_KEY + ":save",
+      vm: vm
+    });
+  }
+
+  menuOptions.menuItems.push({
+    title: "Report",
+    icon: "$sockiFileAlt",
+    key: FORM_KEY + ":report",
+    vm: vm
+  });
+
+  const lastReport = window.$gz.form.getLastReport(FORM_KEY);
+  if (lastReport != null) {
+    menuOptions.menuItems.push({
+      title: lastReport.name,
+      notrans: true,
+      icon: "$sockiFileAlt",
+      key: FORM_KEY + ":report:" + lastReport.id,
+      vm: vm
+    });
+  }
+
+  if (vm.rights.change) {
+    menuOptions.menuItems.push({
+      title: "New",
+      icon: "$sockiPlus",
+      key: FORM_KEY + ":new",
+      vm: vm
+    });
+  }
+
+  if (vm.rights.change && vm.$route.params.recordid != 0) {
+    menuOptions.menuItems.push({
+      title: "Duplicate",
+      icon: "$sockiClone",
+      key: FORM_KEY + ":duplicate",
+      vm: vm
+    });
+  }
+  if (vm.rights.delete && vm.$route.params.recordid != 0) {
+    menuOptions.menuItems.push({
+      title: "Delete",
+      icon: "$sockiTrashAlt",
+      surface: false,
+      key: FORM_KEY + ":delete",
+      vm: vm
+    });
+  }
+  menuOptions.menuItems.push({ divider: true, inset: false });
+
+  menuOptions.menuItems.push({ divider: true, inset: false });
+  window.$gz.eventBus.$emit("menu-change", menuOptions);
+}
+
+let JUST_DELETED = false;
+
+/////////////////////////////////
+//
+//
+async function initForm(vm) {
+  await fetchTranslatedText();
+  await window.$gz.formCustomTemplate.get(FORM_CUSTOM_TEMPLATE_KEY, vm);
+  await populateSelectionLists(vm);
+}
+
+//////////////////////////////////////////////////////////
+//
+// Ensures UI translated text is available
+//
+async function fetchTranslatedText() {
+  await window.$gz.translation.cacheTranslations([
+    "Subscription",
+    "Customer",
+    "ProductGroup",
+    "SubSite",
+    "ContractNotes"
+  ]);
+}
+
+//////////////////////
+//
+//
+async function populateSelectionLists(vm) {
+  //ensure the pick lists required are pre-fetched
+  await window.$gz.enums.fetchEnumList("productgroup");
+  vm.selectLists.pGroups = window.$gz.enums.getSelectionList("productgroup");
+}
+</script>