> For the complete documentation index, see [llms.txt](https://docs.labpipe.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.labpipe.org/client/walkthrough.md).

# Walkthrough

## Launch LabPipe Client for the first time

![First use mandatory settings](/files/-LsRqPpzHLL_k6-DIlcJ)

1. An interactive walkthrough of each fields on the settings page.
2. **Set data directory.** \
   This is going to be the local storage for your collected data and files. Your selected directory will be displayed below the browse button.
3. **Set API root URL.** \
   If your LabPipe Server APIs can be accessed at `http://example.server.com/api/*`, please enter `http://example.server.com` , and ***validate*** your entry. If the url you entered is valid and accessible, it will be displayed below the entry field.
4. **Set API access token.**\
   Enter your allocated access token and key here and then ***validate*** your entry. If the credentials you entered is valid, it will be displayed below the entry field.
5. **Set server monitor interval.**\
   Enter how frequent you prefer your client to check for connection to the server. Please note that the unit here is *millisecond*.
6. **Set server monitor retry interval.**\
   Enter how frequent you prefer your client to retry connecting to the server when the server monitor fails to connect. Please note that the unit here is *millisecond*.

Once you have entered all mandatory settings, you will need to click ***continue*** to restart the application for all settings to become effective.

## Login

![Login](/files/-LsS2_KZFDitY-S_nART)

On restart, you will be redirect to the login page. You will need the following information:

* Your current site location
* The instrument now you will be operating
* Your allocated user ID and password

![Confirm login](/files/-LsS3cH6PDQLUOv0up8x)

If you have entered correct user ID and password, you will be prompt to confirm your details before continue to the task portal.

## Task portal

![Task portal](/files/-LsS6-1XH2gw7Hw4s-yW)

On successful login, you will see the task portal, where you can now select a study to retrieve forms for current study and instrument to start [sample/data collection](/client/walkthrough/sample-data-collection.md).

{% hint style="info" %}
It is recommended that you change your password immediately on your first login. Click your name at the top right will bring you to the [profile portal](/client/walkthrough.md#profile-portal), where you can view your profile details and change password.
{% endhint %}

## Profile portal

![Profile portal](/files/-LsS7saY0sy-ayRqNe-R)

## Browse portal

![Browse portal](/files/-LsSAeEfP1K-8vjvCcwu)

The browse portal allows users to view records stored both locally and remotely. Quick actions are available such as upload local records to server, view record reports, etc.

![Record report](/files/-LsSCEQd_l-hRbJUqmAG)

## Manage portal

![Manage portal](/files/-LsSCsad4F1_2KZQe5BE)

The manage portal allows users to manage parameter records on the server.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.labpipe.org/client/walkthrough.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.