Versions Compared

Version Old Version 24 New Version 25
Changes made by

serdar ak

serdar ak

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Tip

The Agents can be manually installed on FileServers or EndPoints. But if you have many EndPoints, then using a tool like ManageEngine or SCCM for deployment is suggested.

GDE agent software updates are auto. It may be set to update from a local source.

GEODI Server has a monitor panel to watch EndPoints. GEODI Agent Management Panel

Gliffy
imageAttachmentIdatt4336386146
macroIdc02c52c0-32db-418a-8a1e-64c4cfe9a700
baseUrlhttps://decesw.atlassian.net/wiki
nameGDE-EN
diagramAttachmentIdatt4336648300
containerId3972202552
timestamp1702733720298

Table of Contents
Tip

Conditions for connection

  • GEODI Server

    1. Server URL → This URL must be accessible from the endpoints

    2. A GEODI project or a source in an existing project to index files

    3. A token with permission to feet the GEODI Projesi or the source

    4. Folder and file types to index on the endpoints. Configuration may be customized per server or IP.

    • Endpoints

  • Access to the server URL

  • Port 1982 must be open for request from the server

    • You may install it manually for a File Server or a few PCs, but you will need a tool like ManageEngine or SCCM if there are many endpoints.

    Installation Checklist

    Subject

    Description

    Create a new project or choose an existing project to index files.

    A separate project is OK for discovery purposes, but it is better to add PCs to an existing project if you have Enterprise Search.

    This project URL must be accessible from the EndPoints.

    The recognizer, GDE, must be on the project. Find GDE recognizer from IT group.

    Create a token

    Follow the procedure on this page to get the Token.

    As a best practice, we suggest you create a separate user for the Token. And tokenusers password should not be changed.

    Follow the procedures for different OSs

    These pages will lead you to each OS.

    Child pages (Children Display)

    GDE Configuration Settings

    The settings determine which local folders and file types to discover. There may be a single setting for all, or you may customize it by clients.

    Client Monitoring

    Activate GEODI Agent Management Panel

    Troubleshooting

    Expand
    titleIndexing does not start

    1. Check Agent Management Panel; if the health of the endpoint looks ok, then waiting a while will solve the problem. GEODI Server queues the incoming data. So, the time for the files on the endpoint may yet to come.

    2. Check if endPoint has access to the GEODI Server. GEODI must be accessible from a browser.

    3. Check if the port (default 1982) is available and not blocked. You may use GDE API calls to check that. Use a browser to make calls.

    4. Check the Firewall, Virus, or any similar tool; do not block the communication.

    5. Check if the client machine is up and running. GDE is installed and running (Geodi.Desktopexplorer.exe should be in the task list)

    6. Check if the token is active , QQQ: <GEODI_URL>/api/token_parser.html

    Expand
    titleSettings are not effective,

    1. The Setting file may not be a valid JSON. Validate it with an online tool.

    2. Settings will generally be adjusted in an hour. If the IP of the endpoint has changed, this may take up to 3 hours.

    Expand
    titleSome files are not indexed

    1. The default settings block some large files, like videos. Files larger than 100 MB or compressed files larger than 500MB are blocked. You may change the settings. The settings will be effective in an hour.

    Expand
    titleThe endPoint has been formatted

    1. Install the GDE as usual. The endpoint will be treated as new. The old data is preserved.

    ...

    Expand
    titleWho is going to see an the files from endpoints files?

    1. Sistem Admins see the files. But they may not have permission to open the all files. QQQ

    2. Other users' permissions depend on Enable LDAP on the settings.Enable … on GEODI source to have everyone see only their files. … (link) settings. If LDAP is enabled, then local permissions are used.

    3. It is possible to set each user to see their own PC files. Please ask the DECE team how to set that.

    Expand
    titleWhat happens if the endPoint is formatted?

    1. Install the GDE as usual. The endpoint will be treated as new. The old data is preserved.

    ...

    Setting Name

    Type

    Description

    FolderList

    string[]*

    Used to specify the folders to be scanned. Folders can be identified by separating them with ","

    The default directory is %UserProfile% (includes documents, downloads, desktops, etc.). A complete list can be found at https://docs.microsoft.com/tr-tr/dotnet/api/system.environment.specialfolder?view=netframework-4.0. Values are case-sensitive. Subdirectories can also be defined as %UserProfile%\\Desktop.

    You can use ["*"] to scan all disks.

    ExplorerPort

    int

    If a value above 0 is entered, Explorer will run in APP→GEODI→APP mode. Firewall settings must be made in this mode.

    When a port to be used is defined, as long as the client is open, the content can be viewed on GeodiDefault is 1982.

    Optionally you may set port value to 0. Discovery and search will be fine but But in this case GEODI can not open the local files.

    EnableLDAP

    bool

    If a true value is given, LDAP authorizations of the files are also indexed.

    Default value: false

    IgnoreFolders

    string[]

    List of folders to ignore. * is accepted. Used in combination with the settings under Geodi Settings/IgnoreFolders.

    Example: ["*:\\data","C:\User*"]

    Default value: null

    IgnoreFiles

    string[]

    List of folders to ignore. * is accepted and used with the settings under Geodi Settings/IgnoreFileTypes.

    Default value:["*.MP4","*.MOV","*.MP3"]

    Metadata

    You can define metadata for parsing files from clients. These metadata are specified in the settings file. The values used in the default settings can be seen in the example file.

    Searching with metadata is done with <metaname>:<value> Example IP:192.168.1.1

    The defined metadata and values will be visible in the GEODI search interface.

    GDE API

    You may use a browser to make these calls.

    <ClientIP>:<1982>/DEW?op=GetStatus

    Gets the status of GDE Agent

    {"StatusText":"","RequestCount":0,"FileCount":0,"SendCount":0,"IgnoreCount":0,"Server":"<GEODI_URL>"}

    (info) Default port = 1982, may be different

    <ClientIP>:<1982>/DEW?op=GetLastError

    Gets the GDE agent errors.

    If no error, retuns null. Else

    {"Server":"<GEODI_URL>", "LastErrorTime": {}, "LastError" : "", "TotalErrorCount": n}

    Token Creation
    Anchor
    Token
    Token

    1. Log in with a user accessing the Source that GDEs will feed.

    2. Open the page: Generating a GEODI Token. <GEODI_URL>>/api/GeodiTokenApi.html?loginWithGuest=1

    3. Check the Feed Checkbox and enter the Source's name in the AllowList.

    4. Now you are ready to create the Token.

    5. This page may be used to check if a token is valid: <GEODI_URL>/api/token_parser.html

    ...