Package com.ads.api.util

Class SystemManagerUtil

java.lang.Object
com.ads.api.util.BaseUtil
com.ads.api.util.SystemManagerUtil
public class SystemManagerUtil extends com.ads.api.util.BaseUtil
Contains the methods which performs the operations like Creation, Update, Deletion and Retrieval of Systems, Environments, Tables, and Columns. Some of the methods are of Resizable-array implementations, Hash table based implementations and RequestStatus return type.

Resizable-array Implements all optional list operations.Each ArrayList instance has a capacity. The capacity is the size of the array used to store the elements in the list. It is always at least as large as the list size. Hash table based implementation provides all of the optional map operations.

RequestStatus as return type methods will result in being returned as either true or false as its status.

  • Method Details

    • createSystem

      public RequestStatus createSystem(SMSystem system)
      Inserts a new system for the specified SMSystem Object.SMSystem object should contain all the details pertaining to system such as name, business purpose, DBMS platform,location etc...where in systemName are mandatory.
      Without specifying the systemName, method will fail to create a new system and it returns false. If system is added successfully, RequestStatus.isRequestSuccess() will return true or it returns false.
      Parameters:
      system - SMSystemobject
      Returns:
      RequestStatus object
      Since:
      6.2

    • getSystems

      public ArrayList<SMSystem> getSystems() throws Exception
      Returns the List of SMSystems along with all the details regarding each system.
      Returns all the available Systems as a List of SMSystem Object.
      Returns:
      List of Systems
      Throws:
      Exception
      Since:
      6.2

    • getSystem

      public SMSystem getSystem(String systemName) throws Exception
      Returns SMSystem Object for the specified systemName.Specifying the systemName is mandatory.
      Returns all the details such as systemName, description, systemOwner details,dataBase details and auditHistory.
      Parameters:
      systemName - String
      Returns:
      SMSystem object
      Throws:
      Exception
      Since:
      6.2

    • getSystem

      public SMSystem getSystem(int systemId) throws Exception
      Returns SMSystem Object for the specified systemId. Specifying systemId is mandatory.
      Returns all the details such as systemName,description,systemOwner details,dataBase details and auditHistory.
      Parameters:
      systemId - int
      Returns:
      SMSystem object
      Throws:
      Exception
      Since:
      6.2

    • getSystemId

      public int getSystemId(String systemName) throws Exception
      Returns the systemId for the specified systemName.
      Specifying the systemName is mandatory, based on the systemName, it will return the systemId.
      Parameters:
      systemName - String
      Returns:
      int
      Throws:
      Exception
      Since:
      6.2

    • getSystemDocuments

      public ArrayList<Document> getSystemDocuments(int systemId) throws Exception
      Returns the list of systemDocuments for the specified systemId.
      Returns all the Document details of all Documents present in a specific System. The filePath in the returned object is RELATIVE. Specifying the systemId is mandatory in order to retrieve the details of the Documents.
      Parameters:
      systemId - int
      Returns:
      List of SystemDocuments
      Throws:
      Exception
      Since:
      6.2

    • updateSystem

      public RequestStatus updateSystem(SMSystem system)
      Updates the system for the specified SMSystem object.i.e when provided with system details, this method updates the respective information of the system.
      Specifying systemId and systemName is Mandatory.
      All the details of the system can be updated. If system is updated successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
      Parameters:
      system - SMSystemobject
      Returns:
      RequestStatus object
      Since:
      6.2

    • deleteSystem

      public RequestStatus deleteSystem(int systemId)
      Removes SMSystem for the specified systemId.It deletes the System only if it does not contain any Environments or Documents associated with it.
      If the system is deleted successfully, RequestStatus.isRequestSuccess() will return true or it returns false.
      Parameters:
      systemId - int
      Returns:
      RequestStatus object
      Since:
      6.2

    • createEnvironment

      public RequestStatus createEnvironment(SMEnvironment environment) throws Exception
      Inserts a new System Environment for the specified environment object.It creates the environment with the given details.
      Specifying the environmentName, databaseType are mandatory, depending on the databaseType other fields like driverName, userName, password, dbmsName, port, URL, IPAddress are mandatory.
      DatabaseOptions - If you want to add any database options to the environment, specify those in a string format with the comma separator. This is applicable to only RDBMS databases only. Sample string : "Transaction Isolation=TRANSACTION_NONE,Snowflake CaseSensitive/Non-English DBName=true,Snowflake Query Type=SELECT,Snowflake fetch Metadata by=SCHEMA,Read Only=false,Auto Commit=false,Test Connection Query="",Include Synonyms (Only Oracle)=false,Scan Nested Synonyms=false,Query Batch Limit=999,Oracle Enable SSL Connection=false,Oracle Wallet Location="",Oracle PKI Provider Position=3,Oracle SSL Server DN Match=false,Has Access To DBA=false,Support Auto Commit=false,Dump Files=false"
      If the databaseType is fileType, then specification of driver name, port, URL etc... is not necessary. If Environment is added successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
      Parameters:
      environment - SMEnvironmentobject
      Returns:
      RequestStatus object
      Throws:
      Exception
      Since:
      6.2

    • getEnvironments

      public ArrayList<SMEnvironment> getEnvironments(int systemId) throws Exception
      Returns the SMEnvironment Object List for the specified systemId. Specifying the systemId is mandatory.
      Returns all the details pertaining to the Environments, such as environmentId, environmetName, environmentType, systemId and systemName in which the Environments are present, and its associated Database details like userName, password, dbDriver information etc...
      Parameters:
      systemId - int
      Returns:
      List of SMEnvironments.
      Throws:
      Exception
      Since:
      6.2

    • getEnvironment

      public SMEnvironment getEnvironment(int environmentId) throws Exception
      Returns SMEnvironment Object for the specified environmentId.Specifying the environmentId is mandatory.
      Returns all the details pertaining to a specific Environment such as environmentName, systemName in which environment is present, related DB information and its auditHistory. Specifying the environmentId is mandatory in order to retrieve the Environment Details.
      Parameters:
      environmentId - int
      Returns:
      SMEnvironment object
      Throws:
      Exception
      Since:
      6.2

    • getEnvironmentBySystemId

      public SMEnvironment getEnvironmentBySystemId(int systemId, String environmentName) throws Exception
      Returns SMEnvironment Object for the specified systemId and environmentName. Specifying the systemId and environmentName is mandatory in order to retrieve the Environment Details.
      Returns all the details pertaining to a specific Environment such as environmentName, systemName in which environment is present, related DB information and its auditHistory.
      Parameters:
      systemId - int
      environmentName - String
      Returns:
      SMEnvironment Object
      Throws:
      Exception
      Since:
      6.2

    • getEnvironmentConnectionProperties

      public DBProperties getEnvironmentConnectionProperties(SMEnvironment environment) throws Exception
      Returns DBProperties Object for the specified SMEnvironment object.
      It is mandatory to specify EnvironmentName and SystemId in which the Environment is present. Returns all the connection details such as username, password, driver details of a Environment.
      Parameters:
      environment - SMEnvironmentobject
      Returns:
      DBProperties of environment.
      Throws:
      Exception
      Since:
      6.2

    • getEnvironmentId

      public int getEnvironmentId(int systemId, String environmentName) throws Exception
      Returns the environmentId for the specified systemId and environmentName.
      Specifying the systemId and environmentName are mandatory.
      Parameters:
      systemId - int
      environmentName - String
      Returns:
      int
      Throws:
      com.icc.exceptions.DaoException
      Exception
      Since:
      6.2

    • getEnvironmentId

      public int getEnvironmentId(String systemName, String environmentName) throws Exception
      Returns the environmentId for the specified systemName and environmentName.
      Specifying the systemName and environmentName are mandatory.
      Parameters:
      systemName - String
      environmentName - String
      Returns:
      int
      Throws:
      Exception
      Since:
      6.2

    • updateEnvironment

      public RequestStatus updateEnvironment(SMEnvironment environment)
      Updates a System Environment for the specified SMEnvironment object, where all the environment details can be updated.
      When updating the environment, databaseType can be changed from one type to other and depending on the database type, respective details has to be specified.
      DatabaseOptions - If you want to add any database options to the environment, specify those in a string format with the comma separator. This is applicable to only RDBMS databases only. Sample string : "Transaction Isolation=TRANSACTION_NONE,Snowflake CaseSensitive/Non-English DBName=true,Snowflake Query Type=SELECT,Snowflake fetch Metadata by=SCHEMA,Read Only=false,Auto Commit=false,Test Connection Query='',Include Synonyms (Only Oracle)=false,Scan Nested Synonyms=false,Query Batch Limit=999,Oracle Enable SSL Connection=false,Oracle Wallet Location='',Oracle PKI Provider Position=3,Oracle SSL Server DN Match=false,Has Access To DBA=false,Support Auto Commit=false,Dump Files=false"
      If the databaseType of environment is ETL, then environment cannot be updated from one databaseType to another or vice versa
      Specifying the Database Type, SystemId, Environment Name, Environment Id, Environment Type are Mandatory. Depending on the Database Type mandatory values will vary from one type to other. If Environment is updated successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
      Parameters:
      environment - SMEnvironmentobject
      Returns:
      RequestStatus Object.
      Since:
      6.2

    • deleteEnvironment

      public RequestStatus deleteEnvironment(int environmentId)
      Removes System Environment for the specified environmentId. Specifying environmentId is mandatory.
      Environment cannot be deleted if the environment is being used as production environment. If Environment is deleted successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
      Parameters:
      environmentId - int
      Returns:
      RequestStatus object.
      Since:
      6.2

    • createTable

      public RequestStatus createTable(SMTable table)
      Inserts new Table for the specified SMTable Object.
      Specifying the EnvironmentId, TableName and TableType are Mandatory to create the Table. If SMTable is added successfully, RequestStatus.isRequestSuccess() will return true otherwise false. Specifying the parentTable object to the SMTable object is mandatory if you want to create the tables in hierarchical structure.
      Parameters:
      table - SMTable
      Returns:
      RequestStatus Object
      Since:
      6.2

    • getTable

      public SMTable getTable(int tableId) throws Exception
      Returns SMTable object for the specified tableId.
      Returns all the details pertaining to table such as tableName, tableDefinition, environmentName in which table is present etc... Specifying the tableId is mandatory in order to fetch the table details.
      Parameters:
      tableId - int
      Returns:
      SMTable object
      Throws:
      com.icc.exceptions.DaoException
      Exception
      Since:
      6.2

    • getTableByEnvironmentId

      public SMTable getTableByEnvironmentId(int environmentId, String tableName) throws Exception
      Returns SMTable object for the specified environmentId and tableName. This method results in displaying all the details related to table, where in specifying the environmentId, tableName are mandatory.
      Parameters:
      environmentId - int
      tableName - String
      Returns:
      SMTable object
      Throws:
      com.icc.exceptions.DaoException
      Exception
      Since:
      6.2

    • getTableId

      public int getTableId(int environmentId, String tableName) throws Exception
      Returns the tableId for the specified environmentId and tableName.
      Specifying the environmentId and tableName are mandatory.
      Parameters:
      environmentId - int
      tableName - String
      Returns:
      int
      Throws:
      com.icc.exceptions.DaoException
      Exception
      Since:
      6.2

    • getTableId

      public int getTableId(String systemName, String environmentName, String tableName) throws Exception
      Returns the tableId for the specified systemName, environmentName and tableName.
      Specifying the systemName, environmentName and tableName are mandatory.
      Parameters:
      systemName - String
      environmentName - String
      tableName - String
      Returns:
      int
      Throws:
      com.icc.exceptions.DaoException
      Exception
      Since:
      6.2

    • getEnvironmentTables

      public ArrayList<SMTable> getEnvironmentTables(int environmentId) throws Exception
      Returns the List of tables for the specified environmentId. Specifying the environemntId is mandatory in order to retrieve the tables present in the specific environment.
      Parameters:
      environmentId - int
      Returns:
      List of SMTable object
      Throws:
      com.icc.exceptions.DaoException
      Exception
      Since:
      6.2

    • updateTable

      public RequestStatus updateTable(SMTable table, boolean useReferenceId)
      Updates Table for the specified SMTable Object and useReferenceId. useReferenceId value for ERWIN and CWM is true, whereas for other database types it is false.
      In SMTable Object specifying the environmentId, tableName and tableId are mandatory. If SMTable is updated successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
      Parameters:
      table - SMTable
      useReferenceId - boolean
      Returns:
      RequestStatus object
      Since:
      6.2

    • deleteTable

      public RequestStatus deleteTable(int tableId)
      Removes the table for the specified tableId. Specifying the tableId is mandatory, the columns associated with specific table are first deleted and the corresponding Table Metadata is then deleted.
      If SMTable is deleted successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
      Parameters:
      tableId - int
      Returns:
      RequestStatus object
      Since:
      6.2

    • deleteTables

      public RequestStatus deleteTables(List<Integer> tableIds)
      Deletes the tables with the specified list of tableIds. Specifying the tableIds list is mandatory.
      If tables are deleted all its associated data will also be deleted.
      If tables are deleted successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
      Parameters:
      tableIds - List
      Returns:
      RequestStatus Object
      Since:
      12.1

    • deleteTables

      public RequestStatus deleteTables(int environmentId)
      Deletes the list of tables for the given environmentId. Specifying the environmentId is mandatory to delete tables.
      If the tables are deleted all its associated data will also be deleted.
      If tables are deleted successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
      Parameters:
      environmentId - int
      Returns:
      RequestStatus Object
      Since:
      12.1

    • deleteEnvironment

      public RequestStatus deleteEnvironment(int environmentId, APIConstants.VersionMode versionMode)
      Deletes the environment with the specified environmentId and versionMode. Specifying the environmentId is mandatory to delete a particular environment. If versionMode is not specified current version environment will be deleted.
      Version mode has values ALL_VERSIONS, CURRENT_VERSION.
      ALL_VERSIONS - Deletes all environments.
      CURRENT_VERSION - Deletes the present/current version.
      If the environment is deleted all its associated data will also be deleted.
      If environment is deleted successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
      Parameters:
      environmentId - int
      versionMode - VersionMode type - Valid values are ALL_VERSIONS/CURRENT_VERSION
      Returns:
      RequestStatus Object
      Since:
      12.1

    • createColumn

      public RequestStatus createColumn(SMColumn column)
      Inserts Column for the specified SMColumn Object. When creating a new column specifying the SMColumn Object is mandatory.
      In SMColumn Object, providing the details regarding the ColumnName,ColumnType, TableId are Mandatory.
      According to which the column gets created under that particular table. If column is added successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
      Parameters:
      column - SMColumn
      Returns:
      RequestStatus object
      Since:
      6.2

    • getColumn

      public SMColumn getColumn(int columnId) throws Exception
      Returns SMColumn object for the specified columnId.
      Specifying the columnId is mandatory and it returns all the details pertaining to column such as columnName, tableName in which the column is present, columnLength, columnPrecision etc...
      Parameters:
      columnId - int
      Returns:
      SMColumn object
      Throws:
      com.icc.exceptions.DaoException
      Exception
      Since:
      6.2

    • getColumnByTableId

      public SMColumn getColumnByTableId(int tableId, String columnName) throws Exception
      Returns SMColumn Object for the specified tableId and columnName. Specifying the tableId and columnName is mandatory, it returns the column details such as columnName, tableName in which the column is present, columnLength, columnPrecision etc...
      Parameters:
      tableId - int
      columnName - String
      Returns:
      SMColumn object
      Throws:
      com.icc.exceptions.DaoException
      Exception
      Since:
      6.2

    • getColumnId

      public int getColumnId(int tableId, String columnName) throws Exception
      Returns the columnId for the specified tableId and columnName.
      Specifying the tableId and columnName are mandatory.
      Parameters:
      tableId - int
      columnName - String
      Returns:
      int
      Throws:
      Exception
      Since:
      6.2

    • getColumnId

      public int getColumnId(String systemName, String environmentName, String tableName, String columnName) throws Exception
      Returns the columnId for the specified environmentName, systemName, tableName and columnName.
      Specifying the environmentName, systemName, tableName and columnName are mandatory.
      Parameters:
      systemName - String
      environmentName - String
      tableName - String
      columnName - String
      Returns:
      int
      Throws:
      Exception
      Since:
      6.2

    • getTableColumns

      public ArrayList<SMColumn> getTableColumns(int tableId) throws Exception
      Deprecated.
      since 8.2.1
      Returns list of SMColumn Object for the specified tableId.
      Returns the list of columns associated with the particular table, for which specifying the tableId is mandatory in order to retrieve the columns.
      Parameters:
      tableId - int
      Returns:
      List of SMColumn i.e List of columns of a particular Table.
      Throws:
      Exception
      Since:
      6.2

    • updateColumn

      public RequestStatus updateColumn(SMColumn column, boolean useReferenceId)
      Updates the Column for the specified SMColumn Object. Specifying the tableId, columnId and columnName in SMColumn Object and useReferenceId are mandatory which helps in updating all the details of the column specified except for the columnName.
      If column is updated successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
      Parameters:
      column - SMColumn
      useReferenceId - boolean
      Returns:
      RequestStatus object
      Since:
      6.2

    • deleteColumn

      public RequestStatus deleteColumn(int columnId)
      Removes column for the specified columnId. Specifying the columnId is mandatory, based on which the column will be deleted from the table.
      If column is deleted successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
      Parameters:
      columnId - int
      Returns:
      RequestStatus object
      Since:
      6.2

    • loadEnvironment

      public DBEnvironment loadEnvironment(int systemId, String environmentName, boolean useRefrenceId) throws Exception
      Loads the Environment for the specified systemId, environmentName and useReferenceId. Specifying the systemId, environementName and useReferenceId is mandatory. useReferenceId value for ERWIN and CWM is true, for other databaseTypes it is false.

      If the useReferenceId is true, the environment is loaded based on checking the table reference id which is set to the tables in the specific environment. If the value is false, the environment gets loaded with out checking the table referenceId which is set to the tables.

      Parameters:
      systemId - int
      environmentName - String
      useRefrenceId - boolean
      Returns:
      DBEnvironment object
      Throws:
      Exception
      Since:
      6.2

    • loadEnvironment

      public DBEnvironment loadEnvironment(int systemId, String environmentName, boolean useRefrenceId, APIConstants.LoadOptions loadOptions) throws Exception
      Loads the Environment for the specified systemId, environmentName and useReferenceId. Specifying the systemId, environementName and useReferenceId is mandatory. useReferenceId value for ERWIN and CWM is true, for other databaseTypes it is false.

      If the useReferenceId is true, the environment is loaded based on checking the table reference id which is set to the tables in the specific environment. If the value is false, the environment gets loaded with out checking the table referenceId which is set to the tables.

      LoadOptions has values VALID, INVALID and BOTH.
      VALID -Loads valid tables and columns.
      INVALID -Loads invalid tables and columns.
      BOTH -Loads all the valid and invalid tables and columns.

      Parameters:
      systemId - int
      environmentName - String
      useRefrenceId - boolean
      loadOptions - APIConstants.LoadOptions String
      Returns:
      DBEnvironment object
      Throws:
      Exception
      Since:
      14.0

    • scanEnvironment

      public DBEnvironment scanEnvironment(DBHelper dbHelper) throws Exception
      Loads an Environment for the specified dbHelper Object. Specifying the DBHelper object is mandatory.

      The following properties in the dbHelper object are mandatory:

      databaseType - This defines the type of the database to be scanned and saved. For values reference at DBProperties.DatabaseType. Depending on this value, mandatory values will vary from one database to other.

      If the databaseType value retrieved from dbHelper Object is RDBMS database, then the environment is loaded by specifying the dbUrl, dbDriver,dbUserName,dbPassword, dbName, dbSchema, databaseType, ipAddress, scanCriteria,readColumns,readComments,readTables, readViews, readSynonyms and selectedTables/selectedViews/selectedSynonyms.

      If the databaseType value retrieved from dbHelper Object is file based database, then the environment is loaded by specifying the filePath i.e the location from which the file can be read, scanCriteria,readColumns, readComments, readTables, readViews,readSynonyms and selectedTables/selectedViews/selectedSynonyms.

      scanCriteria - This defines the selection criteria of objects(TABLES/VIEWS/SYNONYMS/COMPONENTS) to be saved into the specified environment. This takes either INCLUDE_SELECTION or EXCLUDE_SELECTION or ALL. For values reference at DBHelper.ScanCriteria).
      If the scanCriteria value is INCLUDE_SELECTION then the only selected objects are loaded or if the scanCriteria value is EXCLUDE_SELECTION then apart from selected objects, the rest of the objects from the database are loaded or if the scanCriteria value is ALL then all the objects in the database are loaded into environment. Here objects refers to TABLES/VIEWS/SYNONYMS/COMPONENTS.

      filePath - This property is mandatory when the databaseType is file based database.
      filePathType - The supported values for the filePathType are ABSOLUTE, RELATIVE.

      useReferenceId- This property in dbHelper is used only for ERWIN and CWM file based databases and it accepts boolean value true or false.

      modelType & readLogicalColumns - These properties from the dbHelper object are used for only ERWIN file based databases.
      modelType defines the order in which the tables are displayed and readLogicalColumns value defines whether to skip logical columns or not.
      The value of modelType value can be either PHYSICAL OR LOGICAL (For values reference at DBHelper.ModelType)). DBHelper.ModelType default value is PHYSICAL.
      The value of readLogicalColumns accepts boolean value true or false.

      If environment is loaded successfully, DBEnvironment object will be returned.

      Sample input script for this:

      function execute()
      {
      var dbHelper = new DBHelper();
      dbHelper.setDbUrl("jdbc:sqlserver://hostname:1433;databaseName=dbname");
      dbHelper.setDbDriver("com.microsoft.sqlserver.jdbc.SQLServerDriver");
      dbHelper.setDbUserName("username");
      dbHelper.setDbPassword("***");
      dbHelper.setDbName("dnname");
      dbHelper.setDbSchema("schemaname");
      dbHelper.setDatabaseType(DBProperties.DatabaseType.SQLSERVER);
      dbHelper.setReadColumns(true);
      dbHelper.setReadComments(false);
      dbHelper.setReadTables(true);
      dbHelper.setReadViews(false);
      dbHelper.setReadSynonyms(false);
      dbHelper.setIpAddress("hostname");
      dbHelper.setFilePath(""); //For filebased databases
      dbHelper.setFilePathType(APIConstants.FilePathType.RELATIVE); //For filebased databases
      dbHelper.setModelType(DBHelper.ModelType.PHYSICAL); //For erwin and json database
      dbHelper.setReadLogicalColumns(false);
      dbHelper.setScanCriteria(DBHelper.ScanCriteria.INCLUDE_SELECTION);
      var selectedTablesMap = new HashMap();
      var selList = new ArrayList();
      selList.add("ADS_FORM");
      selectedTablesMap.put("dbo",selList);
      dbHelper.setSelectedTables(selectedTablesMap);
      var dBEnvironment = smutil.scanEnvironment(dbHelper);
      return dBEnvironment;
      }

      Parameters:
      dbHelper - DBHelper
      Returns:
      DBEnvironment object
      Throws:
      Exception
      Since:
      6.2

    • saveEnvironment

      public RequestStatus saveEnvironment(DBEnvironment dbEnvironment, DBProperties.Operation operation, boolean useReferenceId)
      Deprecated.
      since 9.0
      Saves the environment for the specified DBEnvironment Object, DBProperties and useReferenceId. Specification of DBEnvironment Object, DBProperties Object and useReferenceId is mandatory.

      DBEnvironment Object specifies the options update, insert, validate, invalidate and skip depending on the databaseType including which it gives the table count,views count and synonyms count.
      DBProperties Object specifies the operation modes in which the environment will be saved i.e fresh upload, update append and append modes.
      Simple append mode is used when environment is save for the first time i.e add new option.
      Update append mode is used when previously loaded environment is modified and few new tables are appended to the environment.
      Fresh upload mode is used when the previously loaded environment tables are to be deleted and new tables will be inserted in to the environment.
      update append invalidate mode is used when previously loaded meta data is modified and few new tables needs to appended and few scanned tables need to be invalidated in the environment.

      useReferenceId value is set to true or false depending on the databaseType in which the environment is saved. If environment is saved successfully, RequestStatus.isRequestSuccess() will return true otherwise false.

      Parameters:
      dbEnvironment - DBEnvironment
      operation - DBProperties
      useReferenceId - boolean
      Returns:
      RequestStatus object
      Since:
      6.2

    • createSystemAs

      public String createSystemAs(String smSystemObjJson, String outputFormat)
      Inserts a new system for the specified SMSystem Object.Specifying systemName is Mandatory. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      SMSystem object should contain all the details pertaining to system such as name, business purpose, DBMS platform,location etc...where in systemName is mandatory.
      Without specifying the systemName, method will fail to create a new system and it returns false.
      Parameters:
      smSystemObjJson - JSON String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If System is created successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'smSystemObjJson' JSON :
      {
      "systemName": "",
      "systemPrimaryMoveType": "",
      "systemDescriptionLong": "",
      "fileManagmentSystemType": "",
      "serverPlatform": "",
      "systemOwnerEmail": "",
      "specialInsructionsComments": "",
      "esbQManagerName": "",
      "endOfDayDefinition": "",
      "serverOSVersion": "",
      "totalDBSizeInGB": "",
      "dbmsPlatform": "",
      "dailyBatchExtractWindow": "",
      "dbmsVersion": "",
      "sdiFlag": "",
      "sdiDescription": "",
      "sdiClassificationName": "",
      "sdiClassificationId": "",
      "sdiclassifications": [
      {
      "objectTypeId": 0,
      "name": "",
      "description": "",
      "id": 0,
      "objectId": 0
      }
      ]
      }

      Since:
      6.2

    • getSystemsAs

      public String getSystemsAs(String outputFormat)
      Returns the List of SMSystems along with the details of each in the specified outputFormat. outputFormat can be JSON or XML.
      Returns all the available Systems as a List of SMSystem Object. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - List of SMSystems in the form of JSON or XML String.
      Since:
      6.2

    • getSystemAs

      public String getSystemAs(String systemName, String outputFormat)
      Returns SMSystem Object for the specified systemName in the specified outputFormat. Specifying the systemName is mandatory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Returns all the details such as systemName,description,systemOwner details,dataBase details and auditHistory.
      Parameters:
      systemName - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - SMSystem object in the form of JSON or XML String.
      Since:
      6.2

    • getSystemAs

      public String getSystemAs(int systemId, String outputFormat)
      Returns SMSystem Object for the specified systemId in the specified outputFormat. Specifying the systemId is mandatory.
      Returns all the details such as systemName,description,systemOwner details,dataBase details and auditHistory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      systemId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - SMSystem object in the form of JSON String.
      Since:
      6.2

    • getSystemDocumentsAs

      public String getSystemDocumentsAs(int systemId, String outputFormat)
      Returns the list of systemDocuments for the specified systemId in the specified outputFormat.
      Returns all the Document details of all Documents present in a specific System. The filePath in the returned document object is RELATIVE. Specifying the systemId is mandatory in order to retrieve the details of the Documents.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      systemId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - String - List of SystemDocument Objects in the form of JSON or XML String
      Since:
      6.2

    • getSystemIdAs

      public String getSystemIdAs(String systemName, String outputFormat)
      Returns the systemId for the specified systemName.
      Specifying the systemName is mandatory, based on the systemName, method will return the systemId.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      systemName - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - systemId
      Since:
      6.2

    • updateSystemAs

      public String updateSystemAs(String smSystemObjJson, String outputFormat)
      Updates the system for the specified SMSystem object.i.e when provided with system details, this method updates the respective information of the system.
      Specifying systemId and systemName are mandatory. All the details of the system can be updated.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      smSystemObjJson - JSON
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If system is updated successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'smSystemObjJson' JSON :
      {
      "systemName": "",
      "systemId":0,
      "systemPrimaryMoveType": "",
      "systemDescriptionLong": "",
      "fileManagmentSystemType": "",
      "serverPlatform": "",
      "systemOwnerEmail": "",
      "specialInsructionsComments": "",
      "esbQManagerName": "",
      "endOfDayDefinition": "",
      "serverOSVersion": "",
      "totalDBSizeInGB": "",
      "dbmsPlatform": "",
      "dailyBatchExtractWindow": "",
      "dbmsVersion": "",
      "sdiFlag": "",
      "sdiDescription": "",
      "sdiClassificationName": "",
      "sdiClassificationId": "",
      "sdiclassifications": [
      {
      "objectTypeId": 0,
      "name": "",
      "description": "",
      "id": 0,
      "objectId": 0
      }
      ]
      }

      Since:
      6.2

    • deleteSystemAs

      public String deleteSystemAs(int systemId, String outputFormat)
      Removes SMSystem for the specified systemId.It deletes the System only if it does not contain any Environments or Documents associated with it.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      systemId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If system is deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      6.2

    • createEnvironmentAs

      public String createEnvironmentAs(String smEnvironmentObjJson, String outputFormat)
      Inserts a new System Environment for the specified environment object in JSON.It creates the environment with the given details.
      Specifying the environmentName, databaseType are mandatory, depending on the databaseType other fields like driverName, userName, password, dbmsName, port, URL, IPAddress etc are mandatory.
      DatabaseOptions - If you want to add any database options to the environment, specify those in a string format with the comma separator. This is applicable to only RDBMS databases only.
      If the databaseType is fileType, then specification of driver name, port, URL etc... is not necessary.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      smEnvironmentObjJson - in JSON format
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Environment is created successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String. *

      Sample 'smEnvironmentObjJson' JSON :
      {
      "displayViewsInScan": false,
      "databaseOptions": "Transaction Isolation=TRANSACTION_NONE,Snowflake CaseSensitive/Non-English DBName=true,Snowflake Query Type=SELECT,Snowflake fetch Metadata by=SCHEMA,Read Only=false,Auto Commit=false,Test Connection Query='',Include Synonyms (Only Oracle)=false,Scan Nested Synonyms=false,Query Batch Limit=999,Oracle Enable SSL Connection=false,Oracle Wallet Location='',Oracle PKI Provider Position=3,Oracle SSL Server DN Match=false,Has Access To DBA=false,Support Auto Commit=false,Dump Files=false",
      "databaseName": "",
      "productionSystemName": "",
      "workflowStatus": "",
      "maximumNoOfConnectionsPerPartition": 5,
      "passwordEncrypted": true,
      "systemEnvironmentType": "",
      "sapClient": "000",
      "modelFileName": null,
      "databasePoolType": null,
      "extendedProperties": [],
      "systemName": "",
      "environmentNotes": "",
      "draft": 0,
      "kerberosPrincipal": null,
      "sshPort": 0,
      "intendedUseDescription": "",
      "rowDelimiter": "\\n",
      "visibility": 1,
      "productionSystemId": "1",
      "noOfPartitions": 2,
      "version": "1.00",
      "dataFileName": null,
      "dataProfileScoreId": 0,
      "serverPlatform": "",
      "versionLabel": "",
      "fileManagementSystemType": "",
      "databaseInstanceSchema": "",
      "systemEnvironmentName": "",
      "databasePort": "",
      "lastLoadingTime": 1554716759883,
      "status": "",
      "databaseIPAddress": "",
      "fieldDelimiter": ",",
      "databaseUserName": "",
      "databaseDomain": "",
      "environmentId": 0,
      "sapScanTables": "",
      "systemNumber": "00",
      "dataFile": null,
      "databaseURL": "",
      "systemId": 0,
      "sapDestination": null,
      "changeDescription": "",
      "dataProfileScore": null,
      "modelFile": "",
      "fileLocation": "",
      "productionEnvironmentName": "",
      "specialApprovalContvyInstructions": "",
      "userId": "",
      "displayTablesInScan": true,
      "displaySynonymsInScan": false,
      "databaseType": "SqlServer",
      "minimumNoOfConnectionsPerPartition": 3,
      "serverOSVersion": "",
      "databasePassword": "",
      "databaseDriver": "",
      "authenticationType": null,
      "systemEnvironmentId": 0,
      "businessEntityType": "",
      "sdiFlag": "",
      "sdiDescription": "",
      "sdiClassificationName": "",
      "sdiClassificationId": "",
      "sdiclassifications": [
      {
      "objectTypeId": 0,
      "name": "",
      "description": "",
      "id": 0,
      "objectId": 0
      }
      ]
      }

      Since:
      6.2

    • getEnvironmentsAs

      public String getEnvironmentsAs(int systemId, String outputFormat)
      Returns the SMEnvironment Object List for the specified systemId. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.Specifying systemId is mandatory.
      Returns all the details pertaining to the Environments, such as environmentId, environmetName, environmentType, systemId and systemName in which the Environments are present, and its associated Database details like userName, password, dbDriver information etc...
      Parameters:
      systemId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - List of SMEnvironment Objects in the form JSON String.
      Since:
      6.2

    • getEnvironmentAs

      public String getEnvironmentAs(int environmentId, String outputFormat)
      Returns SMEnvironment Object for the specified environmentId in the specified outputFormat.
      Returns all the details pertaining to a specific Environment such as environmentName, systemName in which environment is present, related DB information and its auditHistory. Specifying the environmentId is mandatory in order to retrieve the Environment Details.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      environmentId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - SMEnvironment object in the form of JSON or XML String.
      Since:
      6.2

    • getEnvironmentAs

      public String getEnvironmentAs(int systemId, String environmentName, String outputFormat)
      Returns SMEnvironment Object for the specified systemId and environmentName in the specified outputFormat.
      Returns all the details pertaining to a specific Environment such as environmentName, systemName in which environment is present, related DB information and its auditHistory. Specifying the systemId and environmentName is mandatory in order to retrieve the Environment Details.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      systemId - int
      environmentName - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - SMEnvironment Object in the form of JSON or XML String.
      Since:
      6.2

    • getEnvironmentConnectionPropertiesAs

      public String getEnvironmentConnectionPropertiesAs(String smEnvironmentObjJson, String outputFormat)
      Returns DBProperties Object for the specified SMEnvironment object in JSON in the specified outputFormat. outputFormat can be JSON or XML.
      Returns all the connection details such as username, password, driver details of a Environment. It is mandatory to specify EnvironmentName and SystemId in which the Environment is present.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      smEnvironmentObjJson - JSON
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - Environment DBProperties in the form of JSON or XML String.


      Sample 'smEnvironmentObjJson' JSON :

      {
      "displayViewsInScan": false,
      "databaseOptions": null,
      "databaseName": "",
      "productionSystemName": "",
      "workflowStatus": "",
      "maximumNoOfConnectionsPerPartition": 5,
      "passwordEncrypted": true,
      "systemEnvironmentType": "",
      "sapClient": "000",
      "modelFileName": null,
      "databasePoolType": null,
      "extendedProperties": [],
      "tables": [],
      "systemName": "",
      "environmentNotes": "",
      "draft": 0,
      "kerberosPrincipal": null,
      "sshPort": 0,
      "intendedUseDescription": "",
      "rowDelimiter": "\\n",
      "visibility": 1,
      "productionSystemId": "",
      "noOfPartitions": 2,
      "version": "1.00",
      "dataFileName": null,
      "dataProfileScoreId": 0,
      "serverPlatform": "",
      "versionLabel": "",
      "fileManagementSystemType": "",
      "databaseInstanceSchema": "",
      "systemEnvironmentName": "",
      "databasePort": "",
      "lastLoadingTime": 1554716759883,
      "status": "",
      "databaseIPAddress": "",
      "fieldDelimiter": ",",
      "databaseUserName": "",
      "databaseDomain": "",
      "environmentId": 0,
      "sapScanTables": "",
      "systemNumber": "00",
      "dataFile": null,
      "databaseURL": "",
      "systemId": 0,
      "sapDestination": null,
      "changeDescription": "",
      "dataProfileScore": null,
      "modelFile": "",
      "fileLocation": "",
      "productionEnvironmentName": "",
      "specialApprovalContvyInstructions": "",
      "userId": "",
      "displayTablesInScan": true,
      "displaySynonymsInScan": false,
      "databaseType": "SqlServer",
      "minimumNoOfConnectionsPerPartition": 3,
      "serverOSVersion": "",
      "databasePassword": "",
      "databaseDriver": "",
      "authenticationType": null,
      "systemEnvironmentId": 0
      }

      Since:
      6.2

    • getEnvironmentIdAs

      public String getEnvironmentIdAs(int systemId, String environmentName, String outputFormat)
      Returns the environmentId for the specified systemId and environmentName in the specified outputFormat. Specifying the systemId and environmentName are mandatory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      systemId - int
      environmentName - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - environmentId in JSON or XML string
      Since:
      6.2

    • getEnvironmentIdAs

      public String getEnvironmentIdAs(String systemName, String environmentName, String outputFormat)
      Returns the environmentId for the specified systemName and environmentName in the specific outputFormat. Specifying the systemName and environmentName are mandatory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      systemName - String
      environmentName - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - environmentId in JSON or XML String.
      Since:
      6.2

    • updateEnvironmentAs

      public String updateEnvironmentAs(String smEnvironmentObjJson, String outputFormat)
      Updates a System Environment for the specified SMEnvironment object in JSON, where all the environment details can be updated except for the environmentName.
      When updating the environment, databaseType can be changed from one type to other and depending on the database type the details has to be specified.
      DatabaseOptions - If you want to add any database options to the environment, specify those in a string format with the comma separator. This is applicable to only RDBMS databases only.
      If the databaseType of environment is ETL, then environment cannot be updated from one databaseType to another or vice versa
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      smEnvironmentObjJson - in JSON format
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Environment is updated successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'smEnvironmentObjJson' JSON :
      {
      "displayViewsInScan": false,
      "databaseOptions": "Transaction Isolation=TRANSACTION_NONE,Snowflake CaseSensitive/Non-English DBName=true,Snowflake Query Type=SELECT,Snowflake fetch Metadata by=SCHEMA,Read Only=false,Auto Commit=false,Test Connection Query='',Include Synonyms (Only Oracle)=false,Scan Nested Synonyms=false,Query Batch Limit=999,Oracle Enable SSL Connection=false,Oracle Wallet Location='',Oracle PKI Provider Position=3,Oracle SSL Server DN Match=false,Has Access To DBA=false,Support Auto Commit=false,Dump Files=false",
      "databaseName": "",
      "productionSystemName": "",
      "workflowStatus": "",
      "maximumNoOfConnectionsPerPartition": 5,
      "passwordEncrypted": true,
      "systemEnvironmentType": "",
      "sapClient": "000",
      "modelFileName": null,
      "databasePoolType": null,
      "extendedProperties": [],
      "tables": [],
      "systemName": "",
      "environmentNotes": "",
      "draft": 0,
      "kerberosPrincipal": null,
      "sshPort": 0,
      "intendedUseDescription": "",
      "rowDelimiter": "\\n",
      "visibility": 1,
      "productionSystemId": "",
      "noOfPartitions": 2,
      "version": "1.00",
      "dataFileName": null,
      "dataProfileScoreId": 0,
      "serverPlatform": "",
      "versionLabel": "",
      "fileManagementSystemType": "",
      "databaseInstanceSchema": "",
      "systemEnvironmentName": "",
      "databasePort": "",
      "lastLoadingTime": 1554716759883,
      "status": "",
      "databaseIPAddress": "",
      "fieldDelimiter": ",",
      "databaseUserName": "",
      "databaseDomain": "",
      "environmentId": 0,
      "sapScanTables": "",
      "systemNumber": "00",
      "dataFile": null,
      "databaseURL": "",
      "systemId": 0,
      "sapDestination": null,
      "changeDescription": "",
      "dataProfileScore": null,
      "modelFile": "",
      "fileLocation": "",
      "productionEnvironmentName": "",
      "specialApprovalContvyInstructions": "",
      "userId": "",
      "displayTablesInScan": true,
      "displaySynonymsInScan": false,
      "databaseType": "SqlServer",
      "minimumNoOfConnectionsPerPartition": 3,
      "serverOSVersion": "",
      "databasePassword": "",
      "databaseDriver": "",
      "authenticationType": null,
      "systemEnvironmentId": 0,
      "businessEntityType": "",
      "sdiFlag": "",
      "sdiDescription": "",
      "sdiClassificationName": "",
      "sdiClassificationId": "",
      "sdiclassifications": [
      {
      "objectTypeId": 0,
      "name": "",
      "description": "",
      "id": 0,
      "objectId": 0
      }
      ]
      }

      Since:
      6.2

    • deleteEnvironmentAs

      public String deleteEnvironmentAs(int environmentId, String outputFormat)
      Removes System Environment for the specified environmentId.
      Environment cannot be deleted if the environment is being used as production environment.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      environmentId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Environment is deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      6.2

    • scanEnvironmentAs

      public String scanEnvironmentAs(String dbHelperObjJson, String outputFormat)
      Loads an Environment for the specified dbHelper Object. Specifying the dbHelper object in the form of json is mandatory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.

      The following properties in the dbHelper object are mandatory:

      databaseType - This defines the type of the database to be scanned and saved. For values reference at DBProperties.DatabaseType. Depending on this value, mandatory values will vary from one database to other.

      If the databaseType value retrieved from dbHelper Object is RDBMS database, then the environment is loaded by specifying the dbUrl, dbDriver,dbUserName,dbPassword, dbName, dbSchema, databaseType, ipAddress, scanCriteria,readColumns,readComments,readTables, readViews, readSynonyms and selectedTables/selectedViews/selectedSynonyms.

      If the databaseType value retrieved from dbHelper Object is file based database, then the environment is loaded by specifying the filePath i.e the location from which the file can be read, scanCriteria,readColumns, readComments, readTables, readViews,readSynonyms and selectedTables/selectedViews/selectedSynonyms.

      scanCriteria - This defines the selection criteria of objects(TABLES/VIEWS/SYNONYMS/COMPONENTS) to be saved into the specified environment. This takes either INCLUDE_SELECTION or EXCLUDE_SELECTION or ALL. For values reference at DBHelper.ScanCriteria).
      If the scanCriteria value is INCLUDE_SELECTION then the only selected objects are loaded or if the scanCriteria value is EXCLUDE_SELECTION then apart from selected objects, the rest of the objects from the database are loaded or if the scanCriteria value is ALL then all the objects in the database are loaded into environment. Here objects refers to TABLES/VIEWS/SYNONYMS/COMPONENTS.

      filePath - This property is mandatory when the databaseType is file based database.
      filePathType - The supported values for the filePathType are ABSOLUTE, RELATIVE.

      useReferenceId - This property in dbHelper is used only for ERWIN and CWM file based databases and it accepts boolean value true or false.

      modelType & readLogicalColumns - These properties from the dbHelper object are used for only ERWIN file based databases.
      modelType defines the order in which the tables are displayed and readLogicalColumns value defines whether to skip logical columns or not.
      The value of modelType value can be either PHYSICAL OR LOGICAL (For values reference at DBHelper.ModelType)). DBHelper.ModelType default value is PHYSICAL.
      The value of readLogicalColumns accepts boolean value true or false.

      If environment is loaded successfully, DBEnvironment object will be returned in the form of json/xml depending on the output format.

      Parameters:
      dbHelperObjJson - - dbHelper Object - JSON format
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - DBEnvironment object in the form of JSON or XML String.

      Sample 'dbHelperObjJson' JSON :
      {
      "dbUrl": "jdbc:sqlserver://hostname:1433;databaseName=database_name",
      "dbDriver": "com.microsoft.sqlserver.jdbc.SQLServerDriver",
      "dbUserName": "user name",
      "dbPassword": "******",
      "dbName": "database name",
      "dbSchema": "schema name",
      "databaseType": "SQLSERVER",
      "scanCriteria": "INCLUDE_SELECTION",
      "readColumns": true,
      "readComments": false,
      "readTables": true,
      "readViews": true,
      "readSynonyms": true,
      "readLogicalColumns": false,
      "selectedTables": {
      "dbo": [
      "ADS_FORM"
      ]
      },
      "selectedViews": {},
      "selectedSynonyms": {},
      "autoCommit": true,
      "filePath": "D:\\files to scan\\ERWin\\Demo Model1_10.xml", ==> (for file based databases)
      "filePathType":"RELATIVE" "modelType": "PHYSICAL", ==> (for erwin database)
      "useReferenceId": false ==> (for erwin & cwm databases)
      }

      Since:
      6.2

    • loadEnvironmentAs

      public String loadEnvironmentAs(int systemId, String environmentName, boolean useRefrenceId, String outputFormat)
      Loads the Environment for the specified systemId, environmentName and useReferenceId. Specifying the systemId, environementName and useReferenceId is mandatory. useReferenceId value for ERWIN and CWM is true, for other databaseTypes it is false.

      If the useReferenceId is true, the environment is loaded based on checking the table reference id which is set to the tables in the specific environment. If the value is false, the environment gets loaded with out checking the table referenceId which is set to the tables.

      outputFormat can be either dbHelperObj or XML. If outputFormat is not specified, by default the method will return the dbHelperObj String.

      Parameters:
      systemId - int
      environmentName - String
      useRefrenceId - boolean
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - DBEnvironment object in the form of JSON or XML String.
      Since:
      6.2

    • loadEnvironmentByOptionsAs

      public String loadEnvironmentByOptionsAs(int systemId, String environmentName, boolean useRefrenceId, String loadOptions, String outputFormat)
      Loads the Environment for the specified systemId, environmentName, useReferenceId and loadOptions. OutputFormat can be either Json or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Specifying the systemId, environementName and useReferenceId is mandatory. useReferenceId value for ERWIN and CWM is true, for other databaseTypes it is false.

      If the useReferenceId is true, the environment is loaded based on checking the table reference id which is set to the tables in the specific environment. If the value is false, the environment gets loaded with out checking the table referenceId which is set to the tables.

      LoadOptions has values VALID, INVALID and BOTH.
      VALID -Loads valid tables and columns.
      INVALID -Loads invalid tables and columns.
      BOTH -Loads all the valid and invalid tables and columns.

      Parameters:
      systemId - int
      environmentName - String
      useRefrenceId - boolean
      loadOptions - APIConstants.LoadOptions String
      outputFormat - String
      Returns:
      String - DBEnvironment object in the form of JSON or XML String.

    • saveEnvironmentAs

      public String saveEnvironmentAs(String dbEnvironmentObjJson, String operation, boolean useReferenceId, String outputFormat)
      Deprecated.
      since 9.0
      Saves the environment for the specified DBEnvironment Object, DBProperties and useReferenceId. Specification of DBEnvironment Object, DBProperties Object and useReferenceId is mandatory.

      DBEnvironment Object specifies the options update, insert, validate, invalidate and skip depending on the databaseType including which it gives the table count,views count and synonyms count.
      DBProperties Object specifies the operation modes in which the environment will be saved i.e fresh upload, update append and append modes.
      simple append mode is used when environment is save for the first time i.e add new option.
      update append mode is used when previously loaded environment is modified and few new tables are appended to the environment.
      fresh upload mode is used when the previously loaded environment tables are to be deleted and new tables will be inserted in to the environment.
      update append invalidate mode is used when previously loaded meta data is modified and few new tables needs to appended and few scanned tables need to be invalidated in the environment.

      useReferenceId value is set to true or false depending on the databaseType in which the environment is saved. If environment is saved successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
      outputFormat can be either dbHelperObj or XML. If outputFormat is not specified, by default the method will return the dbHelperObj String.

      Parameters:
      dbEnvironmentObjJson - dbEnvironment Object
      operation - DBProperties.Operation
      useReferenceId - boolean
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Environment is saved successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'dbEnvironmentObjJson' JSON :

      {
      "environmentName": "",
      "system": {
      "systemId": 0
      },
      "schemas": {
      "dbo": {
      "schemaName": "",
      "viewMap": {},
      "synonymMap": {},
      "tableMap": {
      "dbo.table1": {
      "tableName": "",
      "tableComments": "",
      "createdBy": "",
      "createdDateTime": 1428994708798,
      "lastModifiedBy": "",
      "lastModifiedDateTime": 1428994708798,
      "tableType": "",
      "columnMap": {
      "column1": {
      "columnName": "",
      "datatype": "",
      "length": "50",
      "precision": "20",
      "createdBy": "",
      "createdDatetime": 1428994708798,
      "lastModifiedBy": "",
      "lastModifiedDatetime": 1428994708798,
      "scale": "10",
      "businessEntityType": ""
      }
      }
      }
      }
      }
      }
      }

      Since:
      6.2

    • createTableAs

      public String createTableAs(String smTableObjJson, String outputFormat)
      Inserts new Table for the specified SMTable Object. Specifying the SMTable Object is mandatory.
      Specifying the environmentId, tableName and tableType are mandatory to create the Table.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      smTableObjJson - smTable - Object - JSON format
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Table is created successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'smTableObjJson' JSON :

      {
      "expandedLogicalName": "",
      "physicalTableName": "",
      "workflowStatus": "",
      "columns": [],
      "actualTableName": null,
      "tableComments": null,
      "tableAlias": null,
      "associatedBusinessTermId": 0,
      "schemaName": "",
      "declarationPath": "",
      "stmid": 0,
      "referenceId": null,
      "tableName": "",
      "tableClass": null,
      "valid": true,
      "tableType": "TABLE",
      "extendedProperties": [],
      "environmentId": 0,
      "logicalTableName": null,
      "userDefined10": "",
      "marked": false,
      "systemId": 0,
      "rootTable": true,
      "tableDefinition": null,
      "columnIndexes": [],
      "tableReferenceId": null,
      "associatedBusinessTerm": "",
      "dataProfileScoreId": 0,
      "environment": null,
      "totalRowsCount": 0,
      "userDefined8": "",
      "userDefined9": "",
      "metadataSource": "",
      "userDefined6": "",
      "userDefined7": "",
      "userDefined4": "",
      "userDefined5": "",
      "tableId": 0,
      "userDefined2": "",
      "systemEnvironmentName": "",
      "usedInGapAnalysis": true,
      "userDefined3": "",
      "userDefined1": "",
      "fileType": null,
      "fileLocation": "",
      "businessEntityType": "",
      "status": "",
      "sdiFlag": "",
      "sdiDescription": "",
      "sdiClassificationName": "",
      "sdiClassificationId": "",
      "sdiclassifications": [
      {
      "objectTypeId": 0,
      "name": "",
      "description": "",
      "id": 0,
      "objectId": 0
      }
      ]
      }

      Since:
      6.2

    • getTableAs

      public String getTableAs(int tableId, String outputFormat)
      Returns String of SMTable object in JSON format for the specified tableId.
      Returns all the details pertaining to table such as tableName, tableDefinition, environmentName in which table is present etc... Specifying the tableId is mandatory in order to fetch the table details.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      tableId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - SMTable object in the form of JSON or XML String.
      Since:
      6.2

    • getTableAs

      public String getTableAs(int environmentId, String tableName, String outputFormat)
      Returns String of SMTable object in specified outputFormat for the specified environmentId and tableName. This method results in displaying all the details related to table, where in specifying the environmentId, tableName are mandatory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      environmentId - int
      tableName - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - SMTable object in the form of JSON or XML String.
      Since:
      6.2

    • getTableIdAs

      public String getTableIdAs(int environmentId, String tableName, String outputFormat)
      Returns the tableId as String for the specified environmentId and tableName in the specific outputFormat. Specifying the environmentId and tableName are mandatory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      environmentId - int
      tableName - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - tableId
      Since:
      6.2

    • getTableIdAs

      public String getTableIdAs(String systemName, String environmentName, String tableName, String outputFormat)
      Returns the tableId as String for the specified systemName, environmentName and tableName in the specific outputFormat. Specifying the systemName, environmentName and tableName are mandatory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      systemName - String
      environmentName - String
      tableName - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - tableId
      Since:
      6.2

    • getEnvironmentTablesAs

      public String getEnvironmentTablesAs(int environmentId, String outputFormat)
      Returns the List of tables for the specified environmentId. Specifying the environmentId is mandatory in order to retrieve the tables present in the specified environment.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      environmentId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - List of SMTable objects in the form of JSON or XML String.
      Since:
      6.2

    • updateTableAs

      public String updateTableAs(String smTableObjJson, boolean useReferenceId, String outputFormat)
      Updates Table for the specified SMTable Object and useReferenceId. Specifying the SMTable Object and useReferenceId is mandatory, useReferenceId value for ERWIN and CWM is true, whereas for other database types it is false.
      In SMTable Object specifying the environmentId, tableName and tableId are mandatory. If SMTable is updated successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      smTableObjJson -
      useReferenceId - boolean
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Table is updated successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'smTableObjJson' JSON :

      {
      "expandedLogicalName": "",
      "physicalTableName": "",
      "workflowStatus": "",
      "columns": [],
      "actualTableName": null,
      "tableComments": null,
      "tableAlias": null,
      "associatedBusinessTermId": 0,
      "schemaName": "",
      "declarationPath": "",
      "stmid": 0,
      "referenceId": null,
      "tableName": "",
      "tableClass": null,
      "valid": true,
      "tableType": "TABLE",
      "extendedProperties": [],
      "environmentId": 0,
      "logicalTableName": null,
      "userDefined10": "",
      "marked": false,
      "systemId": 0,
      "rootTable": true,
      "tableDefinition": null,
      "columnIndexes": [],
      "tableReferenceId": null,
      "associatedBusinessTerm": "",
      "dataProfileScoreId": 0,
      "environment": null,
      "totalRowsCount": 0,
      "userDefined8": "",
      "userDefined9": "",
      "metadataSource": "",
      "userDefined6": "",
      "userDefined7": "",
      "userDefined4": "",
      "userDefined5": "",
      "tableId": 0,
      "userDefined2": "",
      "systemEnvironmentName": "",
      "usedInGapAnalysis": true,
      "userDefined3": "",
      "userDefined1": "",
      "fileType": null,
      "fileLocation": "",
      "businessEntityType": "",
      "status": "",
      "sdiFlag": "",
      "sdiDescription": "",
      "sdiClassificationName": "",
      "sdiClassificationId": "",
      "sdiclassifications": [
      {
      "objectTypeId": 0,
      "name": "",
      "description": "",
      "id": 0,
      "objectId": 0
      }
      ]
      }

      Since:
      6.2

    • deleteTableAs

      public String deleteTableAs(int tableId, String outputFormat)
      Removes the table for the specified tableId. The columns associated with specific table are first deleted and the corresponding table meta data is then deleted.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      tableId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Table is deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      6.2

    • createColumnAs

      public String createColumnAs(String smColumnObjJson, String outputFormat)
      Inserts Column for the specified SMColumn Object. When creating a new column the SMColumn Object is mandatory.
      In SMColumn Object, ColumnName,ColumnType, TableId are Mandatory according to which the column gets created under that particular table.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      smColumnObjJson - in JSON format
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Column is created successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'smColumnObjJson' JSON :

      {
      "columnLength": "0",
      "logicalColumnName": null,
      "columnETLDefaultValue": null,
      "workflowStatus": "",
      "columnDefinition": null,
      "associatedBusinessTermId": 0,
      "foreignKeyTableName": null,
      "validValues": [],
      "declarationPath": "",
      "columnAlias": null,
      "tableName": "",
      "minimumValue": null,
      "extendedProperties": [],
      "userDefined10": "",
      "dataProfileEndDate": null,
      "dataProfileJobFailReason": null,
      "columnScale": "0",
      "columnPrecision": "0",
      "columnDBDefaultValue": null,
      "includeInDataProfile": null,
      "columnDatatype": "",
      "dataProfileJobState": null,
      "stcmid": 0,
      "naturalKeyFlag": false,
      "physicalColumnName": "",
      "dataProfileScoreId": 0,
      "columnType": "ENTITY_ELEMENT",
      "sdiClassificationName": "",
      "userDefined8": "",
      "userDefined9": "",
      "metadataSource": "",
      "userDefined6": "",
      "userDefined7": "",
      "userDefined4": "",
      "userDefined5": "",
      "userDefined2": "",
      "usedInGapAnalysis": true,
      "userDefined3": "",
      "userDefined1": "",
      "sdiFlag": false,
      "status": "",
      "columnComments": null,
      "expandedLogicalName": "",
      "businessKeyFlag": false,
      "columnId": 0,
      "valid": true,
      "xpath": null,
      "environmentId": 0,
      "table": null,
      "insertOrder": 1,
      "dataProfileScore": null,
      "columnIndexes": [],
      "sdiDescription": null,
      "percentNullValue": null,
      "dataProfileStartDate": null,
      "columnNullableFlag": true,
      "associatedBusinessTerm": "",
      "foreignKeyColumnName": null,
      "columnDataDomain": null,
      "columnIdentityFlag": false,
      "foreignKeyFlag": false,
      "fileStartingPosition": null,
      "columnClass": null,
      "tableId": 0,
      "storageType": null,
      "primaryKeyFlag": false,
      "sdiClassificationId": "",
      "maximumValue": null,
      "columnName": "",
      "columnReferenceId": null,
      "sdiclassifications": [
      {
      "objectTypeId": 0,
      "name": "",
      "description": "",
      "id": 0,
      "objectId": 0
      }
      ]
      }

      Since:
      6.2

    • getColumnAs

      public String getColumnAs(int columnId, String outputFormat)
      Returns SMColumn object as String in the specified outputFormat for the specified columnId. Specifying the columnId is mandatory and it returns all the details pertaining to column such as columnName, tableName in which the column is present, columnLength, columnPrecision etc...
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      columnId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - SMColumn object in the form of JSON or XML String.
      Since:
      6.2

    • getColumnAs

      public String getColumnAs(int tableId, String columnName, String outputFormat)
      Returns SMColumn Object for the specified tableId and columnName. Specifying the tableId and columnName is mandatory, it returns the column details of the table such as columnName,tableName in which the column is present,columnLength,columnPrecision etc...
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      tableId - int
      columnName - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - SMColumn object in the form of JSON or XML String.
      Since:
      6.2

    • getColumnIdAs

      public String getColumnIdAs(int tableId, String columnName, String outputFormat)
      Returns the columnId as String in the specified outputFormat for the specified tableId and columnName. Specifying the tableId and columnName are mandatory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      tableId - int
      columnName - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - columnId
      Since:
      6.2

    • getColumnIdAs

      public String getColumnIdAs(String systemName, String environmentName, String tableName, String columnName, String outputFormat)
      Returns the columnId as String in the specified outputFormat for the specified environmentName, systemName,tableName and columnName. Specifying the environmentName, systemName, tableName and columnName are mandatory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      systemName - String
      environmentName - String
      tableName - String
      columnName - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - columnId
      Since:
      6.2

    • getTableColumnsAs

      public String getTableColumnsAs(int tableId, String outputFormat)
      Deprecated.
      since 8.2.1 - instead of this use getColumnsAs(int, java.lang.String)
      Returns the columns of the table as String for the specified tableId in the specified outputFormat.
      Returns the list of columns associated with the particular table, for which specifying the tableId is mandatory in order to retrieve the columns.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      tableId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - List of SMColumn objects in the form of JSON String i.e List of columns of a particular Table.
      Since:
      6.2

    • updateColumnAs

      public String updateColumnAs(String smColumnObjJson, boolean useReferenceId, String outputFormat)
      Updates the Column for the specified SMColumn Object in Json and useReferenceId. Specifying the tableId, columnId and columnName in SMColumn Object and useReferenceId are mandatory,which helps in updating all the details of the column specified.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      smColumnObjJson - in JSON format
      useReferenceId - boolean
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Column is updated successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'smColumnObjJson' JSON :

      {
      "columnLength": "0",
      "logicalColumnName": null,
      "columnETLDefaultValue": null,
      "workflowStatus": "",
      "columnDefinition": null,
      "associatedBusinessTermId": 0,
      "foreignKeyTableName": null,
      "validValues": [],
      "declarationPath": "",
      "columnAlias": null,
      "tableName": "",
      "minimumValue": null,
      "extendedProperties": [],
      "userDefined10": "",
      "dataProfileEndDate": null,
      "dataProfileJobFailReason": null,
      "columnScale": "0",
      "columnPrecision": "0",
      "columnDBDefaultValue": null,
      "includeInDataProfile": null,
      "columnDatatype": "",
      "dataProfileJobState": null,
      "stcmid": 0,
      "naturalKeyFlag": false,
      "physicalColumnName": "",
      "dataProfileScoreId": 0,
      "columnType": "ENTITY_ELEMENT",
      "sdiClassificationName": "",
      "userDefined8": "",
      "userDefined9": "",
      "metadataSource": "",
      "userDefined6": "",
      "userDefined7": "",
      "userDefined4": "",
      "userDefined5": "",
      "userDefined2": "",
      "usedInGapAnalysis": true,
      "userDefined3": "",
      "userDefined1": "",
      "sdiFlag": false,
      "status": "",
      "columnComments": null,
      "expandedLogicalName": "",
      "businessKeyFlag": false,
      "columnId": 0,
      "valid": true,
      "xpath": null,
      "environmentId": 0,
      "table": null,
      "insertOrder": 1,
      "dataProfileScore": null,
      "columnIndexes": [],
      "sdiDescription": null,
      "percentNullValue": null,
      "dataProfileStartDate": null,
      "columnNullableFlag": true,
      "associatedBusinessTerm": "",
      "foreignKeyColumnName": null,
      "columnDataDomain": null,
      "columnIdentityFlag": false,
      "foreignKeyFlag": false,
      "fileStartingPosition": null,
      "columnClass": null,
      "tableId": 0,
      "storageType": null,
      "primaryKeyFlag": false,
      "sdiClassificationId": "",
      "maximumValue": null,
      "columnName": "",
      "columnReferenceId": null,
      "sdiclassifications": [
      {
      "objectTypeId": 0,
      "name": "",
      "description": "",
      "id": 0,
      "objectId": 0
      }
      ]
      }

      Since:
      6.2

    • deleteColumnAs

      public String deleteColumnAs(int columnId, String outputFormat)
      Removes column for the specified columnId. Specifying the columnId is mandatory, based on which the column gets deleted from the table.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      columnId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Column is deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      6.2

    • addDocument

      public RequestStatus addDocument(int nodeId, Node.NodeType nodeType, Document document)
      Document is added for the specified nodeId of nodeType. specifying the nodeId, nodeType documentName, documentObject, createdBy are mandatory.
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
      Parameters:
      nodeId - int
      nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      document - Document Object
      Returns:
      RequestStatus object - Returns true if Document is added, otherwise returns false.
      Since:
      7.0

    • addDocument

      public RequestStatus addDocument(String nodeName, int parentNodeId, Node.NodeType parentNodeType, Document document)
      Document is added for the specified nodeName, parentNodeId of parentNodeType. specifying the parentNodeId, parentNodeType nodeName, documentName, documentObject, createdBy are mandatory.
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
      If the parentNodeType is SM_SYSTEM, then the parentNodeId is -1.
      If the parentNodeType is SM_ENVIRONMENT, then the parentNodeId is systemId.
      Parameters:
      nodeName - String
      parentNodeId - int
      parentNodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      document - Document Object
      Returns:
      RequestStatus object - Returns true if Document is added, otherwise returns false.
      Since:
      7.0

    • deleteDocuments

      public RequestStatus deleteDocuments(int nodeId, Node.NodeType nodeType)
      Deletes the documents of the specified nodeId of nodeType. Specifying the nodeId and nodeType are mandatory.
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
      Parameters:
      nodeId - int
      nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT.
      Returns:
      RequestStatus object - Returns true if Documents are deleted successfully, otherwise returns false.

    • deleteDocuments

      public RequestStatus deleteDocuments(String nodeName, int parentNodeId, Node.NodeType parentNodeType)
      Documents are deleted for the specified nodeName, parentNodeId of parentNodeType. Specifying the parentNodeId, parentNodeType nodeName are mandatory.
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
      If the parentNodeType is SM_SYSTEM, then the parentNodeId is -1.
      If the parentNodeType is SM_ENVIRONMENT, then the parentNodeId is systemId.
      Parameters:
      nodeName - String
      parentNodeId - int
      parentNodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      Returns:
      RequestStatus object - Returns true if Documents are deleted successfully, otherwise returns false.
      Since:
      7.0

    • deleteSystemDocuments

      public RequestStatus deleteSystemDocuments(int systemId)
      Deletes the systemDocuments for the specified systemId. Specifying the systemId is mandatory.
      Parameters:
      systemId - int
      Returns:
      RequestStatus object - Returns true if the system documents are deleted successfully, otherwise returns false.
      Since:
      7.0

    • deleteSystemDocuments

      public RequestStatus deleteSystemDocuments(String systemName)
      Deletes the System Documents for the specified systemName. Specifying the systemName is mandatory.
      Parameters:
      systemName - String
      Returns:
      RequestStatus object - Returns true if Documents are deleted successfully, otherwise returns false.
      Since:
      7.0

    • deleteEnvironmentDocuments

      public RequestStatus deleteEnvironmentDocuments(int environmentId)
      Deletes the Environment Documents of the specified environmentId. Specifying the environmentId is mandatory.
      Parameters:
      environmentId - int
      Returns:
      RequestStatus object - Returns true if Documents are deleted successfully, otherwise returns false.
      Since:
      7.0

    • deleteEnvironmentDocuments

      public RequestStatus deleteEnvironmentDocuments(int systemId, String environmentName)
      Deletes the Environment Documents of the specified environmentName and systemId. Specifying the environmentName and systemId are mandatory.
      Parameters:
      systemId - int
      environmentName - String
      Returns:
      RequestStatus object - Returns true if Documents are deleted successfully, otherwise returns false.
      Since:
      7.0

    • deleteDocument

      public RequestStatus deleteDocument(Node.NodeType nodeType, int docId)
      Deletes the Document for the specified docId of nodeType. Specifying the docId and nodeType are mandatory.
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT.
      Parameters:
      nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      docId - int
      Returns:
      RequestStatus object - Returns true if Document is deleted, otherwise returns false.
      Since:
      7.0

    • getDocument

      public Document getDocument(Node.NodeType nodeType, int docId) throws Exception
      Returns the Document object for the specified docId of nodeType.
      Specification of docId is mandatory, based on which it returns the document information, such as documentName, documentType, documentOwner, documentId, documentObject, documentReference, auditHistory details etc...
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT.
      Parameters:
      nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      docId - int
      Returns:
      Document Object - Returns true if Document Object returned successfully, otherwise returns false.
      Throws:
      Exception
      Since:
      7.0

    • getDocuments

      public ArrayList<Document> getDocuments(Node.NodeType nodeType, List<Integer> docIds) throws Exception
      Returns the List of Document object for the specified List of docId's of the nodeType.
      Specification of docId's and nodeType are mandatory, based on which it returns the document information, such as documentName, documentType, documentOwner, documentId, documentObject, documentReference, auditHistory details etc...
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
      Parameters:
      nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      docIds - List
      Returns:
      ArrayList of Document Objects
      Throws:
      Exception
      Since:
      7.0

    • getEnvironmentDocuments

      public ArrayList<Document> getEnvironmentDocuments(int environmentId) throws Exception
      Returns the List of Document objects for the specified environmentId. Returns all the documents of the particular environment.
      Specification of environmentId is mandatory, based on which it returns the document information, such as documentName, documentType, documentOwner, documentId, documentObject, documentReference, auditHistory details etc... The filePath in the returned document object is RELATIVE.
      Parameters:
      environmentId - int
      Returns:
      ArrayList of Document Objects
      Throws:
      com.icc.exceptions.DaoException
      Exception
      Since:
      7.0

    • deleteDocuments

      public RequestStatus deleteDocuments(Node.NodeType nodeType, List<Integer> docIds)
      Documents are deleted for the specified List of docIds of the given nodeType. specifying the docIds, nodeType are mandatory.
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT.
      Parameters:
      nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      docIds - List
      Returns:
      RequestStatus Object - Returns true if documents are deleted, otherwise returns false.
      Since:
      7.0

    • updateDocument

      public RequestStatus updateDocument(Node.NodeType nodeType, Document document)
      Document is updated as specified in Document Object of the given nodeType. Specifying the nodeType is mandatory.
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Specification of documnetId and documentName in the document object are mandatory.
      Parameters:
      nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      document - Document Object
      Returns:
      RequestStatus Object - Returns true if Document is updated, otherwise returns false.
      Since:
      7.0

    • cloneEnvironment

      public RequestStatus cloneEnvironment(String srcSystemName, String srcEnvironmentName, String tgtSystemName, String tgtEnvironmentName)
      Clone Environment creates another copy of the Environment. i.e it copies the Environment specified as srcEnvironmentName of srcSystemName and creates another copy at the specified tgtSystemName with tgtEnvironmentName.
      Specifying srcSystemName, srcEnvironmentName, tgtSystemName, tgtEnvironmentName are mandatory.
      Parameters:
      srcSystemName - String
      srcEnvironmentName - String
      tgtSystemName - String
      tgtEnvironmentName - String
      Returns:
      RequestStatus Object - Returns true if Environment is cloned, otherwise returns false.
      Since:
      7.0

    • cloneEnvironment

      public RequestStatus cloneEnvironment(int srcSystemId, String srcEnvironmentName, int tgtSystemId, String tgtEnvironmentName)
      Clone Environment creates another copy of the Environment. i.e it copies the Environment specified as srcEnvironmentName at srcSystemId and creates another copy at the specified tgtSystemId with tgtEnvironmentName.
      Specifying srcSystemId, srcEnvironmentName, tgtSystemId, tgtEnvironmentName are mandatory.
      Parameters:
      srcSystemId - int
      srcEnvironmentName - String
      tgtSystemId - int
      tgtEnvironmentName - String
      Returns:
      RequestStatus Object - Returns true if Environment is cloned, otherwise returns false.
      Since:
      7.0

    • cloneEnvironment

      public RequestStatus cloneEnvironment(int environmentId, String tgtSystemName, String tgtEnvironmentName)
      Clone Environment creates another copy of the Environment. i.e it copies the Environment specified with environmentId and creates another copy at the specified tgtSystemName with tgtEnvironmentName.
      Specifying environmentId, tgtSystemName, tgtEnvironmentName are mandatory.
      Parameters:
      environmentId - int
      tgtSystemName - String
      tgtEnvironmentName - String
      Returns:
      RequestStatus Object - Returns true if Environment is cloned, otherwise returns false.
      Since:
      7.0

    • addDocumentAs

      public String addDocumentAs(int nodeId, String nodeType, String documentJsonObj, String outputFormat)
      Document is added for the specified nodeId of nodeType. specifying the nodeId, nodeType, documentName, documentObject or documentLink are mandatory.
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      outputFormat - String - Valid values: JSON or XML
      nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      nodeId - int
      documentJsonObj - String Document Object.
      Returns:
      String - If Document is added successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'documentJsonObj' JSON :

      {
      "documentIntendedPurpose": "",
      "userData": null,
      "documentReferenceNumber": "",
      "documentType": "",
      "documentName": "",
      "documentApprovedBy": "",
      "documentObject": "",
      "approvalRequired": false,
      "documentOwner": "",
      "documentLink": "",
      "documentId": 0,
      "documentReference": "",
      "documentStatus": "",
      "documentApprovedDate": 1460701213000
      }

      Since:
      7.0

    • addDocumentAs

      public String addDocumentAs(String nodeName, int parentNodeId, String parentNodeType, String documentObjJson, String outputFormat)
      Document is added for the specified nodeName, parentNodeId of parentNodeType. Specifying the parentNodeId, parentNodeType, nodeName, documentName, documentObject or docuentLink are mandatory.
      parentNodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the parentNodeType, parentNodeId will be either systemId or environmentId.
      If the parentNodeType is SM_SYSTEM, then the parentNodeId is -1.
      If the parentNodeType is SM_ENVIRONMENT, then the parentNodeId is systemId.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      outputFormat - String - Valid values: JSON or XML
      nodeName - String
      parentNodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      parentNodeId - int
      documentObjJson - String Document Object.
      Returns:
      String - If Document is added successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'documentObjJson' JSON :

      {
      "documentIntendedPurpose": "",
      "userData": null,
      "documentReferenceNumber": "",
      "documentType": "",
      "documentName": "",
      "documentApprovedBy": "",
      "documentObject": "",
      "approvalRequired": false,
      "documentOwner": "",
      "documentLink": "",
      "documentId": 0,
      "documentReference": "",
      "documentStatus": "",
      "documentApprovedDate": 1460701213000
      }

      Since:
      7.0

    • deleteDocumentsAs

      public String deleteDocumentsAs(int nodeId, String nodeType, String outputFormat)
      Deletes the documents of the specified nodeId of nodeType. Specifying the nodeId and nodeType are mandatory.
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      nodeId - int
      nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Documents are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      7.0

    • deleteDocumentsAs

      public String deleteDocumentsAs(String nodeName, int parentNodeId, String parentNodeType, String outputFormat)
      Documents are deleted for the specified nodeName, parentNodeId of parentNodeType. Specifying the parentNodeId, parentNodeType and nodeName are mandatory.
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
      If the parentNodeType is SM_SYSTEM, then the parentNodeId is -1.
      If the parentNodeType is SM_ENVIRONMENT, then the parentNodeId is systemId.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      nodeName - String
      parentNodeId - int
      parentNodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Documents are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      7.0

    • deleteSystemDocumentsAs

      public String deleteSystemDocumentsAs(int systemId, String outputFormat)
      Deletes the systemDocuments for the specified systemId. Specifying the systemId is mandatory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      systemId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If SystemDocuments are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      7.0

    • deleteSystemDocumentsAs

      public String deleteSystemDocumentsAs(String systemName, String outputFormat)
      Deletes the systemDocuments for the specified systemName. Specifying the systemName is mandatory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      systemName - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If SystemDocuments are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      7.0

    • deleteEnvironmentDocumentsAs

      public String deleteEnvironmentDocumentsAs(int environmentId, String outputFormat)
      Deletes the Environment Documents of the specified environmentId. Specifying the environmentId is mandatory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      environmentId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Environment Documents are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      7.0

    • deleteEnvironmentDocumentsAs

      public String deleteEnvironmentDocumentsAs(int systemId, String environmentName, String outputFormat)
      Deletes the Environment Documents of the specified environmentName and systemId. Specifying the environmentName and systemId are mandatory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      systemId - int
      environmentName - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Environment Documents are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      7.0

    • deleteDocumentAs

      public String deleteDocumentAs(String nodeType, int docId, String outputFormat)
      Deletes the Document for the specified docId of nodeType. Specifying the docId and nodeType are mandatory.
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      docId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Document is deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      7.0

    • getDocumentAs

      public String getDocumentAs(String nodeType, int docId, String outputFormat)
      Returns the Document object for the specified docId of nodeType.
      Specification of docId is mandatory, based on which it returns the document information, such as documentName, documentType, documentOwner, documentObject, documentReference, auditHistory details etc...
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      docId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - Document Object is returned.
      Since:
      7.0

    • getDocumentsAs

      public String getDocumentsAs(String nodeType, String docIdsJsonArray, String outputFormat)
      Returns the List of Document object for the specified List of docId's of the nodeType.
      Specification of docId's and nodeType are mandatory, based on which it returns the document information, such as documentName, documentType, documentOwner, documentId, documentObject, documentReference, auditHistory details etc...
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      docIdsJsonArray - List
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - Document Object is returned.
      Since:
      7.0

    • getEnvironmentDocumentsAs

      public String getEnvironmentDocumentsAs(int environmentId, String outputFormat)
      Returns the List of Document objects for the specified environmentId. Returns all the documents of the particular environment.
      Specification of environmentId is mandatory, based on which it returns the document information, such as documentName, documentType, documentOwner, documentId, documentObject, documentReference, auditHistory details etc... The filePath in the returned document object is RELATIVE.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      environmentId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - Document Object is returned.
      Since:
      7.0

    • deleteDocumentsAs

      public String deleteDocumentsAs(String nodeType, String docIdsJsonArray, String outputFormat)
      Documents are deleted for the specified List of docIds of the given nodeType. specifying the docIds, nodeType are mandatory.
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      docIdsJsonArray - List
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Documents are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      7.0

    • updateDocumentAs

      public String updateDocumentAs(String nodeType, String documentObjJson, String outputFormat)
      Document is updated as specified as Document Object of the given nodeType. Specifying the nodeType, documentId, documentName are mandatory.
      nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
      documentObjJson - Document
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Document is updated successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'documentJsonObj' JSON :

      {
      "documentIntendedPurpose": "",
      "userData": null,
      "documentReferenceNumber": "",
      "documentType": "",
      "documentName": "",
      "documentApprovedBy": "",
      "documentObject": "",
      "approvalRequired": false,
      "documentOwner": "",
      "documentLink": "",
      "documentId": 0,
      "documentReference": "",
      "documentStatus": "",
      "documentApprovedDate": 1460701213000
      }

      Since:
      7.0

    • cloneEnvironmentAs

      public String cloneEnvironmentAs(String srcSystemName, String srcEnvironmentName, String tgtSystemName, String tgtEnvironmentName, String outputFormat)
      Clone Environment creates another copy of the Environment. i.e it copies the Environment specified as srcEnvironmentName of srcSystemName and creates another copy at the specified tgtSystemName with tgtEnvironmentName.
      Specifying srcSystemName, srcEnvironmentName, tgtSystemName, tgtEnvironmentName are mandatory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      srcSystemName - String
      srcEnvironmentName - String
      tgtSystemName - String
      tgtEnvironmentName - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Environment is cloned successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      7.0

    • cloneEnvironmentAs

      public String cloneEnvironmentAs(int srcSystemId, String srcEnvironmentName, int tgtSystemId, String tgtEnvironmentName, String outputFormat)
      Clone Environment creates another copy of the Environment. i.e it copies the Environment specified as srcEnvironmentName at srcSystemId and creates another copy at the specified tgtSystemId with tgtEnvironmentName.
      Specifying srcSystemId, srcEnvironmentName, tgtSystemId, tgtEnvironmentName are mandatory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      srcSystemId - int
      srcEnvironmentName - String
      tgtSystemId - int
      tgtEnvironmentName - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Environment is cloned successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      7.0

    • cloneEnvironmentAs

      public String cloneEnvironmentAs(int environmentId, String tgtSystemName, String tgtEnvironmentName, String outputFormat)
      Clone Environment creates another copy of the Environment. i.e it copies the Environment specified with environmentId and creates another copy at the specified tgtSystemName with tgtEnvironmentName.
      Specifying environmentId, tgtSystemName, tgtEnvironmentName are mandatory.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      environmentId - int
      tgtSystemName - String
      tgtEnvironmentName - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Environment is cloned successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      7.0

    • getEnvironment

      public SMEnvironment getEnvironment(int environmentId, boolean fillMetadata) throws Exception
      Deprecated.
      Returns SMEnvironment Object for the specified environmentId.Specifying the environmentId is mandatory.
      Returns all the details pertaining to a specific Environment such as environmentName, systemName in which environment is present, related DB information and its auditHistory. Specifying the environmentId is mandatory in order to retrieve the Environment Details.

      fillMetadata takes the values as true or false. If the fillMetadata value is false, it simply returns the SMEnvironment object i.e all details relating to the environmentId specified. If fillMetadata value is true, then depending upon the value of referenceId it returns the details of the environment based on the referenceId set in the Tables.
      Parameters:
      environmentId - int
      fillMetadata - boolean
      Returns:
      SMEnvironment Object
      Throws:
      Exception
      Since:
      8.0

    • getEnvironment

      public SMEnvironment getEnvironment(int environmentId, boolean fillMetadata, boolean useReferenceId) throws Exception
      Deprecated.
      Returns SMEnvironment Object for the specified environmentId.Specifying the environmentId is mandatory.
      Returns all the details pertaining to a specific Environment such as environmentName, systemName in which environment is present, related DB information and its auditHistory. Specifying the environmentId is mandatory in order to retrieve the Environment Details.

      fillMetadata and useReferenceId takes the values as true or false. If the fillMetadata value is false, it simply returns the SMEnvironment object i.e all details relating to the environmentId specified. If fillMetadata is true and useReferenceId is true, then it returns the environment based on checking the table referenceId which is set to the tables and column referenceId set in the columns of those tables in the specific environment.

      If fillMetadata is true and useReferenceId is false, then it returns the environment with out checking the table referenceId and the column referenceId of those tables and columns of the specific environment.
      Parameters:
      environmentId - int
      fillMetadata - boolean
      useReferenceId - boolean
      Returns:
      SMEnvironment Object
      Throws:
      Exception
      Since:
      8.0

    • getEnvironmentAs

      public String getEnvironmentAs(int environmentId, boolean fillMetadata, boolean useReferenceId, String outputFormat) throws Exception
      Returns SMEnvironment Object for the specified environmentId.Specifying the environmentId is mandatory.
      Returns all the details pertaining to a specific Environment such as environmentName, systemName in which environment is present, related DB information and its auditHistory. Specifying the environmentId is mandatory in order to retrieve the Environment Details.

      fillMetadata and useReferenceId takes the values as true or false. If the fillMetadata value is false, it simply returns the SMEnvironment object i.e all details relating to the environmentId specified. If fillMetadata is true and useReferenceId is true, then it returns the environment based on checking the table referenceId which is set to the tables and column referenceId set in the columns of those tables in the specific environment.

      If fillMetadata is true and useReferenceId is false, then it returns the environment with out checking the table referenceId and the column referenceId of those tables and columns of the specific environment.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      environmentId - int
      fillMetadata - boolean
      useReferenceId - boolean
      outputFormat - String - Valid values: JSON or XML
      Returns:
      SMEnvironment Object
      Throws:
      Exception
      Since:
      8.0

    • getColumns

      public List<SMColumn> getColumns(int tableId) throws Exception
      Returns all the associated columns of the particular table as a list of column objects , for which specifying the tableId is mandatory in order to retrieve the columns. Each column object contains details like column name,column datatype,column length and column precision etc..
      Parameters:
      tableId - int
      Returns:
      SMColumn List.
      Throws:
      Exception
      Since:
      8.2.1

    • getColumn

      public SMColumn getColumn(int columnId, int fillOptions) throws Exception
      Returns SMColumn object for the specified columnId.
      Specifying the columnId and fillOptions are mandatory. The returned SMColumn object contains all the details pertaining to column such as column name, table name in which the column is present, column length, column precision etc... and also contains details of column indexes, column extended properties ,valid values and extended properties of valid values based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of either APIConstants.SMFillOptions.COLUMN_INDEXES or APIConstants.SMFillOptions.COLUMN_EXTENDED_PROPERTIES or APIConstants.SMFillOptions.COLUMN_VALID_VALUES or APIConstants.SMFillOptions.VALID_VALUES_EXTENDED_PROPERTIES. Based on the value passed its related data is returned within the SMColumn object and if you want to get column indexes and column extended properties then fillOptions parameter value will be addition of COLUMN_INDEXES value and COLUMN_EXTENDED_PROPERTIES value i.e 8+16=24 and so on.
      Parameters:
      columnId - int
      fillOptions - APIConstants.SMFillOptions int
      Returns:
      SMColumn object
      Throws:
      Exception
      Since:
      8.2.1

    • getColumns

      public List<SMColumn> getColumns(int tableId, int fillOptions) throws Exception
      Returns all the associated columns of the particular table as a list of column objects , for which specifying the tableId and fillOptions parameters are mandatory in order to retrieve the columns. Each column object contains details like column name,column datatype,column length and column precision etc..and also contains details of column indexes, column extended properties ,valid values and extended properties of valid values based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of either APIConstants.SMFillOptions.COLUMN_INDEXES or APIConstants.SMFillOptions.COLUMN_EXTENDED_PROPERTIES or APIConstants.SMFillOptions.COLUMN_VALID_VALUES or APIConstants.SMFillOptions.VALID_VALUES_EXTENDED_PROPERTIES. Based on the value passed its related data is returned within the SMColumn object and if you want to get column indexes and column extended properties then fillOptions parameter value will be addition of COLUMN_INDEXES value and COLUMN_EXTENDED_PROPERTIES value i.e 8+16=24 and so on.
      Parameters:
      tableId - int
      fillOptions - APIConstants.SMFillOptions int
      Returns:
      SMColumn List
      Throws:
      Exception - if tableId is invalid or user does not have permission.
      Since:
      8.2.1

    • getColumn

      public SMColumn getColumn(int tableId, String columnName, int fillOptions) throws Exception
      Returns SMColumn object for the specified columnName of a particular table whose tableId also specified.
      The returned SMColumn object contains details like column name, table name in which the column is present, column length, column precision etc... and also contains details of column indexes,column extended properties ,valid values and extended properties of valid values based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions. Here fillOptions parameter takes value of either APIConstants.SMFillOptions.COLUMN_INDEXES or APIConstants.SMFillOptions.COLUMN_EXTENDED_PROPERTIES or APIConstants.SMFillOptions.COLUMN_VALID_VALUES or APIConstants.SMFillOptions.VALID_VALUES_EXTENDED_PROPERTIES. Based on the value passed its related data is returned within the SMColumn object and if you want to get column indexes and column extended properties then fillOptions parameter value will be addition of COLUMN_INDEXES value and COLUMN_EXTENDED_PROPERTIES value i.e 8+16=24 and so on. Specifying the tableId, columnName and fillOptions are mandatory.
      Parameters:
      tableId - int
      columnName - String
      fillOptions - APIConstants.SMFillOptions int
      Returns:
      SMColumn object
      Throws:
      Exception
      Since:
      8.2.1

    • getIndexColumns

      public List<SMColumn> getIndexColumns(int tableId, String indexName, int fillOptions) throws Exception
      Returns List of SMColumn objects for the specified tableId of which columns have the specified indexName as index where each column object contains details like column name,column datatype,column length and column precision etc..and also contains details of column indexes, column extended properties ,valid values and extended properties of valid values based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of either APIConstants.SMFillOptions.COLUMN_INDEXES or APIConstants.SMFillOptions.COLUMN_EXTENDED_PROPERTIES or APIConstants.SMFillOptions.COLUMN_VALID_VALUES or APIConstants.SMFillOptions.VALID_VALUES_EXTENDED_PROPERTIES. Based on the value passed, its related data is returned within the SMColumn object and if you want to get column indexes and column extended properties then fillOptions parameter value will be addition of COLUMN_INDEXES value and COLUMN_EXTENDED_PROPERTIES value i.e 8+16=24 and so on. Specifying the tableId ,indexName and fillOptions are mandatory.
      Parameters:
      tableId - int
      indexName - String
      fillOptions - APIConstants.SMFillOptions int
      Returns:
      SMColumn object
      Throws:
      Exception
      Since:
      8.2.1

    • getTable

      public SMTable getTable(int tableId, int fillOptions) throws com.icc.exceptions.DaoException, Exception
      Returns SMTable object for the specified tableId with fillOptions.
      The returned SMTable object contains all the details pertaining to table such as table name,table definition, environment name in which table is present etc...and also contains details of table indexes,all associated table columns and table extended properties based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions can be Integer values of either APIConstants.SMFillOptions.TABLE_INDEXES or APIConstants.SMFillOptions.TABLE_COLUMNS or APIConstants.SMFillOptions.TABLE_EXTENDED_PROPERTIES for example: If you want to get Indexes and it's Columns along with SMTable object, you need to pass the fillOptions parameter value as 3 (TABLE_INDEXES(1) + TABLE_COLUMNS(2)). Specifying the tableId and fillOptions are mandatory in order to fetch the table details.
      Parameters:
      tableId - int
      fillOptions - APIConstants.SMFillOptions int
      Returns:
      SMTable object
      Throws:
      com.icc.exceptions.DaoException
      Exception
      Since:
      8.2.1

    • addIndex

      public RequestStatus addIndex(SMIndex index)
      Inserts a new index for the specified SMIndex Object. SMIndex object should contain all the details pertaining to index such as index name which is mandatory, type,owner etc.. and SMIndex object should also contain either column object or list of column objects to which the index need to be added where columnId is mandatory in each column object.
      Without specifying the index name and columnId, method will fail to create a new index and it returns false. If index is added successfully, RequestStatus.isRequestSuccess() returns true otherwise it returns false.
      Parameters:
      index - SMIndex
      Returns:
      RequestStatus object
      Since:
      8.2.1

    • addIndex

      public RequestStatus addIndex(int columnId, SMIndex index)
      Inserts a new index for the specified columnId and the specified SMIndex object should contain all the details pertaining to index such as index name which is mandatory, type,owner etc.. Specifying the columnId and SMIndex object are mandatory.
      If index is added successfully, RequestStatus.isRequestSuccess() returns true otherwise it returns false.
      Parameters:
      columnId - int
      index - SMIndex
      Returns:
      RequestStatus object
      Since:
      8.2.1

    • addIndexes

      public RequestStatus addIndexes(List<SMIndex> indexes)
      Inserts List of indexes for the specified SMIndex Objects.Each SMIndex object should contain all the details pertaining to index such as index name,type,owner etc...where index name is mandatory and SMIndex object should also contain either column object or list of column objects to which the index need to be added where in columnId is mandatory in each column object.
      Specifying index name in the List of indexes objects and columnId in each column object are mandatory.
      If Indexes are added successfully then RequestStatus.isRequestSuccess() returns true otherwise false.
      Parameters:
      indexes - List
      Returns:
      RequestStatus Object
      Since:
      8.2.1

    • addIndexes

      public RequestStatus addIndexes(int columnId, List<SMIndex> indexes)
      Inserts list of indexes for the specified columnId where in each SMIndex object should contain index name.
      Specifying columnId and list of SMIndex objects are mandatory. If Indexes are added successfully then RequestStatus.isRequestSuccess() returns true otherwise false.
      Parameters:
      columnId - int
      indexes - List
      Returns:
      RequestStatus Object
      Since:
      8.2.1

    • updateIndex

      public RequestStatus updateIndex(SMIndex index)
      Updates the index for the specified SMIndex object. All the information pertaining to the index can be updated. Specifying the index id and name is mandatory to update the index.
      If index is updated successfully, RequestStatus.isRequestSuccess() returns true otherwise false.
      Parameters:
      index - SMIndex
      Returns:
      RequestStatus object
      Since:
      8.2.1

    • updateIndexes

      public RequestStatus updateIndexes(List<SMIndex> indexes)
      Updates the List of indexes for the specified SMIndex Objects. All the information pertaining to the each index can be updated.
      Specifying index ids and names in list of index objects are mandatory.
      If indexes are updated successfully, RequestStatus.isRequestSuccess() returns true otherwise returns false.
      Parameters:
      indexes - List
      Returns:
      RequestStatus object
      Since:
      8.2.1

    • deleteIndexById

      public RequestStatus deleteIndexById(int indexId)
      Removes SMIndex for the specified indexId.
      If the index is deleted successfully, RequestStatus.isRequestSuccess() returns true otherwise returns false.
      Parameters:
      indexId - int
      Returns:
      RequestStatus object
      Since:
      8.2.1

    • deleteIndex

      public RequestStatus deleteIndex(SMIndex index)
      Removes index for the specified SMIndex object. Specifying index id in SMIndex object is mandatory
      If the index is deleted successfully, RequestStatus.isRequestSuccess() returns true otherwise returns false.
      Parameters:
      index - SMIndex
      Returns:
      RequestStatus object
      Since:
      8.2.1

    • deleteIndexesById

      public RequestStatus deleteIndexesById(List<Integer> indexIds)
      Removes indexes for the specified list of index ids. Specifying the indexIds are mandatory. If the indexes are deleted successfully, RequestStatus.isRequestSuccess() returns true otherwise returns false.
      Parameters:
      indexIds - List
      Returns:
      RequestStatus object
      Since:
      8.2.1

    • deleteIndexes

      public RequestStatus deleteIndexes(List<SMIndex> indexes)
      Removes indexes for the specified list of SMIndex objects. Specifying index id in each SMIndex object is mandatory.
      If the indexes are deleted successfully, RequestStatus.isRequestSuccess() returns true otherwise returns false.
      Parameters:
      indexes - List
      Returns:
      RequestStatus object
      Since:
      8.2.1

    • deleteIndexes

      public RequestStatus deleteIndexes(Node.NodeType nodeType, int nodeId)
      Removes indexes for the specified nodeId of nodeType.
      Specification of nodeId and nodeType are mandatory.
      nodeType can be either SM_TABLE or SM_COLUMN. Depending upon the nodeType, nodeId will be either columnId or tableId.
      If nodeType is SM_TABLE then all the associated indexes of the specified tableId are deleted or if nodeType is SM_COLUMN then all the associated indexes of the specified columnId are deleted. If the indexes are deleted successfully, RequestStatus.isRequestSuccess() returns true otherwise returns false.
      Parameters:
      nodeType - Node Object - valid types - SM_TABLE, SM_COLUMN
      nodeId - int
      Returns:
      RequestStatus object
      Since:
      8.2.1

    • getIndex

      public SMIndex getIndex(int indexId) throws Exception
      Returns SMIndex Object for the specified indexId. Specifying the indexId is mandatory.
      The returned SMIndex Object contains all the details of SMIndex such as index name, type,owner..etc and also contains the list of column objects to which the index is assigned.
      Parameters:
      indexId - int
      Returns:
      SMIndex object
      Throws:
      Exception
      Since:
      8.2.1

    • getIndex

      public SMIndex getIndex(int tableId, String indexName) throws Exception
      Returns SMIndex Object for the specified tableId and indexName. i.e the matched SMIndex object with the specified indexName is returned from the specified tableId. Specifying the tableId and indexName are mandatory.
      The returned SMIndex object contains index name, type,owner..etc and list of column objects to which the index is assigned.
      Parameters:
      tableId - int
      indexName - String
      Returns:
      SMIndex object
      Throws:
      Exception
      Since:
      8.2.1

    • getIndexes

      public List<SMIndex> getIndexes(int tableId) throws Exception
      Returns list of SMIndex Objects for the specified tableId. Specifying the tableId is mandatory.
      The returned SMIndex Objects contains all the details of SMIndex such as index name, type,owner..etc and list of column objects to which the indexes are added.
      Parameters:
      tableId - int
      Returns:
      SMIndex object
      Throws:
      Exception
      Since:
      8.2.1

    • getIndexes

      public List<SMIndex> getIndexes(Node.NodeType nodeType, int nodeId) throws Exception
      Returns the list of SMIndex objects for the specified nodeId of nodeType.
      Each SMIndex object contains details like index name, type,owner..etc and list of column objects to which the indexes are added. Specification of nodeId and nodeType are mandatory.
      nodeType can be either SM_TABLE or SM_COLUMN. Depending upon the nodeType, nodeId will be either tableId or columnId.
      Parameters:
      nodeType - Node Object - valid types - SM_TABLE, SM_COLUMN
      nodeId - int
      Returns:
      List - SMIndex Objects.
      Throws:
      Exception
      Since:
      8.2.1

    • getIndex

      public SMIndex getIndex(Node.NodeType nodeType, int nodeId, String indexName) throws Exception
      Returns SMIndex object for the specified nodeId of nodeType and indexName. i.e the matched SMIndex object with the specified indexName is returned from the specified nodeId.
      SMIndex object contains details like index name, type,owner..etc and list of column objects to which the specified index is added. Specification of nodeId and nodeType are mandatory.
      nodeType can be either SM_TABLE or SM_COLUMN. Depending upon the nodeType, nodeId will be either tableId or columnId.
      Parameters:
      nodeType - Node Object - valid types - SM_TABLE, SM_COLUMN
      nodeId - int
      indexName - String
      Returns:
      SMIndex - SMIndex Object.
      Throws:
      Exception
      Since:
      8.2.1

    • getIndex

      public SMIndex getIndex(int indexId, int fillOptions) throws Exception
      Returns SMIndex Object for the specified indexId.Specifying the indexId is mandatory.
      The returned SMIndex Object contains all the details of SMIndex such as index name, type,owner..etc and also contains the list of column objects to which the index is assigned based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of APIConstants.SMFillOptions.INDEX_COLUMN_ASSOCIATES Based on the value passed its related data is returned within the SMIndex object. For example if you want to get associated column objects of the index,then fillOptions parameter value will be INDEX_COLUMN_ASSOCIATES value i.e 128.
      Parameters:
      indexId - int
      fillOptions - APIConstants.SMFillOptions int
      Returns:
      SMIndex object
      Throws:
      Exception
      Since:
      8.2.1

    • getIndex

      public SMIndex getIndex(int tableId, String indexName, int fillOptions) throws Exception
      Returns SMIndex Object for the specified tableId and indexName. i.e the matched SMIndex object with the specified indexName is returned from the specified tableId. Specifying the tableId and indexName are mandatory.
      The returned SMIndex object contains index name, type,owner..etc and also contains the list of column objects to which the index is assigned based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of APIConstants.SMFillOptions.INDEX_COLUMN_ASSOCIATES Based on the value passed its related data is returned within the SMIndex object. For example if you want to get associated column objects of the index,then fillOptions parameter value will be INDEX_COLUMN_ASSOCIATES value i.e 128.
      Parameters:
      tableId - int
      indexName - String
      fillOptions - APIConstants.SMFillOptions int
      Returns:
      SMIndex object
      Throws:
      Exception
      Since:
      8.2.1

    • getIndexes

      public List<SMIndex> getIndexes(int tableId, int fillOptions) throws Exception
      Returns list of SMIndex Objects for the specified tableId. Specifying the tableId is mandatory.
      The returned SMIndex Objects contains all the details of SMIndex such as index name, type,owner..etc and also contains the list of column objects to which the index is assigned based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of APIConstants.SMFillOptions.INDEX_COLUMN_ASSOCIATES Based on the value passed its related data is returned within the SMIndex object. For example if you want to get associated column objects of the index ,then fillOptions parameter value will be INDEX_COLUMN_ASSOCIATES value i.e 128.
      Parameters:
      tableId - int
      fillOptions - APIConstants.SMFillOptions int
      Returns:
      SMIndex object
      Throws:
      Exception
      Since:
      8.2.1

    • getIndexes

      public List<SMIndex> getIndexes(Node.NodeType nodeType, int nodeId, int fillOptions) throws Exception
      Returns the list of SMIndex objects for the specified nodeId of nodeType.
      Each SMIndex object contains details like index name, type,owner..etc and also contains the list of column objects to which the index is assigned based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of APIConstants.SMFillOptions.INDEX_COLUMN_ASSOCIATES Based on the value passed its related data is returned within the SMIndex object. For example if you want to get associated column objects of the index,then fillOptions parameter value will be INDEX_COLUMN_ASSOCIATES value i.e 128.
      Specification of nodeId and nodeType are mandatory,nodeType can be either SM_TABLE or SM_COLUMN. Depending upon the nodeType, nodeId will be either tableId or columnId.
      Parameters:
      nodeType - Node Object - valid types - SM_TABLE, SM_COLUMN
      nodeId - int
      fillOptions - APIConstants.SMFillOptions int
      Returns:
      List - SMIndex Objects.
      Throws:
      Exception
      Since:
      8.2.1

    • getIndex

      public SMIndex getIndex(Node.NodeType nodeType, int nodeId, String indexName, int fillOptions) throws Exception
      Returns SMIndex object for the specified nodeId of nodeType and indexName. i.e the matched SMIndex object with the specified indexName is returned from the specified nodeId.
      SMIndex object contains details like index name, type,owner..etc and also contains the list of column objects to which the index is assigned based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of APIConstants.SMFillOptions.INDEX_COLUMN_ASSOCIATES Based on the value passed its related data is returned within the SMIndex object. For example if you want to get associated column objects of the index,then fillOptions parameter value will be INDEX_COLUMN_ASSOCIATES value i.e 128.
      Specification of nodeId and nodeType are mandatory,nodeType can be either SM_TABLE or SM_COLUMN. Depending upon the nodeType, nodeId will be either tableId or columnId.
      Parameters:
      nodeType - Node Object - valid types - SM_TABLE, SM_COLUMN
      nodeId - int
      indexName - String
      fillOptions - APIConstants.SMFillOptions int
      Returns:
      SMIndex - SMIndex Object.
      Throws:
      Exception
      Since:
      8.2.1

    • getAssignedCodesets

      public List<Codeset> getAssignedCodesets(int columnId) throws Exception
      Deprecated.
      Returns the list of Codeset objects for the specified columnId where each Codeset object contains codeset name,codeset description, codeset status and category name in which Codeset is present etc...
      Specification of columnId is mandatory.
      Parameters:
      columnId - int
      Returns:
      List - Codeset Objects
      Throws:
      Exception
      Since:
      8.2.1

    • getAssignedCodesets

      public List<Codeset> getAssignedCodesets(int columnId, int fillOptions) throws Exception
      Deprecated.
      Returns the list of Codeset objects for the specified columnId. The returned codeset objects contains all the details pertaining to codeset such as codeset name,codeset description,codeset status and category name in which codeset is present etc..and also contains details of codeValue and codeValue's extended properties based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of either com.ads.api.beans.common.APIConstants.SMFillOptions#CODE_VALUES or com.ads.api.beans.common.APIConstants.SMFillOptions#CODE_VALUE_EXTENDED_PROPERTIES Based on the value passed its related data is returned within the Codeset object and if you want to get codeValues and codeValue extended properties then fillOptions parameter value will be addition of CODE_VALUES value and CODE_VALUE_EXTENDED_PROPERTIES value i.e 32+64=96 and so on. Specification of columnId,fillOptions are mandatory.
      Parameters:
      columnId - int
      fillOptions - APIConstants.SMFillOptions int
      Returns:
      List - Codeset Objects
      Throws:
      Exception
      Since:
      8.2.1

    • getValidValues

      public List<CodeValue> getValidValues(int columnId) throws Exception
      Deprecated.
      Returns the List of CodeValue objects for the specified columnId where each CodeValue object contains code name,code value,code description and codeset name in which codeValue is present etc....
      Specification of columnId is mandatory.
      Parameters:
      columnId - int
      Returns:
      List of CodeValue Objects
      Throws:
      Exception
      Since:
      8.2.1

    • getValidValues

      public List<CodeValue> getValidValues(int columnId, int fillOptions) throws Exception
      Deprecated.
      Returns the List of CodeValue objects for the specified columnId. The returned CodeValue objects contains all the details pertaining to CodeValue such as code name,code value,code description,codeset name in which CodeValue is present etc..and also contains details of codeValue's extended properties based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of com.ads.api.beans.common.APIConstants.SMFillOptions#CODE_VALUE_EXTENDED_PROPERTIES whose value is 64. If fillOptions parameter value is passed as 64 then codeValue's extended properties are returned within the CodeValue object. If CodeValue's extended properties are not required then pass 0(zero) which is default value for fillOptions.
      Specification of columnId and fillOptions are mandatory.
      Parameters:
      columnId - int
      fillOptions - APIConstants.SMFillOptions int
      Returns:
      List of CodeValue Objects
      Throws:
      Exception
      Since:
      8.2.1

    • assignCodeset

      public RequestStatus assignCodeset(int columnId, Codeset codeset)
      Deprecated.
      Assigns the specified codeset to the specified columnId. Specifying the columnId and codeset having codesetId are mandatory.
      If the codeset is assigned successfully, RequestStatus.isRequestSuccess() returns true otherwise returns false.
      Parameters:
      columnId - int
      codeset -
      Returns:
      RequestStatus Object
      Since:
      8.2.1

    • assignCodesets

      public RequestStatus assignCodesets(int columnId, List<Codeset> codesets)
      Deprecated.
      Assigns the specified list of codesets to the specified columnId. Specifying the columnId and list of codesets having codesetId are mandatory.
      If the codesets are assigned successfully,RequestStatus.isRequestSuccess() returns true otherwise returns false.
      Parameters:
      columnId - int
      codesets - List
      Returns:
      RequestStatus Object
      Since:
      8.2.1

    • assignCodesets

      public RequestStatus assignCodesets(int columnId, List<Integer> codeSetIds, boolean unassignExisting)
      Deprecated.
      Assigns codesets of specified codeset ids to the specified columnId. Specifying the columnId, list of codeset ids and unassignExisting flag are mandatory.
      unassignExisting flag can be either true or false. If it is true then existing codesets of columnId are unassigned if any and the new codesets are assigned.If it is false then the new codesets are assigned without unassiging existing codesets of columnId.
      If the codeSetIds are assigned successfully, RequestStatus.isRequestSuccess() returns true otherwise returns false.
      Parameters:
      columnId - int
      codeSetIds - List
      unassignExisting - boolean
      Returns:
      RequestStatus Object
      Since:
      8.2.1

    • unassignExistingCodesets

      public RequestStatus unassignExistingCodesets(Node.NodeType nodeType, int nodeId)
      Deprecated.
      Unassigns Existing Codesets for the specified nodeId of nodeType. Specifying the nodeType and nodeId are mandatory.
      Specification of nodeId and nodeType are mandatory, based on these it unassigns the existing codesets of a node.
      nodeType can be either SM_TABLE or SM_COLUMN. Depending upon the nodeType, nodeId will be either tableId or columnId. If the codeSets are unassigned successfully, RequestStatus.isRequestSuccess() returns true otherwise returns false.
      Parameters:
      nodeType - Node Object - valid types - SM_TABLE, SM_COLUMN
      nodeId - int
      Returns:
      RequestStatus Object
      Since:
      8.2.1

    • getColumnAs

      public String getColumnAs(int tableId, String columnName, int fillOptions, String outputFormat) throws Exception
      Returns SMColumn object for the specified columnName of a particular table whose tableId also specified.
      The returned SMColumn object contains details like column name, table name in which the column is present, column length, column precision etc... and also contains details of column indexes,column extended properties ,valid values and extended properties of valid values based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions. Here fillOptions parameter takes value of either APIConstants.SMFillOptions.COLUMN_INDEXES or APIConstants.SMFillOptions.COLUMN_EXTENDED_PROPERTIES or APIConstants.SMFillOptions.COLUMN_VALID_VALUES or APIConstants.SMFillOptions.VALID_VALUES_EXTENDED_PROPERTIES. Based on the value passed its related data is returned within the SMColumn object and if you want to get column indexes and column extended properties then fillOptions parameter value will be addition of COLUMN_INDEXES value and COLUMN_EXTENDED_PROPERTIES value i.e 8+16=24 and so on.
      Specifying the tableId, columnName and fillOptions are mandatory.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      tableId - int
      columnName - String
      fillOptions - APIConstants.SMFillOptions int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      SMColumn object
      Throws:
      Exception
      Since:
      8.2.1

    • getColumnAs

      public String getColumnAs(int columnId, int fillOptions, String outputFormat) throws Exception
      Returns SMColumn object for the specified columnId.
      Specifying the columnId and fillOptions are mandatory. The returned SMColumn object contains all the details pertaining to column such as column name, table name in which the column is present, column length, column precision etc... and also contains details of column indexes, column extended properties ,valid values and extended properties of valid values based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of either APIConstants.SMFillOptions.COLUMN_INDEXES or APIConstants.SMFillOptions.COLUMN_EXTENDED_PROPERTIES or APIConstants.SMFillOptions.COLUMN_VALID_VALUES or APIConstants.SMFillOptions.VALID_VALUES_EXTENDED_PROPERTIES. Based on the value passed its related data is returned within the SMColumn object and if you want to get column indexes and column extended properties then fillOptions parameter value will be addition of COLUMN_INDEXES value and COLUMN_EXTENDED_PROPERTIES value i.e 8+16=24 and so on.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      columnId - int
      fillOptions - APIConstants.SMFillOptions int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - SMColumn object
      Throws:
      Exception
      Since:
      8.2.1

    • getColumnsAs

      public String getColumnsAs(int tableId, int fillOptions, String outputFormat) throws Exception
      Returns all the associated columns of the particular table as a list of column objects , for which specifying the tableId and fillOptions parameters are mandatory in order to retrieve the columns. Each column object contains details like column name,column datatype,column length and column precision etc.. and also contains details of column indexes, column extended properties ,valid values and extended properties of valid values based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of either APIConstants.SMFillOptions.COLUMN_INDEXES or APIConstants.SMFillOptions.COLUMN_EXTENDED_PROPERTIES or APIConstants.SMFillOptions.COLUMN_VALID_VALUES or APIConstants.SMFillOptions.VALID_VALUES_EXTENDED_PROPERTIES. Based on the value passed its related data is returned within the SMColumn object and if you want to get column indexes and column extended properties then fillOptions parameter value will be addition of COLUMN_INDEXES value and COLUMN_EXTENDED_PROPERTIES value i.e 8+16=24 and so on.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      tableId - int
      fillOptions - APIConstants.SMFillOptions int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      SMColumn object
      Throws:
      Exception
      Since:
      8.2.1

    • getColumnsAs

      public String getColumnsAs(int tableId, String outputFormat)
      Returns the columns of the table as String for the specified tableId in the specified outputFormat.
      Returns the list of columns associated with the particular table, for which specifying the tableId is mandatory in order to retrieve the columns.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      tableId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - List of SMColumn objects in the form of JSON String i.e List of columns of a particular Table.
      Since:
      8.2.1

    • getIndexColumnsAs

      public String getIndexColumnsAs(int tableId, String indexName, int fillOptions, String outputFormat) throws Exception
      Returns List of SMColumn objects for the specified tableId of which columns have the specified indexName as index where each column object contains details like column name,column datatype,column length and column precision etc.. and also contains details of column indexes,column extended properties , valid values and extended properties of valid values based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of either APIConstants.SMFillOptions.COLUMN_INDEXES or APIConstants.SMFillOptions.COLUMN_EXTENDED_PROPERTIES or APIConstants.SMFillOptions.COLUMN_VALID_VALUES or APIConstants.SMFillOptions.VALID_VALUES_EXTENDED_PROPERTIES. Based on the value passed its related data is returned within the SMColumn object and if you want to get column indexes and column extended properties then fillOptions parameter value will be addition of COLUMN_INDEXES value and COLUMN_EXTENDED_PROPERTIES value i.e 8+16=24 and so on.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      tableId - int
      indexName - String
      fillOptions - APIConstants.SMFillOptions int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      SMColumn object
      Throws:
      Exception
      Since:
      8.2.1

    • getTableAs

      public String getTableAs(int tableId, int fillOptions, String outputFormat) throws Exception
      Returns SMTable object for the specified tableId with fillOptions.
      The returned SMTable object contains all the details pertaining to table such as table name,table definition, environment name in which table is present etc...and also contains details of table indexes,all associated table columns and table extended properties based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions can be Integer values of either APIConstants.SMFillOptions.TABLE_INDEXES or APIConstants.SMFillOptions.TABLE_COLUMNS or APIConstants.SMFillOptions.TABLE_EXTENDED_PROPERTIES for example: If you want to get Indexes and it's Columns along with SMTable object, you need to pass the fillOptions parameter value as 3 (TABLE_INDEXES(1) + TABLE_COLUMNS(2)). Specifying the tableId and fillOptions are mandatory in order to fetch the table details.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      tableId - int
      fillOptions - APIConstants.SMFillOptions int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - SMTable object
      Throws:
      Exception
      Since:
      8.2.1

    • addIndexAs

      public String addIndexAs(String jsonSMIndex, String outputFormat)
      Inserts a new index for the specified SMIndex Object. SMIndex object should contain all the details pertaining to index such as index name which is mandatory, type,owner etc.. and SMIndex object should also contain either column object or list of column objects to which the index need to be added where columnId is mandatory in each column object.
      Without specifying the index name and columnId, method will fail to create a new index and it returns false.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      jsonSMIndex - String - smIndex Object
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Index is added successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.


      Sample 'jsonSMIndex' JSON :

      {
      "id":0, "tableId":0, "name": "",
      "owner": "",
      "uniqueness": "",
      "sortOrder": "",
      "type": "",
      "ordinalPosition": 0,
      "columns": [
      {
      "columnId": 0
      }
      ]
      }

      Since:
      8.2.1

    • addIndexAs

      public String addIndexAs(int columnId, String jsonSMIndex, String outputFormat)
      Inserts a new index for the specified columnId and the specified SMIndex object should contain all the details pertaining to index such as index name which is mandatory, type,owner etc..
      Specifying the columnId and SMIndex object are mandatory.
      Parameters:
      columnId - int
      jsonSMIndex - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Index is added successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'jsonSMIndex' JSON :

      {
      "id":0, "tableId":0, "name": "",
      "owner": "",
      "uniqueness": "",
      "sortOrder": "",
      "type": "",
      "ordinalPosition": 0
      }

      Since:
      8.2.1

    • addIndexesAs

      public String addIndexesAs(String jsonArraySMIndex, String outputFormat)
      Inserts List of indexes for the specified SMIndex Objects.Each SMIndex object should contain all the details pertaining to index such as index name,type,owner etc...where index name is mandatory and SMIndex object should also contain either column object or list of column objects to which the index need to be added where in columnId is mandatory in each column object.
      Specifying index name in the List of indexes objects and columnId in each column object are mandatory.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      jsonArraySMIndex - String - smIndex Object list
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Indexes are added successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'jsonArraySMIndex' JSON :

      [
      {
      "id":0, "tableId":0, "name": "",
      "owner": "",
      "uniqueness": "",
      "sortOrder": "",
      "type": "test",
      "ordinalPosition": 0,
      "columns": [
      {
      "columnId": 0
      }
      ]
      },
      {
      "id":0, "tableId":0, "name": "",
      "owner": "",
      "uniqueness": "",
      "sortOrder": "",
      "type": "",
      "ordinalPosition": 0,
      "columns": [
      {
      "columnId": 0
      }
      ]
      }
      ]

      Since:
      8.2.1

    • addIndexesAs

      public String addIndexesAs(int columnId, String jsonArraySMIndex, String outputFormat)
      Inserts list of indexes for the specified columnId where in each SMIndex object should contain index name.
      Specifying columnId and list of SMIndex objects are mandatory.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      columnId - int
      jsonArraySMIndex - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If indexes are added successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'jsonArraySMIndex' JSON :

      [
      {
      "id":0, "tableId":0, "name": "",
      "owner": "",
      "uniqueness": "",
      "sortOrder": "",
      "type": "",
      "ordinalPosition": 0,
      },
      {
      "id":0, "tableId":0, "name": "",
      "owner": "",
      "uniqueness": "",
      "sortOrder": "",
      "type": "",
      "ordinalPosition": 0
      }
      ]

      Since:
      8.2.1

    • updateIndexAs

      public String updateIndexAs(String jsonSMIndex, String outputFormat)
      Updates the index for the specified SMIndex object. All the information pertaining to the index can be updated. Specifying the index id and name is mandatory to update the index.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      jsonSMIndex - String - smIndex Object
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If index is updated successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'jsonSMIndex' JSON :

      {
      "id":0, "tableId":0, "name": "",
      "owner": "",
      "uniqueness": "",
      "sortOrder": "",
      "type": "",
      "ordinalPosition": 0,
      "columns": [
      {
      "columnId": 0
      }
      ]
      }

      Since:
      8.2.1

    • updateIndexesAs

      public String updateIndexesAs(String jsonArraySMIndex, String outputFormat)
      Updates the List of indexes for the specified SMIndex Objects. All the information pertaining to the each index can be updated.
      Specifying index ids and names in list of index objects are mandatory.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      jsonArraySMIndex - String - smIndex objects list
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Indexes are updated successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'jsonArraySMIndex' JSON :

      [
      {
      "id":0, "tableId":0, "name": "",
      "owner": "",
      "uniqueness": "",
      "sortOrder": "",
      "type": "",
      "ordinalPosition": 0,
      "columns": [
      {
      "columnId": 0
      }
      ]
      },
      {
      "id":0, "tableId":0, "name": "",
      "owner": "",
      "uniqueness": "",
      "sortOrder": "",
      "type": "",
      "ordinalPosition": 0,
      "columns": [
      {
      "columnId": 0
      }
      ]
      }
      ]

      Since:
      8.2.1

    • deleteIndexByIdAs

      public String deleteIndexByIdAs(int indexId, String outputFormat)
      Removes SMIndex for the specified indexId.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      indexId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If index is deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      8.2.1

    • deleteIndexAs

      public String deleteIndexAs(String jsonSMIndex, String outputFormat)
      Removes index for the specified SMIndex object. Specifying index id in SMIndex object is mandatory.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      jsonSMIndex - String - smIndex Object
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If index is deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.


      Sample 'jsonSMIndex' JSON :

      {
      "id":0, "tableId":0, "name": "",
      "owner": "",
      "uniqueness": "",
      "sortOrder": "",
      "type": "",
      "ordinalPosition": 0
      }

      Since:
      8.2.1

    • deleteIndexesByIdsAs

      public String deleteIndexesByIdsAs(String jsonArrayIndexId, String outputFormat)
      Removes indexes for the specified list of index ids. Specifying index ids are mandatory.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      jsonArrayIndexId - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Indexes are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      8.2.1

    • deleteIndexesAs

      public String deleteIndexesAs(String jsonArraySMIndex, String outputFormat)
      Removes indexes for the specified list of SMIndex objects. Specifying index id in each SMIndex object is mandatory.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      jsonArraySMIndex - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Indexes are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'jsonArraySMIndex' JSON :

      [
      {
      "id":0, "tableId":0, "name": "",
      "owner": "",
      "uniqueness": "",
      "sortOrder": "",
      "type": "",
      "ordinalPosition": 0,
      "columns": [
      {
      "columnId": 0
      }
      ]
      },
      {
      "id":0, "tableId":0, "name": "",
      "owner": "",
      "uniqueness": "",
      "sortOrder": "",
      "type": "",
      "ordinalPosition": 0,
      "columns": [
      {
      "columnId": 0
      }
      ]
      }
      ]

      Since:
      8.2.1

    • deleteIndexesAs

      public String deleteIndexesAs(String nodeType, int nodeId, String outputFormat)
      Removes indexes for the specified nodeId of nodeType.
      Specification of nodeId and nodeType are mandatory.
      nodeType can be either SM_TABLE or SM_COLUMN. Depending upon the nodeType, nodeId will be either columnId or tableId.
      If nodeType is SM_TABLE then all the associated indexes of the specified tableId are deleted or if nodeType is SM_COLUMN then all the associated indexes of the specified columnId are deleted.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      nodeType - Node Object - valid types - SM_TABLE, SM_COLUMN
      nodeId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Indexes are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      8.2.1

    • getIndexAs

      public String getIndexAs(int indexId, int fillOptions, String outputFormat)
      Returns SMIndex Object for the specified indexId in the specified outputFormat. Specifying the indexId is mandatory.
      The returned SMIndex Object contains all the details of SMIndex such as index name, type,owner..etc and also contains the list of column objects to which the index is assigned based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of either APIConstants.SMFillOptions.INDEX_COLUMN_ASSOCIATES Based on the value passed its related data is returned within the SMIndex object. for example if you want to get column objects then fillOptions parameter value will be INDEX_COLUMN_ASSOCIATES value i.e 128.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      indexId - int
      fillOptions - APIConstants.SMFillOptions int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - SMIndex object in the form of JSON or XML String.
      Since:
      8.2.1

    • getIndexAs

      public String getIndexAs(int tableId, String indexName, int fillOptions, String outputFormat)
      Returns SMIndex Object for the specified tableId and indexName.Specifying the tableId and indexName are mandatory.
      The returned SMIndex object contains index name, type,owner..etc and also contains the list of column objects to which the index is assigned based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of either APIConstants.SMFillOptions.INDEX_COLUMN_ASSOCIATES Based on the value passed its related data is returned within the SMIndex object. for example if you want to get column objects then fillOptions parameter value will be INDEX_COLUMN_ASSOCIATES value i.e 128.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      tableId - int
      indexName - String
      fillOptions - APIConstants.SMFillOptions int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - SMIndex object in the form of JSON or XML String.
      Since:
      8.2.1

    • getIndexesAs

      public String getIndexesAs(int tableId, int fillOptions, String outputFormat)
      Returns list of SMIndex Objects for the specified tableId. Specifying the tableId is mandatory.
      The returned SMIndex Objects contains all the details of SMIndex such as index name, type,owner..etc and also contains the list of column objects to which the index is assigned based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of either APIConstants.SMFillOptions.INDEX_COLUMN_ASSOCIATES Based on the value passed its related data is returned within the SMIndex object. for example if you want to get column objects then fillOptions parameter value will be INDEX_COLUMN_ASSOCIATES value i.e 128.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      tableId - int
      fillOptions - APIConstants.SMFillOptions int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - SMIndex object in the form of JSON or XML String.
      Since:
      8.2.1

    • getIndexesAs

      public String getIndexesAs(String nodeType, int nodeId, int fillOptions, String outputFormat)
      Returns the list of SMIndex objects for the specified nodeId of nodeType.
      Each SMIndex object contains details like index name, type,owner..etc and also contains the list of column objects to which the index is assigned based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of either APIConstants.SMFillOptions.INDEX_COLUMN_ASSOCIATES Based on the value passed its related data is returned within the SMIndex object. for example if you want to get column objects then fillOptions parameter value will be INDEX_COLUMN_ASSOCIATES value i.e 128.
      Specification of nodeId and nodeType are mandatory, nodeType can be either SM_TABLE or SM_COLUMN. Depending upon the nodeType, nodeId will be either tableId or columnId.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      nodeType - Node Object - valid types - SM_TABLE, SM_COLUMN
      nodeId - int
      fillOptions - APIConstants.SMFillOptions int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - SMIndex Object in the form of JSON or XML String.
      Since:
      8.2.1

    • getIndexAs

      public String getIndexAs(String nodeType, int nodeId, String indexName, int fillOptions, String outputFormat)
      Returns SMIndex object for the specified nodeId of nodeType and indexName.
      SMIndex object contains details like index name, type,owner..etc and also contains the list of column objects to which the index is assigned based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of either APIConstants.SMFillOptions.INDEX_COLUMN_ASSOCIATES Based on the value passed its related data is returned within the SMIndex object. for example if you want to get column objects then fillOptions parameter value will be INDEX_COLUMN_ASSOCIATES value i.e 128.
      Specification of nodeId and nodeType are mandatory, nodeType can be either SM_TABLE or SM_COLUMN. Depending upon the nodeType, nodeId will be either tableId or columnId.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      nodeType - Node Object - valid types - SM_TABLE, SM_COLUMN
      nodeId - int
      indexName - String
      fillOptions - APIConstants.SMFillOptions int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - SMIndex Object in the form of JSON or XML String.
      Since:
      8.2.1

    • getAssignedCodesetsAs

      public String getAssignedCodesetsAs(int columnId, String outputFormat)
      Deprecated.
      Returns the list of Codeset objects for the specified columnId where each Codeset object contains codeset name,codeset description, codeset status and category name in which Codeset is present etc...
      Specification of columnId is mandatory.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      columnId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - List of Codeset Objects in the form of JSON or XML String
      Since:
      8.2.1

    • getAssignedCodesetsAs

      public String getAssignedCodesetsAs(int columnId, int fillOptions, String outputFormat)
      Deprecated.
      Returns the list of Codeset objects for the specified columnId. The returned codeset objects contains all the details pertaining to codeset such as codeset name,codeset description,codeset status and category name in which codeset is present etc..and also contains details of codeValue and codeValue's extended properties based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of either com.ads.api.beans.common.APIConstants.SMFillOptions.CODE_VALUES or com.ads.api.beans.common.APIConstants.SMFillOptions.CODE_VALUE_EXTENDED_PROPERTIES Based on the value passed its related data is returned within the Codeset object and if you want to get codeValues and codeValue extended properties then fillOptions parameter value will be addition of CODE_VALUES value and CODE_VALUE_EXTENDED_PROPERTIES value i.e 32+64=96 and so on. Specification of columnId,fillOptions flag are mandatory.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      columnId - int
      fillOptions - APIConstants.SMFillOptions int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - List of Codeset Objects in the form of JSON or XML String
      Since:
      8.2.1

    • getValidValuesAs

      public String getValidValuesAs(int columnId, String outputFormat)
      Deprecated.
      Returns the List of CodeValue objects for the specified columnId where each CodeValue object contains code name,code value,code description and codeset name in which codeValue is present etc....
      Specification of columnId is mandatory.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      columnId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - List of CodeValue Objects in the form of JSON or XML String
      Since:
      8.2.1

    • getValidValuesAs

      public String getValidValuesAs(int columnId, int fillOptions, String outputFormat)
      Deprecated.
      Returns the List of CodeValue objects for the specified columnId. The returned CodeValue objects contains all the details pertaining to CodeValue such as code name,code value,code description,codeset name in which CodeValue is present etc..and also contains details of codeValue's extended properties based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions is fillExtendedProps whose value is 64. If fillOptions value is 64 then CodeValue's extended properties are returned.If CodeValue's extended properties are not required then pass 0(zero) which is default value for fillOptions.
      Specification of columnId and fillOptions are mandatory. OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      columnId - int
      fillOptions - APIConstants.SMFillOptions int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - List of CodeValue Objects in the form of JSON or XML String
      Since:
      8.2.1

    • assignCodesetAs

      public String assignCodesetAs(int columnId, String jsonCodeset, String outputFormat)
      Deprecated.
      Assigns the specified codeset to the specified columnId. Specifying the columnId and codeset having codesetId are mandatory.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      columnId - int
      jsonCodeset - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Codeset is assigned successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'jsonCodeset' 'JSON :

      {
      "changedDescription": "",
      "releaseFlag": false,
      "codeValues": [],
      "description": " ",
      "published": false,
      "version": 0,
      "versionLabel": "",
      "lockedBy": "",
      "name": "",
      "id": 0,
      "publishEnvironments": [],
      "categoryId": 0,
      "status": ""
      }

      Since:
      8.2.1

    • assignCodesetsAs

      public String assignCodesetsAs(int columnId, String jsonArrayCodeset, String outputFormat)
      Deprecated.
      Assigns the specified list of codesets to the specified columnId. Specifying the columnId and list of codesets having codesetId are mandatory.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      columnId - int
      jsonArrayCodeset - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Codesets are assigned successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'jsonArrayCodeset' JSON :

      [ {
      "changedDescription": "",
      "releaseFlag": false,
      "codeValues": [],
      "description": " ",
      "published": false,
      "version": 0,
      "versionLabel": "",
      "lockedBy": "",
      "name": "",
      "id": 0,
      "publishEnvironments": [],
      "categoryId": 0,
      "status": ""
      },
      {
      "changedDescription": "",
      "releaseFlag": false,
      "codeValues": [],
      "description": " ",
      "published": false,
      "version": 0,
      "versionLabel": "",
      "lockedBy": "",
      "name": "",
      "id": 0,
      "publishEnvironments": [],
      "categoryId": 0,
      "status": ""
      }
      ]

      Since:
      8.2.1

    • assignCodesetsAs

      public String assignCodesetsAs(int columnId, String jsonArrayCodeSetIds, boolean unassignExisting, String outputFormat)
      Deprecated.
      Assigns codesets of specified codeset ids to the specified columnId. Specifying the columnId, list of codeset ids and unassignExisting flag are mandatory.
      unassignExisting flag can be either true or false. If it is true then existing codesets are unassigned if any and the new codesets are assigned. If it is false then the new codesets are assigned without unassiging existing codesets.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      columnId - int
      jsonArrayCodeSetIds - String
      unassignExisting - boolean
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Codesets are assigned successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'jsonArrayCodesetsIds' JSON :

      [1,2,3]

      Since:
      8.2.1

    • unassignExistingCodesetsAs

      public String unassignExistingCodesetsAs(String nodeType, int nodeId, String outputFormat)
      Deprecated.
      Unassigns ExistingCodesets for the specified nodeId of nodeType. Specifying the nodeType and nodeId are mandatory, based on these it unassigns the existing codesets of a node. nodeType can be either SM_TABLE or SM_COLUMN. Depending upon the nodeType, nodeId will be either tableId or columnId.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
      Parameters:
      nodeType - String
      nodeId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Codesets are unassigned successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      8.2.1

    • publishTable

      public RequestStatus publishTable(int tableId)
      Table is published for the specified tableId. specifying the tableId is mandatory.
      Parameters:
      tableId - int
      Returns:
      RequestStatus - If table is published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc...
      Since:
      8.3

    • publishColumn

      public RequestStatus publishColumn(int columnId)
      Column is published for the specified columnId. specifying the columnId is mandatory.
      Parameters:
      columnId - int
      Returns:
      RequestStatus - If table is published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc...
      Since:
      8.3

    • publishNode

      public RequestStatus publishNode(Node.NodeType nodeType, int nodeId)
      Node is published for the specified nodeId. Specifying the nodeId is mandatory. nodeType can be either SM_TABLE, SM_COLUMN. Depending upon the nodeType, nodeId will be either tableId or columnId.
      Parameters:
      nodeId - int
      nodeType - Node.NodeType - valid Types are SM_TABLE, SM_COLUMN
      Returns:
      RequestStatus - If node is published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc...
      Since:
      8.3

    • publishTableAs

      public String publishTableAs(int tableId, String outputFormat)
      Table is published for the specified tableId. specifying the tableId is mandatory.
      Parameters:
      outputFormat - String - Valid values: JSON or XML- Valid values: JSON or XML
      tableId - int
      Returns:
      String - If table is published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      8.3

    • publishColumnAs

      public String publishColumnAs(int columnId, String outputFormat)
      Column is published for the specified columnId. specifying the columnId is mandatory.
      Parameters:
      outputFormat - String - Valid values: JSON or XML- Valid values: JSON or XML
      columnId - int
      Returns:
      String - If table is published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      8.3

    • publishNodeAs

      public String publishNodeAs(String nodeType, int nodeId, String outputFormat)
      Node is published for the specified nodeId. Specifying the nodeId is mandatory. nodeType can be either SM_TABLE, SM_COLUMN. Depending upon the nodeType, nodeId will be either tableId or columnId.
      Parameters:
      outputFormat - String - Valid values: JSON or XML - Valid values: JSON or XML
      nodeId - int
      nodeType - String - valid Types are SM_TABLE, SM_COLUMN
      Returns:
      String - If node is published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      8.3

    • publishTables

      public RequestStatus publishTables(List<Integer> tableIds)
      Tables are published for the specified tableIds, specifying the list of tableIds are mandatory. since 8.3
      Parameters:
      tableIds - List - List of tableIds
      Returns:
      RequestStatus - If tables are published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc...
      Since:
      8.3

    • publishColumns

      public RequestStatus publishColumns(List<Integer> columnIds)
      Columns are published for the specified columnIds, specifying the list of columnIds are mandatory.
      Parameters:
      columnIds - List - List of columnIds
      Returns:
      RequestStatus - If columns are published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc...
      Since:
      8.3

    • publishNodes

      public RequestStatus publishNodes(Node.NodeType nodeType, List<Integer> nodeIds)
      Nodes are published for the specified nodeIds. Specifying the nodeIds are mandatory. nodeType can be either SM_TABLE, SM_COLUMN. Depending upon the nodeType, nodeIds will be either tableIds or columnIds.
      Parameters:
      nodeType - Node.NodeType - Valid types: SM_TABLE, SM_COLUMN
      nodeIds - List - List of nodeIds
      Returns:
      RequestStatus - If columns are published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc...
      Since:
      8.3

    • publishTablesAs

      public String publishTablesAs(String tableIdsJsonArray, String outputFormat)
      Tables are published for the specified tableIds, specifying the list of tableIds are mandatory.
      Parameters:
      outputFormat - String - Valid values: JSON or XML - Valid values: JSON or XML
      tableIdsJsonArray - String - List of tableIds
      Returns:
      String - If tables are published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      8.3

    • publishColumnsAs

      public String publishColumnsAs(String columnIdsJsonArray, String outputFormat)
      Columns are published for the specified columnIds, specifying the list of columnIds are mandatory.
      Parameters:
      outputFormat - String - Valid values: JSON or XML - Valid values: JSON or XML
      columnIdsJsonArray - String - List of columnIds
      Returns:
      String - If columns are published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      8.3

    • publishNodesAs

      public String publishNodesAs(String nodeType, String nodeIdsJsonArray, String outputFormat)
      Nodes are published for the specified nodeIds. Specifying the nodeIds are mandatory. nodeType can be either SM_TABLE, SM_COLUMN. Depending upon the nodeType, nodeIds will be either tableIds or columnIds.
      Parameters:
      outputFormat - String - Valid values: JSON or XML - Valid values: JSON or XML
      nodeType - String - Valid types: SM_TABLE, SM_COLUMN
      nodeIdsJsonArray - String - List of nodeIds
      Returns:
      String - If columns are published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
      Since:
      8.3

    • scanIntoEnvironment

      public RequestStatus scanIntoEnvironment(int environmentId, DBHelper dbHelper, DBProperties.Operation dbOperation) throws Exception
      Scan and save the environment meta data into the specified environmentId by specifying the dbOperation and dbHelper object.

      The following properties in the dbHelper object are mandatory:

      databaseType - This defines the type of the database to be scanned and saved. For values reference at DBProperties.DatabaseType. Depending on this value, mandatory values will vary from one database to other.

      If the databaseType value retrieved from the dbHelper Object is RDBMS database, then the environment is loaded and persisted into specified environment by specifying the dbUrl, dbDriver,dbUserName,dbPassword, dbName, dbSchema, databaseType, ipAddress, scanCriteria,readColumns,readComments,readTables, readViews, readSynonyms and selectedTables/selectedViews/selectedSynonyms etc.

      If the databaseType value retrieved from dbHelper object is file based database, then the environment is loaded and persisted into specified environment by specifying the filePath (i.e the location from which the file can be read), scanCriteria,readColumns, readComments, readTables, readViews,readSynonyms and selectedTables/selectedViews/selectedSynonyms etc.

      scanCriteria - This defines the selection criteria of objects(TABLES/VIEWS/SYNONYMS/COMPONENTS) to be saved into the specified environment. This takes either INCLUDE_SELECTION or EXCLUDE_SELECTION or ALL. For values reference at DBHelper.ScanCriteria).
      If the scanCriteria value is INCLUDE_SELECTION then the only selected objects are loaded and persisted or if the scanCriteria value is EXCLUDE_SELECTION then apart from selected objects, the rest of the objects from the database are loaded and persisted or if the scanCriteria value is ALL then all the objects in the database are loaded and persisted into specified environment. Here objects refers to TABLES/VIEWS/SYNONYMS/COMPONENTS. If the database contains nested tables, then need to specify the declarationPath for the nested tables.

      filePath - This property is mandatory when the databaseType is file based database.
      filePathType - The supported values for the filePathType are ABSOLUTE, RELATIVE.

      useReferenceId - This property in dbHelper is used only for ERWIN and CWM file based databases and it accepts boolean value true or false.

      modelType & readLogicalColumns - These properties from the dbHelper object are used for only ERWIN file based databases.
      modelType defines the order in which the tables are displayed and readLogicalColumns value defines whether to skip logical columns or not.
      The value of modelType value can be either PHYSICAL OR LOGICAL (For values reference at DBHelper.ModelType)). DBHelper.ModelType default value is PHYSICAL.
      The value of readLogicalColumns accepts boolean value true or false.
      importSdi - This flag is used to import sensitive data for SQL Server, ORACLE and SNOWFLAKE databases. If it is sets to true, the sensitive information will be scanned.

      dbOperation - DBProperties Object specifies the operation modes in which the environment will be saved i.e fresh upload, update append and append modes(for values reference DBProperties.Operation).
      Simple append mode is used when environment is saved for the first time i.e add new option.
      Update append mode is used when previously loaded environment is modified and few new tables are appended to the environment.
      Fresh upload mode is used when the previously loaded environment tables are to be deleted and new tables will be inserted in to the environment.
      update append invalidate mode is used when previously loaded meta data is modified and few new tables needs to appended and few scanned tables need to be invalidated in the environment.

      If environment is saved successfully, RequestStatus.isRequestSuccess() will return true otherwise false.

      Sample input script for this:

      function execute()
      {
      var dbHelper = new DBHelper();
      dbHelper.setDbUrl("jdbc:sqlserver://hostname:1433;databaseName=dbname");
      dbHelper.setDbDriver("com.microsoft.sqlserver.jdbc.SQLServerDriver");
      dbHelper.setDbUserName("username");
      dbHelper.setDbPassword("***");
      dbHelper.setDbName("dnname");
      dbHelper.setDbSchema("schemaname");
      dbHelper.setDatabaseType(DBProperties.DatabaseType.SQLSERVER);
      dbHelper.setReadColumns(true);
      dbHelper.setReadComments(false);
      dbHelper.setReadTables(true);
      dbHelper.setReadViews(false);
      dbHelper.setReadSynonyms(false);
      dbHelper.setIpAddress("hostname");
      dbHelper.setFilePath(""); //For filebased databases
      dbHelper.setFilePathType(APIConstants.FilePathType.RELATIVE); dbHelper.setModelType(DBHelper.ModelType.PHYSICAL); //For erwin database
      dbHelper.setReadLogicalColumns(false);
      dbHelper.setImportSdi(false);
      dbHelper.setScanCriteria(DBHelper.ScanCriteria.INCLUDE_SELECTION);
      var selectedTablesMap = new HashMap();
      var selList = new ArrayList();
      selList.add("ADS_FORM");
      selectedTablesMap.put("dbo",selList);
      dbHelper.setSelectedTables(selectedTablesMap);
      var reqStat = smutil.scanIntoEnvironment(22, dbHelper,DBProperties.Operation.FRESH_UPLOAD);
      return reqStat.isRequestSuccess()+"====>"+reqStat.getStatusMessage();
      }

      Parameters:
      environmentId - int
      dbHelper - object
      dbOperation - String
      Returns:
      RequestStatus - RequestStatus object.
      Throws:
      Exception
      Since:
      9.0

    • scanIntoEnvironmentAs

      public String scanIntoEnvironmentAs(int environmentId, String dbHelperJson, String dbOperation, String outputFormat)
      Scan and save the environment meta data into the specified environmentId by specifying the dbOperation and dbHelper object in the form of json.
      outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.

      The following properties in the dbHelper object are mandatory:

      databaseType - This defines the type of the database to be scanned and saved. For values reference at DBProperties.DatabaseType. Depending on this value, mandatory values will vary from one database to other.

      If the databaseType value retrieved from the dbHelper Object is RDBMS database, then the environment is loaded and persisted into specified environment by specifying the dbUrl, dbDriver,dbUserName,dbPassword, dbName, dbSchema, databaseType, ipAddress, scanCriteria,readColumns,readComments,readTables, readViews, readSynonyms and selectedTables/selectedViews/selectedSynonyms etc.

      If the databaseType value retrieved from dbHelper object is file based database, then the environment is loaded and persisted into specified environment by specifying the filePath (i.e the location from which the file can be read), scanCriteria,readColumns, readComments, readTables, readViews,readSynonyms and selectedTables/selectedViews/selectedSynonyms etc.

      scanCriteria - This defines the selection criteria of objects(TABLES/VIEWS/SYNONYMS/COMPONENTS) to be saved into the specified environment. This takes either INCLUDE_SELECTION or EXCLUDE_SELECTION or ALL. For values reference at DBHelper.ScanCriteria).
      If the scanCriteria value is INCLUDE_SELECTION then the only selected objects are loaded and persisted or if the scanCriteria value is EXCLUDE_SELECTION then apart from selected objects, the rest of the objects from the database are loaded and persisted or if the scanCriteria value is ALL then all the objects in the database are loaded and persisted into specified environment. Here objects refers to TABLES/VIEWS/SYNONYMS/COMPONENTS. If the database contains nested tables, then need to specify the declarationPath for the nested tables.

      filePath - This property is mandatory when the databaseType is file based database.
      filePathType - The supported values for the filePathType are ABSOLUTE, RELATIVE.

      useReferenceId - This property in dbHelper is used only for ERWIN and CWM file based databases and it accepts boolean value true or false.

      modelType & readLogicalColumns - These properties from the dbHelper object are used for only ERWIN file based databases.
      modelType defines the order in which the tables are displayed and readLogicalColumns value defines whether to skip logical columns or not.
      The value of modelType value can be either PHYSICAL OR LOGICAL (For values reference at DBHelper.ModelType)). DBHelper.ModelType default value is PHYSICAL.
      The value of readLogicalColumns accepts boolean value true or false.
      importSdi - This flag is used to import sensitive data for SQL Server, ORACLE and SNOWFLAKE databases. If it is sets to true, the sensitive information will be scanned.

      dbOperation - DBProperties Object specifies the operation modes in which the environment will be saved i.e fresh upload, update append and append modes(for values reference DBProperties.Operation).
      Simple append mode is used when environment is saved for the first time i.e add new option.
      Update append mode is used when previously loaded environment is modified and few new tables are appended to the environment.
      Fresh upload mode is used when the previously loaded environment tables are to be deleted and new tables will be inserted in to the environment.
      update append invalidate mode is used when previously loaded meta data is modified and few new tables needs to appended and few scanned tables need to be invalidated in the environment.

      If environment is saved successfully, RequestStatus.isRequestSuccess() will return true otherwise false.

      Parameters:
      environmentId - int
      dbHelperJson - in json format
      dbOperation - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - RequestStatus object in the form of JSON String.

      Sample 'dbHelperJson' JSON :
      {
      "dbUrl": "jdbc:sqlserver://hostname:1433;databaseName=database_name",
      "dbDriver": "com.microsoft.sqlserver.jdbc.SQLServerDriver",
      "dbUserName": "user name",
      "dbPassword": "******",
      "dbName": "database name",
      "dbSchema": "schema name",
      "databaseType": "SQLSERVER",
      "scanCriteria": "INCLUDE_SELECTION",
      "readColumns": true,
      "readComments": false,
      "readTables": true,
      "readViews": true,
      "readSynonyms": true,
      "readLogicalColumns": false,
      "selectedTables": {
      "dbo": [
      "ADS_FORM"
      ]
      },
      "selectedViews": {},
      "selectedSynonyms": {},
      "autoCommit": true,
      "filePath": "D:\\files to scan\\ERWin\\Demo Model1_10.xml", ==> (for file based databases)
      "filePathType":"RELATIVE",
      "importSdi" : false,
      "modelType": "PHYSICAL", ==> (for erwin database)
      "useReferenceId": false, ==> (for erwin & cwm databases)
      "supportAutoCommit": false ==>(for BigQuery database)
      }

      Since:
      9.0

    • updateEnvironmentMetadata

      public RequestStatus updateEnvironmentMetadata(DBEnvironment dbEnvironment, DBProperties.Operation operation, boolean useReferenceId)
      Saves the environment for the specified DBEnvironment Object, DBProperties and useReferenceId. Specification of DBEnvironment Object, DBProperties Object, systemId, environmentId, databaseType and useReferenceId are mandatory.

      DBEnvironment Object specifies the options update, insert, validate, invalidate and skip depending on the databaseType including which it gives the table count,views count and synonyms count.
      DBProperties Object specifies the operation modes in which the environment will be saved i.e fresh upload, update append and append modes.
      Simple append mode is used when environment is save for the first time i.e add new option.
      Update append mode is used when previously loaded environment is modified and few new tables are appended to the environment.
      Fresh upload mode is used when the previously loaded environment tables are to be deleted and new tables will be inserted in to the environment.
      update append invalidate mode is used when previously loaded meta data is modified and few new tables needs to appended and few scanned tables need to be invalidated in the environment.

      useReferenceId value is set to true or false depending on the databaseType in which the environment is saved. If environment is saved successfully, RequestStatus.isRequestSuccess() will return true otherwise false.

      Parameters:
      dbEnvironment - DBEnvironment
      operation - DBProperties
      useReferenceId - boolean
      Returns:
      RequestStatus object
      Since:
      9.0

    • updateEnvironmentMetadataAs

      public String updateEnvironmentMetadataAs(String dbEnvironmentObjJson, String operation, boolean useReferenceId, String outputFormat)
      Saves the environment for the specified DBEnvironment Object, DBProperties and useReferenceId. Specification of DBEnvironment Object, DBProperties Object, systemId, environmentID, databaseType and useReferenceId are mandatory.

      DBEnvironment Object specifies the options update, insert, validate, invalidate and skip depending on the databaseType including which it gives the table count,views count and synonyms count.
      DBProperties Object specifies the operation modes in which the environment will be saved i.e fresh upload, update append and append modes.
      simple append mode is used when environment is save for the first time i.e add new option.
      update append mode is used when previously loaded environment is modified and few new tables are appended to the environment.
      fresh upload mode is used when the previously loaded environment tables are to be deleted and new tables will be inserted in to the environment.
      update append invalidate mode is used when previously loaded meta data is modified and few new tables needs to appended and few scanned tables need to be invalidated in the environment.

      useReferenceId value is set to true or false depending on the databaseType in which the environment is saved. If environment is saved successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
      outputFormat can be either dbHelperObj or XML. If outputFormat is not specified, by default the method will return the dbHelperObj String.

      Parameters:
      dbEnvironmentObjJson - dbEnvironment Object
      operation - DBProperties.Operation
      useReferenceId - boolean
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - If Environment is saved successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.

      Sample 'dbEnvironmentObjJson' JSON :

      {
      "environmentName": "",
      "system": {
      "systemId": 0
      },
      "schemas": {
      "dbo": {
      "schemaName": "",
      "viewMap": {},
      "synonymMap": {},
      "tableMap": {
      "dbo.table1": {
      "tableName": "",
      "tableComments": "",
      "createdBy": "",
      "createdDateTime": 1428994708798,
      "lastModifiedBy": "",
      "lastModifiedDateTime": 1428994708798,
      "tableType": "",
      "columnMap": {
      "column1": {
      "columnName": "",
      "datatype": "",
      "length": "50",
      "precision": "20",
      "createdBy": "",
      "createdDatetime": 1428994708798,
      "lastModifiedBy": "",
      "lastModifiedDatetime": 1428994708798,
      "scale": "10"
      }
      }
      }
      }
      }
      }
      }

      Since:
      9.0

    • publishEnvironments

      public RequestStatus publishEnvironments(List<Integer> environmentIds)
      Environments are published for the specified environmentIds, specifying the list of environmentIds are mandatory.
      Parameters:
      environmentIds - List - List of environmentIds
      Returns:
      RequestStatus - If tables are published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc...
      Since:
      9.1

    • loadNewDataAssetCofig

      public org.json.JSONObject loadNewDataAssetCofig(int systemId, boolean isHTML, String visibility)
      Parameters:
      systemId -
      isHTML -
      visibility -
      Returns:
      Since:
      9.1

    • saveNewDataAsset

      public RequestStatus saveNewDataAsset(int systemId, org.json.JSONObject datasetDetails)
      Parameters:
      systemId -
      datasetDetails -
      Returns:
      Since:
      9.1

    • updateDataAsset

      public RequestStatus updateDataAsset(int systemId, int environmentId, org.json.JSONObject datasetDetails)
      Parameters:
      systemId -
      datasetDetails -
      Returns:
      Since:
      9.1

    • loadDataAssets

      public List<SMEnvironment> loadDataAssets(int systemId, String visible, boolean fillExtendedProperties, boolean isHTML) throws com.icc.exceptions.DaoException
      Parameters:
      systemId -
      visible -
      fillExtendedProperties -
      isHTML -
      Returns:
      Throws:
      com.icc.exceptions.DaoException
      Since:
      9.1

    • dataAssetsSearch

      public LinkedHashMap<String,Object> dataAssetsSearch(org.json.JSONObject configDetails) throws com.icc.exceptions.DaoException
      Parameters:
      configDetails -
      Returns:
      Throws:
      com.icc.exceptions.DaoException
      Since:
      9.1

    • exportEnvironment

      public RequestStatus exportEnvironment(int environmentId, APIConstants.FileExtension fileExtension)
      Environment is exported to xml for the specified environmentId.
      The exported filePath will be available in the userObject of RequestStatus Object. The filePath in the userObject is RELATIVE.
      Parameters:
      environmentId - - int
      fileExtension - - FileExtension type - Valid values are XML/AMP/ZIP
      Returns:
      RequestStatus Object.
      Since:
      9.5

    • importEnvironment

      public RequestStatus importEnvironment(int environmentId, DBHelper dbHelper, DBProperties.Operation dbOperation, APIConstants.FileExtension fileExtension)
      Imports the environment on the specified environmentId. Specifying the filePath and filePathType in dbHelper object and dbOperation is mandatory. The supported values for the filePathType are ABSOLUTE, RELATIVE. Here the file in filePath provided should be in xml/zip/amp formats only.
      dbOperation - DBProperties Object specifies the operation modes in which the environment will be saved i.e fresh upload, update append and append modes(for values reference DBProperties.Operation).
      Parameters:
      environmentId - - int
      dbHelper - - DBHelper object
      dbOperation - - DBProperties object
      fileExtension - - FileExtension - Valid Types XML, AMP, ZIP.
      Returns:
      RequestStatus object
      Since:
      9.5

    • exportEnvironmentAs

      public String exportEnvironmentAs(int environmentId, String fileExtension, String outputFormat)
      Environment is exported to xml for the specified environmentId.
      The exported filePath will be availabale in the userObject of RequestStatus Object and it will be RELATIVE.
      Parameters:
      environmentId - - int
      fileExtension - - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - RequestStatus object in the form of json string
      Since:
      9.5

    • importEnvironmentAs

      public String importEnvironmentAs(int environmentId, String dbHelperObjJson, String dbOperation, String fileExtension, String outputFormat)
      Imports the environment on the specified environmentId. Specifying the filePath and filePathType in dbHelper object and dbOperation is mandatory. The supported values for the filePathType are ABSOLUTE, RELATIVE.
      dbOperation - DBProperties Object specifies the operation modes in which the environment will be saved i.e fresh upload, update append and append modes(for values reference DBProperties.Operation).
      Parameters:
      environmentId - - int
      dbHelperObjJson - - String in json format
      dbOperation - - String
      fileExtension - - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - RequestStatus object in the form of json string

      Sample 'dbHelperObjJson' JSON :
      {
      "filePath":"",
      "filePathType":"ABSOLUTE",
      "updateTableELNFlag":false,
      "updateColumnELNFlag":false,
      "generateSummary":false,
      "validateData": false,
      "importTags":false,
      "importAssociations":false
      }

      Since:
      9.5

    • versionEnvironment

      public RequestStatus versionEnvironment(int environmentId, String changeDescription, String versionLabel)
      Versions the environment for the specified environmentId. Creates a copy of entire metadata in archived environments with new environment Id and passive state, versioning will include extended properties, valid values, SDI fields and documents.
      If environment is versioned successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
      Specifying the environmentId and changeDescription are mandatory.
      Parameters:
      environmentId - - int
      changeDescription - - String
      versionLabel - - String
      Returns:
      RequestStatus object
      Since:
      10.0

    • versionEnvironmentAs

      public String versionEnvironmentAs(int environmentId, String changeDescription, String versionLabel, String outputFormat)
      Versions the environment for the specified environmentId. Creates a copy of entire metadata in archived environments with new environment Id and passive state, versioning will include extended properties, valid values, SDI fields and documents.
      Specifying the environmentId and changeDescription are mandatory, outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
      Parameters:
      environmentId - - int
      changeDescription - - String
      versionLabel - - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - RequestStatus object in the form of json string
      Since:
      10.0

    • deleteEnvironmentByIdAs

      public String deleteEnvironmentByIdAs(int environmentId, String versionMode, String outputFormat)
      Deletes the environment with the specified environmentId and versionMode. Specifying the environmentId is mandatory to delete a particular environment. If versionMode is not specified current version environment will be deleted.
      Version mode has values ALL_VERSIONS, CURRENT_VERSION.
      ALL_VERSIONS - Deletes all environments.
      CURRENT_VERSION - Deletes the present/current version.
      If the environment is deleted all its associated data will also be deleted.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
      Parameters:
      environmentId - int
      versionMode - String - VersionMode type - Valid values are ALL_VERSIONS/CURRENT_VERSION
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - RequestStatus object in the form of JSON or XML string
      Since:
      12.1

    • deleteTablesAs

      public String deleteTablesAs(String tableIdsJsonArray, String outputFormat)
      Deletes the tables with the specified list of tableIds. Specifying the tableIds list is mandatory.
      If tables are deleted all its associated data will also be deleted.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
      Parameters:
      tableIdsJsonArray - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - RequestStatus object in the form of JSON or XML string
      Since:
      12.1

    • deleteTablesByEnvironmentIdAs

      public String deleteTablesByEnvironmentIdAs(int environmentId, String outputFormat)
      Deletes the list of tables for the given environmentId. Specifying the environmentId is mandatory to delete tables.
      If the tables are deleted all its associated data will also be deleted.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
      Parameters:
      environmentId - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - RequestStatus object in the form of JSON or XML string
      Since:
      12.1

    • exportDataDictionary

      public RequestStatus exportDataDictionary(int objectId, int objectTypeId, int fillOptions)
      Environment or table is exported to xlsx format for the specified objectId and objectTypeId. Specifying the objectId and objectTypeId are mandatory.
      ObjectTypeId can be either SM_ENVIRONMENT id or SM_TABLE id Depending upon the objectTypeId, objectId will be either environmentId or tableId.
      The exported filePath will be available in the userObject of requestStatus object. The filePath in the userObject is RELATIVE.
      Parameters:
      objectId - int
      objectTypeId - int
      fillOptions - APIConstants.SMFillOptions int
      Returns:
      RequestStatus object
      Since:
      12.1

    • importDataDictionary

      public RequestStatus importDataDictionary(int environmentId, ImportHelper importHelper)
      Imports the tables on the specified environmentId. Specifying the filePath and filePathType are mandatory in importHelper object. The supported values for the filePathType are ABSOLUTE, RELATIVE. Here the the file in filePath given must be in xlsx or xls format only.
      Specifying the environmentId is mandatory.
      Parameters:
      environmentId - int
      importHelper - ImportHelper
      Returns:
      String - RequestStatus object in the form of JSON or XML string
      Since:
      12.1

    • getMetadata

      public org.json.JSONArray getMetadata(org.json.JSONObject jsonObject)
      Returns the metadata information includes systemId, systemName, environmentId, environmentName, environemnetType, dataSourceType etc..as a JSONArray for the specified input values in the JSON object.
      The valid values in the input json object are SERVER, DATABASE, SCHEMA AND TABLENAME.
      Parameters:
      jsonObject -
      Returns:
      JSONArray
      Since:
      12.1

    • exportDataDictionaryAs

      public String exportDataDictionaryAs(int objectId, int objectTypeId, int fillOptions, String outputFormat)
      Environment or table is exported to xlsx format for the specified objectId and objectTypeId. Specifying the objectId and objectTypeId are mandatory.
      ObjectTypeId can be either SM_ENVIRONMENT id or SM_TABLE id Depending upon the objectTypeId, objectId will be either environmentId or tableId.
      The exported filePath will be available in the userObject of requestStatus object. The filePath in the userObject is RELATIVE.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
      Parameters:
      objectId - int
      objectTypeId - int
      fillOptions - APIConstants.SMFillOptions int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - RequestStatus object in the form of JSON or XML string
      Since:
      12.1

    • importDataDictionaryAs

      public String importDataDictionaryAs(int environmentId, String importHelper, String outputFormat)
      Imports the tables on the specified environmentId. Specifying the filePath and filePathType are mandatory in importHelper object. The supported values for the filePathType are ABSOLUTE, RELATIVE. Here the the file in filePath given must be in xlsx or xls format only.
      Specifying the environmentId is mandatory.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
      Parameters:
      environmentId - int
      importHelper - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - RequestStatus object in the form of JSON or XML string
      Since:
      12.1

    • getMetadataAs

      public String getMetadataAs(String inputJson, String outputFormat)
      Returns the metadata information includes systemId, systemName, environmentId, environmentName, environemnetType, dataSourceType etc..as a JSONArray for the specified input values in the JSON object.
      The valid values in the input json object are SERVER, DATABASE, SCHEMA AND TABLENAME.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
      Parameters:
      inputJson - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - RequestStatus object in the form of JSON or XML string

      Sample JSON :

      {
      "SERVER":"",
      "DATABASE":"",
      "SCHEMA":"",
      "TABLENAME":""
      }

      Since:
      12.1

    • getEnvironment

      public SMEnvironment getEnvironment(int environmentId, int fillOptions, boolean useReferenceId) throws Exception
      Returns SMEnvironment object for the specified environmentId, fillOptions, and useReferenceId. Specifying the environmentId,fillOptions and useReferenceId is mandatory.
      Returns all the details pertaining to a specific environment such as environmentName, systemName in which environment is present, related DB information and its auditHistory. Specifying the environmentId is mandatory in order to retrieve the environment details.
      useReferenceId takes the values as true or false.
      If useReferenceId is true, then it returns the environment based on checking the table referenceId which is set to the tables and column referenceId set in the columns of those tables in the specific environment.
      Here fillOptions parameter takes value of APIConstants.SMFillOptions.ENVIRONMENT_TABLES_COLUMNS Based on the value passed its related data is returned within the SMEnvironment object. The default integer value for fillOptions is 0(zero).
      Parameters:
      environmentId - int
      fillOptions - int APIConstants.SMFillOptions
      useReferenceId - boolean
      Returns:
      String
      Throws:
      Exception
      Since:
      12.1

    • getEnvironmentAs

      public String getEnvironmentAs(int environmentId, int fillOptions, boolean useReferenceId, String outputFormat) throws Exception
      Returns SMEnvironment object for the specified environmentId, fillOptions, and useReferenceId. Specifying the environmentId,fillOptions and useReferenceId is mandatory.
      Returns all the details pertaining to a specific environment such as environmentName, systemName in which environment is present, related DB information and its auditHistory. Specifying the environmentId is mandatory in order to retrieve the environment details.
      useReferenceId takes the values as true or false.
      If useReferenceId is true, then it returns the environment based on checking the table referenceId which is set to the tables and column referenceId set in the columns of those tables in the specific environment.
      Here fillOptions parameter takes value of APIConstants.SMFillOptions.ENVIRONMENT_TABLES_COLUMNS Based on the value passed its related data is returned within the SMEnvironment object. The default integer value for fillOptions is 0(zero). OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
      Parameters:
      environmentId - int
      fillOptions - int APIConstants.SMFillOptions
      useReferenceId - boolean
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String
      Throws:
      Exception
      Since:
      12.1

    • getTableId

      public int getTableId(int environmentId, String tableName, String declarationPath) throws Exception
      Returns the tableId for the specified environmentId, tableName and declarationPath.
      Specifying the environmentId, tableName and declarationPath are mandatory.
      Parameters:
      environmentId - int
      tableName - String
      declarationPath - String
      Returns:
      int - Table Id
      Throws:
      com.icc.exceptions.DaoException
      Exception
      Since:
      13.0

    • getTableId

      public int getTableId(String systemName, String environmentName, String tableName, String declarationPath) throws Exception
      Returns the tableId for the specified systemName, environmentName, tableName and declarationPath.
      Specifying the systemName, environmentName, tableName and declarationPath are mandatory.
      Parameters:
      systemName - String
      environmentName - String
      tableName - String
      declarationPath - String
      Returns:
      int
      Throws:
      Exception
      Since:
      13.0

    • getTableIdAs

      public String getTableIdAs(int environmentId, String tableName, String declarationPath, String outputFormat)
      Returns the tableId for the specified environmentId, tableName and declarationPath.
      Specifying the environmentId, tableName and declarationPath are mandatory.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
      Parameters:
      environmentId - int
      tableName - String
      declarationPath - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String
      Since:
      13.0

    • getTableIdAs

      public String getTableIdAs(String systemName, String environmentName, String tableName, String declarationPath, String outputFormat)
      Returns the tableId for the specified systemName, environmentName, tableName and declarationPath.
      Specifying the systemName, environmentName, tableName and declarationPath are mandatory.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
      Parameters:
      systemName - String
      environmentName - String
      tableName - String
      declarationPath - String
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String
      Since:
      13.0

    • getTables

      public List<SMTable> getTables(List<Integer> ids, int fillOptions)
      Returns the list of SMTable objects for the specified list of tableIds along with fillOptions value.
      Each returned SMTable object contains all the details pertaining to table such as table name, table definition, environment name in which table is present etc...and also contains details of table indexes, all associated table columns and table extended properties based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions can be Integer values of either APIConstants.SMFillOptions.TABLE_INDEXES or APIConstants.SMFillOptions.TABLE_COLUMNS or APIConstants.SMFillOptions.TABLE_EXTENDED_PROPERTIES for example: If you want to get Indexes and it's Columns along with SMTable object, you need to pass the fillOptions parameter value as 3 (TABLE_INDEXES(1) + TABLE_COLUMNS(2)).
      Specifying the tableIds and fillOptions are mandatory in order to fetch the table details.
      Parameters:
      ids - List
      fillOptions - int APIConstants.SMFillOptions
      Returns:
      List of Tables
      Since:
      13.0

    • getColumns

      public List<SMColumn> getColumns(List<Integer> ids, int fillOptions)
      Returns the list of SMColumn objects for the specified list of columnIds along with fillOptions value.
      Specifying the columnIds and fillOptions are mandatory. Each returned SMColumn object contains all the details pertaining to column such as column name, table name in which the column is present, column length, column precision etc... and also contains details of column indexes, column extended properties ,valid values and extended properties of valid values based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of either APIConstants.SMFillOptions.COLUMN_INDEXES or APIConstants.SMFillOptions.COLUMN_EXTENDED_PROPERTIES or APIConstants.SMFillOptions.COLUMN_VALID_VALUES or APIConstants.SMFillOptions.VALID_VALUES_EXTENDED_PROPERTIES. Based on the value passed its related data is returned within the SMColumn object and if you want to get column indexes and column extended properties then fillOptions parameter value will be addition of COLUMN_INDEXES value and COLUMN_EXTENDED_PROPERTIES value i.e 8+16=24 and so on.
      Parameters:
      ids - List
      fillOptions - int APIConstants.SMFillOptions
      Returns:
      List of Columns
      Since:
      13.0

    • getTablesAs

      public String getTablesAs(String tableIds, int fillOptions, String outputFormat)
      Returns the list of SMTable objects for the specified list of tableIds along with fillOptions value.
      Each returned SMTable object contains all the details pertaining to table such as table name, table definition, environment name in which table is present etc...and also contains details of table indexes, all associated table columns and table extended properties based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions can be Integer values of either APIConstants.SMFillOptions.TABLE_INDEXES or APIConstants.SMFillOptions.TABLE_COLUMNS or APIConstants.SMFillOptions.TABLE_EXTENDED_PROPERTIES for example: If you want to get Indexes and it's Columns along with SMTable object, you need to pass the fillOptions parameter value as 3 (TABLE_INDEXES(1) + TABLE_COLUMNS(2)).
      Specifying the tableIds and fillOptions are mandatory in order to fetch the table details.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
      Parameters:
      tableIds - tableIds
      fillOptions - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - List of SMTable objects in the form of JSON or XML String.
      Since:
      13.0

    • getColumnsAs

      public String getColumnsAs(String columnIds, int fillOptions, String outputFormat)
      Returns the list of SMColumn objects for the specified list of columnIds along with fillOptions value.
      Specifying the columnIds and fillOptions are mandatory. Each returned SMColumn object contains all the details pertaining to column such as column name, table name in which the column is present, column length, column precision etc... and also contains details of column indexes, column extended properties ,valid values and extended properties of valid values based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
      Here fillOptions parameter takes value of either APIConstants.SMFillOptions.COLUMN_INDEXES or APIConstants.SMFillOptions.COLUMN_EXTENDED_PROPERTIES or APIConstants.SMFillOptions.COLUMN_VALID_VALUES or APIConstants.SMFillOptions.VALID_VALUES_EXTENDED_PROPERTIES. Based on the value passed its related data is returned within the SMColumn object and if you want to get column indexes and column extended properties then fillOptions parameter value will be addition of COLUMN_INDEXES value and COLUMN_EXTENDED_PROPERTIES value i.e 8+16=24 and so on.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
      Parameters:
      columnIds - String
      fillOptions - int
      outputFormat - String - Valid values: JSON or XML
      Returns:
      String - List of SMColumn objects in the form of JSON or XML String.
      Since:
      13.0

    • addSDIClassifications

      public RequestStatus addSDIClassifications(Node.NodeType nodeType, Map<Integer,List<SDIClassification>> mapObjectIdsListSDIClassifications)
      This function is used to insert a list of SDI classifications for the  specified nodeType. NodeIds (objectIds) must be given along with SDI's list. We can add multiple classifications to a single node ID.
      Parameters:
      nodeType - Node.NodeType
      mapObjectIdsListSDIClassifications - List
      Returns:
      RequestStatus object

    • addSDIClassificationsAs

      public String addSDIClassificationsAs(String nodeType, String ObjectIdsListOfSDIClassificationsJson, String outputFormat)
      This function is used to insert a list of SDI classifications for the  specified nodeType. NodeIds (objectIds) must be given along with SDI's list. We can add multiple classifications to a single node ID.
      OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
      Parameters:
      nodeType - String
      ObjectIdsListOfSDIClassificationsJson - String
      outputFormat - String
      Returns:
      String