Methods

(static) registerWidget(options)

Parameters:

Example

// Registration of a "PageViewer" dashboard widget.
            // renderOptions.params:
            //   .pageUrl: url of the page to display
            omada.dashboard.registerWidget({
              name: 'PageViewer', render: function (renderOptions) {
                var frameTag = '<iframe src="' + renderOptions.params.pageUrl + '" style="width:' + renderOptions.width + 'px; height:' + renderOptions.height + 'px;">';
                $('#' + renderOptions.widgetId).html(frameTag);
              }
            });

Methods

(static) getFormData(options) → {object}

Parameters:

Returns:

Type

object

(static) modifyField(options)

Parameters:

Example

omada.dataObjectDialog.modifyField({ property: ['NAME'], hide: false, value: { value: 'some name' } });
omada.dataObjectDialog.modifyField({ property: ['MANAGER'], value: [{ value: 3502, displayValue: 'System Administrator' }] });

Members

(static) quickforms

Example

var properties = [];
properties.push({ name: 'Name', propertyName: 'NAME', caption: 'Name', requiresValue: true });
properties.push({ name: 'Description', propertyName: 'DESCRIPTION', caption: 'Description', requiresValue: true });
omada.dialogHelper.showQuickFormDlg({
  formId: 'MyQuickForm',
  properties: properties,
  caption: 'Please enter name'
});

Methods

(static) configureTree(options)

Parameters:

Example

var roots = [];
roots.push({ id: 1, title: 'My tree root', icon: 'images/appicons16/folder.png' });
omada.dialogHelper.configureTree({
  title: 'My tree dialog',
  roots: roots,
  demandLoad: function (parent) {
    var objects = [];
    objects.push({ id: 2, canExpand: false, title: 'my tree child', icon: 'images/appicons16/folder.png' });
    parent.loadCompleted({ objects: objects });
  },
});

(static) debounce(func, wait)

Parameters:

(static) showAccordionDialog(options)

Parameters:

Example

omada.dialogHelper.showAccordionDialog({
  containerId: 'myAccordionDlg',
  dialogTitle: 'Accordion dialog',
  dialogContent: "This is an accordion dialog",
  panels: [
  {id: "panel1", title: "Panel1", content: "Hello panel1"},
  {id: "panel2", title: "Panel2", content: "Hello panel2"}
  ]
  });

(static) showConfirmation(options)

Parameters:

Example

omada.dialogHelper.showConfirmation({
  title: 'Input required',
  message: 'If you click OK, the data will be submitted for approval',
  okClick: function () { closeDialog(CDR_Ok); }
});

(static) showCopyRuleSelectionDialog(options)

Parameters:

(static) showDataObjectQuickFormDlg(options)

Parameters:

Example

omada.dialogHelper.showDataObjectQuickFormDlg({ dataObjectId: '60CCEC0C-DAD1-4DF8-BB09-C77F15029FCD', divId: 'dataObjQuickForm', width: 500})

(static) showDataObjectSelectionDialog(options) → {object}

Parameters:

Returns:

Type

object

Example

omada.dialogHelper.showDataObjectSelectionDialog(
{
  lookupViewId: '2E03DE34-75C4-4C61-8F84-0156F094677D',
  multiSelection: true,
  selectionCompleted: function (aSelectedItems, aSelectedObjects) {
    for (var i = 0; i < aSelectedObjects.length; i++)
      showMessageDlg(S_COMMON_Text_Warning, 'Selected object with index ' + i + ' has id ' + aSelectedObjects[i].id + ' and display name "' + aSelectedObjects[i].displayName + "'");
  }
});

(static) showDataObjectTypeSelectionDialog(options)

Parameters:

Example

omada.dialogHelper.showDataObjectTypeSelectionDialog(
{
  selectionCompleted: function (aSelectedItems, aSelectedRows)
  {
    showMessageDlg(S_COMMON_Text_Warning, 'selected type id: ' + aSelectedItems[0]);
  }
});

(static) showDataSourceSelectionDialog(options)

Parameters:

(static) showDialog(options)

Parameters:

Example

omada.dialogHelper.showDialog({ containerId: 'myDialog', content: 'Welcome <b>[user]</b>', title: 'Welcome dialog' });

(static) showKpiDrillDownDataSourceSelectionDialog(options)

Parameters:

(static) showMessage(options)

Parameters:

Example

omada.dialogHelper.showMessage({ title: 'Warning', message: 'Invalid input in system search mask' });

(static) showPopupMessage(options)

Parameters:

Example

omada.dialogHelper.showPopupMessage({ message: 'Hello there my friend' });

(static) showPropertySelectionDialog(options)

Parameters:

Example

omada.dialogHelper.showPropertySelectionDialog(
{
  selectionCompleted: function (aSelectedIds, aSelectedRows)
  {
    showMessageDlg(S_COMMON_Text_Warning, 'selected property system name: ' + aSelectedRows.items[0].systemName);
  }
});

(static) showReferenceTreeSelectionDialog(options)

Parameters:

Example

omada.dialogHelper.showReferenceTreeSelectionDialog({
  objectTypeId: '3178BF72-A4C5-4AED-9084-6BB99AA42510',
  parentProperty: 'PARENTOU',
  selectionCompleted: function(result) {
    showMessageDlg(S_COMMON_Text_DlgTitle_Message, result.selectedItems[0].id);
  }
});

(static) showResourceAssigmentAttributesDialog(options)

Parameters:

Example

omada.dialogHelper.showResourceAssigmentAttributesDialog({ resAssnId: '2000' });

(static) showResourceAssignmentsDialog(options)

Parameters:

Example

omada.dialogHelper.showResourceAssignmentsDialog(
{
  viewId: '16f6208f-52ba-4f1a-93b4-ca726fff3828',
    readOnly: false,
    multiSelection: true,
});

(static) showRoPECalculatedAssignmentsDialog(options)

Parameters:

Example

omada.dialogHelper.showRoPECalculatedAssignmentsDialog({ resourceIds: [appPageVars.formDataId] })

(static) showTreeSelectionDialog(options)

Parameters:

Example

var roots = [];
roots.push({ id: 1, title: 'My tree root', icon: 'images/appicons16/folder.png' });
omada.dialogHelper.showTreeSelectionDialog({
  title: 'My tree dialog',
  width: 640,
  height: 480,
  roots: roots,
  demandLoad: function (parent) {
    var objects = [];
    objects.push({ id: 2, canExpand: false, title: 'my tree child', icon: 'images/appicons16/folder.png' });
    parent.loadCompleted({ objects: objects });
  },
  selectionCompleted: function (result) {
    showMessageDlg(S_COMMON_Text_DlgTitle_Message, 'selected object: ' + result.selectedItems[0].id);
  }
});

(static) showViewSelectionDialog(options)

Parameters:

Methods

(static) clearGridData(options)

Parameters:

Example

omada.gridHelper.clearGridData(
{
    sGridId: 'propertiesGrid'
});

(static) clearSelectedRows(options)

Parameters:

Example

omada.gridHelper.clearSelectedRows(
{
  sGridId: 'propertiesGrid'
});

(static) computeIdealItemsPerPage(options) → {object}

Parameters:

Returns:

Type

object

(static) configureGrid(gridParams) → {object}

Parameters:

Returns:

Type

object

Example

var gridParams = {
      sWSDataType: 'RoPEIdentities'
      aColModel: colModel,
      aButtons: gridButtons,
      sGridId: 'myGridId',
      sPagerId: "myGridPagerId",
      bAllowPaging: true,
      bMultiSelect: true,
      sHeight: 400,
      bAutoWidth: true,
      aRowData: options.rowData,
      bRowDataIsVirtual: true,
      bAdjustOnWindowResize: true
    }

    omada.gridHelper.configureGrid(gridParams);

(static) getRoPECRAGridCols(options)

Parameters:

(static) getSelectedRowKeys(options) → {array}

Parameters:

Returns:

Type

array

Example

var selectedRows = omada.gridHelper.getSelectedRowKeys(
{
  gridId: 'propertiesGrid'
});

(static) getSelectedRows(options) → {array}

Parameters:

Returns:

Type

array

Example

var selectedRows = omada.gridHelper.getSelectedRows(
{
  sGridId: 'propertiesGrid'
});

(static) getViewSettings(options)

Parameters:

Example

omada.gridHelper.getViewSettings({
    viewId: '3AE91C70-438B-4BB6-BA4D-AB1510D72DD7', complete: function (settings)
    {
      var gridParams = {
        sGridId: options.divId + '_grid',
        sPagerId: options.divId + '_pager',
        bAllowPaging: true,
        sWSDataType: options.isWorkItemView ? 'WorkItems' : 'DataObjects',
        oWSDataTypeArgs: dataTypeArgs,
        aColModel: settings.ColumnDefinitions,
        aButtons: options.buttons,
        bMultiSelect: false,
        bAllowColHeaderSearch: options.allowColHeaderSearch,
        bSkipColShrinking: options.skipColShrinking,
        bRemoveVerticalGridLines: false,
        sHeight: options.height,
                bAutoWidth: true,
                fCalculateGridDimensions: function () { return { width: $("#" + options.divId).width() } },
        sCaption: options.caption,
        bCollapsed: options.collapsed
      };

      omada.gridHelper.configureGrid(gridParams);

      if (options.success != null)
        options.success({ viewTitle: settings.ViewTitle });
    }
  });

(static) renderViewGrid(options)

Parameters:

Example

jQuery(document).ready(function () {
    omada.gridHelper.renderViewGrid({
        viewId: '3AE91C70-438B-4BB6-BA4D-AB1510D72DD7',
        divId: 'MyDiv',
        height: 200,
        extraDataTypeArgs: { expressions: '<expressions><expression property="NAME" operator="Equals" value="some name"/></expressions>' }
    });
});

(static) setSelectedRow(options)

Parameters:

Example

omada.gridHelper.setSelectedRow(
{
  sGridId: 'propertiesGrid',
  rowId: 'row1',
  status: true
});

(static) showGridDialog(selectionGridParams, showInExportFile) → {object}

Parameters:

Returns:

Type

object

Example

var selectionGridParams = {
      sDialogId: 'previewGridDialog',
      sDialogTitle: formatStr(S_SURVEY_Caption_PreviewDialog,gridName),
      aColModel: colModel,
      oButtons: dialogButtons,
      sCaption: '',
      sRecordText: '',
      sPgText: '',
      bShowRefresh: false,
      bShowPagerButtons: false,
      bShowPagerInput: false,
      bViewRecords: false,
      bSortDesc: true,
      bMultiSelection: true,
      bSkipCancelButton: true,
      bRowDataIsVirtual: true,
      aRowData: data
    };

    var dlgObj = omada.gridHelper.showGridDialog(selectionGridParams);

(static) validateAnyGridSelection(options)

Parameters:

Example

omada.gridHelper.validateAnyGridSelection(
{
    sGridId: 'propertiesGrid'
});

(static) validateSingleSelectionGrid(options)

Parameters:

Example

omada.gridHelper.validateAnyGridSelection(
{
    sGridId: 'propertiesGrid'
});

Methods

(static) buildPropertyControls(options)

Parameters:

Example

// The example shows a dhtml form with two property controls generated with the omada.uiHelper.buildPropertyControls API.
$(document).ready(function () {
  // We append a container for the dhtml form
  $(document.body).append('<div id="MyDiv"></div>');
  omada.uiHelper.buildPropertyControls(
    {
      // We generate controls for two properties (NAME and RESPONSIBLE)
      controls: [
        { controlId: 'ctrl1', propertyName: 'NAME', requiresValue: true, value: 'some name' },
        { controlId: 'ctrl2', propertyName: 'RESPONSIBLE', value: 3502 }],
      callback: function (result) {
        for (var ctrlId in result.controls) {
          var ctrl = result.controls[ctrlId];
          var reqValueIndicator = ctrl.controlOptions.requiresValue ? ' *' : '';
          $('#MyDiv').append('<hr>' + ctrl.controlOptions.propertyName + reqValueIndicator + ': ' + ctrl.html);
        }

        $("#MyDiv").dialog({
          autoOpen: true, buttons: [
            {
              text: "Validate",
              click: function () { result.validateControls(); }
            },
            {
              text: "Get values",
              click: function ()
              {
                for (var ctrlId in result.controls) {
                  var thevalue = result.controls[ctrlId].valueRetriever();
                  showMessageDlg(S_COMMON_Text_DlgTitle_Message, ctrlId + '\r\nControl has value? ' + thevalue.hasValue + '\r\nHas it been changed? ' + thevalue.isChanged + '\r\nValue: ' + (thevalue.hasValue ? thevalue.values[0].value : '-'));
                }
              }
            }
          ]
        });
      }
    });
});

(static) changeVisibilityValueOptionsShown()

(static) copyTextToClipboard(options)

Parameters:

(static) getPropertyControl(options) → {object}

Parameters:

Returns:

Type

object

(static) registerControlChangedEvent(options)

Parameters:

(static) setupVisibilityToggleEnablers(disablingControls)

Parameters:

(static) toggleVisibilityTogglingEnabled(disablingControls)

Parameters:

Methods

(static) getDataObjectTypeId(options)

Parameters:

(static) getDataObjects(options) → {object}

Parameters:

Returns:

Type

object

Example

// Load and display all "Folder" Data Objects
omada.wsproxy.getDataObjects({
  expressions: [{ property: 'Type', operator: 'Equals', value: 'FOLDER' }],
  properties: [], // we're only interested in the DisplayName so we skip loading any properties
  success2: function (result) {
    var dispNames = [];
    for (var i = 0; i < result.objects.length; i++)
      dispNames.push(result.objects[i].$DisplayName);
    showMessageDlg(S_COMMON_Text_DlgTitle_Message, result.objects.length + ' "Folder" Data Objects loaded: ' + dispNames.join(','));
  }
});

(static) getProcessTemplates(options)

Parameters:

Example

// Load and display all Process template created by System administrator
omada.wsproxy.getProcessTemplates({
  expressions: [{ property: 'CREATEDBY', operator: 'Equals', value: 3502 }],
  success: function (result) {
    var dispNames = [];
    for (var i = 0; i < result.length; i++)
      dispNames.push(result[i].$DisplayName);
    showMessageDlg(S_COMMON_Text_DlgTitle_Message, result.length + ' "Process Template" objects loaded: ' + dispNames.join(','));
  }
});

(static) importDataObjects(options)

Parameters:

Example

omada.wsproxy.importDataObjects({
  objects: [{ type: 'FOLDER', operation: 'create', NAME_v: [{ value: 'My new folder' }] }],
  success: function (result) {
    showMessageDlg(S_COMMON_Text_Warning, 'Import completed - created ' + result.CreatedObjectIds.length + ' Data Objects');
  },
  error: function (jqXHR, textStatus, errorThrown) {
    omada.ajaxHelper.alertAjaxError(this, jqXHR, textStatus);
  }
});

(static) resolvePropertyValues(options)

Parameters:

Example

omada.wsproxy.resolvePropertyValues({
  property: 'IDENTITYREF',
  searchStr: 'some value',
  maxResults: 10,
  success: function (result) {
    for (var id in result)
      showMessageDlg(S_COMMON_Text_DlgTitle_Message, 'Id:' + id + ', Name:' + result[id]);
    }
});

(static) startSignalRHub(options, connection)

Parameters:

Example

// Delete data objects
  omada.wsProxy.startSignalRHub({
    success: function () {
      omada.dataObjLst.dataObjectsHub.server.deleteDataObjects(idsToDelete).done(function (result) {
        progBar.hide();
        omada.appList.reloadGrid();
      })
    },
    fail: function (exception) {
      //Do something
    }
  });