Article API (Registration)

JobManager offers an API (Application Programming Interface) which can be used to communicate with JobManager from other programs via Web Services.

Introduction

The solution offers functionality to communicate with JobManager for:

• Register realtime
  • Clock-In/-Out
  • Start/Stop registration
  • Start/Stop break
• Register daily in journals
• Register Item Consumption
• Register Output Quantity
• Register Absence

Prerequisites

The solution support BC14 and above on both On-Premise and SaaS.

From within the Web Service page in standard BC, create an entry for Codeunit with Object ID 6182999 JobManApiRegistration. Select a Service Name to use from the external application.

Common understanding and description of parameters

Below is a description of common parameters for many of the functions.

Some of them are related to functionality within JobManager. Please seek guidance from a consultant who knows the concepts in JobManager.

• ApiId
  • All functions include a first parameter which should be a name for the external solution. The value is passed through to programmable events with in the JobManager solution, which could be used to extend or change the behavor for certain calls.
  • Sample TULIP.
• EmployeeId
  • This is the unique identifier for the Employee to register. This could be all values allowed within JobManager:
    • Employee Number
    • Alternative identification
    • Employee IDs
• UserInterfaceRelation
  • This could be left blank or a value of an JobManager User Interface of Type API.
  • Default User Interface for All is used if blank value.
  • User Interface for individual Employees could be setup witin JobManager. The API would respect that.
  • Some behavior of the functions could be controlled with JobManager User Interface.
    Examples:
    • Filters on lists of JobManager jobs (Resource, Work Center, Date etc.)
    • Filters on lists of absence.
    • Max records to return i list of Items.
    • Whether absence is required.
    • Default Stop-code for registrations.
• SearchText could be used to make server site search in list of jobs. The server search for the value in the following fields:
  • JobNo
  • Description
  • RefNo
  • RefSubNo
• TimeOffsetUTC
  • Functions that should transfer a DateTime should also send the Time Zone. This value should be send as +/- minuts from UTC. That is 120 for GMT+2.
• JobNo
  • Unique number of every entry within the JobManager Jobs table.
• StampJournalLineSequence
  • Unique number for every time registration line in JobManager called Stamp Journal Line within JobManager.
  • The value is used whenever calling functions for an time registration. That could be:
    • ItemConsumption, JobStop, JobFinish, JobQtyGood, JobQtyScrap etc.
  • The value could be obtain from either
    • GetFirstActiveJobLineSequence

Description of functions

Functions that need to return a complex list (typical Subfixed with _Soap) as they return using Soap/XML.

For register realtime (equals to a Punch Clock or Time Clock) use the functions: SignIn, SignOut, BreakStart, BreakStop, JobStart, JobFinish, JobQtyGood, JobQtyScrap.

For register asynchronous in a JobManager Journal use the functions: RegAddSignIn, RegAddSignOut, RegAddBreak, RegInsert, RegModify, REgDelete, RegTotal.

The other functions should be common for the two scenarios.

Functions

GetJob_Soap(_ApiId : Code[10];_JobNo : Code[20];VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get the fields with information for one JobManager Job.

Parameters:

• _ApiId See common description above.
• _JobNo is the job to lookup. See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetJobListAbsence_Soap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get a list of possible absences. Could be used for picking a JobNo to use as parameter JobNoAbsence to the functions SignIn or SignOut.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetJobListIpc_Soap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_SearchText : Text;VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get a list of possible JobManager Jobs of Type IPC.

Filters on the list will be filled in automatically according to setup within BC for the given Employee and/or the given User Interface.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _SearchText See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetJobListIpcFilter_Soap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_FilterCategoryNo : Text;_FilterActivityNo : Text;_SearchText : Text;VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get a list of possible JobManager Jobs of Type IPC.

Filters could be appliesd with the two *_Filter...* parameters.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _FilterCategoryNo could be used to apply filters on IPC Categories. The syntax is standard BC filters (eq. @ * | etc.)
• _FilterActivityNo could be used to apply filters on IPC Activities. The syntax is standard BC filters (eq. @ * | etc.)
• _SearchText See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetJobListIpcTopX_Soap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_SearchText : Text;VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get a list of possible JobManager Jobs of Type IPC.

This will show the latest X used Jobs according to this.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _SearchText See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetJobListProduction_Soap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_SearchText : Text;VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get a list of possible JobManager Jobs of Type Production. Thats jobs related to the Production module of BC.

Filters on the list will be filled in automatically according to setup within BC for the given Employee and/or the given User Interface.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _SearchText See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetJobListProductionFilter_Soap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_FilterWorkCenter : Text;_FilterMachineCenter : Text;_SearchText : Text;VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get a list of possible JobManager Jobs of Type Production. Thats jobs related to the Production module of BC.

Filters could be appliesd with the two *_Filter...* parameters.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _FilterWorkCenter could be used to apply filters on Work Centers. The syntax is standard BC filters (eq. @ * | etc.)
• _FilterMachineCenter could be used to apply filters on Machine Centers. The syntax is standard BC filters (eq. @ * | etc.)
• _SearchText See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetJobListProductionTopX_Soap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_SearchText : Text;VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get a list of possible JobManager Jobs of Type Production. Thats jobs related to the Production module of BC.

This will show the latest X used Jobs according to this.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _SearchText See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetJobListJob_Soap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_SearchText : Text;VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get a list of possible JobManager Jobs of Type Job. Thats jobs related to the Job/Project module of BC.

Filters on the list will be filled in automatically according to setup within BC for the given Employee and/or the given User Interface.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _SearchText See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetJobListJobFilter_Soap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_FilterResourceGroupNo : Text;_FilterResourceNo : Text;_SearchText : Text;VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get a list of possible JobManager Jobs of Type Job. Thats jobs related to the Job/Project module of BC.

Filters could be appliesd with the two *_Filter...* parameters.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _FilterResourceGroupNo could be used to apply filters on Resource Groups. The syntax is standard BC filters (eq. @ * | etc.)
• _FilterResourceNo could be used to apply filters on Resources. The syntax is standard BC filters (eq. @ * | etc.)
• _SearchText See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetJobListJobTopX_Soap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_SearchText : Text;VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get a list of possible JobManager Jobs of Type Job. Thats jobs related to the Job/Project module of BC.

This will show the latest X used Jobs according to this.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _SearchText See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetJobListService_Soap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_SearchText : Text;VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get a list of possible JobManager Jobs of Type Service. Thats jobs related to the Service module of BC.

Filters on the list will be filled in automatically according to setup within BC for the given Employee and/or the given User Interface.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _SearchText See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetJobListServiceFilter_Soap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_FilterResourceGroupNo : Text;_FilterResourceNo : Text;_SearchText : Text;VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get a list of possible JobManager Jobs of Type Service. Thats jobs related to the Service module of BC.

Filters could be appliesd with the two *_Filter...* parameters.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _FilterResourceGroupNo could be used to apply filters on Resource Groups. The syntax is standard BC filters (eq. @ * | etc.)
• _FilterResourceNo could be used to apply filters on Resources. The syntax is standard BC filters (eq. @ * | etc.)
• _SearchText See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetJobListServiceTopX_Soap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_SearchText : Text;VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get a list of possible JobManager Jobs of Type Service. Thats jobs related to the Service module of BC.

This will show the latest X used Jobs according to this.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _SearchText See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetJobListAssembly_Soap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_SearchText : Text;VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get a list of possible JobManager Jobs of Type Assembly. Thats jobs related to the Assembly Order module of BC.

Filters on the list will be filled in automatically according to setup within BC for the given Employee and/or the given User Interface.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _SearchText See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetJobListAssemblyFilter_Soap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_FilterWorkCenter : Text;_FilterMachineCenter : Text;_SearchText : Text;VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get a list of possible JobManager Jobs of Type Assembly. Thats jobs related to the Assembly Order module of BC.

Filters could be appliesd with the two *_Filter...* parameters.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _FilterResourceGroupNo could be used to apply filters on Resource Groups. The syntax is standard BC filters (eq. @ * | etc.)
• _FilterResourceNo could be used to apply filters on Resources. The syntax is standard BC filters (eq. @ * | etc.)
• _SearchText See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetJobListAssemblyTopX_Soap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_SearchText : Text;VAR _JobManApi_JobManJob : XMLport JobManApi_JobManJob)

Get a list of possible JobManager Jobs of Type Assembly. Thats jobs related to the Assembly Order module of BC.

This will show the latest X used Jobs according to this.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _SearchText See common description above.
• _JobManApi_JobManJob is not realy a parameter, but the way BC indicates the fields to be returned.

GetListItem(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_SearchText : Text;VAR _JobManApi_Item : XMLport JobManApi_Item)

Get a list of Items from the standard BC Items table. The Items marked as Blocked within BC is excluded.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _SearchText could be used to make server site search in list of Items. The server search for the value in the following No. and Description fields.
• _JobManApi_Item is not realy a parameter, but the way BC indicates the fields to be returned.

GetListItemVariant(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_ItemNo : Code[20];VAR _JobManApi_ItemVariant : XMLport JobManApi_ItemVariant)

Get a list of Item Variants from the standard BC Item Variant table.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _ItemNo for the related Item Number.
• _JobManApi_ItemVariant is not realy a parameter, but the way BC indicates the fields to be returned.

GetListLocation(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_ItemNo : Code[20];_VariantCode : Code[10];VAR _JobManApi_Location : XMLport JobManApi_Location)

Get a list of Locations from the standard BC Location table.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _ItemNo for the related Item Number.
• _VariantCode for the related Item Variant.
• _JobManApi_Location is not realy a parameter, but the way BC indicates the fields to be returned.

GetListBin(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_ItemNo : Code[20];_VariantCode : Code[10];_LocationCode : Code[10];VAR _JobManApi_Bin : XMLport JobManApi_Bin)

Get a list of Bins from the standard BC Bins table.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _ItemNo for the related Item Number.
• _VariantCode for the related Item Variant.
• _LocationCode for the related Location.
• _JobManApi_Bin is not realy a parameter, but the way BC indicates the fields to be returned.

ItemConsumptionGetList(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_StampJournalLineSequence : Integer;VAR _JobManApi_ItemConsumption : XMLport JobManApi_ItemConsumption)

Get a list of Items that is planned or actual used for the associated Stamp Journal Line. For Productions thats the Component List, for Job/Project thats planned item comsumption.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _StampJournalLineSequence See common description above.
• _JobManApi_ItemConsumption is not realy a parameter, but the way BC indicates the fields to be returned.

ItemConsumptionAdd(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;StampJournalLineSequence : Integer;_ItemNo : Code[20];_ItemQty : Decimal;_ItemVariantCode : Code[10];_ItemSerialNo : Code[50];_ItemLotNo : Code[50];_ItemLocationCode : Code[10];_ItemBinCode : Code[20];_ItemPackageNo : Code[50])

Add a new item consumption for the associated Stamp Journal Line. It's inserted as and Stamp Event for posting.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. This could be left blank. See common description above.
• _UserInterfaceRelation See common description above.
• _StampJournalLineSequence See common description above.
• _ItemNo to use.
• _ItemQty to use.
• _ItemVariantCode to use (optional).
• _ItemSerialNo to use (optional).
• _ItemLotNo to use (optional).
• _ItemLocationCode to use (optional).
• _ItemBinCode to use (optional).
• _ItemPackageNo to use (optional).
• _JobManApi_ItemConsumption is not realy a parameter, but the way BC indicates the fields to be returned.

ItemConsumptionFieldsEnabled(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_ItemNo : Code[20]) RetText : Text

Optional this functions can be used to indicate for the users which fields could be filled in for the ItemConsumptionAdd function above.

The function returns a text with Yes/No for each of the optional parameters for ItemConsumptionAdd.

Sample return value variant=yes;serial=no;lot=no;location=yes;bin=no;package=no

GetFirstActiveJobLineSequence(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;VAR _ReturnStampJournalLineSequence : Integer)

Get the current active Stamp Journal Line for the specified Employee.

If working on more than one job, this function will return the first. If by any change the Employee are allowed to work on several jobs, known as Bundle, it's recommended to use the the GetListActiveJobs function as shown below.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _ReturnStampJournalLineSequence is the returnvalue from the function. See common description for StampJournalLineSequence above.

The *_ReturnStampJournalLineSequence* equals to the StampJournalLineSequence which should be used as parameters to other functions.

GetListActiveJobs(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;VAR _JobManApi_JobManStampJournalLn : XMLport JobManApi_JobManStampJournalLn)

Get the current active Stamp Journal Line for the specified Employee.

If always working on only one job at the time, the GetFirstActiveJobLineSequence function could be used for more easy access to the StampJournalLineSequence.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _JobManApi_JobManStampJournalLn is not realy a parameter, but the way BC indicates the fields to be returned.

The LineSequence field within the returned list equals to the StampJournalLineSequence which should be used as parameters to other functions.

GetAbsenceRequired(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_TimeOffsetUTC : Integer) : Integer

Use this function to determine whether Absence should or could be applied upon SignIn and SignOut functions below.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _TimeoffsetUTC See common description above.

The return value:

• 0 for Never
• 1 for Optional
• 2 for Force

SignIn(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_TimeOffsetUTC : Integer;_JobNoAbsence : Code[20])

Use this function to Clock-In an Employee in realtime.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _TimeoffsetUTC See common description above.
• _JobNoAbsence is an optional cause of Absence.
  • That is a reason to Clock-In to late.
  • Use the GetAbsenceRequired function to determine whether an Absence should be included.
  • Use the GetJobListAbsence_Soap function to pick the cause of Absence to send as parameter to this.

SignOut(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_TimeOffsetUTC : Integer;_JobNoAbsence : Code[20])

Use this function to Clock-Out an Employee in realtime.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _TimeoffsetUTC See common description above.
• _JobNoAbsence is an optional cause of Absence.
  • That is a reason to Clock-Out to early.
  • Use the GetAbsenceRequired function to determine whether an Absence should be included.
  • Use the GetJobListAbsence_Soap function to pick the cause of Absence to send as parameter to this.

BreakStart(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_TimeOffsetUTC : Integer)

Use this function to start a break in realtime.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _TimeoffsetUTC See common description above.

BreakStop(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text)

Use this function to stop a break in realtime.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.

JobStart(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_TimeOffsetUTC : Integer;_JobNo : Code[20];_BundleContinue : Boolean)

Use this function to start a JobManager Job in realtime.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _TimeoffsetUTC See common description above.
• _JobNo is the JobManager job to start. This is the JobNo from one of the GetJobListXxx functions.
• _BundleContinue
  • True to start the job, and still keep working on the on already started.
  • False to start the job. The active jobs shoul either
    • stopped with functions JobStop or JobFinish.
    • stopped automatically using the Default Stop-code.

JobStop(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_StampJournalLineSequence : Integer)

Use this function to stop a Stamp Journal Line in realtime.

Stop means stop the time but keep the JobManager Job open for later registration.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _StampJournalLineSequence See common description above.

JobFinish(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_StampJournalLineSequence : Integer)

Use this function to report finish a Stamp Journal Line in realtime.

Finish means stop the time AND report the JobManager Job as finished.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _StampJournalLineSequence See common description above.

JobQtyGood(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_StampJournalLineSequence : Integer;_QtyGood : Decimal)

Use this function to report Output Quantity for Production Orders or Assembly Orders related to a Stamp Journal Line in realtime.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _StampJournalLineSequence See common description above.
• _ QtyGood is the Quantity to report.

JobQtyScrap(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_StampJournalLineSequence : Integer;_QtyScrap : Decimal)

Use this function to report Scrap Quantity for Production Orders related to a Stamp Journal Line in realtime.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _StampJournalLineSequence See common description above.
• _ QtyScrap is the scrap Quantity to report.

RegAddSignIn(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_ProfileDate : Date;_TimeOffsetUTC : Integer;_RegDateTime : DateTime) NewJournalLineSequence : Integer

Use this function to insert a Clock-In registration in the JobManager Journal.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _ProfileDate is the Profiledate to hold the registration.
• _TimeoffsetUTC See common description above.
• _RegDateTime is the actual time to register the Clock-In.

The function returns the StampJournalLineSequence for the new line. See common description above.

RegAddSignOut(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_ProfileDate : Date;_TimeOffsetUTC : Integer;_RegDateTime : DateTime) NewJournalLineSequence : Integer

Use this function to insert a Clock-Out registration in the JobManager Journal.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _ProfileDate is the Profiledate to hold the registration.
• _TimeoffsetUTC See common description above.
• _RegDateTime is the actual time to register the Clock-Out.

The function returns the StampJournalLineSequence for the new line. See common description above.

RegAddBreak(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_ProfileDate : Date;_TimeOffsetUTC : Integer;_StartDateTime : DateTime;_StopDateTime : DateTime;_RegHours : Decimal) NewJournalLineSequence : Integer

Use this function to insert a Break registration in the JobManager Journal.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _ProfileDate is the Profiledate to hold the registration.
• _TimeoffsetUTC See common description above.
• _StartDateTime is the actual time to register start of the break
• _StopDateTime is the actual time to register start of the break. The value should be the same as _StarteDateTime if *_RegHours* below is used.
• _RegHours is optional, but should be used if enabled with the Use Hours on the JobManager User Interface.

The function returns the StampJournalLineSequence for the new line. See common description above.

RegInsert(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_ProfileDate : Date;_TimeOffsetUTC : Integer;_StartDateTime : DateTime;_StopDateTime : DateTime;_JobNo : Code[20];_RegHours : Decimal;_WorkTypeCode : Code[10];_PostingDescription1 : Text;_PostingDescription2 : Text) NewJournalLineSequence : Integer

Use this function to insert working on a JobManager Job in the JobManager Journal.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _ProfileDate is the Profiledate to hold the registration.
• _TimeoffsetUTC See common description above.
• _StartDateTime is the actual time to register start of the break
• _StopDateTime is the actual time to register start of the break. The value should be the same as _StarteDateTime if *_RegHours* below is used.
• _JobNo is the JobManager job to register. This is the JobNo from one of the GetJobListXxx functions.
• _RegHours is optional, but should be used if enabled with the Use Hours on the JobManager User Interface.
• _WorkTypeCode is optional.
• _PostingDescription1 is optional.
• _PostingDescription2 is optional.

The function returns the StampJournalLineSequence for the new line. See common description above.

RegModify(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_LineSequence : Integer;_ProfileDate : Date;_TimeOffsetUTC : Integer;_StartDateTime : DateTime;_StopDateTime : DateTime;_JobNo : Code[20];_RegHours : Decimal;_WorkTypeCode : Code[10];_PostingDescription1 : Text;_PostingDescription2 : Text) : Boolean

Use this function to modify an existing registration in the JobManager Journal.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _LineSequence equals to th StampJournalLineSequence for the line to modify. See common description above.
• _ProfileDate is the Profiledate to hold the registration.
• _TimeoffsetUTC See common description above.
• _StartDateTime is the actual time to register start of the break
• _StopDateTime is the actual time to register start of the break. The value should be the same as _StarteDateTime if *_RegHours* below is used.
• _JobNo is the JobManager job to register. This is the JobNo from one of the GetJobListXxx functions.
• _RegHours is optional, but should be used if enabled with the Use Hours on the JobManager User Interface.
• _WorkTypeCode is optional.
• _PostingDescription1 is optional.
• _PostingDescription2 is optional.

RegDelete(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_LineSequence : Integer) : Boolean

Use this function to remove an existing registration in the JobManager Journal.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _LineSequence equals to th StampJournalLineSequence for the line to modify. See common description above.

RegTotal(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_ProfileDate : Date) ReturnText : Text

The function returns a text holding the totals for the lines in the JobManager Journal. Could be used to show the Employee totals for inserted lines.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _ProfileDate is the Profiledate to sum registrations.

IsSignedIn(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text) : Boolean

Use this function determine wheter an Employee is currently Clocked-In (SignIn) or not.

This function could be used to hide/show Clock-In/-Out buttons:

• Only show Clock-In if this function is False.
• Only show Clock-Out if this function is True.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.

IsPilot(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text) : Boolean

Use this function determine wheter an Employee is currently an Pilot.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.

IsAssistantTo(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text) : Code[20]

Use this function determine wheter an Employee is currently an Assistant in a Team. The function return the Employee No for the Pilot.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.

GetTeam(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text) CurrentTeam : Text

If the Employee is currently register as part of a Team, this function will return a list of all Employees in the Team.

The result is returned as a simple semi colon string: AH;MD;TS.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.

TeamStart(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_TimeOffsetUTC : Integer;_PilotNo : Code[20])

This function will start a Teams registration within JobManager. This means the given Employees registrations will follow the registrations of the Pilot.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _PilotNo is the Employee to follow.

TeamStop(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_TimeOffsetUTC : Integer)

This will stop the current Team registration for this Employee.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.

TeamChangePilot(_ApiId : Code[10];_EmployeeId : Text;_UserInterfaceRelation : Text;_TimeOffsetUTC : Integer;_PilotNo : Code[20])

This function will change the Pilot witin a Team to one of the others in the current running Team.

Parameters:

• _ApiId See common description above.
• _EmplooyeeId is the current Employee. See common description above.
• _UserInterfaceRelation See common description above.
• _PilotNo is the new Employee to follow.