Module cvpysdk.activateapps.constants

Helper file to maintain all the constants for Activate Apps

ActivateEntityConstants - Maintains constants for Regex custom entity

TagConstants - Maintains constants for Tags

ClassifierConstants - Maintains constants for Classifiers

TrainingStatus - Enum class for classifier training status

TargetApps - Enum class for Activate App types

PlanConstants - Maintains constants for Plan operations

InventoryConstants - Maintains constants for Inventory Manager apps

EdiscoveryConstants - Maintains constants for Ediscovery clients in activate

RequestConstants - Maintains constants for request manager in Activate

ComplianceConstants - Maintains constants for Compliance Search in Activate

ClientType - Enum class for datasource client type

Expand source code Browse git
# -*- coding: utf-8 -*-

# --------------------------------------------------------------------------
# Copyright Commvault Systems, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# --------------------------------------------------------------------------

"""Helper file to maintain all the constants for Activate Apps

ActivateEntityConstants         -       Maintains constants for Regex custom entity

TagConstants                    -       Maintains constants for Tags

ClassifierConstants             -       Maintains constants for Classifiers

TrainingStatus                  -       Enum class for classifier training status

TargetApps                      -       Enum class for Activate App types

PlanConstants                   -       Maintains constants for Plan operations

InventoryConstants              -       Maintains constants for Inventory Manager apps

EdiscoveryConstants             -       Maintains constants for Ediscovery clients in activate

RequestConstants                -       Maintains constants for request manager in Activate

ComplianceConstants             -       Maintains constants for Compliance Search in Activate

ClientType                      -       Enum class for datasource client type

"""
import copy
from enum import Enum


class RequestConstants:
    """class to maintain constants for request manager"""
    PROPERTY_REVIEW_CRIERIA = 'ReviewCriteria'
    PROPERTY_ENTITIES = 'Entities'
    PROPERTY_REQUEST_HANDLER_ID = 'RequestHandlerId'
    PROPERTY_REQUEST_HANDLER_NAME = 'RequestHandlerName'
    PROPERTY_REVIEW_SET_ID = 'ReviewSetId'
    SEARCH_QUERY_SELECTION_SET = {
        "entity_*",
        "count_entity_*",
        "Url",
        "contentid",
        "FileName",
        "Size",
        "data_source",
        "data_source_name",
        "entities_extracted",
        "RedactMode*",
        "CommentFor*",
        "ConsentFor*"}

    FACET_REVIEWED = '_ConsentFor_%s_b_Reviewed'
    FACET_NOT_REVIEWED = '_ConsentFor_%s_b_Not reviewed'
    FACET_ACCEPTED = '_ConsentFor_%s_b_Accepted'
    FACET_DECLINED = '_ConsentFor_%s_b_Declined'
    FACET_REDACTED = '_RedactMode_%s_b_Redacted'
    FACET_NOT_REDACTED = '_RedactMode_%s_b_Not redacted'
    FACET_COUNT = "count"
    REQUEST_FEDERATED_FACET_SEARCH_QUERY = {"searchParams": [{"key": "q",
                                                              "value": "*:*"},
                                                             {"key": "wt",
                                                              "value": "json"},
                                                             {"key": "rows",
                                                              "value": "0"},
                                                             {"key": "defType",
                                                              "value": "edismax"},
                                                             {"key": "facet",
                                                              "value": "true"},
                                                             {"key": "json.facet",
                                                              "value": "{\"_ConsentFor_<rsidparam>_b_Reviewed\":{\"type\":\"query\",\"domain\":{\"excludeTags\":[\"tag_group_ConsentFor_<rsidparam>_b\",\"tag_ConsentFor_<rsidparam>_b\",\"tag_exclude_ConsentFor_<rsidparam>_b\"]},\"numBuckets\":true,\"mincount\":1,\"q\":\"ConsentFor_<rsidparam>_b:*\",\"facet\":{}},\"_ConsentFor_<rsidparam>_b_Not reviewed\":{\"type\":\"query\",\"domain\":{\"excludeTags\":[\"tag_group_ConsentFor_<rsidparam>_b\",\"tag_ConsentFor_<rsidparam>_b\",\"tag_exclude_ConsentFor_<rsidparam>_b\"]},\"numBuckets\":true,\"mincount\":1,\"q\":\"contentid:* AND -(ConsentFor_<rsidparam>_b:*)\",\"facet\":{}},\"_ConsentFor_<rsidparam>_b_Accepted\":{\"type\":\"query\",\"domain\":{\"excludeTags\":[\"tag_group_ConsentFor_<rsidparam>_b\",\"tag_ConsentFor_<rsidparam>_b\",\"tag_exclude_ConsentFor_<rsidparam>_b\"]},\"numBuckets\":true,\"mincount\":1,\"q\":\"ConsentFor_<rsidparam>_b:true\",\"facet\":{}},\"_ConsentFor_<rsidparam>_b_Declined\":{\"type\":\"query\",\"domain\":{\"excludeTags\":[\"tag_group_ConsentFor_<rsidparam>_b\",\"tag_ConsentFor_<rsidparam>_b\",\"tag_exclude_ConsentFor_<rsidparam>_b\"]},\"numBuckets\":true,\"mincount\":1,\"q\":\"ConsentFor_<rsidparam>_b:false\",\"facet\":{}},\"_RedactMode_<rsidparam>_b_Redacted\":{\"type\":\"query\",\"domain\":{\"excludeTags\":[\"tag_group_RedactMode_<rsidparam>_b\",\"tag_RedactMode_<rsidparam>_b\",\"tag_exclude_RedactMode_<rsidparam>_b\"]},\"numBuckets\":true,\"mincount\":1,\"q\":\"RedactMode_<rsidparam>_b:true\",\"facet\":{}},\"_RedactMode_<rsidparam>_b_Not redacted\":{\"type\":\"query\",\"domain\":{\"excludeTags\":[\"tag_group_RedactMode_<rsidparam>_b\",\"tag_RedactMode_<rsidparam>_b\",\"tag_exclude_RedactMode_<rsidparam>_b\"]},\"numBuckets\":true,\"mincount\":1,\"q\":\"RedactMode_<rsidparam>_b:false\",\"facet\":{}},\"FileExtension\":{\"type\":\"terms\",\"domain\":{\"excludeTags\":[\"tag_FileExtension\",\"tag_exclude_FileExtension\"]},\"numBuckets\":true,\"mincount\":1,\"field\":\"FileExtension\",\"limit\":-1,\"facet\":{},\"sort\":{\"count\":\"desc\"}},\"ReadAccessUserName\":{\"type\":\"terms\",\"domain\":{\"excludeTags\":[\"tag_ReadAccessUserName\",\"tag_exclude_ReadAccessUserName\"]},\"numBuckets\":true,\"mincount\":1,\"field\":\"ReadAccessUserName\",\"limit\":-1,\"facet\":{},\"sort\":{\"count\":\"desc\"}},\"data_source_name\":{\"type\":\"terms\",\"domain\":{\"excludeTags\":[\"tag_data_source_name\",\"tag_exclude_data_source_name\"]},\"numBuckets\":true,\"mincount\":1,\"field\":\"data_source_name\",\"limit\":-1,\"facet\":{},\"sort\":{\"count\":\"desc\"}}}"},
                                                             {"key": "useDCubeReq",
                                                              "value": "true"}]}

    FIELD_DOC_COUNT = "TotalDocuments"
    FIELD_REVIEWED = "ReviewedDocuments"
    FIELD_NOT_REVIEWED = "Non-ReviewedDocuments"
    FIELD_ACCEPTED = 'AcceptedDocuments'
    FIELD_DECLINED = 'DeclinedDocuments'
    FIELD_REDACTED = 'RedactedDocuments'
    FIELD_NOT_REDACTED = 'Non-RedactedDocuments'

    class RequestStatus(Enum):
        """enum to specify different request status"""
        TaskCreated = 1
        TaskConfigured = 2
        ReviewInProgress = 3
        ReviewCompleted = 4
        ApproveCompleted = 5
        ExportCompleted = 6
        DeleteCompleted = 7
        TaskCompleted = 8
        ApprovalRequested = 9
        ActionInProgress = 10
        CompletedWithErrors = 11
        Failed = 12

    class RequestType(Enum):
        """enum to maintain different request type"""
        EXPORT = 'EXPORT'
        DELETE = 'DELETE'


class EdiscoveryConstants:
    """class to maintain constants for ediscovery clients"""

    class CrawlType(Enum):
        """Crawl type for SDG/FSO jobs"""
        LIVE = 1
        BACKUP = 2
        CONTENT_INDEXED = 3
        FILE_LEVEL_ANALYTICS = 4
        BACKUP_V2 = 5

    class SourceType(Enum):
        """Source type of data for FSO/SDG app"""
        SOURCE = 1
        BACKUP = 2

    class ReviewActions(Enum):
        """Review actions for documents on SDG/FSO app"""
        DELETE = 1
        MOVE = 4
        RETENTION = 10
        IGNORE = 11
        ARCHIVE = 90
        TAG = 98

    class RiskTypes(Enum):
        """Different risk types for documents on SDG/FSO app"""
        OPEN_ACCESS = 1
        OLD_FILES = 2
        FILE_MOVED = 3
        MULTI_USER_ACCESS = 4
        NO_RETENTION = 5
        IS_PROTECTED = 6

    class ClientType(Enum):
        """Different Type of SDG Datasource"""
        FILE_SYSTEM = 5
        EXCHANGE = 17
        ONEDRIVE = 35

    EXCHANGE_AGENT = "exchange mailbox"
    EXCHANGE_INSTANCE = "defaultinstancename"
    EXCHANGE_BACKUPSET = "user mailbox"
    EXCHANGE_SUBCLIENT = "usermailbox"

    ONEDRIVE_AGENT = 'Cloud Apps'
    ONEDRIVE_INSTANCE = 'OneDrive'
    ONEDRIVE_BACKUPSET = 'defaultbackupset'
    ONEDRIVE_SUBCLIENT = 'default'

    FSO_SERVERS = "FsoServers"
    FSO_SERVER_GROUPS = "FsoServerGroups"

    SERVER_LEVEL_SCHEDULE_JSON = {
        "taskInfo": {
            "task": {
                "taskType": 4,
                "taskFlags": {
                    "isEdiscovery": True
                },
                "taskName": ""
            },
            "subTasks": [
                {
                    "subTask": {
                        "operationType": 5025,
                        "subTaskType": 1,
                        "subTaskName": ""
                    },
                    "pattern": {},
                    "options": {
                        "backupOpts": {
                            "backupLevel": 2,
                            "mediaOpt": {
                                "auxcopyJobOption": {
                                    "allCopies": True,
                                    "useMaximumStreams": True,
                                    "maxNumberOfStreams": 1
                                }
                            }
                        },
                        "adminOpts": {
                            "contentIndexingOption": {
                                "idaType": 1,
                                "operationType": 2,
                                "fileAnalytics": False
                            }
                        }
                    }
                }
            ],
            "associations": [
                {
                    "clientId": 0,
                    "_type_": 3
                }
            ]
        }
    }

    REVIEW_ACTION_FSO_SUPPORTED = [ReviewActions.DELETE.value, ReviewActions.MOVE.value, ReviewActions.ARCHIVE.value]

    REVIEW_ACTION_SDG_SUPPORTED = [
        ReviewActions.DELETE.value,
        ReviewActions.MOVE.value,
        ReviewActions.ARCHIVE.value,
        ReviewActions.RETENTION.value,
        ReviewActions.IGNORE.value]

    CREATE_CLIENT_REQ_JSON = {
        "clientInfo": {
            "clientType": 19,
            "edgeDrivePseudoClientProperties": {
                "systemDriveType": 7,
                "edgeDriveAssociations": {},
                "eDiscoveryInfo": {
                    "eDiscoverySubType": 2,
                    "inventoryDataSource": {
                        "seaDataSourceId": 0
                    }
                }
            },
            "plan": {
                "planId": 0
            }
        },
        "entity": {
            "clientName": "",
            "_type_": 3
        }
    }

    REVIEW_ACTION_DELETE_REQ_JSON = {
        "operation": ReviewActions.DELETE.value,
        "files": "",
        "deleteFromBackup": False,
        "options": ""}

    REVIEW_ACTION_MOVE_REQ_JSON = {"operation": ReviewActions.MOVE.value, "files": "", "options": ""}

    REVIEW_ACTION_SET_RETENTION_REQ_JSON = {
        "operation": ReviewActions.RETENTION.value,
        "remActionRequest": {
            "dataSourceId": 0,
            "handlerName": "default",
            "isBulkOperation": False,
            "searchRequest": ""},
        "setRetentionReq": {"numOfMonthsRemain": 0},
    }

    REVIEW_ACTION_IGNORE_FILES_REQ_JSON = {
        "operation": ReviewActions.IGNORE.value,
        "remActionRequest": {
            "dataSourceId": 0,
            "handlerName": "default",
            "isBulkOperation": False,
            "searchRequest": ""},
        "ignoreRisksReq": {"ignoreAllRisks": False},
    }

    REVIEW_ACTION_TAG_REQ_JSON = {
        "operation": ReviewActions.TAG.value,
        "remActionRequest": {
            "dataSourceId": 0,
            "isBulkOperation": False},
        "taggingRequest": {}}

    REVIEW_ACTION_BULK_SEARCH_REQ = "{\"searchParams\":" \
                                    "[{\"key\":\"q\",\"value\":\"*:*\"},{\"key\":\"wt\",\"value\":\"json\"}," \
                                    "{\"key\":\"rows\",\"value\":\"0\"},{\"key\":\"defType\",\"value\":\"edismax\"}," \
                                    "{\"key\":\"fq\",\"value\":\"IsFile:\\\"1\\\"\"}," \
                                    "{\"key\":\"fl\",\"value\":\"FileName\"},{\"key\":\"fl\",\"value\":\"OwnerName\"}," \
                                    "{\"key\":\"fl\",\"value\":\"OwnerLocation\"}," \
                                    "{\"key\":\"fl\",\"value\":\"CountryCode\"}," \
                                    "{\"key\":\"fl\",\"value\":\"FileExtension\"}," \
                                    "{\"key\":\"fl\",\"value\":\"operatingSystem\"}," \
                                    "{\"key\":\"fl\",\"value\":\"IsProtected\"}," \
                                    "{\"key\":\"fl\",\"value\":\"FileName_path\"},{\"key\":\"fl\",\"value\":\"Url\"}," \
                                    "{\"key\":\"fl\",\"value\":\"ClientId\"}," \
                                    "{\"key\":\"fl\",\"value\":\"DocumentType\"}," \
                                    "{\"key\":\"fl\",\"value\":\"contentid\"}," \
                                    "{\"key\":\"fl\",\"value\":\"AllowListUsername\"}," \
                                    "{\"key\":\"fl\",\"value\":\"AllowModifyUsername\"}," \
                                    "{\"key\":\"fl\",\"value\":\"AllowWriteUsername\"}," \
                                    "{\"key\":\"fl\",\"value\":\"AllowExecuteUsername\"}," \
                                    "{\"key\":\"fl\",\"value\":\"AllowFullControlUsername\"}," \
                                    "{\"key\":\"fl\",\"value\":\"ExpiryDate\"}," \
                                    "{\"key\":\"fl\",\"value\":\"CreatedTime\"}," \
                                    "{\"key\":\"fl\",\"value\":\"data_source\"}," \
                                    "{\"key\":\"fl\",\"value\":\"data_source_name\"}," \
                                    "{\"key\":\"fl\",\"value\":\"data_source_type\"}," \
                                    "{\"key\":\"fl\",\"value\":\"entities_extracted\"}," \
                                    "{\"key\":\"fl\",\"value\":\"ConsentFor_*\"}," \
                                    "{\"key\":\"fl\",\"value\":\"RedactFor_*\"}," \
                                    "{\"key\":\"fl\",\"value\":\"RedactMode_*\"}," \
                                    "{\"key\":\"fl\",\"value\":\"CommentFor_*\"}," \
                                    "{\"key\":\"fl\",\"value\":\"AppType\"}," \
                                    "{\"key\":\"fl\",\"value\":\"ApplicationId\"}," \
                                    "{\"key\":\"fl\",\"value\":\"CVTurboGUID\"}," \
                                    "{\"key\":\"fl\",\"value\":\"CommcellNumber\"}," \
                                    "{\"key\":\"fl\",\"value\":\"AchiveFileId\"}," \
                                    "{\"key\":\"fl\",\"value\":\"ArchiveFileOffset\"}," \
                                    "{\"key\":\"fl\",\"value\":\"Size\"}," \
                                    "{\"key\":\"fl\",\"value\":\"Risk_*\"}," \
                                    "{\"key\":\"fl\",\"value\":\"LastAccessedBy\"}," \
                                    "{\"key\":\"fl\",\"value\":\"LastModifiedBy\"}," \
                                    "{\"key\":\"fl\",\"value\":\"ModifiedTimeAsStr\"}," \
                                    "{\"key\":\"fl\",\"value\":\"entity_doc_tags\"}," \
                                    "{\"key\":\"fl\",\"value\":\"TagIds\"},{\"key\":\"fl\",\"value\":\"FileName\"}," \
                                    "{\"key\":\"fl\",\"value\":\"Url\"},{\"key\":\"fl\",\"value\":\"Size\"}," \
                                    "{\"key\":\"fl\",\"value\":\"OwnerName\"}," \
                                    "{\"key\":\"fl\",\"value\":\"entity_doc_tags\"}," \
                                    "{\"key\":\"start\",\"value\":\"0\"}]}"

    REVIEW_ACTION_SEARCH_FL_SET = {
        "FileName",
        "OwnerName",
        "OwnerLocation",
        "CountryCode",
        "FileExtension",
        "operatingSystem",
        "IsProtected",
        "FileName_path",
        "Url",
        "ClientId",
        "DocumentType",
        "contentid",
        "AllowListUsername",
        "AllowModifyUsername",
        "AllowWriteUsername",
        "AllowExecuteUsername",
        "AllowFullControlUsername",
        "ExpiryDate",
        "CreatedTime",
        "data_source",
        "data_source_name",
        "data_source_type",
        "entities_extracted",
        "ConsentFor_*",
        "RedactFor_*",
        "RedactMode_*",
        "CommentFor_*",
        "AppType",
        "ApplicationId",
        "CVTurboGUID",
        "CommcellNumber",
        "AchiveFileId",
        "ArchiveFileOffset",
        "Size",
        "Risk_*",
        "LastAccessedBy",
        "LastModifiedBy",
        "ModifiedTimeAsStr",
        "entity_doc_tags",
        "TagIds"}

    REVIEW_ACTION_IDA_SELECT_SET = {
        5: {'contentid', 'Url', 'ClientId', 'CreatedTime', 'FileName'}}

    FS_SERVER_HANDLER_NAME = 'GetFileServers'
    ADD_FS_REQ_JSON = {
        "datasourceId": 0,
        "indexServerClientId": 0,
        "followScheduleCrawl": False,
        "datasources": [
            {
                "datasourceName": "",
                "properties": [],
                "datasourceType": 5,
                "accessNodes": [
                    {
                        "clientId": 0,
                        "clientName": ""
                    }
                ]
            }
        ]
    }

    ADD_O365_SDG_BACKED_UP_DS_REQ = {
        "clientId": 0,
        "followScheduleCrawl": False,
        "datasources": [
            {
                "datasourceName": "",
                "datasourceType": 0,
                "properties": []
            }
        ]
    }

    FS_DEFAULT_EXPORT_FIELDS = {'FileName', 'Url', 'Size', 'OwnerName', 'CreatedTime', 'AccessTime', 'ModifiedTime'}
    EXPORT_DOWNLOAD_REQ = {
        "appTypeId": 200,
        "responseFileName": "",
        "fileParams": [
            {
                "name": "",
                "id": 2
            },
            {
                "name": "zip",
                "id": 3
            },
            {
                "name": "Streamed",
                "id": 10
            }
        ]
    }

    DATA_SOURCE_TYPES = {
        0: 'NONE',
        1: 'jdbc',
        5: 'file',
        9: 'ldap',
        10: 'federated',
        11: 'blank',
        15: 'fla',
        16: 'edge',
        17: 'exchange',
        18: 'reviewset',
        22: 'nfs',
        24: 'systemdefault',
        26: 'onedrive',
        27: 'sharepoint',
        28: 'email',
        29: 'dbanalysis',
        30: 'cloudpaas',
        31: 'googledrive',
        32: 'gmail',
        34: 'onedriveindex',
        35: 'multinodefederated',
        37: 'dynamic365'
    }

    VIEW_CATEGORY_PERMISSION = {
        "permissionId": 31,
        "permissionName": "View",
        "_type_": 122
    }
    EDIT_CATEGORY_PERMISSION = {
        "permissionId": 2,
        "permissionName": "Agent Management",
        "_type_": 122
    }

    SHARE_REQUEST_JSON = {
        "entityAssociated": {
            "entity": [
                {
                    "_type_": 3,
                    "clientId": 0
                }
            ]
        },
        "securityAssociations": {
            "associationsOperationType": 1,
            "associations": [
                {
                    "userOrGroup": [
                        {
                            "userId": 0,
                            "_type_": 0,
                            "userName": ""
                        }
                    ],
                    "properties": {
                        "categoryPermission": {
                            "categoriesPermissionOperationType": 1,
                            "categoriesPermissionList": [
                                VIEW_CATEGORY_PERMISSION
                            ]
                        }
                    }
                }
            ]
        }
    }

    DS_FILE = 'file'
    DS_CLOUD_STORAGE = 'cloudstorage'
    FIELD_DATA_SOURCE_DISPLAY_NAME = 'datasourceDisplayName'
    FIELD_DISPLAY_NAME = 'displayName'
    FIELD_DATA_SOURCE_NAME = 'datasourceName'
    FIELD_DATA_SOURCE_ID_NON_SEA = 'datasourceId'
    FIELD_DOCUMENT_COUNT = 'documentCount'
    FIELD_DATA_SOURCE_TYPE = 'datasourceType'
    FIELD_DATA_SOURCE_ID = 'seaDataSourceId'
    FIELD_PLAN_ID = 'planId'
    FIELD_DC_PLAN_ID = 'dcplanid'
    FIELD_PSEDUCO_CLIENT_ID = 'pseudoclientid'
    FIELD_SUBCLIENT_ID = 'subclientid'
    FIELD_CRAWL_TYPE = 'crawltype'
    FIELD_DATA_SOURCE_NAME_SEA = 'seaDataSourceName'
    FIELD_CONTENT_ID = 'contentid'
    FIELD_IS_FILE = 'IsFile:1'
    DYNAMIC_FEDERATED_SEARCH_PARAMS = {"searchParams": []}

    CRITERIA_EXTRACTED_DOCS = "entities_extracted:*"

    TAGGING_ITEMS_REQUEST = {
        "entityType": "SEA_DATASOURCE_ENTITY",
        "entityIds": [],
        "handler": "default",
        "searchRequest": {},
        "opType": "ADD",
        "tags": [],
        "isAsync": True}
    TAGGING_ITEMS_REVIEW_REQUEST = {"operation": ReviewActions.TAG.value, "files": "",
                                    "options": "",
                                    "taggingInformation": {'opType': 'ADD', "tagIds": []}}

    START_CRAWL_SERVER_REQUEST_JSON = {
        "taskInfo": {
            "associations": [
                {
                    "clientId": 0,
                    "_type_": 3
                }
            ],
            "task": {
                "taskType": 1,
                "taskName": "",
                "taskFlags": {
                    "isEdiscovery": True
                }
            },
            "subTasks": [
                {
                    "subTask": {
                        "subTaskName": "CVPYSDK_FSO_IMMEDIATE",
                        "subTaskType": 1,
                        "operationType": 5025
                    },
                    "options": {
                        "backupOpts": {
                            "backupLevel": 2,
                            "mediaOpt": {
                                "auxcopyJobOption": {
                                    "maxNumberOfStreams": 1,
                                    "allCopies": True,
                                    "useMaximumStreams": True
                                }
                            }
                        },
                        "adminOpts": {
                            "contentIndexingOption": {
                                "fileAnalytics": False,
                                "idaType": 1,
                                "operationType": 2
                            }
                        }
                    }
                }
            ]
        }
    }


class InventoryConstants:
    """Class to maintain constants for inventory manager"""

    CRAWL_JOB_FAILED_STATE = [5, 6, 7, 8, 9, 10, 11, 12]

    CRAWL_JOB_COMPLETE_STATE = 4

    CRAWL_JOB_COMPLETE_ERROR_STATE = 13

    INVENTORY_ADD_REQUEST_JSON = {
        "name": "",
        "identityServers": [],
        "indexServer": {
            "cloudId": 0,
            "displayName": ""
        }
    }

    FIELD_PROPERTY_NAME = 'name'
    FIELD_PROPERTY_DNSHOST = 'hostName'
    FIELD_PROPERTY_OS = 'operatingSystem'
    FIELD_PROPERTY_IP = 'ipAddress'
    FIELD_PROPERTY_COUNTRYCODE = 'countryCode'

    KWARGS_NAME = 'name'
    KWARGS_IP = 'ip'
    KWARGS_OS = 'os'
    KWARGS_FQDN = 'fqdn'
    KWARGS_COUNTRY_CODE = 'country_code'

    FIELD_PROPS_MAPPING = {
        FIELD_PROPERTY_NAME: KWARGS_NAME,
        FIELD_PROPERTY_IP: KWARGS_IP,
        FIELD_PROPERTY_OS: KWARGS_OS,
        FIELD_PROPERTY_DNSHOST: KWARGS_FQDN,
        FIELD_PROPERTY_COUNTRYCODE: KWARGS_COUNTRY_CODE
    }

    ASSET_FILE_SERVER_PROPERTY = [
        FIELD_PROPERTY_NAME,
        FIELD_PROPERTY_DNSHOST,
        FIELD_PROPERTY_OS,
        FIELD_PROPERTY_IP,
        FIELD_PROPERTY_COUNTRYCODE
    ]

    IDENTITY_SERVER_ASSET_ADD_TO_INVENTORY_JSON = {"identityServers": [], "startDataCollection": True}

    VIEW_CATEGORY_PERMISSION = {
        "permissionId": 31,
        "permissionName": "View",
        "_type_": 122
    }
    EDIT_CATEGORY_PERMISSION = {
        "permissionId": 2,
        "permissionName": "Agent Management",
        "_type_": 122
    }

    INVENTORY_SHARE_REQUEST_JSON = {
        "entityAssociated": {
            "entity": [
                {
                    "_type_": 132,
                    "seaDataSourceId": 0
                }
            ]
        },
        "securityAssociations": {
            "associationsOperationType": 1,
            "associations": [
                {
                    "userOrGroup": [
                        {
                            "userId": 0,
                            "_type_": 0,
                            "userName": ""
                        }
                    ],
                    "properties": {
                        "categoryPermission": {
                            "categoriesPermissionOperationType": 1,
                            "categoriesPermissionList": [
                                VIEW_CATEGORY_PERMISSION
                            ]
                        }
                    }
                }
            ]
        }
    }

    class AssetType(Enum):
        """Asset type for inventory"""
        IDENTITY_SERVER = 61
        FILE_SERVER = 132


class PlanConstants:
    """Class to maintain constants related to DC plan activate operations"""

    INDEXING_ONLY_METADATA = 1
    INDEXING_METADATA_AND_CONTENT = 2

    DEFAULT_INCLUDE_DOC_TYPES = "*.doc,*.docx,*.xls,*.xlsx,*.ppt,*.pptx,*.msg,*.txt,*.rtf,*.eml,*.pdf," \
                                "*.htm,*.html,*.csv,*.log,*.ods,*.odt,*.odg,*.odp,*.dot,*.pages,*.xmind"
    DEFAULT_EXCLUDE_LIST = [
        "C:\\Program Files",
        "C:\\Program Files (x86)",
        "C:\\Windows"]

    DEFAULT_MIN_DOC_SIZE = 0
    DEFAULT_MAX_DOC_SIZE = 50

    PLAN_UPDATE_REQUEST_JSON = {
        7: {
            "ciPolicyInfo": {
                "ciPolicy": {
                    "policyType": 5,
                    "flags": 536870912,
                    "agentType": {
                        "appTypeId": 0,
                        "entityInfo": {},
                        "flags": {}
                    },
                    "detail": {
                        "ciPolicy": {}
                    }
                }
            },
            "eePolicyInfo": {
                "eePolicy": {
                    "policyType": 3,
                    "flags": 536870920,
                    "agentType": {
                        "appTypeId": 0,
                        "entityInfo": {},
                        "flags": {}
                    },
                    "detail": {
                        "eePolicy": {}
                    }
                }
            },
            "summary": {
                "plan": {
                    "planId": 0
                }
            }
        },
        6: {
            "ciPolicyInfo": {
                "ciPolicy": {
                    "policyType": 5,
                    "detail": {
                        "ciPolicy": {
                            "opType": 2,
                            "enableExactSearch": False,
                            "ciPolicyType": 5,
                            "filters": {
                                "fileFilters": {
                                    "includeDocTypes": "",
                                    "minDocSize": 0,
                                    "maxDocSize": 50
                                }
                            }
                        }
                    }
                }
            },
            "eePolicyInfo": {},
            "exchange": {},
            "office365Info": {
                "o365Exchange": {
                    "mbArchiving": {
                        "policyType": 1,
                        "agentType": {
                            "appTypeId": 137
                        },
                        "detail": {
                            "emailPolicy": {
                                "emailPolicyType": 1,
                                "archivePolicy": {
                                    "primaryMailbox": True,
                                    "contentIndexProps": {}
                                }
                            }
                        }
                    }
                },
                "o365CloudOffice": {
                    "caBackup": {
                        "policyType": 6,
                        "detail": {
                            "cloudAppPolicy": {
                                "cloudAppPolicyType": 1,
                                "backupPolicy": {
                                    "onedrivebackupPolicy": {},
                                    "spbackupPolicy": {},
                                    "teamsbackupPolicy": {}
                                }
                            }
                        }

                    }

                }

            },

            "summary": {
                "plan": {
                    "planName": "",
                    "planId": 0
                }
            }

        }
    }

    PLAN_SCHEDULE_REQUEST_JSON = {
        7: {
            "summary": {
                "plan": {
                    "planId": 0
                }
            },
            "schedule": {
                "associations": [
                    {
                        "_type_": 158,
                        "entityId": 0
                    }
                ],
                "task": {
                    "taskType": 4,
                    "taskName": "",
                    "taskFlags": {
                        "isEdiscovery": True
                    }
                },
                "subTasks": [
                    {
                        "subTask": {
                            "subTaskName": "",
                            "subTaskType": 1,
                            "operationType": 5025
                        },
                        "pattern": {},
                        "options": {
                            "backupOpts": {
                                "backupLevel": 2,
                                "mediaOpt": {
                                    "auxcopyJobOption": {
                                        "maxNumberOfStreams": 1,
                                        "allCopies": True,
                                        "useMaximumStreams": True
                                    }
                                }
                            },
                            "adminOpts": {
                                "contentIndexingOption": {
                                    "fileAnalytics": False,
                                    "idaType": 1,
                                    "operationType": 2
                                }
                            }
                        }
                    }
                ]
            }
        }
    }
    PLAN_SHARE_REQUEST_JSON = {
        "entityAssociated": {
            "entity": [
                {
                    "entityType": 158,
                    "_type_": 150,
                    "entityId": 0
                }
            ]
        },
        "securityAssociations": {
            "associationsOperationType": 1,
            "associations": [
                {
                    "userOrGroup": [
                        {

                        }
                    ],
                    "properties": {
                        "role": {
                            "_type_": 120,
                            "roleId": 0,
                            "roleName": ""
                        }
                    }
                }
            ]
        }
    }

    CREATE_V4_DC_PLAN_REQ = {
        "application": 2,
        "contentAnalyzer": [],
        "contentIndexing": {
            "extractTextFromImage": False,
            "fileFilters": {
                "excludePaths": [
                ],
                "includeDocTypes": "",
                "maxDocSize": 50,
                "minDocSize": 0
            },
            "searchType": "METADATA"
        },
        "entityDetection": {
            "classifiers": [
            ],
            "entities": [
            ]
        },
        "indexServer": {},
        "name": "",
        "threatAnalysis": False
    }

    class RAPlanSearchType(Enum):
        """Class to maintain search types in Risk Analysis Plan"""
        SEARCH_TYPE_ONLY_METADATA = "METADATA"
        SEARCH_TYPE_METADATA_AND_CONTENT = "METADATA_CONTENT"

    class RAPlanAppType(Enum):
        """Class to maintain plan application type"""
        CLASSIFIED = 2
        UNIFIED = 6


class TargetApps(Enum):
    """Class to maintain supported apps types in Activate"""
    SDG = 2
    FSO = 1
    CASE_MGR = 4
    FS = 8
    RA = 128


class TrainingStatus(Enum):
    """Class to maintain training status for classifier"""
    NOT_APPLICABLE = 0
    CREATED = 1
    RUNNING = 2
    FAILED = 3
    COMPLETED = 4
    CANCELLED = 5
    NOT_USABLE = 6


class ClassifierConstants:
    """Class to maintain all the Classsifier related constants"""
    CREATE_REQUEST_JSON = {
        "description": "",
        "enabled": True,
        "entityName": "",
        "entityType": 4,
        "entityKey": "",
        "entityXML": {
            "classifierDetails": {
                "datasetStorageType": 1,
                "trainingStatus": 6,
                "trainDatasetURI": "http://localhost:22000/solr",
                "datasetType": "docs",
                "CAUsedInTraining": {
                    "caUrl": "",
                    "clientId": 0,
                    "cloudName": "",
                    "cloudId": 0
                }
            }
        }
    }


class ActivateEntityConstants:
    """Class to maintain all the Activate entity related constants"""

    REQUEST_JSON = {
        "regularExpression": "",
        "flags": 0,
        "enabled": True,
        "entityName": "",
        "entityXML": {
            "keywords": "",
            "isSystemDefinedEntity": False
        }
    }


class TagConstants:
    """class to maintain all the Tags related constants"""

    TAG_SET_ADD_REQUEST_JSON = {
        "entityType": 9504,
        "operationType": 1,
        "fromSite": 4,
        "container": {
            "containerType": 9504,
            "containerName": "",
            "comment": ""
        }
    }

    TAG_SET_MODIFY_REQUEST_JSON = copy.deepcopy(TAG_SET_ADD_REQUEST_JSON)
    TAG_SET_MODIFY_REQUEST_JSON['operationType'] = 3

    TAG_SET_DELETE_REQUEST_JSON = {
        "entityType": 9504,
        "containers": [
            {
                "containerType": 9504,
                "containerId": 0
            }
        ]
    }

    TAG_ADD_REQUEST_JSON = {
        "container": {
            "containerId": 0
        },
        "tags": [
            {
                "name": ""
            }
        ]
    }

    TAG_MODIFY_REQUEST_JSON = copy.deepcopy(TAG_ADD_REQUEST_JSON)
    TAG_MODIFY_REQUEST_JSON['tags'][0]['tagId'] = 0

    VIEW_PERMISSION = {
        "permissionId": 31,
        "_type_": 122,
        "permissionName": "View"
    }
    ADD_PERMISSION = {
        "permissionId": 34,
        "_type_": 122,
        "permissionName": "Add/Append"
    }

    TAG_SET_SHARE_REQUEST_JSON = {
        "entityAssociated": {
            "entity": [
                {
                    "tagId": 0,
                    "_type_": 9504
                }
            ]
        },
        "securityAssociations": {
            "associationsOperationType": 1,
            "associations": [
                {
                    "userOrGroup": [
                        {

                        }
                    ],
                    "properties": {
                        "permissions": [
                            VIEW_PERMISSION
                        ]
                    }
                }

            ]
        }
    }


class ComplianceConstants:
    """Class to maintain all the Compliance search related constants"""

    SOLR_FIELD_FILE_NAME = "fileName"
    SOLR_FIELD_SIZE = "sizeKB"

    VIEW_PERMISSION = {
        "permissionId": 31,
        "_type_": 122,
        "permissionName": "View"
    }

    ADD_PERMISSION = {
        "permissionId": 34,
        "_type_": 122,
        "permissionName": "Add/Append"
    }

    DOWNLOAD_PERMISSION = {
        "_type_": 122,
        "permissionId": 36,
        "permissionName": "Download"
    }

    DELETE_PERMISSION = {
        "permissionId": 35,
        "permissionName": "Delete",
        "_type_": 122
    }

    PERMISSION_ADD_NAME = "Add"
    PERMISSION_DELETE_NAME = "Delete"
    PERMISSION_DOWNLOAD_NAME = "Download"
    PERMISSION_VIEW_NAME = "View"

    PERMISSIONS = {
        PERMISSION_ADD_NAME: ADD_PERMISSION,
        PERMISSION_DELETE_NAME: DELETE_PERMISSION,
        PERMISSION_DOWNLOAD_NAME: DOWNLOAD_PERMISSION,
        PERMISSION_VIEW_NAME: VIEW_PERMISSION
    }

    EXPORT_SET_SHARE_REQUEST_JSON = {
        "entityAssociated": {
            "entity": [
                {
                    "entityType": 9503,
                    "downloadSetId": None,
                    "_type_": 9503}
            ]
        },
        "securityAssociations": {
            "associationsOperationType": 2,
            "associations": [
                {
                    "userOrGroup": None,
                    "properties": {
                        "permissions": [
                            VIEW_PERMISSION,
                            DOWNLOAD_PERMISSION
                        ]
                    }
                }
            ]
        }
    }

    class AppTypes(Enum):
        EXCHANGE = "EXCHANGE"
        EXCHANGE_JOURNAL = "EXCHANGE_JOURNAL"
        SHAREPOINT = "SHAREPOINT"
        ONEDRIVE = "ONEDRIVE"
        TEAMS = "TEAMS"
        FILE_SYSTEM = "FILE_SYSTEM"

    class ExportTypes(Enum):
        CAB = "CAB"
        PST = "PST"

    RESTORE_TYPE = {
        ExportTypes.PST: 1,
        ExportTypes.CAB: 2
    }

    FILE_TYPE = "File"
    EMAIL_TYPE = "Email"
    FILE_TYPES = [AppTypes.FILE_SYSTEM, AppTypes.SHAREPOINT, AppTypes.ONEDRIVE, AppTypes.TEAMS]
    EMAIL_TYPES = [AppTypes.EXCHANGE, AppTypes.EXCHANGE_JOURNAL]

    FILE_FILTERS_KEY = "fileFilter"
    FILE_FILTERS = [
        {
            "filter": {
                "interFilterOP": "FTAnd",
                "filters": [
                    {
                        "field": "CISTATE",
                        "intraFieldOp": "FTOr",
                        "fieldValues": {
                            "values": [
                                "0",
                                "1",
                                "12",
                                "13",
                                "14",
                                "15",
                                "1014",
                                "3333",
                                "3334",
                                "3335"
                            ]
                        }
                    }
                ]
            }
        }
    ]

    EMAIL_FILTERS_KEY = "emailView"

    ONEDRIVE_FACET = "200118"
    TEAMS_FACET = "200128"
    SHAREPOINT_FACET = "78"
    CUSTOM_FACETS = {
        AppTypes.ONEDRIVE: ONEDRIVE_FACET,
        AppTypes.TEAMS: TEAMS_FACET,
        AppTypes.SHAREPOINT: SHAREPOINT_FACET
    }

    CUSTOM_FACETS_NAME = {
        AppTypes.TEAMS: "TEAMS_NAME",
        AppTypes.SHAREPOINT: "CUSTODIAN",
        AppTypes.ONEDRIVE: "CUSTODIAN"
    }

    FACET_KEY = "facetRequest"
    FILE_FACET = [
        {
            "count": 4,
            "name": "CUSTODIAN"
        },
        {
            "count": 4,
            "name": "APPTYPE",
            "searchFieldName": "APPTYPE",
            "stringParameter": [
                {
                    "name": "33",
                    "custom": True
                },
                {
                    "name": "29",
                    "custom": True
                },
                {
                    "name": "63",
                    "custom": True
                },
                {
                    "name": "21",
                    "custom": True
                }
            ]
        }
    ]
    CUSTOM_FACET = [
        {
            "count": 4,
            "name": "CUSTODIAN"
        },
        {
            "count": 4,
            "name": "APPTYPE",
            "searchFieldName": "APPTYPE",
            "stringParameter": [
                {
                    "name": None,
                    "custom": True
                }
            ]
        }
    ]

    RESPONSE_FIELD_LIST = ("DATA_TYPE,CLIENTNAME,CONTENTID,CV_OBJECT_GUID,PARENT_GUID,CV_TURBO_GUID,"
                           "AFILEID,AFILEOFFSET,COMMCELLNO,MODIFIEDTIME,SIZEINKB,BACKUPTIME,CISTATE,DATE_DELETED,"
                           "TEAMS_ITEM_ID,TEAMS_ITEM_NAME,TEAMS_NAME,TEAMS_SMTP,TEAMS_ITEM_TYPE,TEAMS_CHANNEL_TYPE,"
                           "TEAMS_TAB_TYPE,TEAMS_GROUP_VISIBILITY,TEAMS_GUID,TEAMS_CONV_ITEM_TYPE,"
                           "TEAMS_CONV_MESSAGE_TYPE,TEAMS_CONV_SUBJECT,TEAMS_CONV_IMPORTANCE,TEAMS_CONV_SENDER_TYPE,"
                           "TEAMS_CONV_SENDER_NAME,TEAMS_CONV_HAS_REPLIES,CI_URL,TEAMS_DRIVE_FOLDER_TYPE,APPTYPE,APPID")

    COMPLIANCE_SEARCH_JSON = {
        "mode": 2,
        "facetRequests": {},
        "advSearchGrp": {
            "commonFilter": [
                {
                    "filter": {
                        "filters": [
                            {
                                "field": "CI_STATUS",
                                "intraFieldOp": 0,
                                "fieldValues": {
                                    "values": [
                                        "1",
                                        "3"
                                    ]
                                }
                            }
                        ]
                    }
                }
            ],
            "cvSearchKeyword": {
                "isExactWordsOptionSelected": False,
                "keyword": None
            },
            "galaxyFilter": [
                {
                    "applicationType": None
                }
            ]
        },
        "userInformation": {
            "userGuid": None
        },
        "listOfCIServer": [
            {
                "cloudID": None
            }
        ],
        "searchProcessingInfo": {
            "resultOffset": 0,
            "pageSize": 50,
            "queryParams": [
                {
                    "param": "ENABLE_NEW_COMPLIANCE_SEARCH",
                    "value": "true"
                }
            ]
        }
    }

Classes

class ActivateEntityConstants

Class to maintain all the Activate entity related constants

Expand source code Browse git
class ActivateEntityConstants:
    """Class to maintain all the Activate entity related constants"""

    REQUEST_JSON = {
        "regularExpression": "",
        "flags": 0,
        "enabled": True,
        "entityName": "",
        "entityXML": {
            "keywords": "",
            "isSystemDefinedEntity": False
        }
    }

Class variables

var REQUEST_JSON
class ClassifierConstants

Class to maintain all the Classsifier related constants

Expand source code Browse git
class ClassifierConstants:
    """Class to maintain all the Classsifier related constants"""
    CREATE_REQUEST_JSON = {
        "description": "",
        "enabled": True,
        "entityName": "",
        "entityType": 4,
        "entityKey": "",
        "entityXML": {
            "classifierDetails": {
                "datasetStorageType": 1,
                "trainingStatus": 6,
                "trainDatasetURI": "http://localhost:22000/solr",
                "datasetType": "docs",
                "CAUsedInTraining": {
                    "caUrl": "",
                    "clientId": 0,
                    "cloudName": "",
                    "cloudId": 0
                }
            }
        }
    }

Class variables

var CREATE_REQUEST_JSON
class ComplianceConstants

Class to maintain all the Compliance search related constants

Expand source code Browse git
class ComplianceConstants:
    """Class to maintain all the Compliance search related constants"""

    SOLR_FIELD_FILE_NAME = "fileName"
    SOLR_FIELD_SIZE = "sizeKB"

    VIEW_PERMISSION = {
        "permissionId": 31,
        "_type_": 122,
        "permissionName": "View"
    }

    ADD_PERMISSION = {
        "permissionId": 34,
        "_type_": 122,
        "permissionName": "Add/Append"
    }

    DOWNLOAD_PERMISSION = {
        "_type_": 122,
        "permissionId": 36,
        "permissionName": "Download"
    }

    DELETE_PERMISSION = {
        "permissionId": 35,
        "permissionName": "Delete",
        "_type_": 122
    }

    PERMISSION_ADD_NAME = "Add"
    PERMISSION_DELETE_NAME = "Delete"
    PERMISSION_DOWNLOAD_NAME = "Download"
    PERMISSION_VIEW_NAME = "View"

    PERMISSIONS = {
        PERMISSION_ADD_NAME: ADD_PERMISSION,
        PERMISSION_DELETE_NAME: DELETE_PERMISSION,
        PERMISSION_DOWNLOAD_NAME: DOWNLOAD_PERMISSION,
        PERMISSION_VIEW_NAME: VIEW_PERMISSION
    }

    EXPORT_SET_SHARE_REQUEST_JSON = {
        "entityAssociated": {
            "entity": [
                {
                    "entityType": 9503,
                    "downloadSetId": None,
                    "_type_": 9503}
            ]
        },
        "securityAssociations": {
            "associationsOperationType": 2,
            "associations": [
                {
                    "userOrGroup": None,
                    "properties": {
                        "permissions": [
                            VIEW_PERMISSION,
                            DOWNLOAD_PERMISSION
                        ]
                    }
                }
            ]
        }
    }

    class AppTypes(Enum):
        EXCHANGE = "EXCHANGE"
        EXCHANGE_JOURNAL = "EXCHANGE_JOURNAL"
        SHAREPOINT = "SHAREPOINT"
        ONEDRIVE = "ONEDRIVE"
        TEAMS = "TEAMS"
        FILE_SYSTEM = "FILE_SYSTEM"

    class ExportTypes(Enum):
        CAB = "CAB"
        PST = "PST"

    RESTORE_TYPE = {
        ExportTypes.PST: 1,
        ExportTypes.CAB: 2
    }

    FILE_TYPE = "File"
    EMAIL_TYPE = "Email"
    FILE_TYPES = [AppTypes.FILE_SYSTEM, AppTypes.SHAREPOINT, AppTypes.ONEDRIVE, AppTypes.TEAMS]
    EMAIL_TYPES = [AppTypes.EXCHANGE, AppTypes.EXCHANGE_JOURNAL]

    FILE_FILTERS_KEY = "fileFilter"
    FILE_FILTERS = [
        {
            "filter": {
                "interFilterOP": "FTAnd",
                "filters": [
                    {
                        "field": "CISTATE",
                        "intraFieldOp": "FTOr",
                        "fieldValues": {
                            "values": [
                                "0",
                                "1",
                                "12",
                                "13",
                                "14",
                                "15",
                                "1014",
                                "3333",
                                "3334",
                                "3335"
                            ]
                        }
                    }
                ]
            }
        }
    ]

    EMAIL_FILTERS_KEY = "emailView"

    ONEDRIVE_FACET = "200118"
    TEAMS_FACET = "200128"
    SHAREPOINT_FACET = "78"
    CUSTOM_FACETS = {
        AppTypes.ONEDRIVE: ONEDRIVE_FACET,
        AppTypes.TEAMS: TEAMS_FACET,
        AppTypes.SHAREPOINT: SHAREPOINT_FACET
    }

    CUSTOM_FACETS_NAME = {
        AppTypes.TEAMS: "TEAMS_NAME",
        AppTypes.SHAREPOINT: "CUSTODIAN",
        AppTypes.ONEDRIVE: "CUSTODIAN"
    }

    FACET_KEY = "facetRequest"
    FILE_FACET = [
        {
            "count": 4,
            "name": "CUSTODIAN"
        },
        {
            "count": 4,
            "name": "APPTYPE",
            "searchFieldName": "APPTYPE",
            "stringParameter": [
                {
                    "name": "33",
                    "custom": True
                },
                {
                    "name": "29",
                    "custom": True
                },
                {
                    "name": "63",
                    "custom": True
                },
                {
                    "name": "21",
                    "custom": True
                }
            ]
        }
    ]
    CUSTOM_FACET = [
        {
            "count": 4,
            "name": "CUSTODIAN"
        },
        {
            "count": 4,
            "name": "APPTYPE",
            "searchFieldName": "APPTYPE",
            "stringParameter": [
                {
                    "name": None,
                    "custom": True
                }
            ]
        }
    ]

    RESPONSE_FIELD_LIST = ("DATA_TYPE,CLIENTNAME,CONTENTID,CV_OBJECT_GUID,PARENT_GUID,CV_TURBO_GUID,"
                           "AFILEID,AFILEOFFSET,COMMCELLNO,MODIFIEDTIME,SIZEINKB,BACKUPTIME,CISTATE,DATE_DELETED,"
                           "TEAMS_ITEM_ID,TEAMS_ITEM_NAME,TEAMS_NAME,TEAMS_SMTP,TEAMS_ITEM_TYPE,TEAMS_CHANNEL_TYPE,"
                           "TEAMS_TAB_TYPE,TEAMS_GROUP_VISIBILITY,TEAMS_GUID,TEAMS_CONV_ITEM_TYPE,"
                           "TEAMS_CONV_MESSAGE_TYPE,TEAMS_CONV_SUBJECT,TEAMS_CONV_IMPORTANCE,TEAMS_CONV_SENDER_TYPE,"
                           "TEAMS_CONV_SENDER_NAME,TEAMS_CONV_HAS_REPLIES,CI_URL,TEAMS_DRIVE_FOLDER_TYPE,APPTYPE,APPID")

    COMPLIANCE_SEARCH_JSON = {
        "mode": 2,
        "facetRequests": {},
        "advSearchGrp": {
            "commonFilter": [
                {
                    "filter": {
                        "filters": [
                            {
                                "field": "CI_STATUS",
                                "intraFieldOp": 0,
                                "fieldValues": {
                                    "values": [
                                        "1",
                                        "3"
                                    ]
                                }
                            }
                        ]
                    }
                }
            ],
            "cvSearchKeyword": {
                "isExactWordsOptionSelected": False,
                "keyword": None
            },
            "galaxyFilter": [
                {
                    "applicationType": None
                }
            ]
        },
        "userInformation": {
            "userGuid": None
        },
        "listOfCIServer": [
            {
                "cloudID": None
            }
        ],
        "searchProcessingInfo": {
            "resultOffset": 0,
            "pageSize": 50,
            "queryParams": [
                {
                    "param": "ENABLE_NEW_COMPLIANCE_SEARCH",
                    "value": "true"
                }
            ]
        }
    }

Class variables

var ADD_PERMISSION
var AppTypes

An enumeration.

var COMPLIANCE_SEARCH_JSON
var CUSTOM_FACET
var CUSTOM_FACETS
var CUSTOM_FACETS_NAME
var DELETE_PERMISSION
var DOWNLOAD_PERMISSION
var EMAIL_FILTERS_KEY
var EMAIL_TYPE
var EMAIL_TYPES
var EXPORT_SET_SHARE_REQUEST_JSON
var ExportTypes

An enumeration.

var FACET_KEY
var FILE_FACET
var FILE_FILTERS
var FILE_FILTERS_KEY
var FILE_TYPE
var FILE_TYPES
var ONEDRIVE_FACET
var PERMISSIONS
var PERMISSION_ADD_NAME
var PERMISSION_DELETE_NAME
var PERMISSION_DOWNLOAD_NAME
var PERMISSION_VIEW_NAME
var RESPONSE_FIELD_LIST
var RESTORE_TYPE
var SHAREPOINT_FACET
var SOLR_FIELD_FILE_NAME
var SOLR_FIELD_SIZE
var TEAMS_FACET
var VIEW_PERMISSION
class EdiscoveryConstants

class to maintain constants for ediscovery clients

Expand source code Browse git
class EdiscoveryConstants:
    """class to maintain constants for ediscovery clients"""

    class CrawlType(Enum):
        """Crawl type for SDG/FSO jobs"""
        LIVE = 1
        BACKUP = 2
        CONTENT_INDEXED = 3
        FILE_LEVEL_ANALYTICS = 4
        BACKUP_V2 = 5

    class SourceType(Enum):
        """Source type of data for FSO/SDG app"""
        SOURCE = 1
        BACKUP = 2

    class ReviewActions(Enum):
        """Review actions for documents on SDG/FSO app"""
        DELETE = 1
        MOVE = 4
        RETENTION = 10
        IGNORE = 11
        ARCHIVE = 90
        TAG = 98

    class RiskTypes(Enum):
        """Different risk types for documents on SDG/FSO app"""
        OPEN_ACCESS = 1
        OLD_FILES = 2
        FILE_MOVED = 3
        MULTI_USER_ACCESS = 4
        NO_RETENTION = 5
        IS_PROTECTED = 6

    class ClientType(Enum):
        """Different Type of SDG Datasource"""
        FILE_SYSTEM = 5
        EXCHANGE = 17
        ONEDRIVE = 35

    EXCHANGE_AGENT = "exchange mailbox"
    EXCHANGE_INSTANCE = "defaultinstancename"
    EXCHANGE_BACKUPSET = "user mailbox"
    EXCHANGE_SUBCLIENT = "usermailbox"

    ONEDRIVE_AGENT = 'Cloud Apps'
    ONEDRIVE_INSTANCE = 'OneDrive'
    ONEDRIVE_BACKUPSET = 'defaultbackupset'
    ONEDRIVE_SUBCLIENT = 'default'

    FSO_SERVERS = "FsoServers"
    FSO_SERVER_GROUPS = "FsoServerGroups"

    SERVER_LEVEL_SCHEDULE_JSON = {
        "taskInfo": {
            "task": {
                "taskType": 4,
                "taskFlags": {
                    "isEdiscovery": True
                },
                "taskName": ""
            },
            "subTasks": [
                {
                    "subTask": {
                        "operationType": 5025,
                        "subTaskType": 1,
                        "subTaskName": ""
                    },
                    "pattern": {},
                    "options": {
                        "backupOpts": {
                            "backupLevel": 2,
                            "mediaOpt": {
                                "auxcopyJobOption": {
                                    "allCopies": True,
                                    "useMaximumStreams": True,
                                    "maxNumberOfStreams": 1
                                }
                            }
                        },
                        "adminOpts": {
                            "contentIndexingOption": {
                                "idaType": 1,
                                "operationType": 2,
                                "fileAnalytics": False
                            }
                        }
                    }
                }
            ],
            "associations": [
                {
                    "clientId": 0,
                    "_type_": 3
                }
            ]
        }
    }

    REVIEW_ACTION_FSO_SUPPORTED = [ReviewActions.DELETE.value, ReviewActions.MOVE.value, ReviewActions.ARCHIVE.value]

    REVIEW_ACTION_SDG_SUPPORTED = [
        ReviewActions.DELETE.value,
        ReviewActions.MOVE.value,
        ReviewActions.ARCHIVE.value,
        ReviewActions.RETENTION.value,
        ReviewActions.IGNORE.value]

    CREATE_CLIENT_REQ_JSON = {
        "clientInfo": {
            "clientType": 19,
            "edgeDrivePseudoClientProperties": {
                "systemDriveType": 7,
                "edgeDriveAssociations": {},
                "eDiscoveryInfo": {
                    "eDiscoverySubType": 2,
                    "inventoryDataSource": {
                        "seaDataSourceId": 0
                    }
                }
            },
            "plan": {
                "planId": 0
            }
        },
        "entity": {
            "clientName": "",
            "_type_": 3
        }
    }

    REVIEW_ACTION_DELETE_REQ_JSON = {
        "operation": ReviewActions.DELETE.value,
        "files": "",
        "deleteFromBackup": False,
        "options": ""}

    REVIEW_ACTION_MOVE_REQ_JSON = {"operation": ReviewActions.MOVE.value, "files": "", "options": ""}

    REVIEW_ACTION_SET_RETENTION_REQ_JSON = {
        "operation": ReviewActions.RETENTION.value,
        "remActionRequest": {
            "dataSourceId": 0,
            "handlerName": "default",
            "isBulkOperation": False,
            "searchRequest": ""},
        "setRetentionReq": {"numOfMonthsRemain": 0},
    }

    REVIEW_ACTION_IGNORE_FILES_REQ_JSON = {
        "operation": ReviewActions.IGNORE.value,
        "remActionRequest": {
            "dataSourceId": 0,
            "handlerName": "default",
            "isBulkOperation": False,
            "searchRequest": ""},
        "ignoreRisksReq": {"ignoreAllRisks": False},
    }

    REVIEW_ACTION_TAG_REQ_JSON = {
        "operation": ReviewActions.TAG.value,
        "remActionRequest": {
            "dataSourceId": 0,
            "isBulkOperation": False},
        "taggingRequest": {}}

    REVIEW_ACTION_BULK_SEARCH_REQ = "{\"searchParams\":" \
                                    "[{\"key\":\"q\",\"value\":\"*:*\"},{\"key\":\"wt\",\"value\":\"json\"}," \
                                    "{\"key\":\"rows\",\"value\":\"0\"},{\"key\":\"defType\",\"value\":\"edismax\"}," \
                                    "{\"key\":\"fq\",\"value\":\"IsFile:\\\"1\\\"\"}," \
                                    "{\"key\":\"fl\",\"value\":\"FileName\"},{\"key\":\"fl\",\"value\":\"OwnerName\"}," \
                                    "{\"key\":\"fl\",\"value\":\"OwnerLocation\"}," \
                                    "{\"key\":\"fl\",\"value\":\"CountryCode\"}," \
                                    "{\"key\":\"fl\",\"value\":\"FileExtension\"}," \
                                    "{\"key\":\"fl\",\"value\":\"operatingSystem\"}," \
                                    "{\"key\":\"fl\",\"value\":\"IsProtected\"}," \
                                    "{\"key\":\"fl\",\"value\":\"FileName_path\"},{\"key\":\"fl\",\"value\":\"Url\"}," \
                                    "{\"key\":\"fl\",\"value\":\"ClientId\"}," \
                                    "{\"key\":\"fl\",\"value\":\"DocumentType\"}," \
                                    "{\"key\":\"fl\",\"value\":\"contentid\"}," \
                                    "{\"key\":\"fl\",\"value\":\"AllowListUsername\"}," \
                                    "{\"key\":\"fl\",\"value\":\"AllowModifyUsername\"}," \
                                    "{\"key\":\"fl\",\"value\":\"AllowWriteUsername\"}," \
                                    "{\"key\":\"fl\",\"value\":\"AllowExecuteUsername\"}," \
                                    "{\"key\":\"fl\",\"value\":\"AllowFullControlUsername\"}," \
                                    "{\"key\":\"fl\",\"value\":\"ExpiryDate\"}," \
                                    "{\"key\":\"fl\",\"value\":\"CreatedTime\"}," \
                                    "{\"key\":\"fl\",\"value\":\"data_source\"}," \
                                    "{\"key\":\"fl\",\"value\":\"data_source_name\"}," \
                                    "{\"key\":\"fl\",\"value\":\"data_source_type\"}," \
                                    "{\"key\":\"fl\",\"value\":\"entities_extracted\"}," \
                                    "{\"key\":\"fl\",\"value\":\"ConsentFor_*\"}," \
                                    "{\"key\":\"fl\",\"value\":\"RedactFor_*\"}," \
                                    "{\"key\":\"fl\",\"value\":\"RedactMode_*\"}," \
                                    "{\"key\":\"fl\",\"value\":\"CommentFor_*\"}," \
                                    "{\"key\":\"fl\",\"value\":\"AppType\"}," \
                                    "{\"key\":\"fl\",\"value\":\"ApplicationId\"}," \
                                    "{\"key\":\"fl\",\"value\":\"CVTurboGUID\"}," \
                                    "{\"key\":\"fl\",\"value\":\"CommcellNumber\"}," \
                                    "{\"key\":\"fl\",\"value\":\"AchiveFileId\"}," \
                                    "{\"key\":\"fl\",\"value\":\"ArchiveFileOffset\"}," \
                                    "{\"key\":\"fl\",\"value\":\"Size\"}," \
                                    "{\"key\":\"fl\",\"value\":\"Risk_*\"}," \
                                    "{\"key\":\"fl\",\"value\":\"LastAccessedBy\"}," \
                                    "{\"key\":\"fl\",\"value\":\"LastModifiedBy\"}," \
                                    "{\"key\":\"fl\",\"value\":\"ModifiedTimeAsStr\"}," \
                                    "{\"key\":\"fl\",\"value\":\"entity_doc_tags\"}," \
                                    "{\"key\":\"fl\",\"value\":\"TagIds\"},{\"key\":\"fl\",\"value\":\"FileName\"}," \
                                    "{\"key\":\"fl\",\"value\":\"Url\"},{\"key\":\"fl\",\"value\":\"Size\"}," \
                                    "{\"key\":\"fl\",\"value\":\"OwnerName\"}," \
                                    "{\"key\":\"fl\",\"value\":\"entity_doc_tags\"}," \
                                    "{\"key\":\"start\",\"value\":\"0\"}]}"

    REVIEW_ACTION_SEARCH_FL_SET = {
        "FileName",
        "OwnerName",
        "OwnerLocation",
        "CountryCode",
        "FileExtension",
        "operatingSystem",
        "IsProtected",
        "FileName_path",
        "Url",
        "ClientId",
        "DocumentType",
        "contentid",
        "AllowListUsername",
        "AllowModifyUsername",
        "AllowWriteUsername",
        "AllowExecuteUsername",
        "AllowFullControlUsername",
        "ExpiryDate",
        "CreatedTime",
        "data_source",
        "data_source_name",
        "data_source_type",
        "entities_extracted",
        "ConsentFor_*",
        "RedactFor_*",
        "RedactMode_*",
        "CommentFor_*",
        "AppType",
        "ApplicationId",
        "CVTurboGUID",
        "CommcellNumber",
        "AchiveFileId",
        "ArchiveFileOffset",
        "Size",
        "Risk_*",
        "LastAccessedBy",
        "LastModifiedBy",
        "ModifiedTimeAsStr",
        "entity_doc_tags",
        "TagIds"}

    REVIEW_ACTION_IDA_SELECT_SET = {
        5: {'contentid', 'Url', 'ClientId', 'CreatedTime', 'FileName'}}

    FS_SERVER_HANDLER_NAME = 'GetFileServers'
    ADD_FS_REQ_JSON = {
        "datasourceId": 0,
        "indexServerClientId": 0,
        "followScheduleCrawl": False,
        "datasources": [
            {
                "datasourceName": "",
                "properties": [],
                "datasourceType": 5,
                "accessNodes": [
                    {
                        "clientId": 0,
                        "clientName": ""
                    }
                ]
            }
        ]
    }

    ADD_O365_SDG_BACKED_UP_DS_REQ = {
        "clientId": 0,
        "followScheduleCrawl": False,
        "datasources": [
            {
                "datasourceName": "",
                "datasourceType": 0,
                "properties": []
            }
        ]
    }

    FS_DEFAULT_EXPORT_FIELDS = {'FileName', 'Url', 'Size', 'OwnerName', 'CreatedTime', 'AccessTime', 'ModifiedTime'}
    EXPORT_DOWNLOAD_REQ = {
        "appTypeId": 200,
        "responseFileName": "",
        "fileParams": [
            {
                "name": "",
                "id": 2
            },
            {
                "name": "zip",
                "id": 3
            },
            {
                "name": "Streamed",
                "id": 10
            }
        ]
    }

    DATA_SOURCE_TYPES = {
        0: 'NONE',
        1: 'jdbc',
        5: 'file',
        9: 'ldap',
        10: 'federated',
        11: 'blank',
        15: 'fla',
        16: 'edge',
        17: 'exchange',
        18: 'reviewset',
        22: 'nfs',
        24: 'systemdefault',
        26: 'onedrive',
        27: 'sharepoint',
        28: 'email',
        29: 'dbanalysis',
        30: 'cloudpaas',
        31: 'googledrive',
        32: 'gmail',
        34: 'onedriveindex',
        35: 'multinodefederated',
        37: 'dynamic365'
    }

    VIEW_CATEGORY_PERMISSION = {
        "permissionId": 31,
        "permissionName": "View",
        "_type_": 122
    }
    EDIT_CATEGORY_PERMISSION = {
        "permissionId": 2,
        "permissionName": "Agent Management",
        "_type_": 122
    }

    SHARE_REQUEST_JSON = {
        "entityAssociated": {
            "entity": [
                {
                    "_type_": 3,
                    "clientId": 0
                }
            ]
        },
        "securityAssociations": {
            "associationsOperationType": 1,
            "associations": [
                {
                    "userOrGroup": [
                        {
                            "userId": 0,
                            "_type_": 0,
                            "userName": ""
                        }
                    ],
                    "properties": {
                        "categoryPermission": {
                            "categoriesPermissionOperationType": 1,
                            "categoriesPermissionList": [
                                VIEW_CATEGORY_PERMISSION
                            ]
                        }
                    }
                }
            ]
        }
    }

    DS_FILE = 'file'
    DS_CLOUD_STORAGE = 'cloudstorage'
    FIELD_DATA_SOURCE_DISPLAY_NAME = 'datasourceDisplayName'
    FIELD_DISPLAY_NAME = 'displayName'
    FIELD_DATA_SOURCE_NAME = 'datasourceName'
    FIELD_DATA_SOURCE_ID_NON_SEA = 'datasourceId'
    FIELD_DOCUMENT_COUNT = 'documentCount'
    FIELD_DATA_SOURCE_TYPE = 'datasourceType'
    FIELD_DATA_SOURCE_ID = 'seaDataSourceId'
    FIELD_PLAN_ID = 'planId'
    FIELD_DC_PLAN_ID = 'dcplanid'
    FIELD_PSEDUCO_CLIENT_ID = 'pseudoclientid'
    FIELD_SUBCLIENT_ID = 'subclientid'
    FIELD_CRAWL_TYPE = 'crawltype'
    FIELD_DATA_SOURCE_NAME_SEA = 'seaDataSourceName'
    FIELD_CONTENT_ID = 'contentid'
    FIELD_IS_FILE = 'IsFile:1'
    DYNAMIC_FEDERATED_SEARCH_PARAMS = {"searchParams": []}

    CRITERIA_EXTRACTED_DOCS = "entities_extracted:*"

    TAGGING_ITEMS_REQUEST = {
        "entityType": "SEA_DATASOURCE_ENTITY",
        "entityIds": [],
        "handler": "default",
        "searchRequest": {},
        "opType": "ADD",
        "tags": [],
        "isAsync": True}
    TAGGING_ITEMS_REVIEW_REQUEST = {"operation": ReviewActions.TAG.value, "files": "",
                                    "options": "",
                                    "taggingInformation": {'opType': 'ADD', "tagIds": []}}

    START_CRAWL_SERVER_REQUEST_JSON = {
        "taskInfo": {
            "associations": [
                {
                    "clientId": 0,
                    "_type_": 3
                }
            ],
            "task": {
                "taskType": 1,
                "taskName": "",
                "taskFlags": {
                    "isEdiscovery": True
                }
            },
            "subTasks": [
                {
                    "subTask": {
                        "subTaskName": "CVPYSDK_FSO_IMMEDIATE",
                        "subTaskType": 1,
                        "operationType": 5025
                    },
                    "options": {
                        "backupOpts": {
                            "backupLevel": 2,
                            "mediaOpt": {
                                "auxcopyJobOption": {
                                    "maxNumberOfStreams": 1,
                                    "allCopies": True,
                                    "useMaximumStreams": True
                                }
                            }
                        },
                        "adminOpts": {
                            "contentIndexingOption": {
                                "fileAnalytics": False,
                                "idaType": 1,
                                "operationType": 2
                            }
                        }
                    }
                }
            ]
        }
    }

Class variables

var ADD_FS_REQ_JSON
var ADD_O365_SDG_BACKED_UP_DS_REQ
var CREATE_CLIENT_REQ_JSON
var CRITERIA_EXTRACTED_DOCS
var ClientType

Different Type of SDG Datasource

var CrawlType

Crawl type for SDG/FSO jobs

var DATA_SOURCE_TYPES
var DS_CLOUD_STORAGE
var DS_FILE
var DYNAMIC_FEDERATED_SEARCH_PARAMS
var EDIT_CATEGORY_PERMISSION
var EXCHANGE_AGENT
var EXCHANGE_BACKUPSET
var EXCHANGE_INSTANCE
var EXCHANGE_SUBCLIENT
var EXPORT_DOWNLOAD_REQ
var FIELD_CONTENT_ID
var FIELD_CRAWL_TYPE
var FIELD_DATA_SOURCE_DISPLAY_NAME
var FIELD_DATA_SOURCE_ID
var FIELD_DATA_SOURCE_ID_NON_SEA
var FIELD_DATA_SOURCE_NAME
var FIELD_DATA_SOURCE_NAME_SEA
var FIELD_DATA_SOURCE_TYPE
var FIELD_DC_PLAN_ID
var FIELD_DISPLAY_NAME
var FIELD_DOCUMENT_COUNT
var FIELD_IS_FILE
var FIELD_PLAN_ID
var FIELD_PSEDUCO_CLIENT_ID
var FIELD_SUBCLIENT_ID
var FSO_SERVERS
var FSO_SERVER_GROUPS
var FS_DEFAULT_EXPORT_FIELDS
var FS_SERVER_HANDLER_NAME
var ONEDRIVE_AGENT
var ONEDRIVE_BACKUPSET
var ONEDRIVE_INSTANCE
var ONEDRIVE_SUBCLIENT
var REVIEW_ACTION_BULK_SEARCH_REQ
var REVIEW_ACTION_DELETE_REQ_JSON
var REVIEW_ACTION_FSO_SUPPORTED
var REVIEW_ACTION_IDA_SELECT_SET
var REVIEW_ACTION_IGNORE_FILES_REQ_JSON
var REVIEW_ACTION_MOVE_REQ_JSON
var REVIEW_ACTION_SDG_SUPPORTED
var REVIEW_ACTION_SEARCH_FL_SET
var REVIEW_ACTION_SET_RETENTION_REQ_JSON
var REVIEW_ACTION_TAG_REQ_JSON
var ReviewActions

Review actions for documents on SDG/FSO app

var RiskTypes

Different risk types for documents on SDG/FSO app

var SERVER_LEVEL_SCHEDULE_JSON
var SHARE_REQUEST_JSON
var START_CRAWL_SERVER_REQUEST_JSON
var SourceType

Source type of data for FSO/SDG app

var TAGGING_ITEMS_REQUEST
var TAGGING_ITEMS_REVIEW_REQUEST
var VIEW_CATEGORY_PERMISSION
class InventoryConstants

Class to maintain constants for inventory manager

Expand source code Browse git
class InventoryConstants:
    """Class to maintain constants for inventory manager"""

    CRAWL_JOB_FAILED_STATE = [5, 6, 7, 8, 9, 10, 11, 12]

    CRAWL_JOB_COMPLETE_STATE = 4

    CRAWL_JOB_COMPLETE_ERROR_STATE = 13

    INVENTORY_ADD_REQUEST_JSON = {
        "name": "",
        "identityServers": [],
        "indexServer": {
            "cloudId": 0,
            "displayName": ""
        }
    }

    FIELD_PROPERTY_NAME = 'name'
    FIELD_PROPERTY_DNSHOST = 'hostName'
    FIELD_PROPERTY_OS = 'operatingSystem'
    FIELD_PROPERTY_IP = 'ipAddress'
    FIELD_PROPERTY_COUNTRYCODE = 'countryCode'

    KWARGS_NAME = 'name'
    KWARGS_IP = 'ip'
    KWARGS_OS = 'os'
    KWARGS_FQDN = 'fqdn'
    KWARGS_COUNTRY_CODE = 'country_code'

    FIELD_PROPS_MAPPING = {
        FIELD_PROPERTY_NAME: KWARGS_NAME,
        FIELD_PROPERTY_IP: KWARGS_IP,
        FIELD_PROPERTY_OS: KWARGS_OS,
        FIELD_PROPERTY_DNSHOST: KWARGS_FQDN,
        FIELD_PROPERTY_COUNTRYCODE: KWARGS_COUNTRY_CODE
    }

    ASSET_FILE_SERVER_PROPERTY = [
        FIELD_PROPERTY_NAME,
        FIELD_PROPERTY_DNSHOST,
        FIELD_PROPERTY_OS,
        FIELD_PROPERTY_IP,
        FIELD_PROPERTY_COUNTRYCODE
    ]

    IDENTITY_SERVER_ASSET_ADD_TO_INVENTORY_JSON = {"identityServers": [], "startDataCollection": True}

    VIEW_CATEGORY_PERMISSION = {
        "permissionId": 31,
        "permissionName": "View",
        "_type_": 122
    }
    EDIT_CATEGORY_PERMISSION = {
        "permissionId": 2,
        "permissionName": "Agent Management",
        "_type_": 122
    }

    INVENTORY_SHARE_REQUEST_JSON = {
        "entityAssociated": {
            "entity": [
                {
                    "_type_": 132,
                    "seaDataSourceId": 0
                }
            ]
        },
        "securityAssociations": {
            "associationsOperationType": 1,
            "associations": [
                {
                    "userOrGroup": [
                        {
                            "userId": 0,
                            "_type_": 0,
                            "userName": ""
                        }
                    ],
                    "properties": {
                        "categoryPermission": {
                            "categoriesPermissionOperationType": 1,
                            "categoriesPermissionList": [
                                VIEW_CATEGORY_PERMISSION
                            ]
                        }
                    }
                }
            ]
        }
    }

    class AssetType(Enum):
        """Asset type for inventory"""
        IDENTITY_SERVER = 61
        FILE_SERVER = 132

Class variables

var ASSET_FILE_SERVER_PROPERTY
var AssetType

Asset type for inventory

var CRAWL_JOB_COMPLETE_ERROR_STATE
var CRAWL_JOB_COMPLETE_STATE
var CRAWL_JOB_FAILED_STATE
var EDIT_CATEGORY_PERMISSION
var FIELD_PROPERTY_COUNTRYCODE
var FIELD_PROPERTY_DNSHOST
var FIELD_PROPERTY_IP
var FIELD_PROPERTY_NAME
var FIELD_PROPERTY_OS
var FIELD_PROPS_MAPPING
var IDENTITY_SERVER_ASSET_ADD_TO_INVENTORY_JSON
var INVENTORY_ADD_REQUEST_JSON
var INVENTORY_SHARE_REQUEST_JSON
var KWARGS_COUNTRY_CODE
var KWARGS_FQDN
var KWARGS_IP
var KWARGS_NAME
var KWARGS_OS
var VIEW_CATEGORY_PERMISSION
class PlanConstants

Class to maintain constants related to DC plan activate operations

Expand source code Browse git
class PlanConstants:
    """Class to maintain constants related to DC plan activate operations"""

    INDEXING_ONLY_METADATA = 1
    INDEXING_METADATA_AND_CONTENT = 2

    DEFAULT_INCLUDE_DOC_TYPES = "*.doc,*.docx,*.xls,*.xlsx,*.ppt,*.pptx,*.msg,*.txt,*.rtf,*.eml,*.pdf," \
                                "*.htm,*.html,*.csv,*.log,*.ods,*.odt,*.odg,*.odp,*.dot,*.pages,*.xmind"
    DEFAULT_EXCLUDE_LIST = [
        "C:\\Program Files",
        "C:\\Program Files (x86)",
        "C:\\Windows"]

    DEFAULT_MIN_DOC_SIZE = 0
    DEFAULT_MAX_DOC_SIZE = 50

    PLAN_UPDATE_REQUEST_JSON = {
        7: {
            "ciPolicyInfo": {
                "ciPolicy": {
                    "policyType": 5,
                    "flags": 536870912,
                    "agentType": {
                        "appTypeId": 0,
                        "entityInfo": {},
                        "flags": {}
                    },
                    "detail": {
                        "ciPolicy": {}
                    }
                }
            },
            "eePolicyInfo": {
                "eePolicy": {
                    "policyType": 3,
                    "flags": 536870920,
                    "agentType": {
                        "appTypeId": 0,
                        "entityInfo": {},
                        "flags": {}
                    },
                    "detail": {
                        "eePolicy": {}
                    }
                }
            },
            "summary": {
                "plan": {
                    "planId": 0
                }
            }
        },
        6: {
            "ciPolicyInfo": {
                "ciPolicy": {
                    "policyType": 5,
                    "detail": {
                        "ciPolicy": {
                            "opType": 2,
                            "enableExactSearch": False,
                            "ciPolicyType": 5,
                            "filters": {
                                "fileFilters": {
                                    "includeDocTypes": "",
                                    "minDocSize": 0,
                                    "maxDocSize": 50
                                }
                            }
                        }
                    }
                }
            },
            "eePolicyInfo": {},
            "exchange": {},
            "office365Info": {
                "o365Exchange": {
                    "mbArchiving": {
                        "policyType": 1,
                        "agentType": {
                            "appTypeId": 137
                        },
                        "detail": {
                            "emailPolicy": {
                                "emailPolicyType": 1,
                                "archivePolicy": {
                                    "primaryMailbox": True,
                                    "contentIndexProps": {}
                                }
                            }
                        }
                    }
                },
                "o365CloudOffice": {
                    "caBackup": {
                        "policyType": 6,
                        "detail": {
                            "cloudAppPolicy": {
                                "cloudAppPolicyType": 1,
                                "backupPolicy": {
                                    "onedrivebackupPolicy": {},
                                    "spbackupPolicy": {},
                                    "teamsbackupPolicy": {}
                                }
                            }
                        }

                    }

                }

            },

            "summary": {
                "plan": {
                    "planName": "",
                    "planId": 0
                }
            }

        }
    }

    PLAN_SCHEDULE_REQUEST_JSON = {
        7: {
            "summary": {
                "plan": {
                    "planId": 0
                }
            },
            "schedule": {
                "associations": [
                    {
                        "_type_": 158,
                        "entityId": 0
                    }
                ],
                "task": {
                    "taskType": 4,
                    "taskName": "",
                    "taskFlags": {
                        "isEdiscovery": True
                    }
                },
                "subTasks": [
                    {
                        "subTask": {
                            "subTaskName": "",
                            "subTaskType": 1,
                            "operationType": 5025
                        },
                        "pattern": {},
                        "options": {
                            "backupOpts": {
                                "backupLevel": 2,
                                "mediaOpt": {
                                    "auxcopyJobOption": {
                                        "maxNumberOfStreams": 1,
                                        "allCopies": True,
                                        "useMaximumStreams": True
                                    }
                                }
                            },
                            "adminOpts": {
                                "contentIndexingOption": {
                                    "fileAnalytics": False,
                                    "idaType": 1,
                                    "operationType": 2
                                }
                            }
                        }
                    }
                ]
            }
        }
    }
    PLAN_SHARE_REQUEST_JSON = {
        "entityAssociated": {
            "entity": [
                {
                    "entityType": 158,
                    "_type_": 150,
                    "entityId": 0
                }
            ]
        },
        "securityAssociations": {
            "associationsOperationType": 1,
            "associations": [
                {
                    "userOrGroup": [
                        {

                        }
                    ],
                    "properties": {
                        "role": {
                            "_type_": 120,
                            "roleId": 0,
                            "roleName": ""
                        }
                    }
                }
            ]
        }
    }

    CREATE_V4_DC_PLAN_REQ = {
        "application": 2,
        "contentAnalyzer": [],
        "contentIndexing": {
            "extractTextFromImage": False,
            "fileFilters": {
                "excludePaths": [
                ],
                "includeDocTypes": "",
                "maxDocSize": 50,
                "minDocSize": 0
            },
            "searchType": "METADATA"
        },
        "entityDetection": {
            "classifiers": [
            ],
            "entities": [
            ]
        },
        "indexServer": {},
        "name": "",
        "threatAnalysis": False
    }

    class RAPlanSearchType(Enum):
        """Class to maintain search types in Risk Analysis Plan"""
        SEARCH_TYPE_ONLY_METADATA = "METADATA"
        SEARCH_TYPE_METADATA_AND_CONTENT = "METADATA_CONTENT"

    class RAPlanAppType(Enum):
        """Class to maintain plan application type"""
        CLASSIFIED = 2
        UNIFIED = 6

Class variables

var CREATE_V4_DC_PLAN_REQ
var DEFAULT_EXCLUDE_LIST
var DEFAULT_INCLUDE_DOC_TYPES
var DEFAULT_MAX_DOC_SIZE
var DEFAULT_MIN_DOC_SIZE
var INDEXING_METADATA_AND_CONTENT
var INDEXING_ONLY_METADATA
var PLAN_SCHEDULE_REQUEST_JSON
var PLAN_SHARE_REQUEST_JSON
var PLAN_UPDATE_REQUEST_JSON
var RAPlanAppType

Class to maintain plan application type

var RAPlanSearchType

Class to maintain search types in Risk Analysis Plan

class RequestConstants

class to maintain constants for request manager

Expand source code Browse git
class RequestConstants:
    """class to maintain constants for request manager"""
    PROPERTY_REVIEW_CRIERIA = 'ReviewCriteria'
    PROPERTY_ENTITIES = 'Entities'
    PROPERTY_REQUEST_HANDLER_ID = 'RequestHandlerId'
    PROPERTY_REQUEST_HANDLER_NAME = 'RequestHandlerName'
    PROPERTY_REVIEW_SET_ID = 'ReviewSetId'
    SEARCH_QUERY_SELECTION_SET = {
        "entity_*",
        "count_entity_*",
        "Url",
        "contentid",
        "FileName",
        "Size",
        "data_source",
        "data_source_name",
        "entities_extracted",
        "RedactMode*",
        "CommentFor*",
        "ConsentFor*"}

    FACET_REVIEWED = '_ConsentFor_%s_b_Reviewed'
    FACET_NOT_REVIEWED = '_ConsentFor_%s_b_Not reviewed'
    FACET_ACCEPTED = '_ConsentFor_%s_b_Accepted'
    FACET_DECLINED = '_ConsentFor_%s_b_Declined'
    FACET_REDACTED = '_RedactMode_%s_b_Redacted'
    FACET_NOT_REDACTED = '_RedactMode_%s_b_Not redacted'
    FACET_COUNT = "count"
    REQUEST_FEDERATED_FACET_SEARCH_QUERY = {"searchParams": [{"key": "q",
                                                              "value": "*:*"},
                                                             {"key": "wt",
                                                              "value": "json"},
                                                             {"key": "rows",
                                                              "value": "0"},
                                                             {"key": "defType",
                                                              "value": "edismax"},
                                                             {"key": "facet",
                                                              "value": "true"},
                                                             {"key": "json.facet",
                                                              "value": "{\"_ConsentFor_<rsidparam>_b_Reviewed\":{\"type\":\"query\",\"domain\":{\"excludeTags\":[\"tag_group_ConsentFor_<rsidparam>_b\",\"tag_ConsentFor_<rsidparam>_b\",\"tag_exclude_ConsentFor_<rsidparam>_b\"]},\"numBuckets\":true,\"mincount\":1,\"q\":\"ConsentFor_<rsidparam>_b:*\",\"facet\":{}},\"_ConsentFor_<rsidparam>_b_Not reviewed\":{\"type\":\"query\",\"domain\":{\"excludeTags\":[\"tag_group_ConsentFor_<rsidparam>_b\",\"tag_ConsentFor_<rsidparam>_b\",\"tag_exclude_ConsentFor_<rsidparam>_b\"]},\"numBuckets\":true,\"mincount\":1,\"q\":\"contentid:* AND -(ConsentFor_<rsidparam>_b:*)\",\"facet\":{}},\"_ConsentFor_<rsidparam>_b_Accepted\":{\"type\":\"query\",\"domain\":{\"excludeTags\":[\"tag_group_ConsentFor_<rsidparam>_b\",\"tag_ConsentFor_<rsidparam>_b\",\"tag_exclude_ConsentFor_<rsidparam>_b\"]},\"numBuckets\":true,\"mincount\":1,\"q\":\"ConsentFor_<rsidparam>_b:true\",\"facet\":{}},\"_ConsentFor_<rsidparam>_b_Declined\":{\"type\":\"query\",\"domain\":{\"excludeTags\":[\"tag_group_ConsentFor_<rsidparam>_b\",\"tag_ConsentFor_<rsidparam>_b\",\"tag_exclude_ConsentFor_<rsidparam>_b\"]},\"numBuckets\":true,\"mincount\":1,\"q\":\"ConsentFor_<rsidparam>_b:false\",\"facet\":{}},\"_RedactMode_<rsidparam>_b_Redacted\":{\"type\":\"query\",\"domain\":{\"excludeTags\":[\"tag_group_RedactMode_<rsidparam>_b\",\"tag_RedactMode_<rsidparam>_b\",\"tag_exclude_RedactMode_<rsidparam>_b\"]},\"numBuckets\":true,\"mincount\":1,\"q\":\"RedactMode_<rsidparam>_b:true\",\"facet\":{}},\"_RedactMode_<rsidparam>_b_Not redacted\":{\"type\":\"query\",\"domain\":{\"excludeTags\":[\"tag_group_RedactMode_<rsidparam>_b\",\"tag_RedactMode_<rsidparam>_b\",\"tag_exclude_RedactMode_<rsidparam>_b\"]},\"numBuckets\":true,\"mincount\":1,\"q\":\"RedactMode_<rsidparam>_b:false\",\"facet\":{}},\"FileExtension\":{\"type\":\"terms\",\"domain\":{\"excludeTags\":[\"tag_FileExtension\",\"tag_exclude_FileExtension\"]},\"numBuckets\":true,\"mincount\":1,\"field\":\"FileExtension\",\"limit\":-1,\"facet\":{},\"sort\":{\"count\":\"desc\"}},\"ReadAccessUserName\":{\"type\":\"terms\",\"domain\":{\"excludeTags\":[\"tag_ReadAccessUserName\",\"tag_exclude_ReadAccessUserName\"]},\"numBuckets\":true,\"mincount\":1,\"field\":\"ReadAccessUserName\",\"limit\":-1,\"facet\":{},\"sort\":{\"count\":\"desc\"}},\"data_source_name\":{\"type\":\"terms\",\"domain\":{\"excludeTags\":[\"tag_data_source_name\",\"tag_exclude_data_source_name\"]},\"numBuckets\":true,\"mincount\":1,\"field\":\"data_source_name\",\"limit\":-1,\"facet\":{},\"sort\":{\"count\":\"desc\"}}}"},
                                                             {"key": "useDCubeReq",
                                                              "value": "true"}]}

    FIELD_DOC_COUNT = "TotalDocuments"
    FIELD_REVIEWED = "ReviewedDocuments"
    FIELD_NOT_REVIEWED = "Non-ReviewedDocuments"
    FIELD_ACCEPTED = 'AcceptedDocuments'
    FIELD_DECLINED = 'DeclinedDocuments'
    FIELD_REDACTED = 'RedactedDocuments'
    FIELD_NOT_REDACTED = 'Non-RedactedDocuments'

    class RequestStatus(Enum):
        """enum to specify different request status"""
        TaskCreated = 1
        TaskConfigured = 2
        ReviewInProgress = 3
        ReviewCompleted = 4
        ApproveCompleted = 5
        ExportCompleted = 6
        DeleteCompleted = 7
        TaskCompleted = 8
        ApprovalRequested = 9
        ActionInProgress = 10
        CompletedWithErrors = 11
        Failed = 12

    class RequestType(Enum):
        """enum to maintain different request type"""
        EXPORT = 'EXPORT'
        DELETE = 'DELETE'

Class variables

var FACET_ACCEPTED
var FACET_COUNT
var FACET_DECLINED
var FACET_NOT_REDACTED
var FACET_NOT_REVIEWED
var FACET_REDACTED
var FACET_REVIEWED
var FIELD_ACCEPTED
var FIELD_DECLINED
var FIELD_DOC_COUNT
var FIELD_NOT_REDACTED
var FIELD_NOT_REVIEWED
var FIELD_REDACTED
var FIELD_REVIEWED
var PROPERTY_ENTITIES
var PROPERTY_REQUEST_HANDLER_ID
var PROPERTY_REQUEST_HANDLER_NAME
var PROPERTY_REVIEW_CRIERIA
var PROPERTY_REVIEW_SET_ID
var REQUEST_FEDERATED_FACET_SEARCH_QUERY
var RequestStatus

enum to specify different request status

var RequestType

enum to maintain different request type

var SEARCH_QUERY_SELECTION_SET
class TagConstants

class to maintain all the Tags related constants

Expand source code Browse git
class TagConstants:
    """class to maintain all the Tags related constants"""

    TAG_SET_ADD_REQUEST_JSON = {
        "entityType": 9504,
        "operationType": 1,
        "fromSite": 4,
        "container": {
            "containerType": 9504,
            "containerName": "",
            "comment": ""
        }
    }

    TAG_SET_MODIFY_REQUEST_JSON = copy.deepcopy(TAG_SET_ADD_REQUEST_JSON)
    TAG_SET_MODIFY_REQUEST_JSON['operationType'] = 3

    TAG_SET_DELETE_REQUEST_JSON = {
        "entityType": 9504,
        "containers": [
            {
                "containerType": 9504,
                "containerId": 0
            }
        ]
    }

    TAG_ADD_REQUEST_JSON = {
        "container": {
            "containerId": 0
        },
        "tags": [
            {
                "name": ""
            }
        ]
    }

    TAG_MODIFY_REQUEST_JSON = copy.deepcopy(TAG_ADD_REQUEST_JSON)
    TAG_MODIFY_REQUEST_JSON['tags'][0]['tagId'] = 0

    VIEW_PERMISSION = {
        "permissionId": 31,
        "_type_": 122,
        "permissionName": "View"
    }
    ADD_PERMISSION = {
        "permissionId": 34,
        "_type_": 122,
        "permissionName": "Add/Append"
    }

    TAG_SET_SHARE_REQUEST_JSON = {
        "entityAssociated": {
            "entity": [
                {
                    "tagId": 0,
                    "_type_": 9504
                }
            ]
        },
        "securityAssociations": {
            "associationsOperationType": 1,
            "associations": [
                {
                    "userOrGroup": [
                        {

                        }
                    ],
                    "properties": {
                        "permissions": [
                            VIEW_PERMISSION
                        ]
                    }
                }

            ]
        }
    }

Class variables

var ADD_PERMISSION
var TAG_ADD_REQUEST_JSON
var TAG_MODIFY_REQUEST_JSON
var TAG_SET_ADD_REQUEST_JSON
var TAG_SET_DELETE_REQUEST_JSON
var TAG_SET_MODIFY_REQUEST_JSON
var TAG_SET_SHARE_REQUEST_JSON
var VIEW_PERMISSION
class TargetApps (value, names=None, *, module=None, qualname=None, type=None, start=1)

Class to maintain supported apps types in Activate

Expand source code Browse git
class TargetApps(Enum):
    """Class to maintain supported apps types in Activate"""
    SDG = 2
    FSO = 1
    CASE_MGR = 4
    FS = 8
    RA = 128

Ancestors

  • enum.Enum

Class variables

var CASE_MGR
var FS
var FSO
var RA
var SDG
class TrainingStatus (value, names=None, *, module=None, qualname=None, type=None, start=1)

Class to maintain training status for classifier

Expand source code Browse git
class TrainingStatus(Enum):
    """Class to maintain training status for classifier"""
    NOT_APPLICABLE = 0
    CREATED = 1
    RUNNING = 2
    FAILED = 3
    COMPLETED = 4
    CANCELLED = 5
    NOT_USABLE = 6

Ancestors

  • enum.Enum

Class variables

var CANCELLED
var COMPLETED
var CREATED
var FAILED
var NOT_APPLICABLE
var NOT_USABLE
var RUNNING