Skip to content

serverutils

Helper functions for working with revit server.

Attributes

MODEL_HISTORY_SQLDB = '/Data/Model.db3' module-attribute

SyncHistory = namedtuple('SyncHistory', ['index', 'userid', 'timestamp']) module-attribute

namedtuple for model sync history data in revit server

Attributes:

Name Type Description
index int

row index in history db
userid str

user identifier
timestamp str

time stamp string (e.g. "2017-12-13 19:56:20")

Functions

get_server_path(doc, path_dict)

Return file path of a model hosted on revit server.

Parameters:

Name Type Description Default
doc Document

revit document object

 required
path_dict dict

dict of RSN paths and their directory paths

 required

Examples:

rsn_paths = {'RSN://SERVERNAME': '//servername/filestore'}
get_server_path(doc, rsn_paths)
"//servername/filestore/path/to/model.rvt"

Source code in pyrevitlib/pyrevit/revit/serverutils.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def get_server_path(doc, path_dict):
    """Return file path of a model hosted on revit server.

    Args:
        doc (Document): revit document object
        path_dict (dict): dict of RSN paths and their directory paths

    Examples:
        ```python
        rsn_paths = {'RSN://SERVERNAME': '//servername/filestore'}
        get_server_path(doc, rsn_paths)
        ```
        "//servername/filestore/path/to/model.rvt"
    """
    model_path = doc.GetWorksharingCentralModelPath()
    path = DB.ModelPathUtils.ConvertModelPathToUserVisiblePath(model_path)
    for key, value in path_dict.items():
        path = path.replace(key, value)

    return path

get_model_sync_history(server_path)

Read model sync history from revit server sqlite history file.

Parameters:

Name Type Description Default
server_path str

directory path of revit server filestore

 required

Returns:

Type Description
list[SyncHistory]

list of SyncHistory instances

Examples:

get_model_sync_history("//servername/path/to/model.rvt")
[SyncHistory(index=498, userid="user", timestamp="2017-12-13 19:56:20")]

Source code in pyrevitlib/pyrevit/revit/serverutils.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def get_model_sync_history(server_path):
    """Read model sync history from revit server sqlite history file.

    Args:
        server_path (str): directory path of revit server filestore

    Returns:
        (list[SyncHistory]): list of SyncHistory instances

    Examples:
        ```python
        get_model_sync_history("//servername/path/to/model.rvt")
        ```
        [SyncHistory(index=498, userid="user",
                    timestamp="2017-12-13 19:56:20")]
    """
    db_path = server_path + MODEL_HISTORY_SQLDB
    conn = sqlite3.connect(db_path)
    sync_hist = []
    for row in conn.execute("SELECT * FROM ModelHistory"):
        sync_hist.append(SyncHistory(index=int(row[0]),
                                     userid=row[1],
                                     timestamp=row[2][:-1]))
    return sync_hist