Documents

Documents section is a place where you can define banners or recommendations depending on eg the time of day. In one document you can jam a few other additional banner features in the form of JSON file.

This is an extremely important section from the customers’ point of view, who, thanks to an earlier implementation of the relevant file, will be able to see, for example, the view of the created mobile application.

  • Examples of the use of documents: In the morning - using documents you can show the breakfast offer, at noon - dinner offer, in the evening - a dinner offer. To do this, you have to create 3 documents, in which information is plotted, which should be displayed at specific time.

Configure documents

In this section you can add new files, edit existing ones and delete them when they are no longer needed for further work.

In order to set up the configuration, go to Assets → Documents.


Add new document

You can add a new document at any time on the platform. Below you will find
a description of how to do it.

Screenshot presenting adding documents button in assets module in Synerise

  1. Click on Add document button placed in the right up documents section corner.
  2. Fulfill all required sections: name, slug (url address, description (this one is not obligatory) and field with document version (“1.0.0.” example presented on the screenshot).
  3. Select the type (type must first be defined via API).
  4. Fulfill content JSON field.

Screenshot presenting adding documents view in assets module in Synerise

  1. Submit by clicking save.
Warning: The content you enter must be written in the JSON file format - otherwise you will not be able to upload the document.

Delete existing document

Once you have added the document, you can remove them from the system at any time. Below you will find a description of how to do it.

  1. Search for a document you want to edit using the search box marked with a magnifying glass placed in the right up section corner.
  2. Click on the three dots on the right side of the block view; you’ll see three options: delete, edit document, edit schedule and versions.
  3. Click on delete button.
  4. After clicking delete, a document removing confirmation statement will appear. Submit by clicking OK.

Edit existing document

You can edit existing document at any time on the platform. Below you will find a description of how to do it.

Screenshot presenting documents view in assets module in Synerise

  1. Search for a document you want to edit using the search box marked with a magnifying glass placed in the right up section corner.
  2. Click on the three dots on the right side of the block view; you’ll see three options: delete, edit document, edit schedule and versions.
  3. Click on edit document button.
  4. After clicking the edit button, the platform will take you to a window identical to one used for creating a new document. Change chosen items and submit by clicking save.

Edit schedule

You can edit the schedule existing document displaying at any time on the platform. Below you will find a description of how to do it.

  1. Search for a document you want to edit using the search box marked with a magnifying glass placed in the right up section corner.
  2. Click on the three dots on the right side of the block view; you’ll see three options: delete, edit document, edit schedule and versions.
  3. Click on edit schedule button.

Screenshot presenting editing documents schedule in assets module in Synerise

  1. Fill in the timezone field, select the period in which the document will start to display and when it will end; select time of period (daily / weekly / monthly) and enter the hours in which it will apply. If it is to apply in several time intervals, use the add time period option and provide additional hours.
  2. Submit by clicking save.

Versions

While working on the platform, you can update versions of created documents. So as not to lose the previous versions;it’s worth updating each time you save them as subsequent versions.

If at the time of work on the platform you want to use the older version again, you will find it in the preview section.

  1. Search for a document you want to edit using the search box marked with a magnifying glass placed in the right up section corner.
  2. Click on the three dots on the right side of the block view; you’ll see three options: delete, edit document, edit schedule and versions.
  3. Click on versions button.

Screenshot presenting documents preview view in assets module in Synerise

  1. If you want the selected version to be the current one, click publish button.

😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.