Technical documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== TMF Client =====

The tmf client is meant to execute an BOP Serviceorder. It is a frontend tool with which to execute the script /opt/nms/TMF/tmf2_client.pl and show its output to the user. 

==== Setting up ====
There are a few prerequisites that need to be taken to get it to work:

 - The tmf client tool reads its service orders from the /var/opt/shared/public/tmf directory. This folder needs to be created and have reading and writing permissions. 
 - The script tmf2_client.pl needs to be set up correctly. Its configuration settings are found in the file /opt/nms/TMF/tmf2_client.conf. 

==== Usage ====
You can find the TMF client tool in the sidebar through Operate -> Wizards -> TMF Client.


{{:undefined:tmf_client_start.png|}}

The tmf client is meant to read a service order file and then it will perform an action upon it. The files need to be json files, uploaded to the /var/opt/shared/public/tmf directory. To retrieve a json file, you can go to the BOP Service orders tool:

{{:undefined:tmf_client_input.png|}}

You then can put the contents of the 'Order json' or 'Item json' into the a file and upload it. To upload it, you can use the Admin -> File manager -> Shared files tool, to upload it into the /tmf directory:

{{:undefined:tmf_client_file.png|}}

Once the file has been uploaded, it will appear in the file dropdown in the first field of the tmf client:

{{:undefined:tmf_client_filled.png|}}

In the field next to it you need to specify the order id, followed by the item id and then the action you want to perform on it. If no item id is provided, the default item id of '1' is used. Once the fields are filled in correctly, you can click on the button 'Create' to start up the tmf client tool. The output of the command is displayed on screen:

{{:undefined:tmf_client_output.png|}}