Fieldcode Manual

Tip: You can use filters for better results

  loading=
Enterprise Feature

This specific feature set is only available for customers with an Enterprise plan.

Learn more about how to upgrade your plan

Fieldcode Dynamics is a great way to extend Fieldcode by specific use cases, digitalize processes related to Field Service, or build fully featured solutions that are not or only partially related to Field Service, such as Asset Management, Contract Management, Partner Management, Surveys and Evaluations, Customer Self-Help Processes, and other, almost unlimited, possibilities.

Now, we will use the example of Contract Management to demonstrate the range of functions, possibilities, and power of Fieldcode Dynamics.

Creating the contract model

Please be advised that adequate permissions must be set to access all the Fieldcode Dynamics-related features.

As usual, admins can access the full feature set by default, but you can configure access to your liking. Check the Permissions page for details.

Required Enterprise Permissions:

  • Admin panel/Navigation menu/Dynamics
  • Admin panel/Navigation menu/Automations
  • Work place/Dynamics
Click on image to expand/minimize
You would rather learn certain aspects of Dynamics without a specific use case?

Here is a link collection for Fieldcode Dynamics-related topics:

You can currently not create models without the help of the Fieldcode Support

We are currently still laying the groundwork for Dynamics, so please treat this topic as a pre-read. If you need Dynamics configured right now, please reach out to the Support.

Fieldcode Support

In the following sections, we guide you through the individual requirements and even additional steps you could pursue to cover a successful case of Dynamics. We will learn together how to model a contract in Fieldcode and how to utilize it. In this guided scenario you will learn how to puzzle the pieces together to create your very first custom contract model.

You will learn how to:

  • Create your own Model
    • Add contract fields and relations
  • Configure the Contract Lifecycle and Contract Process
    • Configure the Create forms for your custom object
    • Configure the Edit forms which are used by workflow buttons
    • Configure the Contract Workflow
  • Define the visual layout of the contract details
    • Create inline forms as building units of the layout
    • Design the layout inside the custom contract component
    • Create custom view
  • Start to utilize your new contract model
    • Create new records
    • Process the contract workflow
  • Explore additional settings
    • Integrate automated actions
    • Integrate system connections

To start working with custom objects, the first thing you need to do is create your object data model. The model defines the key characteristics of your custom object, the fields and potential relationships to other objects, and more. Later, you will define how these fields are populated and updated with values throughout the object’s lifecycle.

  1. Open the Admin panel and click on Models.
  2. Inside the Models page click on the Plus button to configure your contract model.
  3. Enter the object name in the Parameters section and call it "contract".
  4. Enter "contractId" as a primary identifier.
Click on image to expand/minimize
  1. What we do now, is to start to add the fields by clicking on the Plus button inside the middle section. 
  2. The fields you add should all be available inside the X-Pool and should all be searchable inside the X-Pool, therefore you activate both toggles
    The X-Pool is a custom component, which you will create later in the process (3.2).
  3. Let's create our first field!
    Enter "contractType" as a field name.
  4. Enter "Type of contract" as a field label.
  5. Select "Text" as a field type.
  6. Select "Select" as an input type.
  7. Select the "Multi-select" checkbox.
  8. Add a "Limited" value.
  9. Add a "Permanent" value.
Click on image to expand/minimize
 
  1. (Optional) - If you want to go further, you can add more fields. For example, you could also add the fields on the right side as inspiration and make your model more robust. But you don't have to.
    Tip: You can check the (2.1) picture to "preview" if you are doing well with the creation of your fields.
  2. Click on Save. Congratulations! You have just successfully created your first object field! A contract, however, usually has many more fields, so for the sake of this scenario, we won't add all. Note before saving: You can only remove or edit fields from your model before pressing Save. Once the model has been saved, field settings can still be adjusted, and new fields can be added, but as of now, existing fields cannot be removed.
Click on image to expand/minimize

Please note that after clicking on Save, the system automatically creates the following for each new model:

  • Workflow: A basic workflow will be created with just one workflow node. You will need to continue configurations from there later on. For our scenario, the workflow name that will be created will be “CONTRACT_BASIC”.
  • Workflow status field: There is no need to add a Status field to your model, it’s generated automatically and will be used by the workflow. They are not visible on the frontend.
  • Project field: There is no need to add a Project field to your model, it’s generated automatically. They are not visible on the frontend.
  • Default form (with “Action type: CREATE”): This form contains all your object fields and if you don’t create a custom form, this default form will open when you create a new object record.
About the "Is available in the pool" and "Searchable" toggles
  • You can check the "Is available in the pool" toggle if you'd like to see this field as a table column later when you list the object records in the X-Pool in Work place. The field order you set inside Models determines the default table column order.
  • The "Searchable" parameter controls if the particular field is searchable by users inside the X-Pool search.

And this is how the workflow parameters for the basic contract look like:

Click on image to expand/minimize

We now have the contract object in the system, and in the next step, we’re going to configure what’s needed to process contracts in the system. The following requirements should be met, depending on the purpose you want to achieve:

For the sake of this scenario, we assume the below workflow is used:
The simplified contract workflow concept

In the following steps, we’ll show you step-by-step how to configure the contract process.

About the process configuration

It's important to start configuring the process before you create any object records, as the default workflow does not contain any workflow buttons, so if you create records earlier, you won't be able to do anything with them later as they will use the workflow version available at record creation. You can start with a very simple workflow and work through it and can always make adjustments later if necessary.

Fieldcode provides you with a default form for all your objects. This form contains all the fields you've added to your object, and unless you specify otherwise, it will open when you create a new object record.

This is what the Create form would look like for the contract object example - with all the fields added:

Click on image to expand/minimize

However, you can create your own 'Create form' on the Forms page of the Admin panel, just as you can for tickets.

For example, for contracts, you may not want to have the "Termination reason" field on the contract creation form, so you could for example customize and remove this field from your already existing "Create Contract" form:

Click on image to expand/minimize

You would remove the termination reason with the trash button if you want to delete this field.

Click on image to expand/minimize

And you could additionally add a filter for signature-related information only if the signed is true:

Click on image to expand/minimize

As a result the "Create Contract" form is adapted properly and should look as follows after the changes:

Click on image to expand/minimize

If it is signed, the fields related to the signature would also be displayed:

Click to zoom
Creating your own form types

You can also create your own forms for other types of actions then 'Create' on the Forms page, and use them later on for editing, and updating your record's data.

About updating fields
  • If you add additional fields after model creation, the default form will contain them out of the box.
  • For the custom forms, however, if you need to update fields, the form has to be re-added again in the Models page.

The easiest and often most convenient way to edit data fields on your objects is to use “Edit” Forms:

  • You need to specify the edit form(s) and the list of data fields available for editing.
  • And then use a workflow button that can open an edit form. If you want to be more specific about which fields are editable during the lifecycle of the object, you can create forms for each purpose (e.g. a specific edit form when the contract is in a new state with relevant contract details and limit field editing to e.g. contract cancellation data when the contract is already active).

In this scenario, for simplicity’s sake, we will only specify one contract “Edit” form, which will be accessible for all contract statuses except the status “Closed”.

As usual, you have to select the "Object" contract, which will bring you all the fields available under contract.

Click on image to expand/minimize

If you open the Workflows page, you will see that the CONTRACT_BASIC workflow has already been created, with only one simple node.

To continue from here and make own custom adjustments to the workflow, you will currently need to contact Fieldcode Support.

Click on image to expand/minimize

The workflow we configured for the contracts scenario looks as follows in the system. Let's have a look on the list view and the tree view of the contracts workflow.

On this right side, you can check the list view of the contracts workflow.

Click on image to expand/minimize

On this right side, you can check the tree view of the contracts workflow.

Click on image to expand/minimize

When you work with Fieldcode, you will notice that we apply certain styling standards to our user interface, including color palettes, fonts, and more. We’ve introduced themes that allow you to customize the styling to your liking.

You will find the default Fieldcode theme when you open the Themes page.

Click on image to expand/minimize

You cannot edit the default theme, but you can create your own.

Click on image to expand/minimize
About Themes

Applying themes is limited at the moment, but our teams are working on more and more features around them, and we hope you'll be excited to see them in the future.

Inline forms provide the building blocks for the visual layout of your object records. An inline form is a unit of your object detail component (such as a tab/sub-tab or header layout).

Important notes when building inline forms:

  • Form name: You can define the form name to identify the correct form later when you look at the list of your custom forms. For example, the name "ContractFirstprojectHeader" can work for the contract object header for the "Firstproject" project.
Click on image to expand/minimize
  • Action type: Defines the purpose of the inline form's building block. For example, for a contract details header, the action type is "HEADER", for the signoff details, the action type is "SIGNOFF".
Click on image to expand/minimize
  • Tags: Tags control the scope of the inline form. The first time you create an inline form under a specific action type for your object, you must leave the Tags untouched (empty), so that this is provided as the default layout. If you want to define a specific layout for a workflow or project, after you've created a default inline form, create another specific inline form with the same action type. This allows you to change the appearance even on a workflow or project level.
Click on image to expand/minimize

Visual concept for “Building the layout”:

Visual concept for a project-based form (building up on the default form):

Visual concept for another project-based form (building up on the default form):

Let’s jump back to our contract scenario:

When you think about how to structure the contract information on the UI, you may begin to realize the following building blocks are required:

  • Header: The header should be added to the header of the Contract Details component. It will contain only the most important contract identification data.
  • Overview: The overview should contain the general contract details.
  • Sign-off: The sign-off should contain all around the contract signatures information.

Action type: HEADER:

Click on image to expand/minimize

Action type: OVERVIEW:

Click on image to expand/minimize

Action type: SIGNOFF:

Click on image to expand/minimize

SIGNOFF: Applicable field filters:

Click on image to expand/minimize

Field filters and field validation examples:

Field filter: 

  • Account name: It could indicate the partner account (company) with which you signed the contract. It doesn’t apply to employment contracts. 
  • More examples to follow with upcoming releases, stay tuned!
Field validations:
  • More examples to follow upcoming releases, stay tuned!

To work with custom objects inside the Work place, we’ve introduced two brand-new components:

  • X-Pool: It displays the object records with the columns made available in the pool in your model definition. To use the X-Pool component, you do not need to perform any additional tasks as it is provided out of the box.
  • X-Details: It displays the details of the object. The component is made up of inline form building blocks. To view the object details, you must build it by creating a new component.

Open the Create component window, and select the contract object:

Click on image to expand/minimize

Then check out the Forms tab, you will see the list of inline forms already created for the contract.

Drag and drop them in the middle section to build your details.

Click on image to expand/minimize

In our example, we've prepared two separate inline forms for the Overview and Sign-off-related details, so we can arrange them here on two separate tabs. You can easily add tabs and subtabs as needed:

Click on image to expand/minimize

The History tab is provided by default and is an integral part of the component, you can't remove it, but you can reorder the tabs by simply dragging and moving them. On the right side, you can rename your tab to match its content.

Click on image to expand/minimize

This is how the Signoff tab could look for example:

Click on image to expand/minimize
About the Header section

The header section is available and you can add the inline header form there, but if you don't need it, just uncheck it and it won't show up in the X-Details view at all.

If you’ve been wondering where and how to view custom object records in Fieldcode, here’s the answer. In the Work place View designer, you can simply add the X-Details and X-Pool components and create your own custom objects view. X-Pool and X-Details are generic components that act as a container for all your objects. Of course, the layout and data content of your view will vary depending on your previous model and component settings.

So how do you add these components to the Work place? Let’s have a look:

Open the View designer inside the Work place:

Click on image to expand/minimize

Select X-Pool and then X-Details from the list of components:

Click on image to expand/minimize

We recommend the following setup, which can be adapted to your usual screen resolution and the amount of data to be displayed:

Click on image to expand/minimize

After you create the view, you'll see this:

Click on image to expand/minimize

To see the records created for your custom object now, you must select your model:

Click on image to expand/minimize

Since you’ve just configured everything, you won’t see any records yet, but everything is in place to get started.

Quick tip:

As you can see, the X-Pool column order corresponds to the field order set in the Model in the Admin panel.

It’s time to add object records and earn the fruits of the configuration efforts you’ve made up to this point.
🍇 🍈 🍉 🍊 🍋 🍌 🍍 🥭 🍎 🍏

Simply click on the Create Object Record menu inside Work place:

Click on image to expand/minimize

It opens the CREATE form of the custom object. If you haven't configured a create form, it opens the default form with all the fields of your object. Select the object:

Click on image to expand/minimize

 Select the project:

Click on image to expand/minimize

Now you can check again if you are satisfied with your custom Create form and start creating your first records if that's the case!

Click on image to expand/minimize

Let's check the results:

Click on image to expand/minimize

Custom objects are also available on the Workflow Monitoring page, so if you experience unexpected workflow problems, visit this page and check issues.

Workflow Monitoring:

Click on image to expand/minimize

You can do even more with your models, for example by integrating automated actions or system connections. Let’s take a short, exemplary look at this.
For further fine-tuning, you can always contact Fieldcode Support.

In preparation!

This section is not finished yet, stay tuned!

Under Automated Actions, you can configure the specific actions that will be performed by the workflow, so you can send emails, SMS, or add ticket info to your object. The automated action must be created on the Automated Actions page and will be triggered in the workflow as it is set up.

Automated Actions and your model

Don't forget that before you can save and execute an automated action, you need to test it. To do this, you need to have some object records already created.

In preparation!

This section is not finished yet, stay tuned!

Was this topic helpful?
0 out of 5 stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
5
How can we further improve this topic?
Please provide the reason for your vote. This will help us improve this topic.
Navigation