Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: I corrected grammatical errors

A user who wants to upload or download documents from his/her clients can do it from the app.

Also, identifiers work similarly to documents, so you can also follow this guide.


Panel

On this page:

Table of Contents
maxLevel2
minLevel3
printablefalse


Prerequisites: Logging in and Opening clients

There are two things you need to do before you are working with Documents and Identifiers:

  1. You need to be logged in. (See Login/Logout)
    1. Once you are logged in, it should take you to a screen similar to the following:



  2. You need to open a client whose documents you want to read or write. (See Search & View Client Details)
    1. To open a client, first tap the menu in the action bar in the top left corner (three lines). A menu should pop up as the following:



    2. Tap Clients. This will take you to a list of clients which you can select from. A sample list is shown below:



    3. From there, you can scroll through to find your client and select it. A sample client is shown below:




Working with Documents

Uploading a document/image

You can upload multiple documents for every client.

  1. Once you have a client opened (See above for a sample client), tap on the menu key in the top right corner (three dots). This will bring up an expanded menu, which should look like the following:


  2. Tap Documents to view the Client's documents. A sample list of documents is shown below:



  3. To upload a document, simply tap the plus icon. This will bring up a dialog, which should look like the following:



  4. Fill out the fields shown (Name and Description). Then tap on "Click to Choose File", navigate your device using a file manager, and find the document you want to upload. A sample filled dialog looks like the following:

    Field Name (attribute)

    Description

    Example

    Validations (if applicable)

    Name

    The name of the document to upload.

    Sample Document

    This should consist of alphanumeric characters.

    Description

    A description of the document to upload.

    This is a sample document.

    This should consist of alphanumeric characters and provide a summary of what the document is about.


  5. Finally, tap on the blue upload "UPLOAD" button.

Managing a Document/Image (Downloading, Updating, and Removing a Document)

  1. In order to manage a document, navigate to a Client's documents as described above. A sample documents page is shown below:



  2. Tap on the cloud icon next to a Document it . This will bring up a menu containing three actions you can perform. A sample menu is shown below:

  3. You can perform three actions:
    1. Download the document to your device by tapping download.
    2. Remove the document from the client by tapping remove.
    3. Update the document by tapping update. This will bring up a similar dialog to when uploading a document. A sample dialog is shown below:



Working With Identifiers

Adding an Identifier

  1. First, navigate to a client, and tap the menu. A sample menu is shown below:



  2. Instead of tapping Documents as before, tap Identifiers. It will take you to the Identifiers for that Client. A sample identifiers page is shown below:



  3. Tap the plus icon in the top right hand corner. It will bring up a dialog which looks like the following:



  4. Fill out the necessary fields. A sample filled out Identifier is shown below:

    Field Name (attribute)

    Description

    Example

    Validations (if applicable)

    Identifier Type

    The type of Identifier to be added

    Passport Id

    Government Id

    Drivers License

    Any Other Id Type

    Ration Card

    Voter ID

    Only one option should be selected from the provided ones described.

    Status

    The status of the Identifier to be added

    Active or Inactive

    Only one option should be selected.

    Unique IDThe ID of the Identifier to be added123abc456This should consist of alphanumeric characters.
    DescriptionThe description of the Identifier to be addedThis is a sample description.This should consist of alphanumeric characters and provide a summary of what the Identifier is about.

  5. Tap the blue Create Identifier button.
  6. If you refresh the Identifiers page, the new Identifier should be there. A refreshed Identifiers page is shown below:

Managing an Identifier

  1. Navigate to the Identifiers page as described above.
  2. To manage an Identifier, tap the menu (three dots) next to it. It will expand a menu, which should look like the following:



  3. You can perform two actions:
    1. Remove the Identifier by tapping Remove.
    2. Manage the Documents by tapping Documents. From there, everything is as described under the Working with Documents section above.

Filter by label (Content by label)
showLabelsfalse
max5
spacesdocs
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel = "kb-how-to-article" and type = "page" and space = "docs"
labelskb-how-to-article