Visual interface browser

The present disclosure describes viewing visual interface documents through a visual interface browser. A visual interface browser is caused to be displayed on a user device. A visual interface document representing a technical interface specification is retrieved from a repository in response to user selection of a technical interface icon through the visual interface browser. Sub-document technical data associated with the visual interface document is retrieved from the repository. The visual interface document including sub-document technical data is caused to be displayed on the user device. Notes associated with the visual interface document and associated with an authenticated user of the user device are caused to be displayed on the user device.

FIELD

The present application relates to a visual interface browser.

BACKGROUND

Typical technical interface specifications (documents including details for software developers) include service level agreement (SLA) information, contact information, configuration information, as well as images or diagrams that provide a visual reference to assist with understanding. However, even standardized technical interface specification layouts can impede efforts to quickly reference and quickly visualize technical specifications and solutions described by the document due to an overwhelming amount of information.

Technical interface specifications also present learning curves for individuals that need to reference the specifications for educational purposes relating to a producer/consumer environment and for those who need to apply information from the technical interface specifications within a proper context. In order to overcome these issues, technical interface specifications may include multiple images and figures. However, this is still only a marginal improvement, and does not facilitate efficient viewing of technical interface specifications.

SUMMARY

In accordance with an embodiment, the present disclosure describes facilitating the viewing of documents through a visual interface browser. A visual interface browser is caused to be displayed on a user device. A visual interface document representing a technical interface specification is retrieved from a repository in response to user selection of a technical interface icon through the visual interface browser. Sub-document technical data associated with the visual interface document is retrieved from the repository. The visual interface document including sub-document technical data is caused to be displayed on the user device. Notes associated with the visual interface document and associated with an authenticated user of the user device are caused to be displayed on the user device.

In an embodiment, a plurality of technical interface specifications are received. Each of the technical interface specifications is formatted to link the technical interface specifications with a corresponding technical interface icon. Each of the technical interface specifications is indexed to generate a plurality of visual interface documents accessible through the visual interface browser. Indexing each of the technical interface specifications comprises generating a categorized visualization of each technical interface specification for viewing as a visual interface document accessible through the visual interface browser.

In an embodiment, each visual interface document and associated sub-document technical data are linked within the repository.

In an embodiment, log-in credentials are received from a user of the user device. The user is authenticated based on the log-in credentials. Notes associated with the user are retrieved. The notes associated with the visual interface document are external to the visual interface document and associated sub-document technical data.

These and other advantages of this disclosure will be apparent to those of ordinary skill in the art by reference to the following detailed description and the accompanying drawings.

DETAILED DESCRIPTION

The method and system described herein addresses the technical interface specification viewing problem discussed above.

The visual interface browser described herein facilitates retrieval, viewing, sorting and referencing of technical interface specifications using visual interface documents (VIDs). VIDs incorporate visualization and contextual assignment of related data to each VID through the retrieval of associated sub-document technical data. The sub-document technical data may include, for example, service level agreement (SLA) information, contact information, and configuration information. VIDs also contain a logical view and embedded documentation of a provider/consumer system. VIDs are a visual representation of technical interface specifications that can be accessed, browsed, and sorted using the visual interface browser described herein.

The visual interface browser also includes functionalities supporting the use of VIDs as learning references. Users may add comments, notes, or instructions that are related to the VIDs. Any information added by users to a VID may be added and associated with a respective user, without the added information becoming a part of official documentation, or in other words, a part of the VID itself. The visual interface browser provides an efficient system for viewing VIDs because the visual interface browser also supports multiple and simultaneous viewing of different VIDs for comparison and reference.

FIG. 1illustrates an exemplary visual interface browser display100in accordance with an embodiment of the present disclosure. Visual interface browser display100includes a plurality of technical interface icons. These technical interface icons are represented graphically inFIG. 1as technical interface icons102,104,106, and108. Each technical interface icon represents a link to a VID. Selection of a technical interface icon causes display of an associated VID.

FIG. 2illustrates exemplary visual interface browser100after selection of a technical interface icon, in accordance with an embodiment of the present disclosure. For example, if technical interface icon102is selected by a user, then associated VID202is presented for display on visual interface browser display100. VID202is retrieved from a repository to be displayed on visual interface browser display100. As multiple VIDs may be presented within visual interface browser display100,FIG. 2also shows VID204, associated with technical interface icon104, presented in response to a user selection of technical interface icon104. VID204is also retrieved from the repository. Within each VID, associated sub-document technical data is also displayed. The sub-document technical data is also retrieved from the repository and populated within a corresponding VID. InFIG. 2, VID202includes sub-document technical data206,208,210, and212, and VID204includes sub-document technical data214, and216. It is understood that visual interface browser display100may also support the display of more than two VIDs.

FIG. 3illustrates exemplary visual interface browser display100after retrieval and display of a VID, and including notes associated with the VID, in accordance with an embodiment of the present disclosure. For the sake of clarity,FIG. 3includes one selected VID202with associated sub-document technical data206for display. Also illustrated byFIG. 3are a plurality of notes302associated with VID202. These notes are added by a specific user, logged into a central server that facilitates access to the visual interface browser shown by visual interface browser display100. The notes are stored in the repository externally to the VID and associated sub-document technical data. Thus, the notes do not become a part of the official documentation or VID. Additionally, since the notes are not officially a part of the VID, there can be different sets of notes associated with different users. Thus, for example, a first user accessing VID202for display will see a different plurality of notes302than a second user accessing VID202.

As each unique user adds notes to a specific VID and its sub-sections, a new section to the users VID Notes document will be created. The Visual Interface Browser has the user id and will use it as a key for the Notes Document. The notes document will contain similar document elements (sub-sections) as defined in the original VID, however the content of each sub-section will only consist of the unique user notes. As a VID is selected for review, the Visual Interface Browser will also retrieve the associated notes document for that user. Both documents will be loaded into memory and parsed accordingly. The contents of VID-Notes will be merged with the VID contents for on-screen display. As notes are added, they will be added to appropriate user document and document section.

The example below depicts the notes created for user BL3825 for VID ABC and VID XYZ):

Brief Example of VID ABC Data Content Showing a Sub-Section (Element):

<VID XYZ><Hours Avail>9:00am CST to 6:00pm CST</Hours Avail>other data</VID XYZ>
VID Notes File for User BL3825 for VID ABC and VID XYZ:

FIG. 4illustrates an exemplary data structure showing data associated with a VID, in accordance with an embodiment of the present disclosure. As discussed, a VID is a visual representation of a technical interface specification. For example, VID400includes data representing the technical interface specification, represented by blocks404, and associated sub-document technical data, represented by blocks402, and shown within VID400to illustrate that sub-document technical data402is a part of the original documentation or VID. Additionally, notes, stored externally to the VID, may be associated with the VID. Notes are stored externally because any number of notes may be associated with different users. As different users view VID400, they will be presented with notes associated with a particular user, and not any other notes. For example, notes406,408,410, and412are all associated with VID400, but are each associated with a different user.

FIG. 5illustrates an exemplary system including user devices that communicate with a central server in order to access visual interface browser100, in accordance with an embodiment of the present disclosure. For example, user device502communicates, over network504, with central server506, which facilitates display of visual interface browser100on display508of user device502. A user device may be, but is not limited to, any type of computing device with a display capable of displaying visual interface browser100. Visual interface browser100is displayed on display508with a plurality of technical interfaces, that when selected by user device502, causes associated VIDs to be retrieved from repository510, in order to be displayed via visual interface browser100. Each VID is comprised of two distinct parts; the visual interactive GUI and the data content describing the specification. The data content format is a well-formed extensible markup language file (XML). The XML file can be stored in a standard XML database within an XML type table or stored as a flat file within a folder structure. The visual interactive GUI in present form is a Java class which is stored in a code repository and deployed with the Visual Interface Browser application. These Java classes are instantiated as needed by the application. The VID's and VID-Notes are the VID's and VID Notes Sub-document technical data, as well as notes associated with a user of user device502may also be retrieved from repository510for display on visual interface browser100. Similarly, user device512may also communicate over network504, with central server506, to have visual interface browser100displayed on display514of user device512. A different set of notes associated with a user of user device512and associated with the same VID, may be retrieved from repository510for display.

Retrieval of notes from associated with a user requires a user entering log-in credentials, which are received by the central server, authenticating the user based on the log-in credentials, and retrieving notes associated with the user. For example, a user enters log-in credentials at user device502, which are transmitted and received by central server506. Central server506authenticates the user based on the received log-in credentials. After authentications, specific notes associated with a VID selected by the user may be retrieved from repository510.

FIG. 6illustrates an exemplary method600for a central server to generate VIDs, in accordance with an embodiment of the present disclosure. At step610, a central server receives a plurality of technical interface specifications. For example, central server506receives a plurality of technical interface specifications.

At step620, each of the plurality of technical interface specifications is formatted to be linked to an associated technical interface icon. For example, central server506formats each of the received plurality of technical interface specifications to link them with an associated technical interface icon.

At step630, each of the formatted plurality of technical interface specifications is indexed to generate a plurality of visual interface documents (VIDs). Central server506indexes the formatted plurality of technical interface specifications to generate a plurality of VIDs for storage on repository510. Indexing each of the formatted technical interface specifications includes generating a categorized visualization of each technical interface specification for viewing as a VID, as well as identifying sub-document technical data to be linked to the VIDs. Each VID is comprised of two distinct parts; the visual interactive GUI and the data content describing the specification. The data content format is a well-formed extensible markup language file (XML), which is programmatically parsed and loaded in memory as a Document Object Model (DOM). The XML file and therefore the DOM, contain elements, which act as indexes to the relevant content therein and can be queried, retrieved and updated accordingly. As the user interacts with various aspects of the visual GUI using mouse-clicks or touch, these actions trigger a query event to the DOM to retrieve and display the relevant sub-document data content. Since the query event is context sensitive, the sub-document element name is defined as part of the query, used as the index to retrieve content from the DOM, and displayed to the user.

FIG. 7illustrate an exemplary method700for a central server to cause display of VIDs on a visual interface browser, in accordance with an embodiment of the present disclosure. At step710, a visual interface browser is caused to be displayed on a user device. For example, central server506communicates with user device502through a network and causes the display of a visual interface browser on user device502through a transmission of data.

At step720, a request to access a VID is received from a user of a user device. For example, user device502transmits a request to central server506to view a VID. A request for the VID is transmitted from user device502based on a selection of a technical interface icon, shown on visual interface browser display100, associated with the VID. Visual interface browser display100may be displayed on a display of user device502.

At step730, in response to a request from a user device, a VID is retrieved from the repository510.

At step740, the sub-document technical data that is associated with the VID is retrieved from repository510. The sub-technical data represents technical data that is stored within repository510and that has been associated with a VID during indexing. Once a VID and sub-document technical data has been retrieved from repository510, central server506may facilitate the display of the VID and sub-document technical data at user device502.

At step750, the central server transmits the VID and associated sub-document technical data to user device, causing the VID to be displayed. For example, central server506transmits the retrieved VID and associated sub-document technical data to user device502, wherein the VID and associated sub-document technical data is caused to be displayed on display508of user device502.

At step760, any notes associated with the VID, and associated specifically with a user of the user device, may be retrieved and transmitted to the user device for display. For example, central server506searches repository510for any notes associated with the VID and a particular user at user device502. Central server506searches repository510for notes that are linked to the VID. Then central server506searches the notes linked to the VID for specific ones that are associated with a user logged in at user device506. These notes are then transmitted to user device502and are caused to be displayed on display508of user device502as annotations accompanying the VID and associated sub-document technical data.

FIG. 8illustrates an exemplary view of a visual interface browser display800in accordance with an embodiment of the present disclosure. Visual interface browser display800includes a display of a VID802, and associated sub-document technical data804. Additionally, technical interfaces806,808, and810are displayed in the background.

FIG. 9illustrates an exemplary view of a visual interface browser display900in accordance with an embodiment of the present disclosure. Visual interface browser display900includes technical interfaces902,904, and906shown throughout, as well as certain associated VIDs908,910, and912.

The above-described methods for viewing VIDs using a visual interface browser can be implemented on a computer using well-known computer processors, memory units, storage devices, computer software, and other components. A high-level block diagram of such a computer is illustrated inFIG. 10. Computer1000contains a processor1010, which controls the overall operation of the computer1000by executing computer program instructions, which define such operations. The computer program instructions may be stored in a storage device1020, or other computer readable medium (e.g., magnetic disk, CD ROM, etc.), and loaded into memory1030when execution of the computer program instructions is desired. Thus, the method steps ofFIGS. 6 and 7can be defined by the computer program instructions stored in the memory1030and/or storage1020and controlled by the processor1010executing the computer program instructions. For example, the computer program instructions can be implemented as computer executable code programmed by one skilled in the art to perform an algorithm defined by the method steps ofFIGS. 6 and 7. Accordingly, by executing the computer program instructions, the processor1010executes an algorithm defined by the method steps ofFIGS. 6 and 7. While the computer1000has been described as being used for converting data messages by performing an algorithm in accordance with the method steps shown inFIGS. 6 and 7, computer1000may also perform other functionalities, such as those described above in connection with the other Figures. The computer1000also includes one or more network interfaces1040for communicating with other devices via a network. The computer1000also includes input/output devices1050that enable user interaction with the computer1000(e.g., display, keyboard, mouse, speakers, buttons, etc.) One skilled in the art will recognize that an implementation of an actual computer could contain other components as well, and thatFIG. 10is a high level representation of some of the components of such a computer for illustrative purposes.