Medyapin User Manual

Player Applications #

The Medyapin Signage Player is software that runs on a compatible device connected to your physical hardware and supports devices running on Windows, Android, LG webOS, Samsunb Tizen and Linux.

Each Player has its own installation package and guide; please select the appropriate option from the left-hand menu.

Yes No
Last updated on 12 July 2019

Windows Player Installation #

The Medyapin Windows Player is distributed as a windows installer file (MSI) which is a standard “double click” installation.

There are 4 steps to follow:

  1. Preparation – Minimum Requirements and MSI
  2. Installation – Double-click the MSI to start the installation process.
  3. Connect – Connect your Player to the CMS.
  4. Authorise – Authorise your Display with the CMS.

Minimum Requirements

Medyapin is a low resource signage solution, however with the advance of technology it has been necessary to set out some minimum requirements. The installation process will check these for you, but they are listed below for convenience:

  • A network connection to the CMS (possibly over the Internet)
  • Microsoft Windows 7 or later
  • Please note that starting with Windows 10 it is advisable to use the “professional” variant of the operating system. The “home” version no longer has the ability to fully control the schedule of automatic updates which may cause messages to interrupt your signage playback.
  • .NET Framework v4.5
  • Internet Explorer 11+ or higher
  • Flash Player Version 9 or later (if Flash support required)
  • Windows Media Player 11 or later
  • For PowerPoint support, Microsoft PowerPoint 2003 or later. PowerPoint viewer is not suitable.

Installation

Download Medyapin for Windows and double click on the Medyapin msi file.

The installer will take you through a number of screens, which are outlined below.

Please note: You may see a security warning or a message asking if you allow an app from an unknown publisher to make changes, during the installation stage. Please accept by clicking on “Run” or “Yes” to continue with the installation.

Step 1

The installer presents a welcome screen, please press “Next”.

Step 2

Read the End-User License Agreement and accept these terms to click “Next”.

Step 3

Choose the location where Medyapin should be installed. The default location should normally be sufficient, however, to change the location click browse. After making the selection (or if left to the default) click “Next” to continue.

Step 4

A confirmation message is then shown. If happy with the selections made click “Install” to begin, otherwise click “Back” to correct any errors.

The Setup Wizard will start to install the Medyapin Player, which may take several minutes.

Step 5

The Installation is now complete, click Finish to exit the Setup Wizard.


With both tick boxes ticked the Read me text will open followed by the Player Options window.

Connect to the CMS

Newly installed Players must be configured and registered with the Medyapin CMS before they can be used using Player Options.

This window can be accessed from each Player from the Start Menu, All programs.

Player Options

Most of the Player options are set on the CMS and delivered over the network to the Player. This keeps the Player configuration to a minimum on each new installation.

Before any options can be sent from the CMS it is necessary to register the Display with the CMS instance. This can be done by completing the necessary fields using the Connect tab as pictured below:

CMS Address This is the fully qualified address of Medyapin Cloud CMS. It must be https://medyapin.cloud for cloud users.

Note: Enterprise users please contact with your media manager for your enterprise CMS Address and Key.

Key will be “cloud” for cloud CMS users.

Local Library The location for the Player to store its local files. Files are downloaded from the CMS so that the Player will still function if it loses connection with the CMS.

Once all of the above fields have been filled in the Save button should be pressed. At this point, the message window will update with the status “Saving with CMS… Please Wait…”

Assuming there are no errors with the communication between the CMS and the Player, the Display will be registered and awaiting approval.

Player Options – Advanced tab

There are a few other settings that can only be set on the Player side, as explained below:

The Player needs to have access to the CMS during the registration process and also to get new content. If the Player is behind a proxy server, the details of that server can be entered using the fields below.

Proxy settings:

Username The username used to authenticate with the Proxy Server.

Password The password used to authenticate with the Proxy Server.

Domain The domain used to authenticate with the Proxy Server.

Other settings:

Display ID The unique ID for this Display. An automatically generated unique ID will be assigned at installation but can be modified if appropriate.

Splash Screen Optionally override the Splash Screen with an image stored locally on the Player PC.

Display Authorisation

So that the Player will function correctly you will need to get in touch with your media manager and provide your device MAC Address for Authorisation.

Display Setting Profiles

Once registered, the Player will be given a default Display Setting Profile. For further information see the Display Settings section.

Launch Medyapin Player

You can now “Launch Player” from the Player Options window or go to all programs and click on Medyapin DSP. It should display the Medyapin Splash Screen while the Default Layout and its media contents (and anything else you have Scheduled) are downloaded. The Player will then begin playing Layout contents.

Windows Modifications

Here are some suggested settings for Windows/ PowerPoint for a Windows Display:

  • Turn off all screensavers.
  • Turn off screen power saving.
  • Load the “No Sounds” Sound Scheme (Control Panel -> Sounds and Audio Devices Properties)
  • Set a plain wallpaper (Hopefully nobody will see it, but you might need to reboot the Player, or restart Medyapin and a sane wallpaper is a help).
  • If the Player is accessible from where you manage your Displays from, you might want to install UltraVNC server so you can connect in and check on the Player from time to time. Use the “View only” option in the VNC client to avoid disturbing the Display.
  • Set Windows to log on as your Medyapin Player automatically.
  • Disable balloon tips in the notification area.

HTML5

Medyapin uses the Web Browser provided by Windows to display web content, tickers, text, etc. This browser component defaults to Internet Explorer 9 on most systems. Please update your Internet Explorer to latest version.

PowerPoint

Displays that will show PowerPoint should follow the Prepare your Windows Players section of the PowerPoint manual page to confirm that the registry has been modified correctly for their version of Windows / PowerPoint.

Thumbnail Database

Windows automatically creates thumbnails for content in the User folder and will try to do so for the Medyapin local Library.

In some cases, this interferes with the normal operation of the Player and should be disabled. This can be achieved with the following registry settings.

[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\Explorer]
"NoThumbnailCache"=dword:00000001
"DisableThumbnailCache"=dword:00000001

[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\Advanced]
"DisableThumbnailCache"=dword:00000001
"NoThumbnailCache"=dword:00000001

Please ensure you know what you are doing and have appropriate backups in place before modifying the registry

Multiple Players

It is possible to run more than one of the Players on Windows. Please see the Windows Player Multi Install page for further details.

Screen Saver

It is possible to run Medyapin as a Screen Saver. Please see the Windows Screen saver page for further details.

Watchdog

The Watchdog is a system tray application which can be used to monitor the stability of the main application and restart it where necessary.

Yes No
Last updated on 12 July 2019

Windows Player Multi Install #

Multiple instances of the Windows Player can be configured to run together on a single PC. This might be desirable if you have 1 PC that drives multiple screens which are not in an extended desktop configuration.

Before choosing this route you should consider whether or not you want to show content spanning both screens – if you do you must use the extended desktop route (and not run multiple instances).

Running multiple instances of the Player application requires some leg-work in order to get the files in the correct place. Please follow the steps below:

  1. Install 1 copy of the Player normally following the Installation instructions.
  2. Navigate to the Player installation folder
  3. Copy the entire folder and rename to something unique (for example a 2 at the end).
  4. Navigate inside the new folder, rename MedyapinClient.exe to MedyapinClient2.exe
  5. Create a start-up shortcut to the new MedyapinClient2.exe file and right click. In the ‘Target’ field enter o after the " on the default path. (Providing the letter o in the startup arguments indicates that the options form should be opened instead of the main application).
  6. Double click the shortcut and configure the second Player as normal making sure that you choose a different library folder.
  7. Navigate inside the Watchdog subfolder, edit the app.config file, set the ClientLibrary to be the library folder you’ve configured above and set theProcessPath to be the path to the renamed MedyapinClient2.exe.
  8. Before starting the Player, create a display profile in the CMS to position the second Player – see below.
  9. Double click the EXE and the client should start.

Positioning the Player

A Player by default will position itself on the Primary monitor in a full-screen configuration. You will want to change this behaviour for the second Player so that it does not appear underneath the first. This is done using a Display Settings Profile from the CMS.

Open a CMS connection and log in, navigate to the Display Settings page, located under the Displays section of the Menu and create a new Windows Profile called “Second Screen” or similar.

In the new profile configure the Location tab so that your left, top, width and height represent the second screen in your PC configuration. For example, if you have two 1920×1080 panels the second one would be at left=1920, top=0, width=1920, height=1080. You would enter different coordinates if the monitors are not ‘side by side’ or have different resolutions. You should, therefore, adjust the coordinates according to your setup.

Embedded Web server

The Player uses an embedded Web Server to show some content and it will be necessary to adjust the port that this web server listens on so that it does not conflict with the other Player. Use the Display Settings Profile created when you positioned the Player and set the Embedded Web Server address, incrementing the port number on the one that is already there.

Yes No
Last updated on 12 July 2019

Windows Player Screen Saver #

The Windows Signage Player installs a SCR file in the installation program files that can be used to run Medyapin as a screen saver.

The Screen Saver can be installed by navigating to the Installation folder and right clicking on the SCR file, and selecting “Install”.

This will present a windows screen saver configuration dialogue, as below:

Settings 

The Player options can be configured by clicking Settings in the screensaver dialogue.

Please note: These settings will be independent of the settings configured on any existing Player on the same PC.

Yes No
Last updated on 12 July 2019

Android Player Installation #

Medyapin for Android is released as a standalone “APK” installer file and can be downloaded from our Downloads section. Medyapin for Android is easy to install and configure and can be up and running in just a few minutes.

This guide will take you through each step in detail for the required installation, which includes the following stages:

  • Preparing your device
  • Downloading Medyapin for Android APK
  • Installation of Medyapin for Android APK
  • Connecting to your CMS
  • Authorising your Display

Prepare your device 

Google Play Store

You can search for Medyapin Cloud Digital Signage on google play store. Or download from the link below.

Non-market Sources

If you prefer to download apk file from our website , the device will need to be configured to allow the installation of applications from unknown sources. This setting is found in the “Security” or “Applications” section of the standard Android “Settings tab”.

This setting should be disabled after installation unless auto-update is required (see Rooted Devices below for further information).

Enable the Wireless Adaptor

Medyapin for Android will try to get the MAC Address of your Wireless Adaptor and record it in your CMS, but it can only do that if the Wifi Adaptor is enabled.

The first time you connect the Display you will need to have your Wireless Adaptor enabled. It is best to do this prior to installation so that you don’t have to leave Medyapin for Android during configuration. After your Display is connected to the CMS you can turn the Wireless Adaptor off (unless you are using it of course!).

Date and Time

Confirm that the Date / Time and Timezone information are correctly set on the device. This information is used by Medyapin for Android for time sensitive scheduling as well as for the 14-day trial.

Please note: If this is incorrectly set during installation your 14-day trial of Medyapin for Android may expire sooner than it should.

Download and Install the Medyapin for Android APK 

Please note: Medyapin for Android requires at least a 4.4 based Android device.

Medyapin for Android is released as an APK file which can be opened and installed by the Android OS. You will need to download or transfer the latest Medyapin for Android APK release file onto your device for installation. The easiest way to do this is to select and download the latest release for your device directly from here: Download Medyapin for Android

To download and install to use Medyapin for Android, you must agree to the End User Licence Agreement.

With the above preparation complete you should now have a device which can install non-market applications, with the Wifi Adaptor enabled, the correct Date/Time/Timezone and the latest Medyapin for Android APK file downloaded onto the device.

Install the Medyapin for Android APK 

Open the APK file and click to install. Medyapin for Android may require a number of permissions, which we have tried to keep to a minimum. Please accept any listed permissions and allow the installation to complete. Medyapin for Android will now be available in your app drawer.

Connect to Cloud

Open Medyapin to be taken to a connection wizard to enter the following:

CMS Address https://medyapin.cloud

Key cloud

Connect CMS The following message will be shown for the first successful connection, “Display added and is awaiting licensing approval from an administrator”.

Assuming there are no errors with the communication between the CMS and the Player, the Display will be registered and awaiting approval.

Display Authorisation 

Get in touch with your media manager to activate your screen by providing your device MAC Address.

Display Setting Profiles

Default Profiles have been provided for you. You only need to create a Display Setting Profile if you want to override these defaults.

For more information on available settings, please see Android Player Settings and the Display Settings section of the Manual.

Rooted Devices 

An Android device that has been rooted can take advantage of the auto-update functionality.

Requirements

  • Android 4.4 or higher
  • Root access to the device (with SU or SuperUser installed)

Medyapin for Android does require a number of permissions, which we have tried to keep to a minimum. Please accept the listed permissions and allow the installation to complete. Medyapin for Android will now be available in your app drawer as normal.

Preparing the device

The device should be prepared with root access and a suitable root manager application such as SuperUser. It should also have Medyapin for Android installed and configured. 

Granting Root Access
The Medyapin application should be granted root access to the device, which is done from the Settings menu.

Clicking or pressing on “Check root is available” will open a popup window, as seen below will ask for a confirmation. At this point, Medyapin will need permanent access to root so that no further user interaction will be required during the update process.

If the popup window does not open it means that root access is not configured correctly on the device.

After selecting “allow” a message will appear saying that super user access has been granted and the configuration for auto-update on the Player is complete.

SuperSu
If you are using SuperSu you should ensure that the “Re-authentication” setting is disabled. Failure to disable this setting will mean that the application will lose root access after any upgrade.

Setting an upgrade window

If you want to set a particular time for the player application to upgrade you will need to create a Display Settings Profile in the CMS and assign it to the Display.

For further information regarding Upgrades, please see Upgrading Medyapin for Android.

Yes No
Last updated on 12 July 2019

Medyapin User Manual #

Medyapin is a flexible and powerful application with a core ethos in Digital Signage for all, regardless of skill or technological knowledge.

The software itself center’s on 5 core concepts:

  1. Users
  2. Displays
  3. Layouts
  4. Media
  5. Scheduling

Using these 5 concepts we can sum up what Medyapin can do in a simple sentence;

“Medyapin enables a User to upload Media and arrange it in a Layout which is then Scheduled to one or more authorised Displays”.

Medyapin has many more features to take advantage of which are covered within this User Manual, but to get started let’s take a quick look at the main 5.

Users

Users are the people that have access to the CMS and are identified by a Username and Password to grant access.

Medyapin supports 3 User typesUser Groups as well as multi-level Permissions to all parts and items stored within the CMS.

For a corporate environment Medyapin can also integrate with SAML identity providers such as Active Directory via ADFS.

Displays

Displays represent the hardware connected to the TV/Projector/Tablet that is displaying the Scheduled end content. Each Display is uniquely identified in the CMS so that every Display can have its own content, Layout designs and Schedules set with uniquely identified reporting statistics available.

Layouts

Layouts are the complete design that is seen on the screen. Layouts are made up of Regions which allows you to split the screen/position how you choose, with each Region containing its own Playlist/Timeline to which Media Widgets are assigned. A Layout will remain on screen until all Regions have finished playing their assigned content through once, then an entirely fresh Scheduled Layout can be loaded that has different positioning/sizing of Regions and different Playlists/Timelines.

This flexibility drives the dynamic nature of a Medyapin display screen.

Media

Media content is at the core of the Medyapin solution and has many different types which can be generally split into two categories:

File-based media – uploaded and stored in the Library, for example, image and video files.

Layout based media – does not have an associated file and is configured directly on a Layout; RSS feeds and free Text

Medyapin uses powerful Widgets which allow you to show your content as well as integrating dynamic third-party information from a variety of sources.

Scheduling

Scheduling is highly flexible and supports Schedules to single Displays as well as to Display Groups. Each Display will check for new Scheduled content periodically, and download Scheduled Items in advance of playback. Default Layouts are shown on Displays when nothing else is Scheduled.

Yes No
Last updated on 1 June 2019

Logging In #

The CMS is protected by an authentication system that requires a Username and Password.

During installation a Username and Password is provided which grants unrestricted access to all areas of the CMS, as a Super AdminUser. Once logged in additional User accounts can be created with various permissions, as covered in the Users section of this manual.

All pages in the CMS are authenticated and if the User is not logged a login form will appear.

First time access

Administrators (Super Admin Users)

After installation the Username and Password provided during installation must be used to access the CMS.

Users

Users can be created by Administrators and given access to the system. The Username and Password for any new User should be shared in a private and secure manner and the User should change their password after they have logged in for the first time.

Forgotten Password reset

You can reset your password over login form.

Cookies

The CMS uses cookies to track whether Users are logged in or not. If you are experiencing trouble logging in you may need to adjust your browser settings for cookies.

After login

Each User is assigned a Dashboard which they will be taken to after login.

Yes No
Last updated on 1 June 2019

Dashboard #

The assigned Dashboard will be the first screen that Users will see after login.

Status Dashboard

The Status Dashboard is the default Dashboard for Super Admin Users and is intended as a high-level view of the system for Administrators. It provides information relating to Library and Bandwidth usage, Display Activity and Latest news.

 

Yes No
Last updated on 2 June 2019

Grids #

The CMS presents many of the entities (LayoutsMediaCampaigns) as tabular data called Grids. Each grid has a number of elements that combine to create a flexible administration tool that is easy to read and understand.

The following diagram is the Layout grid annotated with each of its elements.

Action Buttons

Action buttons located at the top right of the page allow for common actions such as Add Layout.

Filter Form

Most grids have a filter form which is used to restrict the results in some way – for example all Layouts belonging to a particular owner or by Tag.

Results

Once the CMS has searched for the criteria included in the filter fields, results will be shown in the grid data table. Use the Column visibility button to select/de-select which columns should be presented in the data table.

Sortable Columns

Most columns can be sorted by default. Where the column has an up or down arrow the Shift key can be used to multi-sort the column.

Row Menu

Each row may also have an action menu for things that can be done to that specific row. This menu can be accessed by clicking the down arrow in the right-most column of each row.

Multi-select

Some grids include the ability to multi-select rows and perform bulk actions. These are actions that can be run on all of the selected rows at the same time. Click on rows to select and use the With Selected drop-down button, located at the bottom of the grid, to access the bulk action menu for your selected rows.

Paging

If available a paging control will be shown that allows the User to switch between multiple pages of results.

Yes No
Last updated on 2 June 2019

Forms #

The CMS presents most transactions (actions that add/edit or delete in some way) using Forms.

The forms have been designed to be consistent across the application and provide as much information as possible.

A typical form looks like the Add Layout form below.

Tabs

Forms can have 1 or multiple tabs. Access by clicking on the tab header, some may cause the form to expand to better fit the content inside them.

Form Fields

Each field has a title that explains what the field represents. Each field will also have a grey explanation entry above or below it.

Buttons

Every form has a button bar at the bottom for the User to commit or cancel the additions/edits they have made.

Most forms also include a “Help” link to sections of the Manual for additional guidance.

Yes No
Last updated on 2 June 2019

Users #

Medyapin allows individual access to the CMS by multiple people with a Username and Password authentication system.

Users are granted access within the CMS by their User Type and Permission settings, all pre-configured by an Administrator.

User Groups

Users can be assigned to one or multiple User Groups who inherit the permissions granted to that particular group, pre-configured by an Administrator.

Ownership

All items created in the CMS by an individual User are owned by that User. Ownership of an item (be it a Layout, Media File, or Scheduled Event) gives that User full permissions including the ability to share with other Users.

 

Yes No
Last updated on 1 June 2019

User Administration  #

Users are administered in the CMS by clicking on Users under the Administration section on the menu. The Users grid will open for you to manage and add Users.

Adding Users

Click on the Add User button and complete the form fields as required.

Details

Username – create a Username for the User, to be used for login and identifying the User.

Password – create a Password for the User, to be used for login.

Email – include an email address for the User (used for password reset / CMS notifications).

Homepage – select the first page or choice of Dashboard the User will see after login.

User Type – use the drop down to select from the three User Types available.

Library Quota – assign a quota to determine the maximum amount of content allowed to be uploaded to the Library.

Initial User Group – select which group the User should belong to.

Use System Notifications as the Initial User Group for Users that do not require permission to anything within the CMS but need notification emails when there are system issues (System Administrators).

Reference

Optionally complete information to be used as a reference to view and organise your Users.

Notifications

Choose if the User should receive Notifications by ticking the checkboxes.

Options

Select the options as necessary for the User.

Medyapin doesn’t place any limits on the number of Users that can be added.

Editing Users

Use the row menu for the User record you wish to make changes to and select Edit.

An Edit User form will open so that changes can be made as needed.

Deleting Users

Delete a User in the same way by using the row menu for the selected User. A confirmation form will open up and give you further options regarding the items currently owned by that User.

Deleting a User is irreversible and will remove all their owned items including; Media, Layouts and Schedules, even if these items are being used by other Users in the system. Reassign items to another User using the selector to make them the new owner of all the items currently owned by the User you wish to delete. Alternatively, use the Retired checkbox at the bottom of the Edit User form so that the items remain in use in the system with the User unable to log in.

My Applications

Medyapin contains an API that allows 3rd party applications to connect and consume its data. Before using an application each User must authorise the application to act on their behalf within the CMS.

Once an application is authorised it can be viewed by clicking on the My Applications button to open a current list.

At the current time the CMS does not provide individual Users with a method of revoking access to an application, however, an admin can remove an application completely.

Yes No
Last updated on 2 June 2019

User Types #

User Types

Every User is assigned 1 of 3 User Types:

  • Super Admin
  • Group Admin
  • User

User Types are pre-configured and cannot be modified.

Super Admin

Super Admin Users have access to every part of the CMS including all Media, Layouts and Schedules added by other Users of the system. Super Admin Users have access to the entire CMS regardless of any permissions set to a User Group that they are assigned to.

During installation, a Super Admin User is created who would, therefore, have full access to the entire CMS. We suggest having at least one Super Admin User to act as the last contact point for the CMS system.

Group Admin

Group Admin Users only have access to the parts of the CMS as assigned to the User Group they belong to. In addition, they will have access to all Media, Layouts and Schedules of all other Users assigned to that User Group as well as their own Media, Layouts and Schedules.

User

A User will only have access to the parts of the CMS as assigned to the User Group they belong to as well as access to their own Media, Layouts and Schedules.

User Type is selected when first adding a User and can be edited from the individual User record.

Yes No
Last updated on 2 June 2019

User Groups #

User Groups are administered from the Menu under the Administration section. Add a new User Group so that a selected group of Users are able to share and edit their Media, Layouts and Schedules with each other.

Make it easier to onboard new Users and manage system access by creating User Groups. Users will inherit permissions that have been assigned to the User Group. Read the Permissions page for further information.

Click on the Add User Group action button to open the Add User Group form and complete the form fields.

  1. Name – give your User Group a unique name for ease of identification.
  2. Library Quota – assign a quota to determine the maximum amount of content allowed to be uploaded to the Library for the group. Please speak to your administrator for further information.
  3. Tick checkboxes for Notifications as necessary for the User Group.
  4. Save.

Group Members

Assign and manage Users by using the row menu for the selected group and click on Members.

Use the checkboxes to assign Users to that User Group, Save.

Users can be assigned to one or more User Groups for ease of sharing and collaboration as well as being used for Access control to parts of the CMS.

Users will inherit permissions that have been assigned to the User Group. Read the Permissions page for further information

Yes No
Last updated on 2 June 2019

Permissions  #

Permissions can be assigned to both User and User Groups to allow or restrict access to System and User Objects within the CMS.

Permissions are presented as two concepts:

  1. System Objects (restrict or allow access to view pages)
  2. User Objects (view, edit, delete options for Media, Layouts, Display Schedules)

These concepts used in conjunction with each other, ensure that only relevant parts of the CMS are visible with assigned permissions with regards to the ability to viewedit or delete associated objects for that particular User/User Group.

System Objects

Assign permissions to ensure that only the relevant sections of the CMS are visible. Apply against any User or User Group, located under the Administration section of the menu, click on Page Security from the row menu for your selected User/User Group.

Access Control List

Use this form to select what areas of the CMS are to be visible for that User/User Group as appropriate.

Please note: In order to set further permissions with regards to User Objects the User/User Group would need to have access to viewthe Page/Menu item in the first instance.

Make it easier to onboard new Users by managing system access via User Groups. If you need to give more permissions to specific Users within User Groups, assign these directly on their individual User record.

User Objects

Assign vieweditdelete permissions on the object itself. The following objects have assignable permissions:

  • Campaigns
  • Layouts
  • Regions in Layouts
  • Widgets (Media on a Region’s Playlist)
  • Templates
  • Library Media
  • DataSets
  • Displays and associated Schedules
  • Display Groups and associated Schedules
  • Dayparts

Select the object and use the row menu to select Permissions:

Use this form to assign Permissions to both Users and User Groups.

The logged in User will only see a list of Users in their own User Group. Super Admin will see all Users.

Optionally use the checkbox to cascade permissions to items contained underneath. For example, as permissions are being assigned to a Layout if this box was checked then all Regions, Playlists and Widgets within the selected Layout would have the same assigned permissions.

Modifications made to items are available in ‘real time’ this means the next time a User interacts with the object the newly set permissions are applied.

Scenario:

All members of a User Group need to edit DataSet(s) data with only one specific User able to delete.

Permission actions to take:

  1. System Objects – ensure that DataSets have been set to view for the User Group
  2. User Objects – select the DataSet(s) and assign view and edit permissions for the Group.
  3. User Objects – select the DataSet(s) and delete permissions for that specific User. (View and edit permissions are already in place as Group permissions so do not need to be ticked).

The highest permission is always used for Users (if a User belongs to 2 groups with one having edit permissions and the other does not, the User will have edit permissions)

Permissions on an item can be changed by the owner, Group Admin or a Super Administrator.

Permissions for Display and Display Groups, that have no owner, can only be changed by Super Admins.

Yes No
Last updated on 4 June 2019

Notifications  #

Medyapin has a Notification System to keep Administrators and Users of the CMS informed of important system events and other user-created notifications.

Notification Drawer

Notifications for a logged in User appear at the top right of the screen with unread notifications shown in red next to the Alarm bell icon. The Notification Drawer can be accessed by clicking on the Alarm bell icon.

The Notification Drawer is shown when a User or User Group has the Notification Drawer permission, without this permission the Alarm bell icon will not be shown.

Click on the Alarm bell to open the Notification Drawer, which will show the last 5 notifications received. Unread notifications will be shown in black text and read notifications in a light grey text.

Click on the title of each notification to open a popup to read the full notification.

Notifications will only show in the Notification Drawer if their release date has passed and if the logged in User has been assigned the notification.

Notification Centre

Notifications can be created by authorised Users, those that have permission, by using the Notification Centre link at the bottom of the Notification Drawer and clicking on the Add Notification action button.

General

Subject – title for your Notification

Release Date – use the date and time picker to select when you want your Notification to be sent.

Email – choose to send to the email address recorded in the CMS against the User record.

Interrupt – Users would be automatically redirected to a page to show the full Notification and would need to click on Continue to carry on navigating the CMS.

Ensure that Enable Email Alerts has been set to On in Settings, Maintenance tab.

Message

Use the text editor to create and format the message body of your Notification.

If you are going to use the Notification Widget to target your message to Display/Display groups the formatting you use here would be replaced with the formatting as applied in the Widget.

Audience

Users – Select one or more Users/User Groups

Displays – Select one or more Display/Display Groups to show the notification within Scheduled Layouts. (Scheduled Layouts must already include the Notification Widget to target Displays successfully).

Editing Notifications

Edits to a Notification will be altered in the CMS web portal but any emails generated which have already been sent will not be recalled.

System Notifications

Medyapin raises various System Notifications to report on the health of the system as a whole. Notifications are emailed to the Admin email address configured in Settings, Maintenance tab. Notifications will also be sent to Users who belong to groups configured to receive System Notifications or who have been configured to receive these notifications themselves. This configuration is managed on the User/User Group Edit form.

Yes No
Last updated on 4 June 2019

Displays  #

The primary purpose of Medyapin is to show content on screens with the entire application suite existing for that one purpose. Medyapin provides a concept called Displays to manage when and how content is shown on a screen.

When no other content is Scheduled, Displays will always show a Default Layout. You can create your own Default Layout to replace the existing one to show.

Displays are uniquely identified by a hardware key which is generated when the Signage Player software is installed. This hardware key is used to create a Display record in the CMS and is unique to that one Display record.

Connecting a Display

Displays connect to the CMS over an API called “XMDS” . Each Signage Player software application will have its own method of registering and connecting to the CMS – most of them only require the URL and CMS Key.

New Displays will need to be marked as authorised before they can be sent any content. This can be done by using the row menu for the Display and clicking Authorise.

Display Administration

Displays are administered from the Menu, with logged in Users able to view the status of Displays that they have been assigned permission for.

ID

Used for internal identification of the display.

Display

Name given to the Display for easy identification purposes (this is not shown on the Display itself).

Status

Tick = Player is up to date (this may also show as green in colour).

Cloud icon = Player has not logged in with content waiting to be downloaded (this may also show as amber in colour, as displayed in the example image above).

Cross = Player is currently downloading new content and has yet to complete (this may also show as red in colour).

Authorised

Tick or cross to indicate whether the Display has been granted a licence with the CMS. This prevents unauthorised Displays being added to the CMS.

Logged In

Tick or cross to show if the Display has logged in recently.

Last Accessed

Date and time stamp of when the Display was last accessed.

MAC Address

Media Access Control Address of the Display (if the client software is capable of sending it).

Columns can be toggled on and off to show the information you would like to display for administration purposes by clicking on the Column visibility button.

Row Menu

Each Display has a row menu containing a number of actions that can be performed against them such as;

Manage

Each Display has its own Dashboard which shows the Displays current status, bandwidth usage, file status and errors.

This Dashboard is useful as a first step for troubleshooting issues with a Display.

Edit

Configure options specific to that Display with the ‘Advanced’ tab, which lists the general settings applied from the selected Settings Profile.

Delete

Deleting a Display will remove it from the CMS entirely – this operation cannot be reversed. A deleted Display can be reconnected to the CMS by repeating the “Register” procedure which will create a new unique Display record.

Deauthorise a Display instead of deleting so that it can be re-authorised at a later date if needed. Use the row menu for the Display and click on Authorise to toggle to Deauthorise. This can also be actioned from the Edit Display form by selecting No for Authorise display.

Send Command

The Send Command functionality is executed via XMR to Players by selecting a predefined command. This is useful for sending Players ‘Reboot’ commands for example.

Administrators create predefined commands for use, therefore if you require additional commands, please contact your Administrator.

This type of Command can also be executed by scheduling a Command Event

Yes No
Last updated on 4 June 2019

Display Settings #

Display Clients are configured automatically from the CMS once they are connected, this is managed using Display Profiles.

Display Profiles

Each Display has a default Display Profile which can be customised by an Administrator to suit required preferences or new Display Profiles can be created and assigned directly to a Display.

Available profiles

A list of available profiles can be viewed from Display Settings under the Display section on the menu.

Each profile has a NameType and a flag indicating if it is the default or not. Default profiles are automatically assigned to Displays of the corresponding type.

Editing Profiles

Use the row menu for the Profile you wish to view and click on Edit. Use the Edit Profile form to adjust available settings:

Each setting is explained under each form field for each of the tabs.

Using the row menu click on Copy to make another version of a Profile. Make adjustments as needed to quickly and simply create new Profiles.

Collect Interval

Using the drop-down menu select how often you would like the Player to check for new content. This means that once a Player has communicated with the CMS, it will check again for any changes by the time set here.

Scenario:

A Player has a collect interval set for 24 hours, it will check for any changes, action pending changes and then wait for the next 24-hour collection. If a change is made between this period of time, the Player will not be aware of it until it is time to check again.

If a Display Profile for a Player is changed, the Player will only be aware of the change after it has connected according to its prior connection interval.

Scenario:

A Player with a collect interval set for 24 hours made a check at 12 pm, it will not check again until 12 pm the following day for any changes that have been made. Once the 24 hour interval has passed, it will update the new changes and from this point will collect changes based on the new Profile.

The CMS can be configured to talk to an XMR instance if player actions are required, please contact your Administrator.

Add a Profile

Click on the Add Profile button, and include a name and select Client type, Save.

The Edit Profile form will open so that you can complete the necessary form fields for this Profile.

Deleting Profiles

Display profiles can be deleted by using the row menu options for a selected Profile.

Please ensure that there is one default remaining for each Type.

Setting on the Display

A default profile will automatically apply to all Displays of the same Type. A Display can be overridden with a Profile other than default by selecting the required Profile on the Display Edit form and using the Advanced tab.

Yes No
Last updated on 4 June 2019

Display Groups  #

For ease of Scheduling and Media Assignment create Display Groups and assign Displays to one or multiple Display Groups.

Display Groups are administered in the CMS by clicking on Display Settings under the Displays section on the Menu. The Display Group grid will open to Add and manage Display Groups.

Add/Edit

Click on the Add Display Group button to create a new Display Group or use the row menu to Edit an existing Display Group.

Members

The membership of a Display Group is either a Manual Assignment or controlled by filter criteria using Dynamic Groups.

Dynamic Groups

When ticked an additional field will appear to allow for entry of one or more regular expressions to use to select which Displays belong to that Display Group.

Filter criteria for Dynamic Groups is in the format of regular expressions, but can also be simple string comparisons. The expressions should be separated by a comma and can be negated with a - prefix.

For example, all Displays containing “a” but not “b” would be a,-b.

Manual Assignment

Use the row menu for the selected Display Group and click on Members. Tick/untick Displays or Nested Groups to add/remove membership from the Display Group.

The form shows Displays and Display Groups for nesting as well as a Relationship Tree making it easier to see the relationships of Displays.

Nested Groups

Display Groups can be nested to create complex structures and allow for targeted Scheduling.

Example Group Structure

  • Site 1
  • Site 1 – Building A
  • Site 1 – Building A – Level 1
  • Site 1 – Building A – Level 2
  • Site 1 – Building B

The Display membership is set on the lowest level Groups and those groups then belong to the next level up, which in turn belong to the highest level parent “Site 1”. The CMS will not allow a circular reference to be created – this is an assignment that creates a loop (i.e. Site 1 has Site 1 – Building A, and Site 1 – Building A has Site 1.)

SchedulesMedia and Layout Assignments applied to the Display Group will apply to all its members and will appear for selection when Scheduling.

Yes No
Last updated on 4 June 2019

File / Layout Assignments  #

Library files and Layouts can be assigned directly to a Display or Display Group so that they are always available in the local library of the Player.

This does NOT mean that assigned files and Layouts will be shown, and will still need to be Scheduled

This is useful for pre-loading a Layout ahead of time when that Layout will be used for some API integration, triggering a Layout change for example.

Assign Files / Layouts

Directly assign by using the row menu for the selected Display or Display Group.

Select which Library files/Layouts you wish to directly assign (these will show in the staging area as files are selected) and Save.

Those selected will be downloaded to the Display at the next collection interval. If XMR is installed these will be downloaded immediately.

Library files and Layouts that have been directly assigned will still need to be Scheduled to Displays or Display groups to be shown.

Files /Layouts can be removed by following the same steps as above and deselecting the items from the staging area. These will be ‘cleaned up’ when the Player needs space or after 30 days of that file/Layout no-longer being required.

Yes No
Last updated on 4 June 2019

Reporting #

Medyapin provides useful metrics for Users, who have the relevant permissions, to view within the CMS. These are designed to provide a centralised area for analysis into Display performance and usage and are available from the Reporting section on the menu.

Display Statistics

The CMS records the bandwidth used by each Display when connecting to XMDS for content and when reporting back Display information.

The default view for the bandwidth chart is a total per Display.

Filter to one Display to see each call that the Player makes to XMDS in isolation.

Filtering to just one Display helps to better understand where bandwidth was used.

Availability

The CMS records all Displays on/offline events to provide further information regarding a Displays availability.

Proof of Play

Each Display collects information on Layout and Media items they show and can provide a Proof of Play report by:

  • Layout
  • Media
  • Media on Layout

Enable stats reporting can be toggled on/off by editing Display Profiles.

Library Usage

View Library usage for all Users or filter to have an overview of usage by individual User/User Group.

Yes No
Last updated on 4 June 2019

Layouts #

A Layout is a complete screen design including content and background, which is then scheduled to a Display or multiple displays in a Display Group. A Layout is made up of 1 or more Regions which hold content and contain a timeline of Media to show. Media is assigned to the Layout Timeline using Widgets which provide the actions for the selected Module.

Take a look at the Modules page to see the variety of content available by simply adding a Widget to a Layout.

Medyapin has no limit to the number of Layouts you can have in the system or the number a User can have.

Layouts are administered from the Design section of the menu. Click on Layouts to open the Layouts grid to view all existing Layouts and to create new from the Add Layout button.

Add Layout

Click on the action button to open the Add Layout form to complete the appropriate fields.

When should a User create a new Layout? When should a User add to an existing Layout?Layouts provide vast flexibility in the system, but can also cause confusion. The recommended usage for a layout is to only contain the design and media required for a set of related content that should be scheduled at the same time.

Scenario: You have a video showing a fire safety demonstration and a video showing an advert for an upcoming production – it would be natural to have separate Layouts for these.

Tags

Layouts can be tagged which allows for ordering and makes it easier to find and view a large number of Layouts if grouped by a certain Tag. This is particularly useful with a growing number of Layouts.

Templates

Create Layouts and save your design to use as a Template, great for maintaining a corporate image or style.

Resolution

Layouts are designed for an intended display resolution and will function best when shown on a Player with a matching resolution. If they are shown on a display that has a different resolution it will dynamically resize which may result in unused screen space.

Sending a Player a Layout that has been designed with a 4:3 resolution which is connected to a 16:9 TV screen would result in two empty bars either side of your content.

If you require an alternative resolution to the available options listed, contact your Administrator

Row menu

Use the row menu for a selected Layout to access more options:

Design

Click to open in a Read Only Mode, which is viewed in the Layout Designer window. Checkout the Layout to enable editing.

Checkout

Checkout from the row menu to put the Layout into a draft mode so that changes can be made later. Once edited, the Layout can be Published to make changes permanent and send the edited Layout to Displays. Discard will revert the Layout back to the original published state.

Take your time with any edits you need to make as using Checkout ensures that no changes are made to your published version or shown on scheduled Displays until you choose to do so. Publish confirms changes that have been made and will overwrite your published version. Discard will delete the draft with the published version remaining untouched.

Preview Layout

The Layout will play from start to finish which allows you to see how your layout will play. Make important adjustments to ensure that layout designs play as intended before scheduling to Displays.

Before the Layout can start all Media must be downloaded to your browser and verified so you may experience a slight delay whilst this is in process.

Schedule Now

To save time, Layouts can be scheduled for a specified amount of time, which can be very useful for important notices / promotions.

Layouts must have a Published status before being scheduled.

Assign to Campaign

Select Layouts to include in created Campaigns.

Edit

Make changes to the naming and Tags used for the Layout as well as making changes to the background image/colour.

Copy

Create copies of designed layouts. Choose to include all contained Media items, to use as a base for creating new layouts to save time.

Retire

Retire a Layout so it does not affect existing Schedules. A retired Layout will be hidden from new Scheduling options but will remain unaffected in existing Schedules and continue to show on Displays.

Delete

Remove a Layout and all its associated media completely from all existing Schedules. Please note: This action is irreversible!

Export

Export the Layout including all associated Widgets/Media/DataSet structures to a ZIP file, so it can be easily shared.

Permissions

Assign Permissions for Users/User Groups to define who should have access to ViewEdit and Delete the Layout.

Did you know….Layouts and Library files can be Assigned directly to a Display or Display Group so that they are always available in the local library of the Player. Useful for pre-loading a Layout ahead of time ready to be scheduled.

Yes No
Last updated on 14 June 2019

Layout Designer  #

The Layout Designer is the heart of content creation in Medyapin. Each time a new Layout is added, or an existing one needs a design change, the Layout Designer is used.

Medyapin makes layout design simple through the use of drag and drop,interactive previewing and design flexibility. On adding a new Layout the Layout Designer will open in Read Only Mode.

All newly created Layouts have a ‘Published‘ status by default. This allows for quick and easy creation to scheduling if creating from a Template or importing a designed layout. Layouts with a valid status can be scheduled straight away!

To enable editing click on the Actions menu located at the bottom right of the toolbar, and click on Checkout. A confirmation form will appear, click on the Checkout button to continue.

Clicking on the ‘Read Only Mode’ pop up at the bottom of the window will also ‘Checkout’.

The Layout Designer will open and confirm that the Layout has been ‘checked out’ ready for editing.

Layout Navigator

This is located in the bottom corner of the Layout Designer window. As shown in the above image, all new Layouts, by default, have one full screen empty Region, represented as a semi-transparent overlay. The Layout Navigator is used to add, position and resize Regions and gives an overview to the overall layout design.

Clicking on a Region in the opened Layout Navigator window, opens the Region Options form which allows for refinement ofPositioning and the application of Transitions.

Layout Timeline

Located next to the Layout Navigator the Layout Timeline displays the duration of individual Widgets as well as complete layout duration which is based on the longest running region on the layout.

A status indicator is shown (cross or tick) to identify valid and invalid Layouts. Invalid layouts will be excluded from the Schedule and will not be played.

A Layout must contain at least one Region and each Region must contain at least one media item for it to be valid and play when scheduled.

Preview

Preview your Layout, Widgets and Regions and make the necessary alterations to designs to ensure that everything plays as intended. Click on the Play icon located in the top left of the Preview window to Preview your Layout. Toggle to full screen size by clicking the icon in the top right hand corner of the Preview window.

Click on a Widget to view media in the Preview window. Use the arrows to cycle through all Widgets that have been assigned to that Region.

Click on the back arrow in the top right hand of the Preview window to return to the Layout Preview.

Editor

Edit aspects of your Layout and assigned Widgets. Click on assigned Widgets from the Layout Timeline window to open the edit options available for that media item.

Use the arrow in the top right hand corner of the Preview window to return to the Layout and Edit Layout form.

Widgets can be edited by clicking on assigned Widgets on the Layout Timeline window to open the options available for that media item.

Toolbox

Located on the bottom left of the toolbar assign actions using Tools, add Widgets and search for Library media items to add to Layouts.

Actions

Located on the bottom right of the toolbar, select from the menu of Actions that can be performed for Published Layouts.

  • Checkout – enable editing by putting the published Layout into a draft status.
  • Schedule Now – schedule published Layouts onto one or more Displays directly from the Layout Designer.
  • Save Template – save your published designs by creating a Template for reuse. Saving a template will store an exact copy of the Layout, including Regions, Playlists and media.

    Invalid Layouts cannot be published.

Layouts that have been ‘checked out’ and are in a draft status have action buttons to PublishUndoand Delete, located on the bottom right of the toolbar.

Layout Selector

The Layout selector provides easy navigation between all Layouts the logged in User has permission to edit without having to leave the Layout Designer screen.

The toolbar has a memory so that when you next open Medyapin you can pick up exactly where you left off.

Yes No
Last updated on 4 June 2019

Regions  #

Regions define areas on a Layout which hold Widgets (media content) to form sets of timed content.

A new Layout will contain one full size empty Region by default ready for resizing, positioning and adding media content to.

Ensure that the Layout has been ‘checked out’ to enable editing.

Click on the ‘edit’ icon located in the top right hand corner of the Layout Navigator window to open.

Regions can be positioned anywhere inside the Layout canvas using drag and drop, and resized by using the resize handle located in the lower right-hand corner of the Region.

Click in the Region to resize and position, further actions are available via the tabs on the Region Options form.

Region Options

General

Complete a name for the Region and use the checkbox to Loop the content if required.

Positioning

This tab allows for precise sizing and positioning. Make the Region full screen by clicking on the text which will display the dimensions the Region will be set by.

Transition

Exit Transitions happen when the last media item in a Region is shown and occurs only when all other media items have expired in the other Regions.

Transitions are only supported in the Linux, Android and webOS Players and need to be pre configured. Please contact your Administrator.

Once you have Saved your edits click Close to return to the Layout Designer screen.

Adding Regions

Regions can be added in two ways:

  • open the Layout Navigator window and click on the Add Region button.
  • select Tools on the bottom toolbar and click on Region to add or drag to the Layout Navigator window.

Deleting Regions

Remove Regions and all associated content by clicking on the Delete Region button in the Layout Navigator window. Please note: This action cannot be undone.

Regions can be deleted from the Layout Designer by clicking on the Region and clicking the bin icon on the bottom toolbar or by right clicking on the target Region and using the bin icon.

Permissions for a Region

Control which User and User Groups can view/edit/delete the Region. Click on the Permissions button, located under Tools on the toolbar then click or drag to the target Region. Edit the Permissions form as appropriate.

Assign/Edit permissions by right clicking on the target Region.

Please note: The owner of the Layout has full control over sharing.

A globally shared Layout can have Region access rights defined for any other users of the CMS. Read more for Permissions for User Objects

Please note: The Windows Player does not support overlapping Regions. For a mixed Player network ensure Regions do not overlap for the best results.

Yes No
Last updated on 4 June 2019

Layout Timeline #

Each Region on a Layout has its own Playlist of content, which is shown in a specified order by the Player.

A Playlist can consist of a single item (such as a company logo), or multiple items (such as an image slideshow).

A Region’s Playlist is viewed/edited in the Layout Timeline window. Use the buttons to zoom through the timeline to see the full Playlist of content.

The Layout Timeline shows the duration of Widgets as well as the total duration of the Layout.

The timeline will show how each Regions assigned Widgets will play out. The greyed out entries indicate what will play when that items own duration is exceeded.

The above timeline tells us the following:

Text determines the duration of the Layout, as the longest running Region with a 60 second duration.

Clock has a set duration of 10 seconds but will remain on screen for 60 seconds (until the Text Widget has fully played out)

Image (1) will play for 10 seconds then Image (2) will play for 10 seconds, this will repeat twice more to remain on screen for 60 seconds (until the Text Widget has fully played out)

The Layout status indicator shows if a Layout is valid and will play when scheduled (green tick) Invalid Layouts (red cross) will be excluded from the Schedule and will not be played.

A Layout must contain at least one Region and each Region must contain at least one media item for it to be valid and play when scheduled.

Assigning Content

Media items that are assigned to Playlists are called Widgets which can be files stored in the Library as well as enabled Modules.

Use the toolbar on the Layout Designer to add Widgets or use the Library Search to add content that has already been uploaded to the Library.

Widgets that are available can be enabled/disabled by an Administrator in the Modules section of the CMS.

Deleting Widgets

Widgets can be deleted by clicking on the Widget to be removed and clicking on the red bin icon, on the bottom right of the toolbar.

Widget Actions

Each Widget assigned to the timeline has its own set of Actions. Access by right clicking on a Widgets from the Layout Timeline.

Use the arrows to move Widgets along the timeline to reorder the sequence.

Widgets can also be dragged along the timeline to reorder.

For further information regarding the available Actions, please see the Tools manual page.

Yes No
Last updated on 14 June 2019

Tools #

Located on the bottom toolbar on the Layout Designer, the Tools tab contains actions that can be applied to the components of Layouts.

Region

Regions can be simply added to Layouts by clicking on the Region button or drag and drop to the Layout Navigator.

Audio

Upload Audio files to the Library which can then be selected to attach to Widgets. Click on the Audio button and click to add or drag and drop to the target Widget on the Layout Timeline.

Use the drop-down menu to select an audio file from the Library.

When assigning audio to a Widget you can enter Volume as well as a Loop parameter to determine whether the audio will loop for the duration of the existing Widget or just play through once. The audio will be stopped when its parent Widget finishes playing.

Once audio has been assigned to a Widget, a speaker icon will be visible for the media item in the Region Timeline.

Click on the speaker icon to edit the assigned audio.

Expiry Dates

Click on the Expiry Dates button and click to add or drag and drop to a Widget to enter Start and End dates and times.

Widgets that have Expiry Dates assigned can be identified by the clock icon shown in the corner of the media item on the Layout Timeline.

Click on this icon to make edits to expiry dates/times as necessary.

Once the End date has passed the Widget will be removed from the Region. Expired Widgets will remain visible in the Layout Designer so that Start and End times can be re-adjusted if needed.

It is important to note that the Layout will be marked invalid and not sent to Players if a Region is empty due to Widget expiry. It should also be noted that if at the time of download there was a valid Layout but the Player has since gone offline, the Layout will show with an empty Region.

Transitions

Transitions are supported for Android/webOS and Tizen Players.

Fade/Fly In

Select a transition and duration to be applied when the media item starts.

Fade/Fly Out

Select the finish transition and duration to be applied to the media item when further Widget’s are set to follow in the Layout Timeline.

If there are no more Widgets to follow or the Layout is in the process of being removed then the Exit Transition will apply as configured in Region Options.

Permissions

Set view, edit and delete permissions for Widgets and Regions by clicking to add or drag and drop.

Please see the manual page for Permissions for further information.

Yes No
Last updated on 4 June 2019

Widgets #

Media is assigned to Layouts using Widgets, which provide the actions for the selected Module.

Widgets are available from the toolbar at the bottom of the Layout Designer to add to Regions. Use the arrows to scroll through all the the available Widgets.

Widgets that are available can be disabled/enabled by an Administrator in the Modules section of the CMS.

Adding to Regions

Clicking on a Widget will give you the option to click to Add

or Drag and Drop

Add the Widget by clicking directly on or dragging to a target Region.

Once added the Widget will be added to the Layout Timeline and can be configured using the available edit options in the Editor.

To make edits at anytime simply click on the Widget on the Layout Timeline to open the available options form for that Widget.

Toggle Widgets to off when you have finished adding to Regions using the slider to the left of the Tools tab for a ‘clearer’ work space.

Deleting from Regions

To delete, click on the Widget assigned in the Layout Timeline and click on the red bin icon in the bottom right hand corner of the screen.

Right-click on the Widget on the Layout Timeline to also delete. Attached AudioExpiry DatesTransition InTransition Out and Permissions can also be edited in this way.

Yes No
Last updated on 10 June 2019

Templates  #

Templates are saved copies of Layouts which can then be used to create new Layouts. Using a template can speed up the design process as well as maintaining a corporate image/standard.

Saving a Layout as a Template

Published Layouts can be saved as templates in the Layout Designer by using the Actions menu on the bottom of the toolbar and selecting Save Template.

Layouts can also be saved as templates by using the row menu for a Layout in the Layouts grid.

Complete the form fields and select whether to include assigned Widgets to the template and save.

Once saved, templates can be selected by users (with appropriate Permissions) when creating a new Layout.

All saved Templates are managed from the CMS menu located under the Design section. Click on Templates and use the row menu for the selected template.

Import / Exports

For ease of use across users, templates can be exported and imported so that they can be easily shared.

Yes No
Last updated on 10 June 2019

Overlay Layouts  #

Schedule as an Overlay Layout to tell Medyapin to display the Layout on top of normally Scheduled Layouts. Overlays remain on top while your normal Scheduled content changes underneath, particularly useful for logos, important information or emergency notices.

Create an Overlay Layout

Overlay Layouts are created in exactly the same way as all other Layouts. Add Regions to fit around your existing content so that your Overlay Layout can “sit on top” of other Layouts that are Scheduled at the same time as the Overlay. Your Overlay Layout will display its all important content whilst the Layouts “underneath” playout in rotation.

Medyapin will not render the background on an Android or webOS Players when a Layout is scheduled as an Overlay Layout.

With the Windows Player, you will need to match the background so its the same colour/image as the Layout you are overlaying.

Scheduling

Overlay Layouts are selected as an Event type when Scheduling an Event and will behave differently to standard Layouts when Scheduled as an Overlay:

Refreshing Content

When an Overlay Layout is scheduled it will render the Media content once and will not show refreshed content.

A workaround to this would be to add a second Media Item to the Overlay Layout so that it loads item 2 and then reloads item 1 (with now refreshed content). This is particularly useful when creating an Overlay Layout which includes the Calendar or Ticker Widgets for example.

Scheduling multiple Overlays

Overlay Layouts do not appear one after the other in Scheduling but instead will stack.

Scenario: 2 Media items are required to ‘Overlay’ other Scheduled Events in the same area of the screen. Rather than creating 2 Overlay Layouts with the assigned Media, only 1 Overlay Layout should be created which would then contain the 2 Media items within the Region.

Yes No
Last updated on 10 June 2019

Campaigns  #

Layouts can be grouped together into an ordered list. A Campaign can then be Scheduled and the Display will play the grouped Layouts in sequence.

Campaigns are administered from the Design section of the Menu.

Create a Campaign

Click on the Add Campaign button and give the Campaign a name and optional Tag’s. The Campaign will be listed in the Campaigns grid ready for Layouts to be assigned.

Assigning Layouts

Use the row menu for the selected Campaign and click on Layouts.

Layouts are assigned using the plus icon, once pressed Layouts will show in the staging area. Layouts can be removed from here by using the minus icon.

Re-order Layouts in the staging area by drag and drop to ensure that Layouts play out in your designed sequence, ensuring that you press Save to keep changes.

Layouts can be directly assigned to Campaigns using the row menu on the Layouts grid. Layouts will be assigned to the end of the selected Campaign by default.

Yes No
Last updated on 10 June 2019

Media  #

Medyapin supports a wide variety of Media which can be categorised into 2 different types:

  1. Library Media
  2. Layout Media

Library Media

Library Media is file-based Media that is uploaded and stored in the CMS Library for use on one or multiple Layouts.

Examples of Library Media are:

  • Images
  • Videos
  • Fonts

Library Media is administered from Media under the Library section of the Menu.

DataSets are a special type of Library Media which are used to represent tabular data.

Layout Media

Layout Media is created and stored directly on a Layout. This Media cannot be reused and exists on only 1 Playlist specific to a particular Layout.

Examples of Layout Media are:

  • Text
  • Ticker
  • Embedded Content

Please be aware: Medyapin takes no measures to control what content is put on your Displays. It is your responsibility to ensure that your content is appropriate material for your desired audience. Content must be appropriately attributed if you do not own the rights to it.

Yes No
Last updated on 10 June 2019

Library  #

The CMS Library stores all file-based media that is uploaded for use onto Layouts.

Uploading Media

Library media can be uploaded directly to the Library using an easy to use file upload tool.

Navigate to Media under the Library section of the menu to open the Library grid. Click on the Add Media button.

Media can also be uploaded directly to a Widget assigned in a Layout, which will also save to the Library by default.

Uploading is achieved in two steps.

  1. Click Add files and select the file(s) you wish to upload.
  2. Click Start upload to begin the transfer of all files, alternatively click on the blue upload button next to individual files to upload individually. Once successfully uploaded, click Done.

Files can also be added via drag and drop.

All media items that have been uploaded to the Library are available to include in Layouts by simply using the Library Search tab on the Layout Designer tool bar.

Adding New Fonts

Medyapin comes with a set of standard fonts provided by our text editor tool – CKEditor. New fonts can be added and uploaded to the Library in the same way. Once added the font will be available to use in the text editor.

If the new font does not show in the text editor after upload, try clearing the browser cache.

Please note: Fonts have preferences built into then known as OS/2 tags. Medyapin checks for OS/2 preferences and can use fonts with OS/2 tags 0 or 8. Fonts with other OS/2 tags may produce an error on uploading and may not display correctly.

Row Menu

Each media file has a row menu with a list of actions that can be performed against it.

Edit

The Edit Media form allows you to edit the name and duration of the file as well as options to Retire and Update edits to layouts that contain the current media file.

It may be necessary to upload a new revision of an existing file. This can be done by using the Replace button at the bottom of the form.

Upload a replacement file using the same steps as before and select whether the replacement file should be updated to all Layouts it is currently assigned to and the old version removed.

Delete

Media files can only be deleted from the CMS if they are not being used on any existing Layouts. The option to force a delete from any existing Layouts must be used with caution, deleting a file cannot be reversed.

Retiring content means that it will no longer be available to assign to new Layouts but will remain in existing Layouts it is assigned to, meaning scheduled content can remain unaffected.

Permissions

Assign view/edit/delete permissions for User/User Groups.

Download

Download a copy of the media file for ease of sharing.

Usage Report

This will show if the selected media file is scheduled to Displays. Use the Layout tab to see what Layouts the media file is currently included in.

The Usage Report is great to make checks prior to deleting files.

Yes No
Last updated on 10 June 2019

Tidy Library  #

As the CMS is used and Layouts/Media are added, over time the Library can become cluttered with old content that is no longer in use.

The Library can be tidied by a User or Super Administrator so that it is kept clean and small. Actions cannot be reversed so this must be used with caution.

This might be of particular interest if the CMS is installed on a web server that has quotas or if Users have been assigned their own quotas.

There are two places where the Library can be tidied:

  1. Settings page – available to all Super Administrators
  2. Library page – enabled for All Users of the CMS

Tidy from Settings

Super Administrators can initiate a system-wide Library tidy operation by navigating to the Settings page under the Administration section on the Menu. Click on the General tab and click on the Tidy Library button.

As this functionality is system-wide and therefore operates on ALL User files, confirmation is required to remove unused and old revisions.

This option is more comprehensive and removes:

  • Temporary files
  • Orphaned files
  • Thumbnails
  • Media revisions that aren’t used anywhere
  • Media that isn’t used anywhere (on any Layouts / Display Groups / Displays)
  • Generic files uploaded to the CMS

Orphaned files

Orphaned files are a rare occurrence where a file stored on disk in the Library folder is not deleted when the Media item is deleted from the Library. This means that the file exists but the CMS doesn’t know anything about it.

Tidy from Library

Allow ANY User to initiate a Library tidy from the Library page by enabling the functionality in Settings under the Administration section of the Menu. Click on the General tab and use the checkbox for Enable Library Tidy.

Enable Library Tidy

Once enabled Users can click on the Tidy Library button at the top of the Library page.

The form will show the number of files that will be deleted and how much space those files take up.

This will only delete files that are owned by the logged in User which are no longer in use on a Layout or Assigned to a Display Group/Display.

Yes No
Last updated on 10 June 2019

Playlists #

Playlists allow for the creation of reusable playlists which can be easily added to Layouts and come in two parts:

  1. The Playlist (contains the media content and configuration)
  2. The Sub-Playlist Widget (allows for defined Playlists to be added to Layouts)

Playlists are first defined, which can then be reused across multiple Regions and Layouts. Access by navigating to Playlists under the Library section of the menu to view the Playlists grid where you can add new and manage existing Playlists.

Click on the Add Playlist button and complete the form fields:

If you require media assignments to be managed automatically then tick the Dynamic check box and set the filter criteria to use for Library media on the Filter tab.

You can prepopulate your playlist with media from the Library using the Filter tab, but leaving the Dynamic checkbox unticked to make it a one-time assignment.

Once added use the row menu for your created Playlist and click on Timeline.

Click on a Widget or drag and drop to add to the playlist.

Use the Library Search tab to add media already uploaded to the Library.

Once added configure using the Edit options available.

For further information on the Edit options available please refer to the relevant manual page for the chosen Widget.

Change the playlist Timeline order by clicking on an item and dragging it to the desired positioning. As changes are autosaved use the Undo button, located on the bottom right of the toolbar to revert any changes made.

Use the Tools tab to apply Actions such as Audio/Permissions and Expiry Dates to the items added to the timeline.

Easily make copies of Playlists by using the Copy button from the row menu.

Use the tick box to make new copies of all media assigned to the original playlist so that you can make adjustments as needed to create a new Playlist.

Include pre-defined Playlists by adding the Sub-Playlist Widget to Layouts.

Yes No
Last updated on 10 June 2019

DataSets #

DataSets are a feature to design and store tabular data. Once designed the data can be imported from a CSV file, entered manually, as JSON via the API or synced remotely on a Schedule. A DataSet provides a convenient way to import and display data from other systems in Medyapin.

Examples of where DataSets could be utilised:

  • A drinks menu at a bar
  • Tee times at a golf club
  • Meeting room bookings

DataSets have been designed to be versatile and reusable and come in two parts:

  1. The DataSet (Data Structure and data)
  2. The Display (DataSet View / DataSet Ticker / a source of data for a custom Module)

DataSets are first defined, which can then be reused across multiple DataSet Views and Layouts. Access by navigating to DataSetsunder the Library section on the Menu to view the DataSet grid where you can add new and manage existing DataSets.

Add DataSet

Designing a DataSet is a 2 step process – first add the DataSet record and then configure Columns.

Click on the Add DataSet button and complete the form fields.

Name – Use to identify in the CMS

Description – optional (what is it used for?)

Code – Usually used for referencing via the API

Remote? – Should this DataSet sync itself with a remote data source?

If you choose to make the DataSet Remote you will be presented with further tabbed headers with information that will need completing, see the Remote DataSets section of this page.

Columns

Use the row menu and select View Columns, a new grid will open which will show all Columns currently created for that DataSet.

By default, all DataSets will have Col1 added which should be edited or deleted using the row menu.

Columns are used to define the structure of the data, with each Column having a number of settings to achieve this. Click on the Add Column button and complete the fields on the form.

Heading – a heading to identify the Column.

Column Type – Value (User entered), Formula (calculated) or Remote.

Data Type – String, Number, Date, External Image, Library Image, the format to use for the data.

Column Order – The position this Column should appear when viewing/entering Data.

Options for Filtering and Sorting are also included on this form.

Additional Information

Depending on the Column Type selecting additional information will be required:

(Value) List Content – A comma-separated list of values that can be selected for this field.

(Formula) Formula – A MySQL statement suitable for use in a ‘SELECT’ statement, or a string to format a date field $dateFormat(<col>,<format><language>).

Ensure that <col> has a date and time specified for the date format to work.

If the Language has not been set, then it will default to English.

(Remote) Remote Data Path – A JSON syntax string showing how to access the Data in the Remote data source.

There is no theoretical limit to the number of columns Medyapin can support; although a smaller DataSet is often easier to enter and display.

Columns can be added and removed after Data has been entered. The ordering and list content of Columns can also be changed after Data has been collected.

Medyapin should accept any date format that is in a correct PHP date format, the following characters are recognised and can be used:

Format CharacterDescriptionExample returned values
Day
dDay of the month, 2 digits with leading zeros01 to 31
DA textual representation of a day, three lettersMon through Sun
jDay of the month without leading zeros1 to 31
l(lowercase ‘L’) A full textual representation of the day of the weekSunday through Saturday
NISO-8601 numeric representation of the day of the week (added in PHP 5.1.0)1 (for Monday) through 7 (for Sunday)
SEnglish ordinal suffix for the day of the month, 2 charactersst, nd, rd or th. Works well with j
wNumeric representation of the day of the week0 (for Sunday) through 6 (for Saturday)
zThe day of the year (starting from 0)0 through 365
Week
WISO-8601 week number of year, weeks starting on Monday (added in PHP 4.1.0)42 (the 42nd week in the year)
Month
FA full textual representation of a month, such as January or MarchJanuary through December
mNumeric representation of a month, with leading zeros01 through 12
MA short textual representation of a month, three lettersJan through Dec
nNumeric representation of a month, without leading zeros1 through 12
tNumber of days in the given month28 through 31
Year
LWhether it’s a leap year1 if it is a leap year, 0 otherwise.
oISO-8601 year number. This has the same value as Y, except that if the ISO week number (W) belongs to the previous or next year, that year is used instead. (added in PHP 5.1.0)1999 or 2003
YA full numeric representation of a year, 4 digits1999 or 2003
yA two digit representation of a year99 or 0

Remote DataSets

A Remote DataSet will need additional information completed; the Remote data source URL, request params, request method and authentication information.

Remote DataSets are a special type of DataSet which periodically syncs from a 3rd party data source which you specify when adding/editing the DataSet. Medyapin will call the URL specified at the time period specified and parse the data according to the instructions set on the DataSet and any Remote Columns.

Remote DataSet will not sync or update until it is being used in a Layout that has been Scheduledto show on a Player.

The remote data source must be JSON formatted.

Data is populated according to the Columns defined as Column type Remote. When specifying a Remote Column a “data path” is entered which is the JSON syntax path to the data for that column, with respect to the Data Root specified on the DataSet.

Consider an example JSON data source:

{
    "base": "EUR",
    "date": "2017-12-22",
    "rates": {
        "GBP": 0.88568,
        "THB": 38.83,
        "USD": 1.1853
    }
}

If we wanted columns to capture the currency symbol and value, we would set our “Data Root” to rates and then have Columns for:

  • Symbol – data path = 0
  • Value – data path = 1

Dependents

A remote DataSet can depend on another DataSet to formulate its request. Each row in the dependent DataSet will be used to create a request using the parent DataSet’s request parameters.

Data Row

Once you have your DataSet defined with Columns you will need to add some data. This can be done in a number of ways:

  • Manually through the CMS user interface
  • Imported via a CSV file
  • Through the API
  • Remotely synced

Manually

Data can be viewed/added and edited in a DataSet using View Data on the row menu or the button on the Columns page.

The data table returned will contain a column for each of the Columns you’ve defined in your configuration.

Add a new row by clicking on the Add Row button to open a form with fields to be completed for all non-formula Columns. A Row can be edited by clicking anywhere on the row and deleted using the blue X.

Importing CSV

The CMS has a DataSet CSV importer that can be used to extract data from a CSV file and put it into a DataSet. The importer can be accessed through the row menu of any DataSet, with the exception of DataSets configured for Remote data sources.

When the importer opens the Columns in the DataSet will be listed with a field next to them, indicating the Column in the Remote file that should be used as a source of data for that Column. You may also choose to overwrite the existing data and ignore the first row of the CSV file.

An example of the form is shown below:

It is important to ensure that your CSV file has the correct file encoding if you are using non-ASCII characters. Non-ASCII characters are very common for languages outside of English. The file encoding most commonly used is UTF-8.

If you have edited your CSV file using Excel, you will need to make sure you select “Unicode (UTF-8)” from the Tools -> Web Options -> Encoding tab on the Save as dialogue.

Through the API

You can write your own application which syncs data into a DataSet using the Medyapin API. Data can be added row by row or via importing whole JSON structures.

Remotely

Remote DataSets are kept in sync with a Task called Fetch Remote DataSets. This task is configured by default and runs once per minute.

Row Menu

As well as the Actions that have been previously mentioned, each data set can have a number of actions performed against it, accessed using the row menu.

Delete

Select the Delete menu item to show the DataSet Delete form which gives the option of deleting any associated data contained.

DataSets can only be deleted if they are not currently being used.

Permissions

The creator (owner) of the DataSet or a Super Administrator can assign View/Edit/Delete Permissions for User/User Groups.

Users with Edit permissions will be able to add/edit data and reorganise the structure of the DataSet. Only Users with View permissions will be able to use the DataSet in Layouts.

Yes No
Last updated on 14 June 2019

Modules  #

All content displayed in Medyapin is added/edited and served by a Media Module. Medyapin has a wide variety of Modules to choose from with more being introduced with new releases.

 

Yes No
Last updated on 14 June 2019

Audio #

Audio files are uploaded to the Library and served to the Player for offline playback. The Audio Module allows for audio to be assigned to Layouts.

If the audio file has already been uploaded to the Library use the Library Search tab to quickly and simply add to a Region.

Click on the Audio Widget on the toolbar, add / drag to the target Region.

Click on Add files to upload to the Library or click on View Library to select an uploaded file.

Once assigned to a Region, Edit options are available.

If Audio is assigned to a Widget, which is the only Widget in its Region, the audio will stop once the Widget duration has expired, but the Widget may be left on screen until the rest of the Layout has expired.

The Audio Widget is fully compatible with Overlay Layouts and can therefore be used effectively to draw attention and compliment content.

Yes No
Last updated on 14 June 2019

Calendar #

The Calendar Module is used to display events from an iCAL feed. Calendar events can be filtered using Interval options and formatted using text templates.

Click on the Calendar Widget on the toolbar, add / drag to the target Region.

General

  • Provide an optional name.
  • Choose to override the default duration.
  • Select whether the duration is per item. Left unticked the duration will be per feed.

Configuration

  • Provide the iCAL URL.
  • Use the Interval option as a filter to show events for a certain period. Use natural language such as ‘1 day’ or ‘2 weeks’ to return the events within your chosen time frame.
  • Specify the Number of items / events you wish to display from the iCAL feed.
  • Select the Exclude all day events tick box if you would like all day events excluded from the feed and therefore not displayed.
  • Choose to Exclude current events so that they are removed from the feed and therefore will not be displayed.
  • Opt to use the event timezone and calendar timezone. Left unticked, the timezone set in the CMS will be used.
  • If your feed is from Windows use the check box.

Appearance

  • Use Date Format to ensure that you show the appropriate date/time formats for your calendar events.
  • Use the checkbox to show calendar items side by side.
  • Select an effect using the drop-down menu to be used to transition between items.
  • With an Effect selected specify the number of events you wish to show per page.

    We would encourage users to opt for an effect when you have several events you wish to display, otherwise they will be shown as static lists.

Template

Click on the Template header to format the Calendar Template.

Main Template

Toggle On the Visual editor to format the main template using the inline editor. Click in the preview window to open.

Include text merge fields from the Snippets menu to pull in the required event information from the Calendar. Click on the Save button.

Current Event

Using the Set an alternative template for events that are current feature will tell Medyapin to use the Players date/time to work out if the event showing is current.

Include alternative text and formatting to be used just for your Current Events.

Include Snippets to pull the required information from your calendar.

No Data

Include a message to ensure that your audience is not left with blank displays when no information is returned from the iCAL feed.

Optional Style Sheet

Include CSS to apply to the template structure.

Caching

Include a suitable time for the Update Interval in minutes, keeping it as high as possible. This determines how often the Module will request data from your feed. If your calendar only ever modified with events scheduled days in advance, you can set this for a long period.

It is best practice to contact a remote feed as little as possible.

Date Format – PHP

Medyapin should accept any date format that is in a correct PHP date format, the following characters are recognised and can be used:

Format CharacterDescriptionExample returned values
Day
dDay of the month, 2 digits with leading zeros01 to 31
DA textual representation of a day, three lettersMon through Sun
jDay of the month without leading zeros1 to 31
l(lowercase ‘L’) A full textual representation of the day of the weekSunday through Saturday
NISO-8601 numeric representation of the day of the week (added in PHP 5.1.0)1 (for Monday) through 7 (for Sunday)
SEnglish ordinal suffix for the day of the month, 2 charactersst, nd, rd or th. Works well with j
wNumeric representation of the day of the week0 (for Sunday) through 6 (for Saturday)
zThe day of the year (starting from 0)0 through 365
Week
WISO-8601 week number of year, weeks starting on Monday (added in PHP 4.1.0)42 (the 42nd week in the year)
Month
FA full textual representation of a month, such as January or MarchJanuary through December
mNumeric representation of a month, with leading zeros01 through 12
MA short textual representation of a month, three lettersJan through Dec
nNumeric representation of a month, without leading zeros1 through 12
tNumber of days in the given month28 through 31
Year
LWhether it’s a leap year1 if it is a leap year, 0 otherwise.
oISO-8601 year number. This has the same value as Y, except that if the ISO week number (W) belongs to the previous or next year, that year is used instead. (added in PHP 5.1.0)1999 or 2003
YA full numeric representation of a year, 4 digits1999 or 2003
yA two digit representation of a year99 or 0
Yes No
Last updated on 14 June 2019

Chart #

The Chart module is used in conjunction with DataSets to display information as one of the following Chart Types:

  • Line
  • Bar
  • Pie
  • Donut
  • Horizontal Bar
  • Radar

DataSets are created and defined in the Library and can be represented in Layouts using the Chart module. For more information on DataSets and how they are configured, please see the DataSet manual page.

Click on the Chart Widget on the toolbar, add / drag to the target Region.

Add Chart

Use the drop-down menu to select the DataSet to be used as the source.

General

  • Provide an optional name.
  • Choose to override the default duration.

Configuration

Data

  • Use the drop down to select the Chart type which would best present information held in the selected DataSet.
  • All types of chart need an X and Y axis configured from the available columns in the associated DataSet. Configure by using the selectors.

Include a Series Identifier if you want to show a breakdown of values rather than the sum of all values. A series identifier is not suitable for Pie/Donut charts.

Labels

  • Include a chart title and labelling to display on the chart.
  • Choose to include a Legend to further explain the data.

Appearance

Style

Use the colour picker to select colouring for the background and font for the chart as well as specifying the font size.

Colour Palette

Use the colour picker to select the colours to use for the charts data series. If you do not select any colours the default colouring for the module will be used (these can be configured in Module Settings by your administrator)

Order

DataSet results can be ordered by any column. Use the advanced order clause for more complex ordering by providing a SQL command.

Filter

DataSet results can be filtered by any column. Include or omit DataSet results using the clause builder or use the advanced filter clause for more complex filtering.

Caching

Include a suitable time for the Update Interval in minutes, keeping it as high as possible. This determines how often the Module will request data from your feed.

Yes No
Last updated on 14 June 2019

Clock  #

The Clock Widget can be used to show an AnalogueFlip or Digital Clock as well as a Countdown on Layouts.

Click on the Clock Widget on the toolbar, add / drag to the target Region.

General

  • Provide an optional name
  • Choose to override the default duration

Appearance

Use the drop-down menu to select the type of clock to display:

Analogue

The Analogue Clock is a traditional clock face available in a Light or Dark theme (black or white face).

Digital

The Digital Clock has an additional Editor tab so that a template can be entered for the Digital Clock.

The font, size, colour and other properties of the template can be changed. Toggle on the Visual editor to access the inline editor and click on the edit icon in the Preview window.

Enter text and formatting, use the Snippets menu to include available merge fields. See the section Formatting the time for further information.

Flip Clock

The Flip Clock is a pre-formatted clock that animates a “flip” for each hour, minute and seconds (optional) elapsed.

The Flip Clock also has Hourly, Minute and Daily Counter options which run from a specified date/time to give a Countdown on Layouts.

Formatting the Time

The time can be formatted by providing “tokens” that sit between square brackets [] in the template area.

TitleTokenOutput
MonthM1 2 … 11 12
Mo1st 2nd … 11th 12th
MM01 02 … 11 12
MMMJan Feb … Nov Dec
MMMMJanuary February … November December
QuarterQ1 2 3 4
Day of MonthD1 2 … 30 31
Do1st 2nd … 30th 31st
DD01 02 … 30 31
Day of YearDDD1 2 … 364 365
DDDo1st 2nd … 364th 365th
DDDD001 002 … 364 365
Day of Weekd0 1 … 5 6
do0th 1st … 5th 6th
ddSu Mo … Fr Sa
dddSun Mon … Fri Sat
ddddSunday Monday … Friday Saturday
Day of Week (Locale)e0 1 … 5 6
Day of Week (ISO)E1 2 … 6 7
Week of Yearw1 2 … 52 53
wo1st 2nd … 52nd 53rd
ww01 02 … 52 53
Week of Year (ISO)W1 2 … 52 53
Wo1st 2nd … 52nd 53rd
WW01 02 … 52 53
YearYY70 71 … 29 30
YYYY1970 1971 … 2029 2030
Week Yeargg70 71 … 29 30
gggg1970 1971 … 2029 2030
Week Year (ISO)GG70 71 … 29 30
GGGG1970 1971 … 2029 2030
AM/PMAAM PM
aam pm
HourH0 1 … 22 23
HH00 01 … 22 23
h1 2 … 11 12
hh01 02 … 11 12
Minutem0 1 … 58 59
mm00 01 … 58 59
Seconds0 1 … 58 59
ss00 01 … 58 59
Fractional SecondS0 1 … 8 9
SS0 1 … 98 99
SSS0 1 … 998 999
Timezonez or zzEST CST … MST PST
Z-07:00 -06:00 … +06:00 +07:00
ZZ-0700 -0600 … +0600 +0700
Unix TimestampX1360013296
Unix Millisecond Timestampx1360013296123
Yes No
Last updated on 14 June 2019

Currencies  #

The Currencies Widget provides exchange rates for many currency pairs when added to a Layout.

Add Currencies Widget

Click on the Currencies Widget on the toolbar, add / drag to the target Region.

General

  • Provide an optional name
  • Choose to override the default duration
  • Select whether the duration is per item, unticked the duration will be per page / number of items.

Configuration

  • Define currencies using their acronym/abbreviation (symbols or written text will not be recognised).
  • Include a Base currency.
  • Select Reverse conversion if you would like to use your base currency as the comparison.

Appearance

  • Optionally choose a background colour
  • Include a PHP Date Format to apply to returned results, see the bottom of the page for further information.
  • Select an optional Effect and Speed to be used to transition between items.

Templates

Preset – Use the drop-down to select an appropriate Template.

Override the template – Tick in the box to edit the selected template. Please see the section below for further information.

Provide a No Records Message to display when there are no records returned.

Caching

Include a suitable time for the Update Interval in minutes, keeping it as high as possible.

Overriding Templates

Templates can be edited by selecting a Template using the drop-down and clicking in the Override the template checkbox.

Click again on the Templates tab and select to edit:

Main Template

Toggle On the Visual editor to access the inline editor to enter text and formatting.

Get Results at anytime to see what data is returned. Any field is available as a substitute to use in the template by simply entering the field name between square brackets [].

Item Template

Enter a Template to be applied to each item, use the Visual editor (as above).

Date Format – PHP

Medyapin should accept any date format that is in a correct PHP date format, the following characters are recognised and can be used:

Format CharacterDescriptionExample returned values
Day
dDay of the month, 2 digits with leading zeros01 to 31
DA textual representation of a day, three lettersMon through Sun
jDay of the month without leading zeros1 to 31
l(lowercase ‘L’) A full textual representation of the day of the weekSunday through Saturday
NISO-8601 numeric representation of the day of the week (added in PHP 5.1.0)1 (for Monday) through 7 (for Sunday)
SEnglish ordinal suffix for the day of the month, 2 charactersst, nd, rd or th. Works well with j
wNumeric representation of the day of the week0 (for Sunday) through 6 (for Saturday)
zThe day of the year (starting from 0)0 through 365
Week
WISO-8601 week number of year, weeks starting on Monday (added in PHP 4.1.0)42 (the 42nd week in the year)
Month
FA full textual representation of a month, such as January or MarchJanuary through December
mNumeric representation of a month, with leading zeros01 through 12
MA short textual representation of a month, three lettersJan through Dec
nNumeric representation of a month, without leading zeros1 through 12
tNumber of days in the given month28 through 31
Year
LWhether it’s a leap year1 if it is a leap year, 0 otherwise.
oISO-8601 year number. This has the same value as Y, except that if the ISO week number (W) belongs to the previous or next year, that year is used instead. (added in PHP 5.1.0)1999 or 2003
YA full numeric representation of a year, 4 digits1999 or 2003
yA two digit representation of a year99 or 0
Yes No
Last updated on 14 June 2019

Dataset Ticker #

The DataSet Ticker Widget allows for DataSet content to be displayed as a Ticker on a Layout. The Ticker module primarily consists of a data source location and a template to apply to the retrieved data.

Ensure that a DataSet has been created and configured prior to using this Widget.

Add DataSet Ticker

Click on the DataSet Ticker Widget on the toolbar, add / drag to the target Region.

  • Use the drop-down menu to select the DataSet to be used as the source of data for the Ticker.
  • Save

You cannot change to a different DataSet once it has been added to a DataSet Ticker. To use an alternative DataSet a new DataSet Ticker would need to be created.

Once saved the Edit Ticker form will open to provide further options.

General

  • Provide an optional name
  • Choose to override the default duration
  • With Duration is per item selected, the configured duration will be extended by the number of items returned by the Data Source.

This should be used with caution as it can create long-running media items. It is recommended to use this setting in conjunction with a setting to limit the number of items shown.

Configuration

Select if returned items should be shown side by side and configure Upper and Lower row limits.

Appearance

  • Optionally select a background colour
  • Use the drop-down menu to select an Effect to be used to transition between items.
  • Set the Speed for the effect selected.
  • Enter how many Items should appear on each page if an effect to split items has been selected.

Templates

Click on the Template header to format the Main Template.

Toggle On the Visual editor to use the inline editor. Click in the preview window to open.

The available columns to use in the template can be found in the Snippets menu.

Use the No Data Template to include a message to ensure that your audience is not left with blank displays when there is no data to display.

The Optional Style Sheet is intended for advanced users to ‘tweak’ the CMS generated output.

Order

Order the DataSet results by using the clause builder or by using an advanced filter clause using SQL syntax, e.g. Name DESC

Filter

Filter the DataSet to exclude/include results by using the clause builder or by using an advanced filter cause using the SQL syntax.

Caching

Players can cache the content of this media type to prevent repeated downloads and off-line playback. Keep this number as high as possible.

Yes No
Last updated on 14 June 2019

DataSet Views  #

The DataSet View Widget allows content from a created DataSet to be added into a Region, organised and displayed in a tabular format.

When the underlying DataSet Data is changed, the DataSet View Widget included in your Layout(s), will automatically update with the new data.

Once a DataSet has been added to a DataSet View, care should be taken when editing the column structure of the DataSet.

Ensure that you have created a DataSet prior to adding a DataSet View to a Layout.

Add DataSet View

Click on the DataSet View Widget on the toolbar, add / drag to the target Region.

  • Use the drop-down menu to select the DataSet to be used as the source of data for the DataSet View.
  • Save

You cannot change to a different DataSet once it has been added to a DataSet View. To use an alternative DataSet a new DataSet View would need to be created.

Once saved the Edit DataSet View form will open to provide further options.

General

  • Provide an optional name
  • Choose to override the default duration.

Configuration

  • Click or drag and drop to select available columns.
  • Choose to show the table headings
  • Configure Upper and Lower row limits
  • Split the data over multiple pages using Rows per Page.

Appearance

  • Select a Template using the drop-down menu
  • Choose to override the Template

By selecting to Override the Template you can use a CSS style sheet to control the visual styling of the table. (Example style sheet at the bottom of this page).

Complete the form fields to style your DataSet View by selecting colouring and fonts/font size to use.

Templates

Select the No Data Template to provide a message to display when there is no data to show.

Toggle on the Visual editor to use the inline text editor.

Order

Order by any column using the clause builder or by providing a SQL command for more complex ordering.

Filter

Filter by any Column using the clause builder to only include/omit results based on chosen criteria. Provide a SQL command for more complex filtering.

Caching

Enter an update interval in minutes, kept as high as possible. (Displays can cache the content of this media type to prevent repeated download of identical resources, as well as for off-line playback).

Example Style Sheet

table.DataSetTable {
font-family:"Trebuchet MS", Arial, Helvetica, sans-serif;  
width:100%;
border-collapse:collapse;
}

tr.HeaderRow {
font-size:1.1em;
text-align:center;
padding-top:5px;
padding-bottom:4px;
background-color:#A7C942;
color:#ffffff;
}

tr#row_1 {
color:#000000;
background-color:#EAF2D3;
}

td#col_1 {
color:#000000;
background-color:#EAF2D3;
}

td.DataSetColumn {
color:#000000;
background-color:#EAF2D3;
border:1px solid #98bf21
}

tr.DataSetRow {
text-align:center;
color:#000000;
background-color:#EAF2D3;
border:1px solid #98bf21
padding-top:5px;
padding-bottom:4px;
}

th.DataSetColumnHeaderCell {
font-size:1em;
border:1px solid #98bf21;
padding:3px 7px 2px 7px;
}

span#1_1 {

}

span.DataSetColumnSpan {

}
Yes No
Last updated on 14 June 2019

Embedded Content  #

The Embedded Content Widget allows HTML and JavaScript to be embedded into a Region on a Layout. This allows for custom enhancements to be made to Medyapin without modifying the core application.

Examples of where this might be useful are displaying a Clock or Weather region.

Click on the Embedded Widget on the toolbar, add / drag to the target Region.

General

  • Provide an optional name
  • Choose to override the default duration

Configuration

  • Select whether the item should be shown with a transparent background. Please note: This is currently not available on the Windows Player.

Medyapin will try its best to do this when checked, however, it may be overridden by the custom content.

  • Select to scale embedded content along with the layout.

Templates

HTML to Embed

Complete HTML in the box provided or toggle On the Visual editor to use the inline editor to enter text and format. Click in the preview window to open the text editor.

Custom Style Sheets

Use a CSS style sheet to control the visual styling.

HEAD content to Embed

Any content to put in the HEAD of the document – JavaScript should be wrapped in script tags. Medyapin will automatically add jQuery.

The EmbedInit() method will be called by the Player and can be used to safely start any custom JavaScript at the appropriate time. The method is defaulted on any new Embedded media Item.

<script type="text/javascript">
function EmbedInit()
{
    // Init will be called when this page is loaded in the client.

    return;
}
</script>

Show embedded HTML with Active-X content on a Windows Player, with the security settings of IE, so that local files are allowed to run active content by default. This can be done in Tools -> Internet Options -> Advanced -> Security -> “Allow Active content to run in files on My Computer”.

Yes No
Last updated on 14 June 2019

Flash #

The Flash Module allows for SWF file uploads to the Library which can be assigned to Layouts.

If the SWF file has already been uploaded to the Library use the Library Search tab to quickly and simply add to a Region.

Click on the Flash Widget on the toolbar, add / drag to the target Region.

Click on Add files to upload to the Library or click on View Library to select an uploaded file.

Supported Players

DisplaySupported?Remarks
AndroidNoNot supported, see note.
WindowsYes
webOSYes
LinuxPartialSupport via the browser component can be unstable.

Please note: As Adobe has discontinued development and support for this application the Flash Module is no longer supported on Android. After extensive testing, it was found that instabilities in the Player could cause the Player to close. Should you still choose to run via the Flash Module or on embedded websites, it will render using the Flash application if available. However, if you have stability problems with your device this may be due to the running of Flash content.

Yes No
Last updated on 14 June 2019

HLS  #

Add the HLS Video Stream Widget to show live streamed content on Layouts.

Please note: This Module requires Windows 8.1 or later/Android 6 or later. Earlier Android devices may play HLS using the Local Video Module.

This Module requires a valid internet connection on the Player in order to function.

Click on the HLS Widget on the toolbar, add / drag to the target Region.

General

  • Provide an optional name
  • Choose to override the default duration

Configuration

  • Provide a URL to the HLS Video stream.
  • Use the checkbox to mute/unmute the video stream.
Yes No
Last updated on 14 June 2019

HTML Package #

The HTML Package Module allows for the upload of a complete HTML Package which can be distributed to Players.

If the file has already been uploaded to the Library use the Library Search tab to quickly and simply add to a Region.

Click on the HTML Package Widget on the toolbar, add / drag to the target Region.

Click on Add files to upload to the Library or click on View Library to select an uploaded file.

Yes No
Last updated on 14 June 2019

Image  #

The Media Module allows for image uploads which can be added to Layouts using the Image Widget.

If the Image file has already been uploaded to the Library use the Library Search tab to quickly and simply add to a Region.

Click on the Image Widget on the toolbar, add / drag to the target Region.

Click on Add files to upload to the Library or click on View Library to select an uploaded file.

We recommend uploading JPG or PNG files, ensuring that users check the resolution of the Image and keep it within the intended screen size.

Caution should be taken as uploading very large Images can cause issues for the Player.

Once assigned to a Region, Edit options are available.

Please note: Animated GIF’s are not supported on any Player.

As Medyapin takes no measures to control what content is put on your displays, it is your responsibility to ensure that any images used are appropriately attributed if you do not own the rights.

Yes No
Last updated on 14 June 2019

Local Video  #

The Local Video Module is used for video that exists only on the Display and is not uploaded to the CMS, such as;

– Manually transferred videos

– Videos on a LAN

– Streamed Videos

Add Local Video

Click on the Local Video Widget on the toolbar, add / drag to the target Region.

Complete a local file path or URL to the video, this can be an RTSP Stream.

  • Optionally Set a duration to override the default.
  • Use the drop down to select how the video should be scaled.
  • Use the checkbox to mute/unmute the video.

Video scaling and RTSP streams are only supported on the Android and webOS Players. Use the HLS Widget to show compatible video streams on Window Players.

Yes No
Last updated on 14 June 2019

Notifications  #

Add the Notification Widget to layouts to display messages created in the Notification Drawer of the CMS.

Click on the Notification Widget on the toolbar, add / drag to the target Region.

General

  • Provide an optional name
  • Choose to override the default duration
  • Select if the duration should be per Notification or a total duration for ALL Notifications.

Configuration

  • Complete a maximum notification age for messages you wish to use in this Widget.
  • Select an optional Effect and Speed from the drop-down menu.

Templates

Click on the Template header to format the Notifications Template.

Main Template

Toggle On the Visual editor to format the Main Template using the inline editor. Click in the preview window to open.

Include text merge fields from the Snippets menu to pull in the Subject and Body information from the Notification Drawer. Click on the Save button.

No Data

Include a message to ensure that your audience is not left with blank displays when there are no Notifications to display.

Optional Style Sheet

Include CSS to apply to the template structure.

Yes No
Last updated on 14 June 2019

PDF #

The PDF Module allows for the upload of PDF files to the Library which can then be added to Layouts.

If the PDF file has already been uploaded to the Library use the Library Search tab to quickly and simply add to a Region.

Click on the PDF Widget on the toolbar, add / drag to the target Region.

Click on Add files to upload to the Library or click on View Library to select an uploaded file.

Medyapin uses pdfjs to display PDF’s on the Player and in the Layout Designer.

Increase the duration to show a PDF page for longer.

Yes No
Last updated on 14 June 2019

PowerPoint  #

Medyapin has 3 options to display PowerPoint PPT files.

Option 1 – Exported as a Video for non-Windows Players, and or, have no full copy of PowerPoint to install.

Option 2 – Saved as a PDF for non-Windows Players, and or, have no full copy of PowerPoint to install.

Option 3 – Prepared and Uploaded as a PowerPoint PPT file for Windows Players only. Requires a full copy of PowerPoint to install on each Windows Player.

If the PowerPoint PPT file has already been uploaded to the Library use the Library Search tab to quickly and simply add to a Region.

Option 1 – Export as a Video

From Office 2010 onwards PowerPoint presentations can be exported as Video files which can then be uploaded to Medyapin and played using the Video Widget.

Export PowerPoint

  • Export a PowerPoint by using the option on the file menu from inside the PowerPoint application. Save the file with an appropriate name to be selected for upload.

If your Players are Android or webOS devices you should ensure that the export format is MP4 (PowerPoint 2013 onwards) or convert your video to a MP4 using a 3rd party tool.

Upload Video

  • Click on the Video Widget on the toolbar, add / drag to the target Region.
  • Click on Add files and select the exported PowerPoint file to upload.

Once assigned to a Region, Edit options are available.

Option 2 – Save as a PDF

  • Save your PowerPoint as a PDF.
  • Click on the PDF Widget on the toolbar, add / drag to the target Region.
  • Select Add files and select the saved PDF file to upload.

Once assigned to a Region, Edit options are available.

Set the duration for the overall presentation and the PDF Widget will handle the number of pages to make it fit within this timescale.

Option 3 – Prepare and Upload your PowerPoint PPT file

PowerPoint is a proprietary format from Microsoft and can only be displayed on a Windows-based signage player which has Microsoft PowerPoint installed.

First prepare the PowerPoint Presentation. PowerPoint will, by default, put scroll bars up the side of your presentation, unless you do the following for each PowerPoint file BEFORE you upload it:

  1. Open your PowerPoint Document
  2. Slide Show -> Set-up Show
  3. Under “Show Type”, choose “Browsed by an individual (window)” and then untick “Show scrollbar”
  4. Click OK
  5. Save the Presentation
  6. Note also that Medyapin will not advance the slides in a Presentation, so you should record automatic slide timings by going to “Slide Show -> Rehearse Timings” and then saving the presentation.

<a name="machine_preparation"></a>

Click on the PowerPoint Widget on the toolbar, add / drag to the target Region.

Click on Add files to upload to the Library or click on View Library to select an uploaded file.

Prepare your Windows Players

Install PowerPoint on your Windows PC alongside your Medyapin Player and make the following adjustments to the Windows Registry to disable the windows prompt when opening the PowerPoint. Please ensure you have taken all necessary precautions when making these changes.

[HKEY_CLASSES_ROOT\PowerPoint.Show.12]
"BrowserFlags"=dword:00000002
"EditFlags"=dword:00010000

[HKEY_CLASSES_ROOT\PowerPoint.Show.8]
"BrowserFlags"=dword:00000002
"EditFlags"=dword:00010000

[HKEY_CLASSES_ROOT\PowerPoint.SlideShow.12]
"BrowserFlags"=dword:800000a0
"EditFlags"=dword:00010000

[HKEY_CLASSES_ROOT\PowerPoint.SlideShow.8]
"BrowserFlags"=dword:00000002
"EditFlags"=dword:00010000

If you do not feel comfortable changing the registry it may be possible to achieve the same results by waiting for Medyapin to open the first PowerPoint and then when the pop-up notification appears, choose to “Open” the file, and un-check the box so you won’t be prompted again.

Enable PowerPoint on Displays

You will need to ensure that the Windows Display Profile used for the Displays you intend to use PowerPoint on, must be first enabled.

Navigate to Display Settings under the Displays section of the Main menu and locate the Windows Display Profile. Use the row menu to edit the profile. On the General tab tick the Enable PowerPoint check box and Save.

Advanced Steps

When displaying PowerPoint Medyapin is relying on Windows and PowerPoint to display the content. This means that error capture and reporting is outside the control of Medyapin. To mitigate any issues we recommend disabling Windows error notifications. This can be done by following the steps here.

If you still experience issues, it may also be advisable to disable Office Application Error reporting by merging the registry patch below.

[HKEY_CURRENT_USER\Software\Policies\Microsoft\Office\11.0\Common]
"DWNeverUpload"=dword:00000001

[HKEY_CURRENT_USER\Software\Policies\Microsoft\Office\10.0\Common]
"DWNeverUpload"=dword:00000001

[HKEY_CURRENT_USER\Software\Policies\Microsoft\Office\12.0\Common]
"DWNeverUpload"=dword:00000001
Yes No
Last updated on 14 June 2019

Shell Command  #

The Shell Command Module is used to instruct the Display to execute a Command outside of the Medyapin environment, using the operating system shell.

Please note: This Module is not supported for webOS.

The Command is executed when a Layout containing the Shell Command Widget plays at its scheduled time.

A Shell command can be an “ad hoc” command string which is passed directly to the shell or a predefined command configured by an Administrator.

It is recommended that predefined commands should be used where possible. If you require additional commands, please contact your Administrator to create a new predefined command or provide a command string to include.

Click on the Shell Command Widget on the toolbar, add / drag to the target Region.

General

  • Provide an optional name
  • Choose to override the default duration

Configuration

  • Use the drop-down menu to select a command.
  • If a command string is to be used, then fields are provided for Windows or Android / Linux compatible commands.

Linux/Android Players require root access to use Shell Commands.

Shell Commands do not have a duration, they are executed once and then expire automatically.

Add the Shell Command Widget to Layouts to execute external commands, such as ‘volume up’ for a Layout with an Audio Widget that is set to play, and ‘volume down’ when the Layout finishes.

For commands that are executed on a specific date/time, such as ‘reboots’, ‘turn on/off’ on opening/closing times for example, then please see Events in the Scheduling section and Send Command in the Displays section of this User Manual.

Yes No
Last updated on 14 June 2019

Stocks #

The Stocks Widget displays trade price information for stock listings when added to a Layout.

Add Stocks Widget

Click on the Stocks Widget on the toolbar, add / drag to the target Region.

General

  • Provide an optional name
  • Choose to override the default duration
  • Select whether the duration is per item, unticked the duration will be per page / number of items.

Configuration

  • Include a Stock Symbol (Ticker) to return results

If you need a stock symbol that is only quoted on a specific exchange then you can use the format SYMBOL:EXCHANGE to return results.

Stock symbols can be found on various lookup sites such as Yahoo Finance

Appearance

  • Optionally choose a background colour
  • Include a PHP Date Format to apply to returned results, see the bottom of the page for further information.
  • Select an optional Effect and Speed to be used to transition between items.

Templates

Select Preset Templates or provide your own using JavaScript.

Edit templates using the Override the template checkbox, then click on the Template header to select the template you want to edit.

Provide a No Records Message to display when there are no records returned.

To use the inline editor toggle On the Visual editor.

Get Results at anytime to see what data is returned. Any field is available as a substitute to use in the template by simply entering the field name between square brackets [].

Caching

Include a suitable time for the Update Interval in minutes, keeping it as high as possible.

Date Format – PHP

Medyapin should accept any date format that is in a correct PHP date format, the following characters are recognised and can be used:

Format CharacterDescriptionExample returned values
Day
dDay of the month, 2 digits with leading zeros01 to 31
DA textual representation of a day, three lettersMon through Sun
jDay of the month without leading zeros1 to 31
l(lowercase ‘L’) A full textual representation of the day of the weekSunday through Saturday
NISO-8601 numeric representation of the day of the week (added in PHP 5.1.0)1 (for Monday) through 7 (for Sunday)
SEnglish ordinal suffix for the day of the month, 2 charactersst, nd, rd or th. Works well with j
wNumeric representation of the day of the week0 (for Sunday) through 6 (for Saturday)
zThe day of the year (starting from 0)0 through 365
Week
WISO-8601 week number of year, weeks starting on Monday (added in PHP 4.1.0)42 (the 42nd week in the year)
Month
FA full textual representation of a month, such as January or MarchJanuary through December
mNumeric representation of a month, with leading zeros01 through 12
MA short textual representation of a month, three lettersJan through Dec
nNumeric representation of a month, without leading zeros1 through 12
tNumber of days in the given month28 through 31
Year
LWhether it’s a leap year1 if it is a leap year, 0 otherwise.
oISO-8601 year number. This has the same value as Y, except that if the ISO week number (W) belongs to the previous or next year, that year is used instead. (added in PHP 5.1.0)1999 or 2003
YA full numeric representation of a year, 4 digits1999 or 2003
yA two digit representation of a year99 or 03
Yes No
Last updated on 14 June 2019

Sub Playlists #

The Sub-Playlists Widget allows for pre-defined Playlists to be simply added to a Layout.

Ensure that you have created a Playlist prior to adding this Widget.

Click on the Sub-Playlist Widget on the toolbar, add / drag to the target Region.

General

Use the drop-down menu to select a Playlist to embed.

Included on this tab are optional Spot options which allow for the defining of advertising/promotional spots.

Spots

  • Specify the total number of Spots you would like to be available for that Playlist to expand or shrink to a specified size.
  • Leave this field blank to use the count of Widgets assigned to the Playlist to maintain the size.
  • Set to 0 to omit the first Playlist from the play order. This Playlist can be used as a spot filler from the Spot Fill options. Please note: If you wish to provide a Playlist to be used as a ‘Spot Fill’ you must ensure that it is the first Playlist selected.

Spot Length

  • Set the length in seconds that you would like to apply to all Widgets assigned to that Playlist.
  • Leave this field blank to use the Widget duration.

Spot Fill Determine how remaining Spots should be filled in the event that there are not enough Widgets on the Playlist to fill the specified number of Spots.

  • Repeat – Widgets are repeated in the Playlist until the number of Spots has been fulfilled.
  • Fill – Widgets are taken from the first Playlist to fill any remaining Spots.
  • Pad – Widgets are taken from the first Playlist and distributed evenly with the assigned Widgets on that Playlist.

    Use the + button to add multiple Playlists and complete the optional Spot options.

If you select more than one Playlist, click on the Configuration tab to further define a play order.

Configuration

The Configuration tab contains the following options:

Playlist Ordering

Play all – Playlists will play in their entirety one after the other in the order they appear on the General tab.

Round Robin – Takes one Widget from each Playlist in the order they appear on the General tab and repeats.

Auto – Ensures that Widgets are played evenly from each Playlist by using the total count of Widgets on all Playlists.

There are also options to decide what should be done with any Widgets that are left unordered at the end of a Playlist:

Remaining Widgets

Add – includes any remaining Widgets which are then added to the end of the Playlist.

Discard – will use the Playlist with the least Widgets and ignore any remaining Widgets on the longer Playlists.

Repeat – will use the Playlist with the most Widgets and repeat any remaining Widgets on the shorter Playlists.

The Sub-Playlist preview shows the number of Widgets and total duration after play order and Spot options are taken into consideration. Use the Layout preview to see each Widget in the list previewed in sequence.

Yes No
Last updated on 14 June 2019

Text #

Add Text directly onto a Layout by using the Text Widget.

Click on the Text Widget on the toolbar, add / drag to the target Region.

Text Editor

Click in the Preview window to open the inline editor to enter text and apply formatting.

The text editor will open with the same background as selected for the Layout and will use a complimentary text colour for the chosen background colour.

The thin red border in the text editing window represents the Region size. Ensure that formatted text remains within this border.

Optionally use date/time merge tags, available from the Snippets menu.

General

  • Provide an optional name.
  • Choose to override the default duration.

    It is typical to have a text item as the only media item assigned to a Region, therefore the duration can be set to a low value.

Effect

  • Use the drop-down menu to select an effect to be applied to your text.
  • Select a speed for the selected effect.
  • Optionally add a background colour.
  • Include a selector to use for marquee items.

Templates

Click on the Template header to enter HTML directly into the box provided.

Additional Fonts can be added to this editor by uploading files to the Library. Please be aware that fonts have ‘preferences’ built into them known as OS/2 tags. Medyapin checks these OS/2 preferences, and can use fonts with OS/2 tags 0 or 8. Fonts with other tags may not display correctly or you may receive an error on upload.

CKEditor

CKEditor is used for Text input. Complete documentation for all the buttons can be found on the CKEditor’s website.

Yes No
Last updated on 14 June 2019

Ticker #

The Ticker Widget allows dynamic Feed content to be added to a Layout. The Ticker module primarily consists of a data source location and a template to apply to the retrieved data.

Click on the Ticker Widget on the toolbar, add / drag to the target Region.

General

  • Provide an optional name
  • Choose to override the default duration
  • Opt to extend the duration by the number of items.

Use with caution as this can create long-running media items. Use in conjunction with ‘Number of items’ to limit this.

Configuration

  • Specify the Feed URL.
  • Choose how many RSS items should be returned.
  • Select to start with items from the beginning or end of the list.
  • Random feeds work offline; the entire feed is parsed, rendered and downloaded to the Player and then sorted in a random fashion for display. We use a Durstenfeld shuffle to randomise the order of items. Randomise works on the full feed, “Number of items” and “Take items from” options.
  • Display a Copyright notice at the end of the feed.
  • Opt to display returned results side by side.
  • Apply a Date Format to apply to all returned date results.
  • Include a comma-separated list of attributes that will not be stripped from the incoming feed.
  • Include a comma-separated list of HTML tags to be stripped from the feed.
  • Select to disable the date sort for the feed.

Appearance

  • Optionally select a background colour
  • Use the drop-down menu to select an Effect to be used to transition between items.
  • Set the Speed for the selected effect.
  • Select the direction of the text in the feed to use, right to left or left to right.
  • Enter how many Items should appear on each page, if an effect to split items has been selected.

Templates

Select Preset Templates or provide your own using JavaScript.

Preset

  • Use the drop-down to select an appropriate template.
  • Choose to Override the selected template.

By selecting to Override the Template you can enter your own text, html and CSS by using the templates available from clicking on the Templates tab.

Toggle on the Visual editor to use the inline editor.

A special notation is available where the User can specify the Tag|Namespace within the feed for Medyapin to extract content.

Optional Style Sheet

This is applied to the entire Ticker media item when shown on Displays.

This is intended for advanced users to ‘tweak’ the CMS generated output.

No Data

Use the No Data template to include a message to display when there is no data returned from the source.

Caching

Players can cache the content of this media type to prevent repeated downloads and off-line playback. Keep this number as high as possible.

Yes No
Last updated on 14 June 2019

Twitter  #

The Twitter Module provides access to the Twitter Search API. Add the Twitter Widget to Layouts to display Twitter feeds.

Granted access is to read data only.

Add Twitter Widget

Click on the Twitter Widget on the toolbar, add / drag to the target Region.

General

  • Provide an optional name
  • Choose to override the default duration
  • Select whether the duration is per item, unticked the duration will be per feed.

Configuration

  • Provide a search term to return applicable Tweets
  • Select the language to use
  • Choose to return Tweets based on popularity, most recent or a mixture of results
  • Select how many miles away from your location Tweets should be returned from. 0 has no restrictions
  • Select to remove Mentions from returned Tweet text
  • Select to remove Hashtags from returned Tweet text
  • Select to remove URLs from returned Tweet Text

To return Tweets from a specific account rather than all Tweets that contain the accounts @ handle, use from: before the name of the account in the Search Term field.

Most URL’s do not compliment digital signage and so we would recommend having Remove URLsselected.

Appearance

  • Optionally add a background colour
  • Select the number of Tweets to return, left blank will return the default number of 15
  • Select the number of Tweets to show per page, left blank will show the default number of 5 Tweets.
  • Apply a date format to be used for returned results, in PHP date format (see bottom of page)
  • Select an optional effect/speed to be used to transition between Tweets.

Templates

Select Preset templates or provide your own using JavaScript.

Preset – Use the drop-down to select an appropriate template.

Override the template – Tick in the box to edit the selected template. Please see the section on Overriding Templates below for further information.

Provide a No Tweets Message to display when there are no Tweets to return, based on the search query.

Caching

Include a suitable time for the Update Interval in minutes, keeping it as high as possible. This determines how often the Module will request data from your feed.

Overriding Templates

Templates can be edited by selecting a template and using the drop-down. Use the tick box to Override the template.

Click again on the Templates tab to see the available templates to edit:

Main Template

Toggle On the Visual editor to access the inline editor. Click in the preview window to open.

Use the inline editor to enter text and formatting. Use the Snippets menu to include merge text fields.

PHP – Date Format

Medyapin should accept any date format that is in a correct PHP date format, the following characters are recognised and can be used:

Format CharacterDescriptionExample returned values
Day
dDay of the month, 2 digits with leading zeros01 to 31
DA textual representation of a day, three lettersMon through Sun
jDay of the month without leading zeros1 to 31
l(lowercase ‘L’) A full textual representation of the day of the weekSunday through Saturday
NISO-8601 numeric representation of the day of the week (added in PHP 5.1.0)1 (for Monday) through 7 (for Sunday)
SEnglish ordinal suffix for the day of the month, 2 charactersst, nd, rd or th. Works well with j
wNumeric representation of the day of the week0 (for Sunday) through 6 (for Saturday)
zThe day of the year (starting from 0)0 through 365
Week
WISO-8601 week number of year, weeks starting on Monday (added in PHP 4.1.0)42 (the 42nd week in the year)
Month
FA full textual representation of a month, such as January or MarchJanuary through December
mNumeric representation of a month, with leading zeros01 through 12
MA short textual representation of a month, three lettersJan through Dec
nNumeric representation of a month, without leading zeros1 through 12
tNumber of days in the given month28 through 31
Year
LWhether it’s a leap year1 if it is a leap year, 0 otherwise.
oISO-8601 year number. This has the same value as Y, except that if the ISO week number (W) belongs to the previous or next year, that year is used instead. (added in PHP 5.1.0)1999 or 2003
YA full numeric representation of a year, 4 digits1999 or 2003
yA two digit representation of a year99 or 0
Time
aLowercase Ante meridiem and Post meridiemam or pm
AUppercase Ante meridiem and Post meridiemAM or PM
BSwatch Internet time000 through 999
g12-hour format of an hour without leading zeros1 through 12
G24-hour format of an hour without leading zeros0 through 23
h12-hour format of an hour with leading zeros01 through 12
H24-hour format of an hour with leading zeros00 through 23
iMinutes with leading zeros00 to 59
sSeconds, with leading zeros00 through 59
uMicroseconds (added in PHP 5.2.2). Note that date() will always generate 000000 since it takes an integer parameter, whereas DateTime::format() does support microseconds if DateTime was created with microseconds.654321
Timezone
eTimezone identifier (added in PHP 5.1.0)UTC, GMT, Atlantic/Azores
I(capital i) Whether or not the date is in daylight saving time1 if Daylight Saving Time, 0 otherwise.
ODifference to Greenwich time (GMT) in hours+0200
PDifference to Greenwich time (GMT) with colon between hours and minutes (added in PHP 5.1.3)+02:00
TTimezone abbreviationEST, MDT …
ZTimezone offset in seconds. The offset for timezones west of UTC is always negative, and for those east of UTC is always positive.-43200 through 50400
Full Date/Time
cISO 8601 date (added in PHP 5)2004-02-12T15:19:21+00:00
r» RFC 2822 formatted dateThu, 21 Dec 2000 16:01:07 +0200
Yes No
Last updated on 14 June 2019

Twitter Metro  #

The Twitter Metro Module provides access to the Twitter Search API. Add the Twitter Metro Widget to Layouts to display metro tiles of Twitter feeds.

Add Twitter Metro Widget

Click on the Twitter Metro Widget on the toolbar, add / drag to the target Region.

The Twitter Metro Widget will automatically size portrait/landscape based on the size of the Region that it is added to. It will resize as if it were an image for best consistency across all display resolutions.

General

  • Provide an optional name.
  • Choose to override the default duration.

Configuration

Complete the form options as required, refer to the Twitter page.

Appearance

Use the Appearance tab to edit the Main template, Colours to be applied and the Effect to be used to transition between Tweets.

Main

  • Optionally add a background colour.
  • Provide a No Tweets message to display when there are no Tweets to return, based on the search query.
  • Apply a date format to be used for returned results, in PHP date format 9refer to the Twitter page.

Colours

  • Use the drop-down menu to specify a colour pallet to be applied to the metro tiles.
  • Tick to Override the template and specify your own colour pallets to use for the metro tiles

  • Click in the colour bars to re-select using the colour picker, remove by clicking - or add using +
  • Ensure that you Save your changes.

Effect

  • Select an optional effect/speed to be used to transition between Tweets, to be applied to each tile.

Caching

Include a suitable time for the Update Interval in minutes, keeping it as high as possible. This determines how often the Module will request data from your feed.

Yes No
Last updated on 14 June 2019

Video #

The Video Module allows for videos to be uploaded to the Library which are then cached for off-line playback.

If the video file has already been uploaded to the Library use the Library Search tab to quickly and simply add to a Region.

Click on the Video Widget on the toolbar, add / drag to the target Region.

Click on Add files to upload to the Library or click on View Library to select an uploaded file.

We recommend a H264 MP4 file format.

Once assigned to a Region, Edit options are available.

Choose to provide a specific duration:

  • The video can be cut short by providing a lower duration.
  • Wait on the last frame of the video or set the video to Loop (start from the beginning again) by providing a higher duration.

  • Select a scale type (currently supported for Android and webOS Players only).
  • Opt to mute the video by using the tick box.
  • Tick to expand the video so that it shows in full screen.

If you tick Show Full Screen the video will show full screen whilst it is playing. When the next item in the Region is shown it will revert back to the size of the Region.

Yes No
Last updated on 14 June 2019

Video In (webOS) #

The Video In Widget can show input from an external source when added to a Layout.

Please note: This feature is for webOS only.

Click on the Video In Widget on the toolbar, add / drag to the target Region.

Use the drop-down to select which device input should be shown.

Choose to override the default duration.

To seamlessly show content alongside Live TV create an Overlay Layout with the Video In Widget added, this will allow for your layout of content ‘underneath’ to display and rotate freely. This will prevent the TV signal from skipping with each Layout load if on the same Layout.

Yes No
Last updated on 14 June 2019

Weather #

Add Weather Widget

Click on the Weather Widget on the toolbar, add / drag to the target Region.

General

  • Provide an optional name
  • Choose to override the default duration

Configuration

  • Use the display location for the lat/long recorded on the Display rather than specifying manually.
  • Select the unit of measurement using the drop-down menu.
  • Choose the language to use.
  • Use the checkbox to only show daytime weather conditions.

Templates

Select Preset templates or provide your own using JavaScript.

Preset

  • Use the drop-down to select an appropriate template.
  • Tick to edit the selected template. Please see the section on Editing default templates below for further information.

Caching

Enter the Update Interval in minutes.

Editing default templates

Default templates can be edited by selecting a template using the drop-down and clicking in the Override the template checkbox.

The template will be automatically scaled and should be designed for the intended output resolution. The following guidelines should be considered when editing templates:

  • Templates must be designed at a fixed size
  • All elements must use absolute sizing in px, including fonts, margins, widths, heights, etc
  • If positioning is used, it must be from top,left
  • Templates can use bootstrap
  • The aspect ratio will be fixed by Medyapin and sized to fit the Region
  • Templates are treated the same as a static image

Click again on the Templates tab and select to edit:

Current forecast template

Also known as the main template as it is used for the current weather conditions and as the basis for the repeating Daily forecast template.

Click on Get Forecast to see available substitutions to use.

Toggle On the Visual editor to use the Inline Editor to provide text and formatting.

Daily forecast template

This is the repeating template that should be provided for the 7 day forecast. It will be repeated each day and then substituted into the special [dailyForecast] tag (which should feature on the main template).

The [dailyForecast] tag has 2 optional settings which can be added to the tag by including the| character. These are [dailyForecast|Number of days|Start day] and default to 7 days, starting at tomorrow (day 2). If you wanted to see the next 3 days you would use [dailyForecast|3]and for a 3 day forecast starting the day after tomorrow you could use[dailyForecast|3|3]`.

A common example is to ignore the “Current Template” and produce a full 7 day forecast using the daily forecast – this is achieved with [dailyForecast|7|1].

CSS

This is the CSS to apply to the template structure above. It will be augmented with a colour attribute and has a special [[ICONS]] which will be replaced with a selected icon sprite.

Get Forecast

It is possible to request a forecast at any time to see what forecast data is returned. Any field is available as a substitute in the template by entering the field name between square brackets – for example [nearestStormDistance].

Extending with new icons

New icons can be added by an Administrator who has access to the file system. Any PNG file in modules/theme/forecastio/weather_icons will be made available for selection in the Icons selector.

Weather icons are provided as a sprite, each icon is 128×128 and should represent the same weather conditions as the shipped icon sprite.

For example, a “clear-day” is represented by the icon in position 1, a “windy day” is represented by the icon in position 11.

You may have a Layout Status ! There are items on this Layout that can only be assessed by the clientThis is a normal Layout Status if you have online content which will be assessed on the Player side.

Yes No
Last updated on 14 June 2019

Webpage #

Add the Webpage Widget to Layouts to show an entire Webpage embedded inside a Region.

There is support for scaling and offsetting the target webpage to allow for a particular section of a webpage to be defined to display.

Click on the Webpage Widget on the toolbar, add / drag to the target Region.

General

  • Provide an optional name.
  • Choose to override the default duration.

Configuration

Link

  • Provide the URL (including http://) of the webpage.
  • Use the checkbox to render the webpage with a transparent background (currently not available on the Windows Player). Medyapin will try its best to do this when checked, however, it cannot be supported on some webpages.

After the page is rendered Medyapin will scale to fit within the Region.

Webpages are not cached by the Player, this Module requires a valid internet connection in order to function.

Options

Select from 3 options to choose how the webpage should be embedded:

  1. Open Natively

    The Player will open the webpage without any alterations and will open and render in the browser as if the URL had been visited on the device outside Medyapin.

    Please note: There is no preview available for this option.

  2. Manual Position

    Embed the webpage by specifying dimensions which can be used to force the page to fit within certain pre-set dimensions.

    Page Width – specify the width of the page

    Page Height – specify the height of the page

    Offset Top – the top position for the page to start

    Offset Left – the left position for the page to start

    Scale Percentage – percentage zoom to apply to the webpage

  3. Best Fit

    Specify a page width and page height.

    Manual Position and Best Fit options will not work with websites that set the X-Frame-Options header. If you are unable to see the webpage use the Open Natively option when using Windows / Linux or Android. If X-Frame-Options is set then webOS/Tizen will not work in any mode.

    If X-Frame-Options is not set then the website should show in any of the Players, using any of the above options.

    Use the X-Frame-Options Header Checker Tool to see if the header has been set.

Yes No
Last updated on 14 June 2019

Scheduling #

Medyapin has a sophisticated scheduling system which allows for the simple creation of complex schedules for Events across Displays/Display Groups.

Events

Events are administered from the Schedule section of the menu and managed from the calendar interface.

The CMS supports scheduling for 3 event types:

  1. Campaign/Layout Event

    Schedule 1 or multiple Events to Displays.

  2. Overlay Layout Event

    Specially created Layouts are scheduled at the same time as existing Layouts to create an overlay of content to be displayed.

  3. Command Event

    A Scheduled Command can be executed by the Player at a specific point in time and therefore this type of event does not need a toDt.

Commands available to schedule are pre-configured by an Administrator. Available Commands can be selected using the Commanddrop-down menu on the Schedule Event form. If you require additional commands please contact your Administrator.

Display Order and Priority are irrelevant when it comes to executing the Command, but may be set in the CMS for organisational purposes.

Schedule Events

Events are scheduled into Dayparts which are selected to schedule within the selected period:

Custom Daypart

Create your own To/From dates and times.

Always Daypart

Select to have the event run constantly.

Create your own defined Dayparts for ease of scheduling.

Priority

Use Event Priority to determine whether the event should be included in the schedule for the Player or not. A ‘Priority Event’ is determined by a number, with 0 considered the lowest Priority.

If a Player has a schedule containing Events which are all Priority 0, then all of the Events will be shown in rotation together.

If 1 of the Events has a Priority of 1, then this will be the only Event shown.

If there are some Events with Priority 0, some with Priority 1 and some with Priority 2 only the Priority 2 Events will be shown, in a rotation for that Scheduled period (as the highest Priority)

A good example to use Priority would be in a way to alter the Schedule at a specific time, for example, a normal rotation during the day with a Priority Event at lunchtime which shows specific ‘lunch’ information (i.e. Lunchtime specials on a cafe menu).

Yes No
Last updated on 14 June 2019

Schedule #

Schedule content using the simple calendar interface by clicking on the Schedule section of the Menu.

Controls

Use the control bar at the top of the calendar to select DisplaysAdd Eventsview date periods and alternate Views.

Select Displays

Click in this field to select Displays /Display Groups to view the associated schedules.

Add Event

Schedule Events by completing the form fields.

Prev/Today/Next

Use to navigate through the calendar.

Use the calendar icon, next to these buttons, to go directly to a selected date.

Calendar Views

Each Calendar View will show the associated schedule for the selected Display/Display Group. Views show Events represented by Icons, with a key to explain each one, located below the calendar.

Click on an Event or Icon shown on a Calendar View to Edit the schedule.

Year

The Year view is intended as an overview of the Events scheduled throughout the year and provides a total number of Events scheduled per month. Roll over a month and use the black arrow to show Event details.

Double-click to open the Month View for that particular month.

Month

This View includes Icons to represent the Events that have been scheduled for that Month. Click on a particular day square to see an expanded view for that day. Double click on a day square to open the Day View for that date.

Hover over each Icon to display information for that particular Event.

Week

This view gives a week overview of scheduled Events. Double click on a date to open the Day View.

Day

The Day View shows all Events occurring within a single day.

Agenda

Events can span multiple days/weeks/months so it is highly useful to be able to see a precise representation of Layouts/Campaigns that will be shown on a selected Display at a point in time.

The selected Displays/Display Groups will be presented as tabs with Layouts shown in tabular format which appear in the order they will cycle on the Display.

Use the slider, located above the tabs, to pinpoint the exact time of day to view. Change the date using the Prev/Today/Next buttons or by selecting a date using the calendar icon.

Click on a Layout to highlight the associated information (associations will turn blue) and view the breadcrumb, to show further Campaign and Display Group information. If nested Display Groups have been configured, these will show in the breadcrumb.

This can be used to view exactly why a certain Layout is being shown at a certain time.

Click on the breadcrumb to view the Layout and make edits to the schedule.

Yes No
Last updated on 14 June 2019

Events #

Events are Layouts/CampaignsOverlay Layouts or Commands assigned to Displays/Display Groups at specific dates and times. Events are administered from the Schedule section from the menu.

Add Event

Click on the Add Event button on the calendar to schedule an Event.

General

Event Type

Use the drop-down to select an Event from the 3 Types supported:

  • Campaign/Layout – select designed Layouts and Campaigns.
  • Overlay Layout – select a specifically designed Layout to schedule as an Overlay Layout.
  • Command – select from a predefined command.

Events, with the exception of Command Events, can also be added using the Schedule Now function.

Display

Click in the field to select one or more Displays/Display Groups to show the event content on.

Dayparting

Custom/Always or User created Dayparts can be selected using the drop-down menu.

Select Custom to specify your own start/end dates/time. Click in the form field to open the date and time picker.

Start and end times can be free typed to get the exact timings required.

Layout/Campaign

Use the drop-down menu to select the Layout/Campaign to schedule.

This list is dependent on the permissions for that User.

Preview

Click on the Preview button to view the Layout/Campaign in another tab.

This is useful to use to ensure that the correct Layout/Campaign has been selected and to make checks, such as the total duration, without having to leave the schedule.

Display Order

Determine the order in which the Layout/Campaign will play in rotation when scheduled at the same time as other Layouts/Campaigns. Ordering is by a simple numerical sort, lowest to highest numbers, therefore Layouts/Campaigns marked 1 will be played before Layouts/Campaigns marked 2.

The Display Order on Overlay Layouts determines the order in which the Layout Regions are applied to the overlay and compliments the Regions own layer settings.

To ensure ordering of Layouts we would recommend that these are ordered within a Campaign. The Display Order could then be used to determine the order in which entire Campaigns should playout. If no Display Order is specified for Campaigns or they have the same Display order the Campaigns will play interleaved.

Scenario

Campaign A consists of Layout 1, Layout 2 Layout 3 – Display Order of 1 Campaign B consists of Layout 4, Layout 5, Layout 6 – Display Order of 1 When scheduled at the same time the Campaigns will play out as follows:

A – Layout 1

B – Layout 4

A – Layout 2

B – Layout 5

A – Layout 3

B – Layout 6

A – Layout 1 and so on.

To ensure that the Campaigns played all the contained Layouts before rotating to the next, Campaign A would need a Display Order of 1 and Campaign B would need a Display Order of 2.

Priority

Set the Priority of the Event with the highest number stated playing in preference to lower numbers. This can be used to override all other non-priority Events on the schedule.

This functionality is useful for displaying temporary/important notices for overriding a schedule for a specific Event without having to make any changes to your existing schedule or cancelling Layouts/Campaigns that would be running at that time.

Run at CMS Time

When selected, the Event will play at the time determined by the CMS rather than using the local display time.

Scenario CMS Time = GMT Display 1 = GMT Display 2 = GMT -4

An event scheduled for 11:00 with Run at CMS time deselected will run on display 1 at 11:00 and display 2 at 11:00. These two displays will not show the same content at the same time, because display 2 is 4 hours behind.

With Run at CMS time selected, display 1 will run at 11:00 as before but display 2 will run at 07:00.

Please note The Schedule Now functionality will always create events with this option selected.

Repeats

An Event can be repeated at defined intervals (hourly, daily, weekly, monthly or yearly) until a specified time. Use the Repeats tab to create recurring events. Select the type of repeat from the drop-down and complete the form fields as required. Use Repeat every to further specify the frequency of the repeat.

E.g. With a Weekly Repeat you could specify to repeat each Wednesday and Friday every other week by including a 2 in the ‘Repeat every’ form field.

(Available in version 2.0 and later) Monthly Repeats can be determined by the Event date or by the day in the month the event falls on.

For example: an event which is scheduled on 06/03/2019 can be set to repeat on the 6th day of every month or the 1st Wednesday of each month (as 06/03/2019 falls on a Wednesday).

Edit / Delete

Click on any Event/Icon in the calendar to edit form fields or to remove completely from the schedule by clicking delete and confirming.

Duplicate

Located at the bottom of the Edit form, the Duplicate button allows for event details to be duplicated and configured for a new event. Once clicked a pop up will appear to confirm that a new form has been loaded so that amendments can be made.

The new loaded form will not have a Duplicate button.

It is important to note that if at any time there are no Layouts/Campaigns Scheduled to run, the Default Layout for the display will run automatically.

Yes No
Last updated on 14 June 2019

Dayparting  #

In broadcast programming, dayparting is the practice of dividing the broadcast day into several parts, in which a different type of radio or television program apropos for that time period is aired. — Wikipedia

Medyapin supports the creation of multiple Dayparts, which can include day of the week exceptions. This means that a single day can be split into as many pre-defined parts as necessary.

A typical use case would be a hospitality User who has different content to display for Breakfast, Lunch and Dinner. Dayparting allows that User to create a Breakfast, Lunch and Dinner daypart, each of which starts and ends on a different day, to select for ease of Scheduling.

Create a Daypart

Dayparts are administered from the Dayparting page from the Menu and are created by clicking on the Add Daypart button. Complete the form fields to define the Daypart.

Once created the Daypart will show in the Dayparting drop-down list when Scheduling Events.

The below Daypart form shows an example Breakfast Daypart:

Saturday and Sunday have been configured as exceptions so that breakfast starts and ends at different times on those days.

When Scheduling, the Breakfast Daypart will appear in the drop-down list to select. Once selected, the from/to date time selectors will change to date only selectors and the time will be taken from the Daypart configuration – according to the day of the week the Event occurs on.

Edit Dayparts

Dayparts can be edited by using their row menu.

Updating the start/end times or exceptions for a Daypart will cause existing future events to be updated with the newly defined times. Existing recurring Schedules, set to recur beyond the current time, will have new Schedules created to reflect the updated information.

Yes No
Last updated on 14 June 2019

Schedule Now  #

Schedule Now provides a quick way to Schedule a Campaign or Layout for a specific amount of time.

This is useful for displaying temporary/important notices on Displays.

Schedule Now is available across the CMS and is available from the following pages:

  • Campaign – row menu for selected Campaign
  • Layout – row menu for selected Layout
  • Layout Designer – on the Actions tab
  • Display – row menu for selected Display

Complete the form fields as required.

Time zones

Events created using Schedule Now will always have the Run at CMS time option selected. This means that the event will be adjusted for each Display time zone and forced to run from the time “Save” is pressed. Please see Run at CMS time for further information.

Yes No
Last updated on 14 June 2019

API #

Integrating with Medyapin

Integrations with Medyapin can be used to meet a variety of different requirements. They run at “arms-length” which means that they are not directly integrated with the Medyapin code, and instead communicate via API’s.

There are 2 API’s available:

  • CMS API
  • Player API (XMDS)

The CMS API is used to pull data from the Medyapin CMS into another system, or push data from another system into the CMS. Integrations using the CMS API are called “Connectors” in Medyapin terminology.

The Player API is used specifically for Player related interactions and all of our standard Players utilise the Player API, which we call XMDS (Medyapin Media Distribution Service). If a 3rd party Player is required, or CMS data is needed by another application for the purpose of displaying Medyapin content, then the Player API should be used.

Splitting the API ensures that Players can consume a simple, reliable, dedicated API which is easier to maintain and version between application versions.

Player API

The Player API is referred to as XMDS, which stands for Medyapin media distribution service. Medyapin is a SOAP service with a set of end points defined by a WSDL.

The XMDS WSDL can be consumed at //eu.medyapin.cloud/xmds.php?wsdl&v=5 .

The Player API version can be requested with xmds.php?v=X where X is the version requested. The latest version is version 5.

XLF

Layouts are provided by XMDS in their XLF format (Medyapin Layout Format). This is an XML file which represents the Layout presentation and content.

CMS API

The CMS API is a RESTful API protected by oAuth. It can be consumed at //eu.medyapin.cloud/api and exposes routes for all CMS operations.

If developing a CMS extension for use within the existing web portal (for example an extension to be used in a theme file), the API can be consumed directly from //eu.medyapin.cloud/ .

The Medyapin API is OpenAPI Compliant and the documentation is presented using Swagger-UI in this manual. You may also point a Swagger-UI installation to the /swagger.json resource in your CMS instance.

Yes No
Last updated on 14 May 2019

CMS API Overview #

The CMS API is a full featured restful API which allows for advanced integrations with other applications and
automation of CMS functionality.

The API enables exciting opportunities to integrate Medyapin with other systems. Imagine an integration
with a point of sale system which pushed complimentary products to the signage when a customer purchased something.

Any party connecting to the CMS is considered to be an “application” and is granted credentials according to the Applications page in the CMS.

Authentication 

Securing the CMS is of utmost importance and the API is secured behind an oAuth resource server which requires
a valid access_token to be provided before access will be granted.

An access_token can be obtained from the CMS Authorization Server.

Once an access_token has been obtained it should be provided with every request using an Authorization header. The
access_token‘s are Bearer Tokens and should therefore be provided as such:

Authorization: Bearer <<access token>>

Client Information

Applications connecting to the CMS API must do so using a clientId and clientSecret which are available from the Applications page.

An application needs to be added to the CMS before an authorisation request can be processed. After adding an Application it can be granted access to two different types of credentials, called grant types.

Grant Types

The CMS supports two grant types:

  • access_code
  • client_credentials

The grant type requested must be supplied in the grant_type query parameter whenever requesting a token.

Applications added to the CMS should specify which grant types are allowed to use those client credentials. The client_credentials grant is typically used for machine-to-machine communication, whereas the access_code grant type is used to authorise a user.

Authorization Server

The CMS authorization server is used to obtain an access_token and can be found at /api/authorize. The
authorization server supports two methods:

  • /api/authorize/ initiate the access_code grant
  • /api/authorize/access_token obtain a token

Methods 

The Medyapin API is OpenAPI Compliant and the documentation is presented using Swagger-UI in this manual. You may also point a Swagger-UI installation to the /swagger.json resource in your CMS instance.

PHP client implementation 

A PHP oAuth client implementation has been provided for ease of authentication with the API. 

Enveloping 

All requests can be enveloped by adding envelope=1 as a query parameter.

Errors 

API errors are reported via the 4xx and 5xx HTTP response codes, the most common of which are:

  • 404 Not Found (the resource could not be found)
  • 409 Conflict (the request conflicts with an existing entity)
  • 422 Unprocessable Entity (the entity provided is invalid)

Extra information is available in the response body and is JSON formatted. A human readable
error message is presented, the HTTP status code and a data block indicating further information.

An example 422 response is below:

{
    "error": {
        "message": "Layout Name must be between 1 and 50 characters",
        "code": 422,
        "data": {
            "property": "name"
        }
    }
}

5xx errors indicate an issue with the CMS environment and extra information will be available
in the CMS logs.

Grid Data – lists of records 

Lists of records, henceforth referred to as grids, are paged by default, with a default page size of 10 records. They
also have a default sort order applied to them, which is appropriate for that record type.

Paging

Paging is controlled by 2 parameters, start and length. The start parameter denotes at which record in the set
the results should start from, and length denotes the number of records to return. The default length is 10 records
which means to get page 2, start=20 would be provided.

The headers of the response contain extra information related to paging, these are:

  • X-Total-Count: The total count of records (all pages)
  • Link: Links pointing to the first, prev, next and last pages (as appropriate)

The link header is RFC formatted and consists of a url and ; and a rel=
(relationship) attribute.

For example, the headers returned with page 1 are:

Link: <http://localhost/api/layout?start=20&length=10>; rel="next", <http://localhost/api/layout?start=0&length=10>; rel="first"
X-Total-Count: 26

Sorting

Sorting happens in two steps using a columns array and an order array. The columns array describes the fields that
should be ordered, and the order array describes how they should be ordered and in what order.

Taking the layout grid as an example, lets imagine we want to order by the duration of the layout, descending. We do
this by specifying a columns array:

columns[1][data]:duration

And an order array:

order[1][column]:1
order[1][dir]:desc
Yes No
Last updated on 14 May 2019

CMS API Reference #

Yes No
Last updated on 14 May 2019

Software Triggers using the API #

Medyapin supports dynamic signage through the use of software triggers. These are triggers initiated by the CMS and pushed to targeted Players for immediate action.

Software triggers are a flexible way to connect Medyapin Players to devices or software so that actions are taken in real time.

A good example of this is an integration with a POS system that triggers a new Layout each time an item is scanned into the POS terminal (up-sell advertising).

Medyapin is working towards supporting specific hardware triggers which can operate without a network connection, as part of our “interactive signage” software release.

Triggers 

A range of actions are supported by the CMS:

ActionDescriptionParams
changeLayoutImmediately change to the specified LayoutlayoutId,duration,downloadRequired,changeMode
collectNowRun XMDS routine collection immediately 
commandActionActionRun a configured CommandcommandCode
overlayLayoutImmediately overlay a LayoutlayoutId,duration,downloadRequired
rekeyActionRegenerate the Player Public Key and Channel 
revertToScheduleRevert to the scheduled content, removing any Layouts/Overlays 
screenShotTake and send a screen shot 

The changeMode parameter of the changeLayout action can be either “replace” or “queue”, where the value effects the currently active changeLayout actions. The duration is always based on the time since the message was received, even when in “queue” mode.

Security 

Triggers are sent over TCP and therefore security is an understandable concern for many users. To maintain Medyapin’s high standards in this area the push messages we send only contain instructions to communicate with the CMS or show existing content already held by the Player (for example existing Layouts, existing Commands, etc).

Messages are also encrypted with a RSA public key – the private counterpart being held by the Player. The Player sends the public key to the CMS, and the CMS will encrypt all messages destined for the players Channel with the public key provided.

Yes No
Last updated on 14 May 2019