edoras one Developer Guide

  <dependency>
          <groupId>com.h2database</groupId>
          <artifactId>h2</artifactId>
          <version>1.4.194</version>
  </dependency>

  compile "com.h2database:h2:1.4.194"

  WorkObject toDoTasks = WorkObject.builder()
          .type(WorkObjectTypes.CASE_TYPE)
          .name("My ToDo task list")
          .build();

  String toDoListWorkObjectId = this.workObjectService.create(toDoTasks);

  WorkObject milkTask = WorkObject.builder()
          .type(WorkObjectTypes.TASK_TYPE)
          .name("Order the milk")
          .build();

  String taskId = this.workObjectService.create(milkTask, toDoListWorkObjectId);

  WorkObject process = WorkObject.builder()
          .type(WorkObjectTypes.PROCESS_TYPE)
          .definitionId(processDefinition.getId())
          .name("Test Process")
          .build();

  String processId = this.workObjectService.create(process);

  WorkObjectUpdateBuilder updateBuilder =
          this.workObjectService.createUpdateBuilder(taskId);

  WorkObject updatedWorkObject = updateBuilder
          .name("Reassigned task name")
          .ownerId(newOwnerId)
          .apply();

  // range comparisons for date values
  Predicate isDueThisMonth = WorkObjectValues.DUE_TIME.between(startOfMonth, endOfMonth);

  // relative comparisons for numeric values
  Predicate isHighPriority = WorkObjectValues.PRIORITY.greaterThanOrEq(8);

  // wildcard comparisons for string values
  Predicate matchesWildcardName = WorkObjectValues.NAME.like("Smi*");

  Predicate isActive = WorkObjectValues.STATE.isActive();
  Predicate assigneeJane = WorkObjectValues.ASSIGNEE_ID.eq("jane");
  Predicate candidateUserJane = WorkObjectValues.CANDIDATE_USER_IDS.containsAnyOf("jane");
  Predicate candidateGroupAdmin = WorkObjectValues.CANDIDATE_GROUP_IDS.containsAnyOf("admin");

  // fluent API to construct AND/OR combinations of two predicates
  Predicate predicate = isActive.and(assigneeJane.or(candidateUserJane));

  // alternative API to construct AND/OR combinations of any number of predicates
  Predicate otherPredicate = Predicates.and(isActive,
          Predicates.or(assigneeJane, candidateUserJane), candidateGroupAdmin);

  // fluent API to negate a predicate
  Predicate isNotCompleted =
          WorkObjectValues.STATE.isCompleted().not();

  // alternative API to negate a predicate
  Predicate isNotAssignedToJane =
          Predicates.not(WorkObjectValues.ASSIGNEE_ID.eq("jane"));

  List<WorkObject> tenants =
          this.workObjectService.findWorkObjects(
                  WorkObjectValues.TYPE.eq(WorkObjectTypes.TENANT_TYPE),
                  SearchScope.ALL_TENANTS_NO_RESTRICTIONS);

  // Search for the 20 oldest active tasks, omitting variable data.

  Predicate isActivePredicate =
          WorkObjectValues.SUB_STATE.eq(WorkObjectSubState.SUB_STATE_ACTIVE);

  Query query = Query.builder()
          .predicate(isActivePredicate)
          .limit(20)
          .sorting(WorkObjectValues.CREATION_TIME.orderAsc())
          .hints(WorkObjectQueryHints.OMIT_VARIABLES)
          .build();

  WorkObject task = WorkObject.builder()
          .type(WorkObjectTypes.TASK_TYPE)
          .value("foo", "bar")
          .build();

  String fooValue = task.getValue("foo", String.class);

  String taskName = task.getValue(WorkObjectValues.NAME);

  static final StringValue<String> FOO = WorkObjectValues.newStringValue("foo");

      // ...

      WorkObject task = WorkObject.builder()
              .type(WorkObjectTypes.TASK_TYPE)
              .value(FOO, "bar")
              .build();

      String fooValue = task.getValue(FOO);

  /**
   * Type-safe representation of an airport code.
   */
  public class AirportCode {
      private static final Set<String> VALID_CODES =
              ImmutableSet.of("LAX", "LHR", "ZRH", "VLC");

      private final String code;

      /**
       * Constructs a new instance.
       *
       * @param code the airport code as a string value
       * @throws IllegalArgumentException if the code is not valid
       */
      public AirportCode(String code) {
          if (!VALID_CODES.contains(code)) {
              throw new IllegalArgumentException("Invalid value: " + code);
          }
          this.code = code;
      }

      /**
       * Returns the 'raw' airport code as a string value.
       *
       * @return the airport code
       */
      public String getCode() {
          return code;
      }

      // other implementation (hashcode, equals, business logic etc.)
  }

  public class AirportCodeConverter implements ValueConverter<AirportCode, String> {
      @Override
      public String serialize(AirportCode airportCode) {
          return airportCode.getCode();
      }

      @Override
      public AirportCode deserialize(String stringValue) {
          return new AirportCode(stringValue);
      }

      @Override
      public TypeToken<String> getSerializedValueType() {
          return TypeToken.of(String.class);
      }
  }

  static final StringValue<AirportCode> DESTINATION =
          newStringValue("destination", new AirportCodeConverter());

      // ...

      AirportCode destination = new AirportCode("ZRH");

      WorkObject task = WorkObject.builder()
              .type(WorkObjectTypes.TASK_TYPE)
              .value(DESTINATION, destination)
              .build();

      AirportCode value = task.getValue(DESTINATION);

  AirportCode requiredDestination = new AirportCode("VLC");
  Predicate predicate = DESTINATION.eq(requiredDestination);

  package com.edorasware.acme.expression;

  import com.edorasware.api.expression.ExpressionBean;
  import java.util.concurrent.atomic.AtomicInteger;

  /**
   * An example service bean that allows unique task names to be created.
   */
  @ExpressionBean
  public class TaskNameService {

      protected static AtomicInteger taskCount = new AtomicInteger();

      /**
       * Returns a new task name based on the given base name.
       *
       * @param baseName the base name
       * @return the task name
       */
      public String nextTaskName(String baseName) {
          return baseName + "-" + taskCount.incrementAndGet();
      }
  }

  @Bean
  public TaskNameService taskNameService() {
      return new TaskNameService();
  }

  @ComponentScan("com.edorasware.acme")

  #{taskNameService.nextTaskName(case.name)}

  /**
   * An example service bean that uses an execution context.
   */
  @Service
  @ExpressionBean
  public class AcmeService extends AbstractActivityService {

      // type-safe variable definition for the service message
      public static final StringValue<String> SERVICE_MSG = newStringValue("serviceMsg");

      public AcmeService() {
          super(false);
      }

      /**
       * Adds a service invocation message to the root work object.
       *
       * @param execution the execution context
       */
      public void invoke(DelegateExecution execution) {
          AnyWorkObject workObjectInScope = getWorkObjectInScope(execution);
          AnyWorkObject rootObject = getRootCase(workObjectInScope);

          WorkObjectUpdateBuilder updateBuilder =
                  getWorkObjectService().createUpdateBuilder(rootObject.getId());

          String message = "AcmeService was invoked at " + getTimestamp()
                  + " with tag " + getTag(execution);

          updateBuilder.value(SERVICE_MSG, message);

          updateBuilder.apply();
      }

      /**
       * Returns the value of the tag property in the task definition.
       *
       * @param execution the execution context
       * @return the value of the tag property
       */
      protected String getTag(DelegateExecution execution) {
          Map<String, String> properties = getEdorasPropertyMapForCurrentActivity(execution);
          String value = properties.get("tag");
          return hasText(value) ? value : "UNDEFINED";
      }

      /**
       * Returns a string with the current timestamp.
       *
       * @return the current timestamp
       */
      protected String getTimestamp() {
          DateTimeFormatter dateFormat =
                  DateTimeFormatter
                          .ofPattern("yyyy-MM-dd hh:mm")
                          .withZone(ZoneId.of("UTC"));

          return dateFormat.format(Instant.now());
      }
  }

  #{acmeService.invoke(execution)}

  <palette id="acme-process-palette"
           resource-bundle="translation"
           apply-patch-to-palette="edoras-one-process-palette"
           xmlns="http://www.edorasware.com/schema/vis/palette"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://www.edorasware.com/schema/vis/palette http://www.edorasware.com/schema/vis/edoras-vis-process-palette-2.0.58.xsd">

      <!-- palette configuration... -->
  </palette>

  <group id="acme-tasks">
      <component id="acmeservicetask" extends="ServiceTask"
                 attribute-groups="acmeServiceTaskAttributes"/>
  </group>

  <attribute-groups>
      <attribute-group id="acmeServiceTaskAttributes">

          <!-- Provide suitable default values for base attributes -->
          <attribute category="common" id="name" type="SimpleText"
                     value="ACME service task"
                     readonly="false" optional="true"
                     ref-to-view="text_name"/>
          <attribute id="bgcolor" category="common" type="Color"
                     value="#ccffcc" index="190"
                     readonly="false" optional="false"
                     ref-to-view="fill_el" fill="true" stroke="false"/>

          <!-- use a fixed expression to invoke the service -->
          <attribute id="expression" category="edoras" type="SimpleText"
                     value="#{acmeService.invoke(execution)}"
                     readonly="true" optional="false" visible="false"/>

          <!-- add a custom attribute that we can access in the service -->
          <attribute id="tag" category="edoras" type="SimpleText"
                     value="default" export="true"
                     readonly="false" optional="false"/>

          <!-- suppress attributes that aren't needed -->
          <attribute id="delegateExpression" category="edoras" type="SimpleText"
                     value=""
                     readonly="false" optional="true" visible="false"/>
          <attribute id="resultVariable" category="edoras" type="SimpleText"
                     value=""
                     readonly="false" optional="true" visible="false"/>
          <attribute id="class" category="edoras" type="SimpleText"
                     value=""
                     readonly="false" optional="true" visible="false"/>

      </attribute-group>
  </attribute-groups>

  acme-tasks.title = ACME tasks
  acmeservicetask.title = ACME service task
  acmeServiceTaskAttributes.tag.title = Tag
  acmeServiceTaskAttributes.tag.description = Tag

  public class AcmeWebApplicationInitializer implements CustomWebApplicationInitializer {

      @Override
      public void preConfigureServletContext(ServletContext servletContext,
                                             WebApplicationContext rootContext)
      {
          AnnotationConfigWebApplicationContext servletAppContext =
                  new AnnotationConfigWebApplicationContext();
          servletAppContext.setParent(rootContext);
          servletAppContext.register(AcmeDispatcherConfiguration.class);

          DispatcherServlet dispatcherServlet = new DispatcherServlet(servletAppContext);
          ServletRegistration.Dynamic oneRegistration =
                  servletContext.addServlet("acme dispatcher", dispatcherServlet);

          oneRegistration.setLoadOnStartup(1);
          oneRegistration.addMapping("/acme/*");
      }

      @Override
      public void postConfigureServletContext(ServletContext servletContext,
                                              WebApplicationContext webApplicationContext) {
      }

      @Override
      public void postConfigureServletFilters(ServletContext servletContext,
                                              WebApplicationContext webApplicationContext) {
      }
  }

  @EnableWebMvc
  @Configuration
  public class AcmeDispatcherConfiguration extends WebMvcConfigurerAdapter {

      @Bean
      public AcmeController acmeController() {
          return new AcmeController();
      }
  }

  @RestController
  public class AcmeController {

      @RequestMapping(value = {"/acme-test"}, method = RequestMethod.GET)
      @ResponseBody
      public String hello(@RequestParam(required = false, defaultValue = "World") String name) {
          return "Hello, " + name + "!";
      }
  }

  @Configuration
  @Order(Ordered.HIGHEST_PRECEDENCE)
  public class AcmeWebSecurityConfiguration extends WebSecurityConfigurerAdapter {

      @Autowired
      protected UserDetailsService userDetailsService;

      @Autowired
      protected PasswordEncoder passwordEncoder;

      @Override
      public void configure(WebSecurity web) throws Exception {
      }

      @Override
      protected void configure(final HttpSecurity httpSecurity) throws Exception {
              httpSecurity
                      .antMatcher("/acme/**")
                      .authorizeRequests()
                      .antMatchers(HttpMethod.OPTIONS, "/acme/**").permitAll()
                      .antMatchers("/acme/**").authenticated()
                      .and()
                      .httpBasic()
                      .and()
                      .sessionManagement().sessionFixation().none()
                      .and()
                      .csrf().disable();
      }

      @Override
      protected void configure(final AuthenticationManagerBuilder authenticationManagerBuilder)
              throws Exception
      {
          authenticationManagerBuilder
                  .userDetailsService(userDetailsService)
                  .passwordEncoder(passwordEncoder);
      }
  }

  /**
   * Manages reference data using persistent database storage.
   */
  public class DatabaseReferenceDataManager implements ReferenceDataManager {

      @Override
      @Transactional(readOnly = true)
      public List<Domain> getDomains(String typedText) {
          // ...
      }

      // ...

  // ...

  /**
   * Create a navigation response for the next (oldest) task.
   *
   * @return the navigation response or NOT_FOUND if no task is available
   */
  @RequestMapping(value = "/navigation/nextTask", method = RequestMethod.GET)
  @ResponseBody
  public ResponseEntity<NavigationResponse> getNextTask() {
      LOG.debug("Requesting next task navigation");

      Query query = Query.builder()
              .predicate(WorkObjectValues.TYPE.eq(TASK_TYPE).and(WorkObjectValues.STATE.isActive()))
              .sorting(WorkObjectValues.CREATION_TIME.orderDesc())
              .limit(1)
              .build();

      AnyWorkObject task = this.anyWorkObjectService.findWorkObject(query);
      if (task == null) {
          return new ResponseEntity<>(HttpStatus.NOT_FOUND);
      }

      NavigationResponse response = NavigationResponse.get(task, ViewName.BROWSE);
      return new ResponseEntity<>(response, RestUtils.JSON_HTTP_HEADERS, HttpStatus.OK);
  }

edoras-gear_A.B.C.X_Small_description.sql

/com/edorasware/commons/core/persistence/schema/h2/edoras-gear_1.0.1.1_Small_description.sql

  <dependency>
          <groupId>com.edorasware.one</groupId>
          <artifactId>edoras-one-index</artifactId>
          <version>${com.edorasware.one.version}</version>
  </dependency>

  @Bean
  public IndexingConfigurationConfigurer acmeIndexingConfigurationConfigurer(
          DocumentAdapter documentAdapter,
          AcmeIndexEntrySerializer serializer)
  {
      return builder ->
              builder.addIndexConfigurations(
                      new AcmeIndexConfiguration(documentAdapter, serializer));
  }

  @Bean
  public AcmeIndexEntrySerializer acmeIndexEntrySerializer() {
      return new AcmeIndexEntrySerializer();
  }

  {
    "template": "#{index.name}*",
    "settings": {
      "number_of_shards": 1,
      "number_of_replicas": 1,
      "refresh_interval": "1s",
      "index.mapping.attachment.indexed_chars": -1
    },
    "mappings": {
      "_default_": {
        "dynamic": "strict",
        "_all": {
          "enabled": false
        }
      },
      "indexEntry": {
        "properties": {
          "id": {
            "type": "string",
            "index": "not_analyzed"
          },
          "globalId": {
            "type": "string",
            "index": "not_analyzed"
          },
          "name": {
            "type": "string",
            "index": "analyzed"
          },
          "type": {
            "type": "string",
            "index": "not_analyzed"
          }
        }
      }
    }
  }

  public class AcmeIndexEntry {

      @JsonProperty
      protected String id;

      @JsonProperty
      protected String globalId;

      @JsonProperty
      protected String type;

      @JsonProperty
      protected String name;

      protected AcmeIndexEntry() {
          // needed for JSON mapper
      }

      AcmeIndexEntry(WorkObject workObject) {
          this.id = workObject.getId();
          this.globalId = workObject.getGlobalId();
          this.type = workObject.getType();
          this.name = workObject.getName();
      }

      AcmeIndexEntry(Entity entity) {
          this.id = entity.getId();
          this.globalId = entity.getGlobalId();
          this.type = entity.getType();
          this.name = entity.getName();
      }
  ...

  AcmeIndexEntry(JsonNode jsonNode) {
      this.id = jsonNode.findPath("id").asText();
      this.globalId = jsonNode.findPath("globalId").asText();
      this.type = jsonNode.findPath("type").asText();
      this.name = jsonNode.findPath("name").asText();
  }

  public class AcmeIndexConfiguration implements IndexConfiguration {
      static final String INDEX_NAME = "acme";
      static final String DOCUMENT_TYPE = "indexEntry";

      protected final DocumentAdapter documentAdapter;
      protected final AcmeIndexEntrySerializer serializer;

      public AcmeIndexConfiguration(DocumentAdapter documentAdapter,
                                    AcmeIndexEntrySerializer serializer) {
          this.documentAdapter = documentAdapter;
          this.serializer = serializer;
      }

      // ...

  /**
   * Provides search functionality for the sample Elasticsearch index.
   */
  public class AcmeIndexSearch {

      @Autowired
      protected AcmeIndexEntrySerializer serializer;

      @Autowired
      protected Client elasticClient;

      /**
       * Finds a single index entry with the given ID.
       *
       * @param workObjectId the work object ID
       * @return the matching index entry
       */
      public AcmeIndexEntry findIndexEntry(String workObjectId) {
          List<AcmeIndexEntry> searchResults = findIndexEntries(idsQuery().addIds(workObjectId));
          if (searchResults.size() == 0) {
              return null;
          } else if (searchResults.size() == 1) {
              return searchResults.get(0);
          } else {
              throw new RuntimeException("Too many results for ID lookup");
          }
      }

      /**
       * Finds the index entries that match the given Elasticsearch query.
       *
       * @param query the Elasticsearch query
       * @return the macthing index entries
       */
      public List<AcmeIndexEntry> findIndexEntries(QueryBuilder query) {
          SearchResponse searchResponse =
                  this.elasticClient
                          .prepareSearch(AcmeIndexConfiguration.INDEX_NAME)
                          .setTypes(AcmeIndexConfiguration.DOCUMENT_TYPE)
                          .setQuery(query)
                          .get();

          return getSearchResults(searchResponse);
      }

      protected List<AcmeIndexEntry> getSearchResults(SearchResponse searchResponse) {
          return Arrays.stream(searchResponse.getHits().hits())
                  .map(input -> getSerializer().deSerialize(input.getSourceAsString()))
                  .collect(Collectors.toList());
      }

      protected AcmeIndexEntrySerializer getSerializer() {
          return serializer;
      }
  }

<group id="Events" title="Events" description="Events description" index="5" >
    <component id="events_start" extends="StartNoneEvent"
               attribute-groups="commonAttributes, formControlAttributes"/>
    <component id="events_end" extends="EndNoneEvent" description="End Event">
        <attribute id="custom_event_attribute" title="Custom Event Attribute" value="custom"/>
    </component>
</group>

<custom-categories>
    <category id="custom_category_1" index = "101" title="custom category 1(en)" />
    <category id="custom_category_2" title="custom category 2(en)"/>
    <category id="custom_category_3" title="custom category 3(en)" visible="false"/>
</custom-categories>

<attribute id="namekey"  value=""   type="SimpleText" category= "custom_category_1" />
<attribute id="name" title="Name" description="Name" value="" type="SimpleText" category="custom_category_2"/>
<attribute id="behavior" type="ComboBox" category= "custom_category_1"  index="3" title="behavior">
    <items>
        <item id="none" title="none" value="none" />
        <item id="all" title="all" value="all" />
        <item id="one" title="one" value="one" />
        <item id="complex" title="complex" value="complex" />
    </items>
</attribute>

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<component-presentations base-palette-icon-path="icons" base-editor-view-path="view">
    <component-presentation id="presentation.number" palette-icon-path="number.png" editor-view-path="number.svg"/>
    <component-presentation id="presentation.password" palette-icon-path="password.png" editor-view-path="password.svg"/>
</component-presentations>

<attribute-groups>
    <attribute-group id="commonAttributes">
        <attribute id="id" title="Id" value=""/>
        <attribute id="nameKey" title="NameKey" description="NameKey" type="SimpleText" value="" />
    </attribute-group>
    <attribute-group id="formControlAttributes">
        <attribute id="label" runtime="false" multilanguage="false" category="common"/>
        <attribute id="description" title="Description" type="SimpleText" visible="false"/>
    </attribute-group>
</attribute-groups>

<custom-attributes>
    <custom-attributes-group id="customAttributeGroup1">
        <attribute id="id" title="Id" value=""/>
        <attribute id="nameKey" title="NameKey" description="NameKey" type="SimpleText" value="" />
    </custom-attributes-group>
    <custom-attributes-group id="customAttributeGroup2" ref="Task">
        <attribute id="label" runtime="false" multilanguage="false" category="common"/>
        <attribute id="description" title="Description" type="SimpleText" visible="false"/>
    </custom-attributes-group>
</custom-attributes>

<model-attributes id="modelAttributes" >
    <attribute id="expressionid" title="Label Expresion" value=""/>
    <attribute id="guid" title="GUID" description="GUID of the model" type="SimpleText" value="" />
</model-attributes>

<attribute id="name"   value="" category="common"  type="SimpleText" ref-to-view="text_name"/>

<attribute id="form_entry" title="FormRef" type="TreeView" value="" description="Form referenced by Form Task." filter="xfm" optional="false" readonly="true" />

<attribute id ="description" runtime-value="" runtime="true" multilanguage="true"> </attribute>

<attribute id="behavior" type="ComboBox" category= "edoras"  index="3" title="behavior">
    <items>
        <item id="none" title="none" value="none" />
        <item id="all" title="all" value="all" />
        <item id="one" title="one" value="one" />
        <item id="complex" title="complex" value="complex" />
    </items>
</attribute>

<attribute id="email" title="Email Properties" type="ComplexForm" description="Email properties" value="">
    <complex-items>
        <complex-item id="from" name="From" type="SimpleText" value="" width="250" vtype="expressionOrEmail" optional="false" />
        <complex-item id="to" name="To" type="SimpleText" value="" width="250" vtype="expressionOrEmailList" optional="false" />
        <complex-item id="cc" name="Cc" type="SimpleText" value="" width="250" vtype="expressionOrEmailList" />
        <complex-item id="bcc" name="Bcc" type="SimpleText" value="" width="250" vtype="expressionOrEmailList" />
        <complex-item id="subject" name="Subject" type="SimpleText" value="" width="250" />
        <complex-item id="html" name="Html" type="RichText" value="" width="250" />
    </complex-items>
</attribute>

<attribute id="thumbnail-max-height" type="SimpleText" title="Thumbnail Maximum Height" value="" >
    <dependency ref="preview" value="thumbnail" />
</attribute>

<oryx:magnets>
    <oryx:magnet oryx:cx="1" oryx:cy="20" oryx:anchors="left" />
    <oryx:magnet oryx:cx="1" oryx:cy="40" oryx:anchors="left" />
    <oryx:magnet oryx:cx="1" oryx:cy="60" oryx:anchors="left" />

    <oryx:magnet oryx:cx="25" oryx:cy="79" oryx:anchors="bottom" />
    <oryx:magnet oryx:cx="50" oryx:cy="79" oryx:anchors="bottom" />
    <oryx:magnet oryx:cx="75" oryx:cy="79" oryx:anchors="bottom" />

    <oryx:magnet oryx:cx="99" oryx:cy="20" oryx:anchors="right" />
    <oryx:magnet oryx:cx="99" oryx:cy="40" oryx:anchors="right" />
    <oryx:magnet oryx:cx="99" oryx:cy="60" oryx:anchors="right" />

    <oryx:magnet oryx:cx="25" oryx:cy="1" oryx:anchors="top" />
    <oryx:magnet oryx:cx="50" oryx:cy="1" oryx:anchors="top" />
    <oryx:magnet oryx:cx="75" oryx:cy="1" oryx:anchors="top" />

    <oryx:magnet oryx:cx="50" oryx:cy="40" oryx:default="yes" />
  </oryx:magnets>